bonding.h 13.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 * 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>
21
#include <linux/cpumask.h>
22
#include <linux/in6.h>
23
#include <linux/netpoll.h>
24
#include <linux/inetdevice.h>
25
#include <linux/etherdevice.h>
L
Linus Torvalds 已提交
26 27 28
#include "bond_3ad.h"
#include "bond_alb.h"

29 30
#define DRV_VERSION	"3.7.1"
#define DRV_RELDATE	"April 27, 2011"
L
Linus Torvalds 已提交
31 32 33
#define DRV_NAME	"bonding"
#define DRV_DESCRIPTION	"Ethernet Channel Bonding Driver"

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

L
Linus Torvalds 已提交
36 37 38 39 40 41 42 43 44 45 46 47 48 49
#define BOND_MAX_ARP_TARGETS	16

#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) && \
J
Jiri Pirko 已提交
50
		     bond_is_active_slave(slave))
L
Linus Torvalds 已提交
51 52 53 54 55 56 57


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

58 59 60
#define TX_QUEUE_OVERRIDE(mode)				\
			(((mode) == BOND_MODE_ACTIVEBACKUP) ||	\
			 ((mode) == BOND_MODE_ROUNDROBIN))
L
Linus Torvalds 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
/*
 * 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; })

/**
 * bond_for_each_slave_from - iterate the slaves list from a starting point
 * @bond:	the bond holding this list.
 * @pos:	current slave.
 * @cnt:	counter for max number of moves
 * @start:	starting point.
 *
 * Caller must hold bond->lock
 */
#define bond_for_each_slave_from(bond, pos, cnt, start)	\
	for (cnt = 0, pos = start;				\
	     cnt < (bond)->slave_cnt;				\
             cnt++, pos = (pos)->next)

/**
 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
 * @bond:	the bond holding this list.
 * @pos:	current slave.
 * @cnt:	counter for number max of moves
 * @start:	start point.
 * @stop:	stop point.
 *
 * Caller must hold bond->lock
 */
#define bond_for_each_slave_from_to(bond, pos, cnt, start, stop)	\
	for (cnt = 0, pos = start;					\
	     ((cnt < (bond)->slave_cnt) && (pos != (stop)->next));	\
             cnt++, pos = (pos)->next)

/**
 * bond_for_each_slave - iterate the slaves list from head
 * @bond:	the bond holding this list.
 * @pos:	current slave.
 * @cnt:	counter for max number of moves
 *
 * Caller must hold bond->lock
 */
#define bond_for_each_slave(bond, pos, cnt)	\
		bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)


115
#ifdef CONFIG_NET_POLL_CONTROLLER
116
extern atomic_t netpoll_block_tx;
117 118 119

static inline void block_netpoll_tx(void)
{
120
	atomic_inc(&netpoll_block_tx);
121 122 123 124
}

static inline void unblock_netpoll_tx(void)
{
125
	atomic_dec(&netpoll_block_tx);
126 127 128 129
}

static inline int is_netpoll_tx_blocked(struct net_device *dev)
{
130
	if (unlikely(netpoll_tx_running(dev)))
131
		return atomic_read(&netpoll_block_tx);
132 133 134 135 136 137 138 139
	return 0;
}
#else
#define block_netpoll_tx()
#define unblock_netpoll_tx()
#define is_netpoll_tx_blocked(dev) (0)
#endif

L
Linus Torvalds 已提交
140 141
struct bond_params {
	int mode;
142
	int xmit_policy;
L
Linus Torvalds 已提交
143
	int miimon;
144
	u8 num_peer_notif;
L
Linus Torvalds 已提交
145
	int arp_interval;
146
	int arp_validate;
147
	int arp_all_targets;
L
Linus Torvalds 已提交
148
	int use_carrier;
149
	int fail_over_mac;
L
Linus Torvalds 已提交
150 151 152
	int updelay;
	int downdelay;
	int lacp_fast;
153
	unsigned int min_links;
154
	int ad_select;
L
Linus Torvalds 已提交
155
	char primary[IFNAMSIZ];
156
	int primary_reselect;
157
	__be32 arp_targets[BOND_MAX_ARP_TARGETS];
158
	int tx_queues;
159
	int all_slaves_active;
160
	int resend_igmp;
L
Linus Torvalds 已提交
161 162
};

163 164 165 166 167
struct bond_parm_tbl {
	char *modename;
	int mode;
};

J
Jay Vosburgh 已提交
168 169
#define BOND_MAX_MODENAME_LEN 20

