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/kobject.h>
22 #include <linux/in6.h>
26 #define DRV_VERSION "3.5.0"
27 #define DRV_RELDATE "November 4, 2008"
28 #define DRV_NAME "bonding"
29 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
31 #define BOND_MAX_ARP_TARGETS 16
33 extern struct list_head bond_dev_list
;
36 #define dprintk(fmt, args...) \
38 DRV_NAME ": %s() %d: " fmt, __func__, __LINE__ , ## args )
40 #define dprintk(fmt, args...)
41 #endif /* BONDING_DEBUG */
44 ((((dev)->flags & IFF_UP) == IFF_UP) && \
45 netif_running(dev) && \
46 netif_carrier_ok(dev))
49 * Checks whether bond is ready for transmit.
51 * Caller must hold bond->lock
53 #define BOND_IS_OK(bond) \
54 (((bond)->dev->flags & IFF_UP) && \
55 netif_running((bond)->dev) && \
56 ((bond)->slave_cnt > 0))
59 * Checks whether slave is ready for transmit.
61 #define SLAVE_IS_OK(slave) \
62 (((slave)->dev->flags & IFF_UP) && \
63 netif_running((slave)->dev) && \
64 ((slave)->link == BOND_LINK_UP) && \
65 ((slave)->state == BOND_STATE_ACTIVE))
68 #define USES_PRIMARY(mode) \
69 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
70 ((mode) == BOND_MODE_TLB) || \
71 ((mode) == BOND_MODE_ALB))
74 * Less bad way to call ioctl from within the kernel; this needs to be
75 * done some other way to get the call out of interrupt context.
76 * Needs "ioctl" variable to be supplied by calling context.
78 #define IOCTL(dev, arg, cmd) ({ \
80 mm_segment_t fs = get_fs(); \
82 res = ioctl(dev, arg, cmd); \
87 * bond_for_each_slave_from - iterate the slaves list from a starting point
88 * @bond: the bond holding this list.
89 * @pos: current slave.
90 * @cnt: counter for max number of moves
91 * @start: starting point.
93 * Caller must hold bond->lock
95 #define bond_for_each_slave_from(bond, pos, cnt, start) \
96 for (cnt = 0, pos = start; \
97 cnt < (bond)->slave_cnt; \
98 cnt++, pos = (pos)->next)
101 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
102 * @bond: the bond holding this list.
103 * @pos: current slave.
104 * @cnt: counter for number max of moves
105 * @start: start point.
108 * Caller must hold bond->lock
110 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
111 for (cnt = 0, pos = start; \
112 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
113 cnt++, pos = (pos)->next)
116 * bond_for_each_slave - iterate the slaves list from head
117 * @bond: the bond holding this list.
118 * @pos: current slave.
119 * @cnt: counter for max number of moves
121 * Caller must hold bond->lock
123 #define bond_for_each_slave(bond, pos, cnt) \
124 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
141 char primary
[IFNAMSIZ
];
142 __be32 arp_targets
[BOND_MAX_ARP_TARGETS
];
145 struct bond_parm_tbl
{
150 #define BOND_MAX_MODENAME_LEN 20
153 struct list_head vlan_list
;
155 unsigned short vlan_id
;
156 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
157 struct in6_addr vlan_ipv6
;
162 struct net_device
*dev
; /* first - useful for panic debug */
166 unsigned long jiffies
;
167 unsigned long last_arp_rx
;
168 s8 link
; /* one of BOND_LINK_XXXX */
170 s8 state
; /* one of BOND_STATE_XXXX */
173 u32 link_failure_count
;
176 u8 perm_hwaddr
[ETH_ALEN
];
177 struct ad_slave_info ad_info
; /* HUGE - better to dynamically alloc */
178 struct tlb_slave_info tlb_info
;
182 * Link pseudo-state only used internally by monitors
184 #define BOND_LINK_NOCHANGE -1
187 * Here are the locking policies for the two bonding locks:
189 * 1) Get bond->lock when reading/writing slave list.
190 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
191 * (It is unnecessary when the write-lock is put with bond->lock.)
192 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
196 struct net_device
*dev
; /* first - useful for panic debug */
197 struct slave
*first_slave
;
198 struct slave
*curr_active_slave
;
199 struct slave
*current_arp_slave
;
200 struct slave
*primary_slave
;
201 s32 slave_cnt
; /* never change this value outside the attach/detach wrappers */
203 rwlock_t curr_slave_lock
;
208 struct net_device_stats stats
;
209 #ifdef CONFIG_PROC_FS
210 struct proc_dir_entry
*proc_entry
;
211 char proc_file_name
[IFNAMSIZ
];
212 #endif /* CONFIG_PROC_FS */
213 struct list_head bond_list
;
214 struct dev_mc_list
*mc_list
;
215 int (*xmit_hash_policy
)(struct sk_buff
*, struct net_device
*, int);
219 struct ad_bond_info ad_info
;
220 struct alb_bond_info alb_info
;
221 struct bond_params params
;
222 struct list_head vlan_list
;
223 struct vlan_group
*vlgrp
;
224 struct packet_type arp_mon_pt
;
225 struct workqueue_struct
*wq
;
226 struct delayed_work mii_work
;
227 struct delayed_work arp_work
;
228 struct delayed_work alb_work
;
229 struct delayed_work ad_work
;
230 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
231 struct in6_addr master_ipv6
;
236 * Returns NULL if the net_device does not belong to any of the bond's slaves
238 * Caller must hold bond lock for read
240 static inline struct slave
*bond_get_slave_by_dev(struct bonding
*bond
, struct net_device
*slave_dev
)
242 struct slave
*slave
= NULL
;
245 bond_for_each_slave(bond
, slave
, i
) {
246 if (slave
->dev
== slave_dev
) {
254 static inline struct bonding
*bond_get_bond_by_slave(struct slave
*slave
)
256 if (!slave
|| !slave
->dev
->master
) {
260 return (struct bonding
*)netdev_priv(slave
->dev
->master
);
263 #define BOND_FOM_NONE 0
264 #define BOND_FOM_ACTIVE 1
265 #define BOND_FOM_FOLLOW 2
267 #define BOND_ARP_VALIDATE_NONE 0
268 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
269 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
270 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
271 BOND_ARP_VALIDATE_BACKUP)
273 static inline int slave_do_arp_validate(struct bonding
*bond
,
276 return bond
->params
.arp_validate
& (1 << slave
->state
);
279 static inline unsigned long slave_last_rx(struct bonding
*bond
,
282 if (slave_do_arp_validate(bond
, slave
))
283 return slave
->last_arp_rx
;
285 return slave
->dev
->last_rx
;
288 static inline void bond_set_slave_inactive_flags(struct slave
*slave
)
290 struct bonding
*bond
= netdev_priv(slave
->dev
->master
);
291 if (bond
->params
.mode
!= BOND_MODE_TLB
&&
292 bond
->params
.mode
!= BOND_MODE_ALB
)
293 slave
->state
= BOND_STATE_BACKUP
;
294 slave
->dev
->priv_flags
|= IFF_SLAVE_INACTIVE
;
295 if (slave_do_arp_validate(bond
, slave
))
296 slave
->dev
->priv_flags
|= IFF_SLAVE_NEEDARP
;
299 static inline void bond_set_slave_active_flags(struct slave
*slave
)
301 slave
->state
= BOND_STATE_ACTIVE
;
302 slave
->dev
->priv_flags
&= ~(IFF_SLAVE_INACTIVE
| IFF_SLAVE_NEEDARP
);
305 static inline void bond_set_master_3ad_flags(struct bonding
*bond
)
307 bond
->dev
->priv_flags
|= IFF_MASTER_8023AD
;
310 static inline void bond_unset_master_3ad_flags(struct bonding
*bond
)
312 bond
->dev
->priv_flags
&= ~IFF_MASTER_8023AD
;
315 static inline void bond_set_master_alb_flags(struct bonding
*bond
)
317 bond
->dev
->priv_flags
|= IFF_MASTER_ALB
;
320 static inline void bond_unset_master_alb_flags(struct bonding
*bond
)
322 bond
->dev
->priv_flags
&= ~IFF_MASTER_ALB
;
325 struct vlan_entry
*bond_next_vlan(struct bonding
*bond
, struct vlan_entry
*curr
);
326 int bond_dev_queue_xmit(struct bonding
*bond
, struct sk_buff
*skb
, struct net_device
*slave_dev
);
327 int bond_create(char *name
, struct bond_params
*params
);
328 void bond_destroy(struct bonding
*bond
);
329 int bond_release_and_destroy(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
330 int bond_create_sysfs(void);
331 void bond_destroy_sysfs(void);
332 void bond_destroy_sysfs_entry(struct bonding
*bond
);
333 int bond_create_sysfs_entry(struct bonding
*bond
);
334 int bond_create_slave_symlinks(struct net_device
*master
, struct net_device
*slave
);
335 void bond_destroy_slave_symlinks(struct net_device
*master
, struct net_device
*slave
);
336 int bond_enslave(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
337 int bond_release(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
338 void bond_mii_monitor(struct work_struct
*);
339 void bond_loadbalance_arp_mon(struct work_struct
*);
340 void bond_activebackup_arp_mon(struct work_struct
*);
341 void bond_set_mode_ops(struct bonding
*bond
, int mode
);
342 int bond_parse_parm(const char *mode_arg
, struct bond_parm_tbl
*tbl
);
343 void bond_select_active_slave(struct bonding
*bond
);
344 void bond_change_active_slave(struct bonding
*bond
, struct slave
*new_active
);
345 void bond_register_arp(struct bonding
*);
346 void bond_unregister_arp(struct bonding
*);
348 /* exported from bond_main.c */
349 extern struct list_head bond_dev_list
;
350 extern struct bond_parm_tbl bond_lacp_tbl
[];
351 extern struct bond_parm_tbl bond_mode_tbl
[];
352 extern struct bond_parm_tbl xmit_hashtype_tbl
[];
353 extern struct bond_parm_tbl arp_validate_tbl
[];
354 extern struct bond_parm_tbl fail_over_mac_tbl
[];
356 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
357 void bond_send_unsolicited_na(struct bonding
*bond
);
358 void bond_register_ipv6_notifier(void);
359 void bond_unregister_ipv6_notifier(void);
361 static inline void bond_send_unsolicited_na(struct bonding
*bond
)
365 static inline void bond_register_ipv6_notifier(void)
369 static inline void bond_unregister_ipv6_notifier(void)
375 #endif /* _LINUX_BONDING_H */