cregit-Linux how code gets into the kernel

Release 4.14 net/bridge/br_private.h

Directory: net/bridge
 *      Linux ethernet bridge
 *      Authors:
 *      Lennert Buytenhek               <>
 *      This program is free software; you can redistribute it and/or
 *      modify it under the terms of the GNU General Public License
 *      as published by the Free Software Foundation; either version
 *      2 of the License, or (at your option) any later version.

#ifndef _BR_PRIVATE_H

#define _BR_PRIVATE_H

#include <linux/netdevice.h>
#include <linux/if_bridge.h>
#include <linux/netpoll.h>
#include <linux/u64_stats_sync.h>
#include <net/route.h>
#include <net/ip6_fib.h>
#include <linux/if_vlan.h>
#include <linux/rhashtable.h>
#include <linux/refcount.h>

#define BR_HASH_BITS 8

#define BR_HASH_SIZE (1 << BR_HASH_BITS)

#define BR_HOLD_TIME (1*HZ)

#define BR_PORT_BITS	10


#define BR_VERSION	"2.3"

/* Control of forwarding link local multicast */

/* Don't allow forwarding of control protocols like STP, MAC PAUSE and LACP */

/* The Nearest Customer Bridge Group Address, 01-80-C2-00-00-[00,0B,0C,0D,0F] */

#define BR_GROUPFWD_8021AD	0xB801u

/* Path to usermode spanning tree program */

#define BR_STP_PROG	"/sbin/bridge-stp"

typedef struct bridge_id bridge_id;

typedef struct mac_addr mac_addr;

typedef __u16 port_id;

struct bridge_id
unsigned char	prio[2];
unsigned char	addr[ETH_ALEN];

struct mac_addr
unsigned char	addr[ETH_ALEN];

/* our own querier */

struct bridge_mcast_own_query {
struct timer_list	timer;
u32			startup_sent;

/* other querier */

struct bridge_mcast_other_query {
struct timer_list		timer;
unsigned long			delay_time;

/* selected querier */

struct bridge_mcast_querier {
struct br_ip addr;
struct net_bridge_port __rcu	*port;

/* IGMP/MLD statistics */

struct bridge_mcast_stats {
struct br_mcast_stats mstats;
struct u64_stats_sync syncp;

struct br_vlan_stats {
u64 rx_bytes;
u64 rx_packets;
u64 tx_bytes;
u64 tx_packets;
struct u64_stats_sync syncp;

struct br_tunnel_info {
__be64			tunnel_id;
struct metadata_dst	*tunnel_dst;

 * struct net_bridge_vlan - per-vlan entry
 * @vnode: rhashtable member
 * @vid: VLAN id
 * @flags: bridge vlan flags
 * @stats: per-cpu VLAN statistics
 * @br: if MASTER flag set, this points to a bridge struct
 * @port: if MASTER flag unset, this points to a port struct
 * @refcnt: if MASTER flag set, this is bumped for each port referencing it
 * @brvlan: if MASTER flag unset, this points to the global per-VLAN context
 *          for this VLAN entry
 * @vlist: sorted list of VLAN entries
 * @rcu: used for entry destruction
 * This structure is shared between the global per-VLAN entries contained in
 * the bridge rhashtable and the local per-port per-VLAN entries contained in
 * the port's rhashtable. The union entries should be interpreted depending on
 * the entry flags that are set.

struct net_bridge_vlan {
struct rhash_head		vnode;
struct rhash_head		tnode;
u16				vid;
u16				flags;
struct br_vlan_stats __percpu	*stats;
	union {
struct net_bridge	*br;
struct net_bridge_port	*port;
	union {
refcount_t		refcnt;
struct net_bridge_vlan	*brvlan;

struct br_tunnel_info		tinfo;

struct list_head		vlist;

struct rcu_head			rcu;

