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

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