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>
29 #define DRV_VERSION "3.7.1"
30 #define DRV_RELDATE "April 27, 2011"
31 #define DRV_NAME "bonding"
32 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
34 #define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
36 #define BOND_MAX_ARP_TARGETS 16
38 #define BOND_DEFAULT_MIIMON 100
41 ((((dev)->flags & IFF_UP) == IFF_UP) && \
42 netif_running(dev) && \
43 netif_carrier_ok(dev))
46 * Checks whether slave is ready for transmit.
48 #define SLAVE_IS_OK(slave) \
49 (((slave)->dev->flags & IFF_UP) && \
50 netif_running((slave)->dev) && \
51 ((slave)->link == BOND_LINK_UP) && \
52 bond_is_active_slave(slave))
55 #define USES_PRIMARY(mode) \
56 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
57 ((mode) == BOND_MODE_TLB) || \
58 ((mode) == BOND_MODE_ALB))
60 #define BOND_NO_USES_ARP(mode) \
61 (((mode) == BOND_MODE_8023AD) || \
62 ((mode) == BOND_MODE_TLB) || \
63 ((mode) == BOND_MODE_ALB))
65 #define TX_QUEUE_OVERRIDE(mode) \
66 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
67 ((mode) == BOND_MODE_ROUNDROBIN))
69 #define BOND_MODE_IS_LB(mode) \
70 (((mode) == BOND_MODE_TLB) || \
71 ((mode) == BOND_MODE_ALB))
73 #define IS_IP_TARGET_UNUSABLE_ADDRESS(a) \
74 ((htonl(INADDR_BROADCAST) == a) || \
77 * Less bad way to call ioctl from within the kernel; this needs to be
78 * done some other way to get the call out of interrupt context.
79 * Needs "ioctl" variable to be supplied by calling context.
81 #define IOCTL(dev, arg, cmd) ({ \
83 mm_segment_t fs = get_fs(); \
85 res = ioctl(dev, arg, cmd); \
89 /* slave list primitives */
90 #define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
92 #define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
94 /* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
95 #define bond_first_slave(bond) \
96 (bond_has_slaves(bond) ? \
97 netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
99 #define bond_last_slave(bond) \
100 (bond_has_slaves(bond) ? \
101 netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
104 #define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
105 #define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
108 * bond_for_each_slave - iterate over all slaves
109 * @bond: the bond holding this list
110 * @pos: current slave
111 * @iter: list_head * iterator
113 * Caller must hold bond->lock
115 #define bond_for_each_slave(bond, pos, iter) \
116 netdev_for_each_lower_private((bond)->dev, pos, iter)
118 /* Caller must have rcu_read_lock */
119 #define bond_for_each_slave_rcu(bond, pos, iter) \
120 netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
122 #ifdef CONFIG_NET_POLL_CONTROLLER
123 extern atomic_t netpoll_block_tx
;
125 static inline void block_netpoll_tx(void)
127 atomic_inc(&netpoll_block_tx
);
130 static inline void unblock_netpoll_tx(void)
132 atomic_dec(&netpoll_block_tx
);
135 static inline int is_netpoll_tx_blocked(struct net_device
*dev
)
137 if (unlikely(netpoll_tx_running(dev
)))
138 return atomic_read(&netpoll_block_tx
);
142 #define block_netpoll_tx()
143 #define unblock_netpoll_tx()
144 #define is_netpoll_tx_blocked(dev) (0)
160 unsigned int min_links
;
162 char primary
[IFNAMSIZ
];
163 int primary_reselect
;
164 __be32 arp_targets
[BOND_MAX_ARP_TARGETS
];
166 int all_slaves_active
;
169 int packets_per_slave
;
172 struct bond_parm_tbl
{
177 #define BOND_MAX_MODENAME_LEN 20
180 struct net_device
*dev
; /* first - useful for panic debug */
181 struct bonding
*bond
; /* our master */
183 unsigned long jiffies
;
184 unsigned long last_arp_rx
;
185 unsigned long target_last_arp_rx
[BOND_MAX_ARP_TARGETS
];
186 s8 link
; /* one of BOND_LINK_XXXX */
188 u8 backup
:1, /* indicates backup slave. Value corresponds with
189 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
190 inactive
:1; /* indicates inactive slave */
193 u32 link_failure_count
;
196 u8 perm_hwaddr
[ETH_ALEN
];
197 struct ad_slave_info ad_info
; /* HUGE - better to dynamically alloc */
198 struct tlb_slave_info tlb_info
;
199 #ifdef CONFIG_NET_POLL_CONTROLLER
205 * Link pseudo-state only used internally by monitors
207 #define BOND_LINK_NOCHANGE -1
210 * Here are the locking policies for the two bonding locks:
212 * 1) Get bond->lock when reading/writing slave list.
213 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
214 * (It is unnecessary when the write-lock is put with bond->lock.)
215 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
219 struct net_device
*dev
; /* first - useful for panic debug */
220 struct slave
*curr_active_slave
;
221 struct slave
*current_arp_slave
;
222 struct slave
*primary_slave
;
224 s32 slave_cnt
; /* never change this value outside the attach/detach wrappers */
225 int (*recv_probe
)(const struct sk_buff
*, struct bonding
*,
228 rwlock_t curr_slave_lock
;
231 #ifdef CONFIG_PROC_FS
232 struct proc_dir_entry
*proc_entry
;
233 char proc_file_name
[IFNAMSIZ
];
234 #endif /* CONFIG_PROC_FS */
235 struct list_head bond_list
;
237 struct ad_bond_info ad_info
;
238 struct alb_bond_info alb_info
;
239 struct bond_params params
;
240 struct workqueue_struct
*wq
;
241 struct delayed_work mii_work
;
242 struct delayed_work arp_work
;
243 struct delayed_work alb_work
;
244 struct delayed_work ad_work
;
245 struct delayed_work mcast_work
;
246 #ifdef CONFIG_DEBUG_FS
247 /* debugging support via debugfs */
248 struct dentry
*debug_dir
;
249 #endif /* CONFIG_DEBUG_FS */
252 #define bond_slave_get_rcu(dev) \
253 ((struct slave *) rcu_dereference(dev->rx_handler_data))
255 #define bond_slave_get_rtnl(dev) \
256 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
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
)
271 if (!slave
|| !slave
->bond
)
276 static inline bool bond_is_lb(const struct bonding
*bond
)
278 return BOND_MODE_IS_LB(bond
->params
.mode
);
281 static inline void bond_set_active_slave(struct slave
*slave
)
286 static inline void bond_set_backup_slave(struct slave
*slave
)
291 static inline int bond_slave_state(struct slave
*slave
)
293 return slave
->backup
;
296 static inline bool bond_is_active_slave(struct slave
*slave
)
298 return !bond_slave_state(slave
);
301 #define BOND_PRI_RESELECT_ALWAYS 0
302 #define BOND_PRI_RESELECT_BETTER 1
303 #define BOND_PRI_RESELECT_FAILURE 2
305 #define BOND_FOM_NONE 0
306 #define BOND_FOM_ACTIVE 1
307 #define BOND_FOM_FOLLOW 2
309 #define BOND_ARP_TARGETS_ANY 0
310 #define BOND_ARP_TARGETS_ALL 1
312 #define BOND_ARP_VALIDATE_NONE 0
313 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
314 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
315 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
316 BOND_ARP_VALIDATE_BACKUP)
318 static inline int slave_do_arp_validate(struct bonding
*bond
,
321 return bond
->params
.arp_validate
& (1 << bond_slave_state(slave
));
324 /* Get the oldest arp which we've received on this slave for bond's
327 static inline unsigned long slave_oldest_target_arp_rx(struct bonding
*bond
,
331 unsigned long ret
= slave
->target_last_arp_rx
[0];
333 for (; (i
< BOND_MAX_ARP_TARGETS
) && bond
->params
.arp_targets
[i
]; i
++)
334 if (time_before(slave
->target_last_arp_rx
[i
], ret
))
335 ret
= slave
->target_last_arp_rx
[i
];
340 static inline unsigned long slave_last_rx(struct bonding
*bond
,
343 if (slave_do_arp_validate(bond
, slave
)) {
344 if (bond
->params
.arp_all_targets
== BOND_ARP_TARGETS_ALL
)
345 return slave_oldest_target_arp_rx(bond
, slave
);
347 return slave
->last_arp_rx
;
350 return slave
->dev
->last_rx
;
353 #ifdef CONFIG_NET_POLL_CONTROLLER
354 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
357 struct netpoll
*np
= slave
->np
;
360 netpoll_send_skb(np
, skb
);
363 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
369 static inline void bond_set_slave_inactive_flags(struct slave
*slave
)
371 if (!bond_is_lb(slave
->bond
))
372 bond_set_backup_slave(slave
);
373 if (!slave
->bond
->params
.all_slaves_active
)
377 static inline void bond_set_slave_active_flags(struct slave
*slave
)
379 bond_set_active_slave(slave
);
383 static inline bool bond_is_slave_inactive(struct slave
*slave
)
385 return slave
->inactive
;
388 static inline __be32
bond_confirm_addr(struct net_device
*dev
, __be32 dst
, __be32 local
)
390 struct in_device
*in_dev
;
394 in_dev
= __in_dev_get_rcu(dev
);
397 addr
= inet_confirm_addr(in_dev
, dst
, local
, RT_SCOPE_HOST
);
403 static inline bool slave_can_tx(struct slave
*slave
)
405 if (IS_UP(slave
->dev
) && slave
->link
== BOND_LINK_UP
&&
406 bond_is_active_slave(slave
))
414 int bond_arp_rcv(const struct sk_buff
*skb
, struct bonding
*bond
, struct slave
*slave
);
415 int bond_dev_queue_xmit(struct bonding
*bond
, struct sk_buff
*skb
, struct net_device
*slave_dev
);
416 void bond_xmit_slave_id(struct bonding
*bond
, struct sk_buff
*skb
, int slave_id
);
417 int bond_create(struct net
*net
, const char *name
);
418 int bond_create_sysfs(struct bond_net
*net
);
419 void bond_destroy_sysfs(struct bond_net
*net
);
420 void bond_prepare_sysfs_group(struct bonding
*bond
);
421 int bond_enslave(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
422 int bond_release(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
423 void bond_mii_monitor(struct work_struct
*);
424 void bond_loadbalance_arp_mon(struct work_struct
*);
425 void bond_activebackup_arp_mon(struct work_struct
*);
426 int bond_xmit_hash(struct bonding
*bond
, struct sk_buff
*skb
, int count
);
427 int bond_parse_parm(const char *mode_arg
, const struct bond_parm_tbl
*tbl
);
428 void bond_select_active_slave(struct bonding
*bond
);
429 void bond_change_active_slave(struct bonding
*bond
, struct slave
*new_active
);
430 void bond_create_debugfs(void);
431 void bond_destroy_debugfs(void);
432 void bond_debug_register(struct bonding
*bond
);
433 void bond_debug_unregister(struct bonding
*bond
);
434 void bond_debug_reregister(struct bonding
*bond
);
435 const char *bond_mode_name(int mode
);
436 void bond_setup(struct net_device
*bond_dev
);
437 unsigned int bond_get_num_tx_queues(void);
438 int bond_netlink_init(void);
439 void bond_netlink_fini(void);
440 int bond_option_mode_set(struct bonding
*bond
, int mode
);
441 int bond_option_active_slave_set(struct bonding
*bond
, struct net_device
*slave_dev
);
442 struct net_device
*bond_option_active_slave_get_rcu(struct bonding
*bond
);
443 struct net_device
*bond_option_active_slave_get(struct bonding
*bond
);
446 struct net
* net
; /* Associated network namespace */
447 struct list_head dev_list
;
448 #ifdef CONFIG_PROC_FS
449 struct proc_dir_entry
* proc_dir
;
451 struct class_attribute class_attr_bonding_masters
;
454 #ifdef CONFIG_PROC_FS
455 void bond_create_proc_entry(struct bonding
*bond
);
456 void bond_remove_proc_entry(struct bonding
*bond
);
457 void bond_create_proc_dir(struct bond_net
*bn
);
458 void bond_destroy_proc_dir(struct bond_net
*bn
);
460 static inline void bond_create_proc_entry(struct bonding
*bond
)
464 static inline void bond_remove_proc_entry(struct bonding
*bond
)
468 static inline void bond_create_proc_dir(struct bond_net
*bn
)
472 static inline void bond_destroy_proc_dir(struct bond_net
*bn
)
477 static inline struct slave
*bond_slave_has_mac(struct bonding
*bond
,
480 struct list_head
*iter
;
483 bond_for_each_slave(bond
, tmp
, iter
)
484 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
490 /* Caller must hold rcu_read_lock() for read */
491 static inline struct slave
*bond_slave_has_mac_rcu(struct bonding
*bond
,
494 struct list_head
*iter
;
497 bond_for_each_slave_rcu(bond
, tmp
, iter
)
498 if (ether_addr_equal_64bits(mac
, tmp
->dev
->dev_addr
))
504 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
505 * Returns -1 if not found, index if found
507 static inline int bond_get_targets_ip(__be32
*targets
, __be32 ip
)
511 for (i
= 0; i
< BOND_MAX_ARP_TARGETS
; i
++)
512 if (targets
[i
] == ip
)
514 else if (targets
[i
] == 0)
520 /* exported from bond_main.c */
521 extern int bond_net_id
;
522 extern const struct bond_parm_tbl bond_lacp_tbl
[];
523 extern const struct bond_parm_tbl bond_mode_tbl
[];
524 extern const struct bond_parm_tbl xmit_hashtype_tbl
[];
525 extern const struct bond_parm_tbl arp_validate_tbl
[];
526 extern const struct bond_parm_tbl arp_all_targets_tbl
[];
527 extern const struct bond_parm_tbl fail_over_mac_tbl
[];
528 extern const struct bond_parm_tbl pri_reselect_tbl
[];
529 extern struct bond_parm_tbl ad_select_tbl
[];
531 /* exported from bond_netlink.c */
532 extern struct rtnl_link_ops bond_link_ops
;
534 #endif /* _LINUX_BONDING_H */