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.7.0"
27 #define DRV_RELDATE "June 2, 2010"
28 #define DRV_NAME "bonding"
29 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
31 #define BOND_MAX_ARP_TARGETS 16
34 ((((dev)->flags & IFF_UP) == IFF_UP) && \
35 netif_running(dev) && \
36 netif_carrier_ok(dev))
39 * Checks whether bond is ready for transmit.
41 * Caller must hold bond->lock
43 #define BOND_IS_OK(bond) \
44 (((bond)->dev->flags & IFF_UP) && \
45 netif_running((bond)->dev) && \
46 ((bond)->slave_cnt > 0))
49 * Checks whether slave is ready for transmit.
51 #define SLAVE_IS_OK(slave) \
52 (((slave)->dev->flags & IFF_UP) && \
53 netif_running((slave)->dev) && \
54 ((slave)->link == BOND_LINK_UP) && \
55 ((slave)->state == BOND_STATE_ACTIVE))
58 #define USES_PRIMARY(mode) \
59 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
60 ((mode) == BOND_MODE_TLB) || \
61 ((mode) == BOND_MODE_ALB))
63 #define TX_QUEUE_OVERRIDE(mode) \
64 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
65 ((mode) == BOND_MODE_ROUNDROBIN))
67 * Less bad way to call ioctl from within the kernel; this needs to be
68 * done some other way to get the call out of interrupt context.
69 * Needs "ioctl" variable to be supplied by calling context.
71 #define IOCTL(dev, arg, cmd) ({ \
73 mm_segment_t fs = get_fs(); \
75 res = ioctl(dev, arg, cmd); \
80 * bond_for_each_slave_from - iterate the slaves list from a starting point
81 * @bond: the bond holding this list.
82 * @pos: current slave.
83 * @cnt: counter for max number of moves
84 * @start: starting point.
86 * Caller must hold bond->lock
88 #define bond_for_each_slave_from(bond, pos, cnt, start) \
89 for (cnt = 0, pos = start; \
90 cnt < (bond)->slave_cnt; \
91 cnt++, pos = (pos)->next)
94 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
95 * @bond: the bond holding this list.
96 * @pos: current slave.
97 * @cnt: counter for number max of moves
98 * @start: start point.
101 * Caller must hold bond->lock
103 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
104 for (cnt = 0, pos = start; \
105 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
106 cnt++, pos = (pos)->next)
109 * bond_for_each_slave - iterate the slaves list from head
110 * @bond: the bond holding this list.
111 * @pos: current slave.
112 * @cnt: counter for max number of moves
114 * Caller must hold bond->lock
116 #define bond_for_each_slave(bond, pos, cnt) \
117 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
134 char primary[IFNAMSIZ];
135 int primary_reselect;
136 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
138 int all_slaves_active;
141 struct bond_parm_tbl {
146 #define BOND_MAX_MODENAME_LEN 20
149 struct list_head vlan_list;
151 unsigned short vlan_id;
152 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
153 struct in6_addr vlan_ipv6;
158 struct net_device *dev; /* first - useful for panic debug */
162 unsigned long jiffies;
163 unsigned long last_arp_rx;
164 s8 link; /* one of BOND_LINK_XXXX */
166 s8 state; /* one of BOND_STATE_XXXX */
168 u32 link_failure_count;
169 u8 perm_hwaddr[ETH_ALEN];
173 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
174 struct tlb_slave_info tlb_info;
178 * Link pseudo-state only used internally by monitors
180 #define BOND_LINK_NOCHANGE -1
183 * Here are the locking policies for the two bonding locks:
185 * 1) Get bond->lock when reading/writing slave list.
186 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
187 * (It is unnecessary when the write-lock is put with bond->lock.)
188 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
192 struct net_device *dev; /* first - useful for panic debug */
193 struct slave *first_slave;
194 struct slave *curr_active_slave;
195 struct slave *current_arp_slave;
196 struct slave *primary_slave;
198 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
200 rwlock_t curr_slave_lock;
205 #ifdef CONFIG_PROC_FS
206 struct proc_dir_entry *proc_entry;
207 char proc_file_name[IFNAMSIZ];
208 #endif /* CONFIG_PROC_FS */
209 struct list_head bond_list;
210 struct netdev_hw_addr_list mc_list;
211 int (*xmit_hash_policy)(struct sk_buff *, int);
215 struct ad_bond_info ad_info;
216 struct alb_bond_info alb_info;
217 struct bond_params params;
218 struct list_head vlan_list;
219 struct vlan_group *vlgrp;
220 struct packet_type arp_mon_pt;
221 struct workqueue_struct *wq;
222 struct delayed_work mii_work;
223 struct delayed_work arp_work;
224 struct delayed_work alb_work;
225 struct delayed_work ad_work;
226 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
227 struct in6_addr master_ipv6;
232 * Returns NULL if the net_device does not belong to any of the bond's slaves
234 * Caller must hold bond lock for read
236 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
238 struct slave *slave = NULL;
241 bond_for_each_slave(bond, slave, i) {
242 if (slave->dev == slave_dev) {
250 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
252 if (!slave || !slave->dev->master) {
256 return (struct bonding *)netdev_priv(slave->dev->master);
259 static inline bool bond_is_lb(const struct bonding *bond)
261 return (bond->params.mode == BOND_MODE_TLB ||
262 bond->params.mode == BOND_MODE_ALB);
265 #define BOND_PRI_RESELECT_ALWAYS 0
266 #define BOND_PRI_RESELECT_BETTER 1
267 #define BOND_PRI_RESELECT_FAILURE 2
269 #define BOND_FOM_NONE 0
270 #define BOND_FOM_ACTIVE 1
271 #define BOND_FOM_FOLLOW 2
273 #define BOND_ARP_VALIDATE_NONE 0
274 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
275 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
276 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
277 BOND_ARP_VALIDATE_BACKUP)
279 static inline int slave_do_arp_validate(struct bonding *bond,
282 return bond->params.arp_validate & (1 << slave->state);
285 static inline unsigned long slave_last_rx(struct bonding *bond,
288 if (slave_do_arp_validate(bond, slave))
289 return slave->last_arp_rx;
291 return slave->dev->last_rx;
294 static inline void bond_set_slave_inactive_flags(struct slave *slave)
296 struct bonding *bond = netdev_priv(slave->dev->master);
297 if (!bond_is_lb(bond))
298 slave->state = BOND_STATE_BACKUP;
299 if (!bond->params.all_slaves_active)
300 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
301 if (slave_do_arp_validate(bond, slave))
302 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
305 static inline void bond_set_slave_active_flags(struct slave *slave)
307 slave->state = BOND_STATE_ACTIVE;
308 slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
311 static inline void bond_set_master_3ad_flags(struct bonding *bond)
313 bond->dev->priv_flags |= IFF_MASTER_8023AD;
316 static inline void bond_unset_master_3ad_flags(struct bonding *bond)
318 bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
321 static inline void bond_set_master_alb_flags(struct bonding *bond)
323 bond->dev->priv_flags |= IFF_MASTER_ALB;
326 static inline void bond_unset_master_alb_flags(struct bonding *bond)
328 bond->dev->priv_flags &= ~IFF_MASTER_ALB;
331 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
332 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
333 int bond_create(struct net *net, const char *name);
334 int bond_release_and_destroy(struct net_device *bond_dev, struct net_device *slave_dev);
335 int bond_create_sysfs(void);
336 void bond_destroy_sysfs(void);
337 void bond_prepare_sysfs_group(struct bonding *bond);
338 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
339 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
340 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
341 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
342 void bond_mii_monitor(struct work_struct *);
343 void bond_loadbalance_arp_mon(struct work_struct *);
344 void bond_activebackup_arp_mon(struct work_struct *);
345 void bond_set_mode_ops(struct bonding *bond, int mode);
346 int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
347 void bond_select_active_slave(struct bonding *bond);
348 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
349 void bond_register_arp(struct bonding *);
350 void bond_unregister_arp(struct bonding *);
353 struct net * net; /* Associated network namespace */
354 struct list_head dev_list;
355 #ifdef CONFIG_PROC_FS
356 struct proc_dir_entry * proc_dir;
360 /* exported from bond_main.c */
361 extern int bond_net_id;
362 extern const struct bond_parm_tbl bond_lacp_tbl[];
363 extern const struct bond_parm_tbl bond_mode_tbl[];
364 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
365 extern const struct bond_parm_tbl arp_validate_tbl[];
366 extern const struct bond_parm_tbl fail_over_mac_tbl[];
367 extern const struct bond_parm_tbl pri_reselect_tbl[];
368 extern struct bond_parm_tbl ad_select_tbl[];
370 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
371 void bond_send_unsolicited_na(struct bonding *bond);
372 void bond_register_ipv6_notifier(void);
373 void bond_unregister_ipv6_notifier(void);
375 static inline void bond_send_unsolicited_na(struct bonding *bond)
379 static inline void bond_register_ipv6_notifier(void)
383 static inline void bond_unregister_ipv6_notifier(void)
389 #endif /* _LINUX_BONDING_H */