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