[deliverable/linux.git] / drivers / net / bonding / bonding.h

/*
 * Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
 *
 * Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
 * NCM: Network and Communications Management, Inc.
 *
 * BUT, I'm the one who modified it for ethernet, so:
 * (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
 *
 *	This software may be used and distributed according to the terms
 *	of the GNU Public License, incorporated herein by reference.
 *
 */

#ifndef _LINUX_BONDING_H
#define _LINUX_BONDING_H

#include <linux/timer.h>
#include <linux/proc_fs.h>
#include <linux/if_bonding.h>
#include <linux/cpumask.h>
#include <linux/in6.h>
#include <linux/netpoll.h>
#include <linux/inetdevice.h>
#include <linux/etherdevice.h>
#include <linux/reciprocal_div.h>

#include "bond_3ad.h"
#include "bond_alb.h"
#include "bond_options.h"

#define DRV_VERSION	"3.7.1"
#define DRV_RELDATE	"April 27, 2011"
#define DRV_NAME	"bonding"
#define DRV_DESCRIPTION	"Ethernet Channel Bonding Driver"

#define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"

#define BOND_MAX_ARP_TARGETS	16

#define BOND_DEFAULT_MIIMON	100

#define IS_UP(dev)					   \
	      ((((dev)->flags & IFF_UP) == IFF_UP)	&& \
	       netif_running(dev)			&& \
	       netif_carrier_ok(dev))

/*
 * Checks whether slave is ready for transmit.
 */
#define SLAVE_IS_OK(slave)			        \
		    (((slave)->dev->flags & IFF_UP)  && \
		     netif_running((slave)->dev)     && \
		     ((slave)->link == BOND_LINK_UP) && \
		     bond_is_active_slave(slave))


#define USES_PRIMARY(mode)				\
		(((mode) == BOND_MODE_ACTIVEBACKUP) ||	\
		 ((mode) == BOND_MODE_TLB)          ||	\
		 ((mode) == BOND_MODE_ALB))

#define IS_IP_TARGET_UNUSABLE_ADDRESS(a)	\
	((htonl(INADDR_BROADCAST) == a) ||	\
	 ipv4_is_zeronet(a))
/*
 * Less bad way to call ioctl from within the kernel; this needs to be
 * done some other way to get the call out of interrupt context.
 * Needs "ioctl" variable to be supplied by calling context.
 */
#define IOCTL(dev, arg, cmd) ({		\
	int res = 0;			\
	mm_segment_t fs = get_fs();	\
	set_fs(get_ds());		\
	res = ioctl(dev, arg, cmd);	\
	set_fs(fs);			\
	res; })

/* slave list primitives */
#define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)

#define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))

/* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
#define bond_first_slave(bond) \
	(bond_has_slaves(bond) ? \
		netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
		NULL)
#define bond_last_slave(bond) \
	(bond_has_slaves(bond) ? \
		netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
		NULL)

/* Caller must have rcu_read_lock */
#define bond_first_slave_rcu(bond) \
	netdev_lower_get_first_private_rcu(bond->dev)

#define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
#define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))

/**
 * bond_for_each_slave - iterate over all slaves
 * @bond:	the bond holding this list
 * @pos:	current slave
 * @iter:	list_head * iterator
 *
 * Caller must hold bond->lock
 */
#define bond_for_each_slave(bond, pos, iter) \
	netdev_for_each_lower_private((bond)->dev, pos, iter)

/* Caller must have rcu_read_lock */
#define bond_for_each_slave_rcu(bond, pos, iter) \
	netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)

#ifdef CONFIG_NET_POLL_CONTROLLER
extern atomic_t netpoll_block_tx;

static inline void block_netpoll_tx(void)
{
	atomic_inc(&netpoll_block_tx);
}

static inline void unblock_netpoll_tx(void)
{
	atomic_dec(&netpoll_block_tx);
}

static inline int is_netpoll_tx_blocked(struct net_device *dev)
{
	if (unlikely(netpoll_tx_running(dev)))
		return atomic_read(&netpoll_block_tx);
	return 0;
}
#else
#define block_netpoll_tx()
#define unblock_netpoll_tx()
#define is_netpoll_tx_blocked(dev) (0)
#endif

struct bond_params {
	int mode;
	int xmit_policy;
	int miimon;
	u8 num_peer_notif;
	int arp_interval;
	int arp_validate;
	int arp_all_targets;
	int use_carrier;
	int fail_over_mac;
	int updelay;
	int downdelay;
	int lacp_fast;
	unsigned int min_links;
	int ad_select;
	char primary[IFNAMSIZ];
	int primary_reselect;
	__be32 arp_targets[BOND_MAX_ARP_TARGETS];
	int tx_queues;
	int all_slaves_active;
	int resend_igmp;
	int lp_interval;
	int packets_per_slave;
	int tlb_dynamic_lb;
	struct reciprocal_value reciprocal_packets_per_slave;
};

struct bond_parm_tbl {
	char *modename;
	int mode;
};

struct slave {
	struct net_device *dev; /* first - useful for panic debug */
	struct bonding *bond; /* our master */
	int    delay;
	/* all three in jiffies */
	unsigned long last_link_up;
	unsigned long last_rx;
	unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
	s8     link;    /* one of BOND_LINK_XXXX */
	s8     new_link;
	u8     backup:1,   /* indicates backup slave. Value corresponds with
			      BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
	       inactive:1, /* indicates inactive slave */
	       should_notify:1; /* indicateds whether the state changed */
	u8     duplex;
	u32    original_mtu;
	u32    link_failure_count;
	u32    speed;
	u16    queue_id;
	u8     perm_hwaddr[ETH_ALEN];
	struct ad_slave_info *ad_info;
	struct tlb_slave_info tlb_info;
#ifdef CONFIG_NET_POLL_CONTROLLER
	struct netpoll *np;
#endif
	struct kobject kobj;
};

