[mirror_ubuntu-bionic-kernel.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 BOND_NO_USES_ARP(mode)				\
		(((mode) == BOND_MODE_8023AD)	||	\
		 ((mode) == BOND_MODE_TLB)	||	\
		 ((mode) == BOND_MODE_ALB))

#define TX_QUEUE_OVERRIDE(mode)				\
			(((mode) == BOND_MODE_ACTIVEBACKUP) ||	\
			 ((mode) == BOND_MODE_ROUNDROBIN))

#define BOND_MODE_IS_LB(mode)			\
		(((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;
	struct reciprocal_value reciprocal_packets_per_slave;
};

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

#define BOND_MAX_MODENAME_LEN 20

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_arp_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 */
	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; /* HUGE - better to dynamically alloc */
	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))

/**
 * 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_is_lb(const struct bonding *bond)
{
	return BOND_MODE_IS_LB(bond->params.mode);
}

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

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

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

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,
					     struct slave *slave)
{
	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_arp_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)
{
	if (!bond_is_lb(slave->bond))
		bond_set_backup_slave(slave);
	if (!slave->bond->params.all_slaves_active)
		slave->inactive = 1;
}

static inline void bond_set_slave_active_flags(struct slave *slave)
{
	bond_set_active_slave(slave);
	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;

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);
int bond_xmit_hash(struct bonding *bond, struct sk_buff *skb, int count);
int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
int bond_parm_tbl_lookup(int mode, const struct bond_parm_tbl *tbl);
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);
int bond_option_arp_ip_target_add(struct bonding *bond, __be32 target);
int bond_option_arp_ip_target_rem(struct bonding *bond, __be32 target);
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);

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

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