[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_VLAN_ENCAP	2
#define BOND_MAX_ARP_TARGETS	16

#define BOND_DEFAULT_MIIMON	100

/*
 * 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 __rcu *curr_active_slave;
	struct   slave __rcu *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))

#define bond_deref_active_protected(bond)				   \
	rcu_dereference_protected(bond->curr_active_slave,		   \
				  lockdep_is_held(&bond->curr_slave_lock))

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)
{
	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 bool bond_slave_is_up(struct slave *slave)
{
	return netif_running(slave->dev) && netif_carrier_ok(slave->dev);
}

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

static inline bool bond_slave_can_tx(struct slave *slave)
{
	return bond_slave_is_up(slave) && slave->link == BOND_LINK_UP &&
	       bond_is_active_slave(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;
}

static inline int bond_is_ip_target_ok(__be32 addr)
{
	return !ipv4_is_lbcast(addr) && !ipv4_is_zeronet(addr);
}

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

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);
const char *bond_slave_link_status(s8 link);
bool bond_verify_device_path(struct net_device *start_dev,
			     struct net_device *end_dev,
			     struct bond_vlan_tag *tags);

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

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

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

	if (netdev_uc_empty(bond->dev))
		return false;

	netdev_for_each_uc_addr(ha, bond->dev)
		if (ether_addr_equal_64bits(mac, ha->addr))
			return true;

	return false;
}

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