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