bonding.h 10.4 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/kobject.h>
22
#include <linux/in6.h>
L
Linus Torvalds 已提交
23 24 25
#include "bond_3ad.h"
#include "bond_alb.h"

26 27
#define DRV_VERSION	"3.5.0"
#define DRV_RELDATE	"November 4, 2008"
L
Linus Torvalds 已提交
28 29 30 31 32
#define DRV_NAME	"bonding"
#define DRV_DESCRIPTION	"Ethernet Channel Bonding Driver"

#define BOND_MAX_ARP_TARGETS	16

33 34
extern struct list_head bond_dev_list;

L
Linus Torvalds 已提交
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 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 115 116 117 118 119 120
#define IS_UP(dev)					   \
	      ((((dev)->flags & IFF_UP) == IFF_UP)	&& \
	       netif_running(dev)			&& \
	       netif_carrier_ok(dev))

/*
 * Checks whether bond is ready for transmit.
 *
 * Caller must hold bond->lock
 */
#define BOND_IS_OK(bond)			     \
		   (((bond)->dev->flags & IFF_UP) && \
		    netif_running((bond)->dev)	  && \
		    ((bond)->slave_cnt > 0))

/*
 * 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) && \
		     ((slave)->state == BOND_STATE_ACTIVE))


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

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


struct bond_params {
	int mode;
121
	int xmit_policy;
L
Linus Torvalds 已提交
122
	int miimon;
123
	int num_grat_arp;
124
	int num_unsol_na;
L
Linus Torvalds 已提交
125
	int arp_interval;
126
	int arp_validate;
L
Linus Torvalds 已提交
127
	int use_carrier;
128
	int fail_over_mac;
L
Linus Torvalds 已提交
129 130 131
	int updelay;
	int downdelay;
	int lacp_fast;
132
	int ad_select;
L
Linus Torvalds 已提交
133
	char primary[IFNAMSIZ];
134
	__be32 arp_targets[BOND_MAX_ARP_TARGETS];
L
Linus Torvalds 已提交
135 136
};

137 138 139 140 141
struct bond_parm_tbl {
	char *modename;
	int mode;
};

J
Jay Vosburgh 已提交
142 143
#define BOND_MAX_MODENAME_LEN 20

L
Linus Torvalds 已提交
144 145
struct vlan_entry {
	struct list_head vlan_list;
146
	__be32 vlan_ip;
L
Linus Torvalds 已提交
147
	unsigned short vlan_id;
148 149 150
#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
	struct in6_addr vlan_ipv6;
#endif
L
Linus Torvalds 已提交
151 152 153
};

struct slave {
154
	struct net_device *dev; /* first - useful for panic debug */
L
Linus Torvalds 已提交
155 156
	struct slave *next;
	struct slave *prev;
157
	int    delay;
158 159
	unsigned long jiffies;
	unsigned long last_arp_rx;
L
Linus Torvalds 已提交
160
	s8     link;    /* one of BOND_LINK_XXXX */
161
	s8     new_link;
L
Linus Torvalds 已提交
162 163
	s8     state;   /* one of BOND_STATE_XXXX */
	u32    original_flags;
164
	u32    original_mtu;
L
Linus Torvalds 已提交
165 166 167 168 169 170 171 172
	u32    link_failure_count;
	u16    speed;
	u8     duplex;
	u8     perm_hwaddr[ETH_ALEN];
	struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
	struct tlb_slave_info tlb_info;
};

173 174 175 176 177
/*
 * Link pseudo-state only used internally by monitors
 */
#define BOND_LINK_NOCHANGE -1

L
Linus Torvalds 已提交
178 179 180 181 182 183 184 185 186 187
/*
 * 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 {
188
	struct   net_device *dev; /* first - useful for panic debug */
L
Linus Torvalds 已提交
189 190 191 192 193 194 195 196
	struct   slave *first_slave;
	struct   slave *curr_active_slave;
	struct   slave *current_arp_slave;
	struct   slave *primary_slave;
	s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
	rwlock_t lock;
	rwlock_t curr_slave_lock;
	s8       kill_timers;
197
	s8	 send_grat_arp;
198
	s8	 send_unsol_na;
199
	s8	 setup_by_slave;
L
Linus Torvalds 已提交
200 201 202 203 204 205 206
	struct   net_device_stats stats;
#ifdef CONFIG_PROC_FS
	struct   proc_dir_entry *proc_entry;
	char     proc_file_name[IFNAMSIZ];
#endif /* CONFIG_PROC_FS */
	struct   list_head bond_list;
	struct   dev_mc_list *mc_list;
207
	int      (*xmit_hash_policy)(struct sk_buff *, struct net_device *, int);
208
	__be32   master_ip;
L
Linus Torvalds 已提交
209
	u16      flags;
210
	u16      rr_tx_counter;