/*
 * Link pseudo-state only used internally by monitors
 */
#define BOND_LINK_NOCHANGE -1

/*
 * Here are the locking policies for the two bonding locks:
 *
 * 1) Get bond->lock when reading/writing slave list.
 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
 *    (It is unnecessary when the write-lock is put with bond->lock.)
 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
 *    beforehand.
 */
struct bonding {
	struct   net_device *dev; /* first - useful for panic debug */
	struct   slave *curr_active_slave;
	struct   slave *current_arp_slave;
	struct   slave *primary_slave;
	bool     force_primary;
	s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
	int     (*recv_probe)(const struct sk_buff *, struct bonding *,
			      struct slave *);
	rwlock_t lock;
	rwlock_t curr_slave_lock;
	u8	 send_peer_notif;
	u8       igmp_retrans;
#ifdef CONFIG_PROC_FS
	struct   proc_dir_entry *proc_entry;
	char     proc_file_name[IFNAMSIZ];
#endif /* CONFIG_PROC_FS */
	struct   list_head bond_list;
	u32      rr_tx_counter;
	struct   ad_bond_info ad_info;
	struct   alb_bond_info alb_info;
	struct   bond_params params;
	struct   workqueue_struct *wq;
	struct   delayed_work mii_work;
	struct   delayed_work arp_work;
	struct   delayed_work alb_work;
	struct   delayed_work ad_work;
	struct   delayed_work mcast_work;
#ifdef CONFIG_DEBUG_FS
	/* debugging support via debugfs */
	struct	 dentry *debug_dir;
#endif /* CONFIG_DEBUG_FS */
};

#define bond_slave_get_rcu(dev) \
	((struct slave *) rcu_dereference(dev->rx_handler_data))

#define bond_slave_get_rtnl(dev) \
	((struct slave *) rtnl_dereference(dev->rx_handler_data))

struct bond_vlan_tag {
	__be16		vlan_proto;
	unsigned short	vlan_id;
};

/**
 * Returns NULL if the net_device does not belong to any of the bond's slaves
 *
 * Caller must hold bond lock for read
 */
static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
						  struct net_device *slave_dev)
{
	return netdev_lower_dev_get_private(bond->dev, slave_dev);
}

static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
{
	if (!slave || !slave->bond)
		return NULL;
	return slave->bond;
}

static inline bool bond_should_override_tx_queue(struct bonding *bond)
{
	return bond->params.mode == BOND_MODE_ACTIVEBACKUP ||
	       bond->params.mode == BOND_MODE_ROUNDROBIN;
}

static inline bool bond_is_lb(const struct bonding *bond)
{
	return bond->params.mode == BOND_MODE_TLB ||
	       bond->params.mode == BOND_MODE_ALB;
}

static inline bool bond_mode_uses_arp(int mode)
{
	return mode != BOND_MODE_8023AD && mode != BOND_MODE_TLB &&
	       mode != BOND_MODE_ALB;
}

static inline void bond_set_active_slave(struct slave *slave)
{
	if (slave->backup) {
		slave->backup = 0;
		rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
	}
}

static inline void bond_set_backup_slave(struct slave *slave)
{
	if (!slave->backup) {
		slave->backup = 1;
		rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
	}
}

static inline void bond_set_slave_state(struct slave *slave,
					int slave_state, bool notify)
{
	if (slave->backup == slave_state)
		return;

	slave->backup = slave_state;
	if (notify) {
		rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
		slave->should_notify = 0;
	} else {
		if (slave->should_notify)
			slave->should_notify = 0;
		else
			slave->should_notify = 1;
	}
}

static inline void bond_slave_state_change(struct bonding *bond)
{
	struct list_head *iter;
	struct slave *tmp;

	bond_for_each_slave(bond, tmp, iter) {
		if (tmp->link == BOND_LINK_UP)
			bond_set_active_slave(tmp);
		else if (tmp->link == BOND_LINK_DOWN)
			bond_set_backup_slave(tmp);
	}
}

static inline void bond_slave_state_notify(struct bonding *bond)
{
	struct list_head *iter;
	struct slave *tmp;

	bond_for_each_slave(bond, tmp, iter) {
		if (tmp->should_notify) {
			rtmsg_ifinfo(RTM_NEWLINK, tmp->dev, 0, GFP_ATOMIC);
			tmp->should_notify = 0;
		}
	}
}

static inline int bond_slave_state(struct slave *slave)
{
	return slave->backup;
}

static inline bool bond_is_active_slave(struct slave *slave)
{
	return !bond_slave_state(slave);
}

#define BOND_PRI_RESELECT_ALWAYS	0
#define BOND_PRI_RESELECT_BETTER	1
#define BOND_PRI_RESELECT_FAILURE	2

#define BOND_FOM_NONE			0
#define BOND_FOM_ACTIVE			1
#define BOND_FOM_FOLLOW			2

#define BOND_ARP_TARGETS_ANY		0
#define BOND_ARP_TARGETS_ALL		1

