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