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 #define BRIDGE_VLAN_INFO_ONLY_OPTS      (1<<6) /* Skip create/delete/flags */
 134 #define BRIDGE_VLAN_INFO_REMOVE_TUN     (1<<7) /* Remove tunnel mapping */
 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 struct bridge_stp_xstats {
 162         __u64 transition_blk;
 163         __u64 transition_fwd;
 164         __u64 rx_bpdu;
 165         __u64 tx_bpdu;
 166         __u64 rx_tcn;
 167         __u64 tx_tcn;
 168 };
 169
 170 /* Bridge vlan RTM header */
 171 struct br_vlan_msg {
 172         __u8 family;
 173         __u8 reserved1;
 174         __u16 reserved2;
 175         __u32 ifindex;
 176 };
 177
 178 enum {
 179         BRIDGE_VLANDB_DUMP_UNSPEC,
 180         BRIDGE_VLANDB_DUMP_FLAGS,
 181         __BRIDGE_VLANDB_DUMP_MAX,
 182 };
 183 #define BRIDGE_VLANDB_DUMP_MAX (__BRIDGE_VLANDB_DUMP_MAX - 1)
 184
 185 /* flags used in BRIDGE_VLANDB_DUMP_FLAGS attribute to affect dumps */
 186 #define BRIDGE_VLANDB_DUMPF_STATS       (1 << 0) /* Include stats in the dump */
 187
 188 /* Bridge vlan RTM attributes
 189  * [BRIDGE_VLANDB_ENTRY] = {
 190  *     [BRIDGE_VLANDB_ENTRY_INFO]
 191  *     ...
 192  * }
 193  */
 194 enum {
 195         BRIDGE_VLANDB_UNSPEC,
 196         BRIDGE_VLANDB_ENTRY,
 197         __BRIDGE_VLANDB_MAX,
 198 };
 199 #define BRIDGE_VLANDB_MAX (__BRIDGE_VLANDB_MAX - 1)
 200
 201 enum {
 202         BRIDGE_VLANDB_ENTRY_UNSPEC,
 203         BRIDGE_VLANDB_ENTRY_INFO,
 204         BRIDGE_VLANDB_ENTRY_RANGE,
 205         BRIDGE_VLANDB_ENTRY_STATE,
 206         BRIDGE_VLANDB_ENTRY_TUNNEL_ID,
 207         BRIDGE_VLANDB_ENTRY_STATS,
 208         __BRIDGE_VLANDB_ENTRY_MAX,
 209 };
 210 #define BRIDGE_VLANDB_ENTRY_MAX (__BRIDGE_VLANDB_ENTRY_MAX - 1)
 211
 212 /* [BRIDGE_VLANDB_ENTRY] = {
 213  *     [BRIDGE_VLANDB_ENTRY_STATS] = {
 214  *         [BRIDGE_VLANDB_STATS_RX_BYTES]
 215  *         ...
 216  *     }
 217  *     ...
 218  * }
 219  */
 220 enum {
 221         BRIDGE_VLANDB_STATS_UNSPEC,
 222         BRIDGE_VLANDB_STATS_RX_BYTES,
 223         BRIDGE_VLANDB_STATS_RX_PACKETS,
 224         BRIDGE_VLANDB_STATS_TX_BYTES,
 225         BRIDGE_VLANDB_STATS_TX_PACKETS,
 226         BRIDGE_VLANDB_STATS_PAD,
 227         __BRIDGE_VLANDB_STATS_MAX,
 228 };
 229 #define BRIDGE_VLANDB_STATS_MAX (__BRIDGE_VLANDB_STATS_MAX - 1)
 230
 231 /* Bridge multicast database attributes
 232  * [MDBA_MDB] = {
 233  *     [MDBA_MDB_ENTRY] = {
 234  *         [MDBA_MDB_ENTRY_INFO] {
 235  *              struct br_mdb_entry
 236  *              [MDBA_MDB_EATTR attributes]
 237  *         }
 238  *     }
 239  * }
 240  * [MDBA_ROUTER] = {
 241  *    [MDBA_ROUTER_PORT] = {
 242  *        u32 ifindex
 243  *        [MDBA_ROUTER_PATTR attributes]
 244  *    }
 245  * }
 246  */
 247 enum {
 248         MDBA_UNSPEC,
 249         MDBA_MDB,
 250         MDBA_ROUTER,
 251         __MDBA_MAX,
 252 };
 253 #define MDBA_MAX (__MDBA_MAX - 1)
 254
 255 enum {
 256         MDBA_MDB_UNSPEC,
 257         MDBA_MDB_ENTRY,
 258         __MDBA_MDB_MAX,
 259 };
 260 #define MDBA_MDB_MAX (__MDBA_MDB_MAX - 1)
 261
 262 enum {
 263         MDBA_MDB_ENTRY_UNSPEC,
 264         MDBA_MDB_ENTRY_INFO,
 265         __MDBA_MDB_ENTRY_MAX,
 266 };
 267 #define MDBA_MDB_ENTRY_MAX (__MDBA_MDB_ENTRY_MAX - 1)
 268
 269 /* per mdb entry additional attributes */
 270 enum {
 271         MDBA_MDB_EATTR_UNSPEC,
 272         MDBA_MDB_EATTR_TIMER,
 273         __MDBA_MDB_EATTR_MAX
 274 };
 275 #define MDBA_MDB_EATTR_MAX (__MDBA_MDB_EATTR_MAX - 1)
 276
 277 /* multicast router types */
 278 enum {
 279         MDB_RTR_TYPE_DISABLED,
 280         MDB_RTR_TYPE_TEMP_QUERY,
 281         MDB_RTR_TYPE_PERM,
 282         MDB_RTR_TYPE_TEMP
 283 };
 284
 285 enum {
 286         MDBA_ROUTER_UNSPEC,
 287         MDBA_ROUTER_PORT,
 288         __MDBA_ROUTER_MAX,
 289 };
 290 #define MDBA_ROUTER_MAX (__MDBA_ROUTER_MAX - 1)
 291
 292 /* router port attributes */
 293 enum {
 294         MDBA_ROUTER_PATTR_UNSPEC,
 295         MDBA_ROUTER_PATTR_TIMER,
 296         MDBA_ROUTER_PATTR_TYPE,
 297         __MDBA_ROUTER_PATTR_MAX
 298 };
 299 #define MDBA_ROUTER_PATTR_MAX (__MDBA_ROUTER_PATTR_MAX - 1)
 300
 301 struct br_port_msg {
 302         __u8  family;
 303         __u32 ifindex;
 304 };
 305
 306 struct br_mdb_entry {
 307         __u32 ifindex;
 308 #define MDB_TEMPORARY 0
 309 #define MDB_PERMANENT 1
 310         __u8 state;
 311 #define MDB_FLAGS_OFFLOAD       (1 << 0)
 312 #define MDB_FLAGS_FAST_LEAVE    (1 << 1)
 313         __u8 flags;
 314         __u16 vid;
 315         struct {
 316                 union {
 317                         __be32  ip4;
 318                         struct in6_addr ip6;
 319                 } u;
 320                 __be16          proto;
 321         } addr;
 322 };
 323
 324 enum {
 325         MDBA_SET_ENTRY_UNSPEC,
 326         MDBA_SET_ENTRY,
 327         __MDBA_SET_ENTRY_MAX,
 328 };
 329 #define MDBA_SET_ENTRY_MAX (__MDBA_SET_ENTRY_MAX - 1)
 330
 331 /* Embedded inside LINK_XSTATS_TYPE_BRIDGE */
 332 enum {
 333         BRIDGE_XSTATS_UNSPEC,
 334         BRIDGE_XSTATS_VLAN,
 335         BRIDGE_XSTATS_MCAST,
 336         BRIDGE_XSTATS_PAD,
 337         BRIDGE_XSTATS_STP,
 338         __BRIDGE_XSTATS_MAX
 339 };
 340 #define BRIDGE_XSTATS_MAX (__BRIDGE_XSTATS_MAX - 1)
 341
 342 enum {
 343         BR_MCAST_DIR_RX,
 344         BR_MCAST_DIR_TX,
 345         BR_MCAST_DIR_SIZE
 346 };
 347
 348 /* IGMP/MLD statistics */
 349 struct br_mcast_stats {
 350         __u64 igmp_v1queries[BR_MCAST_DIR_SIZE];
 351         __u64 igmp_v2queries[BR_MCAST_DIR_SIZE];
 352         __u64 igmp_v3queries[BR_MCAST_DIR_SIZE];
 353         __u64 igmp_leaves[BR_MCAST_DIR_SIZE];
 354         __u64 igmp_v1reports[BR_MCAST_DIR_SIZE];
 355         __u64 igmp_v2reports[BR_MCAST_DIR_SIZE];
 356         __u64 igmp_v3reports[BR_MCAST_DIR_SIZE];
 357         __u64 igmp_parse_errors;
 358
 359         __u64 mld_v1queries[BR_MCAST_DIR_SIZE];
 360         __u64 mld_v2queries[BR_MCAST_DIR_SIZE];
 361         __u64 mld_leaves[BR_MCAST_DIR_SIZE];
 362         __u64 mld_v1reports[BR_MCAST_DIR_SIZE];
 363         __u64 mld_v2reports[BR_MCAST_DIR_SIZE];
 364         __u64 mld_parse_errors;
 365
 366         __u64 mcast_bytes[BR_MCAST_DIR_SIZE];
 367         __u64 mcast_packets[BR_MCAST_DIR_SIZE];
 368 };
 369
 370 /* bridge boolean options
 371  * BR_BOOLOPT_NO_LL_LEARN - disable learning from link-local packets
 372  *
 373  * IMPORTANT: if adding a new option do not forget to handle
 374  *            it in br_boolopt_toggle/get and bridge sysfs
 375  */
 376 enum br_boolopt_id {
 377         BR_BOOLOPT_NO_LL_LEARN,
 378         BR_BOOLOPT_MAX
 379 };
 380
 381 /* struct br_boolopt_multi - change multiple bridge boolean options
 382  *
 383  * @optval: new option values (bit per option)
 384  * @optmask: options to change (bit per option)
 385  */
 386 struct br_boolopt_multi {
 387         __u32 optval;
 388         __u32 optmask;
 389 };
 390 #endif /* _LINUX_IF_BRIDGE_H */