#define BOND_ARP_VALIDATE_NONE		0
#define BOND_ARP_VALIDATE_ACTIVE	(1 << BOND_STATE_ACTIVE)
#define BOND_ARP_VALIDATE_BACKUP	(1 << BOND_STATE_BACKUP)
#define BOND_ARP_VALIDATE_ALL		(BOND_ARP_VALIDATE_ACTIVE | \
					 BOND_ARP_VALIDATE_BACKUP)
#define BOND_ARP_FILTER			(BOND_ARP_VALIDATE_ALL + 1)
#define BOND_ARP_FILTER_ACTIVE		(BOND_ARP_VALIDATE_ACTIVE | \
					 BOND_ARP_FILTER)
#define BOND_ARP_FILTER_BACKUP		(BOND_ARP_VALIDATE_BACKUP | \
					 BOND_ARP_FILTER)

#define BOND_SLAVE_NOTIFY_NOW		true
#define BOND_SLAVE_NOTIFY_LATER		false

static inline int slave_do_arp_validate(struct bonding *bond,
					struct slave *slave)
{
	return bond->params.arp_validate & (1 << bond_slave_state(slave));
}

static inline int slave_do_arp_validate_only(struct bonding *bond)
{
	return bond->params.arp_validate & BOND_ARP_FILTER;
}

/* Get the oldest arp which we've received on this slave for bond's
 * arp_targets.
 */
static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
						       struct slave *slave)
{
	int i = 1;
	unsigned long ret = slave->target_last_arp_rx[0];

	for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
		if (time_before(slave->target_last_arp_rx[i], ret))
			ret = slave->target_last_arp_rx[i];

	return ret;
}

static inline unsigned long slave_last_rx(struct bonding *bond,
					struct slave *slave)
{
	if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
		return slave_oldest_target_arp_rx(bond, slave);

	return slave->last_rx;
}

#ifdef CONFIG_NET_POLL_CONTROLLER
static inline void bond_netpoll_send_skb(const struct slave *slave,
					 struct sk_buff *skb)
{
	struct netpoll *np = slave->np;

	if (np)
		netpoll_send_skb(np, skb);
}
#else
static inline void bond_netpoll_send_skb(const struct slave *slave,
					 struct sk_buff *skb)
{
}
#endif

static inline void bond_set_slave_inactive_flags(struct slave *slave,
						 bool notify)
{
	if (!bond_is_lb(slave->bond))
		bond_set_slave_state(slave, BOND_STATE_BACKUP, notify);
	if (!slave->bond->params.all_slaves_active)
		slave->inactive = 1;
}

static inline void bond_set_slave_active_flags(struct slave *slave,
					       bool notify)
{
	bond_set_slave_state(slave, BOND_STATE_ACTIVE, notify);
	slave->inactive = 0;
}

static inline bool bond_is_slave_inactive(struct slave *slave)
{
	return slave->inactive;
}

static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
{
	struct in_device *in_dev;
	__be32 addr = 0;

	rcu_read_lock();
	in_dev = __in_dev_get_rcu(dev);

	if (in_dev)
		addr = inet_confirm_addr(dev_net(dev), in_dev, dst, local,
					 RT_SCOPE_HOST);
	rcu_read_unlock();
	return addr;
}

static inline bool slave_can_tx(struct slave *slave)
{
	if (IS_UP(slave->dev) && slave->link == BOND_LINK_UP &&
	    bond_is_active_slave(slave))
		return true;
	else
		return false;
}

struct bond_net {
	struct net		*net;	/* Associated network namespace */
	struct list_head	dev_list;
#ifdef CONFIG_PROC_FS
	struct proc_dir_entry	*proc_dir;
#endif
	struct class_attribute	class_attr_bonding_masters;
};

int bond_arp_rcv(const struct sk_buff *skb, struct bonding *bond, struct slave *slave);
void bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
int bond_create(struct net *net, const char *name);
int bond_create_sysfs(struct bond_net *net);
void bond_destroy_sysfs(struct bond_net *net);
void bond_prepare_sysfs_group(struct bonding *bond);
int bond_sysfs_slave_add(struct slave *slave);
void bond_sysfs_slave_del(struct slave *slave);
int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
u32 bond_xmit_hash(struct bonding *bond, struct sk_buff *skb);
void bond_select_active_slave(struct bonding *bond);
void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
void bond_create_debugfs(void);
void bond_destroy_debugfs(void);
void bond_debug_register(struct bonding *bond);
void bond_debug_unregister(struct bonding *bond);
void bond_debug_reregister(struct bonding *bond);
const char *bond_mode_name(int mode);
void bond_setup(struct net_device *bond_dev);
unsigned int bond_get_num_tx_queues(void);
int bond_netlink_init(void);
void bond_netlink_fini(void);
struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond);
struct net_device *bond_option_active_slave_get(struct bonding *bond);
const char *bond_slave_link_status(s8 link);

#ifdef CONFIG_PROC_FS
void bond_create_proc_entry(struct bonding *bond);
void bond_remove_proc_entry(struct bonding *bond);
void bond_create_proc_dir(struct bond_net *bn);
void bond_destroy_proc_dir(struct bond_net *bn);
#else
static inline void bond_create_proc_entry(struct bonding *bond)
{
}

static inline void bond_remove_proc_entry(struct bonding *bond)
{
}

static inline void bond_create_proc_dir(struct bond_net *bn)
{
}

static inline void bond_destroy_proc_dir(struct bond_net *bn)
{
}
#endif

