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>
27 #define DRV_VERSION "3.7.0"
28 #define DRV_RELDATE "June 2, 2010"
29 #define DRV_NAME "bonding"
30 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
32 #define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
34 #define BOND_MAX_ARP_TARGETS 16
37 ((((dev)->flags & IFF_UP) == IFF_UP) && \
38 netif_running(dev) && \
39 netif_carrier_ok(dev))
42 * Checks whether bond is ready for transmit.
44 * Caller must hold bond->lock
46 #define BOND_IS_OK(bond) \
47 (((bond)->dev->flags & IFF_UP) && \
48 netif_running((bond)->dev) && \
49 ((bond)->slave_cnt > 0))
52 * Checks whether slave is ready for transmit.
54 #define SLAVE_IS_OK(slave) \
55 (((slave)->dev->flags & IFF_UP) && \
56 netif_running((slave)->dev) && \
57 ((slave)->link == BOND_LINK_UP) && \
58 bond_is_active_slave(slave))
61 #define USES_PRIMARY(mode) \
62 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
63 ((mode) == BOND_MODE_TLB) || \
64 ((mode) == BOND_MODE_ALB))
66 #define TX_QUEUE_OVERRIDE(mode) \
67 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
68 ((mode) == BOND_MODE_ROUNDROBIN))
70 * Less bad way to call ioctl from within the kernel; this needs to be
71 * done some other way to get the call out of interrupt context.
72 * Needs "ioctl" variable to be supplied by calling context.
74 #define IOCTL(dev, arg, cmd) ({ \
76 mm_segment_t fs = get_fs(); \
78 res = ioctl(dev, arg, cmd); \
83 * bond_for_each_slave_from - iterate the slaves list from a starting point
84 * @bond: the bond holding this list.
85 * @pos: current slave.
86 * @cnt: counter for max number of moves
87 * @start: starting point.
89 * Caller must hold bond->lock
91 #define bond_for_each_slave_from(bond, pos, cnt, start) \
92 for (cnt = 0, pos = start; \
93 cnt < (bond)->slave_cnt; \
94 cnt++, pos = (pos)->next)
97 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
98 * @bond: the bond holding this list.
99 * @pos: current slave.
100 * @cnt: counter for number max of moves
101 * @start: start point.
104 * Caller must hold bond->lock
106 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
107 for (cnt = 0, pos = start; \
108 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
109 cnt++, pos = (pos)->next)
112 * bond_for_each_slave - iterate the slaves list from head
113 * @bond: the bond holding this list.
114 * @pos: current slave.
115 * @cnt: counter for max number of moves
117 * Caller must hold bond->lock
119 #define bond_for_each_slave(bond, pos, cnt) \
120 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
123 #ifdef CONFIG_NET_POLL_CONTROLLER
124 extern atomic_t netpoll_block_tx
;
126 static inline void block_netpoll_tx(void)
128 atomic_inc(&netpoll_block_tx
);
131 static inline void unblock_netpoll_tx(void)
133 atomic_dec(&netpoll_block_tx
);
136 static inline int is_netpoll_tx_blocked(struct net_device
*dev
)
138 if (unlikely(netpoll_tx_running(dev
)))
139 return atomic_read(&netpoll_block_tx
);
143 #define block_netpoll_tx()
144 #define unblock_netpoll_tx()
145 #define is_netpoll_tx_blocked(dev) (0)
162 char primary
[IFNAMSIZ
];
163 int primary_reselect
;
164 __be32 arp_targets
[BOND_MAX_ARP_TARGETS
];
166 int all_slaves_active
;
170 struct bond_parm_tbl
{
175 #define BOND_MAX_MODENAME_LEN 20
178 struct list_head vlan_list
;
180 unsigned short vlan_id
;
181 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
182 struct in6_addr vlan_ipv6
;
187 struct net_device
*dev
; /* first - useful for panic debug */
190 struct bonding
*bond
; /* our master */
192 unsigned long jiffies
;
193 unsigned long last_arp_rx
;
194 s8 link
; /* one of BOND_LINK_XXXX */
196 u8 backup
:1, /* indicates backup slave. Value corresponds with
197 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
198 inactive
:1; /* indicates inactive slave */
200 u32 link_failure_count
;
201 u8 perm_hwaddr
[ETH_ALEN
];
205 struct ad_slave_info ad_info
; /* HUGE - better to dynamically alloc */
206 struct tlb_slave_info tlb_info
;
207 #ifdef CONFIG_NET_POLL_CONTROLLER
213 * Link pseudo-state only used internally by monitors
215 #define BOND_LINK_NOCHANGE -1
218 * Here are the locking policies for the two bonding locks:
220 * 1) Get bond->lock when reading/writing slave list.
221 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
222 * (It is unnecessary when the write-lock is put with bond->lock.)
223 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
227 struct net_device
*dev
; /* first - useful for panic debug */
228 struct slave
*first_slave
;
229 struct slave
*curr_active_slave
;
230 struct slave
*current_arp_slave
;
231 struct slave
*primary_slave
;
233 s32 slave_cnt
; /* never change this value outside the attach/detach wrappers */
235 rwlock_t curr_slave_lock
;
241 #ifdef CONFIG_PROC_FS
242 struct proc_dir_entry
*proc_entry
;
243 char proc_file_name
[IFNAMSIZ
];
244 #endif /* CONFIG_PROC_FS */
245 struct list_head bond_list
;
246 struct netdev_hw_addr_list mc_list
;
247 int (*xmit_hash_policy
)(struct sk_buff
*, int);
251 struct ad_bond_info ad_info
;
252 struct alb_bond_info alb_info
;
253 struct bond_params params
;
254 struct list_head vlan_list
;
255 struct vlan_group
*vlgrp
;
256 struct packet_type arp_mon_pt
;
257 struct workqueue_struct
*wq
;
258 struct delayed_work mii_work
;
259 struct delayed_work arp_work
;
260 struct delayed_work alb_work
;
261 struct delayed_work ad_work
;
262 struct delayed_work mcast_work
;
263 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
264 struct in6_addr master_ipv6
;
266 #ifdef CONFIG_DEBUG_FS
267 /* debugging suport via debugfs */
268 struct dentry
*debug_dir
;
269 #endif /* CONFIG_DEBUG_FS */
272 #define bond_slave_get_rcu(dev) \
273 ((struct slave *) rcu_dereference(dev->rx_handler_data))
276 * Returns NULL if the net_device does not belong to any of the bond's slaves
278 * Caller must hold bond lock for read
280 static inline struct slave
*bond_get_slave_by_dev(struct bonding
*bond
,
281 struct net_device
*slave_dev
)
283 struct slave
*slave
= NULL
;
286 bond_for_each_slave(bond
, slave
, i
) {
287 if (slave
->dev
== slave_dev
) {
295 static inline struct bonding
*bond_get_bond_by_slave(struct slave
*slave
)
297 if (!slave
|| !slave
->dev
->master
) {
301 return netdev_priv(slave
->dev
->master
);
304 static inline bool bond_is_lb(const struct bonding
*bond
)
306 return (bond
->params
.mode
== BOND_MODE_TLB
||
307 bond
->params
.mode
== BOND_MODE_ALB
);
310 static inline void bond_set_active_slave(struct slave
*slave
)
315 static inline void bond_set_backup_slave(struct slave
*slave
)
320 static inline int bond_slave_state(struct slave
*slave
)
322 return slave
->backup
;
325 static inline bool bond_is_active_slave(struct slave
*slave
)
327 return !bond_slave_state(slave
);
330 #define BOND_PRI_RESELECT_ALWAYS 0
331 #define BOND_PRI_RESELECT_BETTER 1
332 #define BOND_PRI_RESELECT_FAILURE 2
334 #define BOND_FOM_NONE 0
335 #define BOND_FOM_ACTIVE 1
336 #define BOND_FOM_FOLLOW 2
338 #define BOND_ARP_VALIDATE_NONE 0
339 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
340 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
341 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
342 BOND_ARP_VALIDATE_BACKUP)
344 static inline int slave_do_arp_validate(struct bonding
*bond
,
347 return bond
->params
.arp_validate
& (1 << bond_slave_state(slave
));
350 static inline unsigned long slave_last_rx(struct bonding
*bond
,
353 if (slave_do_arp_validate(bond
, slave
))
354 return slave
->last_arp_rx
;
356 return slave
->dev
->last_rx
;
359 #ifdef CONFIG_NET_POLL_CONTROLLER
360 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
363 struct netpoll
*np
= slave
->np
;
366 netpoll_send_skb(np
, skb
);
369 static inline void bond_netpoll_send_skb(const struct slave
*slave
,
375 static inline void bond_set_slave_inactive_flags(struct slave
*slave
)
377 struct bonding
*bond
= netdev_priv(slave
->dev
->master
);
378 if (!bond_is_lb(bond
))
379 bond_set_backup_slave(slave
);
380 if (!bond
->params
.all_slaves_active
)
384 static inline void bond_set_slave_active_flags(struct slave
*slave
)
386 bond_set_active_slave(slave
);
390 static inline bool bond_is_slave_inactive(struct slave
*slave
)
392 return slave
->inactive
;
395 struct vlan_entry
*bond_next_vlan(struct bonding
*bond
, struct vlan_entry
*curr
);
396 int bond_dev_queue_xmit(struct bonding
*bond
, struct sk_buff
*skb
, struct net_device
*slave_dev
);
397 int bond_create(struct net
*net
, const char *name
);
398 int bond_create_sysfs(void);
399 void bond_destroy_sysfs(void);
400 void bond_prepare_sysfs_group(struct bonding
*bond
);
401 int bond_create_slave_symlinks(struct net_device
*master
, struct net_device
*slave
);
402 void bond_destroy_slave_symlinks(struct net_device
*master
, struct net_device
*slave
);
403 int bond_enslave(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
404 int bond_release(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
405 void bond_mii_monitor(struct work_struct
*);
406 void bond_loadbalance_arp_mon(struct work_struct
*);
407 void bond_activebackup_arp_mon(struct work_struct
*);
408 void bond_set_mode_ops(struct bonding
*bond
, int mode
);
409 int bond_parse_parm(const char *mode_arg
, const struct bond_parm_tbl
*tbl
);
410 void bond_select_active_slave(struct bonding
*bond
);
411 void bond_change_active_slave(struct bonding
*bond
, struct slave
*new_active
);
412 void bond_register_arp(struct bonding
*);
413 void bond_unregister_arp(struct bonding
*);
414 void bond_create_debugfs(void);
415 void bond_destroy_debugfs(void);
416 void bond_debug_register(struct bonding
*bond
);
417 void bond_debug_unregister(struct bonding
*bond
);
418 void bond_debug_reregister(struct bonding
*bond
);
421 struct net
* net
; /* Associated network namespace */
422 struct list_head dev_list
;
423 #ifdef CONFIG_PROC_FS
424 struct proc_dir_entry
* proc_dir
;
428 #ifdef CONFIG_PROC_FS
429 void bond_create_proc_entry(struct bonding
*bond
);
430 void bond_remove_proc_entry(struct bonding
*bond
);
431 void bond_create_proc_dir(struct bond_net
*bn
);
432 void bond_destroy_proc_dir(struct bond_net
*bn
);
434 static inline void bond_create_proc_entry(struct bonding
*bond
)
438 static inline void bond_remove_proc_entry(struct bonding
*bond
)
442 static inline void bond_create_proc_dir(struct bond_net
*bn
)
446 static inline void bond_destroy_proc_dir(struct bond_net
*bn
)
452 /* exported from bond_main.c */
453 extern int bond_net_id
;
454 extern const struct bond_parm_tbl bond_lacp_tbl
[];
455 extern const struct bond_parm_tbl bond_mode_tbl
[];
456 extern const struct bond_parm_tbl xmit_hashtype_tbl
[];
457 extern const struct bond_parm_tbl arp_validate_tbl
[];
458 extern const struct bond_parm_tbl fail_over_mac_tbl
[];
459 extern const struct bond_parm_tbl pri_reselect_tbl
[];
460 extern struct bond_parm_tbl ad_select_tbl
[];
462 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
463 void bond_send_unsolicited_na(struct bonding
*bond
);
464 void bond_register_ipv6_notifier(void);
465 void bond_unregister_ipv6_notifier(void);
467 static inline void bond_send_unsolicited_na(struct bonding
*bond
)
471 static inline void bond_register_ipv6_notifier(void)
475 static inline void bond_unregister_ipv6_notifier(void)
481 #endif /* _LINUX_BONDING_H */