Merge tag 'trace-v4.21' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[linux] / 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 <linux/netpoll.h>
19 #include <linux/u64_stats_sync.h>
20 #include <net/route.h>
21 #include <net/ip6_fib.h>
22 #include <linux/if_vlan.h>
23 #include <linux/rhashtable.h>
24 #include <linux/refcount.h>
25
26 #define BR_HASH_BITS 8
27 #define BR_HASH_SIZE (1 << BR_HASH_BITS)
28
29 #define BR_HOLD_TIME (1*HZ)
30
31 #define BR_PORT_BITS    10
32 #define BR_MAX_PORTS    (1<<BR_PORT_BITS)
33
34 #define BR_MULTICAST_DEFAULT_HASH_MAX 4096
35
36 #define BR_VERSION      "2.3"
37
38 /* Control of forwarding link local multicast */
39 #define BR_GROUPFWD_DEFAULT     0
40 /* Don't allow forwarding of control protocols like STP, MAC PAUSE and LACP */
41 enum {
42         BR_GROUPFWD_STP         = BIT(0),
43         BR_GROUPFWD_MACPAUSE    = BIT(1),
44         BR_GROUPFWD_LACP        = BIT(2),
45 };
46
47 #define BR_GROUPFWD_RESTRICTED (BR_GROUPFWD_STP | BR_GROUPFWD_MACPAUSE | \
48                                 BR_GROUPFWD_LACP)
49 /* The Nearest Customer Bridge Group Address, 01-80-C2-00-00-[00,0B,0C,0D,0F] */
50 #define BR_GROUPFWD_8021AD      0xB801u
51
52 /* Path to usermode spanning tree program */
53 #define BR_STP_PROG     "/sbin/bridge-stp"
54
55 typedef struct bridge_id bridge_id;
56 typedef struct mac_addr mac_addr;
57 typedef __u16 port_id;
58
59 struct bridge_id {
60         unsigned char   prio[2];
61         unsigned char   addr[ETH_ALEN];
62 };
63
64 struct mac_addr {
65         unsigned char   addr[ETH_ALEN];
66 };
67
68 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
69 /* our own querier */
70 struct bridge_mcast_own_query {
71         struct timer_list       timer;
72         u32                     startup_sent;
73 };
74
75 /* other querier */
76 struct bridge_mcast_other_query {
77         struct timer_list               timer;
78         unsigned long                   delay_time;
79 };
80
81 /* selected querier */
82 struct bridge_mcast_querier {
83         struct br_ip addr;
84         struct net_bridge_port __rcu    *port;
85 };
86
87 /* IGMP/MLD statistics */
88 struct bridge_mcast_stats {
89         struct br_mcast_stats mstats;
90         struct u64_stats_sync syncp;
91 };
92 #endif
93
94 struct br_vlan_stats {
95         u64 rx_bytes;
96         u64 rx_packets;
97         u64 tx_bytes;
98         u64 tx_packets;
99         struct u64_stats_sync syncp;
100 };
101
102 struct br_tunnel_info {
103         __be64                  tunnel_id;
104         struct metadata_dst     *tunnel_dst;
105 };
106
107 /* private vlan flags */
108 enum {
109         BR_VLFLAG_PER_PORT_STATS = BIT(0),
110 };
111
112 /**
113  * struct net_bridge_vlan - per-vlan entry
114  *
115  * @vnode: rhashtable member
116  * @vid: VLAN id
117  * @flags: bridge vlan flags
118  * @priv_flags: private (in-kernel) bridge vlan flags
119  * @stats: per-cpu VLAN statistics
120  * @br: if MASTER flag set, this points to a bridge struct
121  * @port: if MASTER flag unset, this points to a port struct
122  * @refcnt: if MASTER flag set, this is bumped for each port referencing it
123  * @brvlan: if MASTER flag unset, this points to the global per-VLAN context
124  *          for this VLAN entry
125  * @vlist: sorted list of VLAN entries
126  * @rcu: used for entry destruction
127  *
128  * This structure is shared between the global per-VLAN entries contained in
129  * the bridge rhashtable and the local per-port per-VLAN entries contained in
130  * the port's rhashtable. The union entries should be interpreted depending on
131  * the entry flags that are set.
132  */
133 struct net_bridge_vlan {
134         struct rhash_head               vnode;
135         struct rhash_head               tnode;
136         u16                             vid;
137         u16                             flags;
138         u16                             priv_flags;
139         struct br_vlan_stats __percpu   *stats;
140         union {
141                 struct net_bridge       *br;
142                 struct net_bridge_port  *port;
143         };
144         union {
145                 refcount_t              refcnt;
146                 struct net_bridge_vlan  *brvlan;
147         };
148
149         struct br_tunnel_info           tinfo;
150
151         struct list_head                vlist;
152
153         struct rcu_head                 rcu;
154 };
155
156 /**
157  * struct net_bridge_vlan_group
158  *
159  * @vlan_hash: VLAN entry rhashtable
160  * @vlan_list: sorted VLAN entry list
161  * @num_vlans: number of total VLAN entries
162  * @pvid: PVID VLAN id
163  *
164  * IMPORTANT: Be careful when checking if there're VLAN entries using list
165  *            primitives because the bridge can have entries in its list which
166  *            are just for global context but not for filtering, i.e. they have
167  *            the master flag set but not the brentry flag. If you have to check
168  *            if there're "real" entries in the bridge please test @num_vlans
169  */
170 struct net_bridge_vlan_group {
171         struct rhashtable               vlan_hash;
172         struct rhashtable               tunnel_hash;
173         struct list_head                vlan_list;
174         u16                             num_vlans;
175         u16                             pvid;
176 };
177
178 struct net_bridge_fdb_key {
179         mac_addr addr;
180         u16 vlan_id;
181 };
182
183 struct net_bridge_fdb_entry {
184         struct rhash_head               rhnode;
185         struct net_bridge_port          *dst;
186
187         struct net_bridge_fdb_key       key;
188         struct hlist_node               fdb_node;
189         unsigned char                   is_local:1,
190                                         is_static:1,
191                                         is_sticky:1,
192                                         added_by_user:1,
193                                         added_by_external_learn:1,
194                                         offloaded:1;
195
196         /* write-heavy members should not affect lookups */
197         unsigned long                   updated ____cacheline_aligned_in_smp;
198         unsigned long                   used;
199
200         struct rcu_head                 rcu;
201 };
202
203 #define MDB_PG_FLAGS_PERMANENT  BIT(0)
204 #define MDB_PG_FLAGS_OFFLOAD    BIT(1)
205
206 struct net_bridge_port_group {
207         struct net_bridge_port          *port;
208         struct net_bridge_port_group __rcu *next;
209         struct hlist_node               mglist;
210         struct rcu_head                 rcu;
211         struct timer_list               timer;
212         struct br_ip                    addr;
213         unsigned char                   flags;
214         unsigned char                   eth_addr[ETH_ALEN];
215 };
216
217 struct net_bridge_mdb_entry {
218         struct rhash_head               rhnode;
219         struct net_bridge               *br;
220         struct net_bridge_port_group __rcu *ports;
221         struct rcu_head                 rcu;
222         struct timer_list               timer;
223         struct br_ip                    addr;
224         bool                            host_joined;
225         struct hlist_node               mdb_node;
226 };
227
228 struct net_bridge_port {
229         struct net_bridge               *br;
230         struct net_device               *dev;
231         struct list_head                list;
232
233         unsigned long                   flags;
234 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
235         struct net_bridge_vlan_group    __rcu *vlgrp;
236 #endif
237         struct net_bridge_port          __rcu *backup_port;
238
239         /* STP */
240         u8                              priority;
241         u8                              state;
242         u16                             port_no;
243         unsigned char                   topology_change_ack;
244         unsigned char                   config_pending;
245         port_id                         port_id;
246         port_id                         designated_port;
247         bridge_id                       designated_root;
248         bridge_id                       designated_bridge;
249         u32                             path_cost;
250         u32                             designated_cost;
251         unsigned long                   designated_age;
252
253         struct timer_list               forward_delay_timer;
254         struct timer_list               hold_timer;
255         struct timer_list               message_age_timer;
256         struct kobject                  kobj;
257         struct rcu_head                 rcu;
258
259 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
260         struct bridge_mcast_own_query   ip4_own_query;
261 #if IS_ENABLED(CONFIG_IPV6)
262         struct bridge_mcast_own_query   ip6_own_query;
263 #endif /* IS_ENABLED(CONFIG_IPV6) */
264         unsigned char                   multicast_router;
265         struct bridge_mcast_stats       __percpu *mcast_stats;
266         struct timer_list               multicast_router_timer;
267         struct hlist_head               mglist;
268         struct hlist_node               rlist;
269 #endif
270
271 #ifdef CONFIG_SYSFS
272         char                            sysfs_name[IFNAMSIZ];
273 #endif
274
275 #ifdef CONFIG_NET_POLL_CONTROLLER
276         struct netpoll                  *np;
277 #endif
278 #ifdef CONFIG_NET_SWITCHDEV
279         int                             offload_fwd_mark;
280 #endif
281         u16                             group_fwd_mask;
282         u16                             backup_redirected_cnt;
283 };
284
285 #define kobj_to_brport(obj)     container_of(obj, struct net_bridge_port, kobj)
286
287 #define br_auto_port(p) ((p)->flags & BR_AUTO_MASK)
288 #define br_promisc_port(p) ((p)->flags & BR_PROMISC)
289
290 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
291
292 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
293 {
294         return rcu_dereference(dev->rx_handler_data);
295 }
296
297 static inline struct net_bridge_port *br_port_get_rtnl(const struct net_device *dev)
298 {
299         return br_port_exists(dev) ?
300                 rtnl_dereference(dev->rx_handler_data) : NULL;
301 }
302
303 static inline struct net_bridge_port *br_port_get_rtnl_rcu(const struct net_device *dev)
304 {
305         return br_port_exists(dev) ?
306                 rcu_dereference_rtnl(dev->rx_handler_data) : NULL;
307 }
308
309 enum net_bridge_opts {
310         BROPT_VLAN_ENABLED,
311         BROPT_VLAN_STATS_ENABLED,
312         BROPT_NF_CALL_IPTABLES,
313         BROPT_NF_CALL_IP6TABLES,
314         BROPT_NF_CALL_ARPTABLES,
315         BROPT_GROUP_ADDR_SET,
316         BROPT_MULTICAST_ENABLED,
317         BROPT_MULTICAST_QUERIER,
318         BROPT_MULTICAST_QUERY_USE_IFADDR,
319         BROPT_MULTICAST_STATS_ENABLED,
320         BROPT_HAS_IPV6_ADDR,
321         BROPT_NEIGH_SUPPRESS_ENABLED,
322         BROPT_MTU_SET_BY_USER,
323         BROPT_VLAN_STATS_PER_PORT,
324         BROPT_NO_LL_LEARN,
325 };
326
327 struct net_bridge {
328         spinlock_t                      lock;
329         spinlock_t                      hash_lock;
330         struct list_head                port_list;
331         struct net_device               *dev;
332         struct pcpu_sw_netstats         __percpu *stats;
333         unsigned long                   options;
334         /* These fields are accessed on each packet */
335 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
336         __be16                          vlan_proto;
337         u16                             default_pvid;
338         struct net_bridge_vlan_group    __rcu *vlgrp;
339 #endif
340
341         struct rhashtable               fdb_hash_tbl;
342 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
343         union {
344                 struct rtable           fake_rtable;
345                 struct rt6_info         fake_rt6_info;
346         };
347 #endif
348         u16                             group_fwd_mask;
349         u16                             group_fwd_mask_required;
350
351         /* STP */
352         bridge_id                       designated_root;
353         bridge_id                       bridge_id;
354         unsigned char                   topology_change;
355         unsigned char                   topology_change_detected;
356         u16                             root_port;
357         unsigned long                   max_age;
358         unsigned long                   hello_time;
359         unsigned long                   forward_delay;
360         unsigned long                   ageing_time;
361         unsigned long                   bridge_max_age;
362         unsigned long                   bridge_hello_time;
363         unsigned long                   bridge_forward_delay;
364         unsigned long                   bridge_ageing_time;
365         u32                             root_path_cost;
366
367         u8                              group_addr[ETH_ALEN];
368
369         enum {
370                 BR_NO_STP,              /* no spanning tree */
371                 BR_KERNEL_STP,          /* old STP in kernel */
372                 BR_USER_STP,            /* new RSTP in userspace */
373         } stp_enabled;
374
375 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
376
377         u32                             hash_max;
378
379         u32                             multicast_last_member_count;
380         u32                             multicast_startup_query_count;
381
382         u8                              multicast_igmp_version;
383         u8                              multicast_router;
384 #if IS_ENABLED(CONFIG_IPV6)
385         u8                              multicast_mld_version;
386 #endif
387         spinlock_t                      multicast_lock;
388         unsigned long                   multicast_last_member_interval;
389         unsigned long                   multicast_membership_interval;
390         unsigned long                   multicast_querier_interval;
391         unsigned long                   multicast_query_interval;
392         unsigned long                   multicast_query_response_interval;
393         unsigned long                   multicast_startup_query_interval;
394
395         struct rhashtable               mdb_hash_tbl;
396
397         struct hlist_head               mdb_list;
398         struct hlist_head               router_list;
399
400         struct timer_list               multicast_router_timer;
401         struct bridge_mcast_other_query ip4_other_query;
402         struct bridge_mcast_own_query   ip4_own_query;
403         struct bridge_mcast_querier     ip4_querier;
404         struct bridge_mcast_stats       __percpu *mcast_stats;
405 #if IS_ENABLED(CONFIG_IPV6)
406         struct bridge_mcast_other_query ip6_other_query;
407         struct bridge_mcast_own_query   ip6_own_query;
408         struct bridge_mcast_querier     ip6_querier;
409 #endif /* IS_ENABLED(CONFIG_IPV6) */
410 #endif
411
412         struct timer_list               hello_timer;
413         struct timer_list               tcn_timer;
414         struct timer_list               topology_change_timer;
415         struct delayed_work             gc_work;
416         struct kobject                  *ifobj;
417         u32                             auto_cnt;
418
419 #ifdef CONFIG_NET_SWITCHDEV
420         int offload_fwd_mark;
421 #endif
422         struct hlist_head               fdb_list;
423 };
424
425 struct br_input_skb_cb {
426         struct net_device *brdev;
427
428 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
429         int igmp;
430         int mrouters_only;
431 #endif
432
433         bool proxyarp_replied;
434         bool src_port_isolated;
435
436 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
437         bool vlan_filtered;
438 #endif
439
440 #ifdef CONFIG_NET_SWITCHDEV
441         int offload_fwd_mark;
442 #endif
443 };
444
445 #define BR_INPUT_SKB_CB(__skb)  ((struct br_input_skb_cb *)(__skb)->cb)
446
447 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
448 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)   (BR_INPUT_SKB_CB(__skb)->mrouters_only)
449 #else
450 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)   (0)
451 #endif
452
453 #define br_printk(level, br, format, args...)   \
454         printk(level "%s: " format, (br)->dev->name, ##args)
455
456 #define br_err(__br, format, args...)                   \
457         br_printk(KERN_ERR, __br, format, ##args)
458 #define br_warn(__br, format, args...)                  \
459         br_printk(KERN_WARNING, __br, format, ##args)
460 #define br_notice(__br, format, args...)                \
461         br_printk(KERN_NOTICE, __br, format, ##args)
462 #define br_info(__br, format, args...)                  \
463         br_printk(KERN_INFO, __br, format, ##args)
464
465 #define br_debug(br, format, args...)                   \
466         pr_debug("%s: " format,  (br)->dev->name, ##args)
467
468 /* called under bridge lock */
469 static inline int br_is_root_bridge(const struct net_bridge *br)
470 {
471         return !memcmp(&br->bridge_id, &br->designated_root, 8);
472 }
473
474 /* check if a VLAN entry is global */
475 static inline bool br_vlan_is_master(const struct net_bridge_vlan *v)
476 {
477         return v->flags & BRIDGE_VLAN_INFO_MASTER;
478 }
479
480 /* check if a VLAN entry is used by the bridge */
481 static inline bool br_vlan_is_brentry(const struct net_bridge_vlan *v)
482 {
483         return v->flags & BRIDGE_VLAN_INFO_BRENTRY;
484 }
485
486 /* check if we should use the vlan entry, returns false if it's only context */
487 static inline bool br_vlan_should_use(const struct net_bridge_vlan *v)
488 {
489         if (br_vlan_is_master(v)) {
490                 if (br_vlan_is_brentry(v))
491                         return true;
492                 else
493                         return false;
494         }
495
496         return true;
497 }
498
499 static inline int br_opt_get(const struct net_bridge *br,
500                              enum net_bridge_opts opt)
501 {
502         return test_bit(opt, &br->options);
503 }
504
505 int br_boolopt_toggle(struct net_bridge *br, enum br_boolopt_id opt, bool on,
506                       struct netlink_ext_ack *extack);
507 int br_boolopt_get(const struct net_bridge *br, enum br_boolopt_id opt);
508 int br_boolopt_multi_toggle(struct net_bridge *br,
509                             struct br_boolopt_multi *bm,
510                             struct netlink_ext_ack *extack);
511 void br_boolopt_multi_get(const struct net_bridge *br,
512                           struct br_boolopt_multi *bm);
513 void br_opt_toggle(struct net_bridge *br, enum net_bridge_opts opt, bool on);
514
515 /* br_device.c */
516 void br_dev_setup(struct net_device *dev);
517 void br_dev_delete(struct net_device *dev, struct list_head *list);
518 netdev_tx_t br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
519 #ifdef CONFIG_NET_POLL_CONTROLLER
520 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
521                                        struct sk_buff *skb)
522 {
523         struct netpoll *np = p->np;
524
525         if (np)
526                 netpoll_send_skb(np, skb);
527 }
528
529 int br_netpoll_enable(struct net_bridge_port *p);
530 void br_netpoll_disable(struct net_bridge_port *p);
531 #else
532 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
533                                        struct sk_buff *skb)
534 {
535 }
536
537 static inline int br_netpoll_enable(struct net_bridge_port *p)
538 {
539         return 0;
540 }
541
542 static inline void br_netpoll_disable(struct net_bridge_port *p)
543 {
544 }
545 #endif
546
547 /* br_fdb.c */
548 int br_fdb_init(void);
549 void br_fdb_fini(void);
550 int br_fdb_hash_init(struct net_bridge *br);
551 void br_fdb_hash_fini(struct net_bridge *br);
552 void br_fdb_flush(struct net_bridge *br);
553 void br_fdb_find_delete_local(struct net_bridge *br,
554                               const struct net_bridge_port *p,
555                               const unsigned char *addr, u16 vid);
556 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr);
557 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
558 void br_fdb_cleanup(struct work_struct *work);
559 void br_fdb_delete_by_port(struct net_bridge *br,
560                            const struct net_bridge_port *p, u16 vid, int do_all);
561 struct net_bridge_fdb_entry *br_fdb_find_rcu(struct net_bridge *br,
562                                              const unsigned char *addr,
563                                              __u16 vid);
564 int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
565 int br_fdb_fillbuf(struct net_bridge *br, void *buf, unsigned long count,
566                    unsigned long off);
567 int br_fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
568                   const unsigned char *addr, u16 vid);
569 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
570                    const unsigned char *addr, u16 vid, bool added_by_user);
571
572 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
573                   struct net_device *dev, const unsigned char *addr, u16 vid);
574 int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[], struct net_device *dev,
575                const unsigned char *addr, u16 vid, u16 nlh_flags);
576 int br_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
577                 struct net_device *dev, struct net_device *fdev, int *idx);
578 int br_fdb_get(struct sk_buff *skb, struct nlattr *tb[], struct net_device *dev,
579                const unsigned char *addr, u16 vid, u32 portid, u32 seq,
580                struct netlink_ext_ack *extack);
581 int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p);
582 void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p);
583 int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p,
584                               const unsigned char *addr, u16 vid,
585                               bool swdev_notify);
586 int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p,
587                               const unsigned char *addr, u16 vid,
588                               bool swdev_notify);
589 void br_fdb_offloaded_set(struct net_bridge *br, struct net_bridge_port *p,
590                           const unsigned char *addr, u16 vid, bool offloaded);
591
592 /* br_forward.c */
593 enum br_pkt_type {
594         BR_PKT_UNICAST,
595         BR_PKT_MULTICAST,
596         BR_PKT_BROADCAST
597 };
598 int br_dev_queue_push_xmit(struct net *net, struct sock *sk, struct sk_buff *skb);
599 void br_forward(const struct net_bridge_port *to, struct sk_buff *skb,
600                 bool local_rcv, bool local_orig);
601 int br_forward_finish(struct net *net, struct sock *sk, struct sk_buff *skb);
602 void br_flood(struct net_bridge *br, struct sk_buff *skb,
603               enum br_pkt_type pkt_type, bool local_rcv, bool local_orig);
604
605 /* return true if both source port and dest port are isolated */
606 static inline bool br_skb_isolated(const struct net_bridge_port *to,
607                                    const struct sk_buff *skb)
608 {
609         return BR_INPUT_SKB_CB(skb)->src_port_isolated &&
610                (to->flags & BR_ISOLATED);
611 }
612
613 /* br_if.c */
614 void br_port_carrier_check(struct net_bridge_port *p, bool *notified);
615 int br_add_bridge(struct net *net, const char *name);
616 int br_del_bridge(struct net *net, const char *name);
617 int br_add_if(struct net_bridge *br, struct net_device *dev,
618               struct netlink_ext_ack *extack);
619 int br_del_if(struct net_bridge *br, struct net_device *dev);
620 void br_mtu_auto_adjust(struct net_bridge *br);
621 netdev_features_t br_features_recompute(struct net_bridge *br,
622                                         netdev_features_t features);
623 void br_port_flags_change(struct net_bridge_port *port, unsigned long mask);
624 void br_manage_promisc(struct net_bridge *br);
625 int nbp_backup_change(struct net_bridge_port *p, struct net_device *backup_dev);
626
627 /* br_input.c */
628 int br_handle_frame_finish(struct net *net, struct sock *sk, struct sk_buff *skb);
629 rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
630
631 static inline bool br_rx_handler_check_rcu(const struct net_device *dev)
632 {
633         return rcu_dereference(dev->rx_handler) == br_handle_frame;
634 }
635
636 static inline bool br_rx_handler_check_rtnl(const struct net_device *dev)
637 {
638         return rcu_dereference_rtnl(dev->rx_handler) == br_handle_frame;
639 }
640
641 static inline struct net_bridge_port *br_port_get_check_rcu(const struct net_device *dev)
642 {
643         return br_rx_handler_check_rcu(dev) ? br_port_get_rcu(dev) : NULL;
644 }
645
646 static inline struct net_bridge_port *
647 br_port_get_check_rtnl(const struct net_device *dev)
648 {
649         return br_rx_handler_check_rtnl(dev) ? br_port_get_rtnl_rcu(dev) : NULL;
650 }
651
652 /* br_ioctl.c */
653 int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
654 int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd,
655                              void __user *arg);
656
657 /* br_multicast.c */
658 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
659 int br_multicast_rcv(struct net_bridge *br, struct net_bridge_port *port,
660                      struct sk_buff *skb, u16 vid);
661 struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
662                                         struct sk_buff *skb, u16 vid);
663 int br_multicast_add_port(struct net_bridge_port *port);
664 void br_multicast_del_port(struct net_bridge_port *port);
665 void br_multicast_enable_port(struct net_bridge_port *port);
666 void br_multicast_disable_port(struct net_bridge_port *port);
667 void br_multicast_init(struct net_bridge *br);
668 void br_multicast_open(struct net_bridge *br);
669 void br_multicast_stop(struct net_bridge *br);
670 void br_multicast_dev_del(struct net_bridge *br);
671 void br_multicast_flood(struct net_bridge_mdb_entry *mdst,
672                         struct sk_buff *skb, bool local_rcv, bool local_orig);
673 int br_multicast_set_router(struct net_bridge *br, unsigned long val);
674 int br_multicast_set_port_router(struct net_bridge_port *p, unsigned long val);
675 int br_multicast_toggle(struct net_bridge *br, unsigned long val);
676 int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
677 int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
678 int br_multicast_set_igmp_version(struct net_bridge *br, unsigned long val);
679 #if IS_ENABLED(CONFIG_IPV6)
680 int br_multicast_set_mld_version(struct net_bridge *br, unsigned long val);
681 #endif
682 struct net_bridge_mdb_entry *
683 br_mdb_ip_get(struct net_bridge *br, struct br_ip *dst);
684 struct net_bridge_mdb_entry *
685 br_multicast_new_group(struct net_bridge *br, struct br_ip *group);
686 struct net_bridge_port_group *
687 br_multicast_new_port_group(struct net_bridge_port *port, struct br_ip *group,
688                             struct net_bridge_port_group __rcu *next,
689                             unsigned char flags, const unsigned char *src);
690 int br_mdb_hash_init(struct net_bridge *br);
691 void br_mdb_hash_fini(struct net_bridge *br);
692 void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
693                    struct br_ip *group, int type, u8 flags);
694 void br_rtr_notify(struct net_device *dev, struct net_bridge_port *port,
695                    int type);
696 void br_multicast_count(struct net_bridge *br, const struct net_bridge_port *p,
697                         const struct sk_buff *skb, u8 type, u8 dir);
698 int br_multicast_init_stats(struct net_bridge *br);
699 void br_multicast_uninit_stats(struct net_bridge *br);
700 void br_multicast_get_stats(const struct net_bridge *br,
701                             const struct net_bridge_port *p,
702                             struct br_mcast_stats *dest);
703 void br_mdb_init(void);
704 void br_mdb_uninit(void);
705
706 #define mlock_dereference(X, br) \
707         rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
708
709 static inline bool br_multicast_is_router(struct net_bridge *br)
710 {
711         return br->multicast_router == 2 ||
712                (br->multicast_router == 1 &&
713                 timer_pending(&br->multicast_router_timer));
714 }
715
716 static inline bool
717 __br_multicast_querier_exists(struct net_bridge *br,
718                                 struct bridge_mcast_other_query *querier,
719                                 const bool is_ipv6)
720 {
721         bool own_querier_enabled;
722
723         if (br_opt_get(br, BROPT_MULTICAST_QUERIER)) {
724                 if (is_ipv6 && !br_opt_get(br, BROPT_HAS_IPV6_ADDR))
725                         own_querier_enabled = false;
726                 else
727                         own_querier_enabled = true;
728         } else {
729                 own_querier_enabled = false;
730         }
731
732         return time_is_before_jiffies(querier->delay_time) &&
733                (own_querier_enabled || timer_pending(&querier->timer));
734 }
735
736 static inline bool br_multicast_querier_exists(struct net_bridge *br,
737                                                struct ethhdr *eth)
738 {
739         switch (eth->h_proto) {
740         case (htons(ETH_P_IP)):
741                 return __br_multicast_querier_exists(br,
742                         &br->ip4_other_query, false);
743 #if IS_ENABLED(CONFIG_IPV6)
744         case (htons(ETH_P_IPV6)):
745                 return __br_multicast_querier_exists(br,
746                         &br->ip6_other_query, true);
747 #endif
748         default:
749                 return false;
750         }
751 }
752
753 static inline int br_multicast_igmp_type(const struct sk_buff *skb)
754 {
755         return BR_INPUT_SKB_CB(skb)->igmp;
756 }
757 #else
758 static inline int br_multicast_rcv(struct net_bridge *br,
759                                    struct net_bridge_port *port,
760                                    struct sk_buff *skb,
761                                    u16 vid)
762 {
763         return 0;
764 }
765
766 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
767                                                       struct sk_buff *skb, u16 vid)
768 {
769         return NULL;
770 }
771
772 static inline int br_multicast_add_port(struct net_bridge_port *port)
773 {
774         return 0;
775 }
776
777 static inline void br_multicast_del_port(struct net_bridge_port *port)
778 {
779 }
780
781 static inline void br_multicast_enable_port(struct net_bridge_port *port)
782 {
783 }
784
785 static inline void br_multicast_disable_port(struct net_bridge_port *port)
786 {
787 }
788
789 static inline void br_multicast_init(struct net_bridge *br)
790 {
791 }
792
793 static inline void br_multicast_open(struct net_bridge *br)
794 {
795 }
796
797 static inline void br_multicast_stop(struct net_bridge *br)
798 {
799 }
800
801 static inline void br_multicast_dev_del(struct net_bridge *br)
802 {
803 }
804
805 static inline void br_multicast_flood(struct net_bridge_mdb_entry *mdst,
806                                       struct sk_buff *skb,
807                                       bool local_rcv, bool local_orig)
808 {
809 }
810
811 static inline bool br_multicast_is_router(struct net_bridge *br)
812 {
813         return false;
814 }
815
816 static inline bool br_multicast_querier_exists(struct net_bridge *br,
817                                                struct ethhdr *eth)
818 {
819         return false;
820 }
821
822 static inline void br_mdb_init(void)
823 {
824 }
825
826 static inline void br_mdb_uninit(void)
827 {
828 }
829
830 static inline int br_mdb_hash_init(struct net_bridge *br)
831 {
832         return 0;
833 }
834
835 static inline void br_mdb_hash_fini(struct net_bridge *br)
836 {
837 }
838
839 static inline void br_multicast_count(struct net_bridge *br,
840                                       const struct net_bridge_port *p,
841                                       const struct sk_buff *skb,
842                                       u8 type, u8 dir)
843 {
844 }
845
846 static inline int br_multicast_init_stats(struct net_bridge *br)
847 {
848         return 0;
849 }
850
851 static inline void br_multicast_uninit_stats(struct net_bridge *br)
852 {
853 }
854
855 static inline int br_multicast_igmp_type(const struct sk_buff *skb)
856 {
857         return 0;
858 }
859 #endif
860
861 /* br_vlan.c */
862 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
863 bool br_allowed_ingress(const struct net_bridge *br,
864                         struct net_bridge_vlan_group *vg, struct sk_buff *skb,
865                         u16 *vid);
866 bool br_allowed_egress(struct net_bridge_vlan_group *vg,
867                        const struct sk_buff *skb);
868 bool br_should_learn(struct net_bridge_port *p, struct sk_buff *skb, u16 *vid);
869 struct sk_buff *br_handle_vlan(struct net_bridge *br,
870                                const struct net_bridge_port *port,
871                                struct net_bridge_vlan_group *vg,
872                                struct sk_buff *skb);
873 int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags,
874                 bool *changed, struct netlink_ext_ack *extack);
875 int br_vlan_delete(struct net_bridge *br, u16 vid);
876 void br_vlan_flush(struct net_bridge *br);
877 struct net_bridge_vlan *br_vlan_find(struct net_bridge_vlan_group *vg, u16 vid);
878 void br_recalculate_fwd_mask(struct net_bridge *br);
879 int __br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
880 int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
881 int __br_vlan_set_proto(struct net_bridge *br, __be16 proto);
882 int br_vlan_set_proto(struct net_bridge *br, unsigned long val);
883 int br_vlan_set_stats(struct net_bridge *br, unsigned long val);
884 int br_vlan_set_stats_per_port(struct net_bridge *br, unsigned long val);
885 int br_vlan_init(struct net_bridge *br);
886 int br_vlan_set_default_pvid(struct net_bridge *br, unsigned long val);
887 int __br_vlan_set_default_pvid(struct net_bridge *br, u16 pvid,
888                                struct netlink_ext_ack *extack);
889 int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags,
890                  bool *changed, struct netlink_ext_ack *extack);
891 int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
892 void nbp_vlan_flush(struct net_bridge_port *port);
893 int nbp_vlan_init(struct net_bridge_port *port, struct netlink_ext_ack *extack);
894 int nbp_get_num_vlan_infos(struct net_bridge_port *p, u32 filter_mask);
895 void br_vlan_get_stats(const struct net_bridge_vlan *v,
896                        struct br_vlan_stats *stats);
897
898 static inline struct net_bridge_vlan_group *br_vlan_group(
899                                         const struct net_bridge *br)
900 {
901         return rtnl_dereference(br->vlgrp);
902 }
903
904 static inline struct net_bridge_vlan_group *nbp_vlan_group(
905                                         const struct net_bridge_port *p)
906 {
907         return rtnl_dereference(p->vlgrp);
908 }
909
910 static inline struct net_bridge_vlan_group *br_vlan_group_rcu(
911                                         const struct net_bridge *br)
912 {
913         return rcu_dereference(br->vlgrp);
914 }
915
916 static inline struct net_bridge_vlan_group *nbp_vlan_group_rcu(
917                                         const struct net_bridge_port *p)
918 {
919         return rcu_dereference(p->vlgrp);
920 }
921
922 /* Since bridge now depends on 8021Q module, but the time bridge sees the
923  * skb, the vlan tag will always be present if the frame was tagged.
924  */
925 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
926 {
927         int err = 0;
928
929         if (skb_vlan_tag_present(skb)) {
930                 *vid = skb_vlan_tag_get_id(skb);
931         } else {
932                 *vid = 0;
933                 err = -EINVAL;
934         }
935
936         return err;
937 }
938
939 static inline u16 br_get_pvid(const struct net_bridge_vlan_group *vg)
940 {
941         if (!vg)
942                 return 0;
943
944         smp_rmb();
945         return vg->pvid;
946 }
947
948 #else
949 static inline bool br_allowed_ingress(const struct net_bridge *br,
950                                       struct net_bridge_vlan_group *vg,
951                                       struct sk_buff *skb,
952                                       u16 *vid)
953 {
954         return true;
955 }
956
957 static inline bool br_allowed_egress(struct net_bridge_vlan_group *vg,
958                                      const struct sk_buff *skb)
959 {
960         return true;
961 }
962
963 static inline bool br_should_learn(struct net_bridge_port *p,
964                                    struct sk_buff *skb, u16 *vid)
965 {
966         return true;
967 }
968
969 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
970                                              const struct net_bridge_port *port,
971                                              struct net_bridge_vlan_group *vg,
972                                              struct sk_buff *skb)
973 {
974         return skb;
975 }
976
977 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags,
978                               bool *changed, struct netlink_ext_ack *extack)
979 {
980         *changed = false;
981         return -EOPNOTSUPP;
982 }
983
984 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
985 {
986         return -EOPNOTSUPP;
987 }
988
989 static inline void br_vlan_flush(struct net_bridge *br)
990 {
991 }
992
993 static inline void br_recalculate_fwd_mask(struct net_bridge *br)
994 {
995 }
996
997 static inline int br_vlan_init(struct net_bridge *br)
998 {
999         return 0;
1000 }
1001
1002 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags,
1003                                bool *changed, struct netlink_ext_ack *extack)
1004 {
1005         *changed = false;
1006         return -EOPNOTSUPP;
1007 }
1008
1009 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
1010 {
1011         return -EOPNOTSUPP;
1012 }
1013
1014 static inline void nbp_vlan_flush(struct net_bridge_port *port)
1015 {
1016 }
1017
1018 static inline struct net_bridge_vlan *br_vlan_find(struct net_bridge_vlan_group *vg,
1019                                                    u16 vid)
1020 {
1021         return NULL;
1022 }
1023
1024 static inline int nbp_vlan_init(struct net_bridge_port *port,
1025                                 struct netlink_ext_ack *extack)
1026 {
1027         return 0;
1028 }
1029
1030 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
1031 {
1032         return 0;
1033 }
1034
1035 static inline u16 br_get_pvid(const struct net_bridge_vlan_group *vg)
1036 {
1037         return 0;
1038 }
1039
1040 static inline int __br_vlan_filter_toggle(struct net_bridge *br,
1041                                           unsigned long val)
1042 {
1043         return -EOPNOTSUPP;
1044 }
1045
1046 static inline int nbp_get_num_vlan_infos(struct net_bridge_port *p,
1047                                          u32 filter_mask)
1048 {
1049         return 0;
1050 }
1051
1052 static inline struct net_bridge_vlan_group *br_vlan_group(
1053                                         const struct net_bridge *br)
1054 {
1055         return NULL;
1056 }
1057
1058 static inline struct net_bridge_vlan_group *nbp_vlan_group(
1059                                         const struct net_bridge_port *p)
1060 {
1061         return NULL;
1062 }
1063
1064 static inline struct net_bridge_vlan_group *br_vlan_group_rcu(
1065                                         const struct net_bridge *br)
1066 {
1067         return NULL;
1068 }
1069
1070 static inline struct net_bridge_vlan_group *nbp_vlan_group_rcu(
1071                                         const struct net_bridge_port *p)
1072 {
1073         return NULL;
1074 }
1075
1076 static inline void br_vlan_get_stats(const struct net_bridge_vlan *v,
1077                                      struct br_vlan_stats *stats)
1078 {
1079 }
1080 #endif
1081
1082 struct nf_br_ops {
1083         int (*br_dev_xmit_hook)(struct sk_buff *skb);
1084 };
1085 extern const struct nf_br_ops __rcu *nf_br_ops;
1086
1087 /* br_netfilter.c */
1088 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
1089 int br_nf_core_init(void);
1090 void br_nf_core_fini(void);
1091 void br_netfilter_rtable_init(struct net_bridge *);
1092 #else
1093 static inline int br_nf_core_init(void) { return 0; }
1094 static inline void br_nf_core_fini(void) {}
1095 #define br_netfilter_rtable_init(x)
1096 #endif
1097
1098 /* br_stp.c */
1099 void br_set_state(struct net_bridge_port *p, unsigned int state);
1100 struct net_bridge_port *br_get_port(struct net_bridge *br, u16 port_no);
1101 void br_init_port(struct net_bridge_port *p);
1102 void br_become_designated_port(struct net_bridge_port *p);
1103
1104 void __br_set_forward_delay(struct net_bridge *br, unsigned long t);
1105 int br_set_forward_delay(struct net_bridge *br, unsigned long x);
1106 int br_set_hello_time(struct net_bridge *br, unsigned long x);
1107 int br_set_max_age(struct net_bridge *br, unsigned long x);
1108 int __set_ageing_time(struct net_device *dev, unsigned long t);
1109 int br_set_ageing_time(struct net_bridge *br, clock_t ageing_time);
1110
1111
1112 /* br_stp_if.c */
1113 void br_stp_enable_bridge(struct net_bridge *br);
1114 void br_stp_disable_bridge(struct net_bridge *br);
1115 void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
1116 void br_stp_enable_port(struct net_bridge_port *p);
1117 void br_stp_disable_port(struct net_bridge_port *p);
1118 bool br_stp_recalculate_bridge_id(struct net_bridge *br);
1119 void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
1120 void br_stp_set_bridge_priority(struct net_bridge *br, u16 newprio);
1121 int br_stp_set_port_priority(struct net_bridge_port *p, unsigned long newprio);
1122 int br_stp_set_path_cost(struct net_bridge_port *p, unsigned long path_cost);
1123 ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
1124
1125 /* br_stp_bpdu.c */
1126 struct stp_proto;
1127 void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
1128                 struct net_device *dev);
1129
1130 /* br_stp_timer.c */
1131 void br_stp_timer_init(struct net_bridge *br);
1132 void br_stp_port_timer_init(struct net_bridge_port *p);
1133 unsigned long br_timer_value(const struct timer_list *timer);
1134
1135 /* br.c */
1136 #if IS_ENABLED(CONFIG_ATM_LANE)
1137 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
1138 #endif
1139
1140 /* br_netlink.c */
1141 extern struct rtnl_link_ops br_link_ops;
1142 int br_netlink_init(void);
1143 void br_netlink_fini(void);
1144 void br_ifinfo_notify(int event, const struct net_bridge *br,
1145                       const struct net_bridge_port *port);
1146 int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg, u16 flags,
1147                struct netlink_ext_ack *extack);
1148 int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg, u16 flags);
1149 int br_getlink(struct sk_buff *skb, u32 pid, u32 seq, struct net_device *dev,
1150                u32 filter_mask, int nlflags);
1151
1152 #ifdef CONFIG_SYSFS
1153 /* br_sysfs_if.c */
1154 extern const struct sysfs_ops brport_sysfs_ops;
1155 int br_sysfs_addif(struct net_bridge_port *p);
1156 int br_sysfs_renameif(struct net_bridge_port *p);
1157
1158 /* br_sysfs_br.c */
1159 int br_sysfs_addbr(struct net_device *dev);
1160 void br_sysfs_delbr(struct net_device *dev);
1161
1162 #else
1163
1164 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
1165 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
1166 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
1167 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
1168 #endif /* CONFIG_SYSFS */
1169
1170 /* br_switchdev.c */
1171 #ifdef CONFIG_NET_SWITCHDEV
1172 int nbp_switchdev_mark_set(struct net_bridge_port *p);
1173 void nbp_switchdev_frame_mark(const struct net_bridge_port *p,
1174                               struct sk_buff *skb);
1175 bool nbp_switchdev_allowed_egress(const struct net_bridge_port *p,
1176                                   const struct sk_buff *skb);
1177 int br_switchdev_set_port_flag(struct net_bridge_port *p,
1178                                unsigned long flags,
1179                                unsigned long mask);
1180 void br_switchdev_fdb_notify(const struct net_bridge_fdb_entry *fdb,
1181                              int type);
1182 int br_switchdev_port_vlan_add(struct net_device *dev, u16 vid, u16 flags,
1183                                struct netlink_ext_ack *extack);
1184 int br_switchdev_port_vlan_del(struct net_device *dev, u16 vid);
1185
1186 static inline void br_switchdev_frame_unmark(struct sk_buff *skb)
1187 {
1188         skb->offload_fwd_mark = 0;
1189 }
1190 #else
1191 static inline int nbp_switchdev_mark_set(struct net_bridge_port *p)
1192 {
1193         return 0;
1194 }
1195
1196 static inline void nbp_switchdev_frame_mark(const struct net_bridge_port *p,
1197                                             struct sk_buff *skb)
1198 {
1199 }
1200
1201 static inline bool nbp_switchdev_allowed_egress(const struct net_bridge_port *p,
1202                                                 const struct sk_buff *skb)
1203 {
1204         return true;
1205 }
1206
1207 static inline int br_switchdev_set_port_flag(struct net_bridge_port *p,
1208                                              unsigned long flags,
1209                                              unsigned long mask)
1210 {
1211         return 0;
1212 }
1213
1214 static inline int br_switchdev_port_vlan_add(struct net_device *dev,
1215                                              u16 vid, u16 flags,
1216                                              struct netlink_ext_ack *extack)
1217 {
1218         return -EOPNOTSUPP;
1219 }
1220
1221 static inline int br_switchdev_port_vlan_del(struct net_device *dev, u16 vid)
1222 {
1223         return -EOPNOTSUPP;
1224 }
1225
1226 static inline void
1227 br_switchdev_fdb_notify(const struct net_bridge_fdb_entry *fdb, int type)
1228 {
1229 }
1230
1231 static inline void br_switchdev_frame_unmark(struct sk_buff *skb)
1232 {
1233 }
1234 #endif /* CONFIG_NET_SWITCHDEV */
1235
1236 /* br_arp_nd_proxy.c */
1237 void br_recalculate_neigh_suppress_enabled(struct net_bridge *br);
1238 void br_do_proxy_suppress_arp(struct sk_buff *skb, struct net_bridge *br,
1239                               u16 vid, struct net_bridge_port *p);
1240 void br_do_suppress_nd(struct sk_buff *skb, struct net_bridge *br,
1241                        u16 vid, struct net_bridge_port *p, struct nd_msg *msg);
1242 struct nd_msg *br_is_nd_neigh_msg(struct sk_buff *skb, struct nd_msg *m);
1243 #endif