libnl  3.2.24-rc1
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-2012 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 #include <linux/if.h>
19 #include <sys/types.h>
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 
25 /**
26  * @struct rtnl_link link.h "netlink/route/link.h"
27  * @brief Link object
28  * @implements nl_object
29  * @ingroup link
30  *
31  * @copydoc private_struct
32  */
33 struct rtnl_link;
34 
35 /**
36  * @ingroup link
37  */
38 typedef enum {
39  RTNL_LINK_RX_PACKETS, /*!< Packets received */
40  RTNL_LINK_TX_PACKETS, /*!< Packets sent */
41  RTNL_LINK_RX_BYTES, /*!< Bytes received */
42  RTNL_LINK_TX_BYTES, /*!< Bytes sent */
43  RTNL_LINK_RX_ERRORS, /*!< Receive errors */
44  RTNL_LINK_TX_ERRORS, /*!< Send errors */
45  RTNL_LINK_RX_DROPPED, /*!< Received packets dropped */
46  RTNL_LINK_TX_DROPPED, /*!< Packets dropped during transmit */
47  RTNL_LINK_RX_COMPRESSED, /*!< Compressed packets received */
48  RTNL_LINK_TX_COMPRESSED, /*!< Compressed packets sent */
49  RTNL_LINK_RX_FIFO_ERR, /*!< Receive FIFO errors */
50  RTNL_LINK_TX_FIFO_ERR, /*!< Send FIFO errors */
51  RTNL_LINK_RX_LEN_ERR, /*!< Length errors */
52  RTNL_LINK_RX_OVER_ERR, /*!< Over errors */
53  RTNL_LINK_RX_CRC_ERR, /*!< CRC errors */
54  RTNL_LINK_RX_FRAME_ERR, /*!< Frame errors */
55  RTNL_LINK_RX_MISSED_ERR, /*!< Missed errors */
56  RTNL_LINK_TX_ABORT_ERR, /*!< Aborted errors */
57  RTNL_LINK_TX_CARRIER_ERR, /*!< Carrier errors */
58  RTNL_LINK_TX_HBEAT_ERR, /*!< Heartbeat errors */
59  RTNL_LINK_TX_WIN_ERR, /*!< Window errors */
60  RTNL_LINK_COLLISIONS, /*!< Send collisions */
61  RTNL_LINK_MULTICAST, /*!< Multicast */
62  RTNL_LINK_IP6_INPKTS, /*!< IPv6 SNMP InReceives */
63  RTNL_LINK_IP6_INHDRERRORS, /*!< IPv6 SNMP InHdrErrors */
64  RTNL_LINK_IP6_INTOOBIGERRORS, /*!< IPv6 SNMP InTooBigErrors */
65  RTNL_LINK_IP6_INNOROUTES, /*!< IPv6 SNMP InNoRoutes */
66  RTNL_LINK_IP6_INADDRERRORS, /*!< IPv6 SNMP InAddrErrors */
67  RTNL_LINK_IP6_INUNKNOWNPROTOS, /*!< IPv6 SNMP InUnknownProtos */
68  RTNL_LINK_IP6_INTRUNCATEDPKTS, /*!< IPv6 SNMP InTruncatedPkts */
69  RTNL_LINK_IP6_INDISCARDS, /*!< IPv6 SNMP InDiscards */
70  RTNL_LINK_IP6_INDELIVERS, /*!< IPv6 SNMP InDelivers */
71  RTNL_LINK_IP6_OUTFORWDATAGRAMS, /*!< IPv6 SNMP OutForwDatagrams */
72  RTNL_LINK_IP6_OUTPKTS, /*!< IPv6 SNMP OutRequests */
73  RTNL_LINK_IP6_OUTDISCARDS, /*!< IPv6 SNMP OutDiscards */
74  RTNL_LINK_IP6_OUTNOROUTES, /*!< IPv6 SNMP OutNoRoutes */
75  RTNL_LINK_IP6_REASMTIMEOUT, /*!< IPv6 SNMP ReasmTimeout */
76  RTNL_LINK_IP6_REASMREQDS, /*!< IPv6 SNMP ReasmReqds */
77  RTNL_LINK_IP6_REASMOKS, /*!< IPv6 SNMP ReasmOKs */
78  RTNL_LINK_IP6_REASMFAILS, /*!< IPv6 SNMP ReasmFails */
79  RTNL_LINK_IP6_FRAGOKS, /*!< IPv6 SNMP FragOKs */
80  RTNL_LINK_IP6_FRAGFAILS, /*!< IPv6 SNMP FragFails */
81  RTNL_LINK_IP6_FRAGCREATES, /*!< IPv6 SNMP FragCreates */
82  RTNL_LINK_IP6_INMCASTPKTS, /*!< IPv6 SNMP InMcastPkts */
83  RTNL_LINK_IP6_OUTMCASTPKTS, /*!< IPv6 SNMP OutMcastPkts */
84  RTNL_LINK_IP6_INBCASTPKTS, /*!< IPv6 SNMP InBcastPkts */
85  RTNL_LINK_IP6_OUTBCASTPKTS, /*!< IPv6 SNMP OutBcastPkts */
86  RTNL_LINK_IP6_INOCTETS, /*!< IPv6 SNMP InOctets */
87  RTNL_LINK_IP6_OUTOCTETS, /*!< IPv6 SNMP OutOctets */
88  RTNL_LINK_IP6_INMCASTOCTETS, /*!< IPv6 SNMP InMcastOctets */
89  RTNL_LINK_IP6_OUTMCASTOCTETS, /*!< IPv6 SNMP OutMcastOctets */
90  RTNL_LINK_IP6_INBCASTOCTETS, /*!< IPv6 SNMP InBcastOctets */
91  RTNL_LINK_IP6_OUTBCASTOCTETS, /*!< IPv6 SNMP OutBcastOctets */
92  RTNL_LINK_ICMP6_INMSGS, /*!< ICMPv6 SNMP InMsgs */
93  RTNL_LINK_ICMP6_INERRORS, /*!< ICMPv6 SNMP InErrors */
94  RTNL_LINK_ICMP6_OUTMSGS, /*!< ICMPv6 SNMP OutMsgs */
95  RTNL_LINK_ICMP6_OUTERRORS, /*!< ICMPv6 SNMP OutErrors */
96  __RTNL_LINK_STATS_MAX,
98 
99 #define RTNL_LINK_STATS_MAX (__RTNL_LINK_STATS_MAX - 1)
100 
101 extern struct nla_policy rtln_link_policy[];
102 
103 extern struct rtnl_link *rtnl_link_alloc(void);
104 extern void rtnl_link_put(struct rtnl_link *);
105 
106 extern int rtnl_link_alloc_cache(struct nl_sock *, int, struct nl_cache **);
107 extern struct rtnl_link *rtnl_link_get(struct nl_cache *, int);
108 extern struct rtnl_link *rtnl_link_get_by_name(struct nl_cache *, const char *);
109 
110 
111 extern int rtnl_link_build_add_request(struct rtnl_link *, int,
112  struct nl_msg **);
113 extern int rtnl_link_add(struct nl_sock *, struct rtnl_link *, int);
114 extern int rtnl_link_build_change_request(struct rtnl_link *,
115  struct rtnl_link *, int,
116  struct nl_msg **);
117 extern int rtnl_link_change(struct nl_sock *, struct rtnl_link *,
118  struct rtnl_link *, int);
119 
120 extern int rtnl_link_build_delete_request(const struct rtnl_link *,
121  struct nl_msg **);
122 extern int rtnl_link_delete(struct nl_sock *, const struct rtnl_link *);
123 extern int rtnl_link_build_get_request(int, const char *,
124  struct nl_msg **);
125 extern int rtnl_link_get_kernel(struct nl_sock *, int, const char *,
126  struct rtnl_link **);
127 
128 /* Name <-> Index Translations */
129 extern char * rtnl_link_i2name(struct nl_cache *, int, char *, size_t);
130 extern int rtnl_link_name2i(struct nl_cache *, const char *);
131 
132 /* Name <-> Statistic Translations */
133 extern char * rtnl_link_stat2str(int, char *, size_t);
134 extern int rtnl_link_str2stat(const char *);
135 
136 /* Link Flags Translations */
137 extern char * rtnl_link_flags2str(int, char *, size_t);
138 extern int rtnl_link_str2flags(const char *);
139 
140 extern char * rtnl_link_operstate2str(uint8_t, char *, size_t);
141 extern int rtnl_link_str2operstate(const char *);
142 
143 extern char * rtnl_link_mode2str(uint8_t, char *, size_t);
144 extern int rtnl_link_str2mode(const char *);
145 
146 /* Carrier State Translations */
147 extern char * rtnl_link_carrier2str(uint8_t, char *, size_t);
148 extern int rtnl_link_str2carrier(const char *);
149 
150 /* Access Functions */
151 extern void rtnl_link_set_qdisc(struct rtnl_link *, const char *);
152 extern char * rtnl_link_get_qdisc(struct rtnl_link *);
153 
154 extern void rtnl_link_set_name(struct rtnl_link *, const char *);
155 extern char * rtnl_link_get_name(struct rtnl_link *);
156 
157 extern void rtnl_link_set_group(struct rtnl_link *, uint32_t);
158 extern uint32_t rtnl_link_get_group(struct rtnl_link *);
159 
160 extern void rtnl_link_set_flags(struct rtnl_link *, unsigned int);
161 extern void rtnl_link_unset_flags(struct rtnl_link *, unsigned int);
162 extern unsigned int rtnl_link_get_flags(struct rtnl_link *);
163 
164 extern void rtnl_link_set_mtu(struct rtnl_link *, unsigned int);
165 extern unsigned int rtnl_link_get_mtu(struct rtnl_link *);
166 
167 extern void rtnl_link_set_txqlen(struct rtnl_link *, unsigned int);
168 extern unsigned int rtnl_link_get_txqlen(struct rtnl_link *);
169 
170 extern void rtnl_link_set_ifindex(struct rtnl_link *, int);
171 extern int rtnl_link_get_ifindex(struct rtnl_link *);
172 
173 extern void rtnl_link_set_family(struct rtnl_link *, int);
174 extern int rtnl_link_get_family(struct rtnl_link *);
175 
176 extern void rtnl_link_set_arptype(struct rtnl_link *, unsigned int);
177 extern unsigned int rtnl_link_get_arptype(struct rtnl_link *);
178 
179 extern void rtnl_link_set_addr(struct rtnl_link *, struct nl_addr *);
180 extern struct nl_addr *rtnl_link_get_addr(struct rtnl_link *);
181 
182 extern void rtnl_link_set_broadcast(struct rtnl_link *, struct nl_addr *);
183 extern struct nl_addr *rtnl_link_get_broadcast(struct rtnl_link *);
184 
185 extern void rtnl_link_set_link(struct rtnl_link *, int);
186 extern int rtnl_link_get_link(struct rtnl_link *);
187 
188 extern void rtnl_link_set_master(struct rtnl_link *, int);
189 extern int rtnl_link_get_master(struct rtnl_link *);
190 
191 extern void rtnl_link_set_carrier(struct rtnl_link *, uint8_t);
192 extern uint8_t rtnl_link_get_carrier(struct rtnl_link *);
193 
194 extern void rtnl_link_set_operstate(struct rtnl_link *, uint8_t);
195 extern uint8_t rtnl_link_get_operstate(struct rtnl_link *);
196 
197 extern void rtnl_link_set_linkmode(struct rtnl_link *, uint8_t);
198 extern uint8_t rtnl_link_get_linkmode(struct rtnl_link *);
199 
200 extern const char * rtnl_link_get_ifalias(struct rtnl_link *);
201 extern void rtnl_link_set_ifalias(struct rtnl_link *, const char *);
202 
203 extern int rtnl_link_get_num_vf(struct rtnl_link *, uint32_t *);
204 
205 extern uint64_t rtnl_link_get_stat(struct rtnl_link *, rtnl_link_stat_id_t);
207  const uint64_t);
208 
209 extern int rtnl_link_set_type(struct rtnl_link *, const char *);
210 extern char * rtnl_link_get_type(struct rtnl_link *);
211 
212 extern void rtnl_link_set_promiscuity(struct rtnl_link *, uint32_t);
213 extern uint32_t rtnl_link_get_promiscuity(struct rtnl_link *);
214 
215 extern void rtnl_link_set_num_tx_queues(struct rtnl_link *, uint32_t);
216 extern uint32_t rtnl_link_get_num_tx_queues(struct rtnl_link *);
217 
218 extern void rtnl_link_set_num_rx_queues(struct rtnl_link *, uint32_t);
219 extern uint32_t rtnl_link_get_num_rx_queues(struct rtnl_link *);
220 
221 extern struct nl_data * rtnl_link_get_phys_port_id(struct rtnl_link *);
222 
223 extern void rtnl_link_set_ns_fd(struct rtnl_link *, int);
224 extern int rtnl_link_get_ns_fd(struct rtnl_link *);
225 extern void rtnl_link_set_ns_pid(struct rtnl_link *, pid_t);
226 extern pid_t rtnl_link_get_ns_pid(struct rtnl_link *);
227 
228 extern int rtnl_link_enslave_ifindex(struct nl_sock *, int, int);
229 extern int rtnl_link_enslave(struct nl_sock *, struct rtnl_link *,
230  struct rtnl_link *);
231 extern int rtnl_link_release_ifindex(struct nl_sock *, int);
232 extern int rtnl_link_release(struct nl_sock *, struct rtnl_link *);
233 extern int rtnl_link_fill_info(struct nl_msg *, struct rtnl_link *);
234 extern int rtnl_link_info_parse(struct rtnl_link *, struct nlattr **);
235 
236 
237 /* deprecated */
238 extern int rtnl_link_set_info_type(struct rtnl_link *, const char *) __attribute__((deprecated));
239 extern char * rtnl_link_get_info_type(struct rtnl_link *) __attribute__((deprecated));
240 extern void rtnl_link_set_weight(struct rtnl_link *, unsigned int) __attribute__((deprecated));
241 extern unsigned int rtnl_link_get_weight(struct rtnl_link *) __attribute__((deprecated));
242 
243 
244 #ifdef __cplusplus
245 }
246 #endif
247 
248 #endif