[linux-2.6-block.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 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; })

#define BOND_MODE(bond) ((bond)->params.mode)

/* 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_MODE(bond) == BOND_MODE_ACTIVEBACKUP ||
	       BOND_MODE(bond) == BOND_MODE_ROUNDROBIN;
}

static inline bool bond_is_lb(const struct bonding *bond)
{
	return BOND_MODE(bond) == BOND_MODE_TLB ||
	       BOND_MODE(bond) == 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 bool bond_mode_uses_primary(int mode)
{
	return mode == BOND_MODE_ACTIVEBACKUP || mode == BOND_MODE_TLB ||
	       mode == BOND_MODE_ALB;
}

static inline bool bond_uses_primary(struct bonding *bond)
{
	return bond_mode_uses_primary(BOND_MODE(bond));
}

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