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:
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 <linux/inetdevice.h>
25 #include <linux/etherdevice.h>
29 #define DRV_VERSION "3.7.1"
30 #define DRV_RELDATE "April 27, 2011"
31 #define DRV_NAME "bonding"
32 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
34 #define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
36 #define BOND_MAX_ARP_TARGETS 16
39 ((((dev)->flags & IFF_UP) == IFF_UP) && \
40 netif_running(dev) && \
41 netif_carrier_ok(dev))
44 * Checks whether slave is ready for transmit.
46 #define SLAVE_IS_OK(slave) \
47 (((slave)->dev->flags & IFF_UP) && \
48 netif_running((slave)->dev) && \
49 ((slave)->link == BOND_LINK_UP) && \
50 bond_is_active_slave(slave))
53 #define USES_PRIMARY(mode) \
54 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
55 ((mode) == BOND_MODE_TLB) || \
56 ((mode) == BOND_MODE_ALB))
58 #define TX_QUEUE_OVERRIDE(mode) \
59 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
60 ((mode) == BOND_MODE_ROUNDROBIN))
62 * Less bad way to call ioctl from within the kernel; this needs to be
63 * done some other way to get the call out of interrupt context.
64 * Needs "ioctl" variable to be supplied by calling context.
66 #define IOCTL(dev, arg, cmd) ({ \
68 mm_segment_t fs = get_fs(); \
70 res = ioctl(dev, arg, cmd); \
75 * bond_for_each_slave_from - iterate the slaves list from a starting point
76 * @bond: the bond holding this list.
77 * @pos: current slave.
78 * @cnt: counter for max number of moves
79 * @start: starting point.
81 * Caller must hold bond->lock
83 #define bond_for_each_slave_from(bond, pos, cnt, start) \
84 for (cnt = 0, pos = start; \
85 cnt < (bond)->slave_cnt; \
86 cnt++, pos = (pos)->next)
89 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
90 * @bond: the bond holding this list.
91 * @pos: current slave.
92 * @cnt: counter for number max of moves
93 * @start: start point.
96 * Caller must hold bond->lock
98 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
99 for (cnt = 0, pos = start; \
100 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
101 cnt++, pos = (pos)->next)
104 * bond_for_each_slave - iterate the slaves list from head
105 * @bond: the bond holding this list.
106 * @pos: current slave.
107 * @cnt: counter for max number of moves
109 * Caller must hold bond->lock
111 #define bond_for_each_slave(bond, pos, cnt) \
112 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
115 #ifdef CONFIG_NET_POLL_CONTROLLER
116 extern atomic_t netpoll_block_tx;
118 static inline void block_netpoll_tx(void)
120 atomic_inc(&netpoll_block_tx);
123 static inline void unblock_netpoll_tx(void)
125 atomic_dec(&netpoll_block_tx);
128 static inline int is_netpoll_tx_blocked(struct net_device *dev)
130 if (unlikely(netpoll_tx_running(dev)))
131 return atomic_read(&netpoll_block_tx);
135 #define block_netpoll_tx()
136 #define unblock_netpoll_tx()
137 #define is_netpoll_tx_blocked(dev) (0)
153 unsigned int min_links;
155 char primary[IFNAMSIZ];
156 int primary_reselect;
157 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
159 int all_slaves_active;
163 struct bond_parm_tbl {
168 #define BOND_MAX_MODENAME_LEN 20
171 struct list_head vlan_list;
172 unsigned short vlan_id;
176 struct net_device *dev; /* first - useful for panic debug */
179 struct bonding *bond; /* our master */
181 unsigned long jiffies;
182 unsigned long last_arp_rx;
183 unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
184 s8 link; /* one of BOND_LINK_XXXX */
186 u8 backup:1, /* indicates backup slave. Value corresponds with
187 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
188 inactive:1; /* indicates inactive slave */
191 u32 link_failure_count;
194 u8 perm_hwaddr[ETH_ALEN];
195 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
196 struct tlb_slave_info tlb_info;
197 #ifdef CONFIG_NET_POLL_CONTROLLER
203 * Link pseudo-state only used internally by monitors
205 #define BOND_LINK_NOCHANGE -1
208 * Here are the locking policies for the two bonding locks:
210 * 1) Get bond->lock when reading/writing slave list.
211 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
212 * (It is unnecessary when the write-lock is put with bond->lock.)
213 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
217 struct net_device *dev; /* first - useful for panic debug */
218 struct slave *first_slave;
219 struct slave *curr_active_slave;
220 struct slave *current_arp_slave;
221 struct slave *primary_slave;
223 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
224 int (*recv_probe)(const struct sk_buff *, struct bonding *,
227 rwlock_t curr_slave_lock;
230 #ifdef CONFIG_PROC_FS
231 struct proc_dir_entry *proc_entry;
232 char proc_file_name[IFNAMSIZ];
233 #endif /* CONFIG_PROC_FS */
234 struct list_head bond_list;
235 int (*xmit_hash_policy)(struct sk_buff *, int);
237 struct ad_bond_info ad_info;
238 struct alb_bond_info alb_info;
239 struct bond_params params;
240 struct list_head vlan_list;
241 struct workqueue_struct *wq;
242 struct delayed_work mii_work;
243 struct delayed_work arp_work;
244 struct delayed_work alb_work;
245 struct delayed_work ad_work;
246 struct delayed_work mcast_work;
247 #ifdef CONFIG_DEBUG_FS
248 /* debugging support via debugfs */
249 struct dentry *debug_dir;
250 #endif /* CONFIG_DEBUG_FS */
253 static inline bool bond_vlan_used(struct bonding *bond)
255 return !list_empty(&bond->vlan_list);
258 #define bond_slave_get_rcu(dev) \
259 ((struct slave *) rcu_dereference(dev->rx_handler_data))
261 #define bond_slave_get_rtnl(dev) \
262 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
265 * Returns NULL if the net_device does not belong to any of the bond's slaves
267 * Caller must hold bond lock for read
269 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
270 struct net_device *slave_dev)
272 struct slave *slave = NULL;
275 bond_for_each_slave(bond, slave, i) {
276 if (slave->dev == slave_dev) {
284 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
286 if (!slave || !slave->bond)
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)
302 static inline void bond_set_backup_slave(struct slave *slave)
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_TARGETS_ANY 0
326 #define BOND_ARP_TARGETS_ALL 1
328 #define BOND_ARP_VALIDATE_NONE 0
329 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
330 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
331 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
332 BOND_ARP_VALIDATE_BACKUP)
334 static inline int slave_do_arp_validate(struct bonding *bond,
337 return bond->params.arp_validate & (1 << bond_slave_state(slave));
340 /* Get the oldest arp which we've received on this slave for bond's
343 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
347 unsigned long ret = slave->target_last_arp_rx[0];
349 for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
350 if (time_before(slave->target_last_arp_rx[i], ret))
351 ret = slave->target_last_arp_rx[i];
356 static inline unsigned long slave_last_rx(struct bonding *bond,
359 if (slave_do_arp_validate(bond, slave)) {
360 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
361 return slave_oldest_target_arp_rx(bond, slave);
363 return slave->last_arp_rx;
366 return slave->dev->last_rx;
369 #ifdef CONFIG_NET_POLL_CONTROLLER
370 static inline void bond_netpoll_send_skb(const struct slave *slave,
373 struct netpoll *np = slave->np;
376 netpoll_send_skb(np, skb);
379 static inline void bond_netpoll_send_skb(const struct slave *slave,
385 static inline void bond_set_slave_inactive_flags(struct slave *slave)
387 if (!bond_is_lb(slave->bond))
388 bond_set_backup_slave(slave);
389 if (!slave->bond->params.all_slaves_active)
393 static inline void bond_set_slave_active_flags(struct slave *slave)
395 bond_set_active_slave(slave);
399 static inline bool bond_is_slave_inactive(struct slave *slave)
401 return slave->inactive;
404 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
406 struct in_device *in_dev;
410 in_dev = __in_dev_get_rcu(dev);
413 addr = inet_confirm_addr(in_dev, dst, local, RT_SCOPE_HOST);
421 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
422 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
423 int bond_create(struct net *net, const char *name);
424 int bond_create_sysfs(struct bond_net *net);
425 void bond_destroy_sysfs(struct bond_net *net);
426 void bond_prepare_sysfs_group(struct bonding *bond);
427 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
428 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
429 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
430 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
431 void bond_mii_monitor(struct work_struct *);
432 void bond_loadbalance_arp_mon(struct work_struct *);
433 void bond_activebackup_arp_mon(struct work_struct *);
434 void bond_set_mode_ops(struct bonding *bond, int mode);
435 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
436 void bond_select_active_slave(struct bonding *bond);
437 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
438 void bond_create_debugfs(void);
439 void bond_destroy_debugfs(void);
440 void bond_debug_register(struct bonding *bond);
441 void bond_debug_unregister(struct bonding *bond);
442 void bond_debug_reregister(struct bonding *bond);
443 const char *bond_mode_name(int mode);
446 struct net * net; /* Associated network namespace */
447 struct list_head dev_list;
448 #ifdef CONFIG_PROC_FS
449 struct proc_dir_entry * proc_dir;
451 struct class_attribute class_attr_bonding_masters;
454 #ifdef CONFIG_PROC_FS
455 void bond_create_proc_entry(struct bonding *bond);
456 void bond_remove_proc_entry(struct bonding *bond);
457 void bond_create_proc_dir(struct bond_net *bn);
458 void bond_destroy_proc_dir(struct bond_net *bn);
460 static inline void bond_create_proc_entry(struct bonding *bond)
464 static inline void bond_remove_proc_entry(struct bonding *bond)
468 static inline void bond_create_proc_dir(struct bond_net *bn)
472 static inline void bond_destroy_proc_dir(struct bond_net *bn)
477 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
483 bond_for_each_slave(bond, tmp, i)
484 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
490 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
491 * Returns -1 if not found, index if found
493 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
497 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
498 if (targets[i] == ip)
500 else if (targets[i] == 0)
506 /* exported from bond_main.c */
507 extern int bond_net_id;
508 extern const struct bond_parm_tbl bond_lacp_tbl[];
509 extern const struct bond_parm_tbl bond_mode_tbl[];
510 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
511 extern const struct bond_parm_tbl arp_validate_tbl[];
512 extern const struct bond_parm_tbl arp_all_targets_tbl[];
513 extern const struct bond_parm_tbl fail_over_mac_tbl[];
514 extern const struct bond_parm_tbl pri_reselect_tbl[];
515 extern struct bond_parm_tbl ad_select_tbl[];
517 #endif /* _LINUX_BONDING_H */