xref: /linux-6.15/include/uapi/linux/if_link.h (revision 275876e2)
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_PHYS_PORT_ID,
147 	IFLA_CARRIER_CHANGES,
148 	__IFLA_MAX
149 };
150 
151 
152 #define IFLA_MAX (__IFLA_MAX - 1)
153 
154 /* backwards compatibility for userspace */
155 #ifndef __KERNEL__
156 #define IFLA_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct ifinfomsg))))
157 #define IFLA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct ifinfomsg))
158 #endif
159 
160 enum {
161 	IFLA_INET_UNSPEC,
162 	IFLA_INET_CONF,
163 	__IFLA_INET_MAX,
164 };
165 
166 #define IFLA_INET_MAX (__IFLA_INET_MAX - 1)
167 
168 /* ifi_flags.
169 
170    IFF_* flags.
171 
172    The only change is:
173    IFF_LOOPBACK, IFF_BROADCAST and IFF_POINTOPOINT are
174    more not changeable by user. They describe link media
175    characteristics and set by device driver.
176 
177    Comments:
178    - Combination IFF_BROADCAST|IFF_POINTOPOINT is invalid
179    - If neither of these three flags are set;
180      the interface is NBMA.
181 
182    - IFF_MULTICAST does not mean anything special:
183    multicasts can be used on all not-NBMA links.
184    IFF_MULTICAST means that this media uses special encapsulation
185    for multicast frames. Apparently, all IFF_POINTOPOINT and
186    IFF_BROADCAST devices are able to use multicasts too.
187  */
188 
189 /* IFLA_LINK.
190    For usual devices it is equal ifi_index.
191    If it is a "virtual interface" (f.e. tunnel), ifi_link
192    can point to real physical interface (f.e. for bandwidth calculations),
193    or maybe 0, what means, that real media is unknown (usual
194    for IPIP tunnels, when route to endpoint is allowed to change)
195  */
196 
197 /* Subtype attributes for IFLA_PROTINFO */
198 enum {
199 	IFLA_INET6_UNSPEC,
200 	IFLA_INET6_FLAGS,	/* link flags			*/
201 	IFLA_INET6_CONF,	/* sysctl parameters		*/
202 	IFLA_INET6_STATS,	/* statistics			*/
203 	IFLA_INET6_MCAST,	/* MC things. What of them?	*/
204 	IFLA_INET6_CACHEINFO,	/* time values and max reasm size */
205 	IFLA_INET6_ICMP6STATS,	/* statistics (icmpv6)		*/
206 	IFLA_INET6_TOKEN,	/* device token			*/
207 	IFLA_INET6_ADDR_GEN_MODE, /* implicit address generator mode */
208 	__IFLA_INET6_MAX
209 };
210 
211 #define IFLA_INET6_MAX	(__IFLA_INET6_MAX - 1)
212 
213 enum in6_addr_gen_mode {
214 	IN6_ADDR_GEN_MODE_EUI64,
215 	IN6_ADDR_GEN_MODE_NONE,
216 };
217 
218 enum {
219 	BRIDGE_MODE_UNSPEC,
220 	BRIDGE_MODE_HAIRPIN,
221 };
222 
223 enum {
224 	IFLA_BRPORT_UNSPEC,
225 	IFLA_BRPORT_STATE,	/* Spanning tree state     */
226 	IFLA_BRPORT_PRIORITY,	/* "             priority  */
227 	IFLA_BRPORT_COST,	/* "             cost      */
228 	IFLA_BRPORT_MODE,	/* mode (hairpin)          */
229 	IFLA_BRPORT_GUARD,	/* bpdu guard              */
230 	IFLA_BRPORT_PROTECT,	/* root port protection    */
231 	IFLA_BRPORT_FAST_LEAVE,	/* multicast fast leave    */
232 	IFLA_BRPORT_LEARNING,	/* mac learning */
233 	IFLA_BRPORT_UNICAST_FLOOD, /* flood unicast traffic */
234 	__IFLA_BRPORT_MAX
235 };
236 #define IFLA_BRPORT_MAX (__IFLA_BRPORT_MAX - 1)
237 
238 struct ifla_cacheinfo {
239 	__u32	max_reasm_len;
240 	__u32	tstamp;		/* ipv6InterfaceTable updated timestamp */
241 	__u32	reachable_time;
242 	__u32	retrans_time;
243 };
244 
245 enum {
246 	IFLA_INFO_UNSPEC,
247 	IFLA_INFO_KIND,
248 	IFLA_INFO_DATA,
249 	IFLA_INFO_XSTATS,
250 	IFLA_INFO_SLAVE_KIND,
251 	IFLA_INFO_SLAVE_DATA,
252 	__IFLA_INFO_MAX,
253 };
254 
255 #define IFLA_INFO_MAX	(__IFLA_INFO_MAX - 1)
256 
257 /* VLAN section */
258 
259 enum {
260 	IFLA_VLAN_UNSPEC,
261 	IFLA_VLAN_ID,
262 	IFLA_VLAN_FLAGS,
263 	IFLA_VLAN_EGRESS_QOS,
264 	IFLA_VLAN_INGRESS_QOS,
265 	IFLA_VLAN_PROTOCOL,
266 	__IFLA_VLAN_MAX,
267 };
268 
269 #define IFLA_VLAN_MAX	(__IFLA_VLAN_MAX - 1)
270 
271 struct ifla_vlan_flags {
272 	__u32	flags;
273 	__u32	mask;
274 };
275 
276 enum {
277 	IFLA_VLAN_QOS_UNSPEC,
278 	IFLA_VLAN_QOS_MAPPING,
279 	__IFLA_VLAN_QOS_MAX
280 };
281 
282 #define IFLA_VLAN_QOS_MAX	(__IFLA_VLAN_QOS_MAX - 1)
283 
284 struct ifla_vlan_qos_mapping {
285 	__u32 from;
286 	__u32 to;
287 };
288 
289 /* MACVLAN section */
290 enum {
291 	IFLA_MACVLAN_UNSPEC,
292 	IFLA_MACVLAN_MODE,
293 	IFLA_MACVLAN_FLAGS,
294 	__IFLA_MACVLAN_MAX,
295 };
296 
297 #define IFLA_MACVLAN_MAX (__IFLA_MACVLAN_MAX - 1)
298 
299 enum macvlan_mode {
300 	MACVLAN_MODE_PRIVATE = 1, /* don't talk to other macvlans */
301 	MACVLAN_MODE_VEPA    = 2, /* talk to other ports through ext bridge */
302 	MACVLAN_MODE_BRIDGE  = 4, /* talk to bridge ports directly */
303 	MACVLAN_MODE_PASSTHRU = 8,/* take over the underlying device */
304 };
305 
306 #define MACVLAN_FLAG_NOPROMISC	1
307 
308 /* VXLAN section */
309 enum {
310 	IFLA_VXLAN_UNSPEC,
311 	IFLA_VXLAN_ID,
312 	IFLA_VXLAN_GROUP,	/* group or remote address */
313 	IFLA_VXLAN_LINK,
314 	IFLA_VXLAN_LOCAL,
315 	IFLA_VXLAN_TTL,
316 	IFLA_VXLAN_TOS,
317 	IFLA_VXLAN_LEARNING,
318 	IFLA_VXLAN_AGEING,
319 	IFLA_VXLAN_LIMIT,
320 	IFLA_VXLAN_PORT_RANGE,	/* source port */
321 	IFLA_VXLAN_PROXY,
322 	IFLA_VXLAN_RSC,
323 	IFLA_VXLAN_L2MISS,
324 	IFLA_VXLAN_L3MISS,
325 	IFLA_VXLAN_PORT,	/* destination port */
326 	IFLA_VXLAN_GROUP6,
327 	IFLA_VXLAN_LOCAL6,
328 	IFLA_VXLAN_UDP_CSUM,
329 	IFLA_VXLAN_UDP_ZERO_CSUM6_TX,
330 	IFLA_VXLAN_UDP_ZERO_CSUM6_RX,
331 	__IFLA_VXLAN_MAX
332 };
333 #define IFLA_VXLAN_MAX	(__IFLA_VXLAN_MAX - 1)
334 
335 struct ifla_vxlan_port_range {
336 	__be16	low;
337 	__be16	high;
338 };
339 
340 /* Bonding section */
341 
342 enum {
343 	IFLA_BOND_UNSPEC,
344 	IFLA_BOND_MODE,
345 	IFLA_BOND_ACTIVE_SLAVE,
346 	IFLA_BOND_MIIMON,
347 	IFLA_BOND_UPDELAY,
348 	IFLA_BOND_DOWNDELAY,
349 	IFLA_BOND_USE_CARRIER,
350 	IFLA_BOND_ARP_INTERVAL,
351 	IFLA_BOND_ARP_IP_TARGET,
352 	IFLA_BOND_ARP_VALIDATE,
353 	IFLA_BOND_ARP_ALL_TARGETS,
354 	IFLA_BOND_PRIMARY,
355 	IFLA_BOND_PRIMARY_RESELECT,
356 	IFLA_BOND_FAIL_OVER_MAC,
357 	IFLA_BOND_XMIT_HASH_POLICY,
358 	IFLA_BOND_RESEND_IGMP,
359 	IFLA_BOND_NUM_PEER_NOTIF,
360 	IFLA_BOND_ALL_SLAVES_ACTIVE,
361 	IFLA_BOND_MIN_LINKS,
362 	IFLA_BOND_LP_INTERVAL,
363 	IFLA_BOND_PACKETS_PER_SLAVE,
364 	IFLA_BOND_AD_LACP_RATE,
365 	IFLA_BOND_AD_SELECT,
366 	IFLA_BOND_AD_INFO,
367 	__IFLA_BOND_MAX,
368 };
369 
370 #define IFLA_BOND_MAX	(__IFLA_BOND_MAX - 1)
371 
372 enum {
373 	IFLA_BOND_AD_INFO_UNSPEC,
374 	IFLA_BOND_AD_INFO_AGGREGATOR,
375 	IFLA_BOND_AD_INFO_NUM_PORTS,
376 	IFLA_BOND_AD_INFO_ACTOR_KEY,
377 	IFLA_BOND_AD_INFO_PARTNER_KEY,
378 	IFLA_BOND_AD_INFO_PARTNER_MAC,
379 	__IFLA_BOND_AD_INFO_MAX,
380 };
381 
382 #define IFLA_BOND_AD_INFO_MAX	(__IFLA_BOND_AD_INFO_MAX - 1)
383 
384 enum {
385 	IFLA_BOND_SLAVE_UNSPEC,
386 	IFLA_BOND_SLAVE_STATE,
387 	IFLA_BOND_SLAVE_MII_STATUS,
388 	IFLA_BOND_SLAVE_LINK_FAILURE_COUNT,
389 	IFLA_BOND_SLAVE_PERM_HWADDR,
390 	IFLA_BOND_SLAVE_QUEUE_ID,
391 	IFLA_BOND_SLAVE_AD_AGGREGATOR_ID,
392 	__IFLA_BOND_SLAVE_MAX,
393 };
394 
395 #define IFLA_BOND_SLAVE_MAX	(__IFLA_BOND_SLAVE_MAX - 1)
396 
397 /* SR-IOV virtual function management section */
398 
399 enum {
400 	IFLA_VF_INFO_UNSPEC,
401 	IFLA_VF_INFO,
402 	__IFLA_VF_INFO_MAX,
403 };
404 
405 #define IFLA_VF_INFO_MAX (__IFLA_VF_INFO_MAX - 1)
406 
407 enum {
408 	IFLA_VF_UNSPEC,
409 	IFLA_VF_MAC,		/* Hardware queue specific attributes */
410 	IFLA_VF_VLAN,
411 	IFLA_VF_TX_RATE,	/* Max TX Bandwidth Allocation */
412 	IFLA_VF_SPOOFCHK,	/* Spoof Checking on/off switch */
413 	IFLA_VF_LINK_STATE,	/* link state enable/disable/auto switch */
414 	IFLA_VF_RATE,		/* Min and Max TX Bandwidth Allocation */
415 	__IFLA_VF_MAX,
416 };
417 
418 #define IFLA_VF_MAX (__IFLA_VF_MAX - 1)
419 
420 struct ifla_vf_mac {
421 	__u32 vf;
422 	__u8 mac[32]; /* MAX_ADDR_LEN */
423 };
424 
425 struct ifla_vf_vlan {
426 	__u32 vf;
427 	__u32 vlan; /* 0 - 4095, 0 disables VLAN filter */
428 	__u32 qos;
429 };
430 
431 struct ifla_vf_tx_rate {
432 	__u32 vf;
433 	__u32 rate; /* Max TX bandwidth in Mbps, 0 disables throttling */
434 };
435 
436 struct ifla_vf_rate {
437 	__u32 vf;
438 	__u32 min_tx_rate; /* Min Bandwidth in Mbps */
439 	__u32 max_tx_rate; /* Max Bandwidth in Mbps */
440 };
441 
442 struct ifla_vf_spoofchk {
443 	__u32 vf;
444 	__u32 setting;
445 };
446 
447 enum {
448 	IFLA_VF_LINK_STATE_AUTO,	/* link state of the uplink */
449 	IFLA_VF_LINK_STATE_ENABLE,	/* link always up */
450 	IFLA_VF_LINK_STATE_DISABLE,	/* link always down */
451 	__IFLA_VF_LINK_STATE_MAX,
452 };
453 
454 struct ifla_vf_link_state {
455 	__u32 vf;
456 	__u32 link_state;
457 };
458 
459 /* VF ports management section
460  *
461  *	Nested layout of set/get msg is:
462  *
463  *		[IFLA_NUM_VF]
464  *		[IFLA_VF_PORTS]
465  *			[IFLA_VF_PORT]
466  *				[IFLA_PORT_*], ...
467  *			[IFLA_VF_PORT]
468  *				[IFLA_PORT_*], ...
469  *			...
470  *		[IFLA_PORT_SELF]
471  *			[IFLA_PORT_*], ...
472  */
473 
474 enum {
475 	IFLA_VF_PORT_UNSPEC,
476 	IFLA_VF_PORT,			/* nest */
477 	__IFLA_VF_PORT_MAX,
478 };
479 
480 #define IFLA_VF_PORT_MAX (__IFLA_VF_PORT_MAX - 1)
481 
482 enum {
483 	IFLA_PORT_UNSPEC,
484 	IFLA_PORT_VF,			/* __u32 */
485 	IFLA_PORT_PROFILE,		/* string */
486 	IFLA_PORT_VSI_TYPE,		/* 802.1Qbg (pre-)standard VDP */
487 	IFLA_PORT_INSTANCE_UUID,	/* binary UUID */
488 	IFLA_PORT_HOST_UUID,		/* binary UUID */
489 	IFLA_PORT_REQUEST,		/* __u8 */
490 	IFLA_PORT_RESPONSE,		/* __u16, output only */
491 	__IFLA_PORT_MAX,
492 };
493 
494 #define IFLA_PORT_MAX (__IFLA_PORT_MAX - 1)
495 
496 #define PORT_PROFILE_MAX	40
497 #define PORT_UUID_MAX		16
498 #define PORT_SELF_VF		-1
499 
500 enum {
501 	PORT_REQUEST_PREASSOCIATE = 0,
502 	PORT_REQUEST_PREASSOCIATE_RR,
503 	PORT_REQUEST_ASSOCIATE,
504 	PORT_REQUEST_DISASSOCIATE,
505 };
506 
507 enum {
508 	PORT_VDP_RESPONSE_SUCCESS = 0,
509 	PORT_VDP_RESPONSE_INVALID_FORMAT,
510 	PORT_VDP_RESPONSE_INSUFFICIENT_RESOURCES,
511 	PORT_VDP_RESPONSE_UNUSED_VTID,
512 	PORT_VDP_RESPONSE_VTID_VIOLATION,
513 	PORT_VDP_RESPONSE_VTID_VERSION_VIOALTION,
514 	PORT_VDP_RESPONSE_OUT_OF_SYNC,
515 	/* 0x08-0xFF reserved for future VDP use */
516 	PORT_PROFILE_RESPONSE_SUCCESS = 0x100,
517 	PORT_PROFILE_RESPONSE_INPROGRESS,
518 	PORT_PROFILE_RESPONSE_INVALID,
519 	PORT_PROFILE_RESPONSE_BADSTATE,
520 	PORT_PROFILE_RESPONSE_INSUFFICIENT_RESOURCES,
521 	PORT_PROFILE_RESPONSE_ERROR,
522 };
523 
524 struct ifla_port_vsi {
525 	__u8 vsi_mgr_id;
526 	__u8 vsi_type_id[3];
527 	__u8 vsi_type_version;
528 	__u8 pad[3];
529 };
530 
531 
532 /* IPoIB section */
533 
534 enum {
535 	IFLA_IPOIB_UNSPEC,
536 	IFLA_IPOIB_PKEY,
537 	IFLA_IPOIB_MODE,
538 	IFLA_IPOIB_UMCAST,
539 	__IFLA_IPOIB_MAX
540 };
541 
542 enum {
543 	IPOIB_MODE_DATAGRAM  = 0, /* using unreliable datagram QPs */
544 	IPOIB_MODE_CONNECTED = 1, /* using connected QPs */
545 };
546 
547 #define IFLA_IPOIB_MAX (__IFLA_IPOIB_MAX - 1)
548 
549 
550 /* HSR section */
551 
552 enum {
553 	IFLA_HSR_UNSPEC,
554 	IFLA_HSR_SLAVE1,
555 	IFLA_HSR_SLAVE2,
556 	IFLA_HSR_MULTICAST_SPEC,	/* Last byte of supervision addr */
557 	IFLA_HSR_SUPERVISION_ADDR,	/* Supervision frame multicast addr */
558 	IFLA_HSR_SEQ_NR,
559 	__IFLA_HSR_MAX,
560 };
561 
562 #define IFLA_HSR_MAX (__IFLA_HSR_MAX - 1)
563 
564 #endif /* _UAPI_LINUX_IF_LINK_H */
565