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