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