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