xref: /linux-6.15/include/uapi/linux/if_link.h (revision f5e4e7fd)
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_TOKEN,	/* device token			*/
205 	__IFLA_INET6_MAX
206 };
207 
208 #define IFLA_INET6_MAX	(__IFLA_INET6_MAX - 1)
209 
210 enum {
211 	BRIDGE_MODE_UNSPEC,
212 	BRIDGE_MODE_HAIRPIN,
213 };
214 
215 enum {
216 	IFLA_BRPORT_UNSPEC,
217 	IFLA_BRPORT_STATE,	/* Spanning tree state     */
218 	IFLA_BRPORT_PRIORITY,	/* "             priority  */
219 	IFLA_BRPORT_COST,	/* "             cost      */
220 	IFLA_BRPORT_MODE,	/* mode (hairpin)          */
221 	IFLA_BRPORT_GUARD,	/* bpdu guard              */
222 	IFLA_BRPORT_PROTECT,	/* root port protection    */
223 	IFLA_BRPORT_FAST_LEAVE,	/* multicast fast leave    */
224 	IFLA_BRPORT_LEARNING,	/* mac learning */
225 	IFLA_BRPORT_UNICAST_FLOOD, /* flood unicast traffic */
226 	__IFLA_BRPORT_MAX
227 };
228 #define IFLA_BRPORT_MAX (__IFLA_BRPORT_MAX - 1)
229 
230 struct ifla_cacheinfo {
231 	__u32	max_reasm_len;
232 	__u32	tstamp;		/* ipv6InterfaceTable updated timestamp */
233 	__u32	reachable_time;
234 	__u32	retrans_time;
235 };
236 
237 enum {
238 	IFLA_INFO_UNSPEC,
239 	IFLA_INFO_KIND,
240 	IFLA_INFO_DATA,
241 	IFLA_INFO_XSTATS,
242 	__IFLA_INFO_MAX,
243 };
244 
245 #define IFLA_INFO_MAX	(__IFLA_INFO_MAX - 1)
246 
247 /* VLAN section */
248 
249 enum {
250 	IFLA_VLAN_UNSPEC,
251 	IFLA_VLAN_ID,
252 	IFLA_VLAN_FLAGS,
253 	IFLA_VLAN_EGRESS_QOS,
254 	IFLA_VLAN_INGRESS_QOS,
255 	IFLA_VLAN_PROTOCOL,
256 	__IFLA_VLAN_MAX,
257 };
258 
259 #define IFLA_VLAN_MAX	(__IFLA_VLAN_MAX - 1)
260 
261 struct ifla_vlan_flags {
262 	__u32	flags;
263 	__u32	mask;
264 };
265 
266 enum {
267 	IFLA_VLAN_QOS_UNSPEC,
268 	IFLA_VLAN_QOS_MAPPING,
269 	__IFLA_VLAN_QOS_MAX
270 };
271 
272 #define IFLA_VLAN_QOS_MAX	(__IFLA_VLAN_QOS_MAX - 1)
273 
274 struct ifla_vlan_qos_mapping {
275 	__u32 from;
276 	__u32 to;
277 };
278 
279 /* MACVLAN section */
280 enum {
281 	IFLA_MACVLAN_UNSPEC,
282 	IFLA_MACVLAN_MODE,
283 	IFLA_MACVLAN_FLAGS,
284 	__IFLA_MACVLAN_MAX,
285 };
286 
287 #define IFLA_MACVLAN_MAX (__IFLA_MACVLAN_MAX - 1)
288 
289 enum macvlan_mode {
290 	MACVLAN_MODE_PRIVATE = 1, /* don't talk to other macvlans */
291 	MACVLAN_MODE_VEPA    = 2, /* talk to other ports through ext bridge */
292 	MACVLAN_MODE_BRIDGE  = 4, /* talk to bridge ports directly */
293 	MACVLAN_MODE_PASSTHRU = 8,/* take over the underlying device */
294 };
295 
296 #define MACVLAN_FLAG_NOPROMISC	1
297 
298 /* VXLAN section */
299 enum {
300 	IFLA_VXLAN_UNSPEC,
301 	IFLA_VXLAN_ID,
302 	IFLA_VXLAN_GROUP,	/* group or remote address */
303 	IFLA_VXLAN_LINK,
304 	IFLA_VXLAN_LOCAL,
305 	IFLA_VXLAN_TTL,
306 	IFLA_VXLAN_TOS,
307 	IFLA_VXLAN_LEARNING,
308 	IFLA_VXLAN_AGEING,
309 	IFLA_VXLAN_LIMIT,
310 	IFLA_VXLAN_PORT_RANGE,	/* source port */
311 	IFLA_VXLAN_PROXY,
312 	IFLA_VXLAN_RSC,
313 	IFLA_VXLAN_L2MISS,
314 	IFLA_VXLAN_L3MISS,
315 	IFLA_VXLAN_PORT,	/* destination port */
316 	__IFLA_VXLAN_MAX
317 };
318 #define IFLA_VXLAN_MAX	(__IFLA_VXLAN_MAX - 1)
319 
320 struct ifla_vxlan_port_range {
321 	__be16	low;
322 	__be16	high;
323 };
324 
325 /* SR-IOV virtual function management section */
326 
327 enum {
328 	IFLA_VF_INFO_UNSPEC,
329 	IFLA_VF_INFO,
330 	__IFLA_VF_INFO_MAX,
331 };
332 
333 #define IFLA_VF_INFO_MAX (__IFLA_VF_INFO_MAX - 1)
334 
335 enum {
336 	IFLA_VF_UNSPEC,
337 	IFLA_VF_MAC,		/* Hardware queue specific attributes */
338 	IFLA_VF_VLAN,
339 	IFLA_VF_TX_RATE,	/* TX Bandwidth Allocation */
340 	IFLA_VF_SPOOFCHK,	/* Spoof Checking on/off switch */
341 	IFLA_VF_LINK_STATE,	/* link state enable/disable/auto switch */
342 	__IFLA_VF_MAX,
343 };
344 
345 #define IFLA_VF_MAX (__IFLA_VF_MAX - 1)
346 
347 struct ifla_vf_mac {
348 	__u32 vf;
349 	__u8 mac[32]; /* MAX_ADDR_LEN */
350 };
351 
352 struct ifla_vf_vlan {
353 	__u32 vf;
354 	__u32 vlan; /* 0 - 4095, 0 disables VLAN filter */
355 	__u32 qos;
356 };
357 
358 struct ifla_vf_tx_rate {
359 	__u32 vf;
360 	__u32 rate; /* Max TX bandwidth in Mbps, 0 disables throttling */
361 };
362 
363 struct ifla_vf_spoofchk {
364 	__u32 vf;
365 	__u32 setting;
366 };
367 
368 enum {
369 	IFLA_VF_LINK_STATE_AUTO,	/* link state of the uplink */
370 	IFLA_VF_LINK_STATE_ENABLE,	/* link always up */
371 	IFLA_VF_LINK_STATE_DISABLE,	/* link always down */
372 	__IFLA_VF_LINK_STATE_MAX,
373 };
374 
375 struct ifla_vf_link_state {
376 	__u32 vf;
377 	__u32 link_state;
378 };
379 
380 /* VF ports management section
381  *
382  *	Nested layout of set/get msg is:
383  *
384  *		[IFLA_NUM_VF]
385  *		[IFLA_VF_PORTS]
386  *			[IFLA_VF_PORT]
387  *				[IFLA_PORT_*], ...
388  *			[IFLA_VF_PORT]
389  *				[IFLA_PORT_*], ...
390  *			...
391  *		[IFLA_PORT_SELF]
392  *			[IFLA_PORT_*], ...
393  */
394 
395 enum {
396 	IFLA_VF_PORT_UNSPEC,
397 	IFLA_VF_PORT,			/* nest */
398 	__IFLA_VF_PORT_MAX,
399 };
400 
401 #define IFLA_VF_PORT_MAX (__IFLA_VF_PORT_MAX - 1)
402 
403 enum {
404 	IFLA_PORT_UNSPEC,
405 	IFLA_PORT_VF,			/* __u32 */
406 	IFLA_PORT_PROFILE,		/* string */
407 	IFLA_PORT_VSI_TYPE,		/* 802.1Qbg (pre-)standard VDP */
408 	IFLA_PORT_INSTANCE_UUID,	/* binary UUID */
409 	IFLA_PORT_HOST_UUID,		/* binary UUID */
410 	IFLA_PORT_REQUEST,		/* __u8 */
411 	IFLA_PORT_RESPONSE,		/* __u16, output only */
412 	__IFLA_PORT_MAX,
413 };
414 
415 #define IFLA_PORT_MAX (__IFLA_PORT_MAX - 1)
416 
417 #define PORT_PROFILE_MAX	40
418 #define PORT_UUID_MAX		16
419 #define PORT_SELF_VF		-1
420 
421 enum {
422 	PORT_REQUEST_PREASSOCIATE = 0,
423 	PORT_REQUEST_PREASSOCIATE_RR,
424 	PORT_REQUEST_ASSOCIATE,
425 	PORT_REQUEST_DISASSOCIATE,
426 };
427 
428 enum {
429 	PORT_VDP_RESPONSE_SUCCESS = 0,
430 	PORT_VDP_RESPONSE_INVALID_FORMAT,
431 	PORT_VDP_RESPONSE_INSUFFICIENT_RESOURCES,
432 	PORT_VDP_RESPONSE_UNUSED_VTID,
433 	PORT_VDP_RESPONSE_VTID_VIOLATION,
434 	PORT_VDP_RESPONSE_VTID_VERSION_VIOALTION,
435 	PORT_VDP_RESPONSE_OUT_OF_SYNC,
436 	/* 0x08-0xFF reserved for future VDP use */
437 	PORT_PROFILE_RESPONSE_SUCCESS = 0x100,
438 	PORT_PROFILE_RESPONSE_INPROGRESS,
439 	PORT_PROFILE_RESPONSE_INVALID,
440 	PORT_PROFILE_RESPONSE_BADSTATE,
441 	PORT_PROFILE_RESPONSE_INSUFFICIENT_RESOURCES,
442 	PORT_PROFILE_RESPONSE_ERROR,
443 };
444 
445 struct ifla_port_vsi {
446 	__u8 vsi_mgr_id;
447 	__u8 vsi_type_id[3];
448 	__u8 vsi_type_version;
449 	__u8 pad[3];
450 };
451 
452 
453 /* IPoIB section */
454 
455 enum {
456 	IFLA_IPOIB_UNSPEC,
457 	IFLA_IPOIB_PKEY,
458 	IFLA_IPOIB_MODE,
459 	IFLA_IPOIB_UMCAST,
460 	__IFLA_IPOIB_MAX
461 };
462 
463 enum {
464 	IPOIB_MODE_DATAGRAM  = 0, /* using unreliable datagram QPs */
465 	IPOIB_MODE_CONNECTED = 1, /* using connected QPs */
466 };
467 
468 #define IFLA_IPOIB_MAX (__IFLA_IPOIB_MAX - 1)
469 
470 #endif /* _UAPI_LINUX_IF_LINK_H */
471