xref: /linux-6.15/include/uapi/linux/if_link.h (revision 8fdff1dc)
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_MAX
146 };
147 
148 
149 #define IFLA_MAX (__IFLA_MAX - 1)
150 
151 /* backwards compatibility for userspace */
152 #ifndef __KERNEL__
153 #define IFLA_RTA(r)  ((struct rtattr*)(((char*)(r)) + NLMSG_ALIGN(sizeof(struct ifinfomsg))))
154 #define IFLA_PAYLOAD(n) NLMSG_PAYLOAD(n,sizeof(struct ifinfomsg))
155 #endif
156 
157 enum {
158 	IFLA_INET_UNSPEC,
159 	IFLA_INET_CONF,
160 	__IFLA_INET_MAX,
161 };
162 
163 #define IFLA_INET_MAX (__IFLA_INET_MAX - 1)
164 
165 /* ifi_flags.
166 
167    IFF_* flags.
168 
169    The only change is:
170    IFF_LOOPBACK, IFF_BROADCAST and IFF_POINTOPOINT are
171    more not changeable by user. They describe link media
172    characteristics and set by device driver.
173 
174    Comments:
175    - Combination IFF_BROADCAST|IFF_POINTOPOINT is invalid
176    - If neither of these three flags are set;
177      the interface is NBMA.
178 
179    - IFF_MULTICAST does not mean anything special:
180    multicasts can be used on all not-NBMA links.
181    IFF_MULTICAST means that this media uses special encapsulation
182    for multicast frames. Apparently, all IFF_POINTOPOINT and
183    IFF_BROADCAST devices are able to use multicasts too.
184  */
185 
186 /* IFLA_LINK.
187    For usual devices it is equal ifi_index.
188    If it is a "virtual interface" (f.e. tunnel), ifi_link
189    can point to real physical interface (f.e. for bandwidth calculations),
190    or maybe 0, what means, that real media is unknown (usual
191    for IPIP tunnels, when route to endpoint is allowed to change)
192  */
193 
194 /* Subtype attributes for IFLA_PROTINFO */
195 enum {
196 	IFLA_INET6_UNSPEC,
197 	IFLA_INET6_FLAGS,	/* link flags			*/
198 	IFLA_INET6_CONF,	/* sysctl parameters		*/
199 	IFLA_INET6_STATS,	/* statistics			*/
200 	IFLA_INET6_MCAST,	/* MC things. What of them?	*/
201 	IFLA_INET6_CACHEINFO,	/* time values and max reasm size */
202 	IFLA_INET6_ICMP6STATS,	/* statistics (icmpv6)		*/
203 	__IFLA_INET6_MAX
204 };
205 
206 #define IFLA_INET6_MAX	(__IFLA_INET6_MAX - 1)
207 
208 enum {
209 	BRIDGE_MODE_UNSPEC,
210 	BRIDGE_MODE_HAIRPIN,
211 };
212 
213 enum {
214 	IFLA_BRPORT_UNSPEC,
215 	IFLA_BRPORT_STATE,	/* Spanning tree state     */
216 	IFLA_BRPORT_PRIORITY,	/* "             priority  */
217 	IFLA_BRPORT_COST,	/* "             cost      */
218 	IFLA_BRPORT_MODE,	/* mode (hairpin)          */
219 	IFLA_BRPORT_GUARD,	/* bpdu guard              */
220 	IFLA_BRPORT_PROTECT,	/* root port protection    */
221 	IFLA_BRPORT_FAST_LEAVE,	/* multicast fast leave    */
222 	__IFLA_BRPORT_MAX
223 };
224 #define IFLA_BRPORT_MAX (__IFLA_BRPORT_MAX - 1)
225 
226 struct ifla_cacheinfo {
227 	__u32	max_reasm_len;
228 	__u32	tstamp;		/* ipv6InterfaceTable updated timestamp */
229 	__u32	reachable_time;
230 	__u32	retrans_time;
231 };
232 
233 enum {
234 	IFLA_INFO_UNSPEC,
235 	IFLA_INFO_KIND,
236 	IFLA_INFO_DATA,
237 	IFLA_INFO_XSTATS,
238 	__IFLA_INFO_MAX,
239 };
240 
241 #define IFLA_INFO_MAX	(__IFLA_INFO_MAX - 1)
242 
243 /* VLAN section */
244 
245 enum {
246 	IFLA_VLAN_UNSPEC,
247 	IFLA_VLAN_ID,
248 	IFLA_VLAN_FLAGS,
249 	IFLA_VLAN_EGRESS_QOS,
250 	IFLA_VLAN_INGRESS_QOS,
251 	__IFLA_VLAN_MAX,
252 };
253 
254 #define IFLA_VLAN_MAX	(__IFLA_VLAN_MAX - 1)
255 
256 struct ifla_vlan_flags {
257 	__u32	flags;
258 	__u32	mask;
259 };
260 
261 enum {
262 	IFLA_VLAN_QOS_UNSPEC,
263 	IFLA_VLAN_QOS_MAPPING,
264 	__IFLA_VLAN_QOS_MAX
265 };
266 
267 #define IFLA_VLAN_QOS_MAX	(__IFLA_VLAN_QOS_MAX - 1)
268 
269 struct ifla_vlan_qos_mapping {
270 	__u32 from;
271 	__u32 to;
272 };
273 
274 /* MACVLAN section */
275 enum {
276 	IFLA_MACVLAN_UNSPEC,
277 	IFLA_MACVLAN_MODE,
278 	IFLA_MACVLAN_FLAGS,
279 	__IFLA_MACVLAN_MAX,
280 };
281 
282 #define IFLA_MACVLAN_MAX (__IFLA_MACVLAN_MAX - 1)
283 
284 enum macvlan_mode {
285 	MACVLAN_MODE_PRIVATE = 1, /* don't talk to other macvlans */
286 	MACVLAN_MODE_VEPA    = 2, /* talk to other ports through ext bridge */
287 	MACVLAN_MODE_BRIDGE  = 4, /* talk to bridge ports directly */
288 	MACVLAN_MODE_PASSTHRU = 8,/* take over the underlying device */
289 };
290 
291 #define MACVLAN_FLAG_NOPROMISC	1
292 
293 /* VXLAN section */
294 enum {
295 	IFLA_VXLAN_UNSPEC,
296 	IFLA_VXLAN_ID,
297 	IFLA_VXLAN_GROUP,
298 	IFLA_VXLAN_LINK,
299 	IFLA_VXLAN_LOCAL,
300 	IFLA_VXLAN_TTL,
301 	IFLA_VXLAN_TOS,
302 	IFLA_VXLAN_LEARNING,
303 	IFLA_VXLAN_AGEING,
304 	IFLA_VXLAN_LIMIT,
305 	IFLA_VXLAN_PORT_RANGE,
306 	IFLA_VXLAN_PROXY,
307 	IFLA_VXLAN_RSC,
308 	IFLA_VXLAN_L2MISS,
309 	IFLA_VXLAN_L3MISS,
310 	__IFLA_VXLAN_MAX
311 };
312 #define IFLA_VXLAN_MAX	(__IFLA_VXLAN_MAX - 1)
313 
314 struct ifla_vxlan_port_range {
315 	__be16	low;
316 	__be16	high;
317 };
318 
319 /* SR-IOV virtual function management section */
320 
321 enum {
322 	IFLA_VF_INFO_UNSPEC,
323 	IFLA_VF_INFO,
324 	__IFLA_VF_INFO_MAX,
325 };
326 
327 #define IFLA_VF_INFO_MAX (__IFLA_VF_INFO_MAX - 1)
328 
329 enum {
330 	IFLA_VF_UNSPEC,
331 	IFLA_VF_MAC,		/* Hardware queue specific attributes */
332 	IFLA_VF_VLAN,
333 	IFLA_VF_TX_RATE,	/* TX Bandwidth Allocation */
334 	IFLA_VF_SPOOFCHK,	/* Spoof Checking on/off switch */
335 	__IFLA_VF_MAX,
336 };
337 
338 #define IFLA_VF_MAX (__IFLA_VF_MAX - 1)
339 
340 struct ifla_vf_mac {
341 	__u32 vf;
342 	__u8 mac[32]; /* MAX_ADDR_LEN */
343 };
344 
345 struct ifla_vf_vlan {
346 	__u32 vf;
347 	__u32 vlan; /* 0 - 4095, 0 disables VLAN filter */
348 	__u32 qos;
349 };
350 
351 struct ifla_vf_tx_rate {
352 	__u32 vf;
353 	__u32 rate; /* Max TX bandwidth in Mbps, 0 disables throttling */
354 };
355 
356 struct ifla_vf_spoofchk {
357 	__u32 vf;
358 	__u32 setting;
359 };
360 
361 /* VF ports management section
362  *
363  *	Nested layout of set/get msg is:
364  *
365  *		[IFLA_NUM_VF]
366  *		[IFLA_VF_PORTS]
367  *			[IFLA_VF_PORT]
368  *				[IFLA_PORT_*], ...
369  *			[IFLA_VF_PORT]
370  *				[IFLA_PORT_*], ...
371  *			...
372  *		[IFLA_PORT_SELF]
373  *			[IFLA_PORT_*], ...
374  */
375 
376 enum {
377 	IFLA_VF_PORT_UNSPEC,
378 	IFLA_VF_PORT,			/* nest */
379 	__IFLA_VF_PORT_MAX,
380 };
381 
382 #define IFLA_VF_PORT_MAX (__IFLA_VF_PORT_MAX - 1)
383 
384 enum {
385 	IFLA_PORT_UNSPEC,
386 	IFLA_PORT_VF,			/* __u32 */
387 	IFLA_PORT_PROFILE,		/* string */
388 	IFLA_PORT_VSI_TYPE,		/* 802.1Qbg (pre-)standard VDP */
389 	IFLA_PORT_INSTANCE_UUID,	/* binary UUID */
390 	IFLA_PORT_HOST_UUID,		/* binary UUID */
391 	IFLA_PORT_REQUEST,		/* __u8 */
392 	IFLA_PORT_RESPONSE,		/* __u16, output only */
393 	__IFLA_PORT_MAX,
394 };
395 
396 #define IFLA_PORT_MAX (__IFLA_PORT_MAX - 1)
397 
398 #define PORT_PROFILE_MAX	40
399 #define PORT_UUID_MAX		16
400 #define PORT_SELF_VF		-1
401 
402 enum {
403 	PORT_REQUEST_PREASSOCIATE = 0,
404 	PORT_REQUEST_PREASSOCIATE_RR,
405 	PORT_REQUEST_ASSOCIATE,
406 	PORT_REQUEST_DISASSOCIATE,
407 };
408 
409 enum {
410 	PORT_VDP_RESPONSE_SUCCESS = 0,
411 	PORT_VDP_RESPONSE_INVALID_FORMAT,
412 	PORT_VDP_RESPONSE_INSUFFICIENT_RESOURCES,
413 	PORT_VDP_RESPONSE_UNUSED_VTID,
414 	PORT_VDP_RESPONSE_VTID_VIOLATION,
415 	PORT_VDP_RESPONSE_VTID_VERSION_VIOALTION,
416 	PORT_VDP_RESPONSE_OUT_OF_SYNC,
417 	/* 0x08-0xFF reserved for future VDP use */
418 	PORT_PROFILE_RESPONSE_SUCCESS = 0x100,
419 	PORT_PROFILE_RESPONSE_INPROGRESS,
420 	PORT_PROFILE_RESPONSE_INVALID,
421 	PORT_PROFILE_RESPONSE_BADSTATE,
422 	PORT_PROFILE_RESPONSE_INSUFFICIENT_RESOURCES,
423 	PORT_PROFILE_RESPONSE_ERROR,
424 };
425 
426 struct ifla_port_vsi {
427 	__u8 vsi_mgr_id;
428 	__u8 vsi_type_id[3];
429 	__u8 vsi_type_version;
430 	__u8 pad[3];
431 };
432 
433 
434 /* IPoIB section */
435 
436 enum {
437 	IFLA_IPOIB_UNSPEC,
438 	IFLA_IPOIB_PKEY,
439 	IFLA_IPOIB_MODE,
440 	IFLA_IPOIB_UMCAST,
441 	__IFLA_IPOIB_MAX
442 };
443 
444 enum {
445 	IPOIB_MODE_DATAGRAM  = 0, /* using unreliable datagram QPs */
446 	IPOIB_MODE_CONNECTED = 1, /* using connected QPs */
447 };
448 
449 #define IFLA_IPOIB_MAX (__IFLA_IPOIB_MAX - 1)
450 
451 #endif /* _UAPI_LINUX_IF_LINK_H */
452