L
Linus Torvalds 已提交
170 171 172 173 174 175
struct vlan_entry {
	struct list_head vlan_list;
	unsigned short vlan_id;
};

struct slave {
176
	struct net_device *dev; /* first - useful for panic debug */
L
Linus Torvalds 已提交
177 178
	struct slave *next;
	struct slave *prev;
J
Jiri Pirko 已提交
179
	struct bonding *bond; /* our master */
180
	int    delay;
181 182
	unsigned long jiffies;
	unsigned long last_arp_rx;
183
	unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
L
Linus Torvalds 已提交
184
	s8     link;    /* one of BOND_LINK_XXXX */
185
	s8     new_link;
186 187 188
	u8     backup:1,   /* indicates backup slave. Value corresponds with
			      BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
	       inactive:1; /* indicates inactive slave */
189
	u8     duplex;
190
	u32    original_mtu;
L
Linus Torvalds 已提交
191
	u32    link_failure_count;
192
	u32    speed;
193
	u16    queue_id;
194
	u8     perm_hwaddr[ETH_ALEN];
L
Linus Torvalds 已提交
195 196
	struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
	struct tlb_slave_info tlb_info;
197 198 199
#ifdef CONFIG_NET_POLL_CONTROLLER
	struct netpoll *np;
#endif
L
Linus Torvalds 已提交
200 201
};

202 203 204 205 206
/*
 * Link pseudo-state only used internally by monitors
 */
#define BOND_LINK_NOCHANGE -1

L
Linus Torvalds 已提交
207 208 209 210 211 212 213 214 215 216
/*
 * 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 {
217
	struct   net_device *dev; /* first - useful for panic debug */
L
Linus Torvalds 已提交
218 219 220 221
	struct   slave *first_slave;
	struct   slave *curr_active_slave;
	struct   slave *current_arp_slave;
	struct   slave *primary_slave;
222
	bool     force_primary;
L
Linus Torvalds 已提交
223
	s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
224 225
	int     (*recv_probe)(const struct sk_buff *, struct bonding *,
			      struct slave *);
L
Linus Torvalds 已提交
226 227
	rwlock_t lock;
	rwlock_t curr_slave_lock;
228
	u8	 send_peer_notif;
229
	u8       igmp_retrans;
L
Linus Torvalds 已提交
230 231 232 233 234
#ifdef CONFIG_PROC_FS
	struct   proc_dir_entry *proc_entry;
	char     proc_file_name[IFNAMSIZ];
#endif /* CONFIG_PROC_FS */
	struct   list_head bond_list;
235
	int      (*xmit_hash_policy)(struct sk_buff *, int);
236
	u16      rr_tx_counter;
L
Linus Torvalds 已提交
237 238 239 240
	struct   ad_bond_info ad_info;
	struct   alb_bond_info alb_info;
	struct   bond_params params;
	struct   list_head vlan_list;
241 242 243 244 245
	struct   workqueue_struct *wq;
	struct   delayed_work mii_work;
	struct   delayed_work arp_work;
	struct   delayed_work alb_work;
	struct   delayed_work ad_work;
246
	struct   delayed_work mcast_work;
247
#ifdef CONFIG_DEBUG_FS
248
	/* debugging support via debugfs */
249 250
	struct	 dentry *debug_dir;
#endif /* CONFIG_DEBUG_FS */
251
	bool	dev_addr_from_first;
L
Linus Torvalds 已提交
252 253
};

J
Jiri Pirko 已提交
254 255 256 257 258
static inline bool bond_vlan_used(struct bonding *bond)
{
	return !list_empty(&bond->vlan_list);
}

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

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

L
Linus Torvalds 已提交
265 266 267 268 269
/**
 * Returns NULL if the net_device does not belong to any of the bond's slaves
 *
 * Caller must hold bond lock for read
 */
S
stephen hemminger 已提交
270 271
static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
						  struct net_device *slave_dev)
L
Linus Torvalds 已提交
272 273 274 275 276 277
{
	struct slave *slave = NULL;
	int i;

	bond_for_each_slave(bond, slave, i) {
		if (slave->dev == slave_dev) {
H
Hillf Danton 已提交
278
			return slave;
L
Linus Torvalds 已提交
279 280 281
		}
	}

S
stephen hemminger 已提交
282
	return NULL;
L
Linus Torvalds 已提交
283 284
}

