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 <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 #define BOND_MODE_IS_LB(mode) \
63 (((mode) == BOND_MODE_TLB) || \
64 ((mode) == BOND_MODE_ALB))
66 #define IS_IP_TARGET_UNUSABLE_ADDRESS(a) \
67 ((htonl(INADDR_BROADCAST) == a) || \
70 * Less bad way to call ioctl from within the kernel; this needs to be
71 * done some other way to get the call out of interrupt context.
72 * Needs "ioctl" variable to be supplied by calling context.
74 #define IOCTL(dev, arg, cmd) ({ \
76 mm_segment_t fs = get_fs(); \
78 res = ioctl(dev, arg, cmd); \
82 /* slave list primitives */
83 #define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
85 #define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
87 /* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
88 #define bond_first_slave(bond) \
89 (bond_has_slaves(bond) ? \
90 netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
92 #define bond_last_slave(bond) \
93 (bond_has_slaves(bond) ? \
94 netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
97 #define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
98 #define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
101 * bond_for_each_slave - iterate over all slaves
102 * @bond: the bond holding this list
103 * @pos: current slave
104 * @iter: list_head * iterator
106 * Caller must hold bond->lock
108 #define bond_for_each_slave(bond, pos, iter) \
109 netdev_for_each_lower_private((bond)->dev, pos, iter)
111 /* Caller must have rcu_read_lock */
112 #define bond_for_each_slave_rcu(bond, pos, iter) \
113 netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
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;
162 int packets_per_slave;
165 struct bond_parm_tbl {
170 #define BOND_MAX_MODENAME_LEN 20
173 struct net_device *dev; /* first - useful for panic debug */
174 struct bonding *bond; /* our master */
176 unsigned long jiffies;
177 unsigned long last_arp_rx;
178 unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
179 s8 link; /* one of BOND_LINK_XXXX */
181 u8 backup:1, /* indicates backup slave. Value corresponds with
182 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
183 inactive:1; /* indicates inactive slave */
186 u32 link_failure_count;
189 u8 perm_hwaddr[ETH_ALEN];
190 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
191 struct tlb_slave_info tlb_info;
192 #ifdef CONFIG_NET_POLL_CONTROLLER
198 * Link pseudo-state only used internally by monitors
200 #define BOND_LINK_NOCHANGE -1
203 * Here are the locking policies for the two bonding locks:
205 * 1) Get bond->lock when reading/writing slave list.
206 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
207 * (It is unnecessary when the write-lock is put with bond->lock.)
208 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
212 struct net_device *dev; /* first - useful for panic debug */
213 struct slave *curr_active_slave;
214 struct slave *current_arp_slave;
215 struct slave *primary_slave;
217 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
218 int (*recv_probe)(const struct sk_buff *, struct bonding *,
221 rwlock_t curr_slave_lock;
224 #ifdef CONFIG_PROC_FS
225 struct proc_dir_entry *proc_entry;
226 char proc_file_name[IFNAMSIZ];
227 #endif /* CONFIG_PROC_FS */
228 struct list_head bond_list;
230 struct ad_bond_info ad_info;
231 struct alb_bond_info alb_info;
232 struct bond_params params;
233 struct workqueue_struct *wq;
234 struct delayed_work mii_work;
235 struct delayed_work arp_work;
236 struct delayed_work alb_work;
237 struct delayed_work ad_work;
238 struct delayed_work mcast_work;
239 #ifdef CONFIG_DEBUG_FS
240 /* debugging support via debugfs */
241 struct dentry *debug_dir;
242 #endif /* CONFIG_DEBUG_FS */
245 #define bond_slave_get_rcu(dev) \
246 ((struct slave *) rcu_dereference(dev->rx_handler_data))
248 #define bond_slave_get_rtnl(dev) \
249 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
252 * Returns NULL if the net_device does not belong to any of the bond's slaves
254 * Caller must hold bond lock for read
256 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
257 struct net_device *slave_dev)
259 return netdev_lower_dev_get_private(bond->dev, slave_dev);
262 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
264 if (!slave || !slave->bond)
269 static inline bool bond_is_lb(const struct bonding *bond)
271 return BOND_MODE_IS_LB(bond->params.mode);
274 static inline void bond_set_active_slave(struct slave *slave)
279 static inline void bond_set_backup_slave(struct slave *slave)
284 static inline int bond_slave_state(struct slave *slave)
286 return slave->backup;
289 static inline bool bond_is_active_slave(struct slave *slave)
291 return !bond_slave_state(slave);
294 #define BOND_PRI_RESELECT_ALWAYS 0
295 #define BOND_PRI_RESELECT_BETTER 1
296 #define BOND_PRI_RESELECT_FAILURE 2
298 #define BOND_FOM_NONE 0
299 #define BOND_FOM_ACTIVE 1
300 #define BOND_FOM_FOLLOW 2
302 #define BOND_ARP_TARGETS_ANY 0
303 #define BOND_ARP_TARGETS_ALL 1
305 #define BOND_ARP_VALIDATE_NONE 0
306 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
307 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
308 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
309 BOND_ARP_VALIDATE_BACKUP)
311 static inline int slave_do_arp_validate(struct bonding *bond,
314 return bond->params.arp_validate & (1 << bond_slave_state(slave));
317 /* Get the oldest arp which we've received on this slave for bond's
320 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
324 unsigned long ret = slave->target_last_arp_rx[0];
326 for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
327 if (time_before(slave->target_last_arp_rx[i], ret))
328 ret = slave->target_last_arp_rx[i];
333 static inline unsigned long slave_last_rx(struct bonding *bond,
336 if (slave_do_arp_validate(bond, slave)) {
337 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
338 return slave_oldest_target_arp_rx(bond, slave);
340 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,
350 struct netpoll *np = slave->np;
353 netpoll_send_skb(np, skb);
356 static inline void bond_netpoll_send_skb(const struct slave *slave,
362 static inline void bond_set_slave_inactive_flags(struct slave *slave)
364 if (!bond_is_lb(slave->bond))
365 bond_set_backup_slave(slave);
366 if (!slave->bond->params.all_slaves_active)
370 static inline void bond_set_slave_active_flags(struct slave *slave)
372 bond_set_active_slave(slave);
376 static inline bool bond_is_slave_inactive(struct slave *slave)
378 return slave->inactive;
381 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
383 struct in_device *in_dev;
387 in_dev = __in_dev_get_rcu(dev);
390 addr = inet_confirm_addr(in_dev, dst, local, RT_SCOPE_HOST);
396 static inline bool slave_can_tx(struct slave *slave)
398 if (IS_UP(slave->dev) && slave->link == BOND_LINK_UP &&
399 bond_is_active_slave(slave))
407 int bond_arp_rcv(const struct sk_buff *skb, struct bonding *bond, struct slave *slave);
408 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
409 void bond_xmit_slave_id(struct bonding *bond, struct sk_buff *skb, int slave_id);
410 int bond_create(struct net *net, const char *name);
411 int bond_create_sysfs(struct bond_net *net);
412 void bond_destroy_sysfs(struct bond_net *net);
413 void bond_prepare_sysfs_group(struct bonding *bond);
414 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
415 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
416 void bond_mii_monitor(struct work_struct *);
417 void bond_loadbalance_arp_mon(struct work_struct *);
418 void bond_activebackup_arp_mon(struct work_struct *);
419 int bond_xmit_hash(struct bonding *bond, struct sk_buff *skb, int count);
420 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
421 void bond_select_active_slave(struct bonding *bond);
422 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
423 void bond_create_debugfs(void);
424 void bond_destroy_debugfs(void);
425 void bond_debug_register(struct bonding *bond);
426 void bond_debug_unregister(struct bonding *bond);
427 void bond_debug_reregister(struct bonding *bond);
428 const char *bond_mode_name(int mode);
429 void bond_setup(struct net_device *bond_dev);
430 unsigned int bond_get_num_tx_queues(void);
431 int bond_netlink_init(void);
432 void bond_netlink_fini(void);
433 int bond_option_mode_set(struct bonding *bond, int mode);
434 int bond_option_active_slave_set(struct bonding *bond, struct net_device *slave_dev);
435 struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond);
436 struct net_device *bond_option_active_slave_get(struct bonding *bond);
439 struct net * net; /* Associated network namespace */
440 struct list_head dev_list;
441 #ifdef CONFIG_PROC_FS
442 struct proc_dir_entry * proc_dir;
444 struct class_attribute class_attr_bonding_masters;
447 #ifdef CONFIG_PROC_FS
448 void bond_create_proc_entry(struct bonding *bond);
449 void bond_remove_proc_entry(struct bonding *bond);
450 void bond_create_proc_dir(struct bond_net *bn);
451 void bond_destroy_proc_dir(struct bond_net *bn);
453 static inline void bond_create_proc_entry(struct bonding *bond)
457 static inline void bond_remove_proc_entry(struct bonding *bond)
461 static inline void bond_create_proc_dir(struct bond_net *bn)
465 static inline void bond_destroy_proc_dir(struct bond_net *bn)
470 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
473 struct list_head *iter;
476 bond_for_each_slave(bond, tmp, iter)
477 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
483 /* Caller must hold rcu_read_lock() for read */
484 static inline struct slave *bond_slave_has_mac_rcu(struct bonding *bond,
487 struct list_head *iter;
490 bond_for_each_slave_rcu(bond, tmp, iter)
491 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
497 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
498 * Returns -1 if not found, index if found
500 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
504 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
505 if (targets[i] == ip)
507 else if (targets[i] == 0)
513 /* exported from bond_main.c */
514 extern int bond_net_id;
515 extern const struct bond_parm_tbl bond_lacp_tbl[];
516 extern const struct bond_parm_tbl bond_mode_tbl[];
517 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
518 extern const struct bond_parm_tbl arp_validate_tbl[];
519 extern const struct bond_parm_tbl arp_all_targets_tbl[];
520 extern const struct bond_parm_tbl fail_over_mac_tbl[];
521 extern const struct bond_parm_tbl pri_reselect_tbl[];
522 extern struct bond_parm_tbl ad_select_tbl[];
524 /* exported from bond_netlink.c */
525 extern struct rtnl_link_ops bond_link_ops;
527 #endif /* _LINUX_BONDING_H */