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