[mirror_ubuntu-zesty-kernel.git] / net / bridge / br_private.h

/*
 *	Linux ethernet bridge
 *
 *	Authors:
 *	Lennert Buytenhek		<buytenh@gnu.org>
 *
 *	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 <net/route.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_MAX_PORTS	(1<<BR_PORT_BITS)

#define BR_VERSION	"2.3"

/* 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[6];
};

struct mac_addr
{
	unsigned char	addr[6];
};

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

	struct rcu_head			rcu;
	unsigned long			ageing_timer;
	mac_addr			addr;
	unsigned char			is_local;
	unsigned char			is_static;
};

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

	/* 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;

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

	unsigned long 			flags;
#define BR_HAIRPIN_MODE		0x00000001
};

struct net_bridge
{
	spinlock_t			lock;
	struct list_head		port_list;
	struct net_device		*dev;
	spinlock_t			hash_lock;
	struct hlist_head		hash[BR_HASH_SIZE];
	struct list_head		age_list;
	unsigned long			feature_mask;
#ifdef CONFIG_BRIDGE_NETFILTER
	struct rtable 			fake_rtable;
#endif
	unsigned long			flags;
#define BR_SET_MAC_ADDR		0x00000001

	/* STP */
	bridge_id			designated_root;
	bridge_id			bridge_id;
	u32				root_path_cost;
	unsigned long			max_age;
	unsigned long			hello_time;
	unsigned long			forward_delay;
	unsigned long			bridge_max_age;
	unsigned long			ageing_time;
	unsigned long			bridge_hello_time;
	unsigned long			bridge_forward_delay;

	u8				group_addr[ETH_ALEN];
	u16				root_port;

	enum {
		BR_NO_STP, 		/* no spanning tree */
		BR_KERNEL_STP,		/* old STP in kernel */
		BR_USER_STP,		/* new RSTP in userspace */
	} stp_enabled;

	unsigned char			topology_change;
	unsigned char			topology_change_detected;

	struct timer_list		hello_timer;
	struct timer_list		tcn_timer;
	struct timer_list		topology_change_timer;
	struct timer_list		gc_timer;
	struct kobject			*ifobj;
};

extern struct notifier_block br_device_notifier;
extern const u8 br_group_address[ETH_ALEN];

/* 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);
}

/* br_device.c */
extern void br_dev_setup(struct net_device *dev);
extern int br_dev_xmit(struct sk_buff *skb, struct net_device *dev);

/* br_fdb.c */
extern int br_fdb_init(void);
extern void br_fdb_fini(void);
extern void br_fdb_flush(struct net_bridge *br);
extern void br_fdb_changeaddr(struct net_bridge_port *p,
			      const unsigned char *newaddr);
extern void br_fdb_cleanup(unsigned long arg);
extern void br_fdb_delete_by_port(struct net_bridge *br,
				  const struct net_bridge_port *p, int do_all);
extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
						 const unsigned char *addr);
extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
			  unsigned long count, unsigned long off);
extern int br_fdb_insert(struct net_bridge *br,
			 struct net_bridge_port *source,
			 const unsigned char *addr);
extern void br_fdb_update(struct net_bridge *br,
			  struct net_bridge_port *source,
			  const unsigned char *addr);

/* br_forward.c */
extern void br_deliver(const struct net_bridge_port *to,
		struct sk_buff *skb);
extern int br_dev_queue_push_xmit(struct sk_buff *skb);
extern void br_forward(const struct net_bridge_port *to,
		struct sk_buff *skb);
extern int br_forward_finish(struct sk_buff *skb);
extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb);

/* br_if.c */
extern void br_port_carrier_check(struct net_bridge_port *p);
extern int br_add_bridge(struct net *net, const char *name);
extern int br_del_bridge(struct net *net, const char *name);
extern void br_net_exit(struct net *net);
extern int br_add_if(struct net_bridge *br,
	      struct net_device *dev);
extern int br_del_if(struct net_bridge *br,
	      struct net_device *dev);
extern int br_min_mtu(const struct net_bridge *br);
extern void br_features_recompute(struct net_bridge *br);

/* br_input.c */
extern int br_handle_frame_finish(struct sk_buff *skb);
extern struct sk_buff *br_handle_frame(struct net_bridge_port *p,
				       struct sk_buff *skb);

/* br_ioctl.c */
extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);

/* br_netfilter.c */
#ifdef CONFIG_BRIDGE_NETFILTER
extern int br_netfilter_init(void);
extern void br_netfilter_fini(void);
extern void br_netfilter_rtable_init(struct net_bridge *);
#else
#define br_netfilter_init()	(0)
#define br_netfilter_fini()	do { } while(0)
#define br_netfilter_rtable_init(x)
#endif

