xref: /linux-6.15/include/uapi/linux/if_link.h (revision bb66fc67)
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_MAX
208 };
209 
210 #define IFLA_INET6_MAX	(__IFLA_INET6_MAX - 1)
211 
212 enum {
213 	BRIDGE_MODE_UNSPEC,
214 	BRIDGE_MODE_HAIRPIN,
215 };
216 
217 enum {
218 	IFLA_BRPORT_UNSPEC,
219 	IFLA_BRPORT_STATE,	/* Spanning tree state     */
220 	IFLA_BRPORT_PRIORITY,	/* "             priority  */
221 	IFLA_BRPORT_COST,	/* "             cost      */
222 	IFLA_BRPORT_MODE,	/* mode (hairpin)          */
223 	IFLA_BRPORT_GUARD,	/* bpdu guard              */
224 	IFLA_BRPORT_PROTECT,	/* root port protection    */
225 	IFLA_BRPORT_FAST_LEAVE,	/* multicast fast leave    */
226 	IFLA_BRPORT_LEARNING,	/* mac learning */
227 	IFLA_BRPORT_UNICAST_FLOOD, /* flood unicast traffic */
228 	__IFLA_BRPORT_MAX
229 };
230 #define IFLA_BRPORT_MAX (__IFLA_BRPORT_MAX - 1)
231 
232 struct ifla_cacheinfo {
233 	__u32	max_reasm_len;
234 	__u32	tstamp;		/* ipv6InterfaceTable updated timestamp */
235 	__u32	reachable_time;
236 	__u32	retrans_time;
237 };
238 
239 enum {
240 	IFLA_INFO_UNSPEC,
241 	IFLA_INFO_KIND,
242 	IFLA_INFO_DATA,
243 	IFLA_INFO_XSTATS,
244 	IFLA_INFO_SLAVE_KIND,
245 	IFLA_INFO_SLAVE_DATA,
246 	__IFLA_INFO_MAX,
247 };
248 
249 #define IFLA_INFO_MAX	(__IFLA_INFO_MAX - 1)
250 
251 /* VLAN section */
252 
253 enum {
254 	IFLA_VLAN_UNSPEC,
255 	IFLA_VLAN_ID,
256 	IFLA_VLAN_FLAGS,
257 	IFLA_VLAN_EGRESS_QOS,
258 	IFLA_VLAN_INGRESS_QOS,
259 	IFLA_VLAN_PROTOCOL,
260 	__IFLA_VLAN_MAX,
261 };
262 
263 #define IFLA_VLAN_MAX	(__IFLA_VLAN_MAX - 1)
264 
265 struct ifla_vlan_flags {
266 	__u32	flags;
267 	__u32	mask;
268 };
269 
270 enum {
271 	IFLA_VLAN_QOS_UNSPEC,
272 	IFLA_VLAN_QOS_MAPPING,
273 	__IFLA_VLAN_QOS_MAX
274 };
275 
276 #define IFLA_VLAN_QOS_MAX	(__IFLA_VLAN_QOS_MAX - 1)
277 
278 struct ifla_vlan_qos_mapping {
279 	__u32 from;
280 	__u32 to;
281 };
282 
283 /* MACVLAN section */
284 enum {
285 	IFLA_MACVLAN_UNSPEC,
286 	IFLA_MACVLAN_MODE,
287 	IFLA_MACVLAN_FLAGS,
288 	__IFLA_MACVLAN_MAX,
289 };
290 
291 #define IFLA_MACVLAN_MAX (__IFLA_MACVLAN_MAX - 1)
292 
293 enum macvlan_mode {
294 	MACVLAN_MODE_PRIVATE = 1, /* don't talk to other macvlans */
295 	MACVLAN_MODE_VEPA    = 2, /* talk to other ports through ext bridge */
296 	MACVLAN_MODE_BRIDGE  = 4, /* talk to bridge ports directly */
297 	MACVLAN_MODE_PASSTHRU = 8,/* take over the underlying device */
298 };
299 
300 #define MACVLAN_FLAG_NOPROMISC	1
301 
302 /* VXLAN section */
303 enum {
304 	IFLA_VXLAN_UNSPEC,
305 	IFLA_VXLAN_ID,
306 	IFLA_VXLAN_GROUP,	/* group or remote address */
307 	IFLA_VXLAN_LINK,
308 	IFLA_VXLAN_LOCAL,
309 	IFLA_VXLAN_TTL,
310 	IFLA_VXLAN_TOS,
311 	IFLA_VXLAN_LEARNING,
312 	IFLA_VXLAN_AGEING,
313 	IFLA_VXLAN_LIMIT,
314 	IFLA_VXLAN_PORT_RANGE,	/* source port */
315 	IFLA_VXLAN_PROXY,
316 	IFLA_VXLAN_RSC,
317 	IFLA_VXLAN_L2MISS,
318 	IFLA_VXLAN_L3MISS,
319 	IFLA_VXLAN_PORT,	/* destination port */
320 	IFLA_VXLAN_GROUP6,
321 	IFLA_VXLAN_LOCAL6,
322 	__IFLA_VXLAN_MAX
323 };
324 #define IFLA_VXLAN_MAX	(__IFLA_VXLAN_MAX - 1)
325 
326 struct ifla_vxlan_port_range {
327 	__be16	low;
328 	__be16	high;
329 };
330 
331 /* Bonding section */
332 
333 enum {
334 	IFLA_BOND_UNSPEC,
335 	IFLA_BOND_MODE,
336 	IFLA_BOND_ACTIVE_SLAVE,
337 	IFLA_BOND_MIIMON,
338 	IFLA_BOND_UPDELAY,
339 	IFLA_BOND_DOWNDELAY,
340 	IFLA_BOND_USE_CARRIER,
341 	IFLA_BOND_ARP_INTERVAL,
342 	IFLA_BOND_ARP_IP_TARGET,
343 	IFLA_BOND_ARP_VALIDATE,
344 	IFLA_BOND_ARP_ALL_TARGETS,
345 	IFLA_BOND_PRIMARY,
346 	IFLA_BOND_PRIMARY_RESELECT,
347 	IFLA_BOND_FAIL_OVER_MAC,
348 	IFLA_BOND_XMIT_HASH_POLICY,
349 	IFLA_BOND_RESEND_IGMP,
350 	IFLA_BOND_NUM_PEER_NOTIF,
351 	IFLA_BOND_ALL_SLAVES_ACTIVE,
352 	IFLA_BOND_MIN_LINKS,
353 	IFLA_BOND_LP_INTERVAL,
354 	IFLA_BOND_PACKETS_PER_SLAVE,
355 	IFLA_BOND_AD_LACP_RATE,
356 	IFLA_BOND_AD_SELECT,
357 	IFLA_BOND_AD_INFO,
358 	__IFLA_BOND_MAX,
359 };
360 
361 #define IFLA_BOND_MAX	(__IFLA_BOND_MAX - 1)
362 
363 enum {
364 	IFLA_BOND_AD_INFO_UNSPEC,
365 	IFLA_BOND_AD_INFO_AGGREGATOR,
366 	IFLA_BOND_AD_INFO_NUM_PORTS,
367 	IFLA_BOND_AD_INFO_ACTOR_KEY,
368 	IFLA_BOND_AD_INFO_PARTNER_KEY,
369 	IFLA_BOND_AD_INFO_PARTNER_MAC,
370 	__IFLA_BOND_AD_INFO_MAX,
371 };
372 
373 #define IFLA_BOND_AD_INFO_MAX	(__IFLA_BOND_AD_INFO_MAX - 1)
374 
375 enum {
376 	IFLA_BOND_SLAVE_UNSPEC,
377 	IFLA_BOND_SLAVE_STATE,
378 	IFLA_BOND_SLAVE_MII_STATUS,
379 	IFLA_BOND_SLAVE_LINK_FAILURE_COUNT,
380 	IFLA_BOND_SLAVE_PERM_HWADDR,
381 	IFLA_BOND_SLAVE_QUEUE_ID,
382 	IFLA_BOND_SLAVE_AD_AGGREGATOR_ID,
383 	__IFLA_BOND_SLAVE_MAX,
384 };
385 
386 #define IFLA_BOND_SLAVE_MAX	(__IFLA_BOND_SLAVE_MAX - 1)
387 
388 /* SR-IOV virtual function management section */
389 
390 enum {
391 	IFLA_VF_INFO_UNSPEC,
392 	IFLA_VF_INFO,
393 	__IFLA_VF_INFO_MAX,
394 };
395 
396 #define IFLA_VF_INFO_MAX (__IFLA_VF_INFO_MAX - 1)
397 
398 enum {
399 	IFLA_VF_UNSPEC,
400 	IFLA_VF_MAC,		/* Hardware queue specific attributes */
401 	IFLA_VF_VLAN,
402 	IFLA_VF_TX_RATE,	/* TX Bandwidth Allocation */
403 	IFLA_VF_SPOOFCHK,	/* Spoof Checking on/off switch */
404 	IFLA_VF_LINK_STATE,	/* link state enable/disable/auto switch */
405 	__IFLA_VF_MAX,
406 };
407 
408 #define IFLA_VF_MAX (__IFLA_VF_MAX - 1)
409 
410 struct ifla_vf_mac {
411 	__u32 vf;
412 	__u8 mac[32]; /* MAX_ADDR_LEN */
413 };
414 
415 struct ifla_vf_vlan {
416 	__u32 vf;
417 	__u32 vlan; /* 0 - 4095, 0 disables VLAN filter */
418 	__u32 qos;
419 };
420 
421 struct ifla_vf_tx_rate {
422 	__u32 vf;
423 	__u32 rate; /* Max TX bandwidth in Mbps, 0 disables throttling */
424 };
425 
426 struct ifla_vf_spoofchk {
427 	__u32 vf;
428 	__u32 setting;
429 };
430 
431 enum {
432 	IFLA_VF_LINK_STATE_AUTO,	/* link state of the uplink */
433 	IFLA_VF_LINK_STATE_ENABLE,	/* link always up */
434 	IFLA_VF_LINK_STATE_DISABLE,	/* link always down */
435 	__IFLA_VF_LINK_STATE_MAX,
436 };
437 
438 struct ifla_vf_link_state {
439 	__u32 vf;
440 	__u32 link_state;
441 };
442 
443 /* VF ports management section
444  *
445  *	Nested layout of set/get msg is:
446  *
447  *		[IFLA_NUM_VF]
448  *		[IFLA_VF_PORTS]
449  *			[IFLA_VF_PORT]
450  *				[IFLA_PORT_*], ...
451  *			[IFLA_VF_PORT]
452  *				[IFLA_PORT_*], ...
453  *			...
454  *		[IFLA_PORT_SELF]
455  *			[IFLA_PORT_*], ...
456  */
457 
458 enum {
459 	IFLA_VF_PORT_UNSPEC,
460 	IFLA_VF_PORT,			/* nest */
461 	__IFLA_VF_PORT_MAX,
462 };
463 
464 #define IFLA_VF_PORT_MAX (__IFLA_VF_PORT_MAX - 1)
465 
466 enum {
467 	IFLA_PORT_UNSPEC,
468 	IFLA_PORT_VF,			/* __u32 */
469 	IFLA_PORT_PROFILE,		/* string */
470 	IFLA_PORT_VSI_TYPE,		/* 802.1Qbg (pre-)standard VDP */
471 	IFLA_PORT_INSTANCE_UUID,	/* binary UUID */
472 	IFLA_PORT_HOST_UUID,		/* binary UUID */
473 	IFLA_PORT_REQUEST,		/* __u8 */
474 	IFLA_PORT_RESPONSE,		/* __u16, output only */
475 	__IFLA_PORT_MAX,
476 };
477 
478 #define IFLA_PORT_MAX (__IFLA_PORT_MAX - 1)
479 
480 #define PORT_PROFILE_MAX	40
481 #define PORT_UUID_MAX		16
482 #define PORT_SELF_VF		-1
483 
484 enum {
485 	PORT_REQUEST_PREASSOCIATE = 0,
486 	PORT_REQUEST_PREASSOCIATE_RR,
487 	PORT_REQUEST_ASSOCIATE,
488 	PORT_REQUEST_DISASSOCIATE,
489 };
490 
491 enum {
492 	PORT_VDP_RESPONSE_SUCCESS = 0,
493 	PORT_VDP_RESPONSE_INVALID_FORMAT,
494 	PORT_VDP_RESPONSE_INSUFFICIENT_RESOURCES,
495 	PORT_VDP_RESPONSE_UNUSED_VTID,
496 	PORT_VDP_RESPONSE_VTID_VIOLATION,
497 	PORT_VDP_RESPONSE_VTID_VERSION_VIOALTION,
498 	PORT_VDP_RESPONSE_OUT_OF_SYNC,
499 	/* 0x08-0xFF reserved for future VDP use */
500 	PORT_PROFILE_RESPONSE_SUCCESS = 0x100,
501 	PORT_PROFILE_RESPONSE_INPROGRESS,
502 	PORT_PROFILE_RESPONSE_INVALID,
503 	PORT_PROFILE_RESPONSE_BADSTATE,
504 	PORT_PROFILE_RESPONSE_INSUFFICIENT_RESOURCES,
505 	PORT_PROFILE_RESPONSE_ERROR,
506 };
507 
508 struct ifla_port_vsi {
509 	__u8 vsi_mgr_id;
510 	__u8 vsi_type_id[3];
511 	__u8 vsi_type_version;
512 	__u8 pad[3];
513 };
514 
515 
516 /* IPoIB section */
517 
518 enum {
519 	IFLA_IPOIB_UNSPEC,
520 	IFLA_IPOIB_PKEY,
521 	IFLA_IPOIB_MODE,
522 	IFLA_IPOIB_UMCAST,
523 	__IFLA_IPOIB_MAX
524 };
525 
526 enum {
527 	IPOIB_MODE_DATAGRAM  = 0, /* using unreliable datagram QPs */
528 	IPOIB_MODE_CONNECTED = 1, /* using connected QPs */
529 };
530 
531 #define IFLA_IPOIB_MAX (__IFLA_IPOIB_MAX - 1)
532 
533 
534 /* HSR section */
535 
536 enum {
537 	IFLA_HSR_UNSPEC,
538 	IFLA_HSR_SLAVE1,
539 	IFLA_HSR_SLAVE2,
540 	IFLA_HSR_MULTICAST_SPEC,	/* Last byte of supervision addr */
541 	IFLA_HSR_SUPERVISION_ADDR,	/* Supervision frame multicast addr */
542 	IFLA_HSR_SEQ_NR,
543 	__IFLA_HSR_MAX,
544 };
545 
546 #define IFLA_HSR_MAX (__IFLA_HSR_MAX - 1)
547 
548 #endif /* _UAPI_LINUX_IF_LINK_H */
549