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 cpumask_var_t netpoll_block_tx;
124 static inline void block_netpoll_tx(void)
127 BUG_ON(cpumask_test_and_set_cpu(smp_processor_id(),
131 static inline void unblock_netpoll_tx(void)
133 BUG_ON(!cpumask_test_and_clear_cpu(smp_processor_id(),
138 static inline int is_netpoll_tx_blocked(struct net_device *dev)
140 if (unlikely(dev->priv_flags & IFF_IN_NETPOLL))
141 return cpumask_test_cpu(smp_processor_id(), netpoll_block_tx);
145 #define block_netpoll_tx()
146 #define unblock_netpoll_tx()
147 #define is_netpoll_tx_blocked(dev) (0)
164 char primary[IFNAMSIZ];
165 int primary_reselect;
166 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
168 int all_slaves_active;
172 struct bond_parm_tbl {
177 #define BOND_MAX_MODENAME_LEN 20
180 struct list_head vlan_list;
182 unsigned short vlan_id;
183 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
184 struct in6_addr vlan_ipv6;
189 struct net_device *dev; /* first - useful for panic debug */
193 unsigned long jiffies;
194 unsigned long last_arp_rx;
195 s8 link; /* one of BOND_LINK_XXXX */
197 s8 state; /* one of BOND_STATE_XXXX */
199 u32 link_failure_count;
200 u8 perm_hwaddr[ETH_ALEN];
204 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
205 struct tlb_slave_info tlb_info;
209 * Link pseudo-state only used internally by monitors
211 #define BOND_LINK_NOCHANGE -1
214 * Here are the locking policies for the two bonding locks:
216 * 1) Get bond->lock when reading/writing slave list.
217 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
218 * (It is unnecessary when the write-lock is put with bond->lock.)
219 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
223 struct net_device *dev; /* first - useful for panic debug */
224 struct slave *first_slave;
225 struct slave *curr_active_slave;
226 struct slave *current_arp_slave;
227 struct slave *primary_slave;
229 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
231 rwlock_t curr_slave_lock;
237 #ifdef CONFIG_PROC_FS
238 struct proc_dir_entry *proc_entry;
239 char proc_file_name[IFNAMSIZ];
240 #endif /* CONFIG_PROC_FS */
241 struct list_head bond_list;
242 struct netdev_hw_addr_list mc_list;
243 int (*xmit_hash_policy)(struct sk_buff *, int);
247 struct ad_bond_info ad_info;
248 struct alb_bond_info alb_info;
249 struct bond_params params;
250 struct list_head vlan_list;
251 struct vlan_group *vlgrp;
252 struct packet_type arp_mon_pt;
253 struct workqueue_struct *wq;
254 struct delayed_work mii_work;
255 struct delayed_work arp_work;
256 struct delayed_work alb_work;
257 struct delayed_work ad_work;
258 struct delayed_work mcast_work;
259 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
260 struct in6_addr master_ipv6;
265 * Returns NULL if the net_device does not belong to any of the bond's slaves
267 * Caller must hold bond lock for read
269 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
271 struct slave *slave = NULL;
274 bond_for_each_slave(bond, slave, i) {
275 if (slave->dev == slave_dev) {
283 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
285 if (!slave || !slave->dev->master) {
289 return (struct bonding *)netdev_priv(slave->dev->master);
292 static inline bool bond_is_lb(const struct bonding *bond)
294 return (bond->params.mode == BOND_MODE_TLB ||
295 bond->params.mode == BOND_MODE_ALB);
298 #define BOND_PRI_RESELECT_ALWAYS 0
299 #define BOND_PRI_RESELECT_BETTER 1
300 #define BOND_PRI_RESELECT_FAILURE 2
302 #define BOND_FOM_NONE 0
303 #define BOND_FOM_ACTIVE 1
304 #define BOND_FOM_FOLLOW 2
306 #define BOND_ARP_VALIDATE_NONE 0
307 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
308 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
309 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
310 BOND_ARP_VALIDATE_BACKUP)
312 static inline int slave_do_arp_validate(struct bonding *bond,
315 return bond->params.arp_validate & (1 << slave->state);
318 static inline unsigned long slave_last_rx(struct bonding *bond,
321 if (slave_do_arp_validate(bond, slave))
322 return slave->last_arp_rx;
324 return slave->dev->last_rx;
327 static inline void bond_set_slave_inactive_flags(struct slave *slave)
329 struct bonding *bond = netdev_priv(slave->dev->master);
330 if (!bond_is_lb(bond))
331 slave->state = BOND_STATE_BACKUP;
332 if (!bond->params.all_slaves_active)
333 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
334 if (slave_do_arp_validate(bond, slave))
335 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
338 static inline void bond_set_slave_active_flags(struct slave *slave)
340 slave->state = BOND_STATE_ACTIVE;
341 slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
344 static inline void bond_set_master_3ad_flags(struct bonding *bond)
346 bond->dev->priv_flags |= IFF_MASTER_8023AD;
349 static inline void bond_unset_master_3ad_flags(struct bonding *bond)
351 bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
354 static inline void bond_set_master_alb_flags(struct bonding *bond)
356 bond->dev->priv_flags |= IFF_MASTER_ALB;
359 static inline void bond_unset_master_alb_flags(struct bonding *bond)
361 bond->dev->priv_flags &= ~IFF_MASTER_ALB;
364 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
365 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
366 int bond_create(struct net *net, const char *name);
367 int bond_create_sysfs(void);
368 void bond_destroy_sysfs(void);
369 void bond_prepare_sysfs_group(struct bonding *bond);
370 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
371 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
372 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
373 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
374 void bond_mii_monitor(struct work_struct *);
375 void bond_loadbalance_arp_mon(struct work_struct *);
376 void bond_activebackup_arp_mon(struct work_struct *);
377 void bond_set_mode_ops(struct bonding *bond, int mode);
378 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
379 void bond_select_active_slave(struct bonding *bond);
380 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
381 void bond_register_arp(struct bonding *);
382 void bond_unregister_arp(struct bonding *);
385 struct net * net; /* Associated network namespace */
386 struct list_head dev_list;
387 #ifdef CONFIG_PROC_FS
388 struct proc_dir_entry * proc_dir;
392 /* exported from bond_main.c */
393 extern int bond_net_id;
394 extern const struct bond_parm_tbl bond_lacp_tbl[];
395 extern const struct bond_parm_tbl bond_mode_tbl[];
396 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
397 extern const struct bond_parm_tbl arp_validate_tbl[];
398 extern const struct bond_parm_tbl fail_over_mac_tbl[];
399 extern const struct bond_parm_tbl pri_reselect_tbl[];
400 extern struct bond_parm_tbl ad_select_tbl[];
402 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
403 void bond_send_unsolicited_na(struct bonding *bond);
404 void bond_register_ipv6_notifier(void);
405 void bond_unregister_ipv6_notifier(void);
407 static inline void bond_send_unsolicited_na(struct bonding *bond)
411 static inline void bond_register_ipv6_notifier(void)
415 static inline void bond_unregister_ipv6_notifier(void)
421 #endif /* _LINUX_BONDING_H */