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 #define BR_ROOT_BLOCK           0x00000004
 140
 141 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 142         u32                             multicast_startup_queries_sent;
 143         unsigned char                   multicast_router;
 144         struct timer_list               multicast_router_timer;
 145         struct timer_list               multicast_query_timer;
 146         struct hlist_head               mglist;
 147         struct hlist_node               rlist;
 148 #endif
 149
 150 #ifdef CONFIG_SYSFS
 151         char                            sysfs_name[IFNAMSIZ];
 152 #endif
 153
 154 #ifdef CONFIG_NET_POLL_CONTROLLER
 155         struct netpoll                  *np;
 156 #endif
 157 };
 158
 159 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
 160
 161 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
 162 {
 163         struct net_bridge_port *port =
 164                         rcu_dereference_rtnl(dev->rx_handler_data);
 165
 166         return br_port_exists(dev) ? port : NULL;
 167 }
 168
 169 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
 170 {
 171         return br_port_exists(dev) ?
 172                 rtnl_dereference(dev->rx_handler_data) : NULL;
 173 }
 174
 175 struct br_cpu_netstats {
 176         u64                     rx_packets;
 177         u64                     rx_bytes;
 178         u64                     tx_packets;
 179         u64                     tx_bytes;
 180         struct u64_stats_sync   syncp;
 181 };
 182
 183 struct net_bridge
 184 {
 185         spinlock_t                      lock;
 186         struct list_head                port_list;
 187         struct net_device               *dev;
 188
 189         struct br_cpu_netstats __percpu *stats;
 190         spinlock_t                      hash_lock;
 191         struct hlist_head               hash[BR_HASH_SIZE];
 192 #ifdef CONFIG_BRIDGE_NETFILTER
 193         struct rtable                   fake_rtable;
 194         bool                            nf_call_iptables;
 195         bool                            nf_call_ip6tables;
 196         bool                            nf_call_arptables;
 197 #endif
 198         unsigned long                   flags;
 199 #define BR_SET_MAC_ADDR         0x00000001
 200
 201         u16                             group_fwd_mask;
 202
 203         /* STP */
 204         bridge_id                       designated_root;
 205         bridge_id                       bridge_id;
 206         u32                             root_path_cost;
 207         unsigned long                   max_age;
 208         unsigned long                   hello_time;
 209         unsigned long                   forward_delay;
 210         unsigned long                   bridge_max_age;
 211         unsigned long                   ageing_time;
 212         unsigned long                   bridge_hello_time;
 213         unsigned long                   bridge_forward_delay;
 214
 215         u8                              group_addr[ETH_ALEN];
 216         u16                             root_port;
 217
 218         enum {
 219                 BR_NO_STP,              /* no spanning tree */
 220                 BR_KERNEL_STP,          /* old STP in kernel */
 221                 BR_USER_STP,            /* new RSTP in userspace */
 222         } stp_enabled;
 223
 224         unsigned char                   topology_change;
 225         unsigned char                   topology_change_detected;
 226
 227 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 228         unsigned char                   multicast_router;
 229
 230         u8                              multicast_disabled:1;
 231         u8                              multicast_querier:1;
 232
 233         u32                             hash_elasticity;
 234         u32                             hash_max;
 235
 236         u32                             multicast_last_member_count;
 237         u32                             multicast_startup_queries_sent;
 238         u32                             multicast_startup_query_count;
 239
 240         unsigned long                   multicast_last_member_interval;
 241         unsigned long                   multicast_membership_interval;
 242         unsigned long                   multicast_querier_interval;
 243         unsigned long                   multicast_query_interval;
 244         unsigned long                   multicast_query_response_interval;
 245         unsigned long                   multicast_startup_query_interval;
 246
 247         spinlock_t                      multicast_lock;
 248         struct net_bridge_mdb_htable __rcu *mdb;
 249         struct hlist_head               router_list;
 250
 251         struct timer_list               multicast_router_timer;
 252         struct timer_list               multicast_querier_timer;
 253         struct timer_list               multicast_query_timer;
 254 #endif
 255
 256         struct timer_list               hello_timer;
 257         struct timer_list               tcn_timer;
 258         struct timer_list               topology_change_timer;
 259         struct timer_list               gc_timer;
 260         struct kobject                  *ifobj;
 261 };
 262
 263 struct br_input_skb_cb {
 264         struct net_device *brdev;
 265 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 266         int igmp;
 267         int mrouters_only;
 268 #endif
 269 };
 270
 271 #define BR_INPUT_SKB_CB(__skb)  ((struct br_input_skb_cb *)(__skb)->cb)
 272
 273 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 274 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)   (BR_INPUT_SKB_CB(__skb)->mrouters_only)
 275 #else
 276 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)   (0)
 277 #endif
 278
 279 #define br_printk(level, br, format, args...)   \
 280         printk(level "%s: " format, (br)->dev->name, ##args)
 281
 282 #define br_err(__br, format, args...)                   \
 283         br_printk(KERN_ERR, __br, format, ##args)
 284 #define br_warn(__br, format, args...)                  \
 285         br_printk(KERN_WARNING, __br, format, ##args)
 286 #define br_notice(__br, format, args...)                \
 287         br_printk(KERN_NOTICE, __br, format, ##args)
 288 #define br_info(__br, format, args...)                  \
 289         br_printk(KERN_INFO, __br, format, ##args)
 290
 291 #define br_debug(br, format, args...)                   \
 292         pr_debug("%s: " format,  (br)->dev->name, ##args)
 293
 294 extern struct notifier_block br_device_notifier;
 295
 296 /* called under bridge lock */
 297 static inline int br_is_root_bridge(const struct net_bridge *br)
 298 {
 299         return !memcmp(&br->bridge_id, &br->designated_root, 8);
 300 }
 301
 302 /* br_device.c */
 303 extern void br_dev_setup(struct net_device *dev);
 304 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
 305 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
 306                                struct net_device *dev);
 307 #ifdef CONFIG_NET_POLL_CONTROLLER
 308 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
 309 {
 310         return br->dev->npinfo;
 311 }
 312
 313 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
 314                                        struct sk_buff *skb)
 315 {
 316         struct netpoll *np = p->np;
 317
 318         if (np)
 319                 netpoll_send_skb(np, skb);
 320 }
 321
 322 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
 323 extern void br_netpoll_disable(struct net_bridge_port *p);
 324 #else
 325 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
 326 {
 327         return NULL;
 328 }
 329
 330 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
 331                                        struct sk_buff *skb)
 332 {
 333 }
 334
 335 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
 336 {
 337         return 0;
 338 }
 339
 340 static inline void br_netpoll_disable(struct net_bridge_port *p)
 341 {
 342 }
 343 #endif
 344
 345 /* br_fdb.c */
 346 extern int br_fdb_init(void);
 347 extern void br_fdb_fini(void);
 348 extern void br_fdb_flush(struct net_bridge *br);
 349 extern void br_fdb_changeaddr(struct net_bridge_port *p,
 350                               const unsigned char *newaddr);
 351 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
 352 extern void br_fdb_cleanup(unsigned long arg);
 353 extern void br_fdb_delete_by_port(struct net_bridge *br,
 354                                   const struct net_bridge_port *p, int do_all);
 355 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
 356                                                  const unsigned char *addr);
 357 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
 358 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
 359                           unsigned long count, unsigned long off);
 360 extern int br_fdb_insert(struct net_bridge *br,
 361                          struct net_bridge_port *source,
 362                          const unsigned char *addr);
 363 extern void br_fdb_update(struct net_bridge *br,
 364                           struct net_bridge_port *source,
 365                           const unsigned char *addr);
 366
 367 extern int br_fdb_delete(struct ndmsg *ndm,
 368                          struct net_device *dev,
 369                          const unsigned char *addr);
 370 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
 371                       struct net_device *dev,
 372                       const unsigned char *addr,
 373                       u16 nlh_flags);
 374 extern int br_fdb_dump(struct sk_buff *skb,
 375                        struct netlink_callback *cb,
 376                        struct net_device *dev,
 377                        int idx);
 378
 379 /* br_forward.c */
 380 extern void br_deliver(const struct net_bridge_port *to,
 381                 struct sk_buff *skb);
 382 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
 383 extern void br_forward(const struct net_bridge_port *to,
 384                 struct sk_buff *skb, struct sk_buff *skb0);
 385 extern int br_forward_finish(struct sk_buff *skb);
 386 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
 387 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
 388                              struct sk_buff *skb2);
 389
 390 /* br_if.c */
 391 extern void br_port_carrier_check(struct net_bridge_port *p);
 392 extern int br_add_bridge(struct net *net, const char *name);
 393 extern int br_del_bridge(struct net *net, const char *name);
 394 extern void br_net_exit(struct net *net);
 395 extern int br_add_if(struct net_bridge *br,
 396               struct net_device *dev);
 397 extern int br_del_if(struct net_bridge *br,
 398               struct net_device *dev);
 399 extern int br_min_mtu(const struct net_bridge *br);
 400 extern netdev_features_t br_features_recompute(struct net_bridge *br,
 401         netdev_features_t features);
 402
 403 /* br_input.c */
 404 extern int br_handle_frame_finish(struct sk_buff *skb);
 405 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
 406
 407 /* br_ioctl.c */
 408 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
 409 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
 410
 411 /* br_multicast.c */
 412 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
 413 extern int br_multicast_rcv(struct net_bridge *br,
 414                             struct net_bridge_port *port,
 415                             struct sk_buff *skb);
 416 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
 417                                                struct sk_buff *skb);
 418 extern void br_multicast_add_port(struct net_bridge_port *port);
 419 extern void br_multicast_del_port(struct net_bridge_port *port);
 420 extern void br_multicast_enable_port(struct net_bridge_port *port);
 421 extern void br_multicast_disable_port(struct net_bridge_port *port);
 422 extern void br_multicast_init(struct net_bridge *br);
 423 extern void br_multicast_open(struct net_bridge *br);
 424 extern void br_multicast_stop(struct net_bridge *br);
 425 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
 426                                  struct sk_buff *skb);
 427 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
 428                                  struct sk_buff *skb, struct sk_buff *skb2);
 429 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
 430 extern int br_multicast_set_port_router(struct net_bridge_port *p,
 431                                         unsigned long val);
 432 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
 433 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
 434 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
 435
 436 static inline bool br_multicast_is_router(struct net_bridge *br)
 437 {
 438         return br->multicast_router == 2 ||
 439                (br->multicast_router == 1 &&
 440                 timer_pending(&br->multicast_router_timer));
 441 }
 442 #else
 443 static inline int br_multicast_rcv(struct net_bridge *br,
 444                                    struct net_bridge_port *port,
 445                                    struct sk_buff *skb)
 446 {
 447         return 0;
 448 }
 449
 450 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
 451                                                       struct sk_buff *skb)
 452 {
 453         return NULL;
 454 }
 455
 456 static inline void br_multicast_add_port(struct net_bridge_port *port)
 457 {
 458 }
 459
 460 static inline void br_multicast_del_port(struct net_bridge_port *port)
 461 {
 462 }
 463
 464 static inline void br_multicast_enable_port(struct net_bridge_port *port)
 465 {
 466 }
 467
 468 static inline void br_multicast_disable_port(struct net_bridge_port *port)
 469 {
 470 }
 471
 472 static inline void br_multicast_init(struct net_bridge *br)
 473 {
 474 }
 475
 476 static inline void br_multicast_open(struct net_bridge *br)
 477 {
 478 }
 479
 480 static inline void br_multicast_stop(struct net_bridge *br)
 481 {
 482 }
 483
 484 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
 485                                         struct sk_buff *skb)
 486 {
 487 }
 488
 489 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
 490                                         struct sk_buff *skb,
 491                                         struct sk_buff *skb2)
 492 {
 493 }
 494 static inline bool br_multicast_is_router(struct net_bridge *br)
 495 {
 496         return 0;
 497 }
 498 #endif
 499
 500 /* br_netfilter.c */
 501 #ifdef CONFIG_BRIDGE_NETFILTER
 502 extern int br_netfilter_init(void);
 503 extern void br_netfilter_fini(void);
 504 extern void br_netfilter_rtable_init(struct net_bridge *);
 505 #else
 506 #define br_netfilter_init()     (0)
 507 #define br_netfilter_fini()     do { } while(0)
 508 #define br_netfilter_rtable_init(x)
 509 #endif
 510
 511 /* br_stp.c */
 512 extern void br_log_state(const struct net_bridge_port *p);
 513 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
 514                                            u16 port_no);
 515 extern void br_init_port(struct net_bridge_port *p);
 516 extern void br_become_designated_port(struct net_bridge_port *p);
 517
 518 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
 519 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
 520 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
 521
 522
 523 /* br_stp_if.c */
 524 extern void br_stp_enable_bridge(struct net_bridge *br);
 525 extern void br_stp_disable_bridge(struct net_bridge *br);
 526 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
 527 extern void br_stp_enable_port(struct net_bridge_port *p);
 528 extern void br_stp_disable_port(struct net_bridge_port *p);
 529 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
 530 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
 531 extern void br_stp_set_bridge_priority(struct net_bridge *br,
 532                                        u16 newprio);
 533 extern int br_stp_set_port_priority(struct net_bridge_port *p,
 534                                     unsigned long newprio);
 535 extern int br_stp_set_path_cost(struct net_bridge_port *p,
 536                                 unsigned long path_cost);
 537 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
 538
 539 /* br_stp_bpdu.c */
 540 struct stp_proto;
 541 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
 542                        struct net_device *dev);
 543
 544 /* br_stp_timer.c */
 545 extern void br_stp_timer_init(struct net_bridge *br);
 546 extern void br_stp_port_timer_init(struct net_bridge_port *p);
 547 extern unsigned long br_timer_value(const struct timer_list *timer);
 548
 549 /* br.c */
 550 #if IS_ENABLED(CONFIG_ATM_LANE)
 551 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
 552 #endif
 553
 554 /* br_netlink.c */
 555 extern struct rtnl_link_ops br_link_ops;
 556 extern int br_netlink_init(void);
 557 extern void br_netlink_fini(void);
 558 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
 559 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
 560 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
 561                       struct net_device *dev);
 562
 563 #ifdef CONFIG_SYSFS
 564 /* br_sysfs_if.c */
 565 extern const struct sysfs_ops brport_sysfs_ops;
 566 extern int br_sysfs_addif(struct net_bridge_port *p);
 567 extern int br_sysfs_renameif(struct net_bridge_port *p);
 568
 569 /* br_sysfs_br.c */
 570 extern int br_sysfs_addbr(struct net_device *dev);
 571 extern void br_sysfs_delbr(struct net_device *dev);
 572
 573 #else
 574
 575 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
 576 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
 577 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
 578 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
 579 #endif /* CONFIG_SYSFS */
 580
 581 #endif