 * struct net_bridge_vlan_group
 * @vlan_hash: VLAN entry rhashtable
 * @vlan_list: sorted VLAN entry list
 * @num_vlans: number of total VLAN entries
 * @pvid: PVID VLAN id
 * IMPORTANT: Be careful when checking if there're VLAN entries using list
 *            primitives because the bridge can have entries in its list which
 *            are just for global context but not for filtering, i.e. they have
 *            the master flag set but not the brentry flag. If you have to check
 *            if there're "real" entries in the bridge please test @num_vlans

struct net_bridge_vlan_group {
struct rhashtable		vlan_hash;
struct rhashtable		tunnel_hash;
struct list_head		vlan_list;
u16				num_vlans;
u16				pvid;

struct net_bridge_fdb_entry {
struct hlist_node		hlist;
struct net_bridge_port		*dst;

mac_addr			addr;
__u16				vlan_id;
unsigned char			is_local:1,

	/* write-heavy members should not affect lookups */
unsigned long			updated ____cacheline_aligned_in_smp;
unsigned long			used;

struct rcu_head			rcu;



struct net_bridge_port_group {
struct net_bridge_port		*port;
struct net_bridge_port_group __rcu *next;
struct hlist_node		mglist;
struct rcu_head			rcu;
struct timer_list		timer;
struct br_ip			addr;
unsigned char			flags;
unsigned char			eth_addr[ETH_ALEN];

struct net_bridge_mdb_entry
struct hlist_node		hlist[2];
struct net_bridge		*br;
struct net_bridge_port_group __rcu *ports;
struct rcu_head			rcu;
struct timer_list		timer;
struct br_ip			addr;
bool				mglist;

struct net_bridge_mdb_htable
struct hlist_head		*mhash;
struct rcu_head			rcu;
struct net_bridge_mdb_htable	*old;
u32				size;
u32				max;
u32				secret;
u32				ver;

struct net_bridge_port {
struct net_bridge		*br;
struct net_device		*dev;
struct list_head		list;

unsigned long			flags;
struct net_bridge_vlan_group	__rcu *vlgrp;

