2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
26 #include "dynamic-string.h"
34 #include "poll-loop.h"
40 VLOG_DEFINE_THIS_MODULE(bond);
42 /* Bit-mask for hashing a flow down to a bucket.
43 * There are (BOND_MASK + 1) buckets. */
44 #define BOND_MASK 0xff
46 /* A hash bucket for mapping a flow to a slave.
47 * "struct bond" has an array of (BOND_MASK + 1) of these. */
49 struct bond_slave *slave; /* Assigned slave, NULL if unassigned. */
50 uint64_t tx_bytes; /* Count of bytes recently transmitted. */
51 tag_type tag; /* Tag for entry<->slave association. */
52 struct list list_node; /* In bond_slave's 'entries' list. */
55 /* A bond slave, that is, one of the links comprising a bond. */
57 struct hmap_node hmap_node; /* In struct bond's slaves hmap. */
58 struct bond *bond; /* The bond that contains this slave. */
59 void *aux; /* Client-provided handle for this slave. */
61 struct netdev *netdev; /* Network device, owned by the client. */
62 char *name; /* Name (a copy of netdev_get_name(netdev)). */
65 long long delay_expires; /* Time after which 'enabled' may change. */
66 bool up; /* Last link status read from netdev. */
67 bool enabled; /* May be chosen for flows? */
68 bool lacp_may_enable; /* LACP considers this interface bondable. */
69 tag_type tag; /* Tag associated with this slave. */
71 /* Rebalancing info. Used only by bond_rebalance(). */
72 struct list bal_node; /* In bond_rebalance()'s 'bals' list. */
73 struct list entries; /* 'struct bond_entry's assigned here. */
74 uint64_t tx_bytes; /* Sum across 'tx_bytes' of entries. */
76 /* BM_STABLE specific bonding info. */
77 uint32_t stb_id; /* ID used for 'stb_slaves' ordering. */
80 /* A bond, that is, a set of network devices grouped to improve performance or
83 struct hmap_node hmap_node; /* In 'all_bonds' hmap. */
84 char *name; /* Name provided by client. */
90 enum bond_mode balance; /* Balancing mode, one of BM_*. */
91 struct bond_slave *active_slave;
92 tag_type no_slaves_tag; /* Tag for flows when all slaves disabled. */
93 int updelay, downdelay; /* Delay before slave goes up/down, in ms. */
94 bool lacp_negotiated; /* LACP negotiations were successful. */
95 bool bond_revalidate; /* True if flows need revalidation. */
96 uint32_t basis; /* Basis for flow hash function. */
98 /* SLB specific bonding info. */
99 struct bond_entry *hash; /* An array of (BOND_MASK + 1) elements. */
100 int rebalance_interval; /* Interval between rebalances, in ms. */
101 long long int next_rebalance; /* Next rebalancing time. */
102 bool send_learning_packets;
104 /* BM_STABLE specific bonding info. */
105 tag_type stb_tag; /* Tag associated with this bond. */
108 enum bond_detect_mode detect; /* Link status mode, one of BLSM_*. */
109 struct netdev_monitor *monitor; /* detect == BLSM_CARRIER only. */
110 long long int miimon_interval; /* Miimon status refresh interval. */
111 long long int miimon_next_update; /* Time of next miimon update. */
113 /* Legacy compatibility. */
114 long long int next_fake_iface_update; /* LLONG_MAX if disabled. */
116 /* Tag set saved for next bond_run(). This tag set is a kluge for cases
117 * where we can't otherwise provide revalidation feedback to the client.
118 * That's only unixctl commands now; I hope no other cases will arise. */
119 struct tag_set unixctl_tags;
122 static struct hmap all_bonds = HMAP_INITIALIZER(&all_bonds);
124 static void bond_entry_reset(struct bond *);
125 static struct bond_slave *bond_slave_lookup(struct bond *, const void *slave_);
126 static bool bond_is_link_up(struct bond *, struct netdev *);
127 static void bond_enable_slave(struct bond_slave *, bool enable,
129 static void bond_link_status_update(struct bond_slave *, struct tag_set *);
130 static void bond_choose_active_slave(struct bond *, struct tag_set *);
131 static bool bond_is_tcp_hash(const struct bond *);
132 static unsigned int bond_hash_src(const uint8_t mac[ETH_ADDR_LEN],
133 uint16_t vlan, uint32_t basis);
134 static unsigned int bond_hash_tcp(const struct flow *, uint16_t vlan,
136 static struct bond_entry *lookup_bond_entry(const struct bond *,
139 static tag_type bond_get_active_slave_tag(const struct bond *);
140 static struct bond_slave *choose_output_slave(const struct bond *,
143 static void bond_update_fake_slave_stats(struct bond *);
145 /* Attempts to parse 's' as the name of a bond balancing mode. If successful,
146 * stores the mode in '*balance' and returns true. Otherwise returns false
147 * without modifying '*balance'. */
149 bond_mode_from_string(enum bond_mode *balance, const char *s)
151 if (!strcmp(s, bond_mode_to_string(BM_TCP))) {
153 } else if (!strcmp(s, bond_mode_to_string(BM_SLB))) {
155 } else if (!strcmp(s, bond_mode_to_string(BM_STABLE))) {
156 *balance = BM_STABLE;
157 } else if (!strcmp(s, bond_mode_to_string(BM_AB))) {
165 /* Returns a string representing 'balance'. */
167 bond_mode_to_string(enum bond_mode balance) {
170 return "balance-tcp";
172 return "balance-slb";
176 return "active-backup";
181 /* Attempts to parse 's' as the name of a bond link status detection mode. If
182 * successful, stores the mode in '*detect' and returns true. Otherwise
183 * returns false without modifying '*detect'. */
185 bond_detect_mode_from_string(enum bond_detect_mode *detect, const char *s)
187 if (!strcmp(s, bond_detect_mode_to_string(BLSM_CARRIER))) {
188 *detect = BLSM_CARRIER;
189 } else if (!strcmp(s, bond_detect_mode_to_string(BLSM_MIIMON))) {
190 *detect = BLSM_MIIMON;
197 /* Returns a string representing 'detect'. */
199 bond_detect_mode_to_string(enum bond_detect_mode detect)
210 /* Creates and returns a new bond whose configuration is initially taken from
213 * The caller should register each slave on the new bond by calling
214 * bond_slave_register(). */
216 bond_create(const struct bond_settings *s)
220 bond = xzalloc(sizeof *bond);
221 hmap_init(&bond->slaves);
222 bond->no_slaves_tag = tag_create_random();
223 bond->stb_tag = tag_create_random();
224 bond->miimon_next_update = LLONG_MAX;
225 bond->next_fake_iface_update = LLONG_MAX;
227 bond_reconfigure(bond, s);
229 tag_set_init(&bond->unixctl_tags);
236 bond_destroy(struct bond *bond)
238 struct bond_slave *slave, *next_slave;
244 hmap_remove(&all_bonds, &bond->hmap_node);
246 HMAP_FOR_EACH_SAFE (slave, next_slave, hmap_node, &bond->slaves) {
247 hmap_remove(&bond->slaves, &slave->hmap_node);
248 /* Client owns 'slave->netdev'. */
252 hmap_destroy(&bond->slaves);
256 netdev_monitor_destroy(bond->monitor);
262 /* Updates 'bond''s overall configuration to 's'.
264 * The caller should register each slave on 'bond' by calling
265 * bond_slave_register(). This is optional if none of the slaves'
266 * configuration has changed. In any case it can't hurt.
268 * Returns true if the configuration has changed in such a way that requires
272 bond_reconfigure(struct bond *bond, const struct bond_settings *s)
274 bool revalidate = false;
276 if (!bond->name || strcmp(bond->name, s->name)) {
278 hmap_remove(&all_bonds, &bond->hmap_node);
281 bond->name = xstrdup(s->name);
282 hmap_insert(&all_bonds, &bond->hmap_node, hash_string(bond->name, 0));
285 bond->detect = s->detect;
286 bond->miimon_interval = s->miimon_interval;
287 bond->updelay = s->up_delay;
288 bond->downdelay = s->down_delay;
289 bond->rebalance_interval = s->rebalance_interval;
291 if (bond->balance != s->balance) {
292 bond->balance = s->balance;
296 if (bond->basis != s->basis) {
297 bond->basis = s->basis;
301 if (bond->detect == BLSM_CARRIER) {
302 struct bond_slave *slave;
304 if (!bond->monitor) {
305 bond->monitor = netdev_monitor_create();
308 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
309 netdev_monitor_add(bond->monitor, slave->netdev);
312 netdev_monitor_destroy(bond->monitor);
313 bond->monitor = NULL;
315 if (bond->miimon_next_update == LLONG_MAX) {
316 bond->miimon_next_update = time_msec() + bond->miimon_interval;
321 if (bond->next_fake_iface_update == LLONG_MAX) {
322 bond->next_fake_iface_update = time_msec();
325 bond->next_fake_iface_update = LLONG_MAX;
328 if (bond->bond_revalidate) {
330 bond->bond_revalidate = false;
333 if (bond->balance == BM_AB || !bond->hash || revalidate) {
334 bond_entry_reset(bond);
340 /* Registers 'slave_' as a slave of 'bond'. The 'slave_' pointer is an
341 * arbitrary client-provided pointer that uniquely identifies a slave within a
342 * bond. If 'slave_' already exists within 'bond' then this function
343 * reconfigures the existing slave.
345 * 'stb_id' is used in BM_STABLE bonds to guarantee consistent slave choices
346 * across restarts and distributed vswitch instances. It should be unique per
347 * slave, and preferably consistent across restarts and reconfigurations.
349 * 'netdev' must be the network device that 'slave_' represents. It is owned
350 * by the client, so the client must not close it before either unregistering
351 * 'slave_' or destroying 'bond'.
354 bond_slave_register(struct bond *bond, void *slave_, uint32_t stb_id,
355 struct netdev *netdev)
357 struct bond_slave *slave = bond_slave_lookup(bond, slave_);
360 slave = xzalloc(sizeof *slave);
362 hmap_insert(&bond->slaves, &slave->hmap_node, hash_pointer(slave_, 0));
365 slave->delay_expires = LLONG_MAX;
366 slave->up = bond_is_link_up(bond, netdev);
367 slave->name = xstrdup(netdev_get_name(netdev));
368 bond->bond_revalidate = true;
370 slave->enabled = false;
371 bond_enable_slave(slave, slave->up, NULL);
374 if (slave->stb_id != stb_id) {
375 slave->stb_id = stb_id;
376 bond->bond_revalidate = true;
379 if (slave->netdev != netdev) {
382 netdev_monitor_remove(bond->monitor, slave->netdev);
384 netdev_monitor_add(bond->monitor, netdev);
386 slave->netdev = netdev;
390 slave->name = xstrdup(netdev_get_name(netdev));
393 /* Unregisters 'slave_' from 'bond'. If 'bond' does not contain such a slave
394 * then this function has no effect.
396 * Unregistering a slave invalidates all flows. */
398 bond_slave_unregister(struct bond *bond, const void *slave_)
400 struct bond_slave *slave = bond_slave_lookup(bond, slave_);
408 netdev_monitor_remove(bond->monitor, slave->netdev);
411 bond_enable_slave(slave, false, NULL);
413 del_active = bond->active_slave == slave;
415 struct bond_entry *e;
416 for (e = bond->hash; e <= &bond->hash[BOND_MASK]; e++) {
417 if (e->slave == slave) {
425 hmap_remove(&bond->slaves, &slave->hmap_node);
426 /* Client owns 'slave->netdev'. */
433 bond_choose_active_slave(bond, &tags);
434 bond->send_learning_packets = true;
438 /* Should be called on each slave in 'bond' before bond_run() to indicate the
439 * results of lacp_slave_may_enable() on 'slave_'. */
441 bond_slave_set_lacp_may_enable(struct bond *bond, void *slave_,
444 bond_slave_lookup(bond, slave_)->lacp_may_enable = may_enable;
447 /* Performs periodic maintenance on 'bond'. The caller must provide 'tags' to
448 * allow tagged flows to be invalidated.
450 * The caller should check bond_should_send_learning_packets() afterward. */
452 bond_run(struct bond *bond, struct tag_set *tags, bool lacp_negotiated)
454 struct bond_slave *slave;
455 bool is_tcp_hash = bond_is_tcp_hash(bond);
457 bond->lacp_negotiated = lacp_negotiated;
459 /* Update link status. */
460 if (bond->detect == BLSM_CARRIER
461 || time_msec() >= bond->miimon_next_update)
463 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
464 slave->up = bond_is_link_up(bond, slave->netdev);
466 bond->miimon_next_update = time_msec() + bond->miimon_interval;
470 netdev_monitor_flush(bond->monitor);
473 /* Enable slaves based on link status and LACP feedback. */
474 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
475 bond_link_status_update(slave, tags);
477 if (!bond->active_slave || !bond->active_slave->enabled) {
478 bond_choose_active_slave(bond, tags);
481 /* Update fake bond interface stats. */
482 if (time_msec() >= bond->next_fake_iface_update) {
483 bond_update_fake_slave_stats(bond);
484 bond->next_fake_iface_update = time_msec() + 1000;
487 if (is_tcp_hash != bond_is_tcp_hash(bond)) {
488 bond->bond_revalidate = true;
491 if (bond->bond_revalidate) {
492 bond->bond_revalidate = false;
494 bond_entry_reset(bond);
495 if (bond->balance != BM_STABLE) {
496 struct bond_slave *slave;
498 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
499 tag_set_add(tags, slave->tag);
502 tag_set_add(tags, bond->stb_tag);
504 tag_set_add(tags, bond->no_slaves_tag);
507 /* Invalidate any tags required by */
508 tag_set_union(tags, &bond->unixctl_tags);
509 tag_set_init(&bond->unixctl_tags);
512 /* Causes poll_block() to wake up when 'bond' needs something to be done. */
514 bond_wait(struct bond *bond)
516 struct bond_slave *slave;
518 if (bond->detect == BLSM_CARRIER) {
519 netdev_monitor_poll_wait(bond->monitor);
521 poll_timer_wait_until(bond->miimon_next_update);
524 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
525 if (slave->delay_expires != LLONG_MAX) {
526 poll_timer_wait_until(slave->delay_expires);
530 if (bond->next_fake_iface_update != LLONG_MAX) {
531 poll_timer_wait_until(bond->next_fake_iface_update);
534 /* Ensure that any saved tags get revalidated right away. */
535 if (!tag_set_is_empty(&bond->unixctl_tags)) {
536 poll_immediate_wake();
539 /* We don't wait for bond->next_rebalance because rebalancing can only run
540 * at a flow account checkpoint. ofproto does checkpointing on its own
541 * schedule and bond_rebalance() gets called afterward, so we'd just be
542 * waking up for no purpose. */
545 /* MAC learning table interaction. */
548 may_send_learning_packets(const struct bond *bond)
550 return !bond->lacp_negotiated && bond->balance != BM_AB;
553 /* Returns true if 'bond' needs the client to send out packets to assist with
554 * MAC learning on 'bond'. If this function returns true, then the client
555 * should iterate through its MAC learning table for the bridge on which 'bond'
556 * is located. For each MAC that has been learned on a port other than 'bond',
557 * it should call bond_send_learning_packet().
559 * This function will only return true if 'bond' is in SLB mode and LACP is not
560 * negotiated. Otherwise sending learning packets isn't necessary.
562 * Calling this function resets the state that it checks. */
564 bond_should_send_learning_packets(struct bond *bond)
566 bool send = bond->send_learning_packets && may_send_learning_packets(bond);
567 bond->send_learning_packets = false;
571 /* Sends a gratuitous learning packet on 'bond' from 'eth_src' on 'vlan'.
573 * See bond_should_send_learning_packets() for description of usage. */
575 bond_send_learning_packet(struct bond *bond,
576 const uint8_t eth_src[ETH_ADDR_LEN],
579 struct bond_slave *slave;
580 struct ofpbuf packet;
584 assert(may_send_learning_packets(bond));
585 if (!bond->active_slave) {
586 /* Nowhere to send the learning packet. */
590 memset(&flow, 0, sizeof flow);
591 memcpy(flow.dl_src, eth_src, ETH_ADDR_LEN);
592 slave = choose_output_slave(bond, &flow, vlan);
594 ofpbuf_init(&packet, 0);
595 compose_benign_packet(&packet, "Open vSwitch Bond Failover", 0xf177,
598 eth_set_vlan_tci(&packet, htons(vlan));
600 error = netdev_send(slave->netdev, &packet);
601 ofpbuf_uninit(&packet);
606 /* Checks whether a packet that arrived on 'slave_' within 'bond', with an
607 * Ethernet destination address of 'eth_dst', should be admitted.
609 * The return value is one of the following:
611 * - BV_ACCEPT: Admit the packet.
613 * - BV_DROP: Drop the packet.
615 * - BV_DROP_IF_MOVED: Consult the MAC learning table for the packet's
616 * Ethernet source address and VLAN. If there is none, or if the packet
617 * is on the learned port, then admit the packet. If a different port has
618 * been learned, however, drop the packet (and do not use it for MAC
622 bond_check_admissibility(struct bond *bond, const void *slave_,
623 const uint8_t eth_dst[ETH_ADDR_LEN], tag_type *tags)
625 /* Admit all packets if LACP has been negotiated, because that means that
626 * the remote switch is aware of the bond and will "do the right thing". */
627 if (bond->lacp_negotiated) {
631 /* Drop all multicast packets on inactive slaves. */
632 if (eth_addr_is_multicast(eth_dst)) {
633 *tags |= bond_get_active_slave_tag(bond);
634 if (bond->active_slave != bond_slave_lookup(bond, slave_)) {
639 /* Drop all packets for which we have learned a different input port,
640 * because we probably sent the packet on one slave and got it back on the
641 * other. Gratuitous ARP packets are an exception to this rule: the host
642 * has moved to another switch. The exception to the exception is if we
643 * locked the learning table to avoid reflections on bond slaves. */
644 return BV_DROP_IF_MOVED;
647 /* Returns the slave (registered on 'bond' by bond_slave_register()) to which
648 * a packet with the given 'flow' and 'vlan' should be forwarded. Returns
649 * NULL if the packet should be dropped because no slaves are enabled.
651 * 'vlan' is not necessarily the same as 'flow->vlan_tci'. First, 'vlan'
652 * should be a VID only (i.e. excluding the PCP bits). Second,
653 * 'flow->vlan_tci' is the VLAN TCI that appeared on the packet (so it will be
654 * nonzero only for trunk ports), whereas 'vlan' is the logical VLAN that the
655 * packet belongs to (so for an access port it will be the access port's VLAN).
657 * Adds a tag to '*tags' that associates the flow with the returned slave.
660 bond_choose_output_slave(struct bond *bond, const struct flow *flow,
661 uint16_t vlan, tag_type *tags)
663 struct bond_slave *slave = choose_output_slave(bond, flow, vlan);
665 *tags |= bond->balance == BM_STABLE ? bond->stb_tag : slave->tag;
668 *tags |= bond->no_slaves_tag;
676 bond_is_balanced(const struct bond *bond)
678 return bond->balance == BM_SLB || bond->balance == BM_TCP;
681 /* Notifies 'bond' that 'n_bytes' bytes were sent in 'flow' within 'vlan'. */
683 bond_account(struct bond *bond, const struct flow *flow, uint16_t vlan,
687 if (bond_is_balanced(bond)) {
688 lookup_bond_entry(bond, flow, vlan)->tx_bytes += n_bytes;
692 static struct bond_slave *
693 bond_slave_from_bal_node(struct list *bal)
695 return CONTAINER_OF(bal, struct bond_slave, bal_node);
699 log_bals(struct bond *bond, const struct list *bals)
701 if (VLOG_IS_DBG_ENABLED()) {
702 struct ds ds = DS_EMPTY_INITIALIZER;
703 const struct bond_slave *slave;
705 LIST_FOR_EACH (slave, bal_node, bals) {
707 ds_put_char(&ds, ',');
709 ds_put_format(&ds, " %s %"PRIu64"kB",
710 slave->name, slave->tx_bytes / 1024);
712 if (!slave->enabled) {
713 ds_put_cstr(&ds, " (disabled)");
715 if (!list_is_empty(&slave->entries)) {
716 struct bond_entry *e;
718 ds_put_cstr(&ds, " (");
719 LIST_FOR_EACH (e, list_node, &slave->entries) {
720 if (&e->list_node != list_front(&slave->entries)) {
721 ds_put_cstr(&ds, " + ");
723 ds_put_format(&ds, "h%td: %"PRIu64"kB",
724 e - bond->hash, e->tx_bytes / 1024);
726 ds_put_cstr(&ds, ")");
729 VLOG_DBG("bond %s:%s", bond->name, ds_cstr(&ds));
734 /* Shifts 'hash' from its current slave to 'to'. */
736 bond_shift_load(struct bond_entry *hash, struct bond_slave *to,
739 struct bond_slave *from = hash->slave;
740 struct bond *bond = from->bond;
741 uint64_t delta = hash->tx_bytes;
743 VLOG_INFO("bond %s: shift %"PRIu64"kB of load (with hash %td) "
744 "from %s to %s (now carrying %"PRIu64"kB and "
745 "%"PRIu64"kB load, respectively)",
746 bond->name, delta / 1024, hash - bond->hash,
747 from->name, to->name,
748 (from->tx_bytes - delta) / 1024,
749 (to->tx_bytes + delta) / 1024);
751 /* Shift load away from 'from' to 'to'. */
752 from->tx_bytes -= delta;
753 to->tx_bytes += delta;
755 /* Arrange for flows to be revalidated. */
756 tag_set_add(set, hash->tag);
758 hash->tag = tag_create_random();
761 /* Pick and returns a bond_entry to migrate to 'to' (the least-loaded slave),
762 * given that doing so must decrease the ratio of the load on the two slaves by
763 * at least 0.1. Returns NULL if there is no appropriate entry.
765 * The list of entries isn't sorted. I don't know of a reason to prefer to
766 * shift away small hashes or large hashes. */
767 static struct bond_entry *
768 choose_entry_to_migrate(const struct bond_slave *from, uint64_t to_tx_bytes)
770 struct bond_entry *e;
772 if (list_is_short(&from->entries)) {
773 /* 'from' carries no more than one MAC hash, so shifting load away from
774 * it would be pointless. */
778 LIST_FOR_EACH (e, list_node, &from->entries) {
779 double old_ratio, new_ratio;
782 if (to_tx_bytes == 0) {
783 /* Nothing on the new slave, move it. */
788 old_ratio = (double)from->tx_bytes / to_tx_bytes;
789 new_ratio = (double)(from->tx_bytes - delta) / (to_tx_bytes + delta);
790 if (old_ratio - new_ratio > 0.1) {
791 /* Would decrease the ratio, move it. */
799 /* Inserts 'slave' into 'bals' so that descending order of 'tx_bytes' is
802 insert_bal(struct list *bals, struct bond_slave *slave)
804 struct bond_slave *pos;
806 LIST_FOR_EACH (pos, bal_node, bals) {
807 if (slave->tx_bytes > pos->tx_bytes) {
811 list_insert(&pos->bal_node, &slave->bal_node);
814 /* Removes 'slave' from its current list and then inserts it into 'bals' so
815 * that descending order of 'tx_bytes' is maintained. */
817 reinsert_bal(struct list *bals, struct bond_slave *slave)
819 list_remove(&slave->bal_node);
820 insert_bal(bals, slave);
823 /* If 'bond' needs rebalancing, does so.
825 * The caller should have called bond_account() for each active flow, to ensure
826 * that flow data is consistently accounted at this point. */
828 bond_rebalance(struct bond *bond, struct tag_set *tags)
830 struct bond_slave *slave;
831 struct bond_entry *e;
834 if (!bond_is_balanced(bond) || time_msec() < bond->next_rebalance) {
837 bond->next_rebalance = time_msec() + bond->rebalance_interval;
839 /* Add each bond_entry to its slave's 'entries' list.
840 * Compute each slave's tx_bytes as the sum of its entries' tx_bytes. */
841 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
843 list_init(&slave->entries);
845 for (e = &bond->hash[0]; e <= &bond->hash[BOND_MASK]; e++) {
846 if (e->slave && e->tx_bytes) {
847 e->slave->tx_bytes += e->tx_bytes;
848 list_push_back(&e->slave->entries, &e->list_node);
852 /* Add enabled slaves to 'bals' in descending order of tx_bytes.
854 * XXX This is O(n**2) in the number of slaves but it could be O(n lg n)
855 * with a proper list sort algorithm. */
857 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
858 if (slave->enabled) {
859 insert_bal(&bals, slave);
862 log_bals(bond, &bals);
864 /* Shift load from the most-loaded slaves to the least-loaded slaves. */
865 while (!list_is_short(&bals)) {
866 struct bond_slave *from = bond_slave_from_bal_node(list_front(&bals));
867 struct bond_slave *to = bond_slave_from_bal_node(list_back(&bals));
870 overload = from->tx_bytes - to->tx_bytes;
871 if (overload < to->tx_bytes >> 5 || overload < 100000) {
872 /* The extra load on 'from' (and all less-loaded slaves), compared
873 * to that of 'to' (the least-loaded slave), is less than ~3%, or
874 * it is less than ~1Mbps. No point in rebalancing. */
878 /* 'from' is carrying significantly more load than 'to', and that load
879 * is split across at least two different hashes. */
880 e = choose_entry_to_migrate(from, to->tx_bytes);
882 bond_shift_load(e, to, tags);
884 /* Delete element from from->entries.
886 * We don't add the element to to->hashes. That would only allow
887 * 'e' to be migrated to another slave in this rebalancing run, and
888 * there is no point in doing that. */
889 list_remove(&e->list_node);
891 /* Re-sort 'bals'. */
892 reinsert_bal(&bals, from);
893 reinsert_bal(&bals, to);
895 /* Can't usefully migrate anything away from 'from'.
896 * Don't reconsider it. */
897 list_remove(&from->bal_node);
901 /* Implement exponentially weighted moving average. A weight of 1/2 causes
902 * historical data to decay to <1% in 7 rebalancing runs. 1,000,000 bytes
903 * take 20 rebalancing runs to decay to 0 and get deleted entirely. */
904 for (e = &bond->hash[0]; e <= &bond->hash[BOND_MASK]; e++) {
912 /* Bonding unixctl user interface functions. */
915 bond_find(const char *name)
919 HMAP_FOR_EACH_WITH_HASH (bond, hmap_node, hash_string(name, 0),
921 if (!strcmp(bond->name, name)) {
928 static struct bond_slave *
929 bond_lookup_slave(struct bond *bond, const char *slave_name)
931 struct bond_slave *slave;
933 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
934 if (!strcmp(slave->name, slave_name)) {
942 bond_unixctl_list(struct unixctl_conn *conn,
943 const char *args OVS_UNUSED, void *aux OVS_UNUSED)
945 struct ds ds = DS_EMPTY_INITIALIZER;
946 const struct bond *bond;
948 ds_put_cstr(&ds, "bond\ttype\tslaves\n");
950 HMAP_FOR_EACH (bond, hmap_node, &all_bonds) {
951 const struct bond_slave *slave;
954 ds_put_format(&ds, "%s\t%s\t",
955 bond->name, bond_mode_to_string(bond->balance));
958 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
960 ds_put_cstr(&ds, ", ");
962 ds_put_cstr(&ds, slave->name);
964 ds_put_char(&ds, '\n');
966 unixctl_command_reply(conn, 200, ds_cstr(&ds));
971 bond_unixctl_show(struct unixctl_conn *conn,
972 const char *args, void *aux OVS_UNUSED)
974 struct ds ds = DS_EMPTY_INITIALIZER;
975 const struct bond_slave *slave;
976 const struct bond *bond;
978 bond = bond_find(args);
980 unixctl_command_reply(conn, 501, "no such bond");
984 ds_put_format(&ds, "bond_mode: %s\n",
985 bond_mode_to_string(bond->balance));
987 if (bond->balance != BM_AB) {
988 ds_put_format(&ds, "bond-hash-algorithm: %s\n",
989 bond_is_tcp_hash(bond) ? "balance-tcp" : "balance-slb");
992 ds_put_format(&ds, "bond-hash-basis: %"PRIu32"\n", bond->basis);
994 ds_put_format(&ds, "bond-detect-mode: %s\n",
995 bond->monitor ? "carrier" : "miimon");
997 if (!bond->monitor) {
998 ds_put_format(&ds, "bond-miimon-interval: %lld\n",
999 bond->miimon_interval);
1002 ds_put_format(&ds, "updelay: %d ms\n", bond->updelay);
1003 ds_put_format(&ds, "downdelay: %d ms\n", bond->downdelay);
1005 if (bond_is_balanced(bond)) {
1006 ds_put_format(&ds, "next rebalance: %lld ms\n",
1007 bond->next_rebalance - time_msec());
1010 ds_put_format(&ds, "lacp_negotiated: %s\n",
1011 bond->lacp_negotiated ? "true" : "false");
1013 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1014 struct bond_entry *be;
1018 ds_put_format(&ds, "\nslave %s: %s\n",
1019 slave->name, slave->enabled ? "enabled" : "disabled");
1020 if (slave == bond->active_slave) {
1021 ds_put_cstr(&ds, "\tactive slave\n");
1023 if (slave->delay_expires != LLONG_MAX) {
1024 ds_put_format(&ds, "\t%s expires in %lld ms\n",
1025 slave->enabled ? "downdelay" : "updelay",
1026 slave->delay_expires - time_msec());
1029 ds_put_format(&ds, "\tlacp_may_enable: %s\n",
1030 slave->lacp_may_enable ? "true" : "false");
1032 if (!bond_is_balanced(bond)) {
1037 memset(&flow, 0, sizeof flow);
1038 for (be = bond->hash; be <= &bond->hash[BOND_MASK]; be++) {
1039 int hash = be - bond->hash;
1041 if (be->slave != slave) {
1045 ds_put_format(&ds, "\thash %d: %"PRIu64" kB load\n",
1046 hash, be->tx_bytes / 1024);
1048 if (bond->balance != BM_SLB) {
1052 /* XXX How can we list the MACs assigned to hashes? */
1055 unixctl_command_reply(conn, 200, ds_cstr(&ds));
1060 bond_unixctl_migrate(struct unixctl_conn *conn, const char *args_,
1061 void *aux OVS_UNUSED)
1063 char *args = (char *) args_;
1064 char *save_ptr = NULL;
1065 char *bond_s, *hash_s, *slave_s;
1067 struct bond_slave *slave;
1068 struct bond_entry *entry;
1071 bond_s = strtok_r(args, " ", &save_ptr);
1072 hash_s = strtok_r(NULL, " ", &save_ptr);
1073 slave_s = strtok_r(NULL, " ", &save_ptr);
1075 unixctl_command_reply(conn, 501,
1076 "usage: bond/migrate BOND HASH SLAVE");
1080 bond = bond_find(bond_s);
1082 unixctl_command_reply(conn, 501, "no such bond");
1086 if (bond->balance != BM_SLB) {
1087 unixctl_command_reply(conn, 501, "not an SLB bond");
1091 if (strspn(hash_s, "0123456789") == strlen(hash_s)) {
1092 hash = atoi(hash_s) & BOND_MASK;
1094 unixctl_command_reply(conn, 501, "bad hash");
1098 slave = bond_lookup_slave(bond, slave_s);
1100 unixctl_command_reply(conn, 501, "no such slave");
1104 if (!slave->enabled) {
1105 unixctl_command_reply(conn, 501, "cannot migrate to disabled slave");
1109 entry = &bond->hash[hash];
1110 tag_set_add(&bond->unixctl_tags, entry->tag);
1111 entry->slave = slave;
1112 entry->tag = tag_create_random();
1113 unixctl_command_reply(conn, 200, "migrated");
1117 bond_unixctl_set_active_slave(struct unixctl_conn *conn, const char *args_,
1118 void *aux OVS_UNUSED)
1120 char *args = (char *) args_;
1121 char *save_ptr = NULL;
1122 char *bond_s, *slave_s;
1124 struct bond_slave *slave;
1126 bond_s = strtok_r(args, " ", &save_ptr);
1127 slave_s = strtok_r(NULL, " ", &save_ptr);
1129 unixctl_command_reply(conn, 501,
1130 "usage: bond/set-active-slave BOND SLAVE");
1134 bond = bond_find(bond_s);
1136 unixctl_command_reply(conn, 501, "no such bond");
1140 slave = bond_lookup_slave(bond, slave_s);
1142 unixctl_command_reply(conn, 501, "no such slave");
1146 if (!slave->enabled) {
1147 unixctl_command_reply(conn, 501, "cannot make disabled slave active");
1151 if (bond->active_slave != slave) {
1152 tag_set_add(&bond->unixctl_tags, bond_get_active_slave_tag(bond));
1153 bond->active_slave = slave;
1154 bond->active_slave->tag = tag_create_random();
1155 VLOG_INFO("bond %s: active interface is now %s",
1156 bond->name, slave->name);
1157 bond->send_learning_packets = true;
1158 unixctl_command_reply(conn, 200, "done");
1160 unixctl_command_reply(conn, 200, "no change");
1165 enable_slave(struct unixctl_conn *conn, const char *args_, bool enable)
1167 char *args = (char *) args_;
1168 char *save_ptr = NULL;
1169 char *bond_s, *slave_s;
1171 struct bond_slave *slave;
1173 bond_s = strtok_r(args, " ", &save_ptr);
1174 slave_s = strtok_r(NULL, " ", &save_ptr);
1176 char *usage = xasprintf("usage: bond/%s-slave BOND SLAVE",
1177 enable ? "enable" : "disable");
1178 unixctl_command_reply(conn, 501, usage);
1183 bond = bond_find(bond_s);
1185 unixctl_command_reply(conn, 501, "no such bond");
1189 slave = bond_lookup_slave(bond, slave_s);
1191 unixctl_command_reply(conn, 501, "no such slave");
1195 bond_enable_slave(slave, enable, &bond->unixctl_tags);
1196 unixctl_command_reply(conn, 501, enable ? "enabled" : "disabled");
1200 bond_unixctl_enable_slave(struct unixctl_conn *conn, const char *args,
1201 void *aux OVS_UNUSED)
1203 enable_slave(conn, args, true);
1207 bond_unixctl_disable_slave(struct unixctl_conn *conn, const char *args,
1208 void *aux OVS_UNUSED)
1210 enable_slave(conn, args, false);
1214 bond_unixctl_hash(struct unixctl_conn *conn, const char *args_,
1215 void *aux OVS_UNUSED)
1217 char *args = (char *) args_;
1218 uint8_t mac[ETH_ADDR_LEN];
1223 char *mac_s, *vlan_s, *basis_s;
1224 char *save_ptr = NULL;
1226 mac_s = strtok_r(args, " ", &save_ptr);
1227 vlan_s = strtok_r(NULL, " ", &save_ptr);
1228 basis_s = strtok_r(NULL, " ", &save_ptr);
1231 if (sscanf(vlan_s, "%u", &vlan) != 1) {
1232 unixctl_command_reply(conn, 501, "invalid vlan");
1236 vlan = OFP_VLAN_NONE;
1240 if (sscanf(basis_s, "%"PRIu32, &basis) != 1) {
1241 unixctl_command_reply(conn, 501, "invalid basis");
1248 if (sscanf(mac_s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
1249 == ETH_ADDR_SCAN_COUNT) {
1250 hash = bond_hash_src(mac, vlan, basis) & BOND_MASK;
1252 hash_cstr = xasprintf("%u", hash);
1253 unixctl_command_reply(conn, 200, hash_cstr);
1256 unixctl_command_reply(conn, 501, "invalid mac");
1263 unixctl_command_register("bond/list", bond_unixctl_list, NULL);
1264 unixctl_command_register("bond/show", bond_unixctl_show, NULL);
1265 unixctl_command_register("bond/migrate", bond_unixctl_migrate, NULL);
1266 unixctl_command_register("bond/set-active-slave",
1267 bond_unixctl_set_active_slave, NULL);
1268 unixctl_command_register("bond/enable-slave", bond_unixctl_enable_slave,
1270 unixctl_command_register("bond/disable-slave", bond_unixctl_disable_slave,
1272 unixctl_command_register("bond/hash", bond_unixctl_hash, NULL);
1276 bond_entry_reset(struct bond *bond)
1278 if (bond->balance != BM_AB) {
1279 size_t hash_len = (BOND_MASK + 1) * sizeof *bond->hash;
1282 bond->hash = xmalloc(hash_len);
1284 memset(bond->hash, 0, hash_len);
1286 bond->next_rebalance = time_msec() + bond->rebalance_interval;
1293 static struct bond_slave *
1294 bond_slave_lookup(struct bond *bond, const void *slave_)
1296 struct bond_slave *slave;
1298 HMAP_FOR_EACH_IN_BUCKET (slave, hmap_node, hash_pointer(slave_, 0),
1300 if (slave->aux == slave_) {
1309 bond_is_link_up(struct bond *bond, struct netdev *netdev)
1311 return (bond->detect == BLSM_CARRIER
1312 ? netdev_get_carrier(netdev)
1313 : netdev_get_miimon(netdev));
1317 bond_enable_slave(struct bond_slave *slave, bool enable, struct tag_set *tags)
1319 struct bond *bond = slave->bond;
1320 slave->delay_expires = LLONG_MAX;
1321 if (enable != slave->enabled) {
1322 slave->enabled = enable;
1323 if (!slave->enabled) {
1324 VLOG_WARN("interface %s: disabled", slave->name);
1326 tag_set_add(tags, slave->tag);
1329 VLOG_WARN("interface %s: enabled", slave->name);
1330 slave->tag = tag_create_random();
1333 if (bond->balance == BM_STABLE) {
1334 bond->bond_revalidate = true;
1340 bond_link_status_update(struct bond_slave *slave, struct tag_set *tags)
1342 struct bond *bond = slave->bond;
1345 up = slave->up && slave->lacp_may_enable;
1346 if ((up == slave->enabled) != (slave->delay_expires == LLONG_MAX)) {
1347 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1348 VLOG_INFO_RL(&rl, "interface %s: link state %s",
1349 slave->name, up ? "up" : "down");
1350 if (up == slave->enabled) {
1351 slave->delay_expires = LLONG_MAX;
1352 VLOG_INFO_RL(&rl, "interface %s: will not be %s",
1353 slave->name, up ? "disabled" : "enabled");
1355 int delay = (bond->lacp_negotiated ? 0
1356 : up ? bond->updelay : bond->downdelay);
1357 slave->delay_expires = time_msec() + delay;
1359 VLOG_INFO_RL(&rl, "interface %s: will be %s if it stays %s "
1362 up ? "enabled" : "disabled",
1369 if (time_msec() >= slave->delay_expires) {
1370 bond_enable_slave(slave, up, tags);
1375 bond_is_tcp_hash(const struct bond *bond)
1377 return (bond->balance == BM_TCP || bond->balance == BM_STABLE)
1378 && bond->lacp_negotiated;
1382 bond_hash_src(const uint8_t mac[ETH_ADDR_LEN], uint16_t vlan, uint32_t basis)
1384 return hash_3words(hash_bytes(mac, ETH_ADDR_LEN, 0), vlan, basis);
1388 bond_hash_tcp(const struct flow *flow, uint16_t vlan, uint32_t basis)
1390 struct flow hash_flow = *flow;
1391 hash_flow.vlan_tci = htons(vlan);
1393 /* The symmetric quality of this hash function is not required, but
1394 * flow_hash_symmetric_l4 already exists, and is sufficient for our
1395 * purposes, so we use it out of convenience. */
1396 return flow_hash_symmetric_l4(&hash_flow, basis);
1400 bond_hash(const struct bond *bond, const struct flow *flow, uint16_t vlan)
1402 assert(bond->balance != BM_AB);
1404 return (bond_is_tcp_hash(bond)
1405 ? bond_hash_tcp(flow, vlan, bond->basis)
1406 : bond_hash_src(flow->dl_src, vlan, bond->basis));
1409 static struct bond_entry *
1410 lookup_bond_entry(const struct bond *bond, const struct flow *flow,
1413 return &bond->hash[bond_hash(bond, flow, vlan) & BOND_MASK];
1416 /* This function uses Highest Random Weight hashing to choose an output slave.
1417 * This approach only reassigns a minimal number of flows when slaves are
1418 * enabled or disabled. Unfortunately, it has O(n) performance against the
1419 * number of slaves. There exist algorithms which are O(1), but have slightly
1420 * more complex implementations and require the use of memory. This may need
1421 * to be reimplemented if it becomes a performance bottleneck. */
1422 static struct bond_slave *
1423 choose_stb_slave(const struct bond *bond, const struct flow *flow,
1426 struct bond_slave *best, *slave;
1427 uint32_t best_hash, flow_hash;
1431 flow_hash = bond_hash(bond, flow, vlan);
1432 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1433 if (slave->enabled) {
1436 hash = hash_2words(flow_hash, slave->stb_id);
1437 if (!best || hash > best_hash) {
1447 static struct bond_slave *
1448 choose_output_slave(const struct bond *bond, const struct flow *flow,
1451 struct bond_entry *e;
1453 switch (bond->balance) {
1455 return bond->active_slave;
1458 return choose_stb_slave(bond, flow, vlan);
1461 e = lookup_bond_entry(bond, flow, vlan);
1462 if (!e->slave || !e->slave->enabled) {
1463 e->slave = CONTAINER_OF(hmap_random_node(&bond->slaves),
1464 struct bond_slave, hmap_node);
1465 if (!e->slave->enabled) {
1466 e->slave = bond->active_slave;
1468 e->tag = tag_create_random();
1477 static struct bond_slave *
1478 bond_choose_slave(const struct bond *bond)
1480 struct bond_slave *slave, *best;
1482 /* Find an enabled slave. */
1483 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1484 if (slave->enabled) {
1489 /* All interfaces are disabled. Find an interface that will be enabled
1490 * after its updelay expires. */
1492 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1493 if (slave->delay_expires != LLONG_MAX
1494 && slave->lacp_may_enable
1495 && (!best || slave->delay_expires < best->delay_expires)) {
1503 bond_choose_active_slave(struct bond *bond, struct tag_set *tags)
1505 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1506 struct bond_slave *old_active_slave = bond->active_slave;
1508 bond->active_slave = bond_choose_slave(bond);
1509 if (bond->active_slave) {
1510 if (bond->active_slave->enabled) {
1511 VLOG_INFO_RL(&rl, "bond %s: active interface is now %s",
1512 bond->name, bond->active_slave->name);
1514 VLOG_INFO_RL(&rl, "bond %s: active interface is now %s, skipping "
1515 "remaining %lld ms updelay (since no interface was "
1516 "enabled)", bond->name, bond->active_slave->name,
1517 bond->active_slave->delay_expires - time_msec());
1518 bond_enable_slave(bond->active_slave, true, tags);
1521 if (!old_active_slave) {
1522 tag_set_add(tags, bond->no_slaves_tag);
1525 bond->send_learning_packets = true;
1526 } else if (old_active_slave) {
1527 VLOG_WARN_RL(&rl, "bond %s: all interfaces disabled", bond->name);
1531 /* Returns the tag for 'bond''s active slave, or 'bond''s no_slaves_tag if
1532 * there is no active slave. */
1534 bond_get_active_slave_tag(const struct bond *bond)
1536 return (bond->active_slave
1537 ? bond->active_slave->tag
1538 : bond->no_slaves_tag);
1541 /* Attempts to make the sum of the bond slaves' statistics appear on the fake
1542 * bond interface. */
1544 bond_update_fake_slave_stats(struct bond *bond)
1546 struct netdev_stats bond_stats;
1547 struct bond_slave *slave;
1548 struct netdev *bond_dev;
1550 memset(&bond_stats, 0, sizeof bond_stats);
1552 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1553 struct netdev_stats slave_stats;
1555 if (!netdev_get_stats(slave->netdev, &slave_stats)) {
1556 /* XXX: We swap the stats here because they are swapped back when
1557 * reported by the internal device. The reason for this is
1558 * internal devices normally represent packets going into the
1559 * system but when used as fake bond device they represent packets
1560 * leaving the system. We really should do this in the internal
1561 * device itself because changing it here reverses the counts from
1562 * the perspective of the switch. However, the internal device
1563 * doesn't know what type of device it represents so we have to do
1564 * it here for now. */
1565 bond_stats.tx_packets += slave_stats.rx_packets;
1566 bond_stats.tx_bytes += slave_stats.rx_bytes;
1567 bond_stats.rx_packets += slave_stats.tx_packets;
1568 bond_stats.rx_bytes += slave_stats.tx_bytes;
1572 if (!netdev_open_default(bond->name, &bond_dev)) {
1573 netdev_set_stats(bond_dev, &bond_stats);
1574 netdev_close(bond_dev);