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