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 _NET_BONDING_H
16 #define _NET_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>
27 #include <linux/if_link.h>
29 #include <net/bond_3ad.h>
30 #include <net/bond_alb.h>
31 #include <net/bond_options.h>
33 #define BOND_MAX_ARP_TARGETS 16
35 #define BOND_DEFAULT_MIIMON 100
37 #ifndef __long_aligned
38 #define __long_aligned __attribute__((aligned((sizeof(long)))))
41 #define slave_info(bond_dev, slave_dev, fmt, ...) \
42 netdev_info(bond_dev, "(slave %s): " fmt, (slave_dev)->name, ##__VA_ARGS__)
43 #define slave_warn(bond_dev, slave_dev, fmt, ...) \
44 netdev_warn(bond_dev, "(slave %s): " fmt, (slave_dev)->name, ##__VA_ARGS__)
45 #define slave_dbg(bond_dev, slave_dev, fmt, ...) \
46 netdev_dbg(bond_dev, "(slave %s): " fmt, (slave_dev)->name, ##__VA_ARGS__)
47 #define slave_err(bond_dev, slave_dev, fmt, ...) \
48 netdev_err(bond_dev, "(slave %s): " fmt, (slave_dev)->name, ##__VA_ARGS__)
50 #define BOND_MODE(bond) ((bond)->params.mode)
52 /* slave list primitives */
53 #define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
55 #define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
57 /* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
58 #define bond_first_slave(bond) \
59 (bond_has_slaves(bond) ? \
60 netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
62 #define bond_last_slave(bond) \
63 (bond_has_slaves(bond) ? \
64 netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
67 /* Caller must have rcu_read_lock */
68 #define bond_first_slave_rcu(bond) \
69 netdev_lower_get_first_private_rcu(bond->dev)
71 #define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
72 #define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
75 * bond_for_each_slave - iterate over all slaves
76 * @bond: the bond holding this list
78 * @iter: list_head * iterator
80 * Caller must hold RTNL
82 #define bond_for_each_slave(bond, pos, iter) \
83 netdev_for_each_lower_private((bond)->dev, pos, iter)
85 /* Caller must have rcu_read_lock */
86 #define bond_for_each_slave_rcu(bond, pos, iter) \
87 netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
89 #define BOND_XFRM_FEATURES (NETIF_F_HW_ESP | NETIF_F_HW_ESP_TX_CSUM | \
92 #define BOND_TLS_FEATURES (NETIF_F_HW_TLS_TX | NETIF_F_HW_TLS_RX)
94 #ifdef CONFIG_NET_POLL_CONTROLLER
95 extern atomic_t netpoll_block_tx;
97 static inline void block_netpoll_tx(void)
99 atomic_inc(&netpoll_block_tx);
102 static inline void unblock_netpoll_tx(void)
104 atomic_dec(&netpoll_block_tx);
107 static inline int is_netpoll_tx_blocked(struct net_device *dev)
109 if (unlikely(netpoll_tx_running(dev)))
110 return atomic_read(&netpoll_block_tx);
114 #define block_netpoll_tx()
115 #define unblock_netpoll_tx()
116 #define is_netpoll_tx_blocked(dev) (0)
132 int peer_notif_delay;
135 unsigned int min_links;
137 char primary[IFNAMSIZ];
138 int primary_reselect;
139 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
141 int all_slaves_active;
144 int packets_per_slave;
146 struct reciprocal_value reciprocal_packets_per_slave;
147 u16 ad_actor_sys_prio;
148 u16 ad_user_port_key;
150 /* 2 bytes of padding : see ether_addr_equal_64bits() */
151 u8 ad_actor_system[ETH_ALEN + 2];
155 struct net_device *dev; /* first - useful for panic debug */
156 struct bonding *bond; /* our master */
158 /* all three in jiffies */
159 unsigned long last_link_up;
160 unsigned long last_rx;
161 unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
162 s8 link; /* one of BOND_LINK_XXXX */
163 s8 link_new_state; /* one of BOND_LINK_XXXX */
164 u8 backup:1, /* indicates backup slave. Value corresponds with
165 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
166 inactive:1, /* indicates inactive slave */
167 should_notify:1, /* indicates whether the state changed */
168 should_notify_link:1; /* indicates whether the link changed */
171 u32 link_failure_count;
174 u8 perm_hwaddr[MAX_ADDR_LEN];
175 struct ad_slave_info *ad_info;
176 struct tlb_slave_info tlb_info;
177 #ifdef CONFIG_NET_POLL_CONTROLLER
180 struct delayed_work notify_work;
182 struct rtnl_link_stats64 slave_stats;
185 static inline struct slave *to_slave(struct kobject *kobj)
187 return container_of(kobj, struct slave, kobj);
190 struct bond_up_slave {
197 * Link pseudo-state only used internally by monitors
199 #define BOND_LINK_NOCHANGE -1
202 struct list_head list;
203 struct xfrm_state *xs;
207 * Here are the locking policies for the two bonding locks:
208 * Get rcu_read_lock when reading or RTNL when writing slave list.
211 struct net_device *dev; /* first - useful for panic debug */
212 struct slave __rcu *curr_active_slave;
213 struct slave __rcu *current_arp_slave;
214 struct slave __rcu *primary_slave;
215 struct bond_up_slave __rcu *usable_slaves;
216 struct bond_up_slave __rcu *all_slaves;
218 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
219 int (*recv_probe)(const struct sk_buff *, struct bonding *,
221 /* mode_lock is used for mode-specific locking needs, currently used by:
222 * 3ad mode (4) - protect against running bond_3ad_unbind_slave() and
223 * bond_3ad_state_machine_handler() concurrently and also
224 * the access to the state machine shared variables.
225 * TLB mode (5) - to sync the use and modifications of its hash table
226 * ALB mode (6) - to sync the use and modifications of its hash table
228 spinlock_t mode_lock;
229 spinlock_t stats_lock;
232 #ifdef CONFIG_PROC_FS
233 struct proc_dir_entry *proc_entry;
234 char proc_file_name[IFNAMSIZ];
235 #endif /* CONFIG_PROC_FS */
236 struct list_head bond_list;
237 u32 __percpu *rr_tx_counter;
238 struct ad_bond_info ad_info;
239 struct alb_bond_info alb_info;
240 struct bond_params params;
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 struct delayed_work slave_arr_work;
248 #ifdef CONFIG_DEBUG_FS
249 /* debugging support via debugfs */
250 struct dentry *debug_dir;
251 #endif /* CONFIG_DEBUG_FS */
252 struct rtnl_link_stats64 bond_stats;
253 #ifdef CONFIG_XFRM_OFFLOAD
254 struct list_head ipsec_list;
255 /* protecting ipsec_list */
256 spinlock_t ipsec_lock;
257 #endif /* CONFIG_XFRM_OFFLOAD */
258 struct bpf_prog *xdp_prog;
261 #define bond_slave_get_rcu(dev) \
262 ((struct slave *) rcu_dereference(dev->rx_handler_data))
264 #define bond_slave_get_rtnl(dev) \
265 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
267 void bond_queue_slave_event(struct slave *slave);
268 void bond_lower_state_changed(struct slave *slave);
270 struct bond_vlan_tag {
272 unsigned short vlan_id;
275 bool bond_sk_check(struct bonding *bond);
278 * Returns NULL if the net_device does not belong to any of the bond's slaves
280 * Caller must hold bond lock for read
282 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
283 struct net_device *slave_dev)
285 return netdev_lower_dev_get_private(bond->dev, slave_dev);
288 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
293 static inline bool bond_should_override_tx_queue(struct bonding *bond)
295 return BOND_MODE(bond) == BOND_MODE_ACTIVEBACKUP ||
296 BOND_MODE(bond) == BOND_MODE_ROUNDROBIN;
299 static inline bool bond_is_lb(const struct bonding *bond)
301 return BOND_MODE(bond) == BOND_MODE_TLB ||
302 BOND_MODE(bond) == BOND_MODE_ALB;
305 static inline bool bond_needs_speed_duplex(const struct bonding *bond)
307 return BOND_MODE(bond) == BOND_MODE_8023AD || bond_is_lb(bond);
310 static inline bool bond_is_nondyn_tlb(const struct bonding *bond)
312 return (bond_is_lb(bond) && bond->params.tlb_dynamic_lb == 0);
315 static inline bool bond_mode_can_use_xmit_hash(const struct bonding *bond)
317 return (BOND_MODE(bond) == BOND_MODE_8023AD ||
318 BOND_MODE(bond) == BOND_MODE_XOR ||
319 BOND_MODE(bond) == BOND_MODE_TLB ||
320 BOND_MODE(bond) == BOND_MODE_ALB);
323 static inline bool bond_mode_uses_xmit_hash(const struct bonding *bond)
325 return (BOND_MODE(bond) == BOND_MODE_8023AD ||
326 BOND_MODE(bond) == BOND_MODE_XOR ||
327 bond_is_nondyn_tlb(bond));
330 static inline bool bond_mode_uses_arp(int mode)
332 return mode != BOND_MODE_8023AD && mode != BOND_MODE_TLB &&
333 mode != BOND_MODE_ALB;
336 static inline bool bond_mode_uses_primary(int mode)
338 return mode == BOND_MODE_ACTIVEBACKUP || mode == BOND_MODE_TLB ||
339 mode == BOND_MODE_ALB;
342 static inline bool bond_uses_primary(struct bonding *bond)
344 return bond_mode_uses_primary(BOND_MODE(bond));
347 static inline struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond)
349 struct slave *slave = rcu_dereference(bond->curr_active_slave);
351 return bond_uses_primary(bond) && slave ? slave->dev : NULL;
354 static inline bool bond_slave_is_up(struct slave *slave)
356 return netif_running(slave->dev) && netif_carrier_ok(slave->dev);
359 static inline void bond_set_active_slave(struct slave *slave)
363 bond_queue_slave_event(slave);
364 bond_lower_state_changed(slave);
368 static inline void bond_set_backup_slave(struct slave *slave)
370 if (!slave->backup) {
372 bond_queue_slave_event(slave);
373 bond_lower_state_changed(slave);
377 static inline void bond_set_slave_state(struct slave *slave,
378 int slave_state, bool notify)
380 if (slave->backup == slave_state)
383 slave->backup = slave_state;
385 bond_lower_state_changed(slave);
386 bond_queue_slave_event(slave);
387 slave->should_notify = 0;
389 if (slave->should_notify)
390 slave->should_notify = 0;
392 slave->should_notify = 1;
396 static inline void bond_slave_state_change(struct bonding *bond)
398 struct list_head *iter;
401 bond_for_each_slave(bond, tmp, iter) {
402 if (tmp->link == BOND_LINK_UP)
403 bond_set_active_slave(tmp);
404 else if (tmp->link == BOND_LINK_DOWN)
405 bond_set_backup_slave(tmp);
409 static inline void bond_slave_state_notify(struct bonding *bond)
411 struct list_head *iter;
414 bond_for_each_slave(bond, tmp, iter) {
415 if (tmp->should_notify) {
416 bond_lower_state_changed(tmp);
417 tmp->should_notify = 0;
422 static inline int bond_slave_state(struct slave *slave)
424 return slave->backup;
427 static inline bool bond_is_active_slave(struct slave *slave)
429 return !bond_slave_state(slave);
432 static inline bool bond_slave_can_tx(struct slave *slave)
434 return bond_slave_is_up(slave) && slave->link == BOND_LINK_UP &&
435 bond_is_active_slave(slave);
438 static inline bool bond_is_active_slave_dev(const struct net_device *slave_dev)
444 slave = bond_slave_get_rcu(slave_dev);
445 active = bond_is_active_slave(slave);
451 static inline void bond_hw_addr_copy(u8 *dst, const u8 *src, unsigned int len)
453 if (len == ETH_ALEN) {
454 ether_addr_copy(dst, src);
458 memcpy(dst, src, len);
461 #define BOND_PRI_RESELECT_ALWAYS 0
462 #define BOND_PRI_RESELECT_BETTER 1
463 #define BOND_PRI_RESELECT_FAILURE 2
465 #define BOND_FOM_NONE 0
466 #define BOND_FOM_ACTIVE 1
467 #define BOND_FOM_FOLLOW 2
469 #define BOND_ARP_TARGETS_ANY 0
470 #define BOND_ARP_TARGETS_ALL 1
472 #define BOND_ARP_VALIDATE_NONE 0
473 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
474 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
475 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
476 BOND_ARP_VALIDATE_BACKUP)
477 #define BOND_ARP_FILTER (BOND_ARP_VALIDATE_ALL + 1)
478 #define BOND_ARP_FILTER_ACTIVE (BOND_ARP_VALIDATE_ACTIVE | \
480 #define BOND_ARP_FILTER_BACKUP (BOND_ARP_VALIDATE_BACKUP | \
483 #define BOND_SLAVE_NOTIFY_NOW true
484 #define BOND_SLAVE_NOTIFY_LATER false
486 static inline int slave_do_arp_validate(struct bonding *bond,
489 return bond->params.arp_validate & (1 << bond_slave_state(slave));
492 static inline int slave_do_arp_validate_only(struct bonding *bond)
494 return bond->params.arp_validate & BOND_ARP_FILTER;
497 static inline int bond_is_ip_target_ok(__be32 addr)
499 return !ipv4_is_lbcast(addr) && !ipv4_is_zeronet(addr);
502 /* Get the oldest arp which we've received on this slave for bond's
505 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
509 unsigned long ret = slave->target_last_arp_rx[0];
511 for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
512 if (time_before(slave->target_last_arp_rx[i], ret))
513 ret = slave->target_last_arp_rx[i];
518 static inline unsigned long slave_last_rx(struct bonding *bond,
521 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
522 return slave_oldest_target_arp_rx(bond, slave);
524 return slave->last_rx;
527 #ifdef CONFIG_NET_POLL_CONTROLLER
528 static inline netdev_tx_t bond_netpoll_send_skb(const struct slave *slave,
531 return netpoll_send_skb(slave->np, skb);
534 static inline netdev_tx_t bond_netpoll_send_skb(const struct slave *slave,
542 static inline void bond_set_slave_inactive_flags(struct slave *slave,
545 if (!bond_is_lb(slave->bond))
546 bond_set_slave_state(slave, BOND_STATE_BACKUP, notify);
547 if (!slave->bond->params.all_slaves_active)
551 static inline void bond_set_slave_active_flags(struct slave *slave,
554 bond_set_slave_state(slave, BOND_STATE_ACTIVE, notify);
558 static inline bool bond_is_slave_inactive(struct slave *slave)
560 return slave->inactive;
563 static inline void bond_propose_link_state(struct slave *slave, int state)
565 slave->link_new_state = state;
568 static inline void bond_commit_link_state(struct slave *slave, bool notify)
570 if (slave->link_new_state == BOND_LINK_NOCHANGE)
573 slave->link = slave->link_new_state;
575 bond_queue_slave_event(slave);
576 bond_lower_state_changed(slave);
577 slave->should_notify_link = 0;
579 if (slave->should_notify_link)
580 slave->should_notify_link = 0;
582 slave->should_notify_link = 1;
586 static inline void bond_set_slave_link_state(struct slave *slave, int state,
589 bond_propose_link_state(slave, state);
590 bond_commit_link_state(slave, notify);
593 static inline void bond_slave_link_notify(struct bonding *bond)
595 struct list_head *iter;
598 bond_for_each_slave(bond, tmp, iter) {
599 if (tmp->should_notify_link) {
600 bond_queue_slave_event(tmp);
601 bond_lower_state_changed(tmp);
602 tmp->should_notify_link = 0;
607 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
609 struct in_device *in_dev;
613 in_dev = __in_dev_get_rcu(dev);
616 addr = inet_confirm_addr(dev_net(dev), in_dev, dst, local,
623 struct net *net; /* Associated network namespace */
624 struct list_head dev_list;
625 #ifdef CONFIG_PROC_FS
626 struct proc_dir_entry *proc_dir;
628 struct class_attribute class_attr_bonding_masters;
631 int bond_arp_rcv(const struct sk_buff *skb, struct bonding *bond, struct slave *slave);
632 netdev_tx_t bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
633 int bond_create(struct net *net, const char *name);
634 int bond_create_sysfs(struct bond_net *net);
635 void bond_destroy_sysfs(struct bond_net *net);
636 void bond_prepare_sysfs_group(struct bonding *bond);
637 int bond_sysfs_slave_add(struct slave *slave);
638 void bond_sysfs_slave_del(struct slave *slave);
639 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev,
640 struct netlink_ext_ack *extack);
641 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
642 u32 bond_xmit_hash(struct bonding *bond, struct sk_buff *skb);
643 int bond_set_carrier(struct bonding *bond);
644 void bond_select_active_slave(struct bonding *bond);
645 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
646 void bond_create_debugfs(void);
647 void bond_destroy_debugfs(void);
648 void bond_debug_register(struct bonding *bond);
649 void bond_debug_unregister(struct bonding *bond);
650 void bond_debug_reregister(struct bonding *bond);
651 const char *bond_mode_name(int mode);
652 void bond_setup(struct net_device *bond_dev);
653 unsigned int bond_get_num_tx_queues(void);
654 int bond_netlink_init(void);
655 void bond_netlink_fini(void);
656 struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond);
657 const char *bond_slave_link_status(s8 link);
658 struct bond_vlan_tag *bond_verify_device_path(struct net_device *start_dev,
659 struct net_device *end_dev,
661 int bond_update_slave_arr(struct bonding *bond, struct slave *skipslave);
662 void bond_slave_arr_work_rearm(struct bonding *bond, unsigned long delay);
663 void bond_work_init_all(struct bonding *bond);
665 #ifdef CONFIG_PROC_FS
666 void bond_create_proc_entry(struct bonding *bond);
667 void bond_remove_proc_entry(struct bonding *bond);
668 void bond_create_proc_dir(struct bond_net *bn);
669 void bond_destroy_proc_dir(struct bond_net *bn);
671 static inline void bond_create_proc_entry(struct bonding *bond)
675 static inline void bond_remove_proc_entry(struct bonding *bond)
679 static inline void bond_create_proc_dir(struct bond_net *bn)
683 static inline void bond_destroy_proc_dir(struct bond_net *bn)
688 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
691 struct list_head *iter;
694 bond_for_each_slave(bond, tmp, iter)
695 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
701 /* Caller must hold rcu_read_lock() for read */
702 static inline struct slave *bond_slave_has_mac_rcu(struct bonding *bond,
705 struct list_head *iter;
708 bond_for_each_slave_rcu(bond, tmp, iter)
709 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
715 /* Caller must hold rcu_read_lock() for read */
716 static inline bool bond_slave_has_mac_rx(struct bonding *bond, const u8 *mac)
718 struct list_head *iter;
720 struct netdev_hw_addr *ha;
722 bond_for_each_slave_rcu(bond, tmp, iter)
723 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
726 if (netdev_uc_empty(bond->dev))
729 netdev_for_each_uc_addr(ha, bond->dev)
730 if (ether_addr_equal_64bits(mac, ha->addr))
736 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
737 * Returns -1 if not found, index if found
739 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
743 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
744 if (targets[i] == ip)
746 else if (targets[i] == 0)
752 /* exported from bond_main.c */
753 extern unsigned int bond_net_id;
755 /* exported from bond_netlink.c */
756 extern struct rtnl_link_ops bond_link_ops;
758 /* exported from bond_sysfs_slave.c */
759 extern const struct sysfs_ops slave_sysfs_ops;
761 static inline netdev_tx_t bond_tx_drop(struct net_device *dev, struct sk_buff *skb)
763 atomic_long_inc(&dev->tx_dropped);
764 dev_kfree_skb_any(skb);
765 return NET_XMIT_DROP;
768 #endif /* _NET_BONDING_H */