net-bonding: Fix minor/cosmetic type inconsistencies
[deliverable/linux.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>
e843fa50 21#include <linux/cpumask.h>
305d552a 22#include <linux/in6.h>
8a8efa22 23#include <linux/netpoll.h>
1da177e4
LT
24#include "bond_3ad.h"
25#include "bond_alb.h"
26
bb1d9123
AG
27#define DRV_VERSION "3.7.0"
28#define DRV_RELDATE "June 2, 2010"
1da177e4
LT
29#define DRV_NAME "bonding"
30#define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
31
bd33acc3
AW
32#define bond_version DRV_DESCRIPTION ": v" DRV_VERSION " (" DRV_RELDATE ")\n"
33
1da177e4
LT
34#define BOND_MAX_ARP_TARGETS 16
35
1da177e4
LT
36#define IS_UP(dev) \
37 ((((dev)->flags & IFF_UP) == IFF_UP) && \
38 netif_running(dev) && \
39 netif_carrier_ok(dev))
40
41/*
42 * Checks whether bond is ready for transmit.
43 *
44 * Caller must hold bond->lock
45 */
46#define BOND_IS_OK(bond) \
47 (((bond)->dev->flags & IFF_UP) && \
48 netif_running((bond)->dev) && \
49 ((bond)->slave_cnt > 0))
50
51/*
52 * Checks whether slave is ready for transmit.
53 */
54#define SLAVE_IS_OK(slave) \
55 (((slave)->dev->flags & IFF_UP) && \
56 netif_running((slave)->dev) && \
57 ((slave)->link == BOND_LINK_UP) && \
e30bc066 58 bond_is_active_slave(slave))
1da177e4
LT
59
60
61#define USES_PRIMARY(mode) \
62 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
63 ((mode) == BOND_MODE_TLB) || \
64 ((mode) == BOND_MODE_ALB))
65
bb1d9123
AG
66#define TX_QUEUE_OVERRIDE(mode) \
67 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
68 ((mode) == BOND_MODE_ROUNDROBIN))
1da177e4
LT
69/*
70 * Less bad way to call ioctl from within the kernel; this needs to be
71 * done some other way to get the call out of interrupt context.
72 * Needs "ioctl" variable to be supplied by calling context.
73 */
74#define IOCTL(dev, arg, cmd) ({ \
75 int res = 0; \
76 mm_segment_t fs = get_fs(); \
77 set_fs(get_ds()); \
78 res = ioctl(dev, arg, cmd); \
79 set_fs(fs); \
80 res; })
81
82/**
83 * bond_for_each_slave_from - iterate the slaves list from a starting point
84 * @bond: the bond holding this list.
85 * @pos: current slave.
86 * @cnt: counter for max number of moves
87 * @start: starting point.
88 *
89 * Caller must hold bond->lock
90 */
91#define bond_for_each_slave_from(bond, pos, cnt, start) \
92 for (cnt = 0, pos = start; \
93 cnt < (bond)->slave_cnt; \
94 cnt++, pos = (pos)->next)
95
96/**
97 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
98 * @bond: the bond holding this list.
99 * @pos: current slave.
100 * @cnt: counter for number max of moves
101 * @start: start point.
102 * @stop: stop point.
103 *
104 * Caller must hold bond->lock
105 */
106#define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
107 for (cnt = 0, pos = start; \
108 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
109 cnt++, pos = (pos)->next)
110
111/**
112 * bond_for_each_slave - iterate the slaves list from head
113 * @bond: the bond holding this list.
114 * @pos: current slave.
115 * @cnt: counter for max number of moves
116 *
117 * Caller must hold bond->lock
118 */
119#define bond_for_each_slave(bond, pos, cnt) \
120 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
121
122
e843fa50 123#ifdef CONFIG_NET_POLL_CONTROLLER
fb4fa76a 124extern atomic_t netpoll_block_tx;
e843fa50
NH
125
126static inline void block_netpoll_tx(void)
127{
fb4fa76a 128 atomic_inc(&netpoll_block_tx);
e843fa50
NH
129}
130
131static inline void unblock_netpoll_tx(void)
132{
fb4fa76a 133 atomic_dec(&netpoll_block_tx);
e843fa50
NH
134}
135
136static inline int is_netpoll_tx_blocked(struct net_device *dev)
137{
080e4130 138 if (unlikely(netpoll_tx_running(dev)))
fb4fa76a 139 return atomic_read(&netpoll_block_tx);
e843fa50
NH
140 return 0;
141}
142#else
143#define block_netpoll_tx()
144#define unblock_netpoll_tx()
145#define is_netpoll_tx_blocked(dev) (0)
146#endif
147
1da177e4
LT
148struct bond_params {
149 int mode;
169a3e66 150 int xmit_policy;
1da177e4 151 int miimon;
7893b249 152 int num_grat_arp;
305d552a 153 int num_unsol_na;
1da177e4 154 int arp_interval;
f5b2b966 155 int arp_validate;
1da177e4 156 int use_carrier;
dd957c57 157 int fail_over_mac;
1da177e4
LT
158 int updelay;
159 int downdelay;
160 int lacp_fast;
fd989c83 161 int ad_select;
1da177e4 162 char primary[IFNAMSIZ];
a549952a 163 int primary_reselect;
d3bb52b0 164 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
bb1d9123 165 int tx_queues;
ebd8e497 166 int all_slaves_active;
c2952c31 167 int resend_igmp;
1da177e4
LT
168};
169
12479f9a
MW
170struct bond_parm_tbl {
171 char *modename;
172 int mode;
173};
174
ece95f7f
JV
175#define BOND_MAX_MODENAME_LEN 20
176
1da177e4
LT
177struct vlan_entry {
178 struct list_head vlan_list;
d3bb52b0 179 __be32 vlan_ip;
1da177e4 180 unsigned short vlan_id;
305d552a
BH
181#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
182 struct in6_addr vlan_ipv6;
183#endif
1da177e4
LT
184};
185
186struct slave {
e944ef79 187 struct net_device *dev; /* first - useful for panic debug */
1da177e4
LT
188 struct slave *next;
189 struct slave *prev;
35d48903 190 struct bonding *bond; /* our master */
8bb5f96b 191 int delay;
f8a8ccd5
AG
192 unsigned long jiffies;
193 unsigned long last_arp_rx;
1da177e4 194 s8 link; /* one of BOND_LINK_XXXX */
b2220cad 195 s8 new_link;
2d7011ca
JP
196 u8 backup:1, /* indicates backup slave. Value corresponds with
197 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
198 inactive:1; /* indicates inactive slave */
3158bf7d 199 u32 original_mtu;
1da177e4 200 u32 link_failure_count;
885a136c 201 u8 perm_hwaddr[ETH_ALEN];
1da177e4
LT
202 u16 speed;
203 u8 duplex;
bb1d9123 204 u16 queue_id;
1da177e4
LT
205 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
206 struct tlb_slave_info tlb_info;
8a8efa22
AW
207#ifdef CONFIG_NET_POLL_CONTROLLER
208 struct netpoll *np;
209#endif
1da177e4
LT
210};
211
b2220cad
JV
212/*
213 * Link pseudo-state only used internally by monitors
214 */
215#define BOND_LINK_NOCHANGE -1
216
1da177e4
LT
217/*
218 * Here are the locking policies for the two bonding locks:
219 *
220 * 1) Get bond->lock when reading/writing slave list.
221 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
222 * (It is unnecessary when the write-lock is put with bond->lock.)
223 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
224 * beforehand.
225 */
226struct bonding {
e944ef79 227 struct net_device *dev; /* first - useful for panic debug */
1da177e4
LT
228 struct slave *first_slave;
229 struct slave *curr_active_slave;
230 struct slave *current_arp_slave;
231 struct slave *primary_slave;
a549952a 232 bool force_primary;
1da177e4
LT
233 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
234 rwlock_t lock;
235 rwlock_t curr_slave_lock;
1da177e4 236 s8 kill_timers;
1053f62c 237 s8 send_grat_arp;
305d552a 238 s8 send_unsol_na;
d90a162a 239 s8 setup_by_slave;
c2952c31 240 s8 igmp_retrans;
1da177e4
LT
241#ifdef CONFIG_PROC_FS
242 struct proc_dir_entry *proc_entry;
243 char proc_file_name[IFNAMSIZ];
244#endif /* CONFIG_PROC_FS */
245 struct list_head bond_list;
22bedad3 246 struct netdev_hw_addr_list mc_list;
a361c83c 247 int (*xmit_hash_policy)(struct sk_buff *, int);
d3bb52b0 248 __be32 master_ip;
1da177e4 249 u16 flags;
cf5f9044 250 u16 rr_tx_counter;
1da177e4
LT
251 struct ad_bond_info ad_info;
252 struct alb_bond_info alb_info;
253 struct bond_params params;
254 struct list_head vlan_list;
255 struct vlan_group *vlgrp;
f5b2b966 256 struct packet_type arp_mon_pt;
1b76b316
JV
257 struct workqueue_struct *wq;
258 struct delayed_work mii_work;
259 struct delayed_work arp_work;
260 struct delayed_work alb_work;
261 struct delayed_work ad_work;
5a37e8ca 262 struct delayed_work mcast_work;
305d552a
BH
263#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
264 struct in6_addr master_ipv6;
265#endif
f073c7ca
TI
266#ifdef CONFIG_DEBUG_FS
267 /* debugging suport via debugfs */
268 struct dentry *debug_dir;
269#endif /* CONFIG_DEBUG_FS */
1da177e4
LT
270};
271
f1c1775a
JP
272#define bond_slave_get_rcu(dev) \
273 ((struct slave *) rcu_dereference(dev->rx_handler_data))
274
1da177e4
LT
275/**
276 * Returns NULL if the net_device does not belong to any of the bond's slaves
277 *
278 * Caller must hold bond lock for read
279 */
4ec952b8 280static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
281 struct net_device *slave_dev)
1da177e4
LT
282{
283 struct slave *slave = NULL;
284 int i;
285
286 bond_for_each_slave(bond, slave, i) {
287 if (slave->dev == slave_dev) {
af3e5bd5 288 return slave;
1da177e4
LT
289 }
290 }
291
4ec952b8 292 return NULL;
1da177e4
LT
293}
294
cceb904f 295static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
1da177e4
LT
296{
297 if (!slave || !slave->dev->master) {
298 return NULL;
299 }
300
c04914af 301 return netdev_priv(slave->dev->master);
1da177e4
LT
302}
303
58402054
HE
304static inline bool bond_is_lb(const struct bonding *bond)
305{
8e95a202
JP
306 return (bond->params.mode == BOND_MODE_TLB ||
307 bond->params.mode == BOND_MODE_ALB);
58402054
HE
308}
309
e30bc066
JP
310static inline void bond_set_active_slave(struct slave *slave)
311{
312 slave->backup = 0;
313}
314
315static inline void bond_set_backup_slave(struct slave *slave)
316{
317 slave->backup = 1;
318}
319
320static inline int bond_slave_state(struct slave *slave)
321{
322 return slave->backup;
323}
324
325static inline bool bond_is_active_slave(struct slave *slave)
326{
327 return !bond_slave_state(slave);
328}
329
a549952a
JP
330#define BOND_PRI_RESELECT_ALWAYS 0
331#define BOND_PRI_RESELECT_BETTER 1
332#define BOND_PRI_RESELECT_FAILURE 2
333
3915c1e8
JV
334#define BOND_FOM_NONE 0
335#define BOND_FOM_ACTIVE 1
336#define BOND_FOM_FOLLOW 2
337
f5b2b966
JV
338#define BOND_ARP_VALIDATE_NONE 0
339#define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
340#define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
341#define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
342 BOND_ARP_VALIDATE_BACKUP)
343
079ca7da
AB
344static inline int slave_do_arp_validate(struct bonding *bond,
345 struct slave *slave)
f5b2b966 346{
e30bc066 347 return bond->params.arp_validate & (1 << bond_slave_state(slave));
f5b2b966
JV
348}
349
079ca7da 350static inline unsigned long slave_last_rx(struct bonding *bond,
f8a8ccd5 351 struct slave *slave)
f5b2b966
JV
352{
353 if (slave_do_arp_validate(bond, slave))
354 return slave->last_arp_rx;
355
356 return slave->dev->last_rx;
357}
358
8a8efa22
AW
359#ifdef CONFIG_NET_POLL_CONTROLLER
360static inline void bond_netpoll_send_skb(const struct slave *slave,
361 struct sk_buff *skb)
362{
363 struct netpoll *np = slave->np;
364
365 if (np)
366 netpoll_send_skb(np, skb);
367}
368#else
369static inline void bond_netpoll_send_skb(const struct slave *slave,
370 struct sk_buff *skb)
371{
372}
373#endif
374
cceb904f 375static inline void bond_set_slave_inactive_flags(struct slave *slave)
1da177e4 376{
454d7c9b 377 struct bonding *bond = netdev_priv(slave->dev->master);
ae63e808 378 if (!bond_is_lb(bond))
e30bc066 379 bond_set_backup_slave(slave);
ebd8e497 380 if (!bond->params.all_slaves_active)
2d7011ca 381 slave->inactive = 1;
1da177e4
LT
382}
383
cceb904f 384static inline void bond_set_slave_active_flags(struct slave *slave)
1da177e4 385{
e30bc066 386 bond_set_active_slave(slave);
2d7011ca
JP
387 slave->inactive = 0;
388}
389
390static inline bool bond_is_slave_inactive(struct slave *slave)
391{
392 return slave->inactive;
1da177e4
LT
393}
394
395struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
396int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
ec87fd3b 397int bond_create(struct net *net, const char *name);
b76cdba9
MW
398int bond_create_sysfs(void);
399void bond_destroy_sysfs(void);
6151b3d4 400void bond_prepare_sysfs_group(struct bonding *bond);
b76cdba9
MW
401int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
402void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
a77b5325
MW
403int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
404int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
1b76b316
JV
405void bond_mii_monitor(struct work_struct *);
406void bond_loadbalance_arp_mon(struct work_struct *);
407void bond_activebackup_arp_mon(struct work_struct *);
a77b5325 408void bond_set_mode_ops(struct bonding *bond, int mode);
325dcf7a 409int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
a77b5325
MW
410void bond_select_active_slave(struct bonding *bond);
411void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
f5b2b966
JV
412void bond_register_arp(struct bonding *);
413void bond_unregister_arp(struct bonding *);
f073c7ca
TI
414void bond_create_debugfs(void);
415void bond_destroy_debugfs(void);
416void bond_debug_register(struct bonding *bond);
417void bond_debug_unregister(struct bonding *bond);
418void bond_debug_reregister(struct bonding *bond);
d30ee670 419const char *bond_mode_name(int mode);
1da177e4 420
ec87fd3b
EB
421struct bond_net {
422 struct net * net; /* Associated network namespace */
423 struct list_head dev_list;
424#ifdef CONFIG_PROC_FS
425 struct proc_dir_entry * proc_dir;
426#endif
427};
428
bd33acc3
AW
429#ifdef CONFIG_PROC_FS
430void bond_create_proc_entry(struct bonding *bond);
431void bond_remove_proc_entry(struct bonding *bond);
432void bond_create_proc_dir(struct bond_net *bn);
433void bond_destroy_proc_dir(struct bond_net *bn);
434#else
435static inline void bond_create_proc_entry(struct bonding *bond)
436{
437}
438
439static inline void bond_remove_proc_entry(struct bonding *bond)
440{
441}
442
443static inline void bond_create_proc_dir(struct bond_net *bn)
444{
445}
446
447static inline void bond_destroy_proc_dir(struct bond_net *bn)
448{
449}
450#endif
451
452
b2259672 453/* exported from bond_main.c */
ec87fd3b 454extern int bond_net_id;
e97fd7c6
HE
455extern const struct bond_parm_tbl bond_lacp_tbl[];
456extern const struct bond_parm_tbl bond_mode_tbl[];
457extern const struct bond_parm_tbl xmit_hashtype_tbl[];
458extern const struct bond_parm_tbl arp_validate_tbl[];
459extern const struct bond_parm_tbl fail_over_mac_tbl[];
a549952a 460extern const struct bond_parm_tbl pri_reselect_tbl[];
b06715b7
HE
461extern struct bond_parm_tbl ad_select_tbl[];
462
305d552a
BH
463#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
464void bond_send_unsolicited_na(struct bonding *bond);
465void bond_register_ipv6_notifier(void);
466void bond_unregister_ipv6_notifier(void);
467#else
468static inline void bond_send_unsolicited_na(struct bonding *bond)
469{
470 return;
471}
472static inline void bond_register_ipv6_notifier(void)
473{
474 return;
475}
476static inline void bond_unregister_ipv6_notifier(void)
477{
478 return;
479}
480#endif
481
1da177e4 482#endif /* _LINUX_BONDING_H */
This page took 0.872038 seconds and 5 git commands to generate.