xref: /linux-6.15/include/uapi/linux/if_bridge.h (revision d3f1cbd2)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3  *	Linux ethernet bridge
4  *
5  *	Authors:
6  *	Lennert Buytenhek		<[email protected]>
7  *
8  *	This program is free software; you can redistribute it and/or
9  *	modify it under the terms of the GNU General Public License
10  *	as published by the Free Software Foundation; either version
11  *	2 of the License, or (at your option) any later version.
12  */
13 
14 #ifndef _UAPI_LINUX_IF_BRIDGE_H
15 #define _UAPI_LINUX_IF_BRIDGE_H
16 
17 #include <linux/types.h>
18 #include <linux/if_ether.h>
19 #include <linux/in6.h>
20 
21 #define SYSFS_BRIDGE_ATTR	"bridge"
22 #define SYSFS_BRIDGE_FDB	"brforward"
23 #define SYSFS_BRIDGE_PORT_SUBDIR "brif"
24 #define SYSFS_BRIDGE_PORT_ATTR	"brport"
25 #define SYSFS_BRIDGE_PORT_LINK	"bridge"
26 
27 #define BRCTL_VERSION 1
28 
29 #define BRCTL_GET_VERSION 0
30 #define BRCTL_GET_BRIDGES 1
31 #define BRCTL_ADD_BRIDGE 2
32 #define BRCTL_DEL_BRIDGE 3
33 #define BRCTL_ADD_IF 4
34 #define BRCTL_DEL_IF 5
35 #define BRCTL_GET_BRIDGE_INFO 6
36 #define BRCTL_GET_PORT_LIST 7
37 #define BRCTL_SET_BRIDGE_FORWARD_DELAY 8
38 #define BRCTL_SET_BRIDGE_HELLO_TIME 9
39 #define BRCTL_SET_BRIDGE_MAX_AGE 10
40 #define BRCTL_SET_AGEING_TIME 11
41 #define BRCTL_SET_GC_INTERVAL 12
42 #define BRCTL_GET_PORT_INFO 13
43 #define BRCTL_SET_BRIDGE_STP_STATE 14
44 #define BRCTL_SET_BRIDGE_PRIORITY 15
45 #define BRCTL_SET_PORT_PRIORITY 16
46 #define BRCTL_SET_PATH_COST 17
47 #define BRCTL_GET_FDB_ENTRIES 18
48 
49 #define BR_STATE_DISABLED 0
50 #define BR_STATE_LISTENING 1
51 #define BR_STATE_LEARNING 2
52 #define BR_STATE_FORWARDING 3
53 #define BR_STATE_BLOCKING 4
54 
55 struct __bridge_info {
56 	__u64 designated_root;
57 	__u64 bridge_id;
58 	__u32 root_path_cost;
59 	__u32 max_age;
60 	__u32 hello_time;
61 	__u32 forward_delay;
62 	__u32 bridge_max_age;
63 	__u32 bridge_hello_time;
64 	__u32 bridge_forward_delay;
65 	__u8 topology_change;
66 	__u8 topology_change_detected;
67 	__u8 root_port;
68 	__u8 stp_enabled;
69 	__u32 ageing_time;
70 	__u32 gc_interval;
71 	__u32 hello_timer_value;
72 	__u32 tcn_timer_value;
73 	__u32 topology_change_timer_value;
74 	__u32 gc_timer_value;
75 };
76 
77 struct __port_info {
78 	__u64 designated_root;
79 	__u64 designated_bridge;
80 	__u16 port_id;
81 	__u16 designated_port;
82 	__u32 path_cost;
83 	__u32 designated_cost;
84 	__u8 state;
85 	__u8 top_change_ack;
86 	__u8 config_pending;
87 	__u8 unused0;
88 	__u32 message_age_timer_value;
89 	__u32 forward_delay_timer_value;
90 	__u32 hold_timer_value;
91 };
92 
93 struct __fdb_entry {
94 	__u8 mac_addr[ETH_ALEN];
95 	__u8 port_no;
96 	__u8 is_local;
97 	__u32 ageing_timer_value;
98 	__u8 port_hi;
99 	__u8 pad0;
100 	__u16 unused;
101 };
102 
103 /* Bridge Flags */
104 #define BRIDGE_FLAGS_MASTER	1	/* Bridge command to/from master */
105 #define BRIDGE_FLAGS_SELF	2	/* Bridge command to/from lowerdev */
106 
107 #define BRIDGE_MODE_VEB		0	/* Default loopback mode */
108 #define BRIDGE_MODE_VEPA	1	/* 802.1Qbg defined VEPA mode */
109 #define BRIDGE_MODE_UNDEF	0xFFFF  /* mode undefined */
110 
111 /* Bridge management nested attributes
112  * [IFLA_AF_SPEC] = {
113  *     [IFLA_BRIDGE_FLAGS]
114  *     [IFLA_BRIDGE_MODE]
115  *     [IFLA_BRIDGE_VLAN_INFO]
116  * }
117  */
118 enum {
119 	IFLA_BRIDGE_FLAGS,
120 	IFLA_BRIDGE_MODE,
121 	IFLA_BRIDGE_VLAN_INFO,
122 	IFLA_BRIDGE_VLAN_TUNNEL_INFO,
123 	IFLA_BRIDGE_MRP,
124 	__IFLA_BRIDGE_MAX,
125 };
126 #define IFLA_BRIDGE_MAX (__IFLA_BRIDGE_MAX - 1)
127 
128 #define BRIDGE_VLAN_INFO_MASTER	(1<<0)	/* Operate on Bridge device as well */
129 #define BRIDGE_VLAN_INFO_PVID	(1<<1)	/* VLAN is PVID, ingress untagged */
130 #define BRIDGE_VLAN_INFO_UNTAGGED	(1<<2)	/* VLAN egresses untagged */
131 #define BRIDGE_VLAN_INFO_RANGE_BEGIN	(1<<3) /* VLAN is start of vlan range */
132 #define BRIDGE_VLAN_INFO_RANGE_END	(1<<4) /* VLAN is end of vlan range */
133 #define BRIDGE_VLAN_INFO_BRENTRY	(1<<5) /* Global bridge VLAN entry */
134 #define BRIDGE_VLAN_INFO_ONLY_OPTS	(1<<6) /* Skip create/delete/flags */
135 
136 struct bridge_vlan_info {
137 	__u16 flags;
138 	__u16 vid;
139 };
140 
141 enum {
142 	IFLA_BRIDGE_VLAN_TUNNEL_UNSPEC,
143 	IFLA_BRIDGE_VLAN_TUNNEL_ID,
144 	IFLA_BRIDGE_VLAN_TUNNEL_VID,
145 	IFLA_BRIDGE_VLAN_TUNNEL_FLAGS,
146 	__IFLA_BRIDGE_VLAN_TUNNEL_MAX,
147 };
148 
149 #define IFLA_BRIDGE_VLAN_TUNNEL_MAX (__IFLA_BRIDGE_VLAN_TUNNEL_MAX - 1)
150 
151 struct bridge_vlan_xstats {
152 	__u64 rx_bytes;
153 	__u64 rx_packets;
154 	__u64 tx_bytes;
155 	__u64 tx_packets;
156 	__u16 vid;
157 	__u16 flags;
158 	__u32 pad2;
159 };
160 
161 enum {
162 	IFLA_BRIDGE_MRP_UNSPEC,
163 	IFLA_BRIDGE_MRP_INSTANCE,
164 	IFLA_BRIDGE_MRP_PORT_STATE,
165 	IFLA_BRIDGE_MRP_PORT_ROLE,
166 	IFLA_BRIDGE_MRP_RING_STATE,
167 	IFLA_BRIDGE_MRP_RING_ROLE,
168 	IFLA_BRIDGE_MRP_START_TEST,
169 	__IFLA_BRIDGE_MRP_MAX,
170 };
171 
172 struct br_mrp_instance {
173 	__u32 ring_id;
174 	__u32 p_ifindex;
175 	__u32 s_ifindex;
176 };
177 
178 struct br_mrp_port_role {
179 	__u32 ring_id;
180 	__u32 role;
181 };
182 
183 struct br_mrp_ring_state {
184 	__u32 ring_id;
185 	__u32 ring_state;
186 };
187 
188 struct br_mrp_ring_role {
189 	__u32 ring_id;
190 	__u32 ring_role;
191 };
192 
193 struct br_mrp_start_test {
194 	__u32 ring_id;
195 	__u32 interval;
196 	__u32 max_miss;
197 	__u32 period;
198 };
199 
200 #define IFLA_BRIDGE_MRP_MAX (__IFLA_BRIDGE_MRP_MAX - 1)
201 
202 struct bridge_stp_xstats {
203 	__u64 transition_blk;
204 	__u64 transition_fwd;
205 	__u64 rx_bpdu;
206 	__u64 tx_bpdu;
207 	__u64 rx_tcn;
208 	__u64 tx_tcn;
209 };
210 
211 /* Bridge vlan RTM header */
212 struct br_vlan_msg {
213 	__u8 family;
214 	__u8 reserved1;
215 	__u16 reserved2;
216 	__u32 ifindex;
217 };
218 
219 enum {
220 	BRIDGE_VLANDB_DUMP_UNSPEC,
221 	BRIDGE_VLANDB_DUMP_FLAGS,
222 	__BRIDGE_VLANDB_DUMP_MAX,
223 };
224 #define BRIDGE_VLANDB_DUMP_MAX (__BRIDGE_VLANDB_DUMP_MAX - 1)
225 
226 /* flags used in BRIDGE_VLANDB_DUMP_FLAGS attribute to affect dumps */
227 #define BRIDGE_VLANDB_DUMPF_STATS	(1 << 0) /* Include stats in the dump */
228 
229 /* Bridge vlan RTM attributes
230  * [BRIDGE_VLANDB_ENTRY] = {
231  *     [BRIDGE_VLANDB_ENTRY_INFO]
232  *     ...
233  * }
234  */
235 enum {
236 	BRIDGE_VLANDB_UNSPEC,
237 	BRIDGE_VLANDB_ENTRY,
238 	__BRIDGE_VLANDB_MAX,
239 };
240 #define BRIDGE_VLANDB_MAX (__BRIDGE_VLANDB_MAX - 1)
241 
242 enum {
243 	BRIDGE_VLANDB_ENTRY_UNSPEC,
244 	BRIDGE_VLANDB_ENTRY_INFO,
245 	BRIDGE_VLANDB_ENTRY_RANGE,
246 	BRIDGE_VLANDB_ENTRY_STATE,
247 	BRIDGE_VLANDB_ENTRY_TUNNEL_INFO,
248 	BRIDGE_VLANDB_ENTRY_STATS,
249 	__BRIDGE_VLANDB_ENTRY_MAX,
250 };
251 #define BRIDGE_VLANDB_ENTRY_MAX (__BRIDGE_VLANDB_ENTRY_MAX - 1)
252 
253 /* [BRIDGE_VLANDB_ENTRY] = {
254  *     [BRIDGE_VLANDB_ENTRY_TUNNEL_INFO] = {
255  *         [BRIDGE_VLANDB_TINFO_ID]
256  *         ...
257  *     }
258  * }
259  */
260 enum {
261 	BRIDGE_VLANDB_TINFO_UNSPEC,
262 	BRIDGE_VLANDB_TINFO_ID,
263 	BRIDGE_VLANDB_TINFO_CMD,
264 	__BRIDGE_VLANDB_TINFO_MAX,
265 };
266 #define BRIDGE_VLANDB_TINFO_MAX (__BRIDGE_VLANDB_TINFO_MAX - 1)
267 
268 /* [BRIDGE_VLANDB_ENTRY] = {
269  *     [BRIDGE_VLANDB_ENTRY_STATS] = {
270  *         [BRIDGE_VLANDB_STATS_RX_BYTES]
271  *         ...
272  *     }
273  *     ...
274  * }
275  */
276 enum {
277 	BRIDGE_VLANDB_STATS_UNSPEC,
278 	BRIDGE_VLANDB_STATS_RX_BYTES,
279 	BRIDGE_VLANDB_STATS_RX_PACKETS,
280 	BRIDGE_VLANDB_STATS_TX_BYTES,
281 	BRIDGE_VLANDB_STATS_TX_PACKETS,
282 	BRIDGE_VLANDB_STATS_PAD,
283 	__BRIDGE_VLANDB_STATS_MAX,
284 };
285 #define BRIDGE_VLANDB_STATS_MAX (__BRIDGE_VLANDB_STATS_MAX - 1)
286 
287 /* Bridge multicast database attributes
288  * [MDBA_MDB] = {
289  *     [MDBA_MDB_ENTRY] = {
290  *         [MDBA_MDB_ENTRY_INFO] {
291  *		struct br_mdb_entry
292  *		[MDBA_MDB_EATTR attributes]
293  *         }
294  *     }
295  * }
296  * [MDBA_ROUTER] = {
297  *    [MDBA_ROUTER_PORT] = {
298  *        u32 ifindex
299  *        [MDBA_ROUTER_PATTR attributes]
300  *    }
301  * }
302  */
303 enum {
304 	MDBA_UNSPEC,
305 	MDBA_MDB,
306 	MDBA_ROUTER,
307 	__MDBA_MAX,
308 };
309 #define MDBA_MAX (__MDBA_MAX - 1)
310 
311 enum {
312 	MDBA_MDB_UNSPEC,
313 	MDBA_MDB_ENTRY,
314 	__MDBA_MDB_MAX,
315 };
316 #define MDBA_MDB_MAX (__MDBA_MDB_MAX - 1)
317 
318 enum {
319 	MDBA_MDB_ENTRY_UNSPEC,
320 	MDBA_MDB_ENTRY_INFO,
321 	__MDBA_MDB_ENTRY_MAX,
322 };
323 #define MDBA_MDB_ENTRY_MAX (__MDBA_MDB_ENTRY_MAX - 1)
324 
325 /* per mdb entry additional attributes */
326 enum {
327 	MDBA_MDB_EATTR_UNSPEC,
328 	MDBA_MDB_EATTR_TIMER,
329 	__MDBA_MDB_EATTR_MAX
330 };
331 #define MDBA_MDB_EATTR_MAX (__MDBA_MDB_EATTR_MAX - 1)
332 
333 /* multicast router types */
334 enum {
335 	MDB_RTR_TYPE_DISABLED,
336 	MDB_RTR_TYPE_TEMP_QUERY,
337 	MDB_RTR_TYPE_PERM,
338 	MDB_RTR_TYPE_TEMP
339 };
340 
341 enum {
342 	MDBA_ROUTER_UNSPEC,
343 	MDBA_ROUTER_PORT,
344 	__MDBA_ROUTER_MAX,
345 };
346 #define MDBA_ROUTER_MAX (__MDBA_ROUTER_MAX - 1)
347 
348 /* router port attributes */
349 enum {
350 	MDBA_ROUTER_PATTR_UNSPEC,
351 	MDBA_ROUTER_PATTR_TIMER,
352 	MDBA_ROUTER_PATTR_TYPE,
353 	__MDBA_ROUTER_PATTR_MAX
354 };
355 #define MDBA_ROUTER_PATTR_MAX (__MDBA_ROUTER_PATTR_MAX - 1)
356 
357 struct br_port_msg {
358 	__u8  family;
359 	__u32 ifindex;
360 };
361 
362 struct br_mdb_entry {
363 	__u32 ifindex;
364 #define MDB_TEMPORARY 0
365 #define MDB_PERMANENT 1
366 	__u8 state;
367 #define MDB_FLAGS_OFFLOAD	(1 << 0)
368 #define MDB_FLAGS_FAST_LEAVE	(1 << 1)
369 	__u8 flags;
370 	__u16 vid;
371 	struct {
372 		union {
373 			__be32	ip4;
374 			struct in6_addr ip6;
375 		} u;
376 		__be16		proto;
377 	} addr;
378 };
379 
380 enum {
381 	MDBA_SET_ENTRY_UNSPEC,
382 	MDBA_SET_ENTRY,
383 	__MDBA_SET_ENTRY_MAX,
384 };
385 #define MDBA_SET_ENTRY_MAX (__MDBA_SET_ENTRY_MAX - 1)
386 
387 /* Embedded inside LINK_XSTATS_TYPE_BRIDGE */
388 enum {
389 	BRIDGE_XSTATS_UNSPEC,
390 	BRIDGE_XSTATS_VLAN,
391 	BRIDGE_XSTATS_MCAST,
392 	BRIDGE_XSTATS_PAD,
393 	BRIDGE_XSTATS_STP,
394 	__BRIDGE_XSTATS_MAX
395 };
396 #define BRIDGE_XSTATS_MAX (__BRIDGE_XSTATS_MAX - 1)
397 
398 enum {
399 	BR_MCAST_DIR_RX,
400 	BR_MCAST_DIR_TX,
401 	BR_MCAST_DIR_SIZE
402 };
403 
404 /* IGMP/MLD statistics */
405 struct br_mcast_stats {
406 	__u64 igmp_v1queries[BR_MCAST_DIR_SIZE];
407 	__u64 igmp_v2queries[BR_MCAST_DIR_SIZE];
408 	__u64 igmp_v3queries[BR_MCAST_DIR_SIZE];
409 	__u64 igmp_leaves[BR_MCAST_DIR_SIZE];
410 	__u64 igmp_v1reports[BR_MCAST_DIR_SIZE];
411 	__u64 igmp_v2reports[BR_MCAST_DIR_SIZE];
412 	__u64 igmp_v3reports[BR_MCAST_DIR_SIZE];
413 	__u64 igmp_parse_errors;
414 
415 	__u64 mld_v1queries[BR_MCAST_DIR_SIZE];
416 	__u64 mld_v2queries[BR_MCAST_DIR_SIZE];
417 	__u64 mld_leaves[BR_MCAST_DIR_SIZE];
418 	__u64 mld_v1reports[BR_MCAST_DIR_SIZE];
419 	__u64 mld_v2reports[BR_MCAST_DIR_SIZE];
420 	__u64 mld_parse_errors;
421 
422 	__u64 mcast_bytes[BR_MCAST_DIR_SIZE];
423 	__u64 mcast_packets[BR_MCAST_DIR_SIZE];
424 };
425 
426 /* bridge boolean options
427  * BR_BOOLOPT_NO_LL_LEARN - disable learning from link-local packets
428  *
429  * IMPORTANT: if adding a new option do not forget to handle
430  *            it in br_boolopt_toggle/get and bridge sysfs
431  */
432 enum br_boolopt_id {
433 	BR_BOOLOPT_NO_LL_LEARN,
434 	BR_BOOLOPT_MAX
435 };
436 
437 /* struct br_boolopt_multi - change multiple bridge boolean options
438  *
439  * @optval: new option values (bit per option)
440  * @optmask: options to change (bit per option)
441  */
442 struct br_boolopt_multi {
443 	__u32 optval;
444 	__u32 optmask;
445 };
446 #endif /* _UAPI_LINUX_IF_BRIDGE_H */
447