include/uapi/linux/if_bridge.h

   1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
   2 /*
   3  *      Linux ethernet bridge
   4  *
   5  *      Authors:
   6  *      Lennert Buytenhek               <buytenh@gnu.org>
   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 _LINUX_IF_BRIDGE_H
  15 #define _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_MAX,
 124 };
 125 #define IFLA_BRIDGE_MAX (__IFLA_BRIDGE_MAX - 1)
 126
 127 #define BRIDGE_VLAN_INFO_MASTER (1<<0)  /* Operate on Bridge device as well */
 128 #define BRIDGE_VLAN_INFO_PVID   (1<<1)  /* VLAN is PVID, ingress untagged */
 129 #define BRIDGE_VLAN_INFO_UNTAGGED       (1<<2)  /* VLAN egresses untagged */
 130 #define BRIDGE_VLAN_INFO_RANGE_BEGIN    (1<<3) /* VLAN is start of vlan range */
 131 #define BRIDGE_VLAN_INFO_RANGE_END      (1<<4) /* VLAN is end of vlan range */
 132 #define BRIDGE_VLAN_INFO_BRENTRY        (1<<5) /* Global bridge VLAN entry */
 133
 134 struct bridge_vlan_info {
 135         __u16 flags;
 136         __u16 vid;
 137 };
 138
 139 enum {
 140         IFLA_BRIDGE_VLAN_TUNNEL_UNSPEC,
 141         IFLA_BRIDGE_VLAN_TUNNEL_ID,
 142         IFLA_BRIDGE_VLAN_TUNNEL_VID,
 143         IFLA_BRIDGE_VLAN_TUNNEL_FLAGS,
 144         __IFLA_BRIDGE_VLAN_TUNNEL_MAX,
 145 };
 146
 147 #define IFLA_BRIDGE_VLAN_TUNNEL_MAX (__IFLA_BRIDGE_VLAN_TUNNEL_MAX - 1)
 148
 149 struct bridge_vlan_xstats {
 150         __u64 rx_bytes;
 151         __u64 rx_packets;
 152         __u64 tx_bytes;
 153         __u64 tx_packets;
 154         __u16 vid;
 155         __u16 flags;
 156         __u32 pad2;
 157 };
 158
 159 struct bridge_stp_xstats {
 160         __u64 transition_blk;
 161         __u64 transition_fwd;
 162         __u64 rx_bpdu;
 163         __u64 tx_bpdu;
 164         __u64 rx_tcn;
 165         __u64 tx_tcn;
 166 };
 167
 168 /* Bridge vlan RTM header */
 169 struct br_vlan_msg {
 170         __u8 family;
 171         __u8 reserved1;
 172         __u16 reserved2;
 173         __u32 ifindex;
 174 };
 175
 176 /* Bridge vlan RTM attributes
 177  * [BRIDGE_VLANDB_ENTRY] = {
 178  *     [BRIDGE_VLANDB_ENTRY_INFO]
 179  *     ...
 180  * }
 181  */
 182 enum {
 183         BRIDGE_VLANDB_UNSPEC,
 184         BRIDGE_VLANDB_ENTRY,
 185         __BRIDGE_VLANDB_MAX,
 186 };
 187 #define BRIDGE_VLANDB_MAX (__BRIDGE_VLANDB_MAX - 1)
 188
 189 enum {
 190         BRIDGE_VLANDB_ENTRY_UNSPEC,
 191         BRIDGE_VLANDB_ENTRY_INFO,
 192         BRIDGE_VLANDB_ENTRY_RANGE,
 193         __BRIDGE_VLANDB_ENTRY_MAX,
 194 };
 195 #define BRIDGE_VLANDB_ENTRY_MAX (__BRIDGE_VLANDB_ENTRY_MAX - 1)
 196
 197 /* Bridge multicast database attributes
 198  * [MDBA_MDB] = {
 199  *     [MDBA_MDB_ENTRY] = {
 200  *         [MDBA_MDB_ENTRY_INFO] {
 201  *              struct br_mdb_entry
 202  *              [MDBA_MDB_EATTR attributes]
 203  *         }
 204  *     }
 205  * }
 206  * [MDBA_ROUTER] = {
 207  *    [MDBA_ROUTER_PORT] = {
 208  *        u32 ifindex
 209  *        [MDBA_ROUTER_PATTR attributes]
 210  *    }
 211  * }
 212  */
 213 enum {
 214         MDBA_UNSPEC,
 215         MDBA_MDB,
 216         MDBA_ROUTER,
 217         __MDBA_MAX,
 218 };
 219 #define MDBA_MAX (__MDBA_MAX - 1)
 220
 221 enum {
 222         MDBA_MDB_UNSPEC,
 223         MDBA_MDB_ENTRY,
 224         __MDBA_MDB_MAX,
 225 };
 226 #define MDBA_MDB_MAX (__MDBA_MDB_MAX - 1)
 227
 228 enum {
 229         MDBA_MDB_ENTRY_UNSPEC,
 230         MDBA_MDB_ENTRY_INFO,
 231         __MDBA_MDB_ENTRY_MAX,
 232 };
 233 #define MDBA_MDB_ENTRY_MAX (__MDBA_MDB_ENTRY_MAX - 1)
 234
 235 /* per mdb entry additional attributes */
 236 enum {
 237         MDBA_MDB_EATTR_UNSPEC,
 238         MDBA_MDB_EATTR_TIMER,
 239         __MDBA_MDB_EATTR_MAX
 240 };
 241 #define MDBA_MDB_EATTR_MAX (__MDBA_MDB_EATTR_MAX - 1)
 242
 243 /* multicast router types */
 244 enum {
 245         MDB_RTR_TYPE_DISABLED,
 246         MDB_RTR_TYPE_TEMP_QUERY,
 247         MDB_RTR_TYPE_PERM,
 248         MDB_RTR_TYPE_TEMP
 249 };
 250
 251 enum {
 252         MDBA_ROUTER_UNSPEC,
 253         MDBA_ROUTER_PORT,
 254         __MDBA_ROUTER_MAX,
 255 };
 256 #define MDBA_ROUTER_MAX (__MDBA_ROUTER_MAX - 1)
 257
 258 /* router port attributes */
 259 enum {
 260         MDBA_ROUTER_PATTR_UNSPEC,
 261         MDBA_ROUTER_PATTR_TIMER,
 262         MDBA_ROUTER_PATTR_TYPE,
 263         __MDBA_ROUTER_PATTR_MAX
 264 };
 265 #define MDBA_ROUTER_PATTR_MAX (__MDBA_ROUTER_PATTR_MAX - 1)
 266
 267 struct br_port_msg {
 268         __u8  family;
 269         __u32 ifindex;
 270 };
 271
 272 struct br_mdb_entry {
 273         __u32 ifindex;
 274 #define MDB_TEMPORARY 0
 275 #define MDB_PERMANENT 1
 276         __u8 state;
 277 #define MDB_FLAGS_OFFLOAD       (1 << 0)
 278 #define MDB_FLAGS_FAST_LEAVE    (1 << 1)
 279         __u8 flags;
 280         __u16 vid;
 281         struct {
 282                 union {
 283                         __be32  ip4;
 284                         struct in6_addr ip6;
 285                 } u;
 286                 __be16          proto;
 287         } addr;
 288 };
 289
 290 enum {
 291         MDBA_SET_ENTRY_UNSPEC,
 292         MDBA_SET_ENTRY,
 293         __MDBA_SET_ENTRY_MAX,
 294 };
 295 #define MDBA_SET_ENTRY_MAX (__MDBA_SET_ENTRY_MAX - 1)
 296
 297 /* Embedded inside LINK_XSTATS_TYPE_BRIDGE */
 298 enum {
 299         BRIDGE_XSTATS_UNSPEC,
 300         BRIDGE_XSTATS_VLAN,
 301         BRIDGE_XSTATS_MCAST,
 302         BRIDGE_XSTATS_PAD,
 303         BRIDGE_XSTATS_STP,
 304         __BRIDGE_XSTATS_MAX
 305 };
 306 #define BRIDGE_XSTATS_MAX (__BRIDGE_XSTATS_MAX - 1)
 307
 308 enum {
 309         BR_MCAST_DIR_RX,
 310         BR_MCAST_DIR_TX,
 311         BR_MCAST_DIR_SIZE
 312 };
 313
 314 /* IGMP/MLD statistics */
 315 struct br_mcast_stats {
 316         __u64 igmp_v1queries[BR_MCAST_DIR_SIZE];
 317         __u64 igmp_v2queries[BR_MCAST_DIR_SIZE];
 318         __u64 igmp_v3queries[BR_MCAST_DIR_SIZE];
 319         __u64 igmp_leaves[BR_MCAST_DIR_SIZE];
 320         __u64 igmp_v1reports[BR_MCAST_DIR_SIZE];
 321         __u64 igmp_v2reports[BR_MCAST_DIR_SIZE];
 322         __u64 igmp_v3reports[BR_MCAST_DIR_SIZE];
 323         __u64 igmp_parse_errors;
 324
 325         __u64 mld_v1queries[BR_MCAST_DIR_SIZE];
 326         __u64 mld_v2queries[BR_MCAST_DIR_SIZE];
 327         __u64 mld_leaves[BR_MCAST_DIR_SIZE];
 328         __u64 mld_v1reports[BR_MCAST_DIR_SIZE];
 329         __u64 mld_v2reports[BR_MCAST_DIR_SIZE];
 330         __u64 mld_parse_errors;
 331
 332         __u64 mcast_bytes[BR_MCAST_DIR_SIZE];
 333         __u64 mcast_packets[BR_MCAST_DIR_SIZE];
 334 };
 335
 336 /* bridge boolean options
 337  * BR_BOOLOPT_NO_LL_LEARN - disable learning from link-local packets
 338  *
 339  * IMPORTANT: if adding a new option do not forget to handle
 340  *            it in br_boolopt_toggle/get and bridge sysfs
 341  */
 342 enum br_boolopt_id {
 343         BR_BOOLOPT_NO_LL_LEARN,
 344         BR_BOOLOPT_MAX
 345 };
 346
 347 /* struct br_boolopt_multi - change multiple bridge boolean options
 348  *
 349  * @optval: new option values (bit per option)
 350  * @optmask: options to change (bit per option)
 351  */
 352 struct br_boolopt_multi {
 353         __u32 optval;
 354         __u32 optmask;
 355 };
 356 #endif /* _LINUX_IF_BRIDGE_H */