libnl 1.1

include/netlink/route/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-2006 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_TX_COLLISIONS,
00048         RTNL_LINK_MULTICAST,
00049         __RTNL_LINK_STATS_MAX,
00050 };
00051 
00052 #define RTNL_LINK_STATS_MAX (__RTNL_LINK_STATS_MAX - 1)
00053 
00054 /**
00055  * Special interface index stating the link was not found.
00056  * @ingroup link
00057  */
00058 #define RTNL_LINK_NOT_FOUND -1
00059 
00060 /* link object allocation/freeage */
00061 extern struct rtnl_link *       rtnl_link_alloc(void);
00062 extern void                     rtnl_link_put(struct rtnl_link *);
00063 extern void                     rtnl_link_free(struct rtnl_link *);
00064 
00065 /* link cache management */
00066 extern struct nl_cache *        rtnl_link_alloc_cache(struct nl_handle *);
00067 extern struct rtnl_link *       rtnl_link_get(struct nl_cache *, int);
00068 extern struct rtnl_link *       rtnl_link_get_by_name(struct nl_cache *,
00069                                                       const char *);
00070 
00071 
00072 /* Link Modifications */
00073 extern struct nl_msg *          rtnl_link_build_change_request(struct rtnl_link *,
00074                                                                struct rtnl_link *,
00075                                                                int);
00076 extern int                      rtnl_link_change(struct nl_handle *,
00077                                                  struct rtnl_link *,
00078                                                  struct rtnl_link *, int);
00079 
00080 /* Name <-> Index Translations */
00081 extern char *                   rtnl_link_i2name(struct nl_cache *, int,
00082                                                  char *, size_t);
00083 extern int                      rtnl_link_name2i(struct nl_cache *,
00084                                                  const char *);
00085 
00086 /* Name <-> Statistic Translations */
00087 extern char *                   rtnl_link_stat2str(int, char *, size_t);
00088 extern int                      rtnl_link_str2stat(const char *);
00089 
00090 /* Link Flags Translations */
00091 extern char *                   rtnl_link_flags2str(int, char *, size_t);
00092 extern int                      rtnl_link_str2flags(const char *);
00093 
00094 extern char *                   rtnl_link_operstate2str(int, char *, size_t);
00095 extern int                      rtnl_link_str2operstate(const char *);
00096 
00097 extern char *                   rtnl_link_mode2str(int, char *, size_t);
00098 extern int                      rtnl_link_str2mode(const char *);
00099 
00100 /* Access Functions */
00101 extern void                     rtnl_link_set_qdisc(struct rtnl_link *,
00102                                                     const char *);
00103 extern char *                   rtnl_link_get_qdisc(struct rtnl_link *);
00104 
00105 extern void                     rtnl_link_set_name(struct rtnl_link *,
00106                                                    const char *);
00107 extern char *                   rtnl_link_get_name(struct rtnl_link *);
00108 
00109 extern void                     rtnl_link_set_flags(struct rtnl_link *,
00110                                                     unsigned int);
00111 extern void                     rtnl_link_unset_flags(struct rtnl_link *,
00112                                                       unsigned int);
00113 extern unsigned int             rtnl_link_get_flags(struct rtnl_link *);
00114 
00115 extern void                     rtnl_link_set_mtu(struct rtnl_link *,
00116                                                   unsigned int);
00117 extern unsigned int             rtnl_link_get_mtu(struct rtnl_link *);
00118 
00119 extern void                     rtnl_link_set_txqlen(struct rtnl_link *,
00120                                                      unsigned int);
00121 extern unsigned int             rtnl_link_get_txqlen(struct rtnl_link *);
00122 
00123 extern void                     rtnl_link_set_weight(struct rtnl_link *,
00124                                                      unsigned int);
00125 extern unsigned int             rtnl_link_get_weight(struct rtnl_link *);
00126 
00127 extern void                     rtnl_link_set_ifindex(struct rtnl_link *, int);
00128 extern int                      rtnl_link_get_ifindex(struct rtnl_link *);
00129 
00130 extern void                     rtnl_link_set_family(struct rtnl_link *, int);
00131 extern int                      rtnl_link_get_family(struct rtnl_link *);
00132 
00133 extern void                     rtnl_link_set_arptype(struct rtnl_link *,
00134                                                       unsigned int);
00135 extern unsigned int             rtnl_link_get_arptype(struct rtnl_link *);
00136 
00137 extern void                     rtnl_link_set_addr(struct rtnl_link *,
00138                                                    struct nl_addr *);
00139 extern struct nl_addr *         rtnl_link_get_addr(struct rtnl_link *);
00140 
00141 extern void                     rtnl_link_set_broadcast(struct rtnl_link *,
00142                                                         struct nl_addr *);
00143 extern struct nl_addr *         rtnl_link_get_broadcast(struct rtnl_link *);
00144 
00145 extern void                     rtnl_link_set_link(struct rtnl_link *, int);
00146 extern int                      rtnl_link_get_link(struct rtnl_link *);
00147 
00148 extern void                     rtnl_link_set_master(struct rtnl_link *, int);
00149 extern int                      rtnl_link_get_master(struct rtnl_link *);
00150 
00151 extern void                     rtnl_link_set_operstate(struct rtnl_link *,
00152                                                         uint8_t);
00153 extern uint8_t                  rtnl_link_get_operstate(struct rtnl_link *);
00154 
00155 extern void                     rtnl_link_set_linkmode(struct rtnl_link *,
00156                                                        uint8_t);
00157 extern uint8_t                  rtnl_link_get_linkmode(struct rtnl_link *);
00158 
00159 extern uint64_t                 rtnl_link_get_stat(struct rtnl_link *, int);
00160 
00161 extern int                      rtnl_link_set_info_type(struct rtnl_link *,
00162                                                         const char *);
00163 extern char *                   rtnl_link_get_info_type(struct rtnl_link *);
00164 
00165 #ifdef __cplusplus
00166 }
00167 #endif
00168 
00169 #endif