L
Linus Torvalds 已提交
211 212 213 214 215
	struct   ad_bond_info ad_info;
	struct   alb_bond_info alb_info;
	struct   bond_params params;
	struct   list_head vlan_list;
	struct   vlan_group *vlgrp;
216
	struct   packet_type arp_mon_pt;
217 218 219 220 221
	struct   workqueue_struct *wq;
	struct   delayed_work mii_work;
	struct   delayed_work arp_work;
	struct   delayed_work alb_work;
	struct   delayed_work ad_work;
222 223 224
#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
	struct   in6_addr master_ipv6;
#endif
L
Linus Torvalds 已提交
225 226 227 228 229 230 231
};

/**
 * Returns NULL if the net_device does not belong to any of the bond's slaves
 *
 * Caller must hold bond lock for read
 */
232
static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
L
Linus Torvalds 已提交
233 234 235 236 237 238 239 240 241 242 243 244 245
{
	struct slave *slave = NULL;
	int i;

	bond_for_each_slave(bond, slave, i) {
		if (slave->dev == slave_dev) {
			break;
		}
	}

	return slave;
}

246
static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
L
Linus Torvalds 已提交
247 248 249 250 251
{
	if (!slave || !slave->dev->master) {
		return NULL;
	}

252
	return (struct bonding *)netdev_priv(slave->dev->master);
L
Linus Torvalds 已提交
253 254
}

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

261 262 263 264
#define BOND_FOM_NONE			0
#define BOND_FOM_ACTIVE			1
#define BOND_FOM_FOLLOW			2

265 266 267 268 269 270
#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)

271 272
static inline int slave_do_arp_validate(struct bonding *bond,
					struct slave *slave)
273 274 275 276
{
	return bond->params.arp_validate & (1 << slave->state);
}

277
static inline unsigned long slave_last_rx(struct bonding *bond,
278
					struct slave *slave)
279 280 281 282 283 284 285
{
	if (slave_do_arp_validate(bond, slave))
		return slave->last_arp_rx;

	return slave->dev->last_rx;
}

286
static inline void bond_set_slave_inactive_flags(struct slave *slave)
L
Linus Torvalds 已提交
287
{
288
	struct bonding *bond = netdev_priv(slave->dev->master);
289
	if (!bond_is_lb(bond))
290 291
		slave->state = BOND_STATE_BACKUP;
	slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
292 293
	if (slave_do_arp_validate(bond, slave))
		slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
L
Linus Torvalds 已提交
294 295
}

296
static inline void bond_set_slave_active_flags(struct slave *slave)
L
Linus Torvalds 已提交
297 298
{
	slave->state = BOND_STATE_ACTIVE;
299
	slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
}

static inline void bond_set_master_3ad_flags(struct bonding *bond)
{
	bond->dev->priv_flags |= IFF_MASTER_8023AD;
}

static inline void bond_unset_master_3ad_flags(struct bonding *bond)
{
	bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
}

static inline void bond_set_master_alb_flags(struct bonding *bond)
{
	bond->dev->priv_flags |= IFF_MASTER_ALB;
}

static inline void bond_unset_master_alb_flags(struct bonding *bond)
{
	bond->dev->priv_flags &= ~IFF_MASTER_ALB;
L
Linus Torvalds 已提交
320 321 322 323
}

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);
324
int bond_create(const char *name);
325
int  bond_release_and_destroy(struct net_device *bond_dev, struct net_device *slave_dev);
326 327 328 329 330 331
int bond_create_sysfs(void);
void bond_destroy_sysfs(void);
void bond_destroy_sysfs_entry(struct bonding *bond);
int bond_create_sysfs_entry(struct bonding *bond);
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);
332 333
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);
334 335 336
void bond_mii_monitor(struct work_struct *);
void bond_loadbalance_arp_mon(struct work_struct *);
void bond_activebackup_arp_mon(struct work_struct *);
337
void bond_set_mode_ops(struct bonding *bond, int mode);
338
int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
339 340
void bond_select_active_slave(struct bonding *bond);
void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
341 342
void bond_register_arp(struct bonding *);
void bond_unregister_arp(struct bonding *);
L
Linus Torvalds 已提交
343

344 345
/* exported from bond_main.c */
extern struct list_head bond_dev_list;
346 347 348 349 350
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[];
extern const struct bond_parm_tbl fail_over_mac_tbl[];
351 352
extern struct bond_parm_tbl ad_select_tbl[];

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
void bond_send_unsolicited_na(struct bonding *bond);
void bond_register_ipv6_notifier(void);
void bond_unregister_ipv6_notifier(void);
#else
static inline void bond_send_unsolicited_na(struct bonding *bond)
{
	return;
}
static inline void bond_register_ipv6_notifier(void)
{
	return;
}
static inline void bond_unregister_ipv6_notifier(void)
{
	return;
}
#endif

L
Linus Torvalds 已提交
372 373
#endif /* _LINUX_BONDING_H */