]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/net/bonding/bonding.h
bonding: fix store_arp_validate race with mode change
[mirror_ubuntu-bionic-kernel.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
1da177e4
LT
38#define IS_UP(dev) \
39 ((((dev)->flags & IFF_UP) == IFF_UP) && \
40 netif_running(dev) && \
41 netif_carrier_ok(dev))
42
1da177e4
LT
43/*
44 * Checks whether slave is ready for transmit.
45 */
46#define SLAVE_IS_OK(slave) \
47 (((slave)->dev->flags & IFF_UP) && \
48 netif_running((slave)->dev) && \
49 ((slave)->link == BOND_LINK_UP) && \
e30bc066 50 bond_is_active_slave(slave))
1da177e4
LT
51
52
53#define USES_PRIMARY(mode) \
54 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
55 ((mode) == BOND_MODE_TLB) || \
56 ((mode) == BOND_MODE_ALB))
57
bb1d9123
AG
58#define TX_QUEUE_OVERRIDE(mode) \
59 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
60 ((mode) == BOND_MODE_ROUNDROBIN))
1da177e4
LT
61/*
62 * Less bad way to call ioctl from within the kernel; this needs to be
63 * done some other way to get the call out of interrupt context.
64 * Needs "ioctl" variable to be supplied by calling context.
65 */
66#define IOCTL(dev, arg, cmd) ({ \
67 int res = 0; \
68 mm_segment_t fs = get_fs(); \
69 set_fs(get_ds()); \
70 res = ioctl(dev, arg, cmd); \
71 set_fs(fs); \
72 res; })
73
dec1e90e 74/* slave list primitives */
75#define bond_to_slave(ptr) list_entry(ptr, struct slave, list)
76
77/* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
78#define bond_first_slave(bond) \
79 list_first_entry_or_null(&(bond)->slave_list, struct slave, list)
80#define bond_last_slave(bond) \
81 (list_empty(&(bond)->slave_list) ? NULL : \
82 bond_to_slave((bond)->slave_list.prev))
83
84#define bond_is_first_slave(bond, pos) ((pos)->list.prev == &(bond)->slave_list)
85#define bond_is_last_slave(bond, pos) ((pos)->list.next == &(bond)->slave_list)
86
87/* Since bond_first/last_slave can return NULL, these can return NULL too */
88#define bond_next_slave(bond, pos) \
89 (bond_is_last_slave(bond, pos) ? bond_first_slave(bond) : \
90 bond_to_slave((pos)->list.next))
91
92#define bond_prev_slave(bond, pos) \
93 (bond_is_first_slave(bond, pos) ? bond_last_slave(bond) : \
94 bond_to_slave((pos)->list.prev))
95
1da177e4
LT
96/**
97 * bond_for_each_slave_from - iterate the slaves list from a starting point
98 * @bond: the bond holding this list.
99 * @pos: current slave.
100 * @cnt: counter for max number of moves
101 * @start: starting point.
102 *
103 * Caller must hold bond->lock
104 */
dec1e90e 105#define bond_for_each_slave_from(bond, pos, cnt, start) \
106 for (cnt = 0, pos = start; pos && cnt < (bond)->slave_cnt; \
107 cnt++, pos = bond_next_slave(bond, pos))
1da177e4
LT
108
109/**
dec1e90e 110 * bond_for_each_slave - iterate over all slaves
111 * @bond: the bond holding this list
112 * @pos: current slave
1da177e4
LT
113 *
114 * Caller must hold bond->lock
115 */
dec1e90e 116#define bond_for_each_slave(bond, pos) \
117 list_for_each_entry(pos, &(bond)->slave_list, list)
1da177e4 118
278b2083 119/* Caller must have rcu_read_lock */
120#define bond_for_each_slave_rcu(bond, pos) \
121 list_for_each_entry_rcu(pos, &(bond)->slave_list, list)
122
1da177e4 123/**
dec1e90e 124 * bond_for_each_slave_reverse - iterate in reverse from a given position
125 * @bond: the bond holding this list
126 * @pos: slave to continue from
1da177e4
LT
127 *
128 * Caller must hold bond->lock
129 */
dec1e90e 130#define bond_for_each_slave_continue_reverse(bond, pos) \
131 list_for_each_entry_continue_reverse(pos, &(bond)->slave_list, list)
1da177e4 132
e843fa50 133#ifdef CONFIG_NET_POLL_CONTROLLER
fb4fa76a 134extern atomic_t netpoll_block_tx;
e843fa50
NH
135
136static inline void block_netpoll_tx(void)
137{
fb4fa76a 138 atomic_inc(&netpoll_block_tx);
e843fa50
NH
139}
140
141static inline void unblock_netpoll_tx(void)
142{
fb4fa76a 143 atomic_dec(&netpoll_block_tx);
e843fa50
NH
144}
145
146static inline int is_netpoll_tx_blocked(struct net_device *dev)
147{
080e4130 148 if (unlikely(netpoll_tx_running(dev)))
fb4fa76a 149 return atomic_read(&netpoll_block_tx);
e843fa50
NH
150 return 0;
151}
152#else
153#define block_netpoll_tx()
154#define unblock_netpoll_tx()
155#define is_netpoll_tx_blocked(dev) (0)
156#endif
157
1da177e4
LT
158struct bond_params {
159 int mode;
169a3e66 160 int xmit_policy;
1da177e4 161 int miimon;
ad246c99 162 u8 num_peer_notif;
1da177e4 163 int arp_interval;
f5b2b966 164 int arp_validate;
8599b52e 165 int arp_all_targets;
1da177e4 166 int use_carrier;
dd957c57 167 int fail_over_mac;
1da177e4
LT
168 int updelay;
169 int downdelay;
170 int lacp_fast;
655f8919 171 unsigned int min_links;
fd989c83 172 int ad_select;
1da177e4 173 char primary[IFNAMSIZ];
a549952a 174 int primary_reselect;
d3bb52b0 175 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
bb1d9123 176 int tx_queues;
ebd8e497 177 int all_slaves_active;
c2952c31 178 int resend_igmp;
1da177e4
LT
179};
180
12479f9a
MW
181struct bond_parm_tbl {
182 char *modename;
183 int mode;
184};
185
ece95f7f
JV
186#define BOND_MAX_MODENAME_LEN 20
187
1da177e4 188struct slave {
e944ef79 189 struct net_device *dev; /* first - useful for panic debug */
dec1e90e 190 struct list_head list;
35d48903 191 struct bonding *bond; /* our master */
8bb5f96b 192 int delay;
f8a8ccd5
AG
193 unsigned long jiffies;
194 unsigned long last_arp_rx;
8599b52e 195 unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
1da177e4 196 s8 link; /* one of BOND_LINK_XXXX */
b2220cad 197 s8 new_link;
2d7011ca
JP
198 u8 backup:1, /* indicates backup slave. Value corresponds with
199 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
200 inactive:1; /* indicates inactive slave */
5d30530e 201 u8 duplex;
3158bf7d 202 u32 original_mtu;
1da177e4 203 u32 link_failure_count;
5d30530e 204 u32 speed;
bb1d9123 205 u16 queue_id;
5d30530e 206 u8 perm_hwaddr[ETH_ALEN];
1da177e4
LT
207 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
208 struct tlb_slave_info tlb_info;
8a8efa22
AW
209#ifdef CONFIG_NET_POLL_CONTROLLER
210 struct netpoll *np;
211#endif
1da177e4
LT
212};
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 */
228struct bonding {
e944ef79 229 struct net_device *dev; /* first - useful for panic debug */
dec1e90e 230 struct list_head slave_list;
1da177e4
LT
231 struct slave *curr_active_slave;
232 struct slave *current_arp_slave;
233 struct slave *primary_slave;
a549952a 234 bool force_primary;
1da177e4 235 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
de063b70
ED
236 int (*recv_probe)(const struct sk_buff *, struct bonding *,
237 struct slave *);
1da177e4
LT
238 rwlock_t lock;
239 rwlock_t curr_slave_lock;
ad246c99 240 u8 send_peer_notif;
4f5474e7 241 u8 igmp_retrans;
1da177e4
LT
242#ifdef CONFIG_PROC_FS
243 struct proc_dir_entry *proc_entry;
244 char proc_file_name[IFNAMSIZ];
245#endif /* CONFIG_PROC_FS */
246 struct list_head bond_list;
a361c83c 247 int (*xmit_hash_policy)(struct sk_buff *, int);
cf5f9044 248 u16 rr_tx_counter;
1da177e4
LT
249 struct ad_bond_info ad_info;
250 struct alb_bond_info alb_info;
251 struct bond_params params;
1b76b316
JV
252 struct workqueue_struct *wq;
253 struct delayed_work mii_work;
254 struct delayed_work arp_work;
255 struct delayed_work alb_work;
256 struct delayed_work ad_work;
5a37e8ca 257 struct delayed_work mcast_work;
f073c7ca 258#ifdef CONFIG_DEBUG_FS
02582e9b 259 /* debugging support via debugfs */
f073c7ca
TI
260 struct dentry *debug_dir;
261#endif /* CONFIG_DEBUG_FS */
1da177e4
LT
262};
263
f1c1775a
JP
264#define bond_slave_get_rcu(dev) \
265 ((struct slave *) rcu_dereference(dev->rx_handler_data))
266
471cb5a3
JP
267#define bond_slave_get_rtnl(dev) \
268 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
269
1da177e4
LT
270/**
271 * Returns NULL if the net_device does not belong to any of the bond's slaves
272 *
273 * Caller must hold bond lock for read
274 */
4ec952b8 275static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
276 struct net_device *slave_dev)
1da177e4
LT
277{
278 struct slave *slave = NULL;
1da177e4 279
dec1e90e 280 bond_for_each_slave(bond, slave)
281 if (slave->dev == slave_dev)
af3e5bd5 282 return slave;
1da177e4 283
4ec952b8 284 return NULL;
1da177e4
LT
285}
286
cceb904f 287static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
1da177e4 288{
471cb5a3 289 if (!slave || !slave->bond)
1da177e4 290 return NULL;
471cb5a3 291 return slave->bond;
1da177e4
LT
292}
293
58402054
HE
294static inline bool bond_is_lb(const struct bonding *bond)
295{
8e95a202
JP
296 return (bond->params.mode == BOND_MODE_TLB ||
297 bond->params.mode == BOND_MODE_ALB);
58402054
HE
298}
299
e30bc066
JP
300static inline void bond_set_active_slave(struct slave *slave)
301{
302 slave->backup = 0;
303}
304
305static inline void bond_set_backup_slave(struct slave *slave)
306{
307 slave->backup = 1;
308}
309
310static inline int bond_slave_state(struct slave *slave)
311{
312 return slave->backup;
313}
314
315static inline bool bond_is_active_slave(struct slave *slave)
316{
317 return !bond_slave_state(slave);
318}
319
a549952a
JP
320#define BOND_PRI_RESELECT_ALWAYS 0
321#define BOND_PRI_RESELECT_BETTER 1
322#define BOND_PRI_RESELECT_FAILURE 2
323
3915c1e8
JV
324#define BOND_FOM_NONE 0
325#define BOND_FOM_ACTIVE 1
326#define BOND_FOM_FOLLOW 2
327
8599b52e
VF
328#define BOND_ARP_TARGETS_ANY 0
329#define BOND_ARP_TARGETS_ALL 1
330
f5b2b966
JV
331#define BOND_ARP_VALIDATE_NONE 0
332#define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
333#define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
334#define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
335 BOND_ARP_VALIDATE_BACKUP)
336
079ca7da
AB
337static inline int slave_do_arp_validate(struct bonding *bond,
338 struct slave *slave)
f5b2b966 339{
e30bc066 340 return bond->params.arp_validate & (1 << bond_slave_state(slave));
f5b2b966
JV
341}
342
8599b52e
VF
343/* Get the oldest arp which we've received on this slave for bond's
344 * arp_targets.
345 */
346static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
347 struct slave *slave)
348{
349 int i = 1;
350 unsigned long ret = slave->target_last_arp_rx[0];
351
352 for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
353 if (time_before(slave->target_last_arp_rx[i], ret))
354 ret = slave->target_last_arp_rx[i];
355
356 return ret;
357}
358
079ca7da 359static inline unsigned long slave_last_rx(struct bonding *bond,
f8a8ccd5 360 struct slave *slave)
f5b2b966 361{
8599b52e
VF
362 if (slave_do_arp_validate(bond, slave)) {
363 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
364 return slave_oldest_target_arp_rx(bond, slave);
365 else
366 return slave->last_arp_rx;
367 }
f5b2b966
JV
368
369 return slave->dev->last_rx;
370}
371
8a8efa22
AW
372#ifdef CONFIG_NET_POLL_CONTROLLER
373static inline void bond_netpoll_send_skb(const struct slave *slave,
374 struct sk_buff *skb)
375{
376 struct netpoll *np = slave->np;
377
378 if (np)
379 netpoll_send_skb(np, skb);
380}
381#else
382static inline void bond_netpoll_send_skb(const struct slave *slave,
383 struct sk_buff *skb)
384{
385}
386#endif
387
cceb904f 388static inline void bond_set_slave_inactive_flags(struct slave *slave)
1da177e4 389{
471cb5a3 390 if (!bond_is_lb(slave->bond))
e30bc066 391 bond_set_backup_slave(slave);
471cb5a3 392 if (!slave->bond->params.all_slaves_active)
2d7011ca 393 slave->inactive = 1;
1da177e4
LT
394}
395
cceb904f 396static inline void bond_set_slave_active_flags(struct slave *slave)
1da177e4 397{
e30bc066 398 bond_set_active_slave(slave);
2d7011ca
JP
399 slave->inactive = 0;
400}
401
402static inline bool bond_is_slave_inactive(struct slave *slave)
403{
404 return slave->inactive;
1da177e4
LT
405}
406
eaddcd76
AG
407static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
408{
409 struct in_device *in_dev;
410 __be32 addr = 0;
411
412 rcu_read_lock();
413 in_dev = __in_dev_get_rcu(dev);
414
415 if (in_dev)
416 addr = inet_confirm_addr(in_dev, dst, local, RT_SCOPE_HOST);
417
418 rcu_read_unlock();
419 return addr;
420}
421
15077228
NA
422static inline bool slave_can_tx(struct slave *slave)
423{
424 if (IS_UP(slave->dev) && slave->link == BOND_LINK_UP &&
425 bond_is_active_slave(slave))
426 return true;
427 else
428 return false;
429}
430
4c22400a
EB
431struct bond_net;
432
1da177e4
LT
433struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
434int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
15077228 435void bond_xmit_slave_id(struct bonding *bond, struct sk_buff *skb, int slave_id);
ec87fd3b 436int bond_create(struct net *net, const char *name);
4c22400a
EB
437int bond_create_sysfs(struct bond_net *net);
438void bond_destroy_sysfs(struct bond_net *net);
6151b3d4 439void bond_prepare_sysfs_group(struct bonding *bond);
b76cdba9
MW
440int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
441void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
a77b5325
MW
442int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
443int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
1b76b316
JV
444void bond_mii_monitor(struct work_struct *);
445void bond_loadbalance_arp_mon(struct work_struct *);
446void bond_activebackup_arp_mon(struct work_struct *);
a77b5325 447void bond_set_mode_ops(struct bonding *bond, int mode);
325dcf7a 448int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
a77b5325
MW
449void bond_select_active_slave(struct bonding *bond);
450void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
f073c7ca
TI
451void bond_create_debugfs(void);
452void bond_destroy_debugfs(void);
453void bond_debug_register(struct bonding *bond);
454void bond_debug_unregister(struct bonding *bond);
455void bond_debug_reregister(struct bonding *bond);
d30ee670 456const char *bond_mode_name(int mode);
1da177e4 457
ec87fd3b
EB
458struct bond_net {
459 struct net * net; /* Associated network namespace */
460 struct list_head dev_list;
461#ifdef CONFIG_PROC_FS
462 struct proc_dir_entry * proc_dir;
463#endif
4c22400a 464 struct class_attribute class_attr_bonding_masters;
ec87fd3b
EB
465};
466
bd33acc3
AW
467#ifdef CONFIG_PROC_FS
468void bond_create_proc_entry(struct bonding *bond);
469void bond_remove_proc_entry(struct bonding *bond);
470void bond_create_proc_dir(struct bond_net *bn);
471void bond_destroy_proc_dir(struct bond_net *bn);
472#else
473static inline void bond_create_proc_entry(struct bonding *bond)
474{
475}
476
477static inline void bond_remove_proc_entry(struct bonding *bond)
478{
479}
480
481static inline void bond_create_proc_dir(struct bond_net *bn)
482{
483}
484
485static inline void bond_destroy_proc_dir(struct bond_net *bn)
486{
487}
488#endif
489
567b871e 490static inline struct slave *bond_slave_has_mac(struct bonding *bond,
491 const u8 *mac)
492{
567b871e 493 struct slave *tmp;
494
dec1e90e 495 bond_for_each_slave(bond, tmp)
567b871e 496 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
497 return tmp;
498
499 return NULL;
500}
bd33acc3 501
87a7b84b
VF
502/* Check if the ip is present in arp ip list, or first free slot if ip == 0
503 * Returns -1 if not found, index if found
504 */
505static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
506{
507 int i;
508
509 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
510 if (targets[i] == ip)
511 return i;
512 else if (targets[i] == 0)
513 break;
514
515 return -1;
516}
517
b2259672 518/* exported from bond_main.c */
ec87fd3b 519extern int bond_net_id;
e97fd7c6
HE
520extern const struct bond_parm_tbl bond_lacp_tbl[];
521extern const struct bond_parm_tbl bond_mode_tbl[];
522extern const struct bond_parm_tbl xmit_hashtype_tbl[];
523extern const struct bond_parm_tbl arp_validate_tbl[];
8599b52e 524extern const struct bond_parm_tbl arp_all_targets_tbl[];
e97fd7c6 525extern const struct bond_parm_tbl fail_over_mac_tbl[];
a549952a 526extern const struct bond_parm_tbl pri_reselect_tbl[];
b06715b7
HE
527extern struct bond_parm_tbl ad_select_tbl[];
528
1da177e4 529#endif /* _LINUX_BONDING_H */