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
38 #define BOND_DEFAULT_MIIMON 100
41 ((((dev)->flags & IFF_UP) == IFF_UP) && \
42 netif_running(dev) && \
43 netif_carrier_ok(dev))
46 * Checks whether slave is ready for transmit.
48 #define SLAVE_IS_OK(slave) \
49 (((slave)->dev->flags & IFF_UP) && \
50 netif_running((slave)->dev) && \
51 ((slave)->link == BOND_LINK_UP) && \
52 bond_is_active_slave(slave))
55 #define USES_PRIMARY(mode) \
56 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
57 ((mode) == BOND_MODE_TLB) || \
58 ((mode) == BOND_MODE_ALB))
60 #define BOND_NO_USES_ARP(mode) \
61 (((mode) == BOND_MODE_8023AD) || \
62 ((mode) == BOND_MODE_TLB) || \
63 ((mode) == BOND_MODE_ALB))
65 #define TX_QUEUE_OVERRIDE(mode) \
66 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
67 ((mode) == BOND_MODE_ROUNDROBIN))
69 #define BOND_MODE_IS_LB(mode) \
70 (((mode) == BOND_MODE_TLB) || \
71 ((mode) == BOND_MODE_ALB))
73 #define IS_IP_TARGET_UNUSABLE_ADDRESS(a) \
74 ((htonl(INADDR_BROADCAST) == a) || \
77 * Less bad way to call ioctl from within the kernel; this needs to be
78 * done some other way to get the call out of interrupt context.
79 * Needs "ioctl" variable to be supplied by calling context.
81 #define IOCTL(dev, arg, cmd) ({ \
83 mm_segment_t fs = get_fs(); \
85 res = ioctl(dev, arg, cmd); \
89 /* slave list primitives */
90 #define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
92 #define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
94 /* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
95 #define bond_first_slave(bond) \
96 (bond_has_slaves(bond) ? \
97 netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
99 #define bond_last_slave(bond) \
100 (bond_has_slaves(bond) ? \
101 netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
104 /* Caller must have rcu_read_lock */
105 #define bond_first_slave_rcu(bond) \
106 netdev_lower_get_first_private_rcu(bond->dev)
108 #define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
109 #define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
112 * bond_for_each_slave - iterate over all slaves
113 * @bond: the bond holding this list
114 * @pos: current slave
115 * @iter: list_head * iterator
117 * Caller must hold bond->lock
119 #define bond_for_each_slave(bond, pos, iter) \
120 netdev_for_each_lower_private((bond)->dev, pos, iter)
122 /* Caller must have rcu_read_lock */
123 #define bond_for_each_slave_rcu(bond, pos, iter) \
124 netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
126 #ifdef CONFIG_NET_POLL_CONTROLLER
127 extern atomic_t netpoll_block_tx;
129 static inline void block_netpoll_tx(void)
131 atomic_inc(&netpoll_block_tx);
134 static inline void unblock_netpoll_tx(void)
136 atomic_dec(&netpoll_block_tx);
139 static inline int is_netpoll_tx_blocked(struct net_device *dev)
141 if (unlikely(netpoll_tx_running(dev)))
142 return atomic_read(&netpoll_block_tx);
146 #define block_netpoll_tx()
147 #define unblock_netpoll_tx()
148 #define is_netpoll_tx_blocked(dev) (0)
164 unsigned int min_links;
166 char primary[IFNAMSIZ];
167 int primary_reselect;
168 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
170 int all_slaves_active;
173 int packets_per_slave;
176 struct bond_parm_tbl {
181 #define BOND_MAX_MODENAME_LEN 20
184 struct net_device *dev; /* first - useful for panic debug */
185 struct bonding *bond; /* our master */
187 unsigned long jiffies;
188 unsigned long last_arp_rx;
189 unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
190 s8 link; /* one of BOND_LINK_XXXX */
192 u8 backup:1, /* indicates backup slave. Value corresponds with
193 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
194 inactive:1; /* indicates inactive slave */
197 u32 link_failure_count;
200 u8 perm_hwaddr[ETH_ALEN];
201 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
202 struct tlb_slave_info tlb_info;
203 #ifdef CONFIG_NET_POLL_CONTROLLER
209 * Link pseudo-state only used internally by monitors
211 #define BOND_LINK_NOCHANGE -1
214 * Here are the locking policies for the two bonding locks:
216 * 1) Get bond->lock when reading/writing slave list.
217 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
218 * (It is unnecessary when the write-lock is put with bond->lock.)
219 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
223 struct net_device *dev; /* first - useful for panic debug */
224 struct slave *curr_active_slave;
225 struct slave *current_arp_slave;
226 struct slave *primary_slave;
228 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
229 int (*recv_probe)(const struct sk_buff *, struct bonding *,
232 rwlock_t curr_slave_lock;
235 #ifdef CONFIG_PROC_FS
236 struct proc_dir_entry *proc_entry;
237 char proc_file_name[IFNAMSIZ];
238 #endif /* CONFIG_PROC_FS */
239 struct list_head bond_list;
241 struct ad_bond_info ad_info;
242 struct alb_bond_info alb_info;
243 struct bond_params params;
244 struct workqueue_struct *wq;
245 struct delayed_work mii_work;
246 struct delayed_work arp_work;
247 struct delayed_work alb_work;
248 struct delayed_work ad_work;
249 struct delayed_work mcast_work;
250 #ifdef CONFIG_DEBUG_FS
251 /* debugging support via debugfs */
252 struct dentry *debug_dir;
253 #endif /* CONFIG_DEBUG_FS */
256 #define bond_slave_get_rcu(dev) \
257 ((struct slave *) rcu_dereference(dev->rx_handler_data))
259 #define bond_slave_get_rtnl(dev) \
260 ((struct slave *) rtnl_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 return netdev_lower_dev_get_private(bond->dev, slave_dev);
273 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
275 if (!slave || !slave->bond)
280 static inline bool bond_is_lb(const struct bonding *bond)
282 return BOND_MODE_IS_LB(bond->params.mode);
285 static inline void bond_set_active_slave(struct slave *slave)
290 static inline void bond_set_backup_slave(struct slave *slave)
295 static inline int bond_slave_state(struct slave *slave)
297 return slave->backup;
300 static inline bool bond_is_active_slave(struct slave *slave)
302 return !bond_slave_state(slave);
305 #define BOND_PRI_RESELECT_ALWAYS 0
306 #define BOND_PRI_RESELECT_BETTER 1
307 #define BOND_PRI_RESELECT_FAILURE 2
309 #define BOND_FOM_NONE 0
310 #define BOND_FOM_ACTIVE 1
311 #define BOND_FOM_FOLLOW 2
313 #define BOND_ARP_TARGETS_ANY 0
314 #define BOND_ARP_TARGETS_ALL 1
316 #define BOND_ARP_VALIDATE_NONE 0
317 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
318 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
319 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
320 BOND_ARP_VALIDATE_BACKUP)
322 static inline int slave_do_arp_validate(struct bonding *bond,
325 return bond->params.arp_validate & (1 << bond_slave_state(slave));
328 /* Get the oldest arp which we've received on this slave for bond's
331 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
335 unsigned long ret = slave->target_last_arp_rx[0];
337 for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
338 if (time_before(slave->target_last_arp_rx[i], ret))
339 ret = slave->target_last_arp_rx[i];
344 static inline unsigned long slave_last_rx(struct bonding *bond,
347 if (slave_do_arp_validate(bond, slave)) {
348 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
349 return slave_oldest_target_arp_rx(bond, slave);
351 return slave->last_arp_rx;
354 return slave->dev->last_rx;
357 #ifdef CONFIG_NET_POLL_CONTROLLER
358 static inline void bond_netpoll_send_skb(const struct slave *slave,
361 struct netpoll *np = slave->np;
364 netpoll_send_skb(np, skb);
367 static inline void bond_netpoll_send_skb(const struct slave *slave,
373 static inline void bond_set_slave_inactive_flags(struct slave *slave)
375 if (!bond_is_lb(slave->bond))
376 bond_set_backup_slave(slave);
377 if (!slave->bond->params.all_slaves_active)
381 static inline void bond_set_slave_active_flags(struct slave *slave)
383 bond_set_active_slave(slave);
387 static inline bool bond_is_slave_inactive(struct slave *slave)
389 return slave->inactive;
392 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
394 struct in_device *in_dev;
398 in_dev = __in_dev_get_rcu(dev);
401 addr = inet_confirm_addr(dev_net(dev), in_dev, dst, local,
407 static inline bool slave_can_tx(struct slave *slave)
409 if (IS_UP(slave->dev) && slave->link == BOND_LINK_UP &&
410 bond_is_active_slave(slave))
418 int bond_arp_rcv(const struct sk_buff *skb, struct bonding *bond, struct slave *slave);
419 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
420 int bond_create(struct net *net, const char *name);
421 int bond_create_sysfs(struct bond_net *net);
422 void bond_destroy_sysfs(struct bond_net *net);
423 void bond_prepare_sysfs_group(struct bonding *bond);
424 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
425 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
426 void bond_mii_monitor(struct work_struct *);
427 void bond_loadbalance_arp_mon(struct work_struct *);
428 void bond_activebackup_arp_mon(struct work_struct *);
429 int bond_xmit_hash(struct bonding *bond, struct sk_buff *skb, int count);
430 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
431 void bond_select_active_slave(struct bonding *bond);
432 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
433 void bond_create_debugfs(void);
434 void bond_destroy_debugfs(void);
435 void bond_debug_register(struct bonding *bond);
436 void bond_debug_unregister(struct bonding *bond);
437 void bond_debug_reregister(struct bonding *bond);
438 const char *bond_mode_name(int mode);
439 void bond_setup(struct net_device *bond_dev);
440 unsigned int bond_get_num_tx_queues(void);
441 int bond_netlink_init(void);
442 void bond_netlink_fini(void);
443 int bond_option_mode_set(struct bonding *bond, int mode);
444 int bond_option_active_slave_set(struct bonding *bond, struct net_device *slave_dev);
445 int bond_option_miimon_set(struct bonding *bond, int miimon);
446 int bond_option_updelay_set(struct bonding *bond, int updelay);
447 int bond_option_downdelay_set(struct bonding *bond, int downdelay);
448 int bond_option_use_carrier_set(struct bonding *bond, int use_carrier);
449 int bond_option_arp_interval_set(struct bonding *bond, int arp_interval);
450 int bond_option_arp_ip_targets_set(struct bonding *bond, __be32 *targets,
452 int bond_option_arp_ip_target_add(struct bonding *bond, __be32 target);
453 int bond_option_arp_ip_target_rem(struct bonding *bond, __be32 target);
454 int bond_option_arp_validate_set(struct bonding *bond, int arp_validate);
455 int bond_option_arp_all_targets_set(struct bonding *bond, int arp_all_targets);
456 int bond_option_primary_set(struct bonding *bond, const char *primary);
457 int bond_option_primary_reselect_set(struct bonding *bond,
458 int primary_reselect);
459 int bond_option_fail_over_mac_set(struct bonding *bond, int fail_over_mac);
460 int bond_option_xmit_hash_policy_set(struct bonding *bond,
461 int xmit_hash_policy);
462 int bond_option_resend_igmp_set(struct bonding *bond, int resend_igmp);
463 int bond_option_num_peer_notif_set(struct bonding *bond, int num_peer_notif);
464 int bond_option_all_slaves_active_set(struct bonding *bond,
465 int all_slaves_active);
466 int bond_option_min_links_set(struct bonding *bond, int min_links);
467 int bond_option_lp_interval_set(struct bonding *bond, int min_links);
468 int bond_option_packets_per_slave_set(struct bonding *bond,
469 int packets_per_slave);
470 struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond);
471 struct net_device *bond_option_active_slave_get(struct bonding *bond);
474 struct net * net; /* Associated network namespace */
475 struct list_head dev_list;
476 #ifdef CONFIG_PROC_FS
477 struct proc_dir_entry * proc_dir;
479 struct class_attribute class_attr_bonding_masters;
482 #ifdef CONFIG_PROC_FS
483 void bond_create_proc_entry(struct bonding *bond);
484 void bond_remove_proc_entry(struct bonding *bond);
485 void bond_create_proc_dir(struct bond_net *bn);
486 void bond_destroy_proc_dir(struct bond_net *bn);
488 static inline void bond_create_proc_entry(struct bonding *bond)
492 static inline void bond_remove_proc_entry(struct bonding *bond)
496 static inline void bond_create_proc_dir(struct bond_net *bn)
500 static inline void bond_destroy_proc_dir(struct bond_net *bn)
505 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
508 struct list_head *iter;
511 bond_for_each_slave(bond, tmp, iter)
512 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
518 /* Caller must hold rcu_read_lock() for read */
519 static inline struct slave *bond_slave_has_mac_rcu(struct bonding *bond,
522 struct list_head *iter;
525 bond_for_each_slave_rcu(bond, tmp, iter)
526 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
532 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
533 * Returns -1 if not found, index if found
535 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
539 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
540 if (targets[i] == ip)
542 else if (targets[i] == 0)
548 /* exported from bond_main.c */
549 extern int bond_net_id;
550 extern const struct bond_parm_tbl bond_lacp_tbl[];
551 extern const struct bond_parm_tbl bond_mode_tbl[];
552 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
553 extern const struct bond_parm_tbl arp_validate_tbl[];
554 extern const struct bond_parm_tbl arp_all_targets_tbl[];
555 extern const struct bond_parm_tbl fail_over_mac_tbl[];
556 extern const struct bond_parm_tbl pri_reselect_tbl[];
557 extern struct bond_parm_tbl ad_select_tbl[];
559 /* exported from bond_netlink.c */
560 extern struct rtnl_link_ops bond_link_ops;
562 #endif /* _LINUX_BONDING_H */