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>
25 #define DRV_VERSION "3.1.3"
26 #define DRV_RELDATE "June 13, 2007"
27 #define DRV_NAME "bonding"
28 #define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
30 #define BOND_MAX_ARP_TARGETS 16
33 #define dprintk(fmt, args...) \
35 DRV_NAME ": %s() %d: " fmt, __FUNCTION__, __LINE__ , ## args )
37 #define dprintk(fmt, args...)
38 #endif /* BONDING_DEBUG */
41 ((((dev)->flags & IFF_UP) == IFF_UP) && \
42 netif_running(dev) && \
43 netif_carrier_ok(dev))
46 * Checks whether bond is ready for transmit.
48 * Caller must hold bond->lock
50 #define BOND_IS_OK(bond) \
51 (((bond)->dev->flags & IFF_UP) && \
52 netif_running((bond)->dev) && \
53 ((bond)->slave_cnt > 0))
56 * Checks whether slave is ready for transmit.
58 #define SLAVE_IS_OK(slave) \
59 (((slave)->dev->flags & IFF_UP) && \
60 netif_running((slave)->dev) && \
61 ((slave)->link == BOND_LINK_UP) && \
62 ((slave)->state == BOND_STATE_ACTIVE))
65 #define USES_PRIMARY(mode) \
66 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
67 ((mode) == BOND_MODE_TLB) || \
68 ((mode) == BOND_MODE_ALB))
71 * Less bad way to call ioctl from within the kernel; this needs to be
72 * done some other way to get the call out of interrupt context.
73 * Needs "ioctl" variable to be supplied by calling context.
75 #define IOCTL(dev, arg, cmd) ({ \
77 mm_segment_t fs = get_fs(); \
79 res = ioctl(dev, arg, cmd); \
84 * bond_for_each_slave_from - iterate the slaves list from a starting point
85 * @bond: the bond holding this list.
86 * @pos: current slave.
87 * @cnt: counter for max number of moves
88 * @start: starting point.
90 * Caller must hold bond->lock
92 #define bond_for_each_slave_from(bond, pos, cnt, start) \
93 for (cnt = 0, pos = start; \
94 cnt < (bond)->slave_cnt; \
95 cnt++, pos = (pos)->next)
98 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
99 * @bond: the bond holding this list.
100 * @pos: current slave.
101 * @cnt: counter for number max of moves
102 * @start: start point.
105 * Caller must hold bond->lock
107 #define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
108 for (cnt = 0, pos = start; \
109 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
110 cnt++, pos = (pos)->next)
113 * bond_for_each_slave - iterate the slaves list from head
114 * @bond: the bond holding this list.
115 * @pos: current slave.
116 * @cnt: counter for max number of moves
118 * Caller must hold bond->lock
120 #define bond_for_each_slave(bond, pos, cnt) \
121 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
134 char primary[IFNAMSIZ];
135 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
138 struct bond_parm_tbl {
144 struct list_head vlan_list;
146 unsigned short vlan_id;
150 struct net_device *dev; /* first - useful for panic debug */
154 unsigned long jiffies;
155 unsigned long last_arp_rx;
156 s8 link; /* one of BOND_LINK_XXXX */
157 s8 state; /* one of BOND_STATE_XXXX */
160 u32 link_failure_count;
163 u8 perm_hwaddr[ETH_ALEN];
164 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
165 struct tlb_slave_info tlb_info;
169 * Here are the locking policies for the two bonding locks:
171 * 1) Get bond->lock when reading/writing slave list.
172 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
173 * (It is unnecessary when the write-lock is put with bond->lock.)
174 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
178 struct net_device *dev; /* first - useful for panic debug */
179 struct slave *first_slave;
180 struct slave *curr_active_slave;
181 struct slave *current_arp_slave;
182 struct slave *primary_slave;
183 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
185 rwlock_t curr_slave_lock;
186 struct timer_list mii_timer;
187 struct timer_list arp_timer;
190 struct net_device_stats stats;
191 #ifdef CONFIG_PROC_FS
192 struct proc_dir_entry *proc_entry;
193 char proc_file_name[IFNAMSIZ];
194 #endif /* CONFIG_PROC_FS */
195 struct list_head bond_list;
196 struct dev_mc_list *mc_list;
197 int (*xmit_hash_policy)(struct sk_buff *, struct net_device *, int);
200 struct ad_bond_info ad_info;
201 struct alb_bond_info alb_info;
202 struct bond_params params;
203 struct list_head vlan_list;
204 struct vlan_group *vlgrp;
205 struct packet_type arp_mon_pt;
209 * Returns NULL if the net_device does not belong to any of the bond's slaves
211 * Caller must hold bond lock for read
213 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
215 struct slave *slave = NULL;
218 bond_for_each_slave(bond, slave, i) {
219 if (slave->dev == slave_dev) {
227 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
229 if (!slave || !slave->dev->master) {
233 return (struct bonding *)slave->dev->master->priv;
236 #define BOND_ARP_VALIDATE_NONE 0
237 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
238 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
239 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
240 BOND_ARP_VALIDATE_BACKUP)
242 static inline int slave_do_arp_validate(struct bonding *bond,
245 return bond->params.arp_validate & (1 << slave->state);
248 static inline unsigned long slave_last_rx(struct bonding *bond,
251 if (slave_do_arp_validate(bond, slave))
252 return slave->last_arp_rx;
254 return slave->dev->last_rx;
257 static inline void bond_set_slave_inactive_flags(struct slave *slave)
259 struct bonding *bond = slave->dev->master->priv;
260 if (bond->params.mode != BOND_MODE_TLB &&
261 bond->params.mode != BOND_MODE_ALB)
262 slave->state = BOND_STATE_BACKUP;
263 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
264 if (slave_do_arp_validate(bond, slave))
265 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
268 static inline void bond_set_slave_active_flags(struct slave *slave)
270 slave->state = BOND_STATE_ACTIVE;
271 slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
274 static inline void bond_set_master_3ad_flags(struct bonding *bond)
276 bond->dev->priv_flags |= IFF_MASTER_8023AD;
279 static inline void bond_unset_master_3ad_flags(struct bonding *bond)
281 bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
284 static inline void bond_set_master_alb_flags(struct bonding *bond)
286 bond->dev->priv_flags |= IFF_MASTER_ALB;
289 static inline void bond_unset_master_alb_flags(struct bonding *bond)
291 bond->dev->priv_flags &= ~IFF_MASTER_ALB;
294 struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
295 int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
296 int bond_create(char *name, struct bond_params *params, struct bonding **newbond);
297 void bond_deinit(struct net_device *bond_dev);
298 int bond_create_sysfs(void);
299 void bond_destroy_sysfs(void);
300 void bond_destroy_sysfs_entry(struct bonding *bond);
301 int bond_create_sysfs_entry(struct bonding *bond);
302 int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
303 void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
304 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
305 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
306 void bond_mii_monitor(struct net_device *bond_dev);
307 void bond_loadbalance_arp_mon(struct net_device *bond_dev);
308 void bond_activebackup_arp_mon(struct net_device *bond_dev);
309 void bond_set_mode_ops(struct bonding *bond, int mode);
310 int bond_parse_parm(char *mode_arg, struct bond_parm_tbl *tbl);
311 void bond_select_active_slave(struct bonding *bond);
312 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
313 void bond_register_arp(struct bonding *);
314 void bond_unregister_arp(struct bonding *);
316 #endif /* _LINUX_BONDING_H */