include/netlink/route/link.h

   1 /*
   2  * netlink/route/link.h         Links (Interfaces)
   3  *
   4  *      This library is free software; you can redistribute it and/or
   5  *      modify it under the terms of the GNU Lesser General Public
   6  *      License as published by the Free Software Foundation version 2.1
   7  *      of the License.
   8  *
   9  * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch>
  10  */
  11
  12 #ifndef NETLINK_LINK_H_
  13 #define NETLINK_LINK_H_
  14
  15 #include <netlink/netlink.h>
  16 #include <netlink/cache.h>
  17 #include <netlink/addr.h>
  18
  19 struct rtnl_link;
  20
  21 enum rtnl_link_st {
  22         RTNL_LINK_RX_PACKETS,
  23         RTNL_LINK_TX_PACKETS,
  24         RTNL_LINK_RX_BYTES,
  25         RTNL_LINK_TX_BYTES,
  26         RTNL_LINK_RX_ERRORS,
  27         RTNL_LINK_TX_ERRORS,
  28         RTNL_LINK_RX_DROPPED,
  29         RTNL_LINK_TX_DROPPED,
  30         RTNL_LINK_RX_COMPRESSED,
  31         RTNL_LINK_TX_COMPRESSED,
  32         RTNL_LINK_RX_FIFO_ERR,
  33         RTNL_LINK_TX_FIFO_ERR,
  34         RTNL_LINK_RX_LEN_ERR,
  35         RTNL_LINK_RX_OVER_ERR,
  36         RTNL_LINK_RX_CRC_ERR,
  37         RTNL_LINK_RX_FRAME_ERR,
  38         RTNL_LINK_RX_MISSED_ERR,
  39         RTNL_LINK_TX_ABORT_ERR,
  40         RTNL_LINK_TX_CARRIER_ERR,
  41         RTNL_LINK_TX_HBEAT_ERR,
  42         RTNL_LINK_TX_WIN_ERR,
  43         RTNL_LINK_TX_COLLISIONS,
  44         RTNL_LINK_MULTICAST,
  45         __RTNL_LINK_STATS_MAX,
  46 };
  47
  48 #define RTNL_LINK_STATS_MAX (__RTNL_LINK_STATS_MAX - 1)
  49
  50 /**
  51  * Special interface index stating the link was not found.
  52  * @ingroup link
  53  */
  54 #define RTNL_LINK_NOT_FOUND -1
  55
  56 /* link object allocation/freeage */
  57 extern struct rtnl_link *       rtnl_link_alloc(void);
  58 extern void                     rtnl_link_put(struct rtnl_link *);
  59 extern void                     rtnl_link_free(struct rtnl_link *);
  60
  61 /* link cache management */
  62 extern struct nl_cache *        rtnl_link_alloc_cache(struct nl_handle *);
  63 extern struct rtnl_link *       rtnl_link_get(struct nl_cache *, int);
  64 extern struct rtnl_link *       rtnl_link_get_by_name(struct nl_cache *,
  65                                                       const char *);
  66
  67
  68 /* Link Modifications */
  69 extern struct nl_msg *          rtnl_link_build_change_request(struct rtnl_link *,
  70                                                                struct rtnl_link *,
  71                                                                int);
  72 extern int                      rtnl_link_change(struct nl_handle *,
  73                                                  struct rtnl_link *,
  74                                                  struct rtnl_link *, int);
  75
  76 /* Name <-> Index Translations */
  77 extern char *                   rtnl_link_i2name(struct nl_cache *, int,
  78                                                  char *, size_t);
  79 extern int                      rtnl_link_name2i(struct nl_cache *,
  80                                                  const char *);
  81
  82 /* Name <-> Statistic Translations */
  83 extern char *                   rtnl_link_stat2str(int, char *, size_t);
  84 extern int                      rtnl_link_str2stat(const char *);
  85
  86 /* Link Flags Translations */
  87 extern char *                   rtnl_link_flags2str(int, char *, size_t);
  88 extern int                      rtnl_link_str2flags(const char *);
  89
  90 /* Access Functions */
  91 extern void                     rtnl_link_set_qdisc(struct rtnl_link *,
  92                                                     const char *);
  93 extern char *                   rtnl_link_get_qdisc(struct rtnl_link *);
  94
  95 extern void                     rtnl_link_set_name(struct rtnl_link *,
  96                                                    const char *);
  97 extern char *                   rtnl_link_get_name(struct rtnl_link *);
  98
  99 extern void                     rtnl_link_set_flags(struct rtnl_link *,
 100                                                     unsigned int);
 101 extern void                     rtnl_link_unset_flags(struct rtnl_link *,
 102                                                       unsigned int);
 103 extern unsigned int             rtnl_link_get_flags(struct rtnl_link *);
 104
 105 extern void                     rtnl_link_set_mtu(struct rtnl_link *,
 106                                                   unsigned int);
 107 extern unsigned int             rtnl_link_get_mtu(struct rtnl_link *);
 108
 109 extern void                     rtnl_link_set_txqlen(struct rtnl_link *,
 110                                                      unsigned int);
 111 extern unsigned int             rtnl_link_get_txqlen(struct rtnl_link *);
 112
 113 extern void                     rtnl_link_set_weight(struct rtnl_link *,
 114                                                      unsigned int);
 115 extern unsigned int             rtnl_link_get_weight(struct rtnl_link *);
 116
 117 extern void                     rtnl_link_set_ifindex(struct rtnl_link *, int);
 118 extern int                      rtnl_link_get_ifindex(struct rtnl_link *);
 119
 120 extern void                     rtnl_link_set_family(struct rtnl_link *, int);
 121 extern int                      rtnl_link_get_family(struct rtnl_link *);
 122
 123 extern void                     rtnl_link_set_arptype(struct rtnl_link *,
 124                                                       unsigned int);
 125 extern unsigned int             rtnl_link_get_arptype(struct rtnl_link *);
 126
 127 extern void                     rtnl_link_set_addr(struct rtnl_link *,
 128                                                    struct nl_addr *);
 129 extern struct nl_addr *         rtnl_link_get_addr(struct rtnl_link *);
 130
 131 extern void                     rtnl_link_set_broadcast(struct rtnl_link *,
 132                                                         struct nl_addr *);
 133 extern struct nl_addr *         rtnl_link_get_broadcast(struct rtnl_link *);
 134
 135 extern void                     rtnl_link_set_link(struct rtnl_link *, int);
 136 extern int                      rtnl_link_get_link(struct rtnl_link *);
 137
 138 extern void                     rtnl_link_set_master(struct rtnl_link *, int);
 139 extern int                      rtnl_link_get_master(struct rtnl_link *);
 140
 141 extern uint64_t                 rtnl_link_get_stat(struct rtnl_link *, int);
 142
 143 #endif