blob: 89fd9963db7ae6fea3f2623445a5c5a422837690 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 */
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>
Mitch Williamsb76cdba2005-11-09 10:36:41 -080021#include <linux/kobject.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include "bond_3ad.h"
23#include "bond_alb.h"
24
Jay Vosburgh2cfb8b72008-03-21 22:29:36 -070025#define DRV_VERSION "3.2.5"
26#define DRV_RELDATE "March 21, 2008"
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#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;
Jay Vosburgh169a3e62005-06-26 17:54:11 -0400126 int xmit_policy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 int miimon;
Moni Shoua7893b242008-05-17 21:10:12 -0700128 int num_grat_arp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 int arp_interval;
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700130 int arp_validate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 int use_carrier;
Jay Vosburghdd957c52007-10-09 19:57:24 -0700132 int fail_over_mac;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 int updelay;
134 int downdelay;
135 int lacp_fast;
136 char primary[IFNAMSIZ];
Al Virod3bb52b2007-08-22 20:06:58 -0400137 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138};
139
Mitch Williams12479f92005-11-09 10:35:44 -0800140struct bond_parm_tbl {
141 char *modename;
142 int mode;
143};
144
Jay Vosburghece95f72008-01-17 16:25:01 -0800145#define BOND_MAX_MODENAME_LEN 20
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147struct vlan_entry {
148 struct list_head vlan_list;
Al Virod3bb52b2007-08-22 20:06:58 -0400149 __be32 vlan_ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 unsigned short vlan_id;
151};
152
153struct slave {
Mitch Williamse944ef72005-11-09 10:36:50 -0800154 struct net_device *dev; /* first - useful for panic debug */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 struct slave *next;
156 struct slave *prev;
Jay Vosburgh8bb5f962006-09-22 21:52:51 -0700157 int delay;
Andy Gospodarekf8a8ccd2007-01-29 12:08:38 -0800158 unsigned long jiffies;
159 unsigned long last_arp_rx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 s8 link; /* one of BOND_LINK_XXXX */
Jay Vosburghb2220ca2008-05-17 21:10:13 -0700161 s8 new_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 s8 state; /* one of BOND_STATE_XXXX */
163 u32 original_flags;
Moni Shoua3158bf72007-10-09 19:43:41 -0700164 u32 original_mtu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 u32 link_failure_count;
166 u16 speed;
167 u8 duplex;
168 u8 perm_hwaddr[ETH_ALEN];
169 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
170 struct tlb_slave_info tlb_info;
171};
172
173/*
Jay Vosburghb2220ca2008-05-17 21:10:13 -0700174 * Link pseudo-state only used internally by monitors
175 */
176#define BOND_LINK_NOCHANGE -1
177
178/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 * Here are the locking policies for the two bonding locks:
180 *
181 * 1) Get bond->lock when reading/writing slave list.
182 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
183 * (It is unnecessary when the write-lock is put with bond->lock.)
184 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
185 * beforehand.
186 */
187struct bonding {
Mitch Williamse944ef72005-11-09 10:36:50 -0800188 struct net_device *dev; /* first - useful for panic debug */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 struct slave *first_slave;
190 struct slave *curr_active_slave;
191 struct slave *current_arp_slave;
192 struct slave *primary_slave;
193 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
194 rwlock_t lock;
195 rwlock_t curr_slave_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 s8 kill_timers;
Moni Shoua1053f622007-10-09 19:43:42 -0700197 s8 send_grat_arp;
Moni Shouad90a1622007-10-09 19:43:43 -0700198 s8 setup_by_slave;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 struct net_device_stats stats;
200#ifdef CONFIG_PROC_FS
201 struct proc_dir_entry *proc_entry;
202 char proc_file_name[IFNAMSIZ];
203#endif /* CONFIG_PROC_FS */
204 struct list_head bond_list;
205 struct dev_mc_list *mc_list;
Jay Vosburgh169a3e62005-06-26 17:54:11 -0400206 int (*xmit_hash_policy)(struct sk_buff *, struct net_device *, int);
Al Virod3bb52b2007-08-22 20:06:58 -0400207 __be32 master_ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 u16 flags;
Jay Vosburghcf5f9042007-10-17 17:37:47 -0700209 u16 rr_tx_counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 struct ad_bond_info ad_info;
211 struct alb_bond_info alb_info;
212 struct bond_params params;
213 struct list_head vlan_list;
214 struct vlan_group *vlgrp;
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700215 struct packet_type arp_mon_pt;
Jay Vosburgh1b76b312007-10-17 17:37:45 -0700216 struct workqueue_struct *wq;
217 struct delayed_work mii_work;
218 struct delayed_work arp_work;
219 struct delayed_work alb_work;
220 struct delayed_work ad_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221};
222
223/**
224 * Returns NULL if the net_device does not belong to any of the bond's slaves
225 *
226 * Caller must hold bond lock for read
227 */
Adrian Bunkcceb9042006-01-05 22:45:42 -0800228static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229{
230 struct slave *slave = NULL;
231 int i;
232
233 bond_for_each_slave(bond, slave, i) {
234 if (slave->dev == slave_dev) {
235 break;
236 }
237 }
238
239 return slave;
240}
241
Adrian Bunkcceb9042006-01-05 22:45:42 -0800242static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
244 if (!slave || !slave->dev->master) {
245 return NULL;
246 }
247
248 return (struct bonding *)slave->dev->master->priv;
249}
250
Jay Vosburgh3915c1e82008-05-17 21:10:14 -0700251#define BOND_FOM_NONE 0
252#define BOND_FOM_ACTIVE 1
253#define BOND_FOM_FOLLOW 2
254
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700255#define BOND_ARP_VALIDATE_NONE 0
256#define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
257#define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
258#define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
259 BOND_ARP_VALIDATE_BACKUP)
260
Adrian Bunk079ca7d2006-12-12 17:24:39 +0100261static inline int slave_do_arp_validate(struct bonding *bond,
262 struct slave *slave)
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700263{
264 return bond->params.arp_validate & (1 << slave->state);
265}
266
Adrian Bunk079ca7d2006-12-12 17:24:39 +0100267static inline unsigned long slave_last_rx(struct bonding *bond,
Andy Gospodarekf8a8ccd2007-01-29 12:08:38 -0800268 struct slave *slave)
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700269{
270 if (slave_do_arp_validate(bond, slave))
271 return slave->last_arp_rx;
272
273 return slave->dev->last_rx;
274}
275
Adrian Bunkcceb9042006-01-05 22:45:42 -0800276static inline void bond_set_slave_inactive_flags(struct slave *slave)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277{
Jay Vosburgh8f903c72006-02-21 16:36:44 -0800278 struct bonding *bond = slave->dev->master->priv;
279 if (bond->params.mode != BOND_MODE_TLB &&
280 bond->params.mode != BOND_MODE_ALB)
281 slave->state = BOND_STATE_BACKUP;
282 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700283 if (slave_do_arp_validate(bond, slave))
284 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285}
286
Adrian Bunkcceb9042006-01-05 22:45:42 -0800287static inline void bond_set_slave_active_flags(struct slave *slave)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288{
289 slave->state = BOND_STATE_ACTIVE;
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700290 slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
Jay Vosburgh8f903c72006-02-21 16:36:44 -0800291}
292
293static inline void bond_set_master_3ad_flags(struct bonding *bond)
294{
295 bond->dev->priv_flags |= IFF_MASTER_8023AD;
296}
297
298static inline void bond_unset_master_3ad_flags(struct bonding *bond)
299{
300 bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
301}
302
303static inline void bond_set_master_alb_flags(struct bonding *bond)
304{
305 bond->dev->priv_flags |= IFF_MASTER_ALB;
306}
307
308static inline void bond_unset_master_alb_flags(struct bonding *bond)
309{
310 bond->dev->priv_flags &= ~IFF_MASTER_ALB;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311}
312
313struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
314int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
Pavel Emelyanov0dd646f2008-05-17 21:10:09 -0700315int bond_create(char *name, struct bond_params *params);
Moni Shouad90a1622007-10-09 19:43:43 -0700316void bond_destroy(struct bonding *bond);
317int bond_release_and_destroy(struct net_device *bond_dev, struct net_device *slave_dev);
Mitch Williamsb76cdba2005-11-09 10:36:41 -0800318int bond_create_sysfs(void);
319void bond_destroy_sysfs(void);
320void bond_destroy_sysfs_entry(struct bonding *bond);
321int bond_create_sysfs_entry(struct bonding *bond);
322int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
323void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
Mitch Williamsa77b5322005-11-09 10:35:51 -0800324int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
325int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
Jay Vosburgh1b76b312007-10-17 17:37:45 -0700326void bond_mii_monitor(struct work_struct *);
327void bond_loadbalance_arp_mon(struct work_struct *);
328void bond_activebackup_arp_mon(struct work_struct *);
Mitch Williamsa77b5322005-11-09 10:35:51 -0800329void bond_set_mode_ops(struct bonding *bond, int mode);
Jay Vosburghece95f72008-01-17 16:25:01 -0800330int bond_parse_parm(const char *mode_arg, struct bond_parm_tbl *tbl);
Mitch Williamsa77b5322005-11-09 10:35:51 -0800331void bond_select_active_slave(struct bonding *bond);
332void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700333void bond_register_arp(struct bonding *);
334void bond_unregister_arp(struct bonding *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336#endif /* _LINUX_BONDING_H */
337