/* br_stp.c */
extern void br_log_state(const struct net_bridge_port *p);
extern struct net_bridge_port *br_get_port(struct net_bridge *br,
					   u16 port_no);
extern void br_init_port(struct net_bridge_port *p);
extern void br_become_designated_port(struct net_bridge_port *p);

/* br_stp_if.c */
extern void br_stp_enable_bridge(struct net_bridge *br);
extern void br_stp_disable_bridge(struct net_bridge *br);
extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
extern void br_stp_enable_port(struct net_bridge_port *p);
extern void br_stp_disable_port(struct net_bridge_port *p);
extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
extern void br_stp_set_bridge_priority(struct net_bridge *br,
				       u16 newprio);
extern void br_stp_set_port_priority(struct net_bridge_port *p,
				     u8 newprio);
extern void br_stp_set_path_cost(struct net_bridge_port *p,
				 u32 path_cost);
extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);

/* br_stp_bpdu.c */
struct stp_proto;
extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
		       struct net_device *dev);

/* br_stp_timer.c */
extern void br_stp_timer_init(struct net_bridge *br);
extern void br_stp_port_timer_init(struct net_bridge_port *p);
extern unsigned long br_timer_value(const struct timer_list *timer);

/* br.c */
#if defined(CONFIG_ATM_LANE) || defined(CONFIG_ATM_LANE_MODULE)
extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
#endif

/* br_netlink.c */
extern int br_netlink_init(void);
extern void br_netlink_fini(void);
extern void br_ifinfo_notify(int event, struct net_bridge_port *port);

#ifdef CONFIG_SYSFS
/* br_sysfs_if.c */
extern struct sysfs_ops brport_sysfs_ops;
extern int br_sysfs_addif(struct net_bridge_port *p);

/* br_sysfs_br.c */
extern int br_sysfs_addbr(struct net_device *dev);
extern void br_sysfs_delbr(struct net_device *dev);

#else

#define br_sysfs_addif(p)	(0)
#define br_sysfs_addbr(dev)	(0)
#define br_sysfs_delbr(dev)	do { } while(0)
#endif /* CONFIG_SYSFS */

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Linux ethernet bridge
	3	*
	4	* Authors:
	5	* Lennert Buytenhek <buytenh@gnu.org>
	6	*
1da177e4 LT	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>
1da177e4	17	#include <linux/if_bridge.h>
4adf0af6	18	#include <net/route.h>
1da177e4 LT	19
	20	#define BR_HASH_BITS 8
	21	#define BR_HASH_SIZE (1 << BR_HASH_BITS)
	22
	23	#define BR_HOLD_TIME (1*HZ)
	24
	25	#define BR_PORT_BITS 10
	26	#define BR_MAX_PORTS (1<<BR_PORT_BITS)
	27
9cde0708 SH	28	#define BR_VERSION "2.3"
	29
	30	/* Path to usermode spanning tree program */
	31	#define BR_STP_PROG "/sbin/bridge-stp"