static inline struct slave *bond_slave_has_mac(struct bonding *bond,
					       const u8 *mac)
{
	struct list_head *iter;
	struct slave *tmp;

	bond_for_each_slave(bond, tmp, iter)
		if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
			return tmp;

	return NULL;
}

/* Caller must hold rcu_read_lock() for read */
static inline struct slave *bond_slave_has_mac_rcu(struct bonding *bond,
					       const u8 *mac)
{
	struct list_head *iter;
	struct slave *tmp;

	bond_for_each_slave_rcu(bond, tmp, iter)
		if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
			return tmp;

	return NULL;
}

/* Check if the ip is present in arp ip list, or first free slot if ip == 0
 * Returns -1 if not found, index if found
 */
static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
{
	int i;

	for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
		if (targets[i] == ip)
			return i;
		else if (targets[i] == 0)
			break;

	return -1;
}

/* exported from bond_main.c */
extern int bond_net_id;
extern const struct bond_parm_tbl bond_lacp_tbl[];
extern const struct bond_parm_tbl xmit_hashtype_tbl[];
extern const struct bond_parm_tbl arp_validate_tbl[];
extern const struct bond_parm_tbl arp_all_targets_tbl[];
extern const struct bond_parm_tbl fail_over_mac_tbl[];
extern const struct bond_parm_tbl pri_reselect_tbl[];
extern struct bond_parm_tbl ad_select_tbl[];

/* exported from bond_netlink.c */
extern struct rtnl_link_ops bond_link_ops;

#endif /* _LINUX_BONDING_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
	3	*
	4	* Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
	5	* NCM: Network and Communications Management, Inc.
	6	*
	7	* BUT, I'm the one who modified it for ethernet, so:
	8	* (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
	9	*
	10	* This software may be used and distributed according to the terms
	11	* of the GNU Public License, incorporated herein by reference.
	12	*
1da177e4 LT	13	*/
	14
	15	#ifndef _LINUX_BONDING_H
	16	#define _LINUX_BONDING_H
	17
	18	#include <linux/timer.h>
	19	#include <linux/proc_fs.h>
	20	#include <linux/if_bonding.h>
e843fa50	21	#include <linux/cpumask.h>
305d552a	22	#include <linux/in6.h>
8a8efa22	23	#include <linux/netpoll.h>
eaddcd76	24	#include <linux/inetdevice.h>
567b871e	25	#include <linux/etherdevice.h>
809fa972 HFS	26	#include <linux/reciprocal_div.h>
809fa972 HFS	27
1da177e4 LT	28	#include "bond_3ad.h"
1da177e4 LT	29	#include "bond_alb.h"
09117362	30	#include "bond_options.h"
1da177e4	31
ad246c99 BH	32	#define DRV_VERSION "3.7.1"
ad246c99 BH	33	#define DRV_RELDATE "April 27, 2011"
1da177e4 LT	34	#define DRV_NAME "bonding"
	35	#define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
	36
bd33acc3 AW	37	#define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
bd33acc3 AW	38
1da177e4 LT	39	#define BOND_MAX_ARP_TARGETS 16
1da177e4 LT	40
fe9d04af	41	#define BOND_DEFAULT_MIIMON 100
fe9d04af	42
1da177e4 LT	43	#define IS_UP(dev) \
	44	((((dev)->flags & IFF_UP) == IFF_UP) && \
	45	netif_running(dev) && \
	46	netif_carrier_ok(dev))
	47
1da177e4 LT	48	/*
	49	* Checks whether slave is ready for transmit.
	50	*/
	51	#define SLAVE_IS_OK(slave) \
	52	(((slave)->dev->flags & IFF_UP) && \
	53	netif_running((slave)->dev) && \
	54	((slave)->link == BOND_LINK_UP) && \
e30bc066	55	bond_is_active_slave(slave))
1da177e4 LT	56
	57
	58	#define USES_PRIMARY(mode) \
	59	(((mode) == BOND_MODE_ACTIVEBACKUP) \|\| \
	60	((mode) == BOND_MODE_TLB) \|\| \
	61	((mode) == BOND_MODE_ALB))
	62
f9de11a1 WW	63	#define IS_IP_TARGET_UNUSABLE_ADDRESS(a) \
	64	((htonl(INADDR_BROADCAST) == a) \|\| \
	65	ipv4_is_zeronet(a))
1da177e4 LT	66	/*
	67	* Less bad way to call ioctl from within the kernel; this needs to be
	68	* done some other way to get the call out of interrupt context.
	69	* Needs "ioctl" variable to be supplied by calling context.
	70	*/
	71	#define IOCTL(dev, arg, cmd) ({ \
	72	int res = 0; \
	73	mm_segment_t fs = get_fs(); \
	74	set_fs(get_ds()); \
	75	res = ioctl(dev, arg, cmd); \
	76	set_fs(fs); \
	77	res; })
	78
dec1e90e	79	/* slave list primitives */
5a52405a VF	80	#define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
	81
	82	#define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
0965a1f3	83
dec1e90e	84	/* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
dec1e90e	85	#define bond_first_slave(bond) \
5a52405a VF	86	(bond_has_slaves(bond) ? \
	87	netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
	88	NULL)
dec1e90e	89	#define bond_last_slave(bond) \
5a52405a VF	90	(bond_has_slaves(bond) ? \
	91	netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
	92	NULL)
dec1e90e	93
e001bfad	94	/* Caller must have rcu_read_lock */
	95	#define bond_first_slave_rcu(bond) \
	96	netdev_lower_get_first_private_rcu(bond->dev)
	97
