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 #ifdef CONFIG_NET_POLL_CONTROLLER
90 extern atomic_t netpoll_block_tx
;
92 static inline void block_netpoll_tx(void)
94 atomic_inc(&netpoll_block_tx
);
97 static inline void unblock_netpoll_tx(void)
99 atomic_dec(&netpoll_block_tx
);
102 static inline int is_netpoll_tx_blocked(struct net_device
*dev
)
104 if (unlikely(netpoll_tx_running(dev
)))
105 return atomic_read(&netpoll_block_tx
);
109 #define block_netpoll_tx()
110 #define unblock_netpoll_tx()
111 #define is_netpoll_tx_blocked(dev) (0)
126 int peer_notif_delay
;
128 unsigned int min_links
;
130 char primary
[IFNAMSIZ
];
131 int primary_reselect
;
132 __be32 arp_targets
[BOND_MAX_ARP_TARGETS
];
134 int all_slaves_active
;
137 int packets_per_slave
;
139 struct reciprocal_value reciprocal_packets_per_slave
;
140 u16 ad_actor_sys_prio
;
141 u16 ad_user_port_key
;
143 /* 2 bytes of padding : see ether_addr_equal_64bits() */
144 u8 ad_actor_system
[ETH_ALEN
+ 2];
147 struct bond_parm_tbl
{
153 struct net_device
*dev
; /* first - useful for panic debug */
154 struct bonding
*bond
; /* our master */
156 /* all three in jiffies */
157 unsigned long last_link_up
;
158 unsigned long last_rx
;
159 unsigned long target_last_arp_rx
[BOND_MAX_ARP_TARGETS
];
160 s8 link
; /* one of BOND_LINK_XXXX */
161 s8 link_new_state
; /* one of BOND_LINK_XXXX */
163 u8 backup
:1, /* indicates backup slave. Value corresponds with
164 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
165 inactive
:1, /* indicates inactive slave */
166 should_notify
:1, /* indicates whether the state changed */
167 should_notify_link
:1; /* indicates whether the link changed */
170 u32 link_failure_count
;
173 u8 perm_hwaddr
[MAX_ADDR_LEN
];
174 struct ad_slave_info
*ad_info
;
175 struct tlb_slave_info tlb_info
;
176 #ifdef CONFIG_NET_POLL_CONTROLLER
179 struct delayed_work notify_work
;
181 struct rtnl_link_stats64 slave_stats
;
184 struct bond_up_slave
{
187 struct slave
*arr
[0];
191 * Link pseudo-state only used internally by monitors
193 #define BOND_LINK_NOCHANGE -1
196 * Here are the locking policies for the two bonding locks:
197 * Get rcu_read_lock when reading or RTNL when writing slave list.
200 struct net_device
*dev
; /* first - useful for panic debug */
201 struct slave __rcu
*curr_active_slave
;
202 struct slave __rcu
*current_arp_slave
;
203 struct slave __rcu
*primary_slave
;
204 struct bond_up_slave __rcu
*slave_arr
; /* Array of usable slaves */
207 s32 slave_cnt
; /* never change this value outside the attach/detach wrappers */
208 int (*recv_probe
)(const struct sk_buff
*, struct bonding
*,
210 /* mode_lock is used for mode-specific locking needs, currently used by:
211 * 3ad mode (4) - protect against running bond_3ad_unbind_slave() and
212 * bond_3ad_state_machine_handler() concurrently and also
213 * the access to the state machine shared variables.
214 * TLB mode (5) - to sync the use and modifications of its hash table
215 * ALB mode (6) - to sync the use and modifications of its hash table
217 spinlock_t mode_lock
;
218 spinlock_t stats_lock
;
221 #ifdef CONFIG_PROC_FS
222 struct proc_dir_entry
*proc_entry
;
223 char proc_file_name
[IFNAMSIZ
];
224 #endif /* CONFIG_PROC_FS */
225 struct list_head bond_list
;
227 struct ad_bond_info ad_info
;
228 struct alb_bond_info alb_info
;
229 struct bond_params params
;
230 struct workqueue_struct
*wq
;
231 struct delayed_work mii_work
;
232 struct delayed_work arp_work
;
233 struct delayed_work alb_work
;
234 struct delayed_work ad_work
;
235 struct delayed_work mcast_work
;
236 struct delayed_work slave_arr_work
;
237 #ifdef CONFIG_DEBUG_FS
238 /* debugging support via debugfs */
239 struct dentry
*debug_dir
;
240 #endif /* CONFIG_DEBUG_FS */
241 struct rtnl_link_stats64 bond_stats
;
244 #define bond_slave_get_rcu(dev) \
245 ((struct slave *) rcu_dereference(dev->rx_handler_data))
247 #define bond_slave_get_rtnl(dev) \
248 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
250 void bond_queue_slave_event(struct slave
*slave
);
251 void bond_lower_state_changed(struct slave
*slave
);
253 struct bond_vlan_tag
{
255 unsigned short vlan_id
;
259 * Returns NULL if the net_device does not belong to any of the bond's slaves
261 * Caller must hold bond lock for read
263 static inline struct slave
*bond_get_slave_by_dev(struct bonding
*bond
,
264 struct net_device
*slave_dev
)
266 return netdev_lower_dev_get_private(bond
->dev
, slave_dev
);
269 static inline struct bonding
*bond_get_bond_by_slave(struct slave
*slave
)
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_needs_speed_duplex(const struct bonding
*bond
)
288 return BOND_MODE(bond
) == BOND_MODE_8023AD
|| bond_is_lb(bond
);
291 static inline bool bond_is_nondyn_tlb(const struct bonding
*bond
)
293 return (bond_is_lb(bond
) && bond
->params
.tlb_dynamic_lb
== 0);
296 static inline bool bond_mode_can_use_xmit_hash(const struct bonding
*bond
)
298 return (BOND_MODE(bond
) == BOND_MODE_8023AD
||
299 BOND_MODE(bond
) == BOND_MODE_XOR
||
300 BOND_MODE(bond
) == BOND_MODE_TLB
||
301 BOND_MODE(bond
) == BOND_MODE_ALB
);
304 static inline bool bond_mode_uses_xmit_hash(const struct bonding
*bond
)
306 return (BOND_MODE(bond
) == BOND_MODE_8023AD
||
307 BOND_MODE(bond
) == BOND_MODE_XOR
||
308 bond_is_nondyn_tlb(bond
));
311 static inline bool bond_mode_uses_arp(int mode
)
313 return mode
!= BOND_MODE_8023AD
&& mode
!= BOND_MODE_TLB
&&
314 mode
!= BOND_MODE_ALB
;
317 static inline bool bond_mode_uses_primary(int mode
)
319 return mode
== BOND_MODE_ACTIVEBACKUP
|| mode
== BOND_MODE_TLB
||
320 mode
== BOND_MODE_ALB
;
323 static inline bool bond_uses_primary(struct bonding
*bond
)
325 return bond_mode_uses_primary(BOND_MODE(bond
));
328 static inline struct net_device
*bond_option_active_slave_get_rcu(struct bonding
*bond
)
330 struct slave
*slave
= rcu_dereference(bond
->curr_active_slave
);
332 return bond_uses_primary(bond
) && slave
? slave
->dev
: NULL
;
335 static inline bool bond_slave_is_up(struct slave
*slave
)
337 return netif_running(slave
->dev
) && netif_carrier_ok(slave
->dev
);
340 static inline void bond_set_active_slave(struct slave
*slave
)
344 bond_queue_slave_event(slave
);
345 bond_lower_state_changed(slave
);
349 static inline void bond_set_backup_slave(struct slave
*slave
)
351 if (!slave
->backup
) {
353 bond_queue_slave_event(slave
);
354 bond_lower_state_changed(slave
);
358 static inline void bond_set_slave_state(struct slave
*slave
,
359 int slave_state
, bool notify
)
361 if (slave
->backup
== slave_state
)
364 slave
->backup
= slave_state
;
366 bond_lower_state_changed(slave
);
367 bond_queue_slave_event(slave
);
368 slave
->should_notify
= 0;
370 if (slave
->should_notify
)
371 slave
->should_notify
= 0;
373 slave
->should_notify
= 1;
377 static inline void bond_slave_state_change(struct bonding
*bond
)
379 struct list_head
*iter
;
382 bond_for_each_slave(bond
, tmp
, iter
) {
383 if (tmp
->link
== BOND_LINK_UP
)
384 bond_set_active_slave(tmp
);
385 else if (tmp
->link
== BOND_LINK_DOWN
)
386 bond_set_backup_slave(tmp
);
390 static inline void bond_slave_state_notify(struct bonding
*bond
)
392 struct list_head
*iter
;
395 bond_for_each_slave(bond
, tmp
, iter
) {
396 if (tmp
->should_notify
) {
397 bond_lower_state_changed(tmp
);
398 tmp
->should_notify
= 0;
403 static inline int bond_slave_state(struct slave
*slave
)
405 return slave
->backup
;
408 static inline bool bond_is_active_slave(struct slave
*slave
)
410 return !bond_slave_state(slave
);
413 static inline bool bond_slave_can_tx(struct slave
*slave
)
415 return bond_slave_is_up(slave
) && slave
->link
== BOND_LINK_UP
&&
416 bond_is_active_slave(slave
);
419 static inline bool bond_is_active_slave_dev(const struct net_device
*slave_dev
)
425 slave
= bond_slave_get_rcu(slave_dev
);
426 active
= bond_is_active_slave(slave
);
432 static inline void bond_hw_addr_copy(u8
*dst
, const u8
*src
, unsigned int len
)
434 if (len
== ETH_ALEN
) {
435 ether_addr_copy(dst
, src
);
439 memcpy(dst
, src
, len
);
442 #define BOND_PRI_RESELECT_ALWAYS 0
443 #define BOND_PRI_RESELECT_BETTER 1
444 #define BOND_PRI_RESELECT_FAILURE 2
446 #define BOND_FOM_NONE 0
447 #define BOND_FOM_ACTIVE 1
448 #define BOND_FOM_FOLLOW 2
450 #define BOND_ARP_TARGETS_ANY 0
451 #define BOND_ARP_TARGETS_ALL 1
453 #define BOND_ARP_VALIDATE_NONE 0
454 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
455 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
456 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
457 BOND_ARP_VALIDATE_BACKUP)
458 #define BOND_ARP_FILTER (BOND_ARP_VALIDATE_ALL + 1)
459 #define BOND_ARP_FILTER_ACTIVE (BOND_ARP_VALIDATE_ACTIVE | \
461 #define BOND_ARP_FILTER_BACKUP (BOND_ARP_VALIDATE_BACKUP | \
464 #define BOND_SLAVE_NOTIFY_NOW true
465 #define BOND_SLAVE_NOTIFY_LATER false
467 static inline int slave_do_arp_validate(struct bonding
*bond
,
470 return bond
->params
.arp_validate
& (1 << bond_slave_state(slave
));
473 static inline int slave_do_arp_validate_only(struct bonding
*bond
)
475 return bond
->params
.arp_validate
& BOND_ARP_FILTER
;
478 static inline int bond_is_ip_target_ok(__be32 addr
)
480 return !ipv4_is_lbcast(addr
) && !ipv4_is_zeronet(addr
);
483 /* Get the oldest arp which we've received on this slave for bond's
486 static inline unsigned long slave_oldest_target_arp_rx(struct bonding
*bond
,
490 unsigned long ret
= slave
->target_last_arp_rx
[0];
492 for (; (i
< BOND_MAX_ARP_TARGETS
) && bond
->params
.arp_targets
[i
]; i
++)
493 if (time_before(slave
->target_last_arp_rx
[i
], ret
))
494 ret
= slave
->target_last_arp_rx
[i
];
499 static inline unsigned long slave_last_rx(struct bonding
*bond
,
502 if (bond
->params
.arp_all_targets
== BOND_ARP_TARGETS_ALL
)
503 return slave_oldest_target_arp_rx(bond
, slave
);
505 return slave
->last_rx
;
508 #ifdef CONFIG_NET_POLL_CONTROLLER
509 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
512 struct netpoll
*np
= slave
->np
;
515 netpoll_send_skb(np
, skb
);
518 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
524 static inline void bond_set_slave_inactive_flags(struct slave
*slave
,
527 if (!bond_is_lb(slave
->bond
))
528 bond_set_slave_state(slave
, BOND_STATE_BACKUP
, notify
);
529 if (!slave
->bond
->params
.all_slaves_active
)
533 static inline void bond_set_slave_active_flags(struct slave
*slave
,
536 bond_set_slave_state(slave
, BOND_STATE_ACTIVE
, notify
);
540 static inline bool bond_is_slave_inactive(struct slave
*slave
)
542 return slave
->inactive
;
545 static inline void bond_propose_link_state(struct slave
*slave
, int state
)
547 slave
->link_new_state
= state
;
550 static inline void bond_commit_link_state(struct slave
*slave
, bool notify
)
552 if (slave
->link
== slave
->link_new_state
)
555 slave
->link
= slave
->link_new_state
;
557 bond_queue_slave_event(slave
);
558 bond_lower_state_changed(slave
);
559 slave
->should_notify_link
= 0;
561 if (slave
->should_notify_link
)
562 slave
->should_notify_link
= 0;
564 slave
->should_notify_link
= 1;
568 static inline void bond_set_slave_link_state(struct slave
*slave
, int state
,
571 bond_propose_link_state(slave
, state
);
572 bond_commit_link_state(slave
, notify
);
575 static inline void bond_slave_link_notify(struct bonding
*bond
)
577 struct list_head
*iter
;
580 bond_for_each_slave(bond
, tmp
, iter
) {
581 if (tmp
->should_notify_link
) {
582 bond_queue_slave_event(tmp
);
583 bond_lower_state_changed(tmp
);
584 tmp
->should_notify_link
= 0;
589 static inline __be32
bond_confirm_addr(struct net_device
*dev
, __be32 dst
, __be32 local
)
591 struct in_device
*in_dev
;
595 in_dev
= __in_dev_get_rcu(dev
);
598 addr
= inet_confirm_addr(dev_net(dev
), in_dev
, dst
, local
,
605 struct net
*net
; /* Associated network namespace */
606 struct list_head dev_list
;
607 #ifdef CONFIG_PROC_FS
608 struct proc_dir_entry
*proc_dir
;
610 struct class_attribute class_attr_bonding_masters
;
613 int bond_arp_rcv(const struct sk_buff
*skb
, struct bonding
*bond
, struct slave
*slave
);
614 void bond_dev_queue_xmit(struct bonding
*bond
, struct sk_buff
*skb
, struct net_device
*slave_dev
);
615 int bond_create(struct net
*net
, const char *name
);
616 int bond_create_sysfs(struct bond_net
*net
);
617 void bond_destroy_sysfs(struct bond_net
*net
);
618 void bond_prepare_sysfs_group(struct bonding
*bond
);
619 int bond_sysfs_slave_add(struct slave
*slave
);
620 void bond_sysfs_slave_del(struct slave
*slave
);
621 int bond_enslave(struct net_device
*bond_dev
, struct net_device
*slave_dev
,
622 struct netlink_ext_ack
*extack
);
623 int bond_release(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
624 u32
bond_xmit_hash(struct bonding
*bond
, struct sk_buff
*skb
);
625 int bond_set_carrier(struct bonding
*bond
);
626 void bond_select_active_slave(struct bonding
*bond
);
627 void bond_change_active_slave(struct bonding
*bond
, struct slave
*new_active
);
628 void bond_create_debugfs(void);
629 void bond_destroy_debugfs(void);
630 void bond_debug_register(struct bonding
*bond
);
631 void bond_debug_unregister(struct bonding
*bond
);
632 void bond_debug_reregister(struct bonding
*bond
);
633 const char *bond_mode_name(int mode
);
634 void bond_setup(struct net_device
*bond_dev
);
635 unsigned int bond_get_num_tx_queues(void);
636 int bond_netlink_init(void);
637 void bond_netlink_fini(void);
638 struct net_device
*bond_option_active_slave_get_rcu(struct bonding
*bond
);
639 const char *bond_slave_link_status(s8 link
);
640 struct bond_vlan_tag
*bond_verify_device_path(struct net_device
*start_dev
,
641 struct net_device
*end_dev
,
643 int bond_update_slave_arr(struct bonding
*bond
, struct slave
*skipslave
);
644 void bond_slave_arr_work_rearm(struct bonding
*bond
, unsigned long delay
);
645 void bond_work_init_all(struct bonding
*bond
);
647 #ifdef CONFIG_PROC_FS
648 void bond_create_proc_entry(struct bonding
*bond
);
649 void bond_remove_proc_entry(struct bonding
*bond
);
650 void bond_create_proc_dir(struct bond_net
*bn
);
651 void bond_destroy_proc_dir(struct bond_net
*bn
);
653 static inline void bond_create_proc_entry(struct bonding
*bond
)
657 static inline void bond_remove_proc_entry(struct bonding
*bond
)
661 static inline void bond_create_proc_dir(struct bond_net
*bn
)
665 static inline void bond_destroy_proc_dir(struct bond_net
*bn
)
670 static inline struct slave
*bond_slave_has_mac(struct bonding
*bond
,
673 struct list_head
*iter
;
676 bond_for_each_slave(bond
, tmp
, iter
)
677 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
683 /* Caller must hold rcu_read_lock() for read */
684 static inline struct slave
*bond_slave_has_mac_rcu(struct bonding
*bond
,
687 struct list_head
*iter
;
690 bond_for_each_slave_rcu(bond
, tmp
, iter
)
691 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
697 /* Caller must hold rcu_read_lock() for read */
698 static inline bool bond_slave_has_mac_rx(struct bonding
*bond
, const u8
*mac
)
700 struct list_head
*iter
;
702 struct netdev_hw_addr
*ha
;
704 bond_for_each_slave_rcu(bond
, tmp
, iter
)
705 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
708 if (netdev_uc_empty(bond
->dev
))
711 netdev_for_each_uc_addr(ha
, bond
->dev
)
712 if (ether_addr_equal_64bits(mac
, ha
->addr
))
718 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
719 * Returns -1 if not found, index if found
721 static inline int bond_get_targets_ip(__be32
*targets
, __be32 ip
)
725 for (i
= 0; i
< BOND_MAX_ARP_TARGETS
; i
++)
726 if (targets
[i
] == ip
)
728 else if (targets
[i
] == 0)
734 /* exported from bond_main.c */
735 extern unsigned int bond_net_id
;
736 extern const struct bond_parm_tbl bond_lacp_tbl
[];
737 extern const struct bond_parm_tbl xmit_hashtype_tbl
[];
738 extern const struct bond_parm_tbl arp_validate_tbl
[];
739 extern const struct bond_parm_tbl arp_all_targets_tbl
[];
740 extern const struct bond_parm_tbl fail_over_mac_tbl
[];
741 extern const struct bond_parm_tbl pri_reselect_tbl
[];
742 extern struct bond_parm_tbl ad_select_tbl
[];
744 /* exported from bond_netlink.c */
745 extern struct rtnl_link_ops bond_link_ops
;
747 static inline void bond_tx_drop(struct net_device
*dev
, struct sk_buff
*skb
)
749 atomic_long_inc(&dev
->tx_dropped
);
750 dev_kfree_skb_any(skb
);
753 #endif /* _NET_BONDING_H */