bonding: fix a typo in a comment
[linux-2.6.git] / drivers / net / bonding / bonding.h
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  *
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>
21 #include <linux/cpumask.h>
22 #include <linux/in6.h>
23 #include <linux/netpoll.h>
24 #include "bond_3ad.h"
25 #include "bond_alb.h"
26
27 #define DRV_VERSION     "3.7.0"
28 #define DRV_RELDATE     "June 2, 2010"
29 #define DRV_NAME        "bonding"
30 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
31
32 #define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
33
34 #define BOND_MAX_ARP_TARGETS    16
35
36 #define IS_UP(dev)                                         \
37               ((((dev)->flags & IFF_UP) == IFF_UP)      && \
38                netif_running(dev)                       && \
39                netif_carrier_ok(dev))
40
41 /*
42  * Checks whether bond is ready for transmit.
43  *
44  * Caller must hold bond->lock
45  */
46 #define BOND_IS_OK(bond)                             \
47                    (((bond)->dev->flags & IFF_UP) && \
48                     netif_running((bond)->dev)    && \
49                     ((bond)->slave_cnt > 0))
50
51 /*
52  * Checks whether slave is ready for transmit.
53  */
54 #define SLAVE_IS_OK(slave)                              \
55                     (((slave)->dev->flags & IFF_UP)  && \
56                      netif_running((slave)->dev)     && \
57                      ((slave)->link == BOND_LINK_UP) && \
58                      bond_is_active_slave(slave))
59
60
61 #define USES_PRIMARY(mode)                              \
62                 (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
63                  ((mode) == BOND_MODE_TLB)          ||  \
64                  ((mode) == BOND_MODE_ALB))
65
66 #define TX_QUEUE_OVERRIDE(mode)                         \
67                         (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
68                          ((mode) == BOND_MODE_ROUNDROBIN))
69 /*
70  * Less bad way to call ioctl from within the kernel; this needs to be
71  * done some other way to get the call out of interrupt context.
72  * Needs "ioctl" variable to be supplied by calling context.
73  */
74 #define IOCTL(dev, arg, cmd) ({         \
75         int res = 0;                    \
76         mm_segment_t fs = get_fs();     \
77         set_fs(get_ds());               \
78         res = ioctl(dev, arg, cmd);     \
79         set_fs(fs);                     \
80         res; })
81
82 /**
83  * bond_for_each_slave_from - iterate the slaves list from a starting point
84  * @bond:       the bond holding this list.
85  * @pos:        current slave.
86  * @cnt:        counter for max number of moves
87  * @start:      starting point.
88  *
89  * Caller must hold bond->lock
90  */
91 #define bond_for_each_slave_from(bond, pos, cnt, start) \
92         for (cnt = 0, pos = start;                              \
93              cnt < (bond)->slave_cnt;                           \
94              cnt++, pos = (pos)->next)
95
96 /**
97  * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
98  * @bond:       the bond holding this list.
99  * @pos:        current slave.
100  * @cnt:        counter for number max of moves
101  * @start:      start point.
102  * @stop:       stop point.
103  *
104  * Caller must hold bond->lock
105  */
106 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop)        \
107         for (cnt = 0, pos = start;                                      \
108              ((cnt < (bond)->slave_cnt) && (pos != (stop)->next));      \
109              cnt++, pos = (pos)->next)
110
111 /**
112  * bond_for_each_slave - iterate the slaves list from head
113  * @bond:       the bond holding this list.
114  * @pos:        current slave.
115  * @cnt:        counter for max number of moves
116  *
117  * Caller must hold bond->lock
118  */
119 #define bond_for_each_slave(bond, pos, cnt)     \
120                 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
121
122
123 #ifdef CONFIG_NET_POLL_CONTROLLER
124 extern atomic_t netpoll_block_tx;
125
126 static inline void block_netpoll_tx(void)
127 {
128         atomic_inc(&netpoll_block_tx);
129 }
130
131 static inline void unblock_netpoll_tx(void)
132 {
133         atomic_dec(&netpoll_block_tx);
134 }
135
136 static inline int is_netpoll_tx_blocked(struct net_device *dev)
137 {
138         if (unlikely(netpoll_tx_running(dev)))
139                 return atomic_read(&netpoll_block_tx);
140         return 0;
141 }
142 #else
143 #define block_netpoll_tx()
144 #define unblock_netpoll_tx()
145 #define is_netpoll_tx_blocked(dev) (0)
146 #endif
147
148 struct bond_params {
149         int mode;
150         int xmit_policy;
151         int miimon;
152         int num_grat_arp;
153         int num_unsol_na;
154         int arp_interval;
155         int arp_validate;
156         int use_carrier;
157         int fail_over_mac;
158         int updelay;
159         int downdelay;
160         int lacp_fast;
161         int ad_select;
162         char primary[IFNAMSIZ];
163         int primary_reselect;
164         __be32 arp_targets[BOND_MAX_ARP_TARGETS];
165         int tx_queues;
166         int all_slaves_active;
167         int resend_igmp;
168 };
169
170 struct bond_parm_tbl {
171         char *modename;
172         int mode;
173 };
174
175 #define BOND_MAX_MODENAME_LEN 20
176
177 struct vlan_entry {
178         struct list_head vlan_list;
179         __be32 vlan_ip;
180         unsigned short vlan_id;
181 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
182         struct in6_addr vlan_ipv6;
183 #endif
184 };
185
186 struct slave {
187         struct net_device *dev; /* first - useful for panic debug */
188         struct slave *next;
189         struct slave *prev;
190         int    delay;
191         unsigned long jiffies;
192         unsigned long last_arp_rx;
193         s8     link;    /* one of BOND_LINK_XXXX */
194         s8     new_link;
195         u8     backup:1,   /* indicates backup slave. Value corresponds with
196                               BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
197                inactive:1; /* indicates inactive slave */
198         u32    original_mtu;
199         u32    link_failure_count;
200         u8     perm_hwaddr[ETH_ALEN];
201         u16    speed;
202         u8     duplex;
203         u16    queue_id;
204         struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
205         struct tlb_slave_info tlb_info;
206 #ifdef CONFIG_NET_POLL_CONTROLLER
207         struct netpoll *np;
208 #endif
209 };
210
211 /*
212  * Link pseudo-state only used internally by monitors
213  */
214 #define BOND_LINK_NOCHANGE -1
215
216 /*
217  * Here are the locking policies for the two bonding locks:
218  *
219  * 1) Get bond->lock when reading/writing slave list.
220  * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
221  *    (It is unnecessary when the write-lock is put with bond->lock.)
222  * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
223  *    beforehand.
224  */
225 struct bonding {
226         struct   net_device *dev; /* first - useful for panic debug */
227         struct   slave *first_slave;
228         struct   slave *curr_active_slave;
229         struct   slave *current_arp_slave;
230         struct   slave *primary_slave;
231         bool     force_primary;
232         s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
233         rwlock_t lock;
234         rwlock_t curr_slave_lock;
235         s8       kill_timers;
236         s8       send_grat_arp;
237         s8       send_unsol_na;
238         s8       setup_by_slave;
239         s8       igmp_retrans;
240 #ifdef CONFIG_PROC_FS
241         struct   proc_dir_entry *proc_entry;
242         char     proc_file_name[IFNAMSIZ];
243 #endif /* CONFIG_PROC_FS */
244         struct   list_head bond_list;
245         struct   netdev_hw_addr_list mc_list;
246         int      (*xmit_hash_policy)(struct sk_buff *, int);
247         __be32   master_ip;
248         u16      flags;
249         u16      rr_tx_counter;
250         struct   ad_bond_info ad_info;
251         struct   alb_bond_info alb_info;
252         struct   bond_params params;
253         struct   list_head vlan_list;
254         struct   vlan_group *vlgrp;
255         struct   packet_type arp_mon_pt;
256         struct   workqueue_struct *wq;
257         struct   delayed_work mii_work;
258         struct   delayed_work arp_work;
259         struct   delayed_work alb_work;
260         struct   delayed_work ad_work;
261         struct   delayed_work mcast_work;
262 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
263         struct   in6_addr master_ipv6;
264 #endif
265 #ifdef CONFIG_DEBUG_FS
266         /* debugging suport via debugfs */
267         struct   dentry *debug_dir;
268 #endif /* CONFIG_DEBUG_FS */
269 };
270
271 #define bond_slave_get_rcu(dev) \
272         ((struct slave *) rcu_dereference(dev->rx_handler_data))
273
274 /**
275  * Returns NULL if the net_device does not belong to any of the bond's slaves
276  *
277  * Caller must hold bond lock for read
278  */
279 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
280                                                   struct net_device *slave_dev)
281 {
282         struct slave *slave = NULL;
283         int i;
284
285         bond_for_each_slave(bond, slave, i) {
286                 if (slave->dev == slave_dev) {
287                         return slave;
288                 }
289         }
290
291         return NULL;
292 }
293
294 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
295 {
296         if (!slave || !slave->dev->master) {
297                 return NULL;
298         }
299
300         return netdev_priv(slave->dev->master);
301 }
302
303 static inline bool bond_is_lb(const struct bonding *bond)
304 {
305         return (bond->params.mode == BOND_MODE_TLB ||
306                 bond->params.mode == BOND_MODE_ALB);
307 }
308
309 static inline void bond_set_active_slave(struct slave *slave)
310 {
311         slave->backup = 0;
312 }
313
314 static inline void bond_set_backup_slave(struct slave *slave)
315 {
316         slave->backup = 1;
317 }
318
319 static inline int bond_slave_state(struct slave *slave)
320 {
321         return slave->backup;
322 }
323
324 static inline bool bond_is_active_slave(struct slave *slave)
325 {
326         return !bond_slave_state(slave);
327 }
328
329 #define BOND_PRI_RESELECT_ALWAYS        0
330 #define BOND_PRI_RESELECT_BETTER        1
331 #define BOND_PRI_RESELECT_FAILURE       2
332
333 #define BOND_FOM_NONE                   0
334 #define BOND_FOM_ACTIVE                 1
335 #define BOND_FOM_FOLLOW                 2
336
337 #define BOND_ARP_VALIDATE_NONE          0
338 #define BOND_ARP_VALIDATE_ACTIVE        (1 << BOND_STATE_ACTIVE)
339 #define BOND_ARP_VALIDATE_BACKUP        (1 << BOND_STATE_BACKUP)
340 #define BOND_ARP_VALIDATE_ALL           (BOND_ARP_VALIDATE_ACTIVE | \
341                                          BOND_ARP_VALIDATE_BACKUP)
342
343 static inline int slave_do_arp_validate(struct bonding *bond,
344                                         struct slave *slave)
345 {
346         return bond->params.arp_validate & (1 << bond_slave_state(slave));
347 }
348
349 static inline unsigned long slave_last_rx(struct bonding *bond,
350                                         struct slave *slave)
351 {
352         if (slave_do_arp_validate(bond, slave))
353                 return slave->last_arp_rx;
354
355         return slave->dev->last_rx;
356 }
357
358 #ifdef CONFIG_NET_POLL_CONTROLLER
359 static inline void bond_netpoll_send_skb(const struct slave *slave,
360                                          struct sk_buff *skb)
361 {
362         struct netpoll *np = slave->np;
363
364         if (np)
365                 netpoll_send_skb(np, skb);
366 }
367 #else
368 static inline void bond_netpoll_send_skb(const struct slave *slave,
369                                          struct sk_buff *skb)
370 {
371 }
372 #endif
373
374 static inline void bond_set_slave_inactive_flags(struct slave *slave)
375 {
376         struct bonding *bond = netdev_priv(slave->dev->master);
377         if (!bond_is_lb(bond))
378                 bond_set_backup_slave(slave);
379         if (!bond->params.all_slaves_active)
380                 slave->inactive = 1;
381 }
382
383 static inline void bond_set_slave_active_flags(struct slave *slave)
384 {
385         bond_set_active_slave(slave);
386         slave->inactive = 0;
387 }
388
389 static inline bool bond_is_slave_inactive(struct slave *slave)
390 {
391         return slave->inactive;
392 }
393
394 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
395 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
396 int bond_create(struct net *net, const char *name);
397 int bond_create_sysfs(void);
398 void bond_destroy_sysfs(void);
399 void bond_prepare_sysfs_group(struct bonding *bond);
400 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
401 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
402 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
403 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
404 void bond_mii_monitor(struct work_struct *);
405 void bond_loadbalance_arp_mon(struct work_struct *);
406 void bond_activebackup_arp_mon(struct work_struct *);
407 void bond_set_mode_ops(struct bonding *bond, int mode);
408 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
409 void bond_select_active_slave(struct bonding *bond);
410 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
411 void bond_register_arp(struct bonding *);
412 void bond_unregister_arp(struct bonding *);
413 void bond_create_debugfs(void);
414 void bond_destroy_debugfs(void);
415 void bond_debug_register(struct bonding *bond);
416 void bond_debug_unregister(struct bonding *bond);
417 void bond_debug_reregister(struct bonding *bond);
418
419 struct bond_net {
420         struct net *            net;    /* Associated network namespace */
421         struct list_head        dev_list;
422 #ifdef CONFIG_PROC_FS
423         struct proc_dir_entry * proc_dir;
424 #endif
425 };
426
427 #ifdef CONFIG_PROC_FS
428 void bond_create_proc_entry(struct bonding *bond);
429 void bond_remove_proc_entry(struct bonding *bond);
430 void bond_create_proc_dir(struct bond_net *bn);
431 void bond_destroy_proc_dir(struct bond_net *bn);
432 #else
433 static inline void bond_create_proc_entry(struct bonding *bond)
434 {
435 }
436
437 static inline void bond_remove_proc_entry(struct bonding *bond)
438 {
439 }
440
441 static inline void bond_create_proc_dir(struct bond_net *bn)
442 {
443 }
444
445 static inline void bond_destroy_proc_dir(struct bond_net *bn)
446 {
447 }
448 #endif
449
450
451 /* exported from bond_main.c */
452 extern int bond_net_id;
453 extern const struct bond_parm_tbl bond_lacp_tbl[];
454 extern const struct bond_parm_tbl bond_mode_tbl[];
455 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
456 extern const struct bond_parm_tbl arp_validate_tbl[];
457 extern const struct bond_parm_tbl fail_over_mac_tbl[];
458 extern const struct bond_parm_tbl pri_reselect_tbl[];
459 extern struct bond_parm_tbl ad_select_tbl[];
460
461 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
462 void bond_send_unsolicited_na(struct bonding *bond);
463 void bond_register_ipv6_notifier(void);
464 void bond_unregister_ipv6_notifier(void);
465 #else
466 static inline void bond_send_unsolicited_na(struct bonding *bond)
467 {
468         return;
469 }
470 static inline void bond_register_ipv6_notifier(void)
471 {
472         return;
473 }
474 static inline void bond_unregister_ipv6_notifier(void)
475 {
476         return;
477 }
478 #endif
479
480 #endif /* _LINUX_BONDING_H */