285
static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
L
Linus Torvalds 已提交
286
{
287
	if (!slave || !slave->bond)
L
Linus Torvalds 已提交
288
		return NULL;
289
	return slave->bond;
L
Linus Torvalds 已提交
290 291
}

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

J
Jiri Pirko 已提交
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
static inline void bond_set_active_slave(struct slave *slave)
{
	slave->backup = 0;
}

static inline void bond_set_backup_slave(struct slave *slave)
{
	slave->backup = 1;
}

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

318 319 320 321
#define BOND_PRI_RESELECT_ALWAYS	0
#define BOND_PRI_RESELECT_BETTER	1
#define BOND_PRI_RESELECT_FAILURE	2

322 323 324 325
#define BOND_FOM_NONE			0
#define BOND_FOM_ACTIVE			1
#define BOND_FOM_FOLLOW			2

326 327 328
#define BOND_ARP_TARGETS_ANY		0
#define BOND_ARP_TARGETS_ALL		1

329 330 331 332 333 334
#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)

335 336
static inline int slave_do_arp_validate(struct bonding *bond,
					struct slave *slave)
337
{
J
Jiri Pirko 已提交
338
	return bond->params.arp_validate & (1 << bond_slave_state(slave));
339 340
}

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
/* 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;
}

357
static inline unsigned long slave_last_rx(struct bonding *bond,
358
					struct slave *slave)
359
{
360 361 362 363 364 365
	if (slave_do_arp_validate(bond, slave)) {
		if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
			return slave_oldest_target_arp_rx(bond, slave);
		else
			return slave->last_arp_rx;
	}
366 367 368 369

	return slave->dev->last_rx;
}

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
#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

386
static inline void bond_set_slave_inactive_flags(struct slave *slave)
L
Linus Torvalds 已提交
387
{
388
	if (!bond_is_lb(slave->bond))
J
Jiri Pirko 已提交
389
		bond_set_backup_slave(slave);
390
	if (!slave->bond->params.all_slaves_active)
391
		slave->inactive = 1;
L
Linus Torvalds 已提交
392 393
}

394
static inline void bond_set_slave_active_flags(struct slave *slave)
L
Linus Torvalds 已提交
395
{
J
Jiri Pirko 已提交
396
	bond_set_active_slave(slave);
397 398 399 400 401 402
	slave->inactive = 0;
}

static inline bool bond_is_slave_inactive(struct slave *slave)
{
	return slave->inactive;
L
Linus Torvalds 已提交
403 404
}

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
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(in_dev, dst, local, RT_SCOPE_HOST);

	rcu_read_unlock();
	return addr;
}

420 421
struct bond_net;

L
Linus Torvalds 已提交
422 423
struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
424
int bond_create(struct net *net, const char *name);
425 426
int bond_create_sysfs(struct bond_net *net);
void bond_destroy_sysfs(struct bond_net *net);
427
void bond_prepare_sysfs_group(struct bonding *bond);
428 429
int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
430 431
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);
432 433 434
void bond_mii_monitor(struct work_struct *);
void bond_loadbalance_arp_mon(struct work_struct *);
void bond_activebackup_arp_mon(struct work_struct *);
435
void bond_set_mode_ops(struct bonding *bond, int mode);
436
int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
437 438
void bond_select_active_slave(struct bonding *bond);
void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
439 440 441 442 443
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);
444
const char *bond_mode_name(int mode);
L
Linus Torvalds 已提交
445

446 447 448 449 450 451
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
452
	struct class_attribute	class_attr_bonding_masters;
453 454
};

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
#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

478 479 480 481 482 483 484 485 486 487 488 489
static inline struct slave *bond_slave_has_mac(struct bonding *bond,
					       const u8 *mac)
{
	int i = 0;
	struct slave *tmp;

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

	return NULL;
}
490

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
/* 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;
}

507
/* exported from bond_main.c */
508
extern int bond_net_id;
509 510 511 512
extern const struct bond_parm_tbl bond_lacp_tbl[];
extern const struct bond_parm_tbl bond_mode_tbl[];
extern const struct bond_parm_tbl xmit_hashtype_tbl[];
extern const struct bond_parm_tbl arp_validate_tbl[];
513
extern const struct bond_parm_tbl arp_all_targets_tbl[];
514
extern const struct bond_parm_tbl fail_over_mac_tbl[];
515
extern const struct bond_parm_tbl pri_reselect_tbl[];
516 517
extern struct bond_parm_tbl ad_select_tbl[];

L
Linus Torvalds 已提交
518
#endif /* _LINUX_BONDING_H */