xref: /openbmc/linux/net/bridge/br_private.h (revision 32fe21c0)
11da177e4SLinus Torvalds /*
21da177e4SLinus Torvalds  *	Linux ethernet bridge
31da177e4SLinus Torvalds  *
41da177e4SLinus Torvalds  *	Authors:
51da177e4SLinus Torvalds  *	Lennert Buytenhek		<buytenh@gnu.org>
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  *	$Id: br_private.h,v 1.7 2001/12/24 00:59:55 davem Exp $
81da177e4SLinus Torvalds  *
91da177e4SLinus Torvalds  *	This program is free software; you can redistribute it and/or
101da177e4SLinus Torvalds  *	modify it under the terms of the GNU General Public License
111da177e4SLinus Torvalds  *	as published by the Free Software Foundation; either version
121da177e4SLinus Torvalds  *	2 of the License, or (at your option) any later version.
131da177e4SLinus Torvalds  */
141da177e4SLinus Torvalds 
151da177e4SLinus Torvalds #ifndef _BR_PRIVATE_H
161da177e4SLinus Torvalds #define _BR_PRIVATE_H
171da177e4SLinus Torvalds 
181da177e4SLinus Torvalds #include <linux/netdevice.h>
191da177e4SLinus Torvalds #include <linux/if_bridge.h>
201da177e4SLinus Torvalds 
211da177e4SLinus Torvalds #define BR_HASH_BITS 8
221da177e4SLinus Torvalds #define BR_HASH_SIZE (1 << BR_HASH_BITS)
231da177e4SLinus Torvalds 
241da177e4SLinus Torvalds #define BR_HOLD_TIME (1*HZ)
251da177e4SLinus Torvalds 
261da177e4SLinus Torvalds #define BR_PORT_BITS	10
271da177e4SLinus Torvalds #define BR_MAX_PORTS	(1<<BR_PORT_BITS)
281da177e4SLinus Torvalds 
2911dc1f36SStephen Hemminger #define BR_VERSION	"2.2"
308cbb512eSStephen Hemminger 
311da177e4SLinus Torvalds typedef struct bridge_id bridge_id;
321da177e4SLinus Torvalds typedef struct mac_addr mac_addr;
331da177e4SLinus Torvalds typedef __u16 port_id;
341da177e4SLinus Torvalds 
351da177e4SLinus Torvalds struct bridge_id
361da177e4SLinus Torvalds {
371da177e4SLinus Torvalds 	unsigned char	prio[2];
381da177e4SLinus Torvalds 	unsigned char	addr[6];
391da177e4SLinus Torvalds };
401da177e4SLinus Torvalds 
411da177e4SLinus Torvalds struct mac_addr
421da177e4SLinus Torvalds {
431da177e4SLinus Torvalds 	unsigned char	addr[6];
441da177e4SLinus Torvalds };
451da177e4SLinus Torvalds 
461da177e4SLinus Torvalds struct net_bridge_fdb_entry
471da177e4SLinus Torvalds {
481da177e4SLinus Torvalds 	struct hlist_node		hlist;
491da177e4SLinus Torvalds 	struct net_bridge_port		*dst;
501da177e4SLinus Torvalds 
511da177e4SLinus Torvalds 	struct rcu_head			rcu;
521da177e4SLinus Torvalds 	atomic_t			use_count;
531da177e4SLinus Torvalds 	unsigned long			ageing_timer;
541da177e4SLinus Torvalds 	mac_addr			addr;
551da177e4SLinus Torvalds 	unsigned char			is_local;
561da177e4SLinus Torvalds 	unsigned char			is_static;
571da177e4SLinus Torvalds };
581da177e4SLinus Torvalds 
591da177e4SLinus Torvalds struct net_bridge_port
601da177e4SLinus Torvalds {
611da177e4SLinus Torvalds 	struct net_bridge		*br;
621da177e4SLinus Torvalds 	struct net_device		*dev;
631da177e4SLinus Torvalds 	struct list_head		list;
641da177e4SLinus Torvalds 
651da177e4SLinus Torvalds 	/* STP */
661da177e4SLinus Torvalds 	u8				priority;
671da177e4SLinus Torvalds 	u8				state;
681da177e4SLinus Torvalds 	u16				port_no;
691da177e4SLinus Torvalds 	unsigned char			topology_change_ack;
701da177e4SLinus Torvalds 	unsigned char			config_pending;
711da177e4SLinus Torvalds 	port_id				port_id;
721da177e4SLinus Torvalds 	port_id				designated_port;
731da177e4SLinus Torvalds 	bridge_id			designated_root;
741da177e4SLinus Torvalds 	bridge_id			designated_bridge;
751da177e4SLinus Torvalds 	u32				path_cost;
761da177e4SLinus Torvalds 	u32				designated_cost;
771da177e4SLinus Torvalds 
781da177e4SLinus Torvalds 	struct timer_list		forward_delay_timer;
791da177e4SLinus Torvalds 	struct timer_list		hold_timer;
801da177e4SLinus Torvalds 	struct timer_list		message_age_timer;
811da177e4SLinus Torvalds 	struct kobject			kobj;
821da177e4SLinus Torvalds 	struct rcu_head			rcu;
831da177e4SLinus Torvalds };
841da177e4SLinus Torvalds 
851da177e4SLinus Torvalds struct net_bridge
861da177e4SLinus Torvalds {
871da177e4SLinus Torvalds 	spinlock_t			lock;
881da177e4SLinus Torvalds 	struct list_head		port_list;
891da177e4SLinus Torvalds 	struct net_device		*dev;
901da177e4SLinus Torvalds 	struct net_device_stats		statistics;
911da177e4SLinus Torvalds 	spinlock_t			hash_lock;
921da177e4SLinus Torvalds 	struct hlist_head		hash[BR_HASH_SIZE];
931da177e4SLinus Torvalds 	struct list_head		age_list;
94edb5e46fSStephen Hemminger 	unsigned long			feature_mask;
951da177e4SLinus Torvalds 
961da177e4SLinus Torvalds 	/* STP */
971da177e4SLinus Torvalds 	bridge_id			designated_root;
981da177e4SLinus Torvalds 	bridge_id			bridge_id;
991da177e4SLinus Torvalds 	u32				root_path_cost;
1001da177e4SLinus Torvalds 	unsigned long			max_age;
1011da177e4SLinus Torvalds 	unsigned long			hello_time;
1021da177e4SLinus Torvalds 	unsigned long			forward_delay;
1031da177e4SLinus Torvalds 	unsigned long			bridge_max_age;
1041da177e4SLinus Torvalds 	unsigned long			ageing_time;
1051da177e4SLinus Torvalds 	unsigned long			bridge_hello_time;
1061da177e4SLinus Torvalds 	unsigned long			bridge_forward_delay;
1071da177e4SLinus Torvalds 
108fda93d92SStephen Hemminger 	u8				group_addr[ETH_ALEN];
1091da177e4SLinus Torvalds 	u16				root_port;
1101da177e4SLinus Torvalds 	unsigned char			stp_enabled;
1111da177e4SLinus Torvalds 	unsigned char			topology_change;
1121da177e4SLinus Torvalds 	unsigned char			topology_change_detected;
1131da177e4SLinus Torvalds 
1141da177e4SLinus Torvalds 	struct timer_list		hello_timer;
1151da177e4SLinus Torvalds 	struct timer_list		tcn_timer;
1161da177e4SLinus Torvalds 	struct timer_list		topology_change_timer;
1171da177e4SLinus Torvalds 	struct timer_list		gc_timer;
1181da177e4SLinus Torvalds 	struct kobject			ifobj;
1191da177e4SLinus Torvalds };
1201da177e4SLinus Torvalds 
1211da177e4SLinus Torvalds extern struct notifier_block br_device_notifier;
122fda93d92SStephen Hemminger extern const u8 br_group_address[ETH_ALEN];
1231da177e4SLinus Torvalds 
1241da177e4SLinus Torvalds /* called under bridge lock */
1251da177e4SLinus Torvalds static inline int br_is_root_bridge(const struct net_bridge *br)
1261da177e4SLinus Torvalds {
1271da177e4SLinus Torvalds 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
1281da177e4SLinus Torvalds }
1291da177e4SLinus Torvalds 
1301da177e4SLinus Torvalds 
1311da177e4SLinus Torvalds /* br_device.c */
1321da177e4SLinus Torvalds extern void br_dev_setup(struct net_device *dev);
1331da177e4SLinus Torvalds extern int br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
1341da177e4SLinus Torvalds 
1351da177e4SLinus Torvalds /* br_fdb.c */
1361da177e4SLinus Torvalds extern void br_fdb_init(void);
1371da177e4SLinus Torvalds extern void br_fdb_fini(void);
1381da177e4SLinus Torvalds extern void br_fdb_changeaddr(struct net_bridge_port *p,
1391da177e4SLinus Torvalds 			      const unsigned char *newaddr);
1401da177e4SLinus Torvalds extern void br_fdb_cleanup(unsigned long arg);
1411da177e4SLinus Torvalds extern void br_fdb_delete_by_port(struct net_bridge *br,
1421a620698SStephen Hemminger 				  const struct net_bridge_port *p, int do_all);
1431da177e4SLinus Torvalds extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
1441da177e4SLinus Torvalds 						 const unsigned char *addr);
1451da177e4SLinus Torvalds extern struct net_bridge_fdb_entry *br_fdb_get(struct net_bridge *br,
1461da177e4SLinus Torvalds 					       unsigned char *addr);
1471da177e4SLinus Torvalds extern void br_fdb_put(struct net_bridge_fdb_entry *ent);
1481da177e4SLinus Torvalds extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
1491da177e4SLinus Torvalds 			  unsigned long count, unsigned long off);
1501da177e4SLinus Torvalds extern int br_fdb_insert(struct net_bridge *br,
1511da177e4SLinus Torvalds 			 struct net_bridge_port *source,
1521da177e4SLinus Torvalds 			 const unsigned char *addr);
1531da177e4SLinus Torvalds extern void br_fdb_update(struct net_bridge *br,
1541da177e4SLinus Torvalds 			  struct net_bridge_port *source,
1551da177e4SLinus Torvalds 			  const unsigned char *addr);
1561da177e4SLinus Torvalds 
1571da177e4SLinus Torvalds /* br_forward.c */
1581da177e4SLinus Torvalds extern void br_deliver(const struct net_bridge_port *to,
1591da177e4SLinus Torvalds 		struct sk_buff *skb);
1601da177e4SLinus Torvalds extern int br_dev_queue_push_xmit(struct sk_buff *skb);
1611da177e4SLinus Torvalds extern void br_forward(const struct net_bridge_port *to,
1621da177e4SLinus Torvalds 		struct sk_buff *skb);
1631da177e4SLinus Torvalds extern int br_forward_finish(struct sk_buff *skb);
1641da177e4SLinus Torvalds extern void br_flood_deliver(struct net_bridge *br,
1651da177e4SLinus Torvalds 		      struct sk_buff *skb,
1661da177e4SLinus Torvalds 		      int clone);
1671da177e4SLinus Torvalds extern void br_flood_forward(struct net_bridge *br,
1681da177e4SLinus Torvalds 		      struct sk_buff *skb,
1691da177e4SLinus Torvalds 		      int clone);
1701da177e4SLinus Torvalds 
1711da177e4SLinus Torvalds /* br_if.c */
172269def7cSStephen Hemminger extern void br_port_carrier_check(struct net_bridge_port *p);
1731da177e4SLinus Torvalds extern int br_add_bridge(const char *name);
1741da177e4SLinus Torvalds extern int br_del_bridge(const char *name);
1751da177e4SLinus Torvalds extern void br_cleanup_bridges(void);
1761da177e4SLinus Torvalds extern int br_add_if(struct net_bridge *br,
1771da177e4SLinus Torvalds 	      struct net_device *dev);
1781da177e4SLinus Torvalds extern int br_del_if(struct net_bridge *br,
1791da177e4SLinus Torvalds 	      struct net_device *dev);
1801da177e4SLinus Torvalds extern int br_min_mtu(const struct net_bridge *br);
18181d35307SStephen Hemminger extern void br_features_recompute(struct net_bridge *br);
1821da177e4SLinus Torvalds 
1831da177e4SLinus Torvalds /* br_input.c */
1841da177e4SLinus Torvalds extern int br_handle_frame_finish(struct sk_buff *skb);
1851da177e4SLinus Torvalds extern int br_handle_frame(struct net_bridge_port *p, struct sk_buff **pskb);
1861da177e4SLinus Torvalds 
1871da177e4SLinus Torvalds /* br_ioctl.c */
1881da177e4SLinus Torvalds extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
1891da177e4SLinus Torvalds extern int br_ioctl_deviceless_stub(unsigned int cmd, void __user *arg);
1901da177e4SLinus Torvalds 
1911da177e4SLinus Torvalds /* br_netfilter.c */
192c0909713SStephen Hemminger #ifdef CONFIG_BRIDGE_NETFILTER
1931da177e4SLinus Torvalds extern int br_netfilter_init(void);
1941da177e4SLinus Torvalds extern void br_netfilter_fini(void);
195c0909713SStephen Hemminger #else
196c0909713SStephen Hemminger #define br_netfilter_init()	(0)
197c0909713SStephen Hemminger #define br_netfilter_fini()	do { } while(0)
198c0909713SStephen Hemminger #endif
1991da177e4SLinus Torvalds 
2001da177e4SLinus Torvalds /* br_stp.c */
2011da177e4SLinus Torvalds extern void br_log_state(const struct net_bridge_port *p);
2021da177e4SLinus Torvalds extern struct net_bridge_port *br_get_port(struct net_bridge *br,
2031da177e4SLinus Torvalds 					   u16 port_no);
2041da177e4SLinus Torvalds extern void br_init_port(struct net_bridge_port *p);
2051da177e4SLinus Torvalds extern void br_become_designated_port(struct net_bridge_port *p);
2061da177e4SLinus Torvalds 
2071da177e4SLinus Torvalds /* br_stp_if.c */
2081da177e4SLinus Torvalds extern void br_stp_enable_bridge(struct net_bridge *br);
2091da177e4SLinus Torvalds extern void br_stp_disable_bridge(struct net_bridge *br);
2101da177e4SLinus Torvalds extern void br_stp_enable_port(struct net_bridge_port *p);
2111da177e4SLinus Torvalds extern void br_stp_disable_port(struct net_bridge_port *p);
2121da177e4SLinus Torvalds extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
2134505a3efSStephen Hemminger extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
2141da177e4SLinus Torvalds extern void br_stp_set_bridge_priority(struct net_bridge *br,
2151da177e4SLinus Torvalds 				       u16 newprio);
2161da177e4SLinus Torvalds extern void br_stp_set_port_priority(struct net_bridge_port *p,
2171da177e4SLinus Torvalds 				     u8 newprio);
2181da177e4SLinus Torvalds extern void br_stp_set_path_cost(struct net_bridge_port *p,
2191da177e4SLinus Torvalds 				 u32 path_cost);
2201da177e4SLinus Torvalds extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
2211da177e4SLinus Torvalds 
2221da177e4SLinus Torvalds /* br_stp_bpdu.c */
223cf0f02d0SStephen Hemminger extern int br_stp_rcv(struct sk_buff *skb, struct net_device *dev,
224cf0f02d0SStephen Hemminger 		      struct packet_type *pt, struct net_device *orig_dev);
2251da177e4SLinus Torvalds 
2261da177e4SLinus Torvalds /* br_stp_timer.c */
2271da177e4SLinus Torvalds extern void br_stp_timer_init(struct net_bridge *br);
2281da177e4SLinus Torvalds extern void br_stp_port_timer_init(struct net_bridge_port *p);
2291da177e4SLinus Torvalds extern unsigned long br_timer_value(const struct timer_list *timer);
2301da177e4SLinus Torvalds 
2311da177e4SLinus Torvalds /* br.c */
2321da177e4SLinus Torvalds extern struct net_bridge_fdb_entry *(*br_fdb_get_hook)(struct net_bridge *br,
2331da177e4SLinus Torvalds 						       unsigned char *addr);
2341da177e4SLinus Torvalds extern void (*br_fdb_put_hook)(struct net_bridge_fdb_entry *ent);
2351da177e4SLinus Torvalds 
2361da177e4SLinus Torvalds 
23711dc1f36SStephen Hemminger /* br_netlink.c */
23832fe21c0SThomas Graf extern int br_netlink_init(void);
23911dc1f36SStephen Hemminger extern void br_netlink_fini(void);
24011dc1f36SStephen Hemminger extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
24111dc1f36SStephen Hemminger 
2421da177e4SLinus Torvalds #ifdef CONFIG_SYSFS
2431da177e4SLinus Torvalds /* br_sysfs_if.c */
244bab1deeaSStephen Hemminger extern struct sysfs_ops brport_sysfs_ops;
2451da177e4SLinus Torvalds extern int br_sysfs_addif(struct net_bridge_port *p);
2461da177e4SLinus Torvalds 
2471da177e4SLinus Torvalds /* br_sysfs_br.c */
2481da177e4SLinus Torvalds extern int br_sysfs_addbr(struct net_device *dev);
2491da177e4SLinus Torvalds extern void br_sysfs_delbr(struct net_device *dev);
2501da177e4SLinus Torvalds 
2511da177e4SLinus Torvalds #else
2521da177e4SLinus Torvalds 
2531da177e4SLinus Torvalds #define br_sysfs_addif(p)	(0)
2541da177e4SLinus Torvalds #define br_sysfs_addbr(dev)	(0)
2551da177e4SLinus Torvalds #define br_sysfs_delbr(dev)	do { } while(0)
2561da177e4SLinus Torvalds #endif /* CONFIG_SYSFS */
2571da177e4SLinus Torvalds 
2581da177e4SLinus Torvalds #endif
259