xref: /linux-6.15/include/uapi/linux/if_link.h (revision 6ed7ffdd)
1 #ifndef _UAPI_LINUX_IF_LINK_H
2 #define _UAPI_LINUX_IF_LINK_H
3 
4 #include <linux/types.h>
5 #include <linux/netlink.h>
6 
7 /* This struct should be in sync with struct rtnl_link_stats64 */
8 struct rtnl_link_stats {
9 	__u32	rx_packets;		/* total packets received	*/
10 	__u32	tx_packets;		/* total packets transmitted	*/
11 	__u32	rx_bytes;		/* total bytes received 	*/
12 	__u32	tx_bytes;		/* total bytes transmitted	*/
13 	__u32	rx_errors;		/* bad packets received		*/
14 	__u32	tx_errors;		/* packet transmit problems	*/
15 	__u32	rx_dropped;		/* no space in linux buffers	*/
16 	__u32	tx_dropped;		/* no space available in linux	*/
17 	__u32	multicast;		/* multicast packets received	*/
18 	__u32	collisions;
19 
20 	/* detailed rx_errors: */
21 	__u32	rx_length_errors;
22 	__u32	rx_over_errors;		/* receiver ring buff overflow	*/
23 	__u32	rx_crc_errors;		/* recved pkt with crc error	*/
24 	__u32	rx_frame_errors;	/* recv'd frame alignment error */
25 	__u32	rx_fifo_errors;		/* recv'r fifo overrun		*/
26 	__u32	rx_missed_errors;	/* receiver missed packet	*/
27 
28 	/* detailed tx_errors */
29 	__u32	tx_aborted_errors;
30 	__u32	tx_carrier_errors;
31 	__u32	tx_fifo_errors;
32 	__u32	tx_heartbeat_errors;
33 	__u32	tx_window_errors;
34 
35 	/* for cslip etc */
36 	__u32	rx_compressed;
37 	__u32	tx_compressed;
38 };
39 
40 /* The main device statistics structure */
41 struct rtnl_link_stats64 {
42 	__u64	rx_packets;		/* total packets received	*/
43 	__u64	tx_packets;		/* total packets transmitted	*/
44 	__u64	rx_bytes;		/* total bytes received 	*/
45 	__u64	tx_bytes;		/* total bytes transmitted	*/
46 	__u64	rx_errors;		/* bad packets received		*/
47 	__u64	tx_errors;		/* packet transmit problems	*/
48 	__u64	rx_dropped;		/* no space in linux buffers	*/
49 	__u64	tx_dropped;		/* no space available in linux	*/
50 	__u64	multicast;		/* multicast packets received	*/
51 	__u64	collisions;
52 
53 	/* detailed rx_errors: */
54 	__u64	rx_length_errors;
55 	__u64	rx_over_errors;		/* receiver ring buff overflow	*/
56 	__u64	rx_crc_errors;		/* recved pkt with crc error	*/
57 	__u64	rx_frame_errors;	/* recv'd frame alignment error */
58 	__u64	rx_fifo_errors;		/* recv'r fifo overrun		*/
59 	__u64	rx_missed_errors;	/* receiver missed packet	*/
60 
61 	/* detailed tx_errors */
62 	__u64	tx_aborted_errors;
63 	__u64	tx_carrier_errors;
64 	__u64	tx_fifo_errors;
65 	__u64	tx_heartbeat_errors;
66 	__u64	tx_window_errors;
67 
68 	/* for cslip etc */
69 	__u64	rx_compressed;
70 	__u64	tx_compressed;
71 };
72 
73 /* The struct should be in sync with struct ifmap */
74 struct rtnl_link_ifmap {
75 	__u64	mem_start;
76 	__u64	mem_end;
77 	__u64	base_addr;
78 	__u16	irq;
79 	__u8	dma;
80 	__u8	port;
81 };
82 
83 /*
84  * IFLA_AF_SPEC
85  *   Contains nested attributes for address family specific attributes.
86  *   Each address family may create a attribute with the address family
87  *   number as type and create its own attribute structure in it.
88  *
89  *   Example:
90  *   [IFLA_AF_SPEC] = {
91  *       [AF_INET] = {
92  *           [IFLA_INET_CONF] = ...,
93  *       },
94  *       [AF_INET6] = {
95  *           [IFLA_INET6_FLAGS] = ...,
96  *           [IFLA_INET6_CONF] = ...,
97  *       }
98  *   }
99  */
100 
101 enum {
102 	IFLA_UNSPEC,
103 	IFLA_ADDRESS,
104 	IFLA_BROADCAST,
105 	IFLA_IFNAME,
106 	IFLA_MTU,
107 	IFLA_LINK,
108 	IFLA_QDISC,
109 	IFLA_STATS,
110 	IFLA_COST,
111 #define IFLA_COST IFLA_COST
112 	IFLA_PRIORITY,
113 #define IFLA_PRIORITY IFLA_PRIORITY
114 	IFLA_MASTER,
115 #define IFLA_MASTER IFLA_MASTER
116 	IFLA_WIRELESS,		/* Wireless Extension event - see wireless.h */
117 #define IFLA_WIRELESS IFLA_WIRELESS
118 	IFLA_PROTINFO,		/* Protocol specific information for a link */
119 #define IFLA_PROTINFO IFLA_PROTINFO
120 	IFLA_TXQLEN,
121 #define IFLA_TXQLEN IFLA_TXQLEN
122 	IFLA_MAP,
123 #define IFLA_MAP IFLA_MAP
124 	IFLA_WEIGHT,
125 #define IFLA_WEIGHT IFLA_WEIGHT
126 	IFLA_OPERSTATE,
127 	IFLA_LINKMODE,
128 	IFLA_LINKINFO,
129 #define IFLA_LINKINFO IFLA_LINKINFO
130 	IFLA_NET_NS_PID,
131 	IFLA_IFALIAS,
132 	IFLA_NUM_VF,		/* Number of VFs if device is SR-IOV PF */
133 	IFLA_VFINFO_LIST,
134 	IFLA_STATS64,
135 	IFLA_VF_PORTS,
136 	IFLA_PORT_SELF,
137 	IFLA_AF_SPEC,
138 	IFLA_GROUP,		/* Group the device belongs to */
139 	IFLA_NET_NS_FD,
140 	IFLA_EXT_MASK,		/* Extended info mask, VFs, etc */
141 	IFLA_PROMISCUITY,	/* Promiscuity count: > 0 means acts PROMISC */
142 #define IFLA_PROMISCUITY IFLA_PROMISCUITY
143 	IFLA_NUM_TX_QUEUES,
144 	IFLA_NUM_RX_QUEUES,
145 	IFLA_CARRIER,
146 	__IFLA_MAX
147 };
148 
149 
150 #define IFLA_MAX (__IFLA_MAX - 1)
151 
152 /* backwards compatibility for userspace */
153 #ifndef __KERNEL__
154 #define IFLA_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct ifinfomsg))))
155 #define IFLA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct ifinfomsg))
156 #endif
157 
158 enum {
159 	IFLA_INET_UNSPEC,
160 	IFLA_INET_CONF,
161 	__IFLA_INET_MAX,
162 };
163 
164 #define IFLA_INET_MAX (__IFLA_INET_MAX - 1)
165 
166 /* ifi_flags.
167 
168    IFF_* flags.
169 
170    The only change is:
171    IFF_LOOPBACK, IFF_BROADCAST and IFF_POINTOPOINT are
172    more not changeable by user. They describe link media
173    characteristics and set by device driver.
174 
175    Comments:
176    - Combination IFF_BROADCAST|IFF_POINTOPOINT is invalid
177    - If neither of these three flags are set;
178      the interface is NBMA.
179 
180    - IFF_MULTICAST does not mean anything special:
181    multicasts can be used on all not-NBMA links.
182    IFF_MULTICAST means that this media uses special encapsulation
183    for multicast frames. Apparently, all IFF_POINTOPOINT and
184    IFF_BROADCAST devices are able to use multicasts too.
185  */
186 
187 /* IFLA_LINK.
188    For usual devices it is equal ifi_index.
189    If it is a "virtual interface" (f.e. tunnel), ifi_link
190    can point to real physical interface (f.e. for bandwidth calculations),
191    or maybe 0, what means, that real media is unknown (usual
192    for IPIP tunnels, when route to endpoint is allowed to change)
193  */
194 
195 /* Subtype attributes for IFLA_PROTINFO */
196 enum {
197 	IFLA_INET6_UNSPEC,
198 	IFLA_INET6_FLAGS,	/* link flags			*/
199 	IFLA_INET6_CONF,	/* sysctl parameters		*/
200 	IFLA_INET6_STATS,	/* statistics			*/
201 	IFLA_INET6_MCAST,	/* MC things. What of them?	*/
202 	IFLA_INET6_CACHEINFO,	/* time values and max reasm size */
203 	IFLA_INET6_ICMP6STATS,	/* statistics (icmpv6)		*/
204 	__IFLA_INET6_MAX
205 };
206 
207 #define IFLA_INET6_MAX	(__IFLA_INET6_MAX - 1)
208 
209 enum {
210 	BRIDGE_MODE_UNSPEC,
211 	BRIDGE_MODE_HAIRPIN,
212 };
213 
214 enum {
215 	IFLA_BRPORT_UNSPEC,
216 	IFLA_BRPORT_STATE,	/* Spanning tree state     */
217 	IFLA_BRPORT_PRIORITY,	/* "             priority  */
218 	IFLA_BRPORT_COST,	/* "             cost      */
219 	IFLA_BRPORT_MODE,	/* mode (hairpin)          */
220 	IFLA_BRPORT_GUARD,	/* bpdu guard              */
221 	IFLA_BRPORT_PROTECT,	/* root port protection    */
222 	IFLA_BRPORT_FAST_LEAVE,	/* multicast fast leave    */
223 	__IFLA_BRPORT_MAX
224 };
225 #define IFLA_BRPORT_MAX (__IFLA_BRPORT_MAX - 1)
226 
227 struct ifla_cacheinfo {
228 	__u32	max_reasm_len;
229 	__u32	tstamp;		/* ipv6InterfaceTable updated timestamp */
230 	__u32	reachable_time;
231 	__u32	retrans_time;
232 };
233 
234 enum {
235 	IFLA_INFO_UNSPEC,
236 	IFLA_INFO_KIND,
237 	IFLA_INFO_DATA,
238 	IFLA_INFO_XSTATS,
239 	__IFLA_INFO_MAX,
240 };
241 
242 #define IFLA_INFO_MAX	(__IFLA_INFO_MAX - 1)
243 
244 /* VLAN section */
245 
246 enum {
247 	IFLA_VLAN_UNSPEC,
248 	IFLA_VLAN_ID,
249 	IFLA_VLAN_FLAGS,
250 	IFLA_VLAN_EGRESS_QOS,
251 	IFLA_VLAN_INGRESS_QOS,
252 	__IFLA_VLAN_MAX,
253 };
254 
255 #define IFLA_VLAN_MAX	(__IFLA_VLAN_MAX - 1)
256 
257 struct ifla_vlan_flags {
258 	__u32	flags;
259 	__u32	mask;
260 };
261 
262 enum {
263 	IFLA_VLAN_QOS_UNSPEC,
264 	IFLA_VLAN_QOS_MAPPING,
265 	__IFLA_VLAN_QOS_MAX
266 };
267 
268 #define IFLA_VLAN_QOS_MAX	(__IFLA_VLAN_QOS_MAX - 1)
269 
270 struct ifla_vlan_qos_mapping {
271 	__u32 from;
272 	__u32 to;
273 };
274 
275 /* MACVLAN section */
276 enum {
277 	IFLA_MACVLAN_UNSPEC,
278 	IFLA_MACVLAN_MODE,
279 	IFLA_MACVLAN_FLAGS,
280 	__IFLA_MACVLAN_MAX,
281 };
282 
283 #define IFLA_MACVLAN_MAX (__IFLA_MACVLAN_MAX - 1)
284 
285 enum macvlan_mode {
286 	MACVLAN_MODE_PRIVATE = 1, /* don't talk to other macvlans */
287 	MACVLAN_MODE_VEPA    = 2, /* talk to other ports through ext bridge */
288 	MACVLAN_MODE_BRIDGE  = 4, /* talk to bridge ports directly */
289 	MACVLAN_MODE_PASSTHRU = 8,/* take over the underlying device */
290 };
291 
292 #define MACVLAN_FLAG_NOPROMISC	1
293 
294 /* VXLAN section */
295 enum {
296 	IFLA_VXLAN_UNSPEC,
297 	IFLA_VXLAN_ID,
298 	IFLA_VXLAN_GROUP,
299 	IFLA_VXLAN_LINK,
300 	IFLA_VXLAN_LOCAL,
301 	IFLA_VXLAN_TTL,
302 	IFLA_VXLAN_TOS,
303 	IFLA_VXLAN_LEARNING,
304 	IFLA_VXLAN_AGEING,
305 	IFLA_VXLAN_LIMIT,
306 	IFLA_VXLAN_PORT_RANGE,
307 	IFLA_VXLAN_PROXY,
308 	IFLA_VXLAN_RSC,
309 	IFLA_VXLAN_L2MISS,
310 	IFLA_VXLAN_L3MISS,
311 	__IFLA_VXLAN_MAX
312 };
313 #define IFLA_VXLAN_MAX	(__IFLA_VXLAN_MAX - 1)
314 
315 struct ifla_vxlan_port_range {
316 	__be16	low;
317 	__be16	high;
318 };
319 
320 /* SR-IOV virtual function management section */
321 
322 enum {
323 	IFLA_VF_INFO_UNSPEC,
324 	IFLA_VF_INFO,
325 	__IFLA_VF_INFO_MAX,
326 };
327 
328 #define IFLA_VF_INFO_MAX (__IFLA_VF_INFO_MAX - 1)
329 
330 enum {
331 	IFLA_VF_UNSPEC,
332 	IFLA_VF_MAC,		/* Hardware queue specific attributes */
333 	IFLA_VF_VLAN,
334 	IFLA_VF_TX_RATE,	/* TX Bandwidth Allocation */
335 	IFLA_VF_SPOOFCHK,	/* Spoof Checking on/off switch */
336 	__IFLA_VF_MAX,
337 };
338 
339 #define IFLA_VF_MAX (__IFLA_VF_MAX - 1)
340 
341 struct ifla_vf_mac {
342 	__u32 vf;
343 	__u8 mac[32]; /* MAX_ADDR_LEN */
344 };
345 
346 struct ifla_vf_vlan {
347 	__u32 vf;
348 	__u32 vlan; /* 0 - 4095, 0 disables VLAN filter */
349 	__u32 qos;
350 };
351 
352 struct ifla_vf_tx_rate {
353 	__u32 vf;
354 	__u32 rate; /* Max TX bandwidth in Mbps, 0 disables throttling */
355 };
356 
357 struct ifla_vf_spoofchk {
358 	__u32 vf;
359 	__u32 setting;
360 };
361 
362 /* VF ports management section
363  *
364  *	Nested layout of set/get msg is:
365  *
366  *		[IFLA_NUM_VF]
367  *		[IFLA_VF_PORTS]
368  *			[IFLA_VF_PORT]
369  *				[IFLA_PORT_*], ...
370  *			[IFLA_VF_PORT]
371  *				[IFLA_PORT_*], ...
372  *			...
373  *		[IFLA_PORT_SELF]
374  *			[IFLA_PORT_*], ...
375  */
376 
377 enum {
378 	IFLA_VF_PORT_UNSPEC,
379 	IFLA_VF_PORT,			/* nest */
380 	__IFLA_VF_PORT_MAX,
381 };
382 
383 #define IFLA_VF_PORT_MAX (__IFLA_VF_PORT_MAX - 1)
384 
385 enum {
386 	IFLA_PORT_UNSPEC,
387 	IFLA_PORT_VF,			/* __u32 */
388 	IFLA_PORT_PROFILE,		/* string */
389 	IFLA_PORT_VSI_TYPE,		/* 802.1Qbg (pre-)standard VDP */
390 	IFLA_PORT_INSTANCE_UUID,	/* binary UUID */
391 	IFLA_PORT_HOST_UUID,		/* binary UUID */
392 	IFLA_PORT_REQUEST,		/* __u8 */
393 	IFLA_PORT_RESPONSE,		/* __u16, output only */
394 	__IFLA_PORT_MAX,
395 };
396 
397 #define IFLA_PORT_MAX (__IFLA_PORT_MAX - 1)
398 
399 #define PORT_PROFILE_MAX	40
400 #define PORT_UUID_MAX		16
401 #define PORT_SELF_VF		-1
402 
403 enum {
404 	PORT_REQUEST_PREASSOCIATE = 0,
405 	PORT_REQUEST_PREASSOCIATE_RR,
406 	PORT_REQUEST_ASSOCIATE,
407 	PORT_REQUEST_DISASSOCIATE,
408 };
409 
410 enum {
411 	PORT_VDP_RESPONSE_SUCCESS = 0,
412 	PORT_VDP_RESPONSE_INVALID_FORMAT,
413 	PORT_VDP_RESPONSE_INSUFFICIENT_RESOURCES,
414 	PORT_VDP_RESPONSE_UNUSED_VTID,
415 	PORT_VDP_RESPONSE_VTID_VIOLATION,
416 	PORT_VDP_RESPONSE_VTID_VERSION_VIOALTION,
417 	PORT_VDP_RESPONSE_OUT_OF_SYNC,
418 	/* 0x08-0xFF reserved for future VDP use */
419 	PORT_PROFILE_RESPONSE_SUCCESS = 0x100,
420 	PORT_PROFILE_RESPONSE_INPROGRESS,
421 	PORT_PROFILE_RESPONSE_INVALID,
422 	PORT_PROFILE_RESPONSE_BADSTATE,
423 	PORT_PROFILE_RESPONSE_INSUFFICIENT_RESOURCES,
424 	PORT_PROFILE_RESPONSE_ERROR,
425 };
426 
427 struct ifla_port_vsi {
428 	__u8 vsi_mgr_id;
429 	__u8 vsi_type_id[3];
430 	__u8 vsi_type_version;
431 	__u8 pad[3];
432 };
433 
434 
435 /* IPoIB section */
436 
437 enum {
438 	IFLA_IPOIB_UNSPEC,
439 	IFLA_IPOIB_PKEY,
440 	IFLA_IPOIB_MODE,
441 	IFLA_IPOIB_UMCAST,
442 	__IFLA_IPOIB_MAX
443 };
444 
445 enum {
446 	IPOIB_MODE_DATAGRAM  = 0, /* using unreliable datagram QPs */
447 	IPOIB_MODE_CONNECTED = 1, /* using connected QPs */
448 };
449 
450 #define IFLA_IPOIB_MAX (__IFLA_IPOIB_MAX - 1)
451 
452 #endif /* _UAPI_LINUX_IF_LINK_H */
453