link.h

00001 /*
00002  * netlink/route/link.h         Links (Interfaces)
00003  *
00004  *      This library is free software; you can redistribute it and/or
00005  *      modify it under the terms of the GNU Lesser General Public
00006  *      License as published by the Free Software Foundation version 2.1
00007  *      of the License.
00008  *
00009  * Copyright (c) 2003-2010 Thomas Graf <tgraf@suug.ch>
00010  */
00011 
00012 #ifndef NETLINK_LINK_H_
00013 #define NETLINK_LINK_H_
00014 
00015 #include <netlink/netlink.h>
00016 #include <netlink/cache.h>
00017 #include <netlink/addr.h>
00018 
00019 #ifdef __cplusplus
00020 extern "C" {
00021 #endif
00022 
00023 struct rtnl_link;
00024 
00025 enum rtnl_link_st {
00026         RTNL_LINK_RX_PACKETS,
00027         RTNL_LINK_TX_PACKETS,
00028         RTNL_LINK_RX_BYTES,
00029         RTNL_LINK_TX_BYTES,
00030         RTNL_LINK_RX_ERRORS,
00031         RTNL_LINK_TX_ERRORS,
00032         RTNL_LINK_RX_DROPPED,
00033         RTNL_LINK_TX_DROPPED,
00034         RTNL_LINK_RX_COMPRESSED,
00035         RTNL_LINK_TX_COMPRESSED,
00036         RTNL_LINK_RX_FIFO_ERR,
00037         RTNL_LINK_TX_FIFO_ERR,
00038         RTNL_LINK_RX_LEN_ERR,
00039         RTNL_LINK_RX_OVER_ERR,
00040         RTNL_LINK_RX_CRC_ERR,
00041         RTNL_LINK_RX_FRAME_ERR,
00042         RTNL_LINK_RX_MISSED_ERR,
00043         RTNL_LINK_TX_ABORT_ERR,
00044         RTNL_LINK_TX_CARRIER_ERR,
00045         RTNL_LINK_TX_HBEAT_ERR,
00046         RTNL_LINK_TX_WIN_ERR,
00047         RTNL_LINK_COLLISIONS,
00048         RTNL_LINK_MULTICAST,
00049         RTNL_LINK_IP6_INPKTS,                   /* InReceives */
00050         RTNL_LINK_IP6_INHDRERRORS,              /* InHdrErrors */
00051         RTNL_LINK_IP6_INTOOBIGERRORS,           /* InTooBigErrors */
00052         RTNL_LINK_IP6_INNOROUTES,               /* InNoRoutes */
00053         RTNL_LINK_IP6_INADDRERRORS,             /* InAddrErrors */
00054         RTNL_LINK_IP6_INUNKNOWNPROTOS,          /* InUnknownProtos */
00055         RTNL_LINK_IP6_INTRUNCATEDPKTS,          /* InTruncatedPkts */
00056         RTNL_LINK_IP6_INDISCARDS,               /* InDiscards */
00057         RTNL_LINK_IP6_INDELIVERS,               /* InDelivers */
00058         RTNL_LINK_IP6_OUTFORWDATAGRAMS,         /* OutForwDatagrams */
00059         RTNL_LINK_IP6_OUTPKTS,                  /* OutRequests */
00060         RTNL_LINK_IP6_OUTDISCARDS,              /* OutDiscards */
00061         RTNL_LINK_IP6_OUTNOROUTES,              /* OutNoRoutes */
00062         RTNL_LINK_IP6_REASMTIMEOUT,             /* ReasmTimeout */
00063         RTNL_LINK_IP6_REASMREQDS,               /* ReasmReqds */
00064         RTNL_LINK_IP6_REASMOKS,                 /* ReasmOKs */
00065         RTNL_LINK_IP6_REASMFAILS,               /* ReasmFails */
00066         RTNL_LINK_IP6_FRAGOKS,                  /* FragOKs */
00067         RTNL_LINK_IP6_FRAGFAILS,                /* FragFails */
00068         RTNL_LINK_IP6_FRAGCREATES,              /* FragCreates */
00069         RTNL_LINK_IP6_INMCASTPKTS,              /* InMcastPkts */
00070         RTNL_LINK_IP6_OUTMCASTPKTS,             /* OutMcastPkts */
00071         RTNL_LINK_IP6_INBCASTPKTS,              /* InBcastPkts */
00072         RTNL_LINK_IP6_OUTBCASTPKTS,             /* OutBcastPkts */
00073         RTNL_LINK_IP6_INOCTETS,                 /* InOctets */
00074         RTNL_LINK_IP6_OUTOCTETS,                /* OutOctets */
00075         RTNL_LINK_IP6_INMCASTOCTETS,            /* InMcastOctets */
00076         RTNL_LINK_IP6_OUTMCASTOCTETS,           /* OutMcastOctets */
00077         RTNL_LINK_IP6_INBCASTOCTETS,            /* InBcastOctets */
00078         RTNL_LINK_IP6_OUTBCASTOCTETS,           /* OutBcastOctets */
00079         RTNL_LINK_ICMP6_INMSGS,                 /* InMsgs */
00080         RTNL_LINK_ICMP6_INERRORS,               /* InErrors */
00081         RTNL_LINK_ICMP6_OUTMSGS,                /* OutMsgs */
00082         RTNL_LINK_ICMP6_OUTERRORS,              /* OutErrors */
00083         __RTNL_LINK_STATS_MAX,
00084 };
00085 
00086 #define RTNL_LINK_STATS_MAX (__RTNL_LINK_STATS_MAX - 1)
00087 
00088 /* link object allocation/freeage */
00089 extern struct rtnl_link *rtnl_link_alloc(void);
00090 extern void     rtnl_link_put(struct rtnl_link *);
00091 extern void     rtnl_link_free(struct rtnl_link *);
00092 
00093 /* link cache management */
00094 extern int      rtnl_link_alloc_cache(struct nl_sock *, int, struct nl_cache **);
00095 extern struct rtnl_link *rtnl_link_get(struct nl_cache *, int);
00096 extern struct rtnl_link *rtnl_link_get_by_name(struct nl_cache *, const char *);
00097 
00098 
00099 extern int      rtnl_link_build_change_request(struct rtnl_link *,
00100                                                struct rtnl_link *, int,
00101                                                struct nl_msg **);
00102 extern int      rtnl_link_change(struct nl_sock *, struct rtnl_link *,
00103                                  struct rtnl_link *, int);
00104 
00105 /* Name <-> Index Translations */
00106 extern char *   rtnl_link_i2name(struct nl_cache *, int, char *, size_t);
00107 extern int      rtnl_link_name2i(struct nl_cache *, const char *);
00108 
00109 /* Name <-> Statistic Translations */
00110 extern char *   rtnl_link_stat2str(int, char *, size_t);
00111 extern int      rtnl_link_str2stat(const char *);
00112 
00113 /* Link Flags Translations */
00114 extern char *   rtnl_link_flags2str(int, char *, size_t);
00115 extern int      rtnl_link_str2flags(const char *);
00116 
00117 extern char *   rtnl_link_operstate2str(int, char *, size_t);
00118 extern int      rtnl_link_str2operstate(const char *);
00119 
00120 extern char *   rtnl_link_mode2str(int, char *, size_t);
00121 extern int      rtnl_link_str2mode(const char *);
00122 
00123 /* Access Functions */
00124 extern void     rtnl_link_set_qdisc(struct rtnl_link *, const char *);
00125 extern char *   rtnl_link_get_qdisc(struct rtnl_link *);
00126 
00127 extern void     rtnl_link_set_name(struct rtnl_link *, const char *);
00128 extern char *   rtnl_link_get_name(struct rtnl_link *);
00129 
00130 extern void     rtnl_link_set_flags(struct rtnl_link *, unsigned int);
00131 extern void     rtnl_link_unset_flags(struct rtnl_link *, unsigned int);
00132 extern unsigned int rtnl_link_get_flags(struct rtnl_link *);
00133 
00134 extern void     rtnl_link_set_mtu(struct rtnl_link *, unsigned int);
00135 extern unsigned int rtnl_link_get_mtu(struct rtnl_link *);
00136 
00137 extern void     rtnl_link_set_txqlen(struct rtnl_link *, unsigned int);
00138 extern unsigned int rtnl_link_get_txqlen(struct rtnl_link *);
00139 
00140 extern void     rtnl_link_set_weight(struct rtnl_link *, unsigned int);
00141 extern unsigned int rtnl_link_get_weight(struct rtnl_link *);
00142 
00143 extern void     rtnl_link_set_ifindex(struct rtnl_link *, int);
00144 extern int      rtnl_link_get_ifindex(struct rtnl_link *);
00145 
00146 extern void     rtnl_link_set_family(struct rtnl_link *, int);
00147 extern int      rtnl_link_get_family(struct rtnl_link *);
00148 
00149 extern void     rtnl_link_set_arptype(struct rtnl_link *, unsigned int);
00150 extern unsigned int rtnl_link_get_arptype(struct rtnl_link *);
00151 
00152 extern void     rtnl_link_set_addr(struct rtnl_link *, struct nl_addr *);
00153 extern struct nl_addr *rtnl_link_get_addr(struct rtnl_link *);
00154 
00155 extern void     rtnl_link_set_broadcast(struct rtnl_link *, struct nl_addr *);
00156 extern struct nl_addr *rtnl_link_get_broadcast(struct rtnl_link *);
00157 
00158 extern void     rtnl_link_set_link(struct rtnl_link *, int);
00159 extern int      rtnl_link_get_link(struct rtnl_link *);
00160 
00161 extern void     rtnl_link_set_master(struct rtnl_link *, int);
00162 extern int      rtnl_link_get_master(struct rtnl_link *);
00163 
00164 extern void     rtnl_link_set_operstate(struct rtnl_link *, uint8_t);
00165 extern uint8_t  rtnl_link_get_operstate(struct rtnl_link *);
00166 
00167 extern void     rtnl_link_set_linkmode(struct rtnl_link *, uint8_t);
00168 extern uint8_t  rtnl_link_get_linkmode(struct rtnl_link *);
00169 
00170 extern const char *     rtnl_link_get_ifalias(struct rtnl_link *);
00171 extern void             rtnl_link_set_ifalias(struct rtnl_link *, const char *);
00172 
00173 extern int              rtnl_link_get_num_vf(struct rtnl_link *, uint32_t *);
00174 
00175 extern uint64_t rtnl_link_get_stat(struct rtnl_link *, int);
00176 extern int      rtnl_link_set_stat(struct rtnl_link *, const unsigned int,
00177                                    const uint64_t);
00178 
00179 extern int      rtnl_link_set_info_type(struct rtnl_link *, const char *);
00180 extern char *   rtnl_link_get_info_type(struct rtnl_link *);
00181 
00182 #ifdef __cplusplus
00183 }
00184 #endif
00185 
00186 #endif