projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
be2net: Bump up the version number
[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>
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) && \
58 ((slave)->state == BOND_STATE_ACTIVE))
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;
8bb5f96b 190 int delay;
f8a8ccd5
AG		 191 unsigned long jiffies;
192 unsigned long last_arp_rx;
1da177e4 193 s8 link; /* one of BOND_LINK_XXXX */
b2220cad 194 s8 new_link;
1da177e4 195 s8 state; /* one of BOND_STATE_XXXX */
3158bf7d 196 u32 original_mtu;
1da177e4 197 u32 link_failure_count;
885a136c 198 u8 perm_hwaddr[ETH_ALEN];
1da177e4
LT		 199 u16 speed;
200 u8 duplex;
bb1d9123 201 u16 queue_id;
1da177e4
LT		 202 struct ad_slave_info ad_info; /* HUGE - better to dynamically alloc */
203 struct tlb_slave_info tlb_info;
8a8efa22
AW		 204#ifdef CONFIG_NET_POLL_CONTROLLER
205 struct netpoll *np;
206#endif
1da177e4
LT		 207};
208
b2220cad
JV		 209/*
210 * Link pseudo-state only used internally by monitors
211 */
212#define BOND_LINK_NOCHANGE -1
213
1da177e4
LT		 214/*
215 * Here are the locking policies for the two bonding locks:
216 *
217 * 1) Get bond->lock when reading/writing slave list.
218 * 2) Get bond->curr_slave_lock when reading/writing bond->curr_active_slave.
219 * (It is unnecessary when the write-lock is put with bond->lock.)
220 * 3) When we lock with bond->curr_slave_lock, we must lock with bond->lock
221 * beforehand.
222 */
223struct bonding {
e944ef79 224 struct net_device *dev; /* first - useful for panic debug */
1da177e4
LT		 225 struct slave *first_slave;
226 struct slave *curr_active_slave;
227 struct slave *current_arp_slave;
228 struct slave *primary_slave;
a549952a 229 bool force_primary;
1da177e4
LT		 230 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
231 rwlock_t lock;
232 rwlock_t curr_slave_lock;
1da177e4 233 s8 kill_timers;
1053f62c 234 s8 send_grat_arp;
305d552a 235 s8 send_unsol_na;
d90a162a 236 s8 setup_by_slave;
c2952c31 237 s8 igmp_retrans;
1da177e4
LT		 238#ifdef CONFIG_PROC_FS
239 struct proc_dir_entry *proc_entry;
240 char proc_file_name[IFNAMSIZ];
241#endif /* CONFIG_PROC_FS */
242 struct list_head bond_list;
22bedad3 243 struct netdev_hw_addr_list mc_list;
a361c83c 244 int (*xmit_hash_policy)(struct sk_buff *, int);
d3bb52b0 245 __be32 master_ip;
1da177e4 246 u16 flags;
cf5f9044 247 u16 rr_tx_counter;
1da177e4
LT		 248 struct ad_bond_info ad_info;
249 struct alb_bond_info alb_info;
250 struct bond_params params;
251 struct list_head vlan_list;
252 struct vlan_group *vlgrp;
f5b2b966 253 struct packet_type arp_mon_pt;
1b76b316
JV		 254 struct workqueue_struct *wq;
255 struct delayed_work mii_work;
256 struct delayed_work arp_work;
257 struct delayed_work alb_work;
258 struct delayed_work ad_work;
5a37e8ca 259 struct delayed_work mcast_work;
305d552a
BH		 260#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
261 struct in6_addr master_ipv6;
262#endif
f073c7ca
TI		 263#ifdef CONFIG_DEBUG_FS
264 /* debugging suport via debugfs */
265 struct dentry *debug_dir;
266#endif /* CONFIG_DEBUG_FS */
1da177e4
LT		 267};
268
269/**
270 * Returns NULL if the net_device does not belong to any of the bond's slaves
271 *
272 * Caller must hold bond lock for read
273 */
4ec952b8 274static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
275 struct net_device *slave_dev)
1da177e4
LT		 276{
277 struct slave *slave = NULL;
278 int i;
279
280 bond_for_each_slave(bond, slave, i) {
281 if (slave->dev == slave_dev) {
af3e5bd5 282 return slave;
1da177e4
LT		 283 }
284 }
285
4ec952b8 286 return NULL;
1da177e4
LT		 287}
288
cceb904f 289static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
1da177e4
LT		 290{
291 if (!slave || !slave->dev->master) {
292 return NULL;
293 }
294
c04914af 295 return netdev_priv(slave->dev->master);
1da177e4
LT		 296}
297
58402054
HE		 298static inline bool bond_is_lb(const struct bonding *bond)
299{
8e95a202
JP		 300 return (bond->params.mode == BOND_MODE_TLB ||
301 bond->params.mode == BOND_MODE_ALB);
58402054
HE		 302}
303
a549952a
JP		 304#define BOND_PRI_RESELECT_ALWAYS 0
305#define BOND_PRI_RESELECT_BETTER 1
306#define BOND_PRI_RESELECT_FAILURE 2
307
3915c1e8
JV		 308#define BOND_FOM_NONE 0
309#define BOND_FOM_ACTIVE 1
310#define BOND_FOM_FOLLOW 2
311
f5b2b966
JV		 312#define BOND_ARP_VALIDATE_NONE 0
313#define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
314#define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
315#define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
316 BOND_ARP_VALIDATE_BACKUP)
317
079ca7da
AB		 318static inline int slave_do_arp_validate(struct bonding *bond,
319 struct slave *slave)
f5b2b966
JV		 320{
321 return bond->params.arp_validate & (1 << slave->state);
322}
323
079ca7da 324static inline unsigned long slave_last_rx(struct bonding *bond,
f8a8ccd5 325 struct slave *slave)
f5b2b966
JV		 326{
327 if (slave_do_arp_validate(bond, slave))
328 return slave->last_arp_rx;
329
330 return slave->dev->last_rx;
331}
332
8a8efa22
AW		 333#ifdef CONFIG_NET_POLL_CONTROLLER
334static inline void bond_netpoll_send_skb(const struct slave *slave,
335 struct sk_buff *skb)
336{
337 struct netpoll *np = slave->np;
338
339 if (np)
340 netpoll_send_skb(np, skb);
341}
342#else
343static inline void bond_netpoll_send_skb(const struct slave *slave,
344 struct sk_buff *skb)
345{
346}
347#endif
348
cceb904f 349static inline void bond_set_slave_inactive_flags(struct slave *slave)
1da177e4 350{
454d7c9b 351 struct bonding *bond = netdev_priv(slave->dev->master);
ae63e808 352 if (!bond_is_lb(bond))
8f903c70 353 slave->state = BOND_STATE_BACKUP;
ebd8e497
AG		 354 if (!bond->params.all_slaves_active)
355 slave->dev->priv_flags |= IFF_SLAVE_INACTIVE;
f5b2b966
JV		 356 if (slave_do_arp_validate(bond, slave))
357 slave->dev->priv_flags |= IFF_SLAVE_NEEDARP;
1da177e4
LT		 358}
359
cceb904f 360static inline void bond_set_slave_active_flags(struct slave *slave)
1da177e4
LT		 361{
362 slave->state = BOND_STATE_ACTIVE;
f5b2b966 363 slave->dev->priv_flags &= ~(IFF_SLAVE_INACTIVE | IFF_SLAVE_NEEDARP);
8f903c70
JV		 364}
365
366static inline void bond_set_master_3ad_flags(struct bonding *bond)
367{
368 bond->dev->priv_flags |= IFF_MASTER_8023AD;
369}
370
371static inline void bond_unset_master_3ad_flags(struct bonding *bond)
372{
373 bond->dev->priv_flags &= ~IFF_MASTER_8023AD;
374}
375
376static inline void bond_set_master_alb_flags(struct bonding *bond)
377{
378 bond->dev->priv_flags |= IFF_MASTER_ALB;
379}
380
381static inline void bond_unset_master_alb_flags(struct bonding *bond)
382{
383 bond->dev->priv_flags &= ~IFF_MASTER_ALB;
1da177e4
LT		 384}
385
386struct vlan_entry *bond_next_vlan(struct bonding *bond, struct vlan_entry *curr);
387int bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
ec87fd3b 388int bond_create(struct net *net, const char *name);
b76cdba9
MW		 389int bond_create_sysfs(void);
390void bond_destroy_sysfs(void);
6151b3d4 391void bond_prepare_sysfs_group(struct bonding *bond);
b76cdba9
MW		 392int bond_create_slave_symlinks(struct net_device *master, struct net_device *slave);
393void bond_destroy_slave_symlinks(struct net_device *master, struct net_device *slave);
a77b5325
MW		 394int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
395int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
1b76b316
JV		 396void bond_mii_monitor(struct work_struct *);
397void bond_loadbalance_arp_mon(struct work_struct *);
398void bond_activebackup_arp_mon(struct work_struct *);
a77b5325 399void bond_set_mode_ops(struct bonding *bond, int mode);
325dcf7a 400int bond_parse_parm(const char *mode_arg, const struct bond_parm_tbl *tbl);
a77b5325
MW		 401void bond_select_active_slave(struct bonding *bond);
402void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
f5b2b966
JV		 403void bond_register_arp(struct bonding *);
404void bond_unregister_arp(struct bonding *);
f073c7ca
TI		 405void bond_create_debugfs(void);
406void bond_destroy_debugfs(void);
407void bond_debug_register(struct bonding *bond);
408void bond_debug_unregister(struct bonding *bond);
409void bond_debug_reregister(struct bonding *bond);
1da177e4 410
ec87fd3b
EB		 411struct bond_net {
412 struct net * net; /* Associated network namespace */
413 struct list_head dev_list;
414#ifdef CONFIG_PROC_FS
415 struct proc_dir_entry * proc_dir;
416#endif
417};
418
bd33acc3
AW		 419#ifdef CONFIG_PROC_FS
420void bond_create_proc_entry(struct bonding *bond);
421void bond_remove_proc_entry(struct bonding *bond);
422void bond_create_proc_dir(struct bond_net *bn);
423void bond_destroy_proc_dir(struct bond_net *bn);
424#else
425static inline void bond_create_proc_entry(struct bonding *bond)
426{
427}
428
429static inline void bond_remove_proc_entry(struct bonding *bond)
430{
431}
432
433static inline void bond_create_proc_dir(struct bond_net *bn)
434{
435}
436
437static inline void bond_destroy_proc_dir(struct bond_net *bn)
438{
439}
440#endif
441
442
b2259672 443/* exported from bond_main.c */
ec87fd3b 444extern int bond_net_id;
e97fd7c6
HE		 445extern const struct bond_parm_tbl bond_lacp_tbl[];
446extern const struct bond_parm_tbl bond_mode_tbl[];
447extern const struct bond_parm_tbl xmit_hashtype_tbl[];
448extern const struct bond_parm_tbl arp_validate_tbl[];
449extern const struct bond_parm_tbl fail_over_mac_tbl[];
a549952a 450extern const struct bond_parm_tbl pri_reselect_tbl[];
b06715b7
HE		 451extern struct bond_parm_tbl ad_select_tbl[];
452
305d552a
BH		 453#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
454void bond_send_unsolicited_na(struct bonding *bond);
455void bond_register_ipv6_notifier(void);
456void bond_unregister_ipv6_notifier(void);
457#else
458static inline void bond_send_unsolicited_na(struct bonding *bond)
459{
460 return;
461}
462static inline void bond_register_ipv6_notifier(void)
463{
464 return;
465}
466static inline void bond_unregister_ipv6_notifier(void)
467{
468 return;
469}
470#endif
471
1da177e4 472#endif /* _LINUX_BONDING_H */
Linux 6.x block layer and io_uring tree(s)