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