8cbb512e	32
1da177e4 LT	33	typedef struct bridge_id bridge_id;
	34	typedef struct mac_addr mac_addr;
	35	typedef __u16 port_id;
	36
	37	struct bridge_id
	38	{
	39	unsigned char prio[2];
	40	unsigned char addr[6];
	41	};
	42
	43	struct mac_addr
	44	{
	45	unsigned char addr[6];
	46	};
	47
	48	struct net_bridge_fdb_entry
	49	{
	50	struct hlist_node hlist;
	51	struct net_bridge_port *dst;
	52
	53	struct rcu_head rcu;
1da177e4 LT	54	unsigned long ageing_timer;
	55	mac_addr addr;
	56	unsigned char is_local;
	57	unsigned char is_static;
	58	};
	59
	60	struct net_bridge_port
	61	{
	62	struct net_bridge *br;
	63	struct net_device *dev;
	64	struct list_head list;
	65
	66	/* STP */
	67	u8 priority;
	68	u8 state;
	69	u16 port_no;
	70	unsigned char topology_change_ack;
	71	unsigned char config_pending;
	72	port_id port_id;
	73	port_id designated_port;
	74	bridge_id designated_root;
	75	bridge_id designated_bridge;
	76	u32 path_cost;
	77	u32 designated_cost;
	78
	79	struct timer_list forward_delay_timer;
	80	struct timer_list hold_timer;
	81	struct timer_list message_age_timer;
	82	struct kobject kobj;
	83	struct rcu_head rcu;
3982d3d2 FA	84
	85	unsigned long flags;
	86	#define BR_HAIRPIN_MODE 0x00000001
1da177e4 LT	87	};
	88
	89	struct net_bridge
	90	{
	91	spinlock_t lock;
	92	struct list_head port_list;
	93	struct net_device *dev;
1da177e4 LT	94	spinlock_t hash_lock;
	95	struct hlist_head hash[BR_HASH_SIZE];
	96	struct list_head age_list;
edb5e46f	97	unsigned long feature_mask;
4adf0af6 SW	98	#ifdef CONFIG_BRIDGE_NETFILTER
	99	struct rtable fake_rtable;
	100	#endif
92c0574f SH	101	unsigned long flags;
92c0574f SH	102	#define BR_SET_MAC_ADDR 0x00000001
1da177e4 LT	103
	104	/* STP */
	105	bridge_id designated_root;
	106	bridge_id bridge_id;
	107	u32 root_path_cost;
	108	unsigned long max_age;
	109	unsigned long hello_time;
	110	unsigned long forward_delay;
	111	unsigned long bridge_max_age;
	112	unsigned long ageing_time;
	113	unsigned long bridge_hello_time;
	114	unsigned long bridge_forward_delay;
	115
fda93d92	116	u8 group_addr[ETH_ALEN];
1da177e4	117	u16 root_port;
9cde0708 SH	118
	119	enum {
	120	BR_NO_STP, /* no spanning tree */
	121	BR_KERNEL_STP, /* old STP in kernel */
	122	BR_USER_STP, /* new RSTP in userspace */
	123	} stp_enabled;
	124
1da177e4 LT	125	unsigned char topology_change;
	126	unsigned char topology_change_detected;
	127
	128	struct timer_list hello_timer;
	129	struct timer_list tcn_timer;
	130	struct timer_list topology_change_timer;
	131	struct timer_list gc_timer;
43b98c4a	132	struct kobject *ifobj;
1da177e4 LT	133	};
	134
	135	extern struct notifier_block br_device_notifier;
fda93d92	136	extern const u8 br_group_address[ETH_ALEN];
1da177e4 LT	137
	138	/* called under bridge lock */
	139	static inline int br_is_root_bridge(const struct net_bridge *br)
	140	{
	141	return !memcmp(&br->bridge_id, &br->designated_root, 8);
	142	}
	143
1da177e4 LT	144	/* br_device.c */
	145	extern void br_dev_setup(struct net_device *dev);
	146	extern int br_dev_xmit(struct sk_buff skb, struct net_device dev);
	147
	148	/* br_fdb.c */
87a596e0	149	extern int br_fdb_init(void);
1da177e4	150	extern void br_fdb_fini(void);
9cf63747	151	extern void br_fdb_flush(struct net_bridge *br);
1da177e4 LT	152	extern void br_fdb_changeaddr(struct net_bridge_port *p,
	153	const unsigned char *newaddr);
	154	extern void br_fdb_cleanup(unsigned long arg);
	155	extern void br_fdb_delete_by_port(struct net_bridge *br,
1a620698	156	const struct net_bridge_port *p, int do_all);
1da177e4 LT	157	extern struct net_bridge_fdb_entry __br_fdb_get(struct net_bridge br,
1da177e4 LT	158	const unsigned char *addr);
da678292	159	extern int br_fdb_test_addr(struct net_device dev, unsigned char addr);
9d6f229f	160	extern int br_fdb_fillbuf(struct net_bridge br, void buf,
1da177e4 LT	161	unsigned long count, unsigned long off);
	162	extern int br_fdb_insert(struct net_bridge *br,
	163	struct net_bridge_port *source,
	164	const unsigned char *addr);
	165	extern void br_fdb_update(struct net_bridge *br,
	166	struct net_bridge_port *source,
	167	const unsigned char *addr);
	168
	169	/* br_forward.c */
	170	extern void br_deliver(const struct net_bridge_port *to,
	171	struct sk_buff *skb);
	172	extern int br_dev_queue_push_xmit(struct sk_buff *skb);
	173	extern void br_forward(const struct net_bridge_port *to,
	174	struct sk_buff *skb);
	175	extern int br_forward_finish(struct sk_buff *skb);
e081e1e3 HX	176	extern void br_flood_deliver(struct net_bridge br, struct sk_buff skb);
e081e1e3 HX	177	extern void br_flood_forward(struct net_bridge br, struct sk_buff skb);
1da177e4 LT	178
1da177e4 LT	179	/* br_if.c */
269def7c	180	extern void br_port_carrier_check(struct net_bridge_port *p);
4aa678ba AD	181	extern int br_add_bridge(struct net net, const char name);
4aa678ba AD	182	extern int br_del_bridge(struct net net, const char name);
712d6954	183	extern void br_net_exit(struct net *net);
1da177e4 LT	184	extern int br_add_if(struct net_bridge *br,
	185	struct net_device *dev);
	186	extern int br_del_if(struct net_bridge *br,
	187	struct net_device *dev);
	188	extern int br_min_mtu(const struct net_bridge *br);
