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