[deliverable/linux.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>

#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;
	atomic_t			use_count;
	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;
};

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;

	/* 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 struct net_bridge_fdb_entry *br_fdb_get(struct net_bridge *br,
					       unsigned char *addr);
extern void br_fdb_put(struct net_bridge_fdb_entry *ent);
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(const char *name);
extern int br_del_bridge(const char *name);
extern void br_cleanup_bridges(void);
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);
#else
#define br_netfilter_init()	(0)
#define br_netfilter_fini()	do { } while(0)
#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 */
extern int br_stp_rcv(struct sk_buff *skb, struct net_device *dev,
		      struct packet_type *pt, struct net_device *orig_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 */
extern struct net_bridge_fdb_entry *(*br_fdb_get_hook)(struct net_bridge *br,
						       unsigned char *addr);
extern void (*br_fdb_put_hook)(struct net_bridge_fdb_entry *ent);


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