net/bridge/br_private.h

   1 /*
   2  *      Linux ethernet bridge
   3  *
   4  *      Authors:
   5  *      Lennert Buytenhek               <buytenh@gnu.org>
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License
   9  *      as published by the Free Software Foundation; either version
  10  *      2 of the License, or (at your option) any later version.
  11  */
  12
  13 #ifndef _BR_PRIVATE_H
  14 #define _BR_PRIVATE_H
  15
  16 #include <linux/netdevice.h>
  17 #include <linux/if_bridge.h>
  18 #include <linux/netpoll.h>
  19 #include <linux/u64_stats_sync.h>
  20 #include <net/route.h>
  21
  22 #define BR_HASH_BITS 8
  23 #define BR_HASH_SIZE (1 << BR_HASH_BITS)
  24
  25 #define BR_HOLD_TIME (1*HZ)
  26
  27 #define BR_PORT_BITS    10
  28 #define BR_MAX_PORTS    (1<<BR_PORT_BITS)
  29
  30 #define BR_VERSION      "2.3"
  31
  32 /* Control of forwarding link local multicast */
  33 #define BR_GROUPFWD_DEFAULT     0
  34 /* Don't allow forwarding control protocols like STP and LLDP */
  35 #define BR_GROUPFWD_RESTRICTED  0x4007u
  36
  37 /* Path to usermode spanning tree program */
  38 #define BR_STP_PROG     "/sbin/bridge-stp"
  39
  40 typedef struct bridge_id bridge_id;
  41 typedef struct mac_addr mac_addr;
  42 typedef __u16 port_id;
  43
  44 struct bridge_id
  45 {
  46         unsigned char   prio[2];
  47         unsigned char   addr[6];
  48 };
  49
  50 struct mac_addr
  51 {
  52         unsigned char   addr[6];
  53 };
  54
  55 struct br_ip
  56 {
  57         union {
  58                 __be32  ip4;
  59 #if IS_ENABLED(CONFIG_IPV6)
  60                 struct in6_addr ip6;
  61 #endif
  62         } u;
  63         __be16          proto;
  64 };
  65
  66 struct net_bridge_fdb_entry
  67 {
  68         struct hlist_node               hlist;
  69         struct net_bridge_port          *dst;
  70
  71         struct rcu_head                 rcu;
  72         unsigned long                   updated;
  73         unsigned long                   used;
  74         mac_addr                        addr;
  75         unsigned char                   is_local;
  76         unsigned char                   is_static;
  77 };
  78
  79 struct net_bridge_port_group {
  80         struct net_bridge_port          *port;
  81         struct net_bridge_port_group __rcu *next;
  82         struct hlist_node               mglist;
  83         struct rcu_head                 rcu;
  84         struct timer_list               timer;
  85         struct br_ip                    addr;
  86 };
  87
  88 struct net_bridge_mdb_entry
  89 {
  90         struct hlist_node               hlist[2];
  91         struct net_bridge               *br;
  92         struct net_bridge_port_group __rcu *ports;
  93         struct rcu_head                 rcu;
  94         struct timer_list               timer;
  95         struct br_ip                    addr;
  96         bool                            mglist;
  97 };
  98
  99 struct net_bridge_mdb_htable
 100 {
 101         struct hlist_head               *mhash;
 102         struct rcu_head                 rcu;
 103         struct net_bridge_mdb_htable    *old;
 104         u32                             size;
 105         u32                             max;
 106         u32                             secret;
 107         u32                             ver;
 108 };
 109
 110 struct net_bridge_port
 111 {
 112         struct net_bridge               *br;
 113         struct net_device               *dev;
 114         struct list_head                list;
 115
 116         /* STP */
 117         u8                              priority;
 118         u8                              state;
 119         u16                             port_no;
 120         unsigned char                   topology_change_ack;
 121         unsigned char                   config_pending;
 122         port_id                         port_id;
 123         port_id                         designated_port;
 124         bridge_id                       designated_root;
 125         bridge_id                       designated_bridge;
 126         u32                             path_cost;
 127         u32                             designated_cost;
 128         unsigned long                   designated_age;
 129
 130         struct timer_list               forward_delay_timer;
 131         struct timer_list               hold_timer;
 132         struct timer_list               message_age_timer;
 133         struct kobject                  kobj;
 134         struct rcu_head                 rcu;
 135
 136         unsigned long                   flags;
 137 #define BR_HAIRPIN_MODE         0x00000001
 138 #define BR_BPDU_GUARD           0x00000002
 139
 140 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 141         u32                             multicast_startup_queries_sent;
 142         unsigned char                   multicast_router;
 143         struct timer_list               multicast_router_timer;
 144         struct timer_list               multicast_query_timer;
 145         struct hlist_head               mglist;
 146         struct hlist_node               rlist;
 147 #endif
 148
 149 #ifdef CONFIG_SYSFS
 150         char                            sysfs_name[IFNAMSIZ];
 151 #endif
 152
 153 #ifdef CONFIG_NET_POLL_CONTROLLER
 154         struct netpoll                  *np;
 155 #endif
 156 };
 157
 158 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
 159
 160 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
 161 {
 162         struct net_bridge_port *port =
 163                         rcu_dereference_rtnl(dev->rx_handler_data);
 164
 165         return br_port_exists(dev) ? port : NULL;
 166 }
 167
 168 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
 169 {
 170         return br_port_exists(dev) ?
 171                 rtnl_dereference(dev->rx_handler_data) : NULL;
 172 }
 173
 174 struct br_cpu_netstats {
 175         u64                     rx_packets;
 176         u64                     rx_bytes;
 177         u64                     tx_packets;
 178         u64                     tx_bytes;
 179         struct u64_stats_sync   syncp;
 180 };
 181
 182 struct net_bridge
 183 {
 184         spinlock_t                      lock;
 185         struct list_head                port_list;
 186         struct net_device               *dev;
 187
 188         struct br_cpu_netstats __percpu *stats;
 189         spinlock_t                      hash_lock;
 190         struct hlist_head               hash[BR_HASH_SIZE];
 191 #ifdef CONFIG_BRIDGE_NETFILTER
 192         struct rtable                   fake_rtable;
 193         bool                            nf_call_iptables;
 194         bool                            nf_call_ip6tables;
 195         bool                            nf_call_arptables;
 196 #endif
 197         unsigned long                   flags;
 198 #define BR_SET_MAC_ADDR         0x00000001
 199
 200         u16                             group_fwd_mask;
 201
 202         /* STP */
 203         bridge_id                       designated_root;
 204         bridge_id                       bridge_id;
 205         u32                             root_path_cost;
 206         unsigned long                   max_age;
 207         unsigned long                   hello_time;
 208         unsigned long                   forward_delay;
 209         unsigned long                   bridge_max_age;
 210         unsigned long                   ageing_time;
 211         unsigned long                   bridge_hello_time;
 212         unsigned long                   bridge_forward_delay;
 213
 214         u8                              group_addr[ETH_ALEN];
 215         u16                             root_port;
 216
 217         enum {
 218                 BR_NO_STP,              /* no spanning tree */
 219                 BR_KERNEL_STP,          /* old STP in kernel */
 220                 BR_USER_STP,            /* new RSTP in userspace */
 221         } stp_enabled;
 222
 223         unsigned char                   topology_change;
 224         unsigned char                   topology_change_detected;
 225
 226 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 227         unsigned char                   multicast_router;
 228
 229         u8                              multicast_disabled:1;
 230         u8                              multicast_querier:1;
 231
 232         u32                             hash_elasticity;
 233         u32                             hash_max;
 234
 235         u32                             multicast_last_member_count;
 236         u32                             multicast_startup_queries_sent;
 237         u32                             multicast_startup_query_count;
 238
 239         unsigned long                   multicast_last_member_interval;
 240         unsigned long                   multicast_membership_interval;
 241         unsigned long                   multicast_querier_interval;
 242         unsigned long                   multicast_query_interval;
 243         unsigned long                   multicast_query_response_interval;
 244         unsigned long                   multicast_startup_query_interval;
 245
 246         spinlock_t                      multicast_lock;
 247         struct net_bridge_mdb_htable __rcu *mdb;
 248         struct hlist_head               router_list;
 249
 250         struct timer_list               multicast_router_timer;
 251         struct timer_list               multicast_querier_timer;
 252         struct timer_list               multicast_query_timer;
 253 #endif
 254
 255         struct timer_list               hello_timer;
 256         struct timer_list               tcn_timer;
 257         struct timer_list               topology_change_timer;
 258         struct timer_list               gc_timer;
 259         struct kobject                  *ifobj;
 260 };
 261
 262 struct br_input_skb_cb {
 263         struct net_device *brdev;
 264 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 265         int igmp;
 266         int mrouters_only;
 267 #endif
 268 };
 269
 270 #define BR_INPUT_SKB_CB(__skb)  ((struct br_input_skb_cb *)(__skb)->cb)
 271
 272 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 273 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)   (BR_INPUT_SKB_CB(__skb)->mrouters_only)
 274 #else
 275 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)   (0)
 276 #endif
 277
 278 #define br_printk(level, br, format, args...)   \
 279         printk(level "%s: " format, (br)->dev->name, ##args)
 280
 281 #define br_err(__br, format, args...)                   \
 282         br_printk(KERN_ERR, __br, format, ##args)
 283 #define br_warn(__br, format, args...)                  \
 284         br_printk(KERN_WARNING, __br, format, ##args)
 285 #define br_notice(__br, format, args...)                \
 286         br_printk(KERN_NOTICE, __br, format, ##args)
 287 #define br_info(__br, format, args...)                  \
 288         br_printk(KERN_INFO, __br, format, ##args)
 289
 290 #define br_debug(br, format, args...)                   \
 291         pr_debug("%s: " format,  (br)->dev->name, ##args)
 292
 293 extern struct notifier_block br_device_notifier;
 294
 295 /* called under bridge lock */
 296 static inline int br_is_root_bridge(const struct net_bridge *br)
 297 {
 298         return !memcmp(&br->bridge_id, &br->designated_root, 8);
 299 }
 300
 301 /* br_device.c */
 302 extern void br_dev_setup(struct net_device *dev);
 303 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
 304 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
 305                                struct net_device *dev);
 306 #ifdef CONFIG_NET_POLL_CONTROLLER
 307 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
 308 {
 309         return br->dev->npinfo;
 310 }
 311
 312 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
 313                                        struct sk_buff *skb)
 314 {
 315         struct netpoll *np = p->np;
 316
 317         if (np)
 318                 netpoll_send_skb(np, skb);
 319 }
 320
 321 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
 322 extern void br_netpoll_disable(struct net_bridge_port *p);
 323 #else
 324 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
 325 {
 326         return NULL;
 327 }
 328
 329 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
 330                                        struct sk_buff *skb)
 331 {
 332 }
 333
 334 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
 335 {
 336         return 0;
 337 }
 338
 339 static inline void br_netpoll_disable(struct net_bridge_port *p)
 340 {
 341 }
 342 #endif
 343
 344 /* br_fdb.c */
 345 extern int br_fdb_init(void);
 346 extern void br_fdb_fini(void);
 347 extern void br_fdb_flush(struct net_bridge *br);
 348 extern void br_fdb_changeaddr(struct net_bridge_port *p,
 349                               const unsigned char *newaddr);
 350 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
 351 extern void br_fdb_cleanup(unsigned long arg);
 352 extern void br_fdb_delete_by_port(struct net_bridge *br,
 353                                   const struct net_bridge_port *p, int do_all);
 354 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
 355                                                  const unsigned char *addr);
 356 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
 357 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
 358                           unsigned long count, unsigned long off);
 359 extern int br_fdb_insert(struct net_bridge *br,
 360                          struct net_bridge_port *source,
 361                          const unsigned char *addr);
 362 extern void br_fdb_update(struct net_bridge *br,
 363                           struct net_bridge_port *source,
 364                           const unsigned char *addr);
 365
 366 extern int br_fdb_delete(struct ndmsg *ndm,
 367                          struct net_device *dev,
 368                          const unsigned char *addr);
 369 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
 370                       struct net_device *dev,
 371                       const unsigned char *addr,
 372                       u16 nlh_flags);
 373 extern int br_fdb_dump(struct sk_buff *skb,
 374                        struct netlink_callback *cb,
 375                        struct net_device *dev,
 376                        int idx);
 377
 378 /* br_forward.c */
 379 extern void br_deliver(const struct net_bridge_port *to,
 380                 struct sk_buff *skb);
 381 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
 382 extern void br_forward(const struct net_bridge_port *to,
 383                 struct sk_buff *skb, struct sk_buff *skb0);
 384 extern int br_forward_finish(struct sk_buff *skb);
 385 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
 386 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
 387                              struct sk_buff *skb2);
 388
 389 /* br_if.c */
 390 extern void br_port_carrier_check(struct net_bridge_port *p);
 391 extern int br_add_bridge(struct net *net, const char *name);
 392 extern int br_del_bridge(struct net *net, const char *name);
 393 extern void br_net_exit(struct net *net);
 394 extern int br_add_if(struct net_bridge *br,
 395               struct net_device *dev);
 396 extern int br_del_if(struct net_bridge *br,
 397               struct net_device *dev);
 398 extern int br_min_mtu(const struct net_bridge *br);
 399 extern netdev_features_t br_features_recompute(struct net_bridge *br,
 400         netdev_features_t features);
 401
 402 /* br_input.c */
 403 extern int br_handle_frame_finish(struct sk_buff *skb);
 404 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
 405
 406 /* br_ioctl.c */
 407 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
 408 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
 409
 410 /* br_multicast.c */
 411 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 412 extern int br_multicast_rcv(struct net_bridge *br,
 413                             struct net_bridge_port *port,
 414                             struct sk_buff *skb);
 415 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
 416                                                struct sk_buff *skb);
 417 extern void br_multicast_add_port(struct net_bridge_port *port);
 418 extern void br_multicast_del_port(struct net_bridge_port *port);
 419 extern void br_multicast_enable_port(struct net_bridge_port *port);
 420 extern void br_multicast_disable_port(struct net_bridge_port *port);
 421 extern void br_multicast_init(struct net_bridge *br);
 422 extern void br_multicast_open(struct net_bridge *br);
 423 extern void br_multicast_stop(struct net_bridge *br);
 424 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
 425                                  struct sk_buff *skb);
 426 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
 427                                  struct sk_buff *skb, struct sk_buff *skb2);
 428 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
 429 extern int br_multicast_set_port_router(struct net_bridge_port *p,
 430                                         unsigned long val);
 431 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
 432 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
 433 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
 434
 435 static inline bool br_multicast_is_router(struct net_bridge *br)
 436 {
 437         return br->multicast_router == 2 ||
 438                (br->multicast_router == 1 &&
 439                 timer_pending(&br->multicast_router_timer));
 440 }
 441 #else
 442 static inline int br_multicast_rcv(struct net_bridge *br,
 443                                    struct net_bridge_port *port,
 444                                    struct sk_buff *skb)
 445 {
 446         return 0;
 447 }
 448
 449 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
 450                                                       struct sk_buff *skb)
 451 {
 452         return NULL;
 453 }
 454
 455 static inline void br_multicast_add_port(struct net_bridge_port *port)
 456 {
 457 }
 458
 459 static inline void br_multicast_del_port(struct net_bridge_port *port)
 460 {
 461 }
 462
 463 static inline void br_multicast_enable_port(struct net_bridge_port *port)
 464 {
 465 }
 466
 467 static inline void br_multicast_disable_port(struct net_bridge_port *port)
 468 {
 469 }
 470
 471 static inline void br_multicast_init(struct net_bridge *br)
 472 {
 473 }
 474
 475 static inline void br_multicast_open(struct net_bridge *br)
 476 {
 477 }
 478
 479 static inline void br_multicast_stop(struct net_bridge *br)
 480 {
 481 }
 482
 483 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
 484                                         struct sk_buff *skb)
 485 {
 486 }
 487
 488 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
 489                                         struct sk_buff *skb,
 490                                         struct sk_buff *skb2)
 491 {
 492 }
 493 static inline bool br_multicast_is_router(struct net_bridge *br)
 494 {
 495         return 0;
 496 }
 497 #endif
 498
 499 /* br_netfilter.c */
 500 #ifdef CONFIG_BRIDGE_NETFILTER
 501 extern int br_netfilter_init(void);
 502 extern void br_netfilter_fini(void);
 503 extern void br_netfilter_rtable_init(struct net_bridge *);
 504 #else
 505 #define br_netfilter_init()     (0)
 506 #define br_netfilter_fini()     do { } while(0)
 507 #define br_netfilter_rtable_init(x)
 508 #endif
 509
 510 /* br_stp.c */
 511 extern void br_log_state(const struct net_bridge_port *p);
 512 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
 513                                            u16 port_no);
 514 extern void br_init_port(struct net_bridge_port *p);
 515 extern void br_become_designated_port(struct net_bridge_port *p);
 516
 517 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
 518 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
 519 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
 520
 521
 522 /* br_stp_if.c */
 523 extern void br_stp_enable_bridge(struct net_bridge *br);
 524 extern void br_stp_disable_bridge(struct net_bridge *br);
 525 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
 526 extern void br_stp_enable_port(struct net_bridge_port *p);
 527 extern void br_stp_disable_port(struct net_bridge_port *p);
 528 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
 529 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
 530 extern void br_stp_set_bridge_priority(struct net_bridge *br,
 531                                        u16 newprio);
 532 extern int br_stp_set_port_priority(struct net_bridge_port *p,
 533                                     unsigned long newprio);
 534 extern int br_stp_set_path_cost(struct net_bridge_port *p,
 535                                 unsigned long path_cost);
 536 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
 537
 538 /* br_stp_bpdu.c */
 539 struct stp_proto;
 540 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
 541                        struct net_device *dev);
 542
 543 /* br_stp_timer.c */
 544 extern void br_stp_timer_init(struct net_bridge *br);
 545 extern void br_stp_port_timer_init(struct net_bridge_port *p);
 546 extern unsigned long br_timer_value(const struct timer_list *timer);
 547
 548 /* br.c */
 549 #if IS_ENABLED(CONFIG_ATM_LANE)
 550 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
 551 #endif
 552
 553 /* br_netlink.c */
 554 extern struct rtnl_link_ops br_link_ops;
 555 extern int br_netlink_init(void);
 556 extern void br_netlink_fini(void);
 557 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
 558 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
 559 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
 560                       struct net_device *dev);
 561
 562 #ifdef CONFIG_SYSFS
 563 /* br_sysfs_if.c */
 564 extern const struct sysfs_ops brport_sysfs_ops;
 565 extern int br_sysfs_addif(struct net_bridge_port *p);
 566 extern int br_sysfs_renameif(struct net_bridge_port *p);
 567
 568 /* br_sysfs_br.c */
 569 extern int br_sysfs_addbr(struct net_device *dev);
 570 extern void br_sysfs_delbr(struct net_device *dev);
 571
 572 #else
 573
 574 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
 575 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
 576 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
 577 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
 578 #endif /* CONFIG_SYSFS */
 579
 580 #endif