dt-bindings: Document rk3399 rk-timer bindings
[linux/fpc-iii.git] / include / net / bonding.h
blob791800ddd6d90de23d7b7acea7a91e500e646eda
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
38 * Less bad way to call ioctl from within the kernel; this needs to be
39 * done some other way to get the call out of interrupt context.
40 * Needs "ioctl" variable to be supplied by calling context.
42 #define IOCTL(dev, arg, cmd) ({ \
43 int res = 0; \
44 mm_segment_t fs = get_fs(); \
45 set_fs(get_ds()); \
46 res = ioctl(dev, arg, cmd); \
47 set_fs(fs); \
48 res; })
50 #define BOND_MODE(bond) ((bond)->params.mode)
52 /* slave list primitives */
53 #define bond_slave_list(bond) (&(bond)->dev->adj_list.lower)
55 #define bond_has_slaves(bond) !list_empty(bond_slave_list(bond))
57 /* IMPORTANT: bond_first/last_slave can return NULL in case of an empty list */
58 #define bond_first_slave(bond) \
59 (bond_has_slaves(bond) ? \
60 netdev_adjacent_get_private(bond_slave_list(bond)->next) : \
61 NULL)
62 #define bond_last_slave(bond) \
63 (bond_has_slaves(bond) ? \
64 netdev_adjacent_get_private(bond_slave_list(bond)->prev) : \
65 NULL)
67 /* Caller must have rcu_read_lock */
68 #define bond_first_slave_rcu(bond) \
69 netdev_lower_get_first_private_rcu(bond->dev)
71 #define bond_is_first_slave(bond, pos) (pos == bond_first_slave(bond))
72 #define bond_is_last_slave(bond, pos) (pos == bond_last_slave(bond))
74 /**
75 * bond_for_each_slave - iterate over all slaves
76 * @bond: the bond holding this list
77 * @pos: current slave
78 * @iter: list_head * iterator
80 * Caller must hold RTNL
82 #define bond_for_each_slave(bond, pos, iter) \
83 netdev_for_each_lower_private((bond)->dev, pos, iter)
85 /* Caller must have rcu_read_lock */
86 #define bond_for_each_slave_rcu(bond, pos, iter) \
87 netdev_for_each_lower_private_rcu((bond)->dev, pos, iter)
89 #ifdef CONFIG_NET_POLL_CONTROLLER
90 extern atomic_t netpoll_block_tx;
92 static inline void block_netpoll_tx(void)
94 atomic_inc(&netpoll_block_tx);
97 static inline void unblock_netpoll_tx(void)
99 atomic_dec(&netpoll_block_tx);
102 static inline int is_netpoll_tx_blocked(struct net_device *dev)
104 if (unlikely(netpoll_tx_running(dev)))
105 return atomic_read(&netpoll_block_tx);
106 return 0;
108 #else
109 #define block_netpoll_tx()
110 #define unblock_netpoll_tx()
111 #define is_netpoll_tx_blocked(dev) (0)
112 #endif
114 struct bond_params {
115 int mode;
116 int xmit_policy;
117 int miimon;
118 u8 num_peer_notif;
119 int arp_interval;
120 int arp_validate;
121 int arp_all_targets;
122 int use_carrier;
123 int fail_over_mac;
124 int updelay;
125 int downdelay;
126 int lacp_fast;
127 unsigned int min_links;
128 int ad_select;
129 char primary[IFNAMSIZ];
130 int primary_reselect;
131 __be32 arp_targets[BOND_MAX_ARP_TARGETS];
132 int tx_queues;
133 int all_slaves_active;
134 int resend_igmp;
135 int lp_interval;
136 int packets_per_slave;
137 int tlb_dynamic_lb;
138 struct reciprocal_value reciprocal_packets_per_slave;
139 u16 ad_actor_sys_prio;
140 u16 ad_user_port_key;
141 u8 ad_actor_system[ETH_ALEN];
144 struct bond_parm_tbl {
145 char *modename;
146 int mode;
149 struct netdev_notify_work {
150 struct delayed_work work;
151 struct net_device *dev;
152 struct netdev_bonding_info bonding_info;
155 struct slave {
156 struct net_device *dev; /* first - useful for panic debug */
157 struct bonding *bond; /* our master */
158 int delay;
159 /* all three in jiffies */
160 unsigned long last_link_up;
161 unsigned long last_rx;
162 unsigned long target_last_arp_rx[BOND_MAX_ARP_TARGETS];
163 s8 link; /* one of BOND_LINK_XXXX */
164 s8 new_link;
165 u8 backup:1, /* indicates backup slave. Value corresponds with
166 BOND_STATE_ACTIVE and BOND_STATE_BACKUP */
167 inactive:1, /* indicates inactive slave */
168 should_notify:1, /* indicates whether the state changed */
169 should_notify_link:1; /* indicates whether the link changed */
170 u8 duplex;
171 u32 original_mtu;
172 u32 link_failure_count;
173 u32 speed;
174 u16 queue_id;
175 u8 perm_hwaddr[ETH_ALEN];
176 struct ad_slave_info *ad_info;
177 struct tlb_slave_info tlb_info;
178 #ifdef CONFIG_NET_POLL_CONTROLLER
179 struct netpoll *np;
180 #endif
181 struct kobject kobj;
182 struct rtnl_link_stats64 slave_stats;
185 struct bond_up_slave {
186 unsigned int count;
187 struct rcu_head rcu;
188 struct slave *arr[0];
192 * Link pseudo-state only used internally by monitors
194 #define BOND_LINK_NOCHANGE -1
197 * Here are the locking policies for the two bonding locks:
198 * Get rcu_read_lock when reading or RTNL when writing slave list.
200 struct bonding {
201 struct net_device *dev; /* first - useful for panic debug */
202 struct slave __rcu *curr_active_slave;
203 struct slave __rcu *current_arp_slave;
204 struct slave __rcu *primary_slave;
205 struct bond_up_slave __rcu *slave_arr; /* Array of usable slaves */
206 bool force_primary;
207 s32 slave_cnt; /* never change this value outside the attach/detach wrappers */
208 int (*recv_probe)(const struct sk_buff *, struct bonding *,
209 struct slave *);
210 /* mode_lock is used for mode-specific locking needs, currently used by:
211 * 3ad mode (4) - protect against running bond_3ad_unbind_slave() and
212 * bond_3ad_state_machine_handler() concurrently and also
213 * the access to the state machine shared variables.
214 * TLB mode (5) - to sync the use and modifications of its hash table
215 * ALB mode (6) - to sync the use and modifications of its hash table
217 spinlock_t mode_lock;
218 spinlock_t stats_lock;
219 u8 send_peer_notif;
220 u8 igmp_retrans;
221 #ifdef CONFIG_PROC_FS
222 struct proc_dir_entry *proc_entry;
223 char proc_file_name[IFNAMSIZ];
224 #endif /* CONFIG_PROC_FS */
225 struct list_head bond_list;
226 u32 rr_tx_counter;
227 struct ad_bond_info ad_info;
228 struct alb_bond_info alb_info;
229 struct bond_params params;
230 struct workqueue_struct *wq;
231 struct delayed_work mii_work;
232 struct delayed_work arp_work;
233 struct delayed_work alb_work;
234 struct delayed_work ad_work;
235 struct delayed_work mcast_work;
236 struct delayed_work slave_arr_work;
237 #ifdef CONFIG_DEBUG_FS
238 /* debugging support via debugfs */
239 struct dentry *debug_dir;
240 #endif /* CONFIG_DEBUG_FS */
241 struct rtnl_link_stats64 bond_stats;
244 #define bond_slave_get_rcu(dev) \
245 ((struct slave *) rcu_dereference(dev->rx_handler_data))
247 #define bond_slave_get_rtnl(dev) \
248 ((struct slave *) rtnl_dereference(dev->rx_handler_data))
250 void bond_queue_slave_event(struct slave *slave);
251 void bond_lower_state_changed(struct slave *slave);
253 struct bond_vlan_tag {
254 __be16 vlan_proto;
255 unsigned short vlan_id;
259 * Returns NULL if the net_device does not belong to any of the bond's slaves
261 * Caller must hold bond lock for read
263 static inline struct slave *bond_get_slave_by_dev(struct bonding *bond,
264 struct net_device *slave_dev)
266 return netdev_lower_dev_get_private(bond->dev, slave_dev);
269 static inline struct bonding *bond_get_bond_by_slave(struct slave *slave)
271 return slave->bond;
274 static inline bool bond_should_override_tx_queue(struct bonding *bond)
276 return BOND_MODE(bond) == BOND_MODE_ACTIVEBACKUP ||
277 BOND_MODE(bond) == BOND_MODE_ROUNDROBIN;
280 static inline bool bond_is_lb(const struct bonding *bond)
282 return BOND_MODE(bond) == BOND_MODE_TLB ||
283 BOND_MODE(bond) == BOND_MODE_ALB;
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);
334 rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
338 static inline void bond_set_backup_slave(struct slave *slave)
340 if (!slave->backup) {
341 slave->backup = 1;
342 bond_queue_slave_event(slave);
343 bond_lower_state_changed(slave);
344 rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
348 static inline void bond_set_slave_state(struct slave *slave,
349 int slave_state, bool notify)
351 if (slave->backup == slave_state)
352 return;
354 slave->backup = slave_state;
355 if (notify) {
356 bond_lower_state_changed(slave);
357 rtmsg_ifinfo(RTM_NEWLINK, slave->dev, 0, GFP_ATOMIC);
358 bond_queue_slave_event(slave);
359 slave->should_notify = 0;
360 } else {
361 if (slave->should_notify)
362 slave->should_notify = 0;
363 else
364 slave->should_notify = 1;
368 static inline void bond_slave_state_change(struct bonding *bond)
370 struct list_head *iter;
371 struct slave *tmp;
373 bond_for_each_slave(bond, tmp, iter) {
374 if (tmp->link == BOND_LINK_UP)
375 bond_set_active_slave(tmp);
376 else if (tmp->link == BOND_LINK_DOWN)
377 bond_set_backup_slave(tmp);
381 static inline void bond_slave_state_notify(struct bonding *bond)
383 struct list_head *iter;
384 struct slave *tmp;
386 bond_for_each_slave(bond, tmp, iter) {
387 if (tmp->should_notify) {
388 bond_lower_state_changed(tmp);
389 rtmsg_ifinfo(RTM_NEWLINK, tmp->dev, 0, GFP_ATOMIC);
390 tmp->should_notify = 0;
395 static inline int bond_slave_state(struct slave *slave)
397 return slave->backup;
400 static inline bool bond_is_active_slave(struct slave *slave)
402 return !bond_slave_state(slave);
405 static inline bool bond_slave_can_tx(struct slave *slave)
407 return bond_slave_is_up(slave) && slave->link == BOND_LINK_UP &&
408 bond_is_active_slave(slave);
411 #define BOND_PRI_RESELECT_ALWAYS 0
412 #define BOND_PRI_RESELECT_BETTER 1
413 #define BOND_PRI_RESELECT_FAILURE 2
415 #define BOND_FOM_NONE 0
416 #define BOND_FOM_ACTIVE 1
417 #define BOND_FOM_FOLLOW 2
419 #define BOND_ARP_TARGETS_ANY 0
420 #define BOND_ARP_TARGETS_ALL 1
422 #define BOND_ARP_VALIDATE_NONE 0
423 #define BOND_ARP_VALIDATE_ACTIVE (1 << BOND_STATE_ACTIVE)
424 #define BOND_ARP_VALIDATE_BACKUP (1 << BOND_STATE_BACKUP)
425 #define BOND_ARP_VALIDATE_ALL (BOND_ARP_VALIDATE_ACTIVE | \
426 BOND_ARP_VALIDATE_BACKUP)
427 #define BOND_ARP_FILTER (BOND_ARP_VALIDATE_ALL + 1)
428 #define BOND_ARP_FILTER_ACTIVE (BOND_ARP_VALIDATE_ACTIVE | \
429 BOND_ARP_FILTER)
430 #define BOND_ARP_FILTER_BACKUP (BOND_ARP_VALIDATE_BACKUP | \
431 BOND_ARP_FILTER)
433 #define BOND_SLAVE_NOTIFY_NOW true
434 #define BOND_SLAVE_NOTIFY_LATER false
436 static inline int slave_do_arp_validate(struct bonding *bond,
437 struct slave *slave)
439 return bond->params.arp_validate & (1 << bond_slave_state(slave));
442 static inline int slave_do_arp_validate_only(struct bonding *bond)
444 return bond->params.arp_validate & BOND_ARP_FILTER;
447 static inline int bond_is_ip_target_ok(__be32 addr)
449 return !ipv4_is_lbcast(addr) && !ipv4_is_zeronet(addr);
452 /* Get the oldest arp which we've received on this slave for bond's
453 * arp_targets.
455 static inline unsigned long slave_oldest_target_arp_rx(struct bonding *bond,
456 struct slave *slave)
458 int i = 1;
459 unsigned long ret = slave->target_last_arp_rx[0];
461 for (; (i < BOND_MAX_ARP_TARGETS) && bond->params.arp_targets[i]; i++)
462 if (time_before(slave->target_last_arp_rx[i], ret))
463 ret = slave->target_last_arp_rx[i];
465 return ret;
468 static inline unsigned long slave_last_rx(struct bonding *bond,
469 struct slave *slave)
471 if (bond->params.arp_all_targets == BOND_ARP_TARGETS_ALL)
472 return slave_oldest_target_arp_rx(bond, slave);
474 return slave->last_rx;
477 #ifdef CONFIG_NET_POLL_CONTROLLER
478 static inline void bond_netpoll_send_skb(const struct slave *slave,
479 struct sk_buff *skb)
481 struct netpoll *np = slave->np;
483 if (np)
484 netpoll_send_skb(np, skb);
486 #else
487 static inline void bond_netpoll_send_skb(const struct slave *slave,
488 struct sk_buff *skb)
491 #endif
493 static inline void bond_set_slave_inactive_flags(struct slave *slave,
494 bool notify)
496 if (!bond_is_lb(slave->bond))
497 bond_set_slave_state(slave, BOND_STATE_BACKUP, notify);
498 if (!slave->bond->params.all_slaves_active)
499 slave->inactive = 1;
502 static inline void bond_set_slave_active_flags(struct slave *slave,
503 bool notify)
505 bond_set_slave_state(slave, BOND_STATE_ACTIVE, notify);
506 slave->inactive = 0;
509 static inline bool bond_is_slave_inactive(struct slave *slave)
511 return slave->inactive;
514 static inline void bond_set_slave_link_state(struct slave *slave, int state,
515 bool notify)
517 if (slave->link == state)
518 return;
520 slave->link = state;
521 if (notify) {
522 bond_queue_slave_event(slave);
523 bond_lower_state_changed(slave);
524 slave->should_notify_link = 0;
525 } else {
526 if (slave->should_notify_link)
527 slave->should_notify_link = 0;
528 else
529 slave->should_notify_link = 1;
533 static inline void bond_slave_link_notify(struct bonding *bond)
535 struct list_head *iter;
536 struct slave *tmp;
538 bond_for_each_slave(bond, tmp, iter) {
539 if (tmp->should_notify_link) {
540 bond_queue_slave_event(tmp);
541 bond_lower_state_changed(tmp);
542 tmp->should_notify_link = 0;
547 static inline __be32 bond_confirm_addr(struct net_device *dev, __be32 dst, __be32 local)
549 struct in_device *in_dev;
550 __be32 addr = 0;
552 rcu_read_lock();
553 in_dev = __in_dev_get_rcu(dev);
555 if (in_dev)
556 addr = inet_confirm_addr(dev_net(dev), in_dev, dst, local,
557 RT_SCOPE_HOST);
558 rcu_read_unlock();
559 return addr;
562 struct bond_net {
563 struct net *net; /* Associated network namespace */
564 struct list_head dev_list;
565 #ifdef CONFIG_PROC_FS
566 struct proc_dir_entry *proc_dir;
567 #endif
568 struct class_attribute class_attr_bonding_masters;
571 int bond_arp_rcv(const struct sk_buff *skb, struct bonding *bond, struct slave *slave);
572 void bond_dev_queue_xmit(struct bonding *bond, struct sk_buff *skb, struct net_device *slave_dev);
573 int bond_create(struct net *net, const char *name);
574 int bond_create_sysfs(struct bond_net *net);
575 void bond_destroy_sysfs(struct bond_net *net);
576 void bond_prepare_sysfs_group(struct bonding *bond);
577 int bond_sysfs_slave_add(struct slave *slave);
578 void bond_sysfs_slave_del(struct slave *slave);
579 int bond_enslave(struct net_device *bond_dev, struct net_device *slave_dev);
580 int bond_release(struct net_device *bond_dev, struct net_device *slave_dev);
581 u32 bond_xmit_hash(struct bonding *bond, struct sk_buff *skb);
582 int bond_set_carrier(struct bonding *bond);
583 void bond_select_active_slave(struct bonding *bond);
584 void bond_change_active_slave(struct bonding *bond, struct slave *new_active);
585 void bond_create_debugfs(void);
586 void bond_destroy_debugfs(void);
587 void bond_debug_register(struct bonding *bond);
588 void bond_debug_unregister(struct bonding *bond);
589 void bond_debug_reregister(struct bonding *bond);
590 const char *bond_mode_name(int mode);
591 void bond_setup(struct net_device *bond_dev);
592 unsigned int bond_get_num_tx_queues(void);
593 int bond_netlink_init(void);
594 void bond_netlink_fini(void);
595 struct net_device *bond_option_active_slave_get_rcu(struct bonding *bond);
596 const char *bond_slave_link_status(s8 link);
597 struct bond_vlan_tag *bond_verify_device_path(struct net_device *start_dev,
598 struct net_device *end_dev,
599 int level);
600 int bond_update_slave_arr(struct bonding *bond, struct slave *skipslave);
601 void bond_slave_arr_work_rearm(struct bonding *bond, unsigned long delay);
603 #ifdef CONFIG_PROC_FS
604 void bond_create_proc_entry(struct bonding *bond);
605 void bond_remove_proc_entry(struct bonding *bond);
606 void bond_create_proc_dir(struct bond_net *bn);
607 void bond_destroy_proc_dir(struct bond_net *bn);
608 #else
609 static inline void bond_create_proc_entry(struct bonding *bond)
613 static inline void bond_remove_proc_entry(struct bonding *bond)
617 static inline void bond_create_proc_dir(struct bond_net *bn)
621 static inline void bond_destroy_proc_dir(struct bond_net *bn)
624 #endif
626 static inline struct slave *bond_slave_has_mac(struct bonding *bond,
627 const u8 *mac)
629 struct list_head *iter;
630 struct slave *tmp;
632 bond_for_each_slave(bond, tmp, iter)
633 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
634 return tmp;
636 return NULL;
639 /* Caller must hold rcu_read_lock() for read */
640 static inline struct slave *bond_slave_has_mac_rcu(struct bonding *bond,
641 const u8 *mac)
643 struct list_head *iter;
644 struct slave *tmp;
646 bond_for_each_slave_rcu(bond, tmp, iter)
647 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
648 return tmp;
650 return NULL;
653 /* Caller must hold rcu_read_lock() for read */
654 static inline bool bond_slave_has_mac_rx(struct bonding *bond, const u8 *mac)
656 struct list_head *iter;
657 struct slave *tmp;
658 struct netdev_hw_addr *ha;
660 bond_for_each_slave_rcu(bond, tmp, iter)
661 if (ether_addr_equal_64bits(mac, tmp->dev->dev_addr))
662 return true;
664 if (netdev_uc_empty(bond->dev))
665 return false;
667 netdev_for_each_uc_addr(ha, bond->dev)
668 if (ether_addr_equal_64bits(mac, ha->addr))
669 return true;
671 return false;
674 /* Check if the ip is present in arp ip list, or first free slot if ip == 0
675 * Returns -1 if not found, index if found
677 static inline int bond_get_targets_ip(__be32 *targets, __be32 ip)
679 int i;
681 for (i = 0; i < BOND_MAX_ARP_TARGETS; i++)
682 if (targets[i] == ip)
683 return i;
684 else if (targets[i] == 0)
685 break;
687 return -1;
690 /* exported from bond_main.c */
691 extern int bond_net_id;
692 extern const struct bond_parm_tbl bond_lacp_tbl[];
693 extern const struct bond_parm_tbl xmit_hashtype_tbl[];
694 extern const struct bond_parm_tbl arp_validate_tbl[];
695 extern const struct bond_parm_tbl arp_all_targets_tbl[];
696 extern const struct bond_parm_tbl fail_over_mac_tbl[];
697 extern const struct bond_parm_tbl pri_reselect_tbl[];
698 extern struct bond_parm_tbl ad_select_tbl[];
700 /* exported from bond_netlink.c */
701 extern struct rtnl_link_ops bond_link_ops;
703 static inline void bond_tx_drop(struct net_device *dev, struct sk_buff *skb)
705 atomic_long_inc(&dev->tx_dropped);
706 dev_kfree_skb_any(skb);
709 #endif /* _NET_BONDING_H */