Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-btrfs-devel.git] / drivers / net / bonding / bonding.h
blob82fec5fc75d7fd84fc861516cd356ae793feb41c
1 /*
2 * Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
4 * Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
5 * NCM: Network and Communications Management, Inc.
7 * BUT, I'm the one who modified it for ethernet, so:
8 * (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
10 * This software may be used and distributed according to the terms
11 * of the GNU Public License, incorporated herein by reference.
15 #ifndef _LINUX_BONDING_H
16 #define _LINUX_BONDING_H
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"
27 #define DRV_VERSION "3.7.1"
28 #define DRV_RELDATE "April 27, 2011"
29 #define DRV_NAME "bonding"
30 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
32 #define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
34 #define BOND_MAX_ARP_TARGETS 16
36 #define IS_UP(dev) \
37 ((((dev)->flags & IFF_UP) == IFF_UP) && \
38 netif_running(dev) && \
39 netif_carrier_ok(dev))
42 * Checks whether slave is ready for transmit.
44 #define SLAVE_IS_OK(slave) \
45 (((slave)->dev->flags & IFF_UP) && \
46 netif_running((slave)->dev) && \
47 ((slave)->link == BOND_LINK_UP) && \
48 bond_is_active_slave(slave))
51 #define USES_PRIMARY(mode) \
52 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
53 ((mode) == BOND_MODE_TLB) || \
54 ((mode) == BOND_MODE_ALB))
56 #define TX_QUEUE_OVERRIDE(mode) \
57 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
58 ((mode) == BOND_MODE_ROUNDROBIN))
60 * Less bad way to call ioctl from within the kernel; this needs to be
61 * done some other way to get the call out of interrupt context.
62 * Needs "ioctl" variable to be supplied by calling context.
64 #define IOCTL(dev, arg, cmd) ({ \
65 int res = 0; \
66 mm_segment_t fs = get_fs(); \
67 set_fs(get_ds()); \
68 res = ioctl(dev, arg, cmd); \
69 set_fs(fs); \
70 res; })
72 /**
73 * bond_for_each_slave_from - iterate the slaves list from a starting point
74 * @bond: the bond holding this list.
75 * @pos: current slave.
76 * @cnt: counter for max number of moves
77 * @start: starting point.
79 * Caller must hold bond->lock
81 #define bond_for_each_slave_from(bond, pos, cnt, start) \
82 for (cnt = 0, pos = start; \
83 cnt < (bond)->slave_cnt; \
84 cnt++, pos = (pos)->next)
86 /**
87 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
88 * @bond: the bond holding this list.
89 * @pos: current slave.
90 * @cnt: counter for number max of moves
91 * @start: start point.
92 * @stop: stop point.
94 * Caller must hold bond->lock
96 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
97 for (cnt = 0, pos = start; \
98 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
99 cnt++, pos = (pos)->next)
102 * bond_for_each_slave - iterate the slaves list from head
103 * @bond: the bond holding this list.
104 * @pos: current slave.
105 * @cnt: counter for max number of moves
107 * Caller must hold bond->lock
109 #define bond_for_each_slave(bond, pos, cnt) \
110 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
113 #ifdef CONFIG_NET_POLL_CONTROLLER
114 extern atomic_t netpoll_block_tx;
116 static inline void block_netpoll_tx(void)
118 atomic_inc(&netpoll_block_tx);
121 static inline void unblock_netpoll_tx(void)
123 atomic_dec(&netpoll_block_tx);
126 static inline int is_netpoll_tx_blocked(struct net_device *dev)
128 if (unlikely(netpoll_tx_running(dev)))
129 return atomic_read(&netpoll_block_tx);
130 return 0;
132 #else
133 #define block_netpoll_tx()
134 #define unblock_netpoll_tx()
135 #define is_netpoll_tx_blocked(dev) (0)
136 #endif
138 struct bond_params {
139 int mode;
140 int xmit_policy;
141 int miimon;
142 u8 num_peer_notif;
143 int arp_interval;
144 int arp_validate;
145 int use_carrier;
146 int fail_over_mac;
147 int updelay;
148 int downdelay;
149 int lacp_fast;
150 unsigned int min_links;
151 int ad_select;
152 char primary[IFNAMSIZ];
153 int primary_reselect;
154 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
155 int tx_queues;
156 int all_slaves_active;
157 int resend_igmp;
160 struct bond_parm_tbl {
161 char *modename;
162 int mode;
165 #define BOND_MAX_MODENAME_LEN 20
167 struct vlan_entry {
168 struct list_head vlan_list;
169 __be32 vlan_ip;
170 unsigned short vlan_id;
173 struct slave {
174 struct net_device *dev; /* first - useful for panic debug */
175 struct slave *next;
176 struct slave *prev;
177 struct bonding *bond; /* our master */
178 int delay;
179 unsigned long jiffies;
180 unsigned long last_arp_rx;
181 s8 link; /* one of BOND_LINK_XXXX */
182 s8 new_link;
183 u8 backup:1, /* indicates backup slave. Value corresponds with
184 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
185 inactive:1; /* indicates inactive slave */
186 u8 duplex;
187 u32 original_mtu;
188 u32 link_failure_count;
189 u32 speed;
190 u16 queue_id;
191 u8 perm_hwaddr[ETH_ALEN];
192 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
193 struct tlb_slave_info tlb_info;
194 #ifdef CONFIG_NET_POLL_CONTROLLER
195 struct netpoll *np;
196 #endif
200 * Link pseudo-state only used internally by monitors
202 #define BOND_LINK_NOCHANGE -1
205 * Here are the locking policies for the two bonding locks:
207 * 1) Get bond->lock when reading/writing slave list.
208 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
209 * (It is unnecessary when the write-lock is put with bond->lock.)
210 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
211 * beforehand.
213 struct bonding {
214 struct net_device *dev; /* first - useful for panic debug */
215 struct slave *first_slave;
216 struct slave *curr_active_slave;
217 struct slave *current_arp_slave;
218 struct slave *primary_slave;
219 bool force_primary;
220 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
221 void (*recv_probe)(struct sk_buff *, struct bonding *,
222 struct slave *);
223 rwlock_t lock;
224 rwlock_t curr_slave_lock;
225 s8 kill_timers;
226 u8 send_peer_notif;
227 s8 setup_by_slave;
228 s8 igmp_retrans;
229 #ifdef CONFIG_PROC_FS
230 struct proc_dir_entry *proc_entry;
231 char proc_file_name[IFNAMSIZ];
232 #endif /* CONFIG_PROC_FS */
233 struct list_head bond_list;
234 struct netdev_hw_addr_list mc_list;
235 int (*xmit_hash_policy)(struct sk_buff *, int);
236 __be32 master_ip;
237 u16 rr_tx_counter;
238 struct ad_bond_info ad_info;
239 struct alb_bond_info alb_info;
240 struct bond_params params;
241 struct list_head vlan_list;
242 struct workqueue_struct *wq;
243 struct delayed_work mii_work;
244 struct delayed_work arp_work;
245 struct delayed_work alb_work;
246 struct delayed_work ad_work;
247 struct delayed_work mcast_work;
248 #ifdef CONFIG_DEBUG_FS
249 /* debugging suport via debugfs */
250 struct dentry *debug_dir;
251 #endif /* CONFIG_DEBUG_FS */
254 static inline bool bond_vlan_used(struct bonding *bond)
256 return !list_empty(&bond->vlan_list);
259 #define bond_slave_get_rcu(dev) \
260 ((struct slave *) rcu_dereference(dev->rx_handler_data))
263 * Returns NULL if the net_device does not belong to any of the bond's slaves
265 * Caller must hold bond lock for read
267 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
268 struct net_device *slave_dev)
270 struct slave *slave = NULL;
271 int i;
273 bond_for_each_slave(bond, slave, i) {
274 if (slave->dev == slave_dev) {
275 return slave;
279 return NULL;
282 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
284 if (!slave || !slave->dev->master) {
285 return NULL;
288 return netdev_priv(slave->dev->master);
291 static inline bool bond_is_lb(const struct bonding *bond)
293 return (bond->params.mode == BOND_MODE_TLB ||
294 bond->params.mode == BOND_MODE_ALB);
297 static inline void bond_set_active_slave(struct slave *slave)
299 slave->backup = 0;
302 static inline void bond_set_backup_slave(struct slave *slave)
304 slave->backup = 1;
307 static inline int bond_slave_state(struct slave *slave)
309 return slave->backup;
312 static inline bool bond_is_active_slave(struct slave *slave)
314 return !bond_slave_state(slave);
317 #define BOND_PRI_RESELECT_ALWAYS 0
318 #define BOND_PRI_RESELECT_BETTER 1
319 #define BOND_PRI_RESELECT_FAILURE 2
321 #define BOND_FOM_NONE 0
322 #define BOND_FOM_ACTIVE 1
323 #define BOND_FOM_FOLLOW 2
325 #define BOND_ARP_VALIDATE_NONE 0
326 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
327 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
328 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
329 BOND_ARP_VALIDATE_BACKUP)
331 static inline int slave_do_arp_validate(struct bonding *bond,
332 struct slave *slave)
334 return bond->params.arp_validate & (1 << bond_slave_state(slave));
337 static inline unsigned long slave_last_rx(struct bonding *bond,
338 struct slave *slave)
340 if (slave_do_arp_validate(bond, slave))
341 return slave->last_arp_rx;
343 return slave->dev->last_rx;
346 #ifdef CONFIG_NET_POLL_CONTROLLER
347 static inline void bond_netpoll_send_skb(const struct slave *slave,
348 struct sk_buff *skb)
350 struct netpoll *np = slave->np;
352 if (np)
353 netpoll_send_skb(np, skb);
355 #else
356 static inline void bond_netpoll_send_skb(const struct slave *slave,
357 struct sk_buff *skb)
360 #endif
362 static inline void bond_set_slave_inactive_flags(struct slave *slave)
364 struct bonding *bond = netdev_priv(slave->dev->master);
365 if (!bond_is_lb(bond))
366 bond_set_backup_slave(slave);
367 if (!bond->params.all_slaves_active)
368 slave->inactive = 1;
371 static inline void bond_set_slave_active_flags(struct slave *slave)
373 bond_set_active_slave(slave);
374 slave->inactive = 0;
377 static inline bool bond_is_slave_inactive(struct slave *slave)
379 return slave->inactive;
382 struct bond_net;
384 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
385 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
386 int bond_create(struct net *net, const char *name);
387 int bond_create_sysfs(struct bond_net *net);
388 void bond_destroy_sysfs(struct bond_net *net);
389 void bond_prepare_sysfs_group(struct bonding *bond);
390 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
391 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
392 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
393 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
394 void bond_mii_monitor(struct work_struct *);
395 void bond_loadbalance_arp_mon(struct work_struct *);
396 void bond_activebackup_arp_mon(struct work_struct *);
397 void bond_set_mode_ops(struct bonding *bond, int mode);
398 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
399 void bond_select_active_slave(struct bonding *bond);
400 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
401 void bond_create_debugfs(void);
402 void bond_destroy_debugfs(void);
403 void bond_debug_register(struct bonding *bond);
404 void bond_debug_unregister(struct bonding *bond);
405 void bond_debug_reregister(struct bonding *bond);
406 const char *bond_mode_name(int mode);
408 struct bond_net {
409 struct net * net; /* Associated network namespace */
410 struct list_head dev_list;
411 #ifdef CONFIG_PROC_FS
412 struct proc_dir_entry * proc_dir;
413 #endif
414 struct class_attribute class_attr_bonding_masters;
417 #ifdef CONFIG_PROC_FS
418 void bond_create_proc_entry(struct bonding *bond);
419 void bond_remove_proc_entry(struct bonding *bond);
420 void bond_create_proc_dir(struct bond_net *bn);
421 void bond_destroy_proc_dir(struct bond_net *bn);
422 #else
423 static inline void bond_create_proc_entry(struct bonding *bond)
427 static inline void bond_remove_proc_entry(struct bonding *bond)
431 static inline void bond_create_proc_dir(struct bond_net *bn)
435 static inline void bond_destroy_proc_dir(struct bond_net *bn)
438 #endif
441 /* exported from bond_main.c */
442 extern int bond_net_id;
443 extern const struct bond_parm_tbl bond_lacp_tbl[];
444 extern const struct bond_parm_tbl bond_mode_tbl[];
445 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
446 extern const struct bond_parm_tbl arp_validate_tbl[];
447 extern const struct bond_parm_tbl fail_over_mac_tbl[];
448 extern const struct bond_parm_tbl pri_reselect_tbl[];
449 extern struct bond_parm_tbl ad_select_tbl[];
451 #endif /* _LINUX_BONDING_H */