5a52405a VF	98	#define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
5a52405a VF	99	#define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
dec1e90e	100
1da177e4	101	/**
dec1e90e	102	* bond_for_each_slave - iterate over all slaves
	103	* @bond: the bond holding this list
	104	* @pos: current slave
9caff1e7	105	* @iter: list_head * iterator
1da177e4 LT	106	*
	107	* Caller must hold bond->lock
	108	*/
9caff1e7 VF	109	#define bond_for_each_slave(bond, pos, iter) \
9caff1e7 VF	110	netdev_for_each_lower_private((bond)->dev, pos, iter)
1da177e4	111
278b2083	112	/* Caller must have rcu_read_lock */
9caff1e7 VF	113	#define bond_for_each_slave_rcu(bond, pos, iter) \
9caff1e7 VF	114	netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
278b2083	115
e843fa50	116	#ifdef CONFIG_NET_POLL_CONTROLLER
fb4fa76a	117	extern atomic_t netpoll_block_tx;
e843fa50 NH	118
	119	static inline void block_netpoll_tx(void)
	120	{
fb4fa76a	121	atomic_inc(&netpoll_block_tx);
e843fa50 NH	122	}
	123
	124	static inline void unblock_netpoll_tx(void)
	125	{
fb4fa76a	126	atomic_dec(&netpoll_block_tx);
e843fa50 NH	127	}
	128
	129	static inline int is_netpoll_tx_blocked(struct net_device *dev)
	130	{
080e4130	131	if (unlikely(netpoll_tx_running(dev)))
fb4fa76a	132	return atomic_read(&netpoll_block_tx);
e843fa50 NH	133	return 0;
	134	}
	135	#else
	136	#define block_netpoll_tx()
	137	#define unblock_netpoll_tx()
	138	#define is_netpoll_tx_blocked(dev) (0)
	139	#endif
	140
1da177e4 LT	141	struct bond_params {
1da177e4 LT	142	int mode;
169a3e66	143	int xmit_policy;
1da177e4	144	int miimon;
ad246c99	145	u8 num_peer_notif;
1da177e4	146	int arp_interval;
f5b2b966	147	int arp_validate;
8599b52e	148	int arp_all_targets;
1da177e4	149	int use_carrier;
dd957c57	150	int fail_over_mac;
1da177e4 LT	151	int updelay;
	152	int downdelay;
	153	int lacp_fast;
655f8919	154	unsigned int min_links;
fd989c83	155	int ad_select;
1da177e4	156	char primary[IFNAMSIZ];
a549952a	157	int primary_reselect;
d3bb52b0	158	__be32 arp_targets[BOND_MAX_ARP_TARGETS];
bb1d9123	159	int tx_queues;
ebd8e497	160	int all_slaves_active;
c2952c31	161	int resend_igmp;
7eacd038	162	int lp_interval;
73958329	163	int packets_per_slave;
e9f0fb88	164	int tlb_dynamic_lb;
809fa972	165	struct reciprocal_value reciprocal_packets_per_slave;
1da177e4 LT	166	};
1da177e4 LT	167
12479f9a MW	168	struct bond_parm_tbl {
	169	char *modename;
	170	int mode;
	171	};
	172
1da177e4	173	struct slave {
e944ef79	174	struct net_device dev; / first - useful for panic debug */
35d48903	175	struct bonding bond; / our master */
8bb5f96b	176	int delay;
8e603460 VF	177	/* all three in jiffies */
8e603460 VF	178	unsigned long last_link_up;
49f17de7	179	unsigned long last_rx;
8599b52e	180	unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
1da177e4	181	s8 link; /* one of BOND_LINK_XXXX */
b2220cad	182	s8 new_link;
2d7011ca JP	183	u8 backup:1, /* indicates backup slave. Value corresponds with
2d7011ca JP	184	BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
5e5b0665	185	inactive:1, /* indicates inactive slave */
5e5b0665	186	should_notify:1; /* indicateds whether the state changed */
5d30530e	187	u8 duplex;
3158bf7d	188	u32 original_mtu;
1da177e4	189	u32 link_failure_count;
5d30530e	190	u32 speed;
bb1d9123	191	u16 queue_id;
5d30530e	192	u8 perm_hwaddr[ETH_ALEN];
3fdddd85	193	struct ad_slave_info *ad_info;
1da177e4	194	struct tlb_slave_info tlb_info;
8a8efa22 AW	195	#ifdef CONFIG_NET_POLL_CONTROLLER
	196	struct netpoll *np;
	197	#endif
07699f9a	198	struct kobject kobj;
1da177e4 LT	199	};
1da177e4 LT	200
b2220cad JV	201	/*
	202	* Link pseudo-state only used internally by monitors
	203	*/
	204	#define BOND_LINK_NOCHANGE -1
	205