81d35307	189	extern void br_features_recompute(struct net_bridge *br);
1da177e4 LT	190
	191	/* br_input.c */
	192	extern int br_handle_frame_finish(struct sk_buff *skb);
6229e362 SH	193	extern struct sk_buff br_handle_frame(struct net_bridge_port p,
6229e362 SH	194	struct sk_buff *skb);
1da177e4 LT	195
	196	/* br_ioctl.c */
	197	extern int br_dev_ioctl(struct net_device dev, struct ifreq rq, int cmd);
881d966b	198	extern int br_ioctl_deviceless_stub(struct net net, unsigned int cmd, void __user arg);
1da177e4 LT	199
1da177e4 LT	200	/* br_netfilter.c */
c0909713	201	#ifdef CONFIG_BRIDGE_NETFILTER
1da177e4 LT	202	extern int br_netfilter_init(void);
1da177e4 LT	203	extern void br_netfilter_fini(void);
4adf0af6	204	extern void br_netfilter_rtable_init(struct net_bridge *);
c0909713 SH	205	#else
	206	#define br_netfilter_init() (0)
	207	#define br_netfilter_fini() do { } while(0)
4adf0af6	208	#define br_netfilter_rtable_init(x)
c0909713	209	#endif
1da177e4 LT	210
	211	/* br_stp.c */
	212	extern void br_log_state(const struct net_bridge_port *p);
	213	extern struct net_bridge_port br_get_port(struct net_bridge br,
9d6f229f	214	u16 port_no);
1da177e4 LT	215	extern void br_init_port(struct net_bridge_port *p);
	216	extern void br_become_designated_port(struct net_bridge_port *p);
	217
	218	/* br_stp_if.c */
	219	extern void br_stp_enable_bridge(struct net_bridge *br);
	220	extern void br_stp_disable_bridge(struct net_bridge *br);
9cde0708	221	extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
1da177e4 LT	222	extern void br_stp_enable_port(struct net_bridge_port *p);
	223	extern void br_stp_disable_port(struct net_bridge_port *p);
	224	extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
4505a3ef	225	extern void br_stp_change_bridge_id(struct net_bridge br, const unsigned char a);
1da177e4 LT	226	extern void br_stp_set_bridge_priority(struct net_bridge *br,
	227	u16 newprio);
	228	extern void br_stp_set_port_priority(struct net_bridge_port *p,
	229	u8 newprio);
	230	extern void br_stp_set_path_cost(struct net_bridge_port *p,
	231	u32 path_cost);
	232	extern ssize_t br_show_bridge_id(char buf, const struct bridge_id id);
	233
	234	/* br_stp_bpdu.c */
7c85fbf0 PM	235	struct stp_proto;
	236	extern void br_stp_rcv(const struct stp_proto proto, struct sk_buff skb,
	237	struct net_device *dev);
1da177e4 LT	238
	239	/* br_stp_timer.c */
	240	extern void br_stp_timer_init(struct net_bridge *br);
	241	extern void br_stp_port_timer_init(struct net_bridge_port *p);
	242	extern unsigned long br_timer_value(const struct timer_list *timer);
	243
	244	/* br.c */
da678292 MM	245	#if defined(CONFIG_ATM_LANE) \|\| defined(CONFIG_ATM_LANE_MODULE)
	246	extern int (br_fdb_test_addr_hook)(struct net_device dev, unsigned char *addr);
	247	#endif
1da177e4	248
11dc1f36	249	/* br_netlink.c */
32fe21c0	250	extern int br_netlink_init(void);
11dc1f36 SH	251	extern void br_netlink_fini(void);
	252	extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
	253
1da177e4 LT	254	#ifdef CONFIG_SYSFS
1da177e4 LT	255	/* br_sysfs_if.c */
bab1deea	256	extern struct sysfs_ops brport_sysfs_ops;
1da177e4	257	extern int br_sysfs_addif(struct net_bridge_port *p);
1da177e4 LT	258
	259	/* br_sysfs_br.c */
	260	extern int br_sysfs_addbr(struct net_device *dev);
	261	extern void br_sysfs_delbr(struct net_device *dev);
	262
	263	#else
	264
	265	#define br_sysfs_addif(p) (0)
1da177e4 LT	266	#define br_sysfs_addbr(dev) (0)
	267	#define br_sysfs_delbr(dev) do { } while(0)
	268	#endif /* CONFIG_SYSFS */
	269
	270	#endif