257a7a4dfce98b93f7d04130d21e98f3173c1ab2
[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/kobject.h>
22 #include <linux/in6.h>
23 #include "bond_3ad.h"
24 #include "bond_alb.h"
25
26 #define DRV_VERSION     "3.6.0"
27 #define DRV_RELDATE     "September 26, 2009"
28 #define DRV_NAME        "bonding"
29 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
30
31 #define BOND_MAX_ARP_TARGETS    16
32
33 #define IS_UP(dev)                                         \
34               ((((dev)->flags & IFF_UP) == IFF_UP)      && \
35                netif_running(dev)                       && \
36                netif_carrier_ok(dev))
37
38 /*
39  * Checks whether bond is ready for transmit.
40  *
41  * Caller must hold bond->lock
42  */
43 #define BOND_IS_OK(bond)                             \
44                    (((bond)->dev->flags & IFF_UP) && \
45                     netif_running((bond)->dev)    && \
46                     ((bond)->slave_cnt > 0))
47
48 /*
49  * Checks whether slave is ready for transmit.
50  */
51 #define SLAVE_IS_OK(slave)                              \
52                     (((slave)->dev->flags & IFF_UP)  && \
53                      netif_running((slave)->dev)     && \
54                      ((slave)->link == BOND_LINK_UP) && \
55                      ((slave)->state == BOND_STATE_ACTIVE))
56
57
58 #define USES_PRIMARY(mode)                              \
59                 (((mode) == BOND_MODE_ACTIVEBACKUP) ||  \
60                  ((mode) == BOND_MODE_TLB)          ||  \
61                  ((mode) == BOND_MODE_ALB))
62
63 /*
64  * Less bad way to call ioctl from within the kernel; this needs to be
65  * done some other way to get the call out of interrupt context.
66  * Needs "ioctl" variable to be supplied by calling context.
67  */
68 #define IOCTL(dev, arg, cmd) ({         \
69         int res = 0;                    \
70         mm_segment_t fs = get_fs();     \
71         set_fs(get_ds());               \
72         res = ioctl(dev, arg, cmd);     \
73         set_fs(fs);                     \
74         res; })
75
76 /**
77  * bond_for_each_slave_from - iterate the slaves list from a starting point
78  * @bond:       the bond holding this list.
79  * @pos:        current slave.
80  * @cnt:        counter for max number of moves
81  * @start:      starting point.
82  *
83  * Caller must hold bond->lock
84  */
85 #define bond_for_each_slave_from(bond, pos, cnt, start) \
86         for (cnt = 0, pos = start;                              \
87              cnt < (bond)->slave_cnt;                           \
88              cnt++, pos = (pos)->next)
89
90 /**
91  * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
92  * @bond:       the bond holding this list.
93  * @pos:        current slave.
94  * @cnt:        counter for number max of moves
95  * @start:      start point.
96  * @stop:       stop point.
97  *
98  * Caller must hold bond->lock
99  */
100 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop)        \
101         for (cnt = 0, pos = start;                                      \
102              ((cnt < (bond)->slave_cnt) && (pos != (stop)->next));      \
103              cnt++, pos = (pos)->next)
104
105 /**
106  * bond_for_each_slave - iterate the slaves list from head
107  * @bond:       the bond holding this list.
108  * @pos:        current slave.
109  * @cnt:        counter for max number of moves
110  *
111  * Caller must hold bond->lock
112  */
113 #define bond_for_each_slave(bond, pos, cnt)     \
114                 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
115
116
117 struct bond_params {
118         int mode;
119         int xmit_policy;
120         int miimon;
121         int num_grat_arp;
122         int num_unsol_na;
123         int arp_interval;
124         int arp_validate;
125         int use_carrier;
126         int fail_over_mac;
127         int updelay;
128         int downdelay;
129         int lacp_fast;
130         int ad_select;
131         char primary[IFNAMSIZ];
132         int primary_reselect;
133         __be32 arp_targets[BOND_MAX_ARP_TARGETS];
134 };
135
136 struct bond_parm_tbl {
137         char *modename;
138         int mode;
139 };
140
141 #define BOND_MAX_MODENAME_LEN 20
142
143 struct vlan_entry {
144         struct list_head vlan_list;
145         __be32 vlan_ip;
146         unsigned short vlan_id;
147 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
148         struct in6_addr vlan_ipv6;
149 #endif
150 };
151
152 struct slave {
153         struct net_device *dev; /* first - useful for panic debug */
154         struct slave *next;
155         struct slave *prev;
156         int    delay;
157         unsigned long jiffies;
158         unsigned long last_arp_rx;
159         s8     link;    /* one of BOND_LINK_XXXX */
160         s8     new_link;
161         s8     state;   /* one of BOND_STATE_XXXX */
162         u32    original_flags;
163         u32    original_mtu;
164         u32    link_failure_count;
165         u8     perm_hwaddr[ETH_ALEN];
166         u16    speed;
167         u8     duplex;
168         struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
169         struct tlb_slave_info tlb_info;
170 };
171
172 /*
173  * Link pseudo-state only used internally by monitors
174  */
175 #define BOND_LINK_NOCHANGE -1
176
177 /*
178  * Here are the locking policies for the two bonding locks:
179  *
180  * 1) Get bond->lock when reading/writing slave list.
181  * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
182  *    (It is unnecessary when the write-lock is put with bond->lock.)
183  * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
184  *    beforehand.
185  */
186 struct bonding {
187         struct   net_device *dev; /* first - useful for panic debug */
188         struct   slave *first_slave;
189         struct   slave *curr_active_slave;
190         struct   slave *current_arp_slave;
191         struct   slave *primary_slave;
192         bool     force_primary;
193         s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
194         rwlock_t lock;
195         rwlock_t curr_slave_lock;
196         s8       kill_timers;
197         s8       send_grat_arp;
198         s8       send_unsol_na;
199         s8       setup_by_slave;
200 #ifdef CONFIG_PROC_FS
201         struct   proc_dir_entry *proc_entry;
202         char     proc_file_name[IFNAMSIZ];
203 #endif /* CONFIG_PROC_FS */
204         struct   list_head bond_list;
205         struct   dev_mc_list *mc_list;
206         int      (*xmit_hash_policy)(struct sk_buff *, int);
207         __be32   master_ip;
208         u16      flags;
209         u16      rr_tx_counter;
210         struct   ad_bond_info ad_info;
211         struct   alb_bond_info alb_info;
212         struct   bond_params params;
213         struct   list_head vlan_list;
214         struct   vlan_group *vlgrp;
215         struct   packet_type arp_mon_pt;
216         struct   workqueue_struct *wq;
217         struct   delayed_work mii_work;
218         struct   delayed_work arp_work;
219         struct   delayed_work alb_work;
220         struct   delayed_work ad_work;
221 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
222         struct   in6_addr master_ipv6;
223 #endif
224 };
225
226 /**
227  * Returns NULL if the net_device does not belong to any of the bond's slaves
228  *
229  * Caller must hold bond lock for read
230  */
231 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
232 {
233         struct slave *slave = NULL;
234         int i;
235
236         bond_for_each_slave(bond, slave, i) {
237                 if (slave->dev == slave_dev) {
238                         break;
239                 }
240         }
241
242         return slave;
243 }
244
245 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
246 {
247         if (!slave || !slave->dev->master) {
248                 return NULL;
249         }
250
251         return (struct bonding *)netdev_priv(slave->dev->master);
252 }
253
254 static inline bool bond_is_lb(const struct bonding *bond)
255 {
256         return (bond->params.mode == BOND_MODE_TLB ||
257                 bond->params.mode == BOND_MODE_ALB);
258 }
259
260 #define BOND_PRI_RESELECT_ALWAYS        0
261 #define BOND_PRI_RESELECT_BETTER        1
262 #define BOND_PRI_RESELECT_FAILURE       2
263
264 #define BOND_FOM_NONE                   0
265 #define BOND_FOM_ACTIVE                 1
266 #define BOND_FOM_FOLLOW                 2
267
268 #define BOND_ARP_VALIDATE_NONE          0
269 #define BOND_ARP_VALIDATE_ACTIVE        (1 << BOND_STATE_ACTIVE)
270 #define BOND_ARP_VALIDATE_BACKUP        (1 << BOND_STATE_BACKUP)
271 #define BOND_ARP_VALIDATE_ALL           (BOND_ARP_VALIDATE_ACTIVE | \
272                                          BOND_ARP_VALIDATE_BACKUP)
273
274 static inline int slave_do_arp_validate(struct bonding *bond,
275                                         struct slave *slave)
276 {
277         return bond->params.arp_validate & (1 << slave->state);
278 }
279
280 static inline unsigned long slave_last_rx(struct bonding *bond,
281                                         struct slave *slave)
282 {
283         if (slave_do_arp_validate(bond, slave))
284                 return slave->last_arp_rx;
285
286         return slave->dev->last_rx;
287 }
288
289 static inline void bond_set_slave_inactive_flags(struct slave *slave)
290 {
291         struct bonding *bond = netdev_priv(slave->dev->master);
292         if (!bond_is_lb(bond))
293                 slave->state = BOND_STATE_BACKUP;
294         slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
295         if (slave_do_arp_validate(bond, slave))
296                 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
297 }
298
299 static inline void bond_set_slave_active_flags(struct slave *slave)
300 {
301         slave->state = BOND_STATE_ACTIVE;
302         slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
303 }
304
305 static inline void bond_set_master_3ad_flags(struct bonding *bond)
306 {
307         bond->dev->priv_flags |= IFF_MASTER_8023AD;
308 }
309
310 static inline void bond_unset_master_3ad_flags(struct bonding *bond)
311 {
312         bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
313 }
314
315 static inline void bond_set_master_alb_flags(struct bonding *bond)
316 {
317         bond->dev->priv_flags |= IFF_MASTER_ALB;
318 }
319
320 static inline void bond_unset_master_alb_flags(struct bonding *bond)
321 {
322         bond->dev->priv_flags &= ~IFF_MASTER_ALB;
323 }
324
325 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
326 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
327 int bond_create(struct net *net, const char *name);
328 int  bond_release_and_destroy(struct net_device *bond_dev, struct net_device *slave_dev);
329 int bond_create_sysfs(void);
330 void bond_destroy_sysfs(void);
331 void bond_prepare_sysfs_group(struct bonding *bond);
332 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
333 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
334 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
335 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
336 void bond_mii_monitor(struct work_struct *);
337 void bond_loadbalance_arp_mon(struct work_struct *);
338 void bond_activebackup_arp_mon(struct work_struct *);
339 void bond_set_mode_ops(struct bonding *bond, int mode);
340 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
341 void bond_select_active_slave(struct bonding *bond);
342 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
343 void bond_register_arp(struct bonding *);
344 void bond_unregister_arp(struct bonding *);
345
346 struct bond_net {
347         struct net *            net;    /* Associated network namespace */
348         struct list_head        dev_list;
349 #ifdef CONFIG_PROC_FS
350         struct proc_dir_entry * proc_dir;
351 #endif
352 };
353
354 /* exported from bond_main.c */
355 extern int bond_net_id;
356 extern const struct bond_parm_tbl bond_lacp_tbl[];
357 extern const struct bond_parm_tbl bond_mode_tbl[];
358 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
359 extern const struct bond_parm_tbl arp_validate_tbl[];
360 extern const struct bond_parm_tbl fail_over_mac_tbl[];
361 extern const struct bond_parm_tbl pri_reselect_tbl[];
362 extern struct bond_parm_tbl ad_select_tbl[];
363
364 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
365 void bond_send_unsolicited_na(struct bonding *bond);
366 void bond_register_ipv6_notifier(void);
367 void bond_unregister_ipv6_notifier(void);
368 #else
369 static inline void bond_send_unsolicited_na(struct bonding *bond)
370 {
371         return;
372 }
373 static inline void bond_register_ipv6_notifier(void)
374 {
375         return;
376 }
377 static inline void bond_unregister_ipv6_notifier(void)
378 {
379         return;
380 }
381 #endif
382
383 #endif /* _LINUX_BONDING_H */