1da177e4 LT	206	/*
	207	* Here are the locking policies for the two bonding locks:
	208	*
	209	* 1) Get bond->lock when reading/writing slave list.
	210	* 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
	211	* (It is unnecessary when the write-lock is put with bond->lock.)
	212	* 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
	213	* beforehand.
	214	*/
	215	struct bonding {
e944ef79	216	struct net_device dev; / first - useful for panic debug */
1da177e4 LT	217	struct slave *curr_active_slave;
	218	struct slave *current_arp_slave;
	219	struct slave *primary_slave;
a549952a	220	bool force_primary;
1da177e4	221	s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
de063b70 ED	222	int (recv_probe)(const struct sk_buff , struct bonding *,
de063b70 ED	223	struct slave *);
1da177e4 LT	224	rwlock_t lock;
1da177e4 LT	225	rwlock_t curr_slave_lock;
ad246c99	226	u8 send_peer_notif;
4f5474e7	227	u8 igmp_retrans;
1da177e4 LT	228	#ifdef CONFIG_PROC_FS
	229	struct proc_dir_entry *proc_entry;
	230	char proc_file_name[IFNAMSIZ];
	231	#endif /* CONFIG_PROC_FS */
	232	struct list_head bond_list;
73958329	233	u32 rr_tx_counter;
1da177e4 LT	234	struct ad_bond_info ad_info;
	235	struct alb_bond_info alb_info;
	236	struct bond_params params;
1b76b316 JV	237	struct workqueue_struct *wq;
	238	struct delayed_work mii_work;
	239	struct delayed_work arp_work;
	240	struct delayed_work alb_work;
	241	struct delayed_work ad_work;
5a37e8ca	242	struct delayed_work mcast_work;
f073c7ca	243	#ifdef CONFIG_DEBUG_FS
02582e9b	244	/* debugging support via debugfs */
f073c7ca TI	245	struct dentry *debug_dir;
f073c7ca TI	246	#endif /* CONFIG_DEBUG_FS */
1da177e4 LT	247	};
1da177e4 LT	248
f1c1775a JP	249	#define bond_slave_get_rcu(dev) \
	250	((struct slave *) rcu_dereference(dev->rx_handler_data))
	251
471cb5a3 JP	252	#define bond_slave_get_rtnl(dev) \
	253	((struct slave *) rtnl_dereference(dev->rx_handler_data))
	254
fbd929f2	255	struct bond_vlan_tag {
	256	__be16 vlan_proto;
	257	unsigned short vlan_id;
	258	};
	259
1da177e4 LT	260	/**
	261	* Returns NULL if the net_device does not belong to any of the bond's slaves
	262	*
	263	* Caller must hold bond lock for read
	264	*/
4ec952b8	265	static inline struct slave bond_get_slave_by_dev(struct bonding bond,
4ec952b8	266	struct net_device *slave_dev)
1da177e4	267	{
46bb4807	268	return netdev_lower_dev_get_private(bond->dev, slave_dev);
1da177e4 LT	269	}
1da177e4 LT	270
cceb904f	271	static inline struct bonding bond_get_bond_by_slave(struct slave slave)
1da177e4	272	{
471cb5a3	273	if (!slave \|\| !slave->bond)
1da177e4	274	return NULL;
471cb5a3	275	return slave->bond;
1da177e4 LT	276	}
1da177e4 LT	277
d1e2e5cd VF	278	static inline bool bond_should_override_tx_queue(struct bonding *bond)
	279	{
	280	return bond->params.mode == BOND_MODE_ACTIVEBACKUP \|\|
	281	bond->params.mode == BOND_MODE_ROUNDROBIN;
	282	}
	283
58402054 HE	284	static inline bool bond_is_lb(const struct bonding *bond)
58402054 HE	285	{
befb903a VF	286	return bond->params.mode == BOND_MODE_TLB \|\|
befb903a VF	287	bond->params.mode == BOND_MODE_ALB;
58402054 HE	288	}
58402054 HE	289
267bed77 VF	290	static inline bool bond_mode_uses_arp(int mode)
	291	{
	292	return mode != BOND_MODE_8023AD && mode != BOND_MODE_TLB &&
	293	mode != BOND_MODE_ALB;
	294	}
	295
e30bc066 JP	296	static inline void bond_set_active_slave(struct slave *slave)
e30bc066 JP	297	{
1d3ee88a	298	if (slave->backup) {
1d3ee88a	299	slave->backup = 0;
072256d1	300	rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
1d3ee88a	301	}
e30bc066 JP	302	}
	303
	304	static inline void bond_set_backup_slave(struct slave *slave)
	305	{
1d3ee88a	306	if (!slave->backup) {
1d3ee88a	307	slave->backup = 1;
072256d1	308	rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
1d3ee88a	309	}
e30bc066 JP	310	}
e30bc066 JP	311
5e5b0665	312	static inline void bond_set_slave_state(struct slave *slave,
	313	int slave_state, bool notify)
	314	{
	315	if (slave->backup == slave_state)
	316	return;
	317
	318	slave->backup = slave_state;
	319	if (notify) {
072256d1	320	rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
5e5b0665	321	slave->should_notify = 0;
	322	} else {
	323	if (slave->should_notify)
	324	slave->should_notify = 0;
	325	else
	326	slave->should_notify = 1;
	327	}
	328	}
	329
6fde8f03 DT	330	static inline void bond_slave_state_change(struct bonding *bond)
	331	{
	332	struct list_head *iter;
	333	struct slave *tmp;
	334
	335	bond_for_each_slave(bond, tmp, iter) {
	336	if (tmp->link == BOND_LINK_UP)
	337	bond_set_active_slave(tmp);
	338	else if (tmp->link == BOND_LINK_DOWN)
	339	bond_set_backup_slave(tmp);
	340	}
	341	}
	342
b0929915	343	static inline void bond_slave_state_notify(struct bonding *bond)
	344	{
	345	struct list_head *iter;
	346	struct slave *tmp;
	347
	348	bond_for_each_slave(bond, tmp, iter) {
	349	if (tmp->should_notify) {
072256d1	350	rtmsg_ifinfo(RTM_NEWLINK, tmp->dev, 0, GFP_ATOMIC);
b0929915	351	tmp->should_notify = 0;
	352	}
	353	}
	354	}
	355
