Linux Audio

Check our new training course

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