bonding: remove unused original_flags struct slave member
[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_mtu;
163         u32    link_failure_count;
164         u8     perm_hwaddr[ETH_ALEN];
165         u16    speed;
166         u8     duplex;
167         struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
168         struct tlb_slave_info tlb_info;
169 };
170
171 /*
172  * Link pseudo-state only used internally by monitors
173  */
174 #define BOND_LINK_NOCHANGE -1
175
176 /*
177  * Here are the locking policies for the two bonding locks:
178  *
179  * 1) Get bond->lock when reading/writing slave list.
180  * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
181  *    (It is unnecessary when the write-lock is put with bond->lock.)
182  * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
183  *    beforehand.
184  */
185 struct bonding {
186         struct   net_device *dev; /* first - useful for panic debug */
187         struct   slave *first_slave;
188         struct   slave *curr_active_slave;
189         struct   slave *current_arp_slave;
190         struct   slave *primary_slave;
191         bool     force_primary;
192         s32      slave_cnt; /* never change this value outside the attach/detach wrappers */
193         rwlock_t lock;
194         rwlock_t curr_slave_lock;
195         s8       kill_timers;
196         s8       send_grat_arp;
197         s8       send_unsol_na;
198         s8       setup_by_slave;
199 #ifdef CONFIG_PROC_FS
200         struct   proc_dir_entry *proc_entry;
201         char     proc_file_name[IFNAMSIZ];
202 #endif /* CONFIG_PROC_FS */
203         struct   list_head bond_list;
204         struct   netdev_hw_addr_list mc_list;
205         int      (*xmit_hash_policy)(struct sk_buff *, int);
206         __be32   master_ip;
207         u16      flags;
208         u16      rr_tx_counter;
209         struct   ad_bond_info ad_info;
210         struct   alb_bond_info alb_info;
211         struct   bond_params params;
212         struct   list_head vlan_list;
213         struct   vlan_group *vlgrp;
214         struct   packet_type arp_mon_pt;
215         struct   workqueue_struct *wq;
216         struct   delayed_work mii_work;
217         struct   delayed_work arp_work;
218         struct   delayed_work alb_work;
219         struct   delayed_work ad_work;
220 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
221         struct   in6_addr master_ipv6;
222 #endif
223 };
224
225 /**
226  * Returns NULL if the net_device does not belong to any of the bond's slaves
227  *
228  * Caller must hold bond lock for read
229  */
230 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
231 {
232         struct slave *slave = NULL;
233         int i;
234
235         bond_for_each_slave(bond, slave, i) {
236                 if (slave->dev == slave_dev) {
237                         break;
238                 }
239         }
240
241         return slave;
242 }
243
244 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
245 {
246         if (!slave || !slave->dev->master) {
247                 return NULL;
248         }
249
250         return (struct bonding *)netdev_priv(slave->dev->master);
251 }
252
253 static inline bool bond_is_lb(const struct bonding *bond)
254 {
255         return (bond->params.mode == BOND_MODE_TLB ||
256                 bond->params.mode == BOND_MODE_ALB);
257 }
258
259 #define BOND_PRI_RESELECT_ALWAYS        0
260 #define BOND_PRI_RESELECT_BETTER        1
261 #define BOND_PRI_RESELECT_FAILURE       2
262
263 #define BOND_FOM_NONE                   0
264 #define BOND_FOM_ACTIVE                 1
265 #define BOND_FOM_FOLLOW                 2
266
267 #define BOND_ARP_VALIDATE_NONE          0
268 #define BOND_ARP_VALIDATE_ACTIVE        (1 << BOND_STATE_ACTIVE)
269 #define BOND_ARP_VALIDATE_BACKUP        (1 << BOND_STATE_BACKUP)
270 #define BOND_ARP_VALIDATE_ALL           (BOND_ARP_VALIDATE_ACTIVE | \
271                                          BOND_ARP_VALIDATE_BACKUP)
272
273 static inline int slave_do_arp_validate(struct bonding *bond,
274                                         struct slave *slave)
275 {
276         return bond->params.arp_validate & (1 << slave->state);
277 }
278
279 static inline unsigned long slave_last_rx(struct bonding *bond,
280                                         struct slave *slave)
281 {
282         if (slave_do_arp_validate(bond, slave))
283                 return slave->last_arp_rx;
284
285         return slave->dev->last_rx;
286 }
287
288 static inline void bond_set_slave_inactive_flags(struct slave *slave)
289 {
290         struct bonding *bond = netdev_priv(slave->dev->master);
291         if (!bond_is_lb(bond))
292                 slave->state = BOND_STATE_BACKUP;
293         slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
294         if (slave_do_arp_validate(bond, slave))
295                 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
296 }
297
298 static inline void bond_set_slave_active_flags(struct slave *slave)
299 {
300         slave->state = BOND_STATE_ACTIVE;
301         slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
302 }
303
304 static inline void bond_set_master_3ad_flags(struct bonding *bond)
305 {
306         bond->dev->priv_flags |= IFF_MASTER_8023AD;
307 }
308
309 static inline void bond_unset_master_3ad_flags(struct bonding *bond)
310 {
311         bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
312 }
313
314 static inline void bond_set_master_alb_flags(struct bonding *bond)
315 {
316         bond->dev->priv_flags |= IFF_MASTER_ALB;
317 }
318
319 static inline void bond_unset_master_alb_flags(struct bonding *bond)
320 {
321         bond->dev->priv_flags &= ~IFF_MASTER_ALB;
322 }
323
324 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
325 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
326 int bond_create(struct net *net, const char *name);
327 int  bond_release_and_destroy(struct net_device *bond_dev, struct net_device *slave_dev);
328 int bond_create_sysfs(void);
329 void bond_destroy_sysfs(void);
330 void bond_prepare_sysfs_group(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 struct bond_net {
346         struct net *            net;    /* Associated network namespace */
347         struct list_head        dev_list;
348 #ifdef CONFIG_PROC_FS
349         struct proc_dir_entry * proc_dir;
350 #endif
351 };
352
353 /* exported from bond_main.c */
354 extern int bond_net_id;
355 extern const struct bond_parm_tbl bond_lacp_tbl[];
356 extern const struct bond_parm_tbl bond_mode_tbl[];
357 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
358 extern const struct bond_parm_tbl arp_validate_tbl[];
359 extern const struct bond_parm_tbl fail_over_mac_tbl[];
360 extern const struct bond_parm_tbl pri_reselect_tbl[];
361 extern struct bond_parm_tbl ad_select_tbl[];
362
363 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
364 void bond_send_unsolicited_na(struct bonding *bond);
365 void bond_register_ipv6_notifier(void);
366 void bond_unregister_ipv6_notifier(void);
367 #else
368 static inline void bond_send_unsolicited_na(struct bonding *bond)
369 {
370         return;
371 }
372 static inline void bond_register_ipv6_notifier(void)
373 {
374         return;
375 }
376 static inline void bond_unregister_ipv6_notifier(void)
377 {
378         return;
379 }
380 #endif
381
382 #endif /* _LINUX_BONDING_H */