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/cpumask.h>
23 #include <linux/in6.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_MAX_ARP_TARGETS 16
35 ((((dev)->flags & IFF_UP) == IFF_UP) && \
36 netif_running(dev) && \
37 netif_carrier_ok(dev))
40 * Checks whether bond is ready for transmit.
42 * Caller must hold bond->lock
44 #define BOND_IS_OK(bond) \
45 (((bond)->dev->flags & IFF_UP) && \
46 netif_running((bond)->dev) && \
47 ((bond)->slave_cnt > 0))
50 * Checks whether slave is ready for transmit.
52 #define SLAVE_IS_OK(slave) \
53 (((slave)->dev->flags & IFF_UP) && \
54 netif_running((slave)->dev) && \
55 ((slave)->link == BOND_LINK_UP) && \
56 ((slave)->state == BOND_STATE_ACTIVE))
59 #define USES_PRIMARY(mode) \
60 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
61 ((mode) == BOND_MODE_TLB) || \
62 ((mode) == BOND_MODE_ALB))
64 #define TX_QUEUE_OVERRIDE(mode) \
65 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
66 ((mode) == BOND_MODE_ROUNDROBIN))
68 * Less bad way to call ioctl from within the kernel; this needs to be
69 * done some other way to get the call out of interrupt context.
70 * Needs "ioctl" variable to be supplied by calling context.
72 #define IOCTL(dev, arg, cmd) ({ \
74 mm_segment_t fs = get_fs(); \
76 res = ioctl(dev, arg, cmd); \
81 * bond_for_each_slave_from - iterate the slaves list from a starting point
82 * @bond: the bond holding this list.
83 * @pos: current slave.
84 * @cnt: counter for max number of moves
85 * @start: starting point.
87 * Caller must hold bond->lock
89 #define bond_for_each_slave_from(bond, pos, cnt, start) \
90 for (cnt = 0, pos = start; \
91 cnt < (bond)->slave_cnt; \
92 cnt++, pos = (pos)->next)
95 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
96 * @bond: the bond holding this list.
97 * @pos: current slave.
98 * @cnt: counter for number max of moves
99 * @start: start point.
102 * Caller must hold bond->lock
104 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
105 for (cnt = 0, pos = start; \
106 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
107 cnt++, pos = (pos)->next)
110 * bond_for_each_slave - iterate the slaves list from head
111 * @bond: the bond holding this list.
112 * @pos: current slave.
113 * @cnt: counter for max number of moves
115 * Caller must hold bond->lock
117 #define bond_for_each_slave(bond, pos, cnt) \
118 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
121 #ifdef CONFIG_NET_POLL_CONTROLLER
122 extern atomic_t netpoll_block_tx
;
124 static inline void block_netpoll_tx(void)
126 atomic_inc(&netpoll_block_tx
);
129 static inline void unblock_netpoll_tx(void)
131 atomic_dec(&netpoll_block_tx
);
134 static inline int is_netpoll_tx_blocked(struct net_device
*dev
)
136 if (unlikely(dev
->priv_flags
& IFF_IN_NETPOLL
))
137 return atomic_read(&netpoll_block_tx
);
141 #define block_netpoll_tx()
142 #define unblock_netpoll_tx()
143 #define is_netpoll_tx_blocked(dev) (0)
160 char primary
[IFNAMSIZ
];
161 int primary_reselect
;
162 __be32 arp_targets
[BOND_MAX_ARP_TARGETS
];
164 int all_slaves_active
;
168 struct bond_parm_tbl
{
173 #define BOND_MAX_MODENAME_LEN 20
176 struct list_head vlan_list
;
178 unsigned short vlan_id
;
179 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
180 struct in6_addr vlan_ipv6
;
185 struct net_device
*dev
; /* first - useful for panic debug */
189 unsigned long jiffies
;
190 unsigned long last_arp_rx
;
191 s8 link
; /* one of BOND_LINK_XXXX */
193 s8 state
; /* one of BOND_STATE_XXXX */
195 u32 link_failure_count
;
196 u8 perm_hwaddr
[ETH_ALEN
];
200 struct ad_slave_info ad_info
; /* HUGE - better to dynamically alloc */
201 struct tlb_slave_info tlb_info
;
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
*first_slave
;
221 struct slave
*curr_active_slave
;
222 struct slave
*current_arp_slave
;
223 struct slave
*primary_slave
;
225 s32 slave_cnt
; /* never change this value outside the attach/detach wrappers */
227 rwlock_t curr_slave_lock
;
233 #ifdef CONFIG_PROC_FS
234 struct proc_dir_entry
*proc_entry
;
235 char proc_file_name
[IFNAMSIZ
];
236 #endif /* CONFIG_PROC_FS */
237 struct list_head bond_list
;
238 struct netdev_hw_addr_list mc_list
;
239 int (*xmit_hash_policy
)(struct sk_buff
*, int);
243 struct ad_bond_info ad_info
;
244 struct alb_bond_info alb_info
;
245 struct bond_params params
;
246 struct list_head vlan_list
;
247 struct vlan_group
*vlgrp
;
248 struct packet_type arp_mon_pt
;
249 struct workqueue_struct
*wq
;
250 struct delayed_work mii_work
;
251 struct delayed_work arp_work
;
252 struct delayed_work alb_work
;
253 struct delayed_work ad_work
;
254 struct delayed_work mcast_work
;
255 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
256 struct in6_addr master_ipv6
;
261 * Returns NULL if the net_device does not belong to any of the bond's slaves
263 * Caller must hold bond lock for read
265 static inline struct slave
*bond_get_slave_by_dev(struct bonding
*bond
, struct net_device
*slave_dev
)
267 struct slave
*slave
= NULL
;
270 bond_for_each_slave(bond
, slave
, i
) {
271 if (slave
->dev
== slave_dev
) {
279 static inline struct bonding
*bond_get_bond_by_slave(struct slave
*slave
)
281 if (!slave
|| !slave
->dev
->master
) {
285 return (struct bonding
*)netdev_priv(slave
->dev
->master
);
288 static inline bool bond_is_lb(const struct bonding
*bond
)
290 return (bond
->params
.mode
== BOND_MODE_TLB
||
291 bond
->params
.mode
== BOND_MODE_ALB
);
294 #define BOND_PRI_RESELECT_ALWAYS 0
295 #define BOND_PRI_RESELECT_BETTER 1
296 #define BOND_PRI_RESELECT_FAILURE 2
298 #define BOND_FOM_NONE 0
299 #define BOND_FOM_ACTIVE 1
300 #define BOND_FOM_FOLLOW 2
302 #define BOND_ARP_VALIDATE_NONE 0
303 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
304 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
305 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
306 BOND_ARP_VALIDATE_BACKUP)
308 static inline int slave_do_arp_validate(struct bonding
*bond
,
311 return bond
->params
.arp_validate
& (1 << slave
->state
);
314 static inline unsigned long slave_last_rx(struct bonding
*bond
,
317 if (slave_do_arp_validate(bond
, slave
))
318 return slave
->last_arp_rx
;
320 return slave
->dev
->last_rx
;
323 static inline void bond_set_slave_inactive_flags(struct slave
*slave
)
325 struct bonding
*bond
= netdev_priv(slave
->dev
->master
);
326 if (!bond_is_lb(bond
))
327 slave
->state
= BOND_STATE_BACKUP
;
328 if (!bond
->params
.all_slaves_active
)
329 slave
->dev
->priv_flags
|= IFF_SLAVE_INACTIVE
;
330 if (slave_do_arp_validate(bond
, slave
))
331 slave
->dev
->priv_flags
|= IFF_SLAVE_NEEDARP
;
334 static inline void bond_set_slave_active_flags(struct slave
*slave
)
336 slave
->state
= BOND_STATE_ACTIVE
;
337 slave
->dev
->priv_flags
&= ~(IFF_SLAVE_INACTIVE
| IFF_SLAVE_NEEDARP
);
340 static inline void bond_set_master_3ad_flags(struct bonding
*bond
)
342 bond
->dev
->priv_flags
|= IFF_MASTER_8023AD
;
345 static inline void bond_unset_master_3ad_flags(struct bonding
*bond
)
347 bond
->dev
->priv_flags
&= ~IFF_MASTER_8023AD
;
350 static inline void bond_set_master_alb_flags(struct bonding
*bond
)
352 bond
->dev
->priv_flags
|= IFF_MASTER_ALB
;
355 static inline void bond_unset_master_alb_flags(struct bonding
*bond
)
357 bond
->dev
->priv_flags
&= ~IFF_MASTER_ALB
;
360 struct vlan_entry
*bond_next_vlan(struct bonding
*bond
, struct vlan_entry
*curr
);
361 int bond_dev_queue_xmit(struct bonding
*bond
, struct sk_buff
*skb
, struct net_device
*slave_dev
);
362 int bond_create(struct net
*net
, const char *name
);
363 int bond_create_sysfs(void);
364 void bond_destroy_sysfs(void);
365 void bond_prepare_sysfs_group(struct bonding
*bond
);
366 int bond_create_slave_symlinks(struct net_device
*master
, struct net_device
*slave
);
367 void bond_destroy_slave_symlinks(struct net_device
*master
, struct net_device
*slave
);
368 int bond_enslave(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
369 int bond_release(struct net_device
*bond_dev
, struct net_device
*slave_dev
);
370 void bond_mii_monitor(struct work_struct
*);
371 void bond_loadbalance_arp_mon(struct work_struct
*);
372 void bond_activebackup_arp_mon(struct work_struct
*);
373 void bond_set_mode_ops(struct bonding
*bond
, int mode
);
374 int bond_parse_parm(const char *mode_arg
, const struct bond_parm_tbl
*tbl
);
375 void bond_select_active_slave(struct bonding
*bond
);
376 void bond_change_active_slave(struct bonding
*bond
, struct slave
*new_active
);
377 void bond_register_arp(struct bonding
*);
378 void bond_unregister_arp(struct bonding
*);
381 struct net
* net
; /* Associated network namespace */
382 struct list_head dev_list
;
383 #ifdef CONFIG_PROC_FS
384 struct proc_dir_entry
* proc_dir
;
388 /* exported from bond_main.c */
389 extern int bond_net_id
;
390 extern const struct bond_parm_tbl bond_lacp_tbl
[];
391 extern const struct bond_parm_tbl bond_mode_tbl
[];
392 extern const struct bond_parm_tbl xmit_hashtype_tbl
[];
393 extern const struct bond_parm_tbl arp_validate_tbl
[];
394 extern const struct bond_parm_tbl fail_over_mac_tbl
[];
395 extern const struct bond_parm_tbl pri_reselect_tbl
[];
396 extern struct bond_parm_tbl ad_select_tbl
[];
398 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
399 void bond_send_unsolicited_na(struct bonding
*bond
);
400 void bond_register_ipv6_notifier(void);
401 void bond_unregister_ipv6_notifier(void);
403 static inline void bond_send_unsolicited_na(struct bonding
*bond
)
407 static inline void bond_register_ipv6_notifier(void)
411 static inline void bond_unregister_ipv6_notifier(void)
417 #endif /* _LINUX_BONDING_H */