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