e30bc066 JP	356	static inline int bond_slave_state(struct slave *slave)
	357	{
	358	return slave->backup;
	359	}
	360
	361	static inline bool bond_is_active_slave(struct slave *slave)
	362	{
	363	return !bond_slave_state(slave);
	364	}
	365
a549952a JP	366	#define BOND_PRI_RESELECT_ALWAYS 0
	367	#define BOND_PRI_RESELECT_BETTER 1
	368	#define BOND_PRI_RESELECT_FAILURE 2
	369
3915c1e8 JV	370	#define BOND_FOM_NONE 0
	371	#define BOND_FOM_ACTIVE 1
	372	#define BOND_FOM_FOLLOW 2
	373
8599b52e VF	374	#define BOND_ARP_TARGETS_ANY 0
	375	#define BOND_ARP_TARGETS_ALL 1
	376
f5b2b966 JV	377	#define BOND_ARP_VALIDATE_NONE 0
	378	#define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
	379	#define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
	380	#define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE \| \
	381	BOND_ARP_VALIDATE_BACKUP)
896149ff VF	382	#define BOND_ARP_FILTER (BOND_ARP_VALIDATE_ALL + 1)
	383	#define BOND_ARP_FILTER_ACTIVE (BOND_ARP_VALIDATE_ACTIVE \| \
	384	BOND_ARP_FILTER)
	385	#define BOND_ARP_FILTER_BACKUP (BOND_ARP_VALIDATE_BACKUP \| \
	386	BOND_ARP_FILTER)
f5b2b966	387
5e5b0665	388	#define BOND_SLAVE_NOTIFY_NOW true
	389	#define BOND_SLAVE_NOTIFY_LATER false
	390
079ca7da AB	391	static inline int slave_do_arp_validate(struct bonding *bond,
079ca7da AB	392	struct slave *slave)
f5b2b966	393	{
e30bc066	394	return bond->params.arp_validate & (1 << bond_slave_state(slave));
f5b2b966 JV	395	}
f5b2b966 JV	396
bedabf90	397	static inline int slave_do_arp_validate_only(struct bonding *bond)
896149ff VF	398	{
	399	return bond->params.arp_validate & BOND_ARP_FILTER;
	400	}
	401
8599b52e VF	402	/* Get the oldest arp which we've received on this slave for bond's
	403	* arp_targets.
	404	*/
	405	static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
	406	struct slave *slave)
	407	{
	408	int i = 1;
	409	unsigned long ret = slave->target_last_arp_rx[0];
	410
	411	for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
	412	if (time_before(slave->target_last_arp_rx[i], ret))
	413	ret = slave->target_last_arp_rx[i];
	414
	415	return ret;
	416	}
	417
079ca7da	418	static inline unsigned long slave_last_rx(struct bonding *bond,
f8a8ccd5	419	struct slave *slave)
f5b2b966	420	{
9f242738 VF	421	if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
9f242738 VF	422	return slave_oldest_target_arp_rx(bond, slave);
f5b2b966	423
49f17de7	424	return slave->last_rx;
f5b2b966 JV	425	}
f5b2b966 JV	426
8a8efa22 AW	427	#ifdef CONFIG_NET_POLL_CONTROLLER
	428	static inline void bond_netpoll_send_skb(const struct slave *slave,
	429	struct sk_buff *skb)
	430	{
	431	struct netpoll *np = slave->np;
	432
	433	if (np)
	434	netpoll_send_skb(np, skb);
	435	}
	436	#else
	437	static inline void bond_netpoll_send_skb(const struct slave *slave,
	438	struct sk_buff *skb)
	439	{
	440	}
	441	#endif
	442
5e5b0665	443	static inline void bond_set_slave_inactive_flags(struct slave *slave,
5e5b0665	444	bool notify)
1da177e4	445	{
471cb5a3	446	if (!bond_is_lb(slave->bond))
5e5b0665	447	bond_set_slave_state(slave, BOND_STATE_BACKUP, notify);
471cb5a3	448	if (!slave->bond->params.all_slaves_active)
2d7011ca	449	slave->inactive = 1;
1da177e4 LT	450	}
1da177e4 LT	451
5e5b0665	452	static inline void bond_set_slave_active_flags(struct slave *slave,
5e5b0665	453	bool notify)
1da177e4	454	{
5e5b0665	455	bond_set_slave_state(slave, BOND_STATE_ACTIVE, notify);
2d7011ca JP	456	slave->inactive = 0;
	457	}
	458
	459	static inline bool bond_is_slave_inactive(struct slave *slave)
	460	{
	461	return slave->inactive;
1da177e4 LT	462	}
1da177e4 LT	463
eaddcd76 AG	464	static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
	465	{
	466	struct in_device *in_dev;
	467	__be32 addr = 0;
	468
	469	rcu_read_lock();
	470	in_dev = __in_dev_get_rcu(dev);
	471
	472	if (in_dev)
b601fa19 ND	473	addr = inet_confirm_addr(dev_net(dev), in_dev, dst, local,
b601fa19 ND	474	RT_SCOPE_HOST);
eaddcd76 AG	475	rcu_read_unlock();
	476	return addr;
	477	}
	478
15077228 NA	479	static inline bool slave_can_tx(struct slave *slave)
	480	{
	481	if (IS_UP(slave->dev) && slave->link == BOND_LINK_UP &&
	482	bond_is_active_slave(slave))
	483	return true;
	484	else
	485	return false;
	486	}
	487
