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>
26 #include <linux/reciprocal_div.h>
30 #include "bond_options.h"
32 #define DRV_VERSION "3.7.1"
33 #define DRV_RELDATE "April 27, 2011"
34 #define DRV_NAME "bonding"
35 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
37 #define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
39 #define BOND_MAX_ARP_TARGETS 16
41 #define BOND_DEFAULT_MIIMON 100
44 ((((dev)->flags & IFF_UP) == IFF_UP) && \
45 netif_running(dev) && \
46 netif_carrier_ok(dev))
49 * Checks whether slave is ready for transmit.
51 #define SLAVE_IS_OK(slave) \
52 (((slave)->dev->flags & IFF_UP) && \
53 netif_running((slave)->dev) && \
54 ((slave)->link == BOND_LINK_UP) && \
55 bond_is_active_slave(slave))
57 #define IS_IP_TARGET_UNUSABLE_ADDRESS(a) \
58 ((htonl(INADDR_BROADCAST) == a) || \
61 * Less bad way to call ioctl from within the kernel; this needs to be
62 * done some other way to get the call out of interrupt context.
63 * Needs "ioctl" variable to be supplied by calling context.
65 #define IOCTL(dev, arg, cmd) ({ \
67 mm_segment_t fs = get_fs(); \
69 res = ioctl(dev, arg, cmd); \
73 #define BOND_MODE(bond) ((bond)->params.mode)
75 /* slave list primitives */
76 #define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
78 #define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
80 /* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
81 #define bond_first_slave(bond) \
82 (bond_has_slaves(bond) ? \
83 netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
85 #define bond_last_slave(bond) \
86 (bond_has_slaves(bond) ? \
87 netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
90 /* Caller must have rcu_read_lock */
91 #define bond_first_slave_rcu(bond) \
92 netdev_lower_get_first_private_rcu(bond->dev)
94 #define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
95 #define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
98 * bond_for_each_slave - iterate over all slaves
99 * @bond: the bond holding this list
100 * @pos: current slave
101 * @iter: list_head * iterator
103 * Caller must hold bond->lock
105 #define bond_for_each_slave(bond, pos, iter) \
106 netdev_for_each_lower_private((bond)->dev, pos, iter)
108 /* Caller must have rcu_read_lock */
109 #define bond_for_each_slave_rcu(bond, pos, iter) \
110 netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
112 #ifdef CONFIG_NET_POLL_CONTROLLER
113 extern atomic_t netpoll_block_tx;
115 static inline void block_netpoll_tx(void)
117 atomic_inc(&netpoll_block_tx);
120 static inline void unblock_netpoll_tx(void)
122 atomic_dec(&netpoll_block_tx);
125 static inline int is_netpoll_tx_blocked(struct net_device *dev)
127 if (unlikely(netpoll_tx_running(dev)))
128 return atomic_read(&netpoll_block_tx);
132 #define block_netpoll_tx()
133 #define unblock_netpoll_tx()
134 #define is_netpoll_tx_blocked(dev) (0)
150 unsigned int min_links;
152 char primary[IFNAMSIZ];
153 int primary_reselect;
154 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
156 int all_slaves_active;
159 int packets_per_slave;
161 struct reciprocal_value reciprocal_packets_per_slave;
164 struct bond_parm_tbl {
170 struct net_device *dev; /* first - useful for panic debug */
171 struct bonding *bond; /* our master */
173 /* all three in jiffies */
174 unsigned long last_link_up;
175 unsigned long last_rx;
176 unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
177 s8 link; /* one of BOND_LINK_XXXX */
179 u8 backup:1, /* indicates backup slave. Value corresponds with
180 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
181 inactive:1, /* indicates inactive slave */
182 should_notify:1; /* indicateds whether the state changed */
185 u32 link_failure_count;
188 u8 perm_hwaddr[ETH_ALEN];
189 struct ad_slave_info *ad_info;
190 struct tlb_slave_info tlb_info;
191 #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))
251 struct bond_vlan_tag {
253 unsigned short vlan_id;
257 * Returns NULL if the net_device does not belong to any of the bond's slaves
259 * Caller must hold bond lock for read
261 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
262 struct net_device *slave_dev)
264 return netdev_lower_dev_get_private(bond->dev, slave_dev);
267 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
269 if (!slave || !slave->bond)
274 static inline bool bond_should_override_tx_queue(struct bonding *bond)
276 return BOND_MODE(bond) == BOND_MODE_ACTIVEBACKUP ||
277 BOND_MODE(bond) == BOND_MODE_ROUNDROBIN;
280 static inline bool bond_is_lb(const struct bonding *bond)
282 return BOND_MODE(bond) == BOND_MODE_TLB ||
283 BOND_MODE(bond) == BOND_MODE_ALB;
286 static inline bool bond_mode_uses_arp(int mode)
288 return mode != BOND_MODE_8023AD && mode != BOND_MODE_TLB &&
289 mode != BOND_MODE_ALB;
292 static inline bool bond_mode_uses_primary(int mode)
294 return mode == BOND_MODE_ACTIVEBACKUP || mode == BOND_MODE_TLB ||
295 mode == BOND_MODE_ALB;
298 static inline bool bond_uses_primary(struct bonding *bond)
300 return bond_mode_uses_primary(BOND_MODE(bond));
303 static inline void bond_set_active_slave(struct slave *slave)
307 rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
311 static inline void bond_set_backup_slave(struct slave *slave)
313 if (!slave->backup) {
315 rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
319 static inline void bond_set_slave_state(struct slave *slave,
320 int slave_state, bool notify)
322 if (slave->backup == slave_state)
325 slave->backup = slave_state;
327 rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
328 slave->should_notify = 0;
330 if (slave->should_notify)
331 slave->should_notify = 0;
333 slave->should_notify = 1;
337 static inline void bond_slave_state_change(struct bonding *bond)
339 struct list_head *iter;
342 bond_for_each_slave(bond, tmp, iter) {
343 if (tmp->link == BOND_LINK_UP)
344 bond_set_active_slave(tmp);
345 else if (tmp->link == BOND_LINK_DOWN)
346 bond_set_backup_slave(tmp);
350 static inline void bond_slave_state_notify(struct bonding *bond)
352 struct list_head *iter;
355 bond_for_each_slave(bond, tmp, iter) {
356 if (tmp->should_notify) {
357 rtmsg_ifinfo(RTM_NEWLINK, tmp->dev, 0, GFP_ATOMIC);
358 tmp->should_notify = 0;
363 static inline int bond_slave_state(struct slave *slave)
365 return slave->backup;
368 static inline bool bond_is_active_slave(struct slave *slave)
370 return !bond_slave_state(slave);
373 #define BOND_PRI_RESELECT_ALWAYS 0
374 #define BOND_PRI_RESELECT_BETTER 1
375 #define BOND_PRI_RESELECT_FAILURE 2
377 #define BOND_FOM_NONE 0
378 #define BOND_FOM_ACTIVE 1
379 #define BOND_FOM_FOLLOW 2
381 #define BOND_ARP_TARGETS_ANY 0
382 #define BOND_ARP_TARGETS_ALL 1
384 #define BOND_ARP_VALIDATE_NONE 0
385 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
386 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
387 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
388 BOND_ARP_VALIDATE_BACKUP)
389 #define BOND_ARP_FILTER (BOND_ARP_VALIDATE_ALL + 1)
390 #define BOND_ARP_FILTER_ACTIVE (BOND_ARP_VALIDATE_ACTIVE | \
392 #define BOND_ARP_FILTER_BACKUP (BOND_ARP_VALIDATE_BACKUP | \
395 #define BOND_SLAVE_NOTIFY_NOW true
396 #define BOND_SLAVE_NOTIFY_LATER false
398 static inline int slave_do_arp_validate(struct bonding *bond,
401 return bond->params.arp_validate & (1 << bond_slave_state(slave));
404 static inline int slave_do_arp_validate_only(struct bonding *bond)
406 return bond->params.arp_validate & BOND_ARP_FILTER;
409 /* Get the oldest arp which we've received on this slave for bond's
412 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
416 unsigned long ret = slave->target_last_arp_rx[0];
418 for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
419 if (time_before(slave->target_last_arp_rx[i], ret))
420 ret = slave->target_last_arp_rx[i];
425 static inline unsigned long slave_last_rx(struct bonding *bond,
428 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
429 return slave_oldest_target_arp_rx(bond, slave);
431 return slave->last_rx;
434 #ifdef CONFIG_NET_POLL_CONTROLLER
435 static inline void bond_netpoll_send_skb(const struct slave *slave,
438 struct netpoll *np = slave->np;
441 netpoll_send_skb(np, skb);
444 static inline void bond_netpoll_send_skb(const struct slave *slave,
450 static inline void bond_set_slave_inactive_flags(struct slave *slave,
453 if (!bond_is_lb(slave->bond))
454 bond_set_slave_state(slave, BOND_STATE_BACKUP, notify);
455 if (!slave->bond->params.all_slaves_active)
459 static inline void bond_set_slave_active_flags(struct slave *slave,
462 bond_set_slave_state(slave, BOND_STATE_ACTIVE, notify);
466 static inline bool bond_is_slave_inactive(struct slave *slave)
468 return slave->inactive;
471 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
473 struct in_device *in_dev;
477 in_dev = __in_dev_get_rcu(dev);
480 addr = inet_confirm_addr(dev_net(dev), in_dev, dst, local,
486 static inline bool slave_can_tx(struct slave *slave)
488 if (IS_UP(slave->dev) && slave->link == BOND_LINK_UP &&
489 bond_is_active_slave(slave))
496 struct net *net; /* Associated network namespace */
497 struct list_head dev_list;
498 #ifdef CONFIG_PROC_FS
499 struct proc_dir_entry *proc_dir;
501 struct class_attribute class_attr_bonding_masters;
504 int bond_arp_rcv(const struct sk_buff *skb, struct bonding *bond, struct slave *slave);
505 void bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
506 int bond_create(struct net *net, const char *name);
507 int bond_create_sysfs(struct bond_net *net);
508 void bond_destroy_sysfs(struct bond_net *net);
509 void bond_prepare_sysfs_group(struct bonding *bond);
510 int bond_sysfs_slave_add(struct slave *slave);
511 void bond_sysfs_slave_del(struct slave *slave);
512 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
513 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
514 u32 bond_xmit_hash(struct bonding *bond, struct sk_buff *skb);
515 void bond_select_active_slave(struct bonding *bond);
516 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
517 void bond_create_debugfs(void);
518 void bond_destroy_debugfs(void);
519 void bond_debug_register(struct bonding *bond);
520 void bond_debug_unregister(struct bonding *bond);
521 void bond_debug_reregister(struct bonding *bond);
522 const char *bond_mode_name(int mode);
523 void bond_setup(struct net_device *bond_dev);
524 unsigned int bond_get_num_tx_queues(void);
525 int bond_netlink_init(void);
526 void bond_netlink_fini(void);
527 struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond);
528 struct net_device *bond_option_active_slave_get(struct bonding *bond);
529 const char *bond_slave_link_status(s8 link);
531 #ifdef CONFIG_PROC_FS
532 void bond_create_proc_entry(struct bonding *bond);
533 void bond_remove_proc_entry(struct bonding *bond);
534 void bond_create_proc_dir(struct bond_net *bn);
535 void bond_destroy_proc_dir(struct bond_net *bn);
537 static inline void bond_create_proc_entry(struct bonding *bond)
541 static inline void bond_remove_proc_entry(struct bonding *bond)
545 static inline void bond_create_proc_dir(struct bond_net *bn)
549 static inline void bond_destroy_proc_dir(struct bond_net *bn)
554 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
557 struct list_head *iter;
560 bond_for_each_slave(bond, tmp, iter)
561 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
567 /* Caller must hold rcu_read_lock() for read */
568 static inline struct slave *bond_slave_has_mac_rcu(struct bonding *bond,
571 struct list_head *iter;
574 bond_for_each_slave_rcu(bond, tmp, iter)
575 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
581 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
582 * Returns -1 if not found, index if found
584 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
588 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
589 if (targets[i] == ip)
591 else if (targets[i] == 0)
597 /* exported from bond_main.c */
598 extern int bond_net_id;
599 extern const struct bond_parm_tbl bond_lacp_tbl[];
600 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
601 extern const struct bond_parm_tbl arp_validate_tbl[];
602 extern const struct bond_parm_tbl arp_all_targets_tbl[];
603 extern const struct bond_parm_tbl fail_over_mac_tbl[];
604 extern const struct bond_parm_tbl pri_reselect_tbl[];
605 extern struct bond_parm_tbl ad_select_tbl[];
607 /* exported from bond_netlink.c */
608 extern struct rtnl_link_ops bond_link_ops;
610 #endif /* _LINUX_BONDING_H */