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