net/bonding: Destroy bonding master when last slave is gone
[linux-2.6-block.git] / drivers / net / bonding / bonding.h
CommitLineData
1da177e4
LT
1/*
2 * Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
3 *
4 * Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
5 * NCM: Network and Communications Management, Inc.
6 *
7 * BUT, I'm the one who modified it for ethernet, so:
8 * (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
9 *
10 * This software may be used and distributed according to the terms
11 * of the GNU Public License, incorporated herein by reference.
12 *
1da177e4
LT
13 */
14
15#ifndef _LINUX_BONDING_H
16#define _LINUX_BONDING_H
17
18#include <linux/timer.h>
19#include <linux/proc_fs.h>
20#include <linux/if_bonding.h>
b76cdba9 21#include <linux/kobject.h>
1da177e4
LT
22#include "bond_3ad.h"
23#include "bond_alb.h"
24
031ae4de
JV
25#define DRV_VERSION "3.1.3"
26#define DRV_RELDATE "June 13, 2007"
1da177e4
LT
27#define DRV_NAME "bonding"
28#define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
29
30#define BOND_MAX_ARP_TARGETS 16
31
32#ifdef BONDING_DEBUG
33#define dprintk(fmt, args...) \
34 printk(KERN_DEBUG \
35 DRV_NAME ": %s() %d: " fmt, __FUNCTION__, __LINE__ , ## args )
36#else
37#define dprintk(fmt, args...)
38#endif /* BONDING_DEBUG */
39
40#define IS_UP(dev) \
41 ((((dev)->flags & IFF_UP) == IFF_UP) && \
42 netif_running(dev) && \
43 netif_carrier_ok(dev))
44
45/*
46 * Checks whether bond is ready for transmit.
47 *
48 * Caller must hold bond->lock
49 */
50#define BOND_IS_OK(bond) \
51 (((bond)->dev->flags & IFF_UP) && \
52 netif_running((bond)->dev) && \
53 ((bond)->slave_cnt > 0))
54
55/*
56 * Checks whether slave is ready for transmit.
57 */
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))
63
64
65#define USES_PRIMARY(mode) \
66 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
67 ((mode) == BOND_MODE_TLB) || \
68 ((mode) == BOND_MODE_ALB))
69
70/*
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.
74 */
75#define IOCTL(dev, arg, cmd) ({ \
76 int res = 0; \
77 mm_segment_t fs = get_fs(); \
78 set_fs(get_ds()); \
79 res = ioctl(dev, arg, cmd); \
80 set_fs(fs); \
81 res; })
82
83/**
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.
89 *
90 * Caller must hold bond->lock
91 */
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)
96
97/**
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.
103 * @stop: stop point.
104 *
105 * Caller must hold bond->lock
106 */
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)
111
112/**
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
117 *
118 * Caller must hold bond->lock
119 */
120#define bond_for_each_slave(bond, pos, cnt) \
121 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
122
123
124struct bond_params {
125 int mode;
169a3e66 126 int xmit_policy;
1da177e4
LT
127 int miimon;
128 int arp_interval;
f5b2b966 129 int arp_validate;
1da177e4
LT
130 int use_carrier;
131 int updelay;
132 int downdelay;
133 int lacp_fast;
134 char primary[IFNAMSIZ];
d3bb52b0 135 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
1da177e4
LT
136};
137
12479f9a
MW
138struct bond_parm_tbl {
139 char *modename;
140 int mode;
141};
142
1da177e4
LT
143struct vlan_entry {
144 struct list_head vlan_list;
d3bb52b0 145 __be32 vlan_ip;
1da177e4
LT
146 unsigned short vlan_id;
147};
148
149struct slave {
e944ef79 150 struct net_device *dev; /* first - useful for panic debug */
1da177e4
LT
151 struct slave *next;
152 struct slave *prev;
8bb5f96b 153 int delay;
f8a8ccd5
AG
154 unsigned long jiffies;
155 unsigned long last_arp_rx;
1da177e4
LT
156 s8 link; /* one of BOND_LINK_XXXX */
157 s8 state; /* one of BOND_STATE_XXXX */
158 u32 original_flags;
3158bf7d 159 u32 original_mtu;
1da177e4
LT
160 u32 link_failure_count;
161 u16 speed;
162 u8 duplex;
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;
166};
167
168/*
169 * Here are the locking policies for the two bonding locks:
170 *
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
175 * beforehand.
176 */
177struct bonding {
e944ef79 178 struct net_device *dev; /* first - useful for panic debug */
1da177e4
LT
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 */
184 rwlock_t lock;
185 rwlock_t curr_slave_lock;
186 struct timer_list mii_timer;
187 struct timer_list arp_timer;
188 s8 kill_timers;
2ab82852 189 s8 do_set_mac_addr;
1053f62c 190 s8 send_grat_arp;
d90a162a 191 s8 setup_by_slave;
1da177e4
LT
192 struct net_device_stats stats;
193#ifdef CONFIG_PROC_FS
194 struct proc_dir_entry *proc_entry;
195 char proc_file_name[IFNAMSIZ];
196#endif /* CONFIG_PROC_FS */
197 struct list_head bond_list;
198 struct dev_mc_list *mc_list;
169a3e66 199 int (*xmit_hash_policy)(struct sk_buff *, struct net_device *, int);
d3bb52b0 200 __be32 master_ip;
1da177e4
LT
201 u16 flags;
202 struct ad_bond_info ad_info;
203 struct alb_bond_info alb_info;
204 struct bond_params params;
205 struct list_head vlan_list;
206 struct vlan_group *vlgrp;
f5b2b966 207 struct packet_type arp_mon_pt;
1da177e4
LT
208};
209
210/**
211 * Returns NULL if the net_device does not belong to any of the bond's slaves
212 *
213 * Caller must hold bond lock for read
214 */
cceb904f 215static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
1da177e4
LT
216{
217 struct slave *slave = NULL;
218 int i;
219
220 bond_for_each_slave(bond, slave, i) {
221 if (slave->dev == slave_dev) {
222 break;
223 }
224 }
225
226 return slave;
227}
228
cceb904f 229static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
1da177e4
LT
230{
231 if (!slave || !slave->dev->master) {
232 return NULL;
233 }
234
235 return (struct bonding *)slave->dev->master->priv;
236}
237
f5b2b966
JV
238#define BOND_ARP_VALIDATE_NONE 0
239#define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
240#define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
241#define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
242 BOND_ARP_VALIDATE_BACKUP)
243
079ca7da
AB
244static inline int slave_do_arp_validate(struct bonding *bond,
245 struct slave *slave)
f5b2b966
JV
246{
247 return bond->params.arp_validate & (1 << slave->state);
248}
249
079ca7da 250static inline unsigned long slave_last_rx(struct bonding *bond,
f8a8ccd5 251 struct slave *slave)
f5b2b966
JV
252{
253 if (slave_do_arp_validate(bond, slave))
254 return slave->last_arp_rx;
255
256 return slave->dev->last_rx;
257}
258
cceb904f 259static inline void bond_set_slave_inactive_flags(struct slave *slave)
1da177e4 260{
8f903c70
JV
261 struct bonding *bond = slave->dev->master->priv;
262 if (bond->params.mode != BOND_MODE_TLB &&
263 bond->params.mode != BOND_MODE_ALB)
264 slave->state = BOND_STATE_BACKUP;
265 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
f5b2b966
JV
266 if (slave_do_arp_validate(bond, slave))
267 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
1da177e4
LT
268}
269
cceb904f 270static inline void bond_set_slave_active_flags(struct slave *slave)
1da177e4
LT
271{
272 slave->state = BOND_STATE_ACTIVE;
f5b2b966 273 slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
8f903c70
JV
274}
275
276static inline void bond_set_master_3ad_flags(struct bonding *bond)
277{
278 bond->dev->priv_flags |= IFF_MASTER_8023AD;
279}
280
281static inline void bond_unset_master_3ad_flags(struct bonding *bond)
282{
283 bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
284}
285
286static inline void bond_set_master_alb_flags(struct bonding *bond)
287{
288 bond->dev->priv_flags |= IFF_MASTER_ALB;
289}
290
291static inline void bond_unset_master_alb_flags(struct bonding *bond)
292{
293 bond->dev->priv_flags &= ~IFF_MASTER_ALB;
1da177e4
LT
294}
295
296struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
297int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
dfe60397 298int bond_create(char *name, struct bond_params *params, struct bonding **newbond);
d90a162a
MS
299void bond_destroy(struct bonding *bond);
300int bond_release_and_destroy(struct net_device *bond_dev, struct net_device *slave_dev);
a77b5325 301void bond_deinit(struct net_device *bond_dev);
b76cdba9
MW
302int bond_create_sysfs(void);
303void bond_destroy_sysfs(void);
304void bond_destroy_sysfs_entry(struct bonding *bond);
305int bond_create_sysfs_entry(struct bonding *bond);
306int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
307void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
a77b5325
MW
308int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
309int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
a77b5325
MW
310void bond_mii_monitor(struct net_device *bond_dev);
311void bond_loadbalance_arp_mon(struct net_device *bond_dev);
312void bond_activebackup_arp_mon(struct net_device *bond_dev);
313void bond_set_mode_ops(struct bonding *bond, int mode);
314int bond_parse_parm(char *mode_arg, struct bond_parm_tbl *tbl);
a77b5325
MW
315void bond_select_active_slave(struct bonding *bond);
316void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
f5b2b966
JV
317void bond_register_arp(struct bonding *);
318void bond_unregister_arp(struct bonding *);
1da177e4
LT
319
320#endif /* _LINUX_BONDING_H */
321