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
38 * Less bad way to call ioctl from within the kernel; this needs to be
39 * done some other way to get the call out of interrupt context.
40 * Needs "ioctl" variable to be supplied by calling context.
42 #define IOCTL(dev, arg, cmd) ({ \
44 mm_segment_t fs = get_fs(); \
46 res = ioctl(dev, arg, cmd); \
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)
127 unsigned int min_links
;
129 char primary
[IFNAMSIZ
];
130 int primary_reselect
;
131 __be32 arp_targets
[BOND_MAX_ARP_TARGETS
];
133 int all_slaves_active
;
136 int packets_per_slave
;
138 struct reciprocal_value reciprocal_packets_per_slave
;
139 u16 ad_actor_sys_prio
;
140 u16 ad_user_port_key
;
141 u8 ad_actor_system
[ETH_ALEN
];
144 struct bond_parm_tbl
{
149 struct netdev_notify_work
{
150 struct delayed_work work
;
151 struct net_device
*dev
;
152 struct netdev_bonding_info bonding_info
;
156 struct net_device
*dev
; /* first - useful for panic debug */
157 struct bonding
*bond
; /* our master */
159 /* all three in jiffies */
160 unsigned long last_link_up
;
161 unsigned long last_rx
;
162 unsigned long target_last_arp_rx
[BOND_MAX_ARP_TARGETS
];
163 s8 link
; /* one of BOND_LINK_XXXX */
165 u8 backup
:1, /* indicates backup slave. Value corresponds with
166 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
167 inactive
:1, /* indicates inactive slave */
168 should_notify
:1, /* indicates whether the state changed */
169 should_notify_link
:1; /* indicates whether the link changed */
172 u32 link_failure_count
;
175 u8 perm_hwaddr
[ETH_ALEN
];
176 struct ad_slave_info
*ad_info
;
177 struct tlb_slave_info tlb_info
;
178 #ifdef CONFIG_NET_POLL_CONTROLLER
182 struct rtnl_link_stats64 slave_stats
;
185 struct bond_up_slave
{
188 struct slave
*arr
[0];
192 * Link pseudo-state only used internally by monitors
194 #define BOND_LINK_NOCHANGE -1
197 * Here are the locking policies for the two bonding locks:
198 * Get rcu_read_lock when reading or RTNL when writing slave list.
201 struct net_device
*dev
; /* first - useful for panic debug */
202 struct slave __rcu
*curr_active_slave
;
203 struct slave __rcu
*current_arp_slave
;
204 struct slave __rcu
*primary_slave
;
205 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
;
220 #ifdef CONFIG_PROC_FS
221 struct proc_dir_entry
*proc_entry
;
222 char proc_file_name
[IFNAMSIZ
];
223 #endif /* CONFIG_PROC_FS */
224 struct list_head bond_list
;
226 struct ad_bond_info ad_info
;
227 struct alb_bond_info alb_info
;
228 struct bond_params params
;
229 struct workqueue_struct
*wq
;
230 struct delayed_work mii_work
;
231 struct delayed_work arp_work
;
232 struct delayed_work alb_work
;
233 struct delayed_work ad_work
;
234 struct delayed_work mcast_work
;
235 struct delayed_work slave_arr_work
;
236 #ifdef CONFIG_DEBUG_FS
237 /* debugging support via debugfs */
238 struct dentry
*debug_dir
;
239 #endif /* CONFIG_DEBUG_FS */
240 struct rtnl_link_stats64 bond_stats
;
243 #define bond_slave_get_rcu(dev) \
244 ((struct slave *) rcu_dereference(dev->rx_handler_data))
246 #define bond_slave_get_rtnl(dev) \
247 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
249 void bond_queue_slave_event(struct slave
*slave
);
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
)
272 static inline bool bond_should_override_tx_queue(struct bonding
*bond
)
274 return BOND_MODE(bond
) == BOND_MODE_ACTIVEBACKUP
||
275 BOND_MODE(bond
) == BOND_MODE_ROUNDROBIN
;
278 static inline bool bond_is_lb(const struct bonding
*bond
)
280 return BOND_MODE(bond
) == BOND_MODE_TLB
||
281 BOND_MODE(bond
) == BOND_MODE_ALB
;
284 static inline bool bond_is_nondyn_tlb(const struct bonding
*bond
)
286 return (BOND_MODE(bond
) == BOND_MODE_TLB
) &&
287 (bond
->params
.tlb_dynamic_lb
== 0);
290 static inline bool bond_mode_uses_xmit_hash(const struct bonding
*bond
)
292 return (BOND_MODE(bond
) == BOND_MODE_8023AD
||
293 BOND_MODE(bond
) == BOND_MODE_XOR
||
294 bond_is_nondyn_tlb(bond
));
297 static inline bool bond_mode_uses_arp(int mode
)
299 return mode
!= BOND_MODE_8023AD
&& mode
!= BOND_MODE_TLB
&&
300 mode
!= BOND_MODE_ALB
;
303 static inline bool bond_mode_uses_primary(int mode
)
305 return mode
== BOND_MODE_ACTIVEBACKUP
|| mode
== BOND_MODE_TLB
||
306 mode
== BOND_MODE_ALB
;
309 static inline bool bond_uses_primary(struct bonding
*bond
)
311 return bond_mode_uses_primary(BOND_MODE(bond
));
314 static inline struct net_device
*bond_option_active_slave_get_rcu(struct bonding
*bond
)
316 struct slave
*slave
= rcu_dereference(bond
->curr_active_slave
);
318 return bond_uses_primary(bond
) && slave
? slave
->dev
: NULL
;
321 static inline bool bond_slave_is_up(struct slave
*slave
)
323 return netif_running(slave
->dev
) && netif_carrier_ok(slave
->dev
);
326 static inline void bond_set_active_slave(struct slave
*slave
)
330 bond_queue_slave_event(slave
);
331 rtmsg_ifinfo(RTM_NEWLINK
, slave
->dev
, 0, GFP_ATOMIC
);
335 static inline void bond_set_backup_slave(struct slave
*slave
)
337 if (!slave
->backup
) {
339 bond_queue_slave_event(slave
);
340 rtmsg_ifinfo(RTM_NEWLINK
, slave
->dev
, 0, GFP_ATOMIC
);
344 static inline void bond_set_slave_state(struct slave
*slave
,
345 int slave_state
, bool notify
)
347 if (slave
->backup
== slave_state
)
350 slave
->backup
= slave_state
;
352 rtmsg_ifinfo(RTM_NEWLINK
, slave
->dev
, 0, GFP_ATOMIC
);
353 bond_queue_slave_event(slave
);
354 slave
->should_notify
= 0;
356 if (slave
->should_notify
)
357 slave
->should_notify
= 0;
359 slave
->should_notify
= 1;
363 static inline void bond_slave_state_change(struct bonding
*bond
)
365 struct list_head
*iter
;
368 bond_for_each_slave(bond
, tmp
, iter
) {
369 if (tmp
->link
== BOND_LINK_UP
)
370 bond_set_active_slave(tmp
);
371 else if (tmp
->link
== BOND_LINK_DOWN
)
372 bond_set_backup_slave(tmp
);
376 static inline void bond_slave_state_notify(struct bonding
*bond
)
378 struct list_head
*iter
;
381 bond_for_each_slave(bond
, tmp
, iter
) {
382 if (tmp
->should_notify
) {
383 rtmsg_ifinfo(RTM_NEWLINK
, tmp
->dev
, 0, GFP_ATOMIC
);
384 tmp
->should_notify
= 0;
389 static inline int bond_slave_state(struct slave
*slave
)
391 return slave
->backup
;
394 static inline bool bond_is_active_slave(struct slave
*slave
)
396 return !bond_slave_state(slave
);
399 static inline bool bond_slave_can_tx(struct slave
*slave
)
401 return bond_slave_is_up(slave
) && slave
->link
== BOND_LINK_UP
&&
402 bond_is_active_slave(slave
);
405 #define BOND_PRI_RESELECT_ALWAYS 0
406 #define BOND_PRI_RESELECT_BETTER 1
407 #define BOND_PRI_RESELECT_FAILURE 2
409 #define BOND_FOM_NONE 0
410 #define BOND_FOM_ACTIVE 1
411 #define BOND_FOM_FOLLOW 2
413 #define BOND_ARP_TARGETS_ANY 0
414 #define BOND_ARP_TARGETS_ALL 1
416 #define BOND_ARP_VALIDATE_NONE 0
417 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
418 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
419 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
420 BOND_ARP_VALIDATE_BACKUP)
421 #define BOND_ARP_FILTER (BOND_ARP_VALIDATE_ALL + 1)
422 #define BOND_ARP_FILTER_ACTIVE (BOND_ARP_VALIDATE_ACTIVE | \
424 #define BOND_ARP_FILTER_BACKUP (BOND_ARP_VALIDATE_BACKUP | \
427 #define BOND_SLAVE_NOTIFY_NOW true
428 #define BOND_SLAVE_NOTIFY_LATER false
430 static inline int slave_do_arp_validate(struct bonding
*bond
,
433 return bond
->params
.arp_validate
& (1 << bond_slave_state(slave
));
436 static inline int slave_do_arp_validate_only(struct bonding
*bond
)
438 return bond
->params
.arp_validate
& BOND_ARP_FILTER
;
441 static inline int bond_is_ip_target_ok(__be32 addr
)
443 return !ipv4_is_lbcast(addr
) && !ipv4_is_zeronet(addr
);
446 /* Get the oldest arp which we've received on this slave for bond's
449 static inline unsigned long slave_oldest_target_arp_rx(struct bonding
*bond
,
453 unsigned long ret
= slave
->target_last_arp_rx
[0];
455 for (; (i
< BOND_MAX_ARP_TARGETS
) && bond
->params
.arp_targets
[i
]; i
++)
456 if (time_before(slave
->target_last_arp_rx
[i
], ret
))
457 ret
= slave
->target_last_arp_rx
[i
];
462 static inline unsigned long slave_last_rx(struct bonding
*bond
,
465 if (bond
->params
.arp_all_targets
== BOND_ARP_TARGETS_ALL
)
466 return slave_oldest_target_arp_rx(bond
, slave
);
468 return slave
->last_rx
;
471 #ifdef CONFIG_NET_POLL_CONTROLLER
472 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
475 struct netpoll
*np
= slave
->np
;
478 netpoll_send_skb(np
, skb
);
481 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
487 static inline void bond_set_slave_inactive_flags(struct slave
*slave
,
490 if (!bond_is_lb(slave
->bond
))
491 bond_set_slave_state(slave
, BOND_STATE_BACKUP
, notify
);
492 if (!slave
->bond
->params
.all_slaves_active
)
496 static inline void bond_set_slave_active_flags(struct slave
*slave
,
499 bond_set_slave_state(slave
, BOND_STATE_ACTIVE
, notify
);
503 static inline bool bond_is_slave_inactive(struct slave
*slave
)
505 return slave
->inactive
;
508 static inline void bond_set_slave_link_state(struct slave
*slave
, int state
,
511 if (slave
->link
== state
)
516 bond_queue_slave_event(slave
);
517 slave
->should_notify_link
= 0;
519 if (slave
->should_notify_link
)
520 slave
->should_notify_link
= 0;
522 slave
->should_notify_link
= 1;
526 static inline void bond_slave_link_notify(struct bonding
*bond
)
528 struct list_head
*iter
;
531 bond_for_each_slave(bond
, tmp
, iter
) {
532 if (tmp
->should_notify_link
) {
533 bond_queue_slave_event(tmp
);
534 tmp
->should_notify_link
= 0;
539 static inline __be32
bond_confirm_addr(struct net_device
*dev
, __be32 dst
, __be32 local
)
541 struct in_device
*in_dev
;
545 in_dev
= __in_dev_get_rcu(dev
);
548 addr
= inet_confirm_addr(dev_net(dev
), in_dev
, dst
, local
,
555 struct net
*net
; /* Associated network namespace */
556 struct list_head dev_list
;
557 #ifdef CONFIG_PROC_FS
558 struct proc_dir_entry
*proc_dir
;
560 struct class_attribute class_attr_bonding_masters
;
563 int bond_arp_rcv(const struct sk_buff
*skb
, struct bonding
*bond
, struct slave
*slave
);
564 void bond_dev_queue_xmit(struct bonding
*bond
, struct sk_buff
*skb
, struct net_device
*slave_dev
);
565 int bond_create(struct net
*net
, const char *name
);
566 int bond_create_sysfs(struct bond_net
*net
);
567 void bond_destroy_sysfs(struct bond_net
*net
);
568 void bond_prepare_sysfs_group(struct bonding
*bond
);
569 int bond_sysfs_slave_add(struct slave
*slave
);
570 void bond_sysfs_slave_del(struct slave
*slave
);
571 int bond_enslave(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
572 int bond_release(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
573 u32
bond_xmit_hash(struct bonding
*bond
, struct sk_buff
*skb
);
574 int bond_set_carrier(struct bonding
*bond
);
575 void bond_select_active_slave(struct bonding
*bond
);
576 void bond_change_active_slave(struct bonding
*bond
, struct slave
*new_active
);
577 void bond_create_debugfs(void);
578 void bond_destroy_debugfs(void);
579 void bond_debug_register(struct bonding
*bond
);
580 void bond_debug_unregister(struct bonding
*bond
);
581 void bond_debug_reregister(struct bonding
*bond
);
582 const char *bond_mode_name(int mode
);
583 void bond_setup(struct net_device
*bond_dev
);
584 unsigned int bond_get_num_tx_queues(void);
585 int bond_netlink_init(void);
586 void bond_netlink_fini(void);
587 struct net_device
*bond_option_active_slave_get_rcu(struct bonding
*bond
);
588 const char *bond_slave_link_status(s8 link
);
589 struct bond_vlan_tag
*bond_verify_device_path(struct net_device
*start_dev
,
590 struct net_device
*end_dev
,
592 int bond_update_slave_arr(struct bonding
*bond
, struct slave
*skipslave
);
593 void bond_slave_arr_work_rearm(struct bonding
*bond
, unsigned long delay
);
595 #ifdef CONFIG_PROC_FS
596 void bond_create_proc_entry(struct bonding
*bond
);
597 void bond_remove_proc_entry(struct bonding
*bond
);
598 void bond_create_proc_dir(struct bond_net
*bn
);
599 void bond_destroy_proc_dir(struct bond_net
*bn
);
601 static inline void bond_create_proc_entry(struct bonding
*bond
)
605 static inline void bond_remove_proc_entry(struct bonding
*bond
)
609 static inline void bond_create_proc_dir(struct bond_net
*bn
)
613 static inline void bond_destroy_proc_dir(struct bond_net
*bn
)
618 static inline struct slave
*bond_slave_has_mac(struct bonding
*bond
,
621 struct list_head
*iter
;
624 bond_for_each_slave(bond
, tmp
, iter
)
625 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
631 /* Caller must hold rcu_read_lock() for read */
632 static inline struct slave
*bond_slave_has_mac_rcu(struct bonding
*bond
,
635 struct list_head
*iter
;
638 bond_for_each_slave_rcu(bond
, tmp
, iter
)
639 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
645 /* Caller must hold rcu_read_lock() for read */
646 static inline bool bond_slave_has_mac_rx(struct bonding
*bond
, const u8
*mac
)
648 struct list_head
*iter
;
650 struct netdev_hw_addr
*ha
;
652 bond_for_each_slave_rcu(bond
, tmp
, iter
)
653 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
656 if (netdev_uc_empty(bond
->dev
))
659 netdev_for_each_uc_addr(ha
, bond
->dev
)
660 if (ether_addr_equal_64bits(mac
, ha
->addr
))
666 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
667 * Returns -1 if not found, index if found
669 static inline int bond_get_targets_ip(__be32
*targets
, __be32 ip
)
673 for (i
= 0; i
< BOND_MAX_ARP_TARGETS
; i
++)
674 if (targets
[i
] == ip
)
676 else if (targets
[i
] == 0)
682 /* exported from bond_main.c */
683 extern int bond_net_id
;
684 extern const struct bond_parm_tbl bond_lacp_tbl
[];
685 extern const struct bond_parm_tbl xmit_hashtype_tbl
[];
686 extern const struct bond_parm_tbl arp_validate_tbl
[];
687 extern const struct bond_parm_tbl arp_all_targets_tbl
[];
688 extern const struct bond_parm_tbl fail_over_mac_tbl
[];
689 extern const struct bond_parm_tbl pri_reselect_tbl
[];
690 extern struct bond_parm_tbl ad_select_tbl
[];
692 /* exported from bond_netlink.c */
693 extern struct rtnl_link_ops bond_link_ops
;
695 static inline void bond_tx_drop(struct net_device
*dev
, struct sk_buff
*skb
)
697 atomic_long_inc(&dev
->tx_dropped
);
698 dev_kfree_skb_any(skb
);
701 #endif /* _NET_BONDING_H */