Linux 4.16.11
[linux/fpc-iii.git] / include / net / bonding.h
blobb522351588360107d8eeb25c7ff4670f78b5cbd6
1 /*
2 * Bond several ethernet interfaces into a Cisco, running 'Etherchannel'.
4 * Portions are (c) Copyright 1995 Simon "Guru Aleph-Null" Janes
5 * NCM: Network and Communications Management, Inc.
7 * BUT, I'm the one who modified it for ethernet, so:
8 * (c) Copyright 1999, Thomas Davis, tadavis@lbl.gov
10 * This software may be used and distributed according to the terms
11 * of the GNU Public License, incorporated herein by reference.
15 #ifndef _NET_BONDING_H
16 #define _NET_BONDING_H
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 <linux/etherdevice.h>
26 #include <linux/reciprocal_div.h>
27 #include <linux/if_link.h>
29 #include <net/bond_3ad.h>
30 #include <net/bond_alb.h>
31 #include <net/bond_options.h>
33 #define BOND_MAX_ARP_TARGETS 16
35 #define BOND_DEFAULT_MIIMON 100
37 #ifndef __long_aligned
38 #define __long_aligned __attribute__((aligned((sizeof(long)))))
39 #endif
41 #define BOND_MODE(bond) ((bond)->params.mode)
43 /* slave list primitives */
44 #define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
46 #define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
48 /* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
49 #define bond_first_slave(bond) \
50 (bond_has_slaves(bond) ? \
51 netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
52 NULL)
53 #define bond_last_slave(bond) \
54 (bond_has_slaves(bond) ? \
55 netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
56 NULL)
58 /* Caller must have rcu_read_lock */
59 #define bond_first_slave_rcu(bond) \
60 netdev_lower_get_first_private_rcu(bond->dev)
62 #define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
63 #define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
65 /**
66 * bond_for_each_slave - iterate over all slaves
67 * @bond: the bond holding this list
68 * @pos: current slave
69 * @iter: list_head * iterator
71 * Caller must hold RTNL
73 #define bond_for_each_slave(bond, pos, iter) \
74 netdev_for_each_lower_private((bond)->dev, pos, iter)
76 /* Caller must have rcu_read_lock */
77 #define bond_for_each_slave_rcu(bond, pos, iter) \
78 netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
80 #ifdef CONFIG_NET_POLL_CONTROLLER
81 extern atomic_t netpoll_block_tx;
83 static inline void block_netpoll_tx(void)
85 atomic_inc(&netpoll_block_tx);
88 static inline void unblock_netpoll_tx(void)
90 atomic_dec(&netpoll_block_tx);
93 static inline int is_netpoll_tx_blocked(struct net_device *dev)
95 if (unlikely(netpoll_tx_running(dev)))
96 return atomic_read(&netpoll_block_tx);
97 return 0;
99 #else
100 #define block_netpoll_tx()
101 #define unblock_netpoll_tx()
102 #define is_netpoll_tx_blocked(dev) (0)
103 #endif
105 struct bond_params {
106 int mode;
107 int xmit_policy;
108 int miimon;
109 u8 num_peer_notif;
110 int arp_interval;
111 int arp_validate;
112 int arp_all_targets;
113 int use_carrier;
114 int fail_over_mac;
115 int updelay;
116 int downdelay;
117 int lacp_fast;
118 unsigned int min_links;
119 int ad_select;
120 char primary[IFNAMSIZ];
121 int primary_reselect;
122 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
123 int tx_queues;
124 int all_slaves_active;
125 int resend_igmp;
126 int lp_interval;
127 int packets_per_slave;
128 int tlb_dynamic_lb;
129 struct reciprocal_value reciprocal_packets_per_slave;
130 u16 ad_actor_sys_prio;
131 u16 ad_user_port_key;
133 /* 2 bytes of padding : see ether_addr_equal_64bits() */
134 u8 ad_actor_system[ETH_ALEN + 2];
137 struct bond_parm_tbl {
138 char *modename;
139 int mode;
142 struct netdev_notify_work {
143 struct delayed_work work;
144 struct net_device *dev;
145 struct netdev_bonding_info bonding_info;
148 struct slave {
149 struct net_device *dev; /* first - useful for panic debug */
150 struct bonding *bond; /* our master */
151 int delay;
152 /* all three in jiffies */
153 unsigned long last_link_up;
154 unsigned long last_rx;
155 unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
156 s8 link; /* one of BOND_LINK_XXXX */
157 s8 link_new_state; /* one of BOND_LINK_XXXX */
158 s8 new_link;
159 u8 backup:1, /* indicates backup slave. Value corresponds with
160 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
161 inactive:1, /* indicates inactive slave */
162 should_notify:1, /* indicates whether the state changed */
163 should_notify_link:1; /* indicates whether the link changed */
164 u8 duplex;
165 u32 original_mtu;
166 u32 link_failure_count;
167 u32 speed;
168 u16 queue_id;
169 u8 perm_hwaddr[MAX_ADDR_LEN];
170 struct ad_slave_info *ad_info;
171 struct tlb_slave_info tlb_info;
172 #ifdef CONFIG_NET_POLL_CONTROLLER
173 struct netpoll *np;
174 #endif
175 struct kobject kobj;
176 struct rtnl_link_stats64 slave_stats;
179 struct bond_up_slave {
180 unsigned int count;
181 struct rcu_head rcu;
182 struct slave *arr[0];
186 * Link pseudo-state only used internally by monitors
188 #define BOND_LINK_NOCHANGE -1
191 * Here are the locking policies for the two bonding locks:
192 * Get rcu_read_lock when reading or RTNL when writing slave list.
194 struct bonding {
195 struct net_device *dev; /* first - useful for panic debug */
196 struct slave __rcu *curr_active_slave;
197 struct slave __rcu *current_arp_slave;
198 struct slave __rcu *primary_slave;
199 struct bond_up_slave __rcu *slave_arr; /* Array of usable slaves */
200 bool force_primary;
201 u32 nest_level;
202 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
203 int (*recv_probe)(const struct sk_buff *, struct bonding *,
204 struct slave *);
205 /* mode_lock is used for mode-specific locking needs, currently used by:
206 * 3ad mode (4) - protect against running bond_3ad_unbind_slave() and
207 * bond_3ad_state_machine_handler() concurrently and also
208 * the access to the state machine shared variables.
209 * TLB mode (5) - to sync the use and modifications of its hash table
210 * ALB mode (6) - to sync the use and modifications of its hash table
212 spinlock_t mode_lock;
213 spinlock_t stats_lock;
214 u8 send_peer_notif;
215 u8 igmp_retrans;
216 #ifdef CONFIG_PROC_FS
217 struct proc_dir_entry *proc_entry;
218 char proc_file_name[IFNAMSIZ];
219 #endif /* CONFIG_PROC_FS */
220 struct list_head bond_list;
221 u32 rr_tx_counter;
222 struct ad_bond_info ad_info;
223 struct alb_bond_info alb_info;
224 struct bond_params params;
225 struct workqueue_struct *wq;
226 struct delayed_work mii_work;
227 struct delayed_work arp_work;
228 struct delayed_work alb_work;
229 struct delayed_work ad_work;
230 struct delayed_work mcast_work;
231 struct delayed_work slave_arr_work;
232 #ifdef CONFIG_DEBUG_FS
233 /* debugging support via debugfs */
234 struct dentry *debug_dir;
235 #endif /* CONFIG_DEBUG_FS */
236 struct rtnl_link_stats64 bond_stats;
239 #define bond_slave_get_rcu(dev) \
240 ((struct slave *) rcu_dereference(dev->rx_handler_data))
242 #define bond_slave_get_rtnl(dev) \
243 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
245 void bond_queue_slave_event(struct slave *slave);
246 void bond_lower_state_changed(struct slave *slave);
248 struct bond_vlan_tag {
249 __be16 vlan_proto;
250 unsigned short vlan_id;
254 * Returns NULL if the net_device does not belong to any of the bond's slaves
256 * Caller must hold bond lock for read
258 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
259 struct net_device *slave_dev)
261 return netdev_lower_dev_get_private(bond->dev, slave_dev);
264 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
266 return slave->bond;
269 static inline bool bond_should_override_tx_queue(struct bonding *bond)
271 return BOND_MODE(bond) == BOND_MODE_ACTIVEBACKUP ||
272 BOND_MODE(bond) == BOND_MODE_ROUNDROBIN;
275 static inline bool bond_is_lb(const struct bonding *bond)
277 return BOND_MODE(bond) == BOND_MODE_TLB ||
278 BOND_MODE(bond) == BOND_MODE_ALB;
281 static inline bool bond_needs_speed_duplex(const struct bonding *bond)
283 return BOND_MODE(bond) == BOND_MODE_8023AD || bond_is_lb(bond);
286 static inline bool bond_is_nondyn_tlb(const struct bonding *bond)
288 return (BOND_MODE(bond) == BOND_MODE_TLB) &&
289 (bond->params.tlb_dynamic_lb == 0);
292 static inline bool bond_mode_uses_xmit_hash(const struct bonding *bond)
294 return (BOND_MODE(bond) == BOND_MODE_8023AD ||
295 BOND_MODE(bond) == BOND_MODE_XOR ||
296 bond_is_nondyn_tlb(bond));
299 static inline bool bond_mode_uses_arp(int mode)
301 return mode != BOND_MODE_8023AD && mode != BOND_MODE_TLB &&
302 mode != BOND_MODE_ALB;
305 static inline bool bond_mode_uses_primary(int mode)
307 return mode == BOND_MODE_ACTIVEBACKUP || mode == BOND_MODE_TLB ||
308 mode == BOND_MODE_ALB;
311 static inline bool bond_uses_primary(struct bonding *bond)
313 return bond_mode_uses_primary(BOND_MODE(bond));
316 static inline struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond)
318 struct slave *slave = rcu_dereference(bond->curr_active_slave);
320 return bond_uses_primary(bond) && slave ? slave->dev : NULL;
323 static inline bool bond_slave_is_up(struct slave *slave)
325 return netif_running(slave->dev) && netif_carrier_ok(slave->dev);
328 static inline void bond_set_active_slave(struct slave *slave)
330 if (slave->backup) {
331 slave->backup = 0;
332 bond_queue_slave_event(slave);
333 bond_lower_state_changed(slave);
337 static inline void bond_set_backup_slave(struct slave *slave)
339 if (!slave->backup) {
340 slave->backup = 1;
341 bond_queue_slave_event(slave);
342 bond_lower_state_changed(slave);
346 static inline void bond_set_slave_state(struct slave *slave,
347 int slave_state, bool notify)
349 if (slave->backup == slave_state)
350 return;
352 slave->backup = slave_state;
353 if (notify) {
354 bond_lower_state_changed(slave);
355 bond_queue_slave_event(slave);
356 slave->should_notify = 0;
357 } else {
358 if (slave->should_notify)
359 slave->should_notify = 0;
360 else
361 slave->should_notify = 1;
365 static inline void bond_slave_state_change(struct bonding *bond)
367 struct list_head *iter;
368 struct slave *tmp;
370 bond_for_each_slave(bond, tmp, iter) {
371 if (tmp->link == BOND_LINK_UP)
372 bond_set_active_slave(tmp);
373 else if (tmp->link == BOND_LINK_DOWN)
374 bond_set_backup_slave(tmp);
378 static inline void bond_slave_state_notify(struct bonding *bond)
380 struct list_head *iter;
381 struct slave *tmp;
383 bond_for_each_slave(bond, tmp, iter) {
384 if (tmp->should_notify) {
385 bond_lower_state_changed(tmp);
386 tmp->should_notify = 0;
391 static inline int bond_slave_state(struct slave *slave)
393 return slave->backup;
396 static inline bool bond_is_active_slave(struct slave *slave)
398 return !bond_slave_state(slave);
401 static inline bool bond_slave_can_tx(struct slave *slave)
403 return bond_slave_is_up(slave) && slave->link == BOND_LINK_UP &&
404 bond_is_active_slave(slave);
407 static inline void bond_hw_addr_copy(u8 *dst, const u8 *src, unsigned int len)
409 if (len == ETH_ALEN) {
410 ether_addr_copy(dst, src);
411 return;
414 memcpy(dst, src, len);
417 #define BOND_PRI_RESELECT_ALWAYS 0
418 #define BOND_PRI_RESELECT_BETTER 1
419 #define BOND_PRI_RESELECT_FAILURE 2
421 #define BOND_FOM_NONE 0
422 #define BOND_FOM_ACTIVE 1
423 #define BOND_FOM_FOLLOW 2
425 #define BOND_ARP_TARGETS_ANY 0
426 #define BOND_ARP_TARGETS_ALL 1
428 #define BOND_ARP_VALIDATE_NONE 0
429 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
430 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
431 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
432 BOND_ARP_VALIDATE_BACKUP)
433 #define BOND_ARP_FILTER (BOND_ARP_VALIDATE_ALL + 1)
434 #define BOND_ARP_FILTER_ACTIVE (BOND_ARP_VALIDATE_ACTIVE | \
435 BOND_ARP_FILTER)
436 #define BOND_ARP_FILTER_BACKUP (BOND_ARP_VALIDATE_BACKUP | \
437 BOND_ARP_FILTER)
439 #define BOND_SLAVE_NOTIFY_NOW true
440 #define BOND_SLAVE_NOTIFY_LATER false
442 static inline int slave_do_arp_validate(struct bonding *bond,
443 struct slave *slave)
445 return bond->params.arp_validate & (1 << bond_slave_state(slave));
448 static inline int slave_do_arp_validate_only(struct bonding *bond)
450 return bond->params.arp_validate & BOND_ARP_FILTER;
453 static inline int bond_is_ip_target_ok(__be32 addr)
455 return !ipv4_is_lbcast(addr) && !ipv4_is_zeronet(addr);
458 /* Get the oldest arp which we've received on this slave for bond's
459 * arp_targets.
461 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
462 struct slave *slave)
464 int i = 1;
465 unsigned long ret = slave->target_last_arp_rx[0];
467 for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
468 if (time_before(slave->target_last_arp_rx[i], ret))
469 ret = slave->target_last_arp_rx[i];
471 return ret;
474 static inline unsigned long slave_last_rx(struct bonding *bond,
475 struct slave *slave)
477 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
478 return slave_oldest_target_arp_rx(bond, slave);
480 return slave->last_rx;
483 #ifdef CONFIG_NET_POLL_CONTROLLER
484 static inline void bond_netpoll_send_skb(const struct slave *slave,
485 struct sk_buff *skb)
487 struct netpoll *np = slave->np;
489 if (np)
490 netpoll_send_skb(np, skb);
492 #else
493 static inline void bond_netpoll_send_skb(const struct slave *slave,
494 struct sk_buff *skb)
497 #endif
499 static inline void bond_set_slave_inactive_flags(struct slave *slave,
500 bool notify)
502 if (!bond_is_lb(slave->bond))
503 bond_set_slave_state(slave, BOND_STATE_BACKUP, notify);
504 if (!slave->bond->params.all_slaves_active)
505 slave->inactive = 1;
508 static inline void bond_set_slave_active_flags(struct slave *slave,
509 bool notify)
511 bond_set_slave_state(slave, BOND_STATE_ACTIVE, notify);
512 slave->inactive = 0;
515 static inline bool bond_is_slave_inactive(struct slave *slave)
517 return slave->inactive;
520 static inline void bond_propose_link_state(struct slave *slave, int state)
522 slave->link_new_state = state;
525 static inline void bond_commit_link_state(struct slave *slave, bool notify)
527 if (slave->link == slave->link_new_state)
528 return;
530 slave->link = slave->link_new_state;
531 if (notify) {
532 bond_queue_slave_event(slave);
533 bond_lower_state_changed(slave);
534 slave->should_notify_link = 0;
535 } else {
536 if (slave->should_notify_link)
537 slave->should_notify_link = 0;
538 else
539 slave->should_notify_link = 1;
543 static inline void bond_set_slave_link_state(struct slave *slave, int state,
544 bool notify)
546 bond_propose_link_state(slave, state);
547 bond_commit_link_state(slave, notify);
550 static inline void bond_slave_link_notify(struct bonding *bond)
552 struct list_head *iter;
553 struct slave *tmp;
555 bond_for_each_slave(bond, tmp, iter) {
556 if (tmp->should_notify_link) {
557 bond_queue_slave_event(tmp);
558 bond_lower_state_changed(tmp);
559 tmp->should_notify_link = 0;
564 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
566 struct in_device *in_dev;
567 __be32 addr = 0;
569 rcu_read_lock();
570 in_dev = __in_dev_get_rcu(dev);
572 if (in_dev)
573 addr = inet_confirm_addr(dev_net(dev), in_dev, dst, local,
574 RT_SCOPE_HOST);
575 rcu_read_unlock();
576 return addr;
579 struct bond_net {
580 struct net *net; /* Associated network namespace */
581 struct list_head dev_list;
582 #ifdef CONFIG_PROC_FS
583 struct proc_dir_entry *proc_dir;
584 #endif
585 struct class_attribute class_attr_bonding_masters;
588 int bond_arp_rcv(const struct sk_buff *skb, struct bonding *bond, struct slave *slave);
589 void bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
590 int bond_create(struct net *net, const char *name);
591 int bond_create_sysfs(struct bond_net *net);
592 void bond_destroy_sysfs(struct bond_net *net);
593 void bond_prepare_sysfs_group(struct bonding *bond);
594 int bond_sysfs_slave_add(struct slave *slave);
595 void bond_sysfs_slave_del(struct slave *slave);
596 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev,
597 struct netlink_ext_ack *extack);
598 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
599 u32 bond_xmit_hash(struct bonding *bond, struct sk_buff *skb);
600 int bond_set_carrier(struct bonding *bond);
601 void bond_select_active_slave(struct bonding *bond);
602 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
603 void bond_create_debugfs(void);
604 void bond_destroy_debugfs(void);
605 void bond_debug_register(struct bonding *bond);
606 void bond_debug_unregister(struct bonding *bond);
607 void bond_debug_reregister(struct bonding *bond);
608 const char *bond_mode_name(int mode);
609 void bond_setup(struct net_device *bond_dev);
610 unsigned int bond_get_num_tx_queues(void);
611 int bond_netlink_init(void);
612 void bond_netlink_fini(void);
613 struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond);
614 const char *bond_slave_link_status(s8 link);
615 struct bond_vlan_tag *bond_verify_device_path(struct net_device *start_dev,
616 struct net_device *end_dev,
617 int level);
618 int bond_update_slave_arr(struct bonding *bond, struct slave *skipslave);
619 void bond_slave_arr_work_rearm(struct bonding *bond, unsigned long delay);
620 void bond_work_init_all(struct bonding *bond);
622 #ifdef CONFIG_PROC_FS
623 void bond_create_proc_entry(struct bonding *bond);
624 void bond_remove_proc_entry(struct bonding *bond);
625 void bond_create_proc_dir(struct bond_net *bn);
626 void bond_destroy_proc_dir(struct bond_net *bn);
627 #else
628 static inline void bond_create_proc_entry(struct bonding *bond)
632 static inline void bond_remove_proc_entry(struct bonding *bond)
636 static inline void bond_create_proc_dir(struct bond_net *bn)
640 static inline void bond_destroy_proc_dir(struct bond_net *bn)
643 #endif
645 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
646 const u8 *mac)
648 struct list_head *iter;
649 struct slave *tmp;
651 bond_for_each_slave(bond, tmp, iter)
652 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
653 return tmp;
655 return NULL;
658 /* Caller must hold rcu_read_lock() for read */
659 static inline struct slave *bond_slave_has_mac_rcu(struct bonding *bond,
660 const u8 *mac)
662 struct list_head *iter;
663 struct slave *tmp;
665 bond_for_each_slave_rcu(bond, tmp, iter)
666 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
667 return tmp;
669 return NULL;
672 /* Caller must hold rcu_read_lock() for read */
673 static inline bool bond_slave_has_mac_rx(struct bonding *bond, const u8 *mac)
675 struct list_head *iter;
676 struct slave *tmp;
677 struct netdev_hw_addr *ha;
679 bond_for_each_slave_rcu(bond, tmp, iter)
680 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
681 return true;
683 if (netdev_uc_empty(bond->dev))
684 return false;
686 netdev_for_each_uc_addr(ha, bond->dev)
687 if (ether_addr_equal_64bits(mac, ha->addr))
688 return true;
690 return false;
693 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
694 * Returns -1 if not found, index if found
696 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
698 int i;
700 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
701 if (targets[i] == ip)
702 return i;
703 else if (targets[i] == 0)
704 break;
706 return -1;
709 /* exported from bond_main.c */
710 extern unsigned int bond_net_id;
711 extern const struct bond_parm_tbl bond_lacp_tbl[];
712 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
713 extern const struct bond_parm_tbl arp_validate_tbl[];
714 extern const struct bond_parm_tbl arp_all_targets_tbl[];
715 extern const struct bond_parm_tbl fail_over_mac_tbl[];
716 extern const struct bond_parm_tbl pri_reselect_tbl[];
717 extern struct bond_parm_tbl ad_select_tbl[];
719 /* exported from bond_netlink.c */
720 extern struct rtnl_link_ops bond_link_ops;
722 static inline void bond_tx_drop(struct net_device *dev, struct sk_buff *skb)
724 atomic_long_inc(&dev->tx_dropped);
725 dev_kfree_skb_any(skb);
728 #endif /* _NET_BONDING_H */