blob: 9c03c2ee074d7b68912a07f4573bd0728f8b28cd [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>
Brian Haley305d5522008-11-04 17:51:14 -080022#include <linux/in6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include "bond_3ad.h"
24#include "bond_alb.h"
25
Jiri Pirkoa5499522009-09-25 03:28:09 +000026#define DRV_VERSION "3.6.0"
27#define DRV_RELDATE "September 26, 2009"
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#define DRV_NAME "bonding"
29#define DRV_DESCRIPTION "Ethernet Channel Bonding Driver"
30
31#define BOND_MAX_ARP_TARGETS 16
32
Brian Haley305d5522008-11-04 17:51:14 -080033extern struct list_head bond_dev_list;
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define IS_UP(dev) \
36 ((((dev)->flags & IFF_UP) == IFF_UP) && \
37 netif_running(dev) && \
38 netif_carrier_ok(dev))
39
40/*
41 * Checks whether bond is ready for transmit.
42 *
43 * Caller must hold bond->lock
44 */
45#define BOND_IS_OK(bond) \
46 (((bond)->dev->flags & IFF_UP) && \
47 netif_running((bond)->dev) && \
48 ((bond)->slave_cnt > 0))
49
50/*
51 * Checks whether slave is ready for transmit.
52 */
53#define SLAVE_IS_OK(slave) \
54 (((slave)->dev->flags & IFF_UP) && \
55 netif_running((slave)->dev) && \
56 ((slave)->link == BOND_LINK_UP) && \
57 ((slave)->state == BOND_STATE_ACTIVE))
58
59
60#define USES_PRIMARY(mode) \
61 (((mode) == BOND_MODE_ACTIVEBACKUP) || \
62 ((mode) == BOND_MODE_TLB) || \
63 ((mode) == BOND_MODE_ALB))
64
65/*
66 * Less bad way to call ioctl from within the kernel; this needs to be
67 * done some other way to get the call out of interrupt context.
68 * Needs "ioctl" variable to be supplied by calling context.
69 */
70#define IOCTL(dev, arg, cmd) ({ \
71 int res = 0; \
72 mm_segment_t fs = get_fs(); \
73 set_fs(get_ds()); \
74 res = ioctl(dev, arg, cmd); \
75 set_fs(fs); \
76 res; })
77
78/**
79 * bond_for_each_slave_from - iterate the slaves list from a starting point
80 * @bond: the bond holding this list.
81 * @pos: current slave.
82 * @cnt: counter for max number of moves
83 * @start: starting point.
84 *
85 * Caller must hold bond->lock
86 */
87#define bond_for_each_slave_from(bond, pos, cnt, start) \
88 for (cnt = 0, pos = start; \
89 cnt < (bond)->slave_cnt; \
90 cnt++, pos = (pos)->next)
91
92/**
93 * bond_for_each_slave_from_to - iterate the slaves list from start point to stop point
94 * @bond: the bond holding this list.
95 * @pos: current slave.
96 * @cnt: counter for number max of moves
97 * @start: start point.
98 * @stop: stop point.
99 *
100 * Caller must hold bond->lock
101 */
102#define bond_for_each_slave_from_to(bond, pos, cnt, start, stop) \
103 for (cnt = 0, pos = start; \
104 ((cnt < (bond)->slave_cnt) && (pos != (stop)->next)); \
105 cnt++, pos = (pos)->next)
106
107/**
108 * bond_for_each_slave - iterate the slaves list from head
109 * @bond: the bond holding this list.
110 * @pos: current slave.
111 * @cnt: counter for max number of moves
112 *
113 * Caller must hold bond->lock
114 */
115#define bond_for_each_slave(bond, pos, cnt) \
116 bond_for_each_slave_from(bond, pos, cnt, (bond)->first_slave)
117
118
119struct bond_params {
120 int mode;
Jay Vosburgh169a3e62005-06-26 17:54:11 -0400121 int xmit_policy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 int miimon;
Moni Shoua7893b242008-05-17 21:10:12 -0700123 int num_grat_arp;
Brian Haley305d5522008-11-04 17:51:14 -0800124 int num_unsol_na;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 int arp_interval;
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700126 int arp_validate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 int use_carrier;
Jay Vosburghdd957c52007-10-09 19:57:24 -0700128 int fail_over_mac;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 int updelay;
130 int downdelay;
131 int lacp_fast;
Jay Vosburghfd989c82008-11-04 17:51:16 -0800132 int ad_select;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 char primary[IFNAMSIZ];
Jiri Pirkoa5499522009-09-25 03:28:09 +0000134 int primary_reselect;
Al Virod3bb52b2007-08-22 20:06:58 -0400135 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136};
137
Mitch Williams12479f92005-11-09 10:35:44 -0800138struct bond_parm_tbl {
139 char *modename;
140 int mode;
141};
142
Jay Vosburghece95f72008-01-17 16:25:01 -0800143#define BOND_MAX_MODENAME_LEN 20
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145struct vlan_entry {
146 struct list_head vlan_list;
Al Virod3bb52b2007-08-22 20:06:58 -0400147 __be32 vlan_ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 unsigned short vlan_id;
Brian Haley305d5522008-11-04 17:51:14 -0800149#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
150 struct in6_addr vlan_ipv6;
151#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152};
153
154struct slave {
Mitch Williamse944ef72005-11-09 10:36:50 -0800155 struct net_device *dev; /* first - useful for panic debug */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 struct slave *next;
157 struct slave *prev;
Jay Vosburgh8bb5f962006-09-22 21:52:51 -0700158 int delay;
Andy Gospodarekf8a8ccd2007-01-29 12:08:38 -0800159 unsigned long jiffies;
160 unsigned long last_arp_rx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 s8 link; /* one of BOND_LINK_XXXX */
Jay Vosburghb2220ca2008-05-17 21:10:13 -0700162 s8 new_link;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 s8 state; /* one of BOND_STATE_XXXX */
164 u32 original_flags;
Moni Shoua3158bf72007-10-09 19:43:41 -0700165 u32 original_mtu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 u32 link_failure_count;
Eric Dumazet885a1362009-09-01 06:31:18 +0000167 u8 perm_hwaddr[ETH_ALEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 u16 speed;
169 u8 duplex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
171 struct tlb_slave_info tlb_info;
172};
173
174/*
Jay Vosburghb2220ca2008-05-17 21:10:13 -0700175 * Link pseudo-state only used internally by monitors
176 */
177#define BOND_LINK_NOCHANGE -1
178
179/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 * Here are the locking policies for the two bonding locks:
181 *
182 * 1) Get bond->lock when reading/writing slave list.
183 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
184 * (It is unnecessary when the write-lock is put with bond->lock.)
185 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
186 * beforehand.
187 */
188struct bonding {
Mitch Williamse944ef72005-11-09 10:36:50 -0800189 struct net_device *dev; /* first - useful for panic debug */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 struct slave *first_slave;
191 struct slave *curr_active_slave;
192 struct slave *current_arp_slave;
193 struct slave *primary_slave;
Jiri Pirkoa5499522009-09-25 03:28:09 +0000194 bool force_primary;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
196 rwlock_t lock;
197 rwlock_t curr_slave_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 s8 kill_timers;
Moni Shoua1053f622007-10-09 19:43:42 -0700199 s8 send_grat_arp;
Brian Haley305d5522008-11-04 17:51:14 -0800200 s8 send_unsol_na;
Moni Shouad90a1622007-10-09 19:43:43 -0700201 s8 setup_by_slave;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 struct net_device_stats stats;
203#ifdef CONFIG_PROC_FS
204 struct proc_dir_entry *proc_entry;
205 char proc_file_name[IFNAMSIZ];
206#endif /* CONFIG_PROC_FS */
207 struct list_head bond_list;
208 struct dev_mc_list *mc_list;
Jay Vosburgh169a3e62005-06-26 17:54:11 -0400209 int (*xmit_hash_policy)(struct sk_buff *, struct net_device *, int);
Al Virod3bb52b2007-08-22 20:06:58 -0400210 __be32 master_ip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 u16 flags;
Jay Vosburghcf5f9042007-10-17 17:37:47 -0700212 u16 rr_tx_counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 struct ad_bond_info ad_info;
214 struct alb_bond_info alb_info;
215 struct bond_params params;
216 struct list_head vlan_list;
217 struct vlan_group *vlgrp;
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700218 struct packet_type arp_mon_pt;
Jay Vosburgh1b76b312007-10-17 17:37:45 -0700219 struct workqueue_struct *wq;
220 struct delayed_work mii_work;
221 struct delayed_work arp_work;
222 struct delayed_work alb_work;
223 struct delayed_work ad_work;
Brian Haley305d5522008-11-04 17:51:14 -0800224#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
225 struct in6_addr master_ipv6;
226#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227};
228
229/**
230 * Returns NULL if the net_device does not belong to any of the bond's slaves
231 *
232 * Caller must hold bond lock for read
233 */
Adrian Bunkcceb9042006-01-05 22:45:42 -0800234static inline struct slave *bond_get_slave_by_dev(struct bonding *bond, struct net_device *slave_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
236 struct slave *slave = NULL;
237 int i;
238
239 bond_for_each_slave(bond, slave, i) {
240 if (slave->dev == slave_dev) {
241 break;
242 }
243 }
244
245 return slave;
246}
247
Adrian Bunkcceb9042006-01-05 22:45:42 -0800248static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249{
250 if (!slave || !slave->dev->master) {
251 return NULL;
252 }
253
Wang Chen454d7c92008-11-12 23:37:49 -0800254 return (struct bonding *)netdev_priv(slave->dev->master);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
256
Holger Eitzenberger58402052008-12-09 23:07:13 -0800257static inline bool bond_is_lb(const struct bonding *bond)
258{
259 return bond->params.mode == BOND_MODE_TLB
260 || bond->params.mode == BOND_MODE_ALB;
261}
262
Jiri Pirkoa5499522009-09-25 03:28:09 +0000263#define BOND_PRI_RESELECT_ALWAYS 0
264#define BOND_PRI_RESELECT_BETTER 1
265#define BOND_PRI_RESELECT_FAILURE 2
266
Jay Vosburgh3915c1e82008-05-17 21:10:14 -0700267#define BOND_FOM_NONE 0
268#define BOND_FOM_ACTIVE 1
269#define BOND_FOM_FOLLOW 2
270
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700271#define BOND_ARP_VALIDATE_NONE 0
272#define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
273#define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
274#define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
275 BOND_ARP_VALIDATE_BACKUP)
276
Adrian Bunk079ca7d2006-12-12 17:24:39 +0100277static inline int slave_do_arp_validate(struct bonding *bond,
278 struct slave *slave)
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700279{
280 return bond->params.arp_validate & (1 << slave->state);
281}
282
Adrian Bunk079ca7d2006-12-12 17:24:39 +0100283static inline unsigned long slave_last_rx(struct bonding *bond,
Andy Gospodarekf8a8ccd2007-01-29 12:08:38 -0800284 struct slave *slave)
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700285{
286 if (slave_do_arp_validate(bond, slave))
287 return slave->last_arp_rx;
288
289 return slave->dev->last_rx;
290}
291
Adrian Bunkcceb9042006-01-05 22:45:42 -0800292static inline void bond_set_slave_inactive_flags(struct slave *slave)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293{
Wang Chen454d7c92008-11-12 23:37:49 -0800294 struct bonding *bond = netdev_priv(slave->dev->master);
Jiri Pirkoae63e802009-05-27 05:42:36 +0000295 if (!bond_is_lb(bond))
Jay Vosburgh8f903c72006-02-21 16:36:44 -0800296 slave->state = BOND_STATE_BACKUP;
297 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700298 if (slave_do_arp_validate(bond, slave))
299 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300}
301
Adrian Bunkcceb9042006-01-05 22:45:42 -0800302static inline void bond_set_slave_active_flags(struct slave *slave)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303{
304 slave->state = BOND_STATE_ACTIVE;
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700305 slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
Jay Vosburgh8f903c72006-02-21 16:36:44 -0800306}
307
308static inline void bond_set_master_3ad_flags(struct bonding *bond)
309{
310 bond->dev->priv_flags |= IFF_MASTER_8023AD;
311}
312
313static inline void bond_unset_master_3ad_flags(struct bonding *bond)
314{
315 bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
316}
317
318static inline void bond_set_master_alb_flags(struct bonding *bond)
319{
320 bond->dev->priv_flags |= IFF_MASTER_ALB;
321}
322
323static inline void bond_unset_master_alb_flags(struct bonding *bond)
324{
325 bond->dev->priv_flags &= ~IFF_MASTER_ALB;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326}
327
328struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
329int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
Stephen Hemmingerd2991f72009-06-12 19:02:44 +0000330int bond_create(const char *name);
Moni Shouad90a1622007-10-09 19:43:43 -0700331int bond_release_and_destroy(struct net_device *bond_dev, struct net_device *slave_dev);
Mitch Williamsb76cdba2005-11-09 10:36:41 -0800332int bond_create_sysfs(void);
333void bond_destroy_sysfs(void);
334void bond_destroy_sysfs_entry(struct bonding *bond);
335int bond_create_sysfs_entry(struct bonding *bond);
336int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
337void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
Mitch Williamsa77b5322005-11-09 10:35:51 -0800338int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
339int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
Jay Vosburgh1b76b312007-10-17 17:37:45 -0700340void bond_mii_monitor(struct work_struct *);
341void bond_loadbalance_arp_mon(struct work_struct *);
342void bond_activebackup_arp_mon(struct work_struct *);
Mitch Williamsa77b5322005-11-09 10:35:51 -0800343void bond_set_mode_ops(struct bonding *bond, int mode);
Holger Eitzenberger325dcf72008-12-09 23:10:17 -0800344int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
Mitch Williamsa77b5322005-11-09 10:35:51 -0800345void bond_select_active_slave(struct bonding *bond);
346void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
Jay Vosburghf5b2b962006-09-22 21:54:53 -0700347void bond_register_arp(struct bonding *);
348void bond_unregister_arp(struct bonding *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
Ben Dooksb2259672008-09-14 16:56:12 +0100350/* exported from bond_main.c */
351extern struct list_head bond_dev_list;
Holger Eitzenbergere97fd7c2008-12-09 23:10:38 -0800352extern const struct bond_parm_tbl bond_lacp_tbl[];
353extern const struct bond_parm_tbl bond_mode_tbl[];
354extern const struct bond_parm_tbl xmit_hashtype_tbl[];
355extern const struct bond_parm_tbl arp_validate_tbl[];
356extern const struct bond_parm_tbl fail_over_mac_tbl[];
Jiri Pirkoa5499522009-09-25 03:28:09 +0000357extern const struct bond_parm_tbl pri_reselect_tbl[];
Hannes Ederb06715b2008-12-25 23:58:57 -0800358extern struct bond_parm_tbl ad_select_tbl[];
359
Brian Haley305d5522008-11-04 17:51:14 -0800360#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
361void bond_send_unsolicited_na(struct bonding *bond);
362void bond_register_ipv6_notifier(void);
363void bond_unregister_ipv6_notifier(void);
364#else
365static inline void bond_send_unsolicited_na(struct bonding *bond)
366{
367 return;
368}
369static inline void bond_register_ipv6_notifier(void)
370{
371 return;
372}
373static inline void bond_unregister_ipv6_notifier(void)
374{
375 return;
376}
377#endif
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379#endif /* _LINUX_BONDING_H */
380