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
);
250 void bond_lower_state_changed(struct slave
*slave
);
252 struct bond_vlan_tag
{
254 unsigned short vlan_id
;
258 * Returns NULL if the net_device does not belong to any of the bond's slaves
260 * Caller must hold bond lock for read
262 static inline struct slave
*bond_get_slave_by_dev(struct bonding
*bond
,
263 struct net_device
*slave_dev
)
265 return netdev_lower_dev_get_private(bond
->dev
, slave_dev
);
268 static inline struct bonding
*bond_get_bond_by_slave(struct slave
*slave
)
273 static inline bool bond_should_override_tx_queue(struct bonding
*bond
)
275 return BOND_MODE(bond
) == BOND_MODE_ACTIVEBACKUP
||
276 BOND_MODE(bond
) == BOND_MODE_ROUNDROBIN
;
279 static inline bool bond_is_lb(const struct bonding
*bond
)
281 return BOND_MODE(bond
) == BOND_MODE_TLB
||
282 BOND_MODE(bond
) == BOND_MODE_ALB
;
285 static inline bool bond_is_nondyn_tlb(const struct bonding
*bond
)
287 return (BOND_MODE(bond
) == BOND_MODE_TLB
) &&
288 (bond
->params
.tlb_dynamic_lb
== 0);
291 static inline bool bond_mode_uses_xmit_hash(const struct bonding
*bond
)
293 return (BOND_MODE(bond
) == BOND_MODE_8023AD
||
294 BOND_MODE(bond
) == BOND_MODE_XOR
||
295 bond_is_nondyn_tlb(bond
));
298 static inline bool bond_mode_uses_arp(int mode
)
300 return mode
!= BOND_MODE_8023AD
&& mode
!= BOND_MODE_TLB
&&
301 mode
!= BOND_MODE_ALB
;
304 static inline bool bond_mode_uses_primary(int mode
)
306 return mode
== BOND_MODE_ACTIVEBACKUP
|| mode
== BOND_MODE_TLB
||
307 mode
== BOND_MODE_ALB
;
310 static inline bool bond_uses_primary(struct bonding
*bond
)
312 return bond_mode_uses_primary(BOND_MODE(bond
));
315 static inline struct net_device
*bond_option_active_slave_get_rcu(struct bonding
*bond
)
317 struct slave
*slave
= rcu_dereference(bond
->curr_active_slave
);
319 return bond_uses_primary(bond
) && slave
? slave
->dev
: NULL
;
322 static inline bool bond_slave_is_up(struct slave
*slave
)
324 return netif_running(slave
->dev
) && netif_carrier_ok(slave
->dev
);
327 static inline void bond_set_active_slave(struct slave
*slave
)
331 bond_queue_slave_event(slave
);
332 bond_lower_state_changed(slave
);
333 rtmsg_ifinfo(RTM_NEWLINK
, slave
->dev
, 0, GFP_ATOMIC
);
337 static inline void bond_set_backup_slave(struct slave
*slave
)
339 if (!slave
->backup
) {
341 bond_queue_slave_event(slave
);
342 bond_lower_state_changed(slave
);
343 rtmsg_ifinfo(RTM_NEWLINK
, slave
->dev
, 0, GFP_ATOMIC
);
347 static inline void bond_set_slave_state(struct slave
*slave
,
348 int slave_state
, bool notify
)
350 if (slave
->backup
== slave_state
)
353 slave
->backup
= slave_state
;
355 bond_lower_state_changed(slave
);
356 rtmsg_ifinfo(RTM_NEWLINK
, slave
->dev
, 0, GFP_ATOMIC
);
357 bond_queue_slave_event(slave
);
358 slave
->should_notify
= 0;
360 if (slave
->should_notify
)
361 slave
->should_notify
= 0;
363 slave
->should_notify
= 1;
367 static inline void bond_slave_state_change(struct bonding
*bond
)
369 struct list_head
*iter
;
372 bond_for_each_slave(bond
, tmp
, iter
) {
373 if (tmp
->link
== BOND_LINK_UP
)
374 bond_set_active_slave(tmp
);
375 else if (tmp
->link
== BOND_LINK_DOWN
)
376 bond_set_backup_slave(tmp
);
380 static inline void bond_slave_state_notify(struct bonding
*bond
)
382 struct list_head
*iter
;
385 bond_for_each_slave(bond
, tmp
, iter
) {
386 if (tmp
->should_notify
) {
387 bond_lower_state_changed(tmp
);
388 rtmsg_ifinfo(RTM_NEWLINK
, tmp
->dev
, 0, GFP_ATOMIC
);
389 tmp
->should_notify
= 0;
394 static inline int bond_slave_state(struct slave
*slave
)
396 return slave
->backup
;
399 static inline bool bond_is_active_slave(struct slave
*slave
)
401 return !bond_slave_state(slave
);
404 static inline bool bond_slave_can_tx(struct slave
*slave
)
406 return bond_slave_is_up(slave
) && slave
->link
== BOND_LINK_UP
&&
407 bond_is_active_slave(slave
);
410 #define BOND_PRI_RESELECT_ALWAYS 0
411 #define BOND_PRI_RESELECT_BETTER 1
412 #define BOND_PRI_RESELECT_FAILURE 2
414 #define BOND_FOM_NONE 0
415 #define BOND_FOM_ACTIVE 1
416 #define BOND_FOM_FOLLOW 2
418 #define BOND_ARP_TARGETS_ANY 0
419 #define BOND_ARP_TARGETS_ALL 1
421 #define BOND_ARP_VALIDATE_NONE 0
422 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
423 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
424 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
425 BOND_ARP_VALIDATE_BACKUP)
426 #define BOND_ARP_FILTER (BOND_ARP_VALIDATE_ALL + 1)
427 #define BOND_ARP_FILTER_ACTIVE (BOND_ARP_VALIDATE_ACTIVE | \
429 #define BOND_ARP_FILTER_BACKUP (BOND_ARP_VALIDATE_BACKUP | \
432 #define BOND_SLAVE_NOTIFY_NOW true
433 #define BOND_SLAVE_NOTIFY_LATER false
435 static inline int slave_do_arp_validate(struct bonding
*bond
,
438 return bond
->params
.arp_validate
& (1 << bond_slave_state(slave
));
441 static inline int slave_do_arp_validate_only(struct bonding
*bond
)
443 return bond
->params
.arp_validate
& BOND_ARP_FILTER
;
446 static inline int bond_is_ip_target_ok(__be32 addr
)
448 return !ipv4_is_lbcast(addr
) && !ipv4_is_zeronet(addr
);
451 /* Get the oldest arp which we've received on this slave for bond's
454 static inline unsigned long slave_oldest_target_arp_rx(struct bonding
*bond
,
458 unsigned long ret
= slave
->target_last_arp_rx
[0];
460 for (; (i
< BOND_MAX_ARP_TARGETS
) && bond
->params
.arp_targets
[i
]; i
++)
461 if (time_before(slave
->target_last_arp_rx
[i
], ret
))
462 ret
= slave
->target_last_arp_rx
[i
];
467 static inline unsigned long slave_last_rx(struct bonding
*bond
,
470 if (bond
->params
.arp_all_targets
== BOND_ARP_TARGETS_ALL
)
471 return slave_oldest_target_arp_rx(bond
, slave
);
473 return slave
->last_rx
;
476 #ifdef CONFIG_NET_POLL_CONTROLLER
477 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
480 struct netpoll
*np
= slave
->np
;
483 netpoll_send_skb(np
, skb
);
486 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
492 static inline void bond_set_slave_inactive_flags(struct slave
*slave
,
495 if (!bond_is_lb(slave
->bond
))
496 bond_set_slave_state(slave
, BOND_STATE_BACKUP
, notify
);
497 if (!slave
->bond
->params
.all_slaves_active
)
501 static inline void bond_set_slave_active_flags(struct slave
*slave
,
504 bond_set_slave_state(slave
, BOND_STATE_ACTIVE
, notify
);
508 static inline bool bond_is_slave_inactive(struct slave
*slave
)
510 return slave
->inactive
;
513 static inline void bond_set_slave_link_state(struct slave
*slave
, int state
,
516 if (slave
->link
== state
)
521 bond_queue_slave_event(slave
);
522 bond_lower_state_changed(slave
);
523 slave
->should_notify_link
= 0;
525 if (slave
->should_notify_link
)
526 slave
->should_notify_link
= 0;
528 slave
->should_notify_link
= 1;
532 static inline void bond_slave_link_notify(struct bonding
*bond
)
534 struct list_head
*iter
;
537 bond_for_each_slave(bond
, tmp
, iter
) {
538 if (tmp
->should_notify_link
) {
539 bond_queue_slave_event(tmp
);
540 bond_lower_state_changed(tmp
);
541 tmp
->should_notify_link
= 0;
546 static inline __be32
bond_confirm_addr(struct net_device
*dev
, __be32 dst
, __be32 local
)
548 struct in_device
*in_dev
;
552 in_dev
= __in_dev_get_rcu(dev
);
555 addr
= inet_confirm_addr(dev_net(dev
), in_dev
, dst
, local
,
562 struct net
*net
; /* Associated network namespace */
563 struct list_head dev_list
;
564 #ifdef CONFIG_PROC_FS
565 struct proc_dir_entry
*proc_dir
;
567 struct class_attribute class_attr_bonding_masters
;
570 int bond_arp_rcv(const struct sk_buff
*skb
, struct bonding
*bond
, struct slave
*slave
);
571 void bond_dev_queue_xmit(struct bonding
*bond
, struct sk_buff
*skb
, struct net_device
*slave_dev
);
572 int bond_create(struct net
*net
, const char *name
);
573 int bond_create_sysfs(struct bond_net
*net
);
574 void bond_destroy_sysfs(struct bond_net
*net
);
575 void bond_prepare_sysfs_group(struct bonding
*bond
);
576 int bond_sysfs_slave_add(struct slave
*slave
);
577 void bond_sysfs_slave_del(struct slave
*slave
);
578 int bond_enslave(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
579 int bond_release(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
580 u32
bond_xmit_hash(struct bonding
*bond
, struct sk_buff
*skb
);
581 int bond_set_carrier(struct bonding
*bond
);
582 void bond_select_active_slave(struct bonding
*bond
);
583 void bond_change_active_slave(struct bonding
*bond
, struct slave
*new_active
);
584 void bond_create_debugfs(void);
585 void bond_destroy_debugfs(void);
586 void bond_debug_register(struct bonding
*bond
);
587 void bond_debug_unregister(struct bonding
*bond
);
588 void bond_debug_reregister(struct bonding
*bond
);
589 const char *bond_mode_name(int mode
);
590 void bond_setup(struct net_device
*bond_dev
);
591 unsigned int bond_get_num_tx_queues(void);
592 int bond_netlink_init(void);
593 void bond_netlink_fini(void);
594 struct net_device
*bond_option_active_slave_get_rcu(struct bonding
*bond
);
595 const char *bond_slave_link_status(s8 link
);
596 struct bond_vlan_tag
*bond_verify_device_path(struct net_device
*start_dev
,
597 struct net_device
*end_dev
,
599 int bond_update_slave_arr(struct bonding
*bond
, struct slave
*skipslave
);
600 void bond_slave_arr_work_rearm(struct bonding
*bond
, unsigned long delay
);
602 #ifdef CONFIG_PROC_FS
603 void bond_create_proc_entry(struct bonding
*bond
);
604 void bond_remove_proc_entry(struct bonding
*bond
);
605 void bond_create_proc_dir(struct bond_net
*bn
);
606 void bond_destroy_proc_dir(struct bond_net
*bn
);
608 static inline void bond_create_proc_entry(struct bonding
*bond
)
612 static inline void bond_remove_proc_entry(struct bonding
*bond
)
616 static inline void bond_create_proc_dir(struct bond_net
*bn
)
620 static inline void bond_destroy_proc_dir(struct bond_net
*bn
)
625 static inline struct slave
*bond_slave_has_mac(struct bonding
*bond
,
628 struct list_head
*iter
;
631 bond_for_each_slave(bond
, tmp
, iter
)
632 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
638 /* Caller must hold rcu_read_lock() for read */
639 static inline struct slave
*bond_slave_has_mac_rcu(struct bonding
*bond
,
642 struct list_head
*iter
;
645 bond_for_each_slave_rcu(bond
, tmp
, iter
)
646 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
652 /* Caller must hold rcu_read_lock() for read */
653 static inline bool bond_slave_has_mac_rx(struct bonding
*bond
, const u8
*mac
)
655 struct list_head
*iter
;
657 struct netdev_hw_addr
*ha
;
659 bond_for_each_slave_rcu(bond
, tmp
, iter
)
660 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
663 if (netdev_uc_empty(bond
->dev
))
666 netdev_for_each_uc_addr(ha
, bond
->dev
)
667 if (ether_addr_equal_64bits(mac
, ha
->addr
))
673 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
674 * Returns -1 if not found, index if found
676 static inline int bond_get_targets_ip(__be32
*targets
, __be32 ip
)
680 for (i
= 0; i
< BOND_MAX_ARP_TARGETS
; i
++)
681 if (targets
[i
] == ip
)
683 else if (targets
[i
] == 0)
689 /* exported from bond_main.c */
690 extern int bond_net_id
;
691 extern const struct bond_parm_tbl bond_lacp_tbl
[];
692 extern const struct bond_parm_tbl xmit_hashtype_tbl
[];
693 extern const struct bond_parm_tbl arp_validate_tbl
[];
694 extern const struct bond_parm_tbl arp_all_targets_tbl
[];
695 extern const struct bond_parm_tbl fail_over_mac_tbl
[];
696 extern const struct bond_parm_tbl pri_reselect_tbl
[];
697 extern struct bond_parm_tbl ad_select_tbl
[];
699 /* exported from bond_netlink.c */
700 extern struct rtnl_link_ops bond_link_ops
;
702 static inline void bond_tx_drop(struct net_device
*dev
, struct sk_buff
*skb
)
704 atomic_long_inc(&dev
->tx_dropped
);
705 dev_kfree_skb_any(skb
);
708 #endif /* _NET_BONDING_H */