	/* STP */
u8				priority;
u8				state;
u16				port_no;
unsigned char			topology_change_ack;
unsigned char			config_pending;
port_id				port_id;
port_id				designated_port;
bridge_id			designated_root;
bridge_id			designated_bridge;
u32				path_cost;
u32				designated_cost;
unsigned long			designated_age;

struct timer_list		forward_delay_timer;
struct timer_list		hold_timer;
struct timer_list		message_age_timer;
struct kobject			kobj;
struct rcu_head			rcu;

struct bridge_mcast_own_query	ip4_own_query;
struct bridge_mcast_own_query	ip6_own_query;
#endif /* IS_ENABLED(CONFIG_IPV6) */
unsigned char			multicast_router;
struct bridge_mcast_stats	__percpu *mcast_stats;
struct timer_list		multicast_router_timer;
struct hlist_head		mglist;
struct hlist_node		rlist;

char				sysfs_name[IFNAMSIZ];

struct netpoll			*np;
int				offload_fwd_mark;

#define br_auto_port(p) ((p)->flags & BR_AUTO_MASK)

#define br_promisc_port(p) ((p)->flags & BR_PROMISC)

#define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)

static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev) { return rcu_dereference(dev->rx_handler_data); }


Stephen Hemminger1878.26%133.33%
Jiri Pirko313.04%133.33%
Hong Zhi Guo28.70%133.33%

static inline struct net_bridge_port *br_port_get_rtnl(const struct net_device *dev) { return br_port_exists(dev) ? rtnl_dereference(dev->rx_handler_data) : NULL; }


Stephen Hemminger2273.33%125.00%
Eric Dumazet413.33%125.00%
Jiri Pirko310.00%125.00%
Hong Zhi Guo13.33%125.00%

static inline struct net_bridge_port *br_port_get_rtnl_rcu(const struct net_device *dev) { return br_port_exists(dev) ? rcu_dereference_rtnl(dev->rx_handler_data) : NULL; }


Arkadi Sharshevsky30100.00%1100.00%

struct net_bridge { spinlock_t lock; spinlock_t hash_lock; struct list_head port_list; struct net_device *dev; struct pcpu_sw_netstats __percpu *stats; /* These fields are accessed on each packet */ #ifdef CONFIG_BRIDGE_VLAN_FILTERING u8 vlan_enabled; u8 vlan_stats_enabled; __be16 vlan_proto; u16 default_pvid; struct net_bridge_vlan_group __rcu *vlgrp; #endif struct hlist_head hash[BR_HASH_SIZE]; #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER) union { struct rtable fake_rtable; struct rt6_info fake_rt6_info; }; bool nf_call_iptables; bool nf_call_ip6tables; bool nf_call_arptables; #endif u16 group_fwd_mask; u16 group_fwd_mask_required; /* STP */ bridge_id designated_root; bridge_id bridge_id; u32 root_path_cost; unsigned char topology_change; unsigned char topology_change_detected; u16 root_port; unsigned long max_age; unsigned long hello_time; unsigned long forward_delay; unsigned long ageing_time; unsigned long bridge_max_age; unsigned long bridge_hello_time; unsigned long bridge_forward_delay; unsigned long bridge_ageing_time; u8 group_addr[ETH_ALEN]; bool group_addr_set; enum { BR_NO_STP, /* no spanning tree */ BR_KERNEL_STP, /* old STP in kernel */ BR_USER_STP, /* new RSTP in userspace */ } stp_enabled; #ifdef CONFIG_BRIDGE_IGMP_SNOOPING unsigned char multicast_router; u8 multicast_disabled:1; u8 multicast_querier:1; u8 multicast_query_use_ifaddr:1; u8 has_ipv6_addr:1; u8 multicast_stats_enabled:1; u32 hash_elasticity; u32 hash_max; u32 multicast_last_member_count; u32 multicast_startup_query_count; u8 multicast_igmp_version; unsigned long multicast_last_member_interval; unsigned long multicast_membership_interval; unsigned long multicast_querier_interval; unsigned long multicast_query_interval; unsigned long multicast_query_response_interval; unsigned long multicast_startup_query_interval; spinlock_t multicast_lock; struct net_bridge_mdb_htable __rcu *mdb; struct hlist_head router_list; struct timer_list multicast_router_timer; struct bridge_mcast_other_query ip4_other_query; struct bridge_mcast_own_query ip4_own_query; struct bridge_mcast_querier ip4_querier; struct bridge_mcast_stats __percpu *mcast_stats; #if IS_ENABLED(CONFIG_IPV6) struct bridge_mcast_other_query ip6_other_query; struct bridge_mcast_own_query ip6_own_query; struct bridge_mcast_querier ip6_querier; u8 multicast_mld_version; #endif /* IS_ENABLED(CONFIG_IPV6) */ #endif struct timer_list hello_timer; struct timer_list tcn_timer; struct timer_list topology_change_timer; struct delayed_work gc_work; struct kobject *ifobj; u32 auto_cnt; #ifdef CONFIG_NET_SWITCHDEV int offload_fwd_mark; #endif }; struct br_input_skb_cb { struct net_device *brdev; #ifdef CONFIG_BRIDGE_IGMP_SNOOPING int igmp; int mrouters_only; #endif bool proxyarp_replied; #ifdef CONFIG_BRIDGE_VLAN_FILTERING bool vlan_filtered; #endif #ifdef CONFIG_NET_SWITCHDEV int offload_fwd_mark; #endif }; #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb) #ifdef CONFIG_BRIDGE_IGMP_SNOOPING # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only) #else # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0) #endif #define br_printk(level, br, format, args...) \ printk(level "%s: " format, (br)->dev->name, ##args) #define br_err(__br, format, args...) \ br_printk(KERN_ERR, __br, format, ##args) #define br_warn(__br, format, args...) \ br_printk(KERN_WARNING, __br, format, ##args) #define br_notice(__br, format, args...) \ br_printk(KERN_NOTICE, __br, format, ##args) #define br_info(__br, format, args...) \ br_printk(KERN_INFO, __br, format, ##args) #define br_debug(br, format, args...) \ pr_debug("%s: " format, (br)->dev->name, ##args) /* called under bridge lock */
static inline int br_is_root_bridge(const struct net_bridge *br) { return !memcmp(&br->bridge_id, &br->designated_root, 8); }


Stephen Hemminger30100.00%1100.00%

/* check if a VLAN entry is global */
static inline bool br_vlan_is_master(const struct net_bridge_vlan *v) { return v->flags & BRIDGE_VLAN_INFO_MASTER; }


Nikolay Aleksandrov20100.00%1100.00%

/* check if a VLAN entry is used by the bridge */
static inline bool br_vlan_is_brentry(const struct net_bridge_vlan *v) { return v->flags & BRIDGE_VLAN_INFO_BRENTRY; }


Nikolay Aleksandrov20100.00%1100.00%

/* check if we should use the vlan entry, returns false if it's only context */
static inline bool br_vlan_should_use(const struct net_bridge_vlan *v) { if (br_vlan_is_master(v)) { if (br_vlan_is_brentry(v)) return true; else return false; } return true; }


Nikolay Aleksandrov39100.00%1100.00%

/* br_device.c */ void br_dev_setup(struct net_device *dev); void br_dev_delete(struct net_device *dev, struct list_head *list); netdev_tx_t br_dev_xmit(struct sk_buff *skb, struct net_device *dev); #ifdef CONFIG_NET_POLL_CONTROLLER
static inline void br_netpoll_send_skb(const struct net_bridge_port *p, struct sk_buff *skb) { struct netpoll *np = p->np; if (np) netpoll_send_skb(np, skb); }


Herbert Xu3181.58%133.33%
Stephen Hemminger410.53%133.33%
Américo Wang37.89%133.33%

int br_netpoll_enable(struct net_bridge_port *p); void br_netpoll_disable(struct net_bridge_port *p); #else
static inline void br_netpoll_send_skb(const struct net_bridge_port *p, struct sk_buff *skb) { }


Herbert Xu1482.35%266.67%
Stephen Hemminger317.65%133.33%

static inline int br_netpoll_enable(struct net_bridge_port *p) { return 0; }


Herbert Xu15100.00%1100.00%

static inline void br_netpoll_disable(struct net_bridge_port *p) { }


Herbert Xu872.73%150.00%
Stephen Hemminger327.27%150.00%

#endif /* br_fdb.c */ int br_fdb_init(void); void br_fdb_fini(void); void br_fdb_flush(struct net_bridge *br); void br_fdb_find_delete_local(struct net_bridge *br, const struct net_bridge_port *p, const unsigned char *addr, u16 vid); void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr); void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr); void br_fdb_cleanup(struct work_struct *work); void br_fdb_delete_by_port(struct net_bridge *br, const struct net_bridge_port *p, u16 vid, int do_all); struct net_bridge_fdb_entry *br_fdb_find_rcu(struct net_bridge *br, const unsigned char *addr, __u16 vid); int br_fdb_test_addr(struct net_device *dev, unsigned char *addr); int br_fdb_fillbuf(struct net_bridge *br, void *buf, unsigned long count, unsigned long off); int br_fdb_insert(struct net_bridge *br, struct net_bridge_port *source, const unsigned char *addr, u16 vid); void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source, const unsigned char *addr, u16 vid, bool added_by_user); int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[], struct net_device *dev, const unsigned char *addr, u16 vid); int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[], struct net_device *dev, const unsigned char *addr, u16 vid, u16 nlh_flags); int br_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb, struct net_device *dev, struct net_device *fdev, int *idx); int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p); void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p); int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p, const unsigned char *addr, u16 vid); int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p, const unsigned char *addr, u16 vid); void br_fdb_offloaded_set(struct net_bridge *br, struct net_bridge_port *p, const unsigned char *addr, u16 vid); /* br_forward.c */ enum br_pkt_type { BR_PKT_UNICAST, BR_PKT_MULTICAST, BR_PKT_BROADCAST }; int br_dev_queue_push_xmit(struct net *net, struct sock *sk, struct sk_buff *skb); void br_forward(const struct net_bridge_port *to, struct sk_buff *skb, bool local_rcv, bool local_orig); int br_forward_finish(struct net *net, struct sock *sk, struct sk_buff *skb); void br_flood(struct net_bridge *br, struct sk_buff *skb, enum br_pkt_type pkt_type, bool local_rcv, bool local_orig); /* br_if.c */ void br_port_carrier_check(struct net_bridge_port *p); int br_add_bridge(struct net *net, const char *name); int br_del_bridge(struct net *net, const char *name); int br_add_if(struct net_bridge *br, struct net_device *dev); int br_del_if(struct net_bridge *br, struct net_device *dev); int br_min_mtu(const struct net_bridge *br); netdev_features_t br_features_recompute(struct net_bridge *br, netdev_features_t features); void br_port_flags_change(struct net_bridge_port *port, unsigned long mask); void br_manage_promisc(struct net_bridge *br); /* br_input.c */ int br_handle_frame_finish(struct net *net, struct sock *sk, struct sk_buff *skb); rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
static inline bool br_rx_handler_check_rcu(const struct net_device *dev) { return rcu_dereference(dev->rx_handler) == br_handle_frame; }


Jiri Pirko23100.00%1100.00%

static inline struct net_bridge_port *br_port_get_check_rcu(const struct net_device *dev) { return br_rx_handler_check_rcu(dev) ? br_port_get_rcu(dev) : NULL; }


Jiri Pirko28100.00%1100.00%

/* br_ioctl.c */ int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd); int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg); /* br_multicast.c */ #ifdef CONFIG_BRIDGE_IGMP_SNOOPING extern unsigned int br_mdb_rehash_seq; int br_multicast_rcv(struct net_bridge *br, struct net_bridge_port *port, struct sk_buff *skb, u16 vid); struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br, struct sk_buff *skb, u16 vid); int br_multicast_add_port(struct net_bridge_port *port); void br_multicast_del_port(struct net_bridge_port *port); void br_multicast_enable_port(struct net_bridge_port *port); void br_multicast_disable_port(struct net_bridge_port *port); void br_multicast_init(struct net_bridge *br); void br_multicast_open(struct net_bridge *br); void br_multicast_stop(struct net_bridge *br); void br_multicast_dev_del(struct net_bridge *br); void br_multicast_flood(struct net_bridge_mdb_entry *mdst, struct sk_buff *skb, bool local_rcv, bool local_orig); int br_multicast_set_router(struct net_bridge *br, unsigned long val); int br_multicast_set_port_router(struct net_bridge_port *p, unsigned long val); int br_multicast_toggle(struct net_bridge *br, unsigned long val); int br_multicast_set_querier(struct net_bridge *br, unsigned long val); int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val); int br_multicast_set_igmp_version(struct net_bridge *br, unsigned long val); #if IS_ENABLED(CONFIG_IPV6) int br_multicast_set_mld_version(struct net_bridge *br, unsigned long val); #endif struct net_bridge_mdb_entry * br_mdb_ip_get(struct net_bridge_mdb_htable *mdb, struct br_ip *dst); struct net_bridge_mdb_entry * br_multicast_new_group(struct net_bridge *br, struct net_bridge_port *port, struct br_ip *group); void br_multicast_free_pg(struct rcu_head *head); struct net_bridge_port_group * br_multicast_new_port_group(struct net_bridge_port *port, struct br_ip *group, struct net_bridge_port_group __rcu *next, unsigned char flags, const unsigned char *src); void br_mdb_init(void); void br_mdb_uninit(void); void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port, struct br_ip *group, int type, u8 flags); void br_rtr_notify(struct net_device *dev, struct net_bridge_port *port, int type); void br_multicast_count(struct net_bridge *br, const struct net_bridge_port *p, const struct sk_buff *skb, u8 type, u8 dir); int br_multicast_init_stats(struct net_bridge *br); void br_multicast_uninit_stats(struct net_bridge *br); void br_multicast_get_stats(const struct net_bridge *br, const struct net_bridge_port *p, struct br_mcast_stats *dest); #define mlock_dereference(X, br) \ rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
static inline bool br_multicast_is_router(struct net_bridge *br) { return br->multicast_router == 2 || (br->multicast_router == 1 && timer_pending(&br->multicast_router_timer)); }


Sridhar Samudrala35100.00%1100.00%

static inline bool __br_multicast_querier_exists(struct net_bridge *br, struct bridge_mcast_other_query *querier, const bool is_ipv6) { bool own_querier_enabled; if (br->multicast_querier) { if (is_ipv6 && !br->has_ipv6_addr) own_querier_enabled = false; else own_querier_enabled = true; } else { own_querier_enabled = false; } return time_is_before_jiffies(querier->delay_time) && (own_querier_enabled || timer_pending(&querier->timer)); }


Linus Lüssing3646.75%375.00%

static inline bool br_multicast_querier_exists(struct net_bridge *br, struct ethhdr *eth) { switch (eth->h_proto) { case (htons(ETH_P_IP)): return __br_multicast_querier_exists(br, &br->ip4_other_query, false); #if IS_ENABLED(CONFIG_IPV6) case (htons(ETH_P_IPV6)