31924325	488	struct bond_net {
	489	struct net net; / Associated network namespace */
	490	struct list_head dev_list;
	491	#ifdef CONFIG_PROC_FS
	492	struct proc_dir_entry *proc_dir;
	493	#endif
	494	struct class_attribute class_attr_bonding_masters;
	495	};
4c22400a	496
5bb9e0b5	497	int bond_arp_rcv(const struct sk_buff skb, struct bonding bond, struct slave *slave);
d316dedd	498	void bond_dev_queue_xmit(struct bonding bond, struct sk_buff skb, struct net_device *slave_dev);
ec87fd3b	499	int bond_create(struct net net, const char name);
4c22400a EB	500	int bond_create_sysfs(struct bond_net *net);
4c22400a EB	501	void bond_destroy_sysfs(struct bond_net *net);
6151b3d4	502	void bond_prepare_sysfs_group(struct bonding *bond);
07699f9a	503	int bond_sysfs_slave_add(struct slave *slave);
07699f9a	504	void bond_sysfs_slave_del(struct slave *slave);
a77b5325 MW	505	int bond_enslave(struct net_device bond_dev, struct net_device slave_dev);
a77b5325 MW	506	int bond_release(struct net_device bond_dev, struct net_device slave_dev);
ee62e868	507	u32 bond_xmit_hash(struct bonding bond, struct sk_buff skb);
a77b5325 MW	508	void bond_select_active_slave(struct bonding *bond);
a77b5325 MW	509	void bond_change_active_slave(struct bonding bond, struct slave new_active);
f073c7ca TI	510	void bond_create_debugfs(void);
	511	void bond_destroy_debugfs(void);
	512	void bond_debug_register(struct bonding *bond);
	513	void bond_debug_unregister(struct bonding *bond);
	514	void bond_debug_reregister(struct bonding *bond);
d30ee670	515	const char *bond_mode_name(int mode);
0a2a78c4 JP	516	void bond_setup(struct net_device *bond_dev);
	517	unsigned int bond_get_num_tx_queues(void);
	518	int bond_netlink_init(void);
	519	void bond_netlink_fini(void);
752d48b5 JP	520	struct net_device bond_option_active_slave_get_rcu(struct bonding bond);
752d48b5 JP	521	struct net_device bond_option_active_slave_get(struct bonding bond);
07699f9a	522	const char *bond_slave_link_status(s8 link);
1da177e4	523
bd33acc3 AW	524	#ifdef CONFIG_PROC_FS
	525	void bond_create_proc_entry(struct bonding *bond);
	526	void bond_remove_proc_entry(struct bonding *bond);
	527	void bond_create_proc_dir(struct bond_net *bn);
	528	void bond_destroy_proc_dir(struct bond_net *bn);
	529	#else
	530	static inline void bond_create_proc_entry(struct bonding *bond)
	531	{
	532	}
	533
	534	static inline void bond_remove_proc_entry(struct bonding *bond)
	535	{
	536	}
	537
	538	static inline void bond_create_proc_dir(struct bond_net *bn)
	539	{
	540	}
	541
	542	static inline void bond_destroy_proc_dir(struct bond_net *bn)
	543	{
	544	}
	545	#endif
	546
567b871e	547	static inline struct slave bond_slave_has_mac(struct bonding bond,
	548	const u8 *mac)
	549	{
9caff1e7	550	struct list_head *iter;
567b871e	551	struct slave *tmp;
567b871e	552
9caff1e7	553	bond_for_each_slave(bond, tmp, iter)
567b871e	554	if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
	555	return tmp;
	556
	557	return NULL;
	558	}
bd33acc3	559
28c71926	560	/* Caller must hold rcu_read_lock() for read */
	561	static inline struct slave bond_slave_has_mac_rcu(struct bonding bond,
	562	const u8 *mac)
	563	{
	564	struct list_head *iter;
	565	struct slave *tmp;
	566
	567	bond_for_each_slave_rcu(bond, tmp, iter)
	568	if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
	569	return tmp;
	570
	571	return NULL;
	572	}
	573
87a7b84b VF	574	/* Check if the ip is present in arp ip list, or first free slot if ip == 0
	575	* Returns -1 if not found, index if found
	576	*/
	577	static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
	578	{
	579	int i;
	580
	581	for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
	582	if (targets[i] == ip)
	583	return i;
	584	else if (targets[i] == 0)
	585	break;
	586
	587	return -1;
	588	}
	589
b2259672	590	/* exported from bond_main.c */
ec87fd3b	591	extern int bond_net_id;
e97fd7c6	592	extern const struct bond_parm_tbl bond_lacp_tbl[];
e97fd7c6 HE	593	extern const struct bond_parm_tbl xmit_hashtype_tbl[];
e97fd7c6 HE	594	extern const struct bond_parm_tbl arp_validate_tbl[];
8599b52e	595	extern const struct bond_parm_tbl arp_all_targets_tbl[];
e97fd7c6	596	extern const struct bond_parm_tbl fail_over_mac_tbl[];
a549952a	597	extern const struct bond_parm_tbl pri_reselect_tbl[];
b06715b7 HE	598	extern struct bond_parm_tbl ad_select_tbl[];
b06715b7 HE	599
0a2a78c4 JP	600	/* exported from bond_netlink.c */
	601	extern struct rtnl_link_ops bond_link_ops;
	602
1da177e4	603	#endif /* _LINUX_BONDING_H */