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);
341 bond_slave_set_netdev__(struct bond *bond, struct bond_slave *slave,
342 struct netdev *netdev)
344 if (slave->netdev != netdev) {
347 netdev_monitor_remove(bond->monitor, slave->netdev);
349 netdev_monitor_add(bond->monitor, netdev);
351 slave->netdev = netdev;
355 /* Registers 'slave_' as a slave of 'bond'. The 'slave_' pointer is an
356 * arbitrary client-provided pointer that uniquely identifies a slave within a
357 * bond. If 'slave_' already exists within 'bond' then this function
358 * reconfigures the existing slave.
360 * 'stb_id' is used in BM_STABLE bonds to guarantee consistent slave choices
361 * across restarts and distributed vswitch instances. It should be unique per
362 * slave, and preferably consistent across restarts and reconfigurations.
364 * 'netdev' must be the network device that 'slave_' represents. It is owned
365 * by the client, so the client must not close it before either unregistering
366 * 'slave_' or destroying 'bond'.
369 bond_slave_register(struct bond *bond, void *slave_, uint32_t stb_id,
370 struct netdev *netdev)
372 struct bond_slave *slave = bond_slave_lookup(bond, slave_);
375 slave = xzalloc(sizeof *slave);
377 hmap_insert(&bond->slaves, &slave->hmap_node, hash_pointer(slave_, 0));
380 slave->delay_expires = LLONG_MAX;
381 slave->up = bond_is_link_up(bond, netdev);
382 slave->name = xstrdup(netdev_get_name(netdev));
383 bond->bond_revalidate = true;
385 slave->enabled = false;
386 bond_enable_slave(slave, slave->up, NULL);
389 if (slave->stb_id != stb_id) {
390 slave->stb_id = stb_id;
391 bond->bond_revalidate = true;
394 bond_slave_set_netdev__(bond, slave, netdev);
397 slave->name = xstrdup(netdev_get_name(netdev));
400 /* Updates the network device to be used with 'slave_' to 'netdev'.
402 * This is useful if the caller closes and re-opens the network device
403 * registered with bond_slave_register() but doesn't need to change anything
406 bond_slave_set_netdev(struct bond *bond, void *slave_, struct netdev *netdev)
408 struct bond_slave *slave = bond_slave_lookup(bond, slave_);
410 bond_slave_set_netdev__(bond, slave, netdev);
414 /* Unregisters 'slave_' from 'bond'. If 'bond' does not contain such a slave
415 * then this function has no effect.
417 * Unregistering a slave invalidates all flows. */
419 bond_slave_unregister(struct bond *bond, const void *slave_)
421 struct bond_slave *slave = bond_slave_lookup(bond, slave_);
429 netdev_monitor_remove(bond->monitor, slave->netdev);
432 bond_enable_slave(slave, false, NULL);
434 del_active = bond->active_slave == slave;
436 struct bond_entry *e;
437 for (e = bond->hash; e <= &bond->hash[BOND_MASK]; e++) {
438 if (e->slave == slave) {
446 hmap_remove(&bond->slaves, &slave->hmap_node);
447 /* Client owns 'slave->netdev'. */
454 bond_choose_active_slave(bond, &tags);
455 bond->send_learning_packets = true;
459 /* Should be called on each slave in 'bond' before bond_run() to indicate the
460 * results of lacp_slave_may_enable() on 'slave_'. */
462 bond_slave_set_lacp_may_enable(struct bond *bond, void *slave_,
465 bond_slave_lookup(bond, slave_)->lacp_may_enable = may_enable;
468 /* Performs periodic maintenance on 'bond'. The caller must provide 'tags' to
469 * allow tagged flows to be invalidated.
471 * The caller should check bond_should_send_learning_packets() afterward. */
473 bond_run(struct bond *bond, struct tag_set *tags, bool lacp_negotiated)
475 struct bond_slave *slave;
476 bool is_tcp_hash = bond_is_tcp_hash(bond);
478 bond->lacp_negotiated = lacp_negotiated;
480 /* Update link status. */
481 if (bond->detect == BLSM_CARRIER
482 || time_msec() >= bond->miimon_next_update)
484 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
485 slave->up = bond_is_link_up(bond, slave->netdev);
487 bond->miimon_next_update = time_msec() + bond->miimon_interval;
491 netdev_monitor_flush(bond->monitor);
494 /* Enable slaves based on link status and LACP feedback. */
495 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
496 bond_link_status_update(slave, tags);
498 if (!bond->active_slave || !bond->active_slave->enabled) {
499 bond_choose_active_slave(bond, tags);
502 /* Update fake bond interface stats. */
503 if (time_msec() >= bond->next_fake_iface_update) {
504 bond_update_fake_slave_stats(bond);
505 bond->next_fake_iface_update = time_msec() + 1000;
508 if (is_tcp_hash != bond_is_tcp_hash(bond)) {
509 bond->bond_revalidate = true;
512 if (bond->bond_revalidate) {
513 bond->bond_revalidate = false;
515 bond_entry_reset(bond);
516 if (bond->balance != BM_STABLE) {
517 struct bond_slave *slave;
519 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
520 tag_set_add(tags, slave->tag);
523 tag_set_add(tags, bond->stb_tag);
525 tag_set_add(tags, bond->no_slaves_tag);
528 /* Invalidate any tags required by */
529 tag_set_union(tags, &bond->unixctl_tags);
530 tag_set_init(&bond->unixctl_tags);
533 /* Causes poll_block() to wake up when 'bond' needs something to be done. */
535 bond_wait(struct bond *bond)
537 struct bond_slave *slave;
539 if (bond->detect == BLSM_CARRIER) {
540 netdev_monitor_poll_wait(bond->monitor);
542 poll_timer_wait_until(bond->miimon_next_update);
545 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
546 if (slave->delay_expires != LLONG_MAX) {
547 poll_timer_wait_until(slave->delay_expires);
551 if (bond->next_fake_iface_update != LLONG_MAX) {
552 poll_timer_wait_until(bond->next_fake_iface_update);
555 /* Ensure that any saved tags get revalidated right away. */
556 if (!tag_set_is_empty(&bond->unixctl_tags)) {
557 poll_immediate_wake();
560 /* We don't wait for bond->next_rebalance because rebalancing can only run
561 * at a flow account checkpoint. ofproto does checkpointing on its own
562 * schedule and bond_rebalance() gets called afterward, so we'd just be
563 * waking up for no purpose. */
566 /* MAC learning table interaction. */
569 may_send_learning_packets(const struct bond *bond)
571 return !bond->lacp_negotiated && bond->balance != BM_AB;
574 /* Returns true if 'bond' needs the client to send out packets to assist with
575 * MAC learning on 'bond'. If this function returns true, then the client
576 * should iterate through its MAC learning table for the bridge on which 'bond'
577 * is located. For each MAC that has been learned on a port other than 'bond',
578 * it should call bond_send_learning_packet().
580 * This function will only return true if 'bond' is in SLB mode and LACP is not
581 * negotiated. Otherwise sending learning packets isn't necessary.
583 * Calling this function resets the state that it checks. */
585 bond_should_send_learning_packets(struct bond *bond)
587 bool send = bond->send_learning_packets && may_send_learning_packets(bond);
588 bond->send_learning_packets = false;
592 /* Sends a gratuitous learning packet on 'bond' from 'eth_src' on 'vlan'.
594 * See bond_should_send_learning_packets() for description of usage. */
596 bond_send_learning_packet(struct bond *bond,
597 const uint8_t eth_src[ETH_ADDR_LEN],
600 struct bond_slave *slave;
601 struct ofpbuf packet;
605 assert(may_send_learning_packets(bond));
606 if (!bond->active_slave) {
607 /* Nowhere to send the learning packet. */
611 memset(&flow, 0, sizeof flow);
612 memcpy(flow.dl_src, eth_src, ETH_ADDR_LEN);
613 slave = choose_output_slave(bond, &flow, vlan);
615 ofpbuf_init(&packet, 0);
616 compose_benign_packet(&packet, "Open vSwitch Bond Failover", 0xf177,
619 eth_set_vlan_tci(&packet, htons(vlan));
621 error = netdev_send(slave->netdev, &packet);
622 ofpbuf_uninit(&packet);
627 /* Checks whether a packet that arrived on 'slave_' within 'bond', with an
628 * Ethernet destination address of 'eth_dst', should be admitted.
630 * The return value is one of the following:
632 * - BV_ACCEPT: Admit the packet.
634 * - BV_DROP: Drop the packet.
636 * - BV_DROP_IF_MOVED: Consult the MAC learning table for the packet's
637 * Ethernet source address and VLAN. If there is none, or if the packet
638 * is on the learned port, then admit the packet. If a different port has
639 * been learned, however, drop the packet (and do not use it for MAC
643 bond_check_admissibility(struct bond *bond, const void *slave_,
644 const uint8_t eth_dst[ETH_ADDR_LEN], tag_type *tags)
646 /* Admit all packets if LACP has been negotiated, because that means that
647 * the remote switch is aware of the bond and will "do the right thing". */
648 if (bond->lacp_negotiated) {
652 /* Drop all multicast packets on inactive slaves. */
653 if (eth_addr_is_multicast(eth_dst)) {
654 *tags |= bond_get_active_slave_tag(bond);
655 if (bond->active_slave != bond_slave_lookup(bond, slave_)) {
660 /* Drop all packets for which we have learned a different input port,
661 * because we probably sent the packet on one slave and got it back on the
662 * other. Gratuitous ARP packets are an exception to this rule: the host
663 * has moved to another switch. The exception to the exception is if we
664 * locked the learning table to avoid reflections on bond slaves. */
665 return BV_DROP_IF_MOVED;
668 /* Returns the slave (registered on 'bond' by bond_slave_register()) to which
669 * a packet with the given 'flow' and 'vlan' should be forwarded. Returns
670 * NULL if the packet should be dropped because no slaves are enabled.
672 * 'vlan' is not necessarily the same as 'flow->vlan_tci'. First, 'vlan'
673 * should be a VID only (i.e. excluding the PCP bits). Second,
674 * 'flow->vlan_tci' is the VLAN TCI that appeared on the packet (so it will be
675 * nonzero only for trunk ports), whereas 'vlan' is the logical VLAN that the
676 * packet belongs to (so for an access port it will be the access port's VLAN).
678 * Adds a tag to '*tags' that associates the flow with the returned slave.
681 bond_choose_output_slave(struct bond *bond, const struct flow *flow,
682 uint16_t vlan, tag_type *tags)
684 struct bond_slave *slave = choose_output_slave(bond, flow, vlan);
686 *tags |= bond->balance == BM_STABLE ? bond->stb_tag : slave->tag;
689 *tags |= bond->no_slaves_tag;
697 bond_is_balanced(const struct bond *bond)
699 return bond->balance == BM_SLB || bond->balance == BM_TCP;
702 /* Notifies 'bond' that 'n_bytes' bytes were sent in 'flow' within 'vlan'. */
704 bond_account(struct bond *bond, const struct flow *flow, uint16_t vlan,
708 if (bond_is_balanced(bond)) {
709 lookup_bond_entry(bond, flow, vlan)->tx_bytes += n_bytes;
713 static struct bond_slave *
714 bond_slave_from_bal_node(struct list *bal)
716 return CONTAINER_OF(bal, struct bond_slave, bal_node);
720 log_bals(struct bond *bond, const struct list *bals)
722 if (VLOG_IS_DBG_ENABLED()) {
723 struct ds ds = DS_EMPTY_INITIALIZER;
724 const struct bond_slave *slave;
726 LIST_FOR_EACH (slave, bal_node, bals) {
728 ds_put_char(&ds, ',');
730 ds_put_format(&ds, " %s %"PRIu64"kB",
731 slave->name, slave->tx_bytes / 1024);
733 if (!slave->enabled) {
734 ds_put_cstr(&ds, " (disabled)");
736 if (!list_is_empty(&slave->entries)) {
737 struct bond_entry *e;
739 ds_put_cstr(&ds, " (");
740 LIST_FOR_EACH (e, list_node, &slave->entries) {
741 if (&e->list_node != list_front(&slave->entries)) {
742 ds_put_cstr(&ds, " + ");
744 ds_put_format(&ds, "h%td: %"PRIu64"kB",
745 e - bond->hash, e->tx_bytes / 1024);
747 ds_put_cstr(&ds, ")");
750 VLOG_DBG("bond %s:%s", bond->name, ds_cstr(&ds));
755 /* Shifts 'hash' from its current slave to 'to'. */
757 bond_shift_load(struct bond_entry *hash, struct bond_slave *to,
760 struct bond_slave *from = hash->slave;
761 struct bond *bond = from->bond;
762 uint64_t delta = hash->tx_bytes;
764 VLOG_INFO("bond %s: shift %"PRIu64"kB of load (with hash %td) "
765 "from %s to %s (now carrying %"PRIu64"kB and "
766 "%"PRIu64"kB load, respectively)",
767 bond->name, delta / 1024, hash - bond->hash,
768 from->name, to->name,
769 (from->tx_bytes - delta) / 1024,
770 (to->tx_bytes + delta) / 1024);
772 /* Shift load away from 'from' to 'to'. */
773 from->tx_bytes -= delta;
774 to->tx_bytes += delta;
776 /* Arrange for flows to be revalidated. */
777 tag_set_add(set, hash->tag);
779 hash->tag = tag_create_random();
782 /* Pick and returns a bond_entry to migrate to 'to' (the least-loaded slave),
783 * given that doing so must decrease the ratio of the load on the two slaves by
784 * at least 0.1. Returns NULL if there is no appropriate entry.
786 * The list of entries isn't sorted. I don't know of a reason to prefer to
787 * shift away small hashes or large hashes. */
788 static struct bond_entry *
789 choose_entry_to_migrate(const struct bond_slave *from, uint64_t to_tx_bytes)
791 struct bond_entry *e;
793 if (list_is_short(&from->entries)) {
794 /* 'from' carries no more than one MAC hash, so shifting load away from
795 * it would be pointless. */
799 LIST_FOR_EACH (e, list_node, &from->entries) {
800 double old_ratio, new_ratio;
803 if (to_tx_bytes == 0) {
804 /* Nothing on the new slave, move it. */
809 old_ratio = (double)from->tx_bytes / to_tx_bytes;
810 new_ratio = (double)(from->tx_bytes - delta) / (to_tx_bytes + delta);
811 if (old_ratio - new_ratio > 0.1) {
812 /* Would decrease the ratio, move it. */
820 /* Inserts 'slave' into 'bals' so that descending order of 'tx_bytes' is
823 insert_bal(struct list *bals, struct bond_slave *slave)
825 struct bond_slave *pos;
827 LIST_FOR_EACH (pos, bal_node, bals) {
828 if (slave->tx_bytes > pos->tx_bytes) {
832 list_insert(&pos->bal_node, &slave->bal_node);
835 /* Removes 'slave' from its current list and then inserts it into 'bals' so
836 * that descending order of 'tx_bytes' is maintained. */
838 reinsert_bal(struct list *bals, struct bond_slave *slave)
840 list_remove(&slave->bal_node);
841 insert_bal(bals, slave);
844 /* If 'bond' needs rebalancing, does so.
846 * The caller should have called bond_account() for each active flow, to ensure
847 * that flow data is consistently accounted at this point. */
849 bond_rebalance(struct bond *bond, struct tag_set *tags)
851 struct bond_slave *slave;
852 struct bond_entry *e;
855 if (!bond_is_balanced(bond) || time_msec() < bond->next_rebalance) {
858 bond->next_rebalance = time_msec() + bond->rebalance_interval;
860 /* Add each bond_entry to its slave's 'entries' list.
861 * Compute each slave's tx_bytes as the sum of its entries' tx_bytes. */
862 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
864 list_init(&slave->entries);
866 for (e = &bond->hash[0]; e <= &bond->hash[BOND_MASK]; e++) {
867 if (e->slave && e->tx_bytes) {
868 e->slave->tx_bytes += e->tx_bytes;
869 list_push_back(&e->slave->entries, &e->list_node);
873 /* Add enabled slaves to 'bals' in descending order of tx_bytes.
875 * XXX This is O(n**2) in the number of slaves but it could be O(n lg n)
876 * with a proper list sort algorithm. */
878 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
879 if (slave->enabled) {
880 insert_bal(&bals, slave);
883 log_bals(bond, &bals);
885 /* Shift load from the most-loaded slaves to the least-loaded slaves. */
886 while (!list_is_short(&bals)) {
887 struct bond_slave *from = bond_slave_from_bal_node(list_front(&bals));
888 struct bond_slave *to = bond_slave_from_bal_node(list_back(&bals));
891 overload = from->tx_bytes - to->tx_bytes;
892 if (overload < to->tx_bytes >> 5 || overload < 100000) {
893 /* The extra load on 'from' (and all less-loaded slaves), compared
894 * to that of 'to' (the least-loaded slave), is less than ~3%, or
895 * it is less than ~1Mbps. No point in rebalancing. */
899 /* 'from' is carrying significantly more load than 'to', and that load
900 * is split across at least two different hashes. */
901 e = choose_entry_to_migrate(from, to->tx_bytes);
903 bond_shift_load(e, to, tags);
905 /* Delete element from from->entries.
907 * We don't add the element to to->hashes. That would only allow
908 * 'e' to be migrated to another slave in this rebalancing run, and
909 * there is no point in doing that. */
910 list_remove(&e->list_node);
912 /* Re-sort 'bals'. */
913 reinsert_bal(&bals, from);
914 reinsert_bal(&bals, to);
916 /* Can't usefully migrate anything away from 'from'.
917 * Don't reconsider it. */
918 list_remove(&from->bal_node);
922 /* Implement exponentially weighted moving average. A weight of 1/2 causes
923 * historical data to decay to <1% in 7 rebalancing runs. 1,000,000 bytes
924 * take 20 rebalancing runs to decay to 0 and get deleted entirely. */
925 for (e = &bond->hash[0]; e <= &bond->hash[BOND_MASK]; e++) {
933 /* Bonding unixctl user interface functions. */
936 bond_find(const char *name)
940 HMAP_FOR_EACH_WITH_HASH (bond, hmap_node, hash_string(name, 0),
942 if (!strcmp(bond->name, name)) {
949 static struct bond_slave *
950 bond_lookup_slave(struct bond *bond, const char *slave_name)
952 struct bond_slave *slave;
954 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
955 if (!strcmp(slave->name, slave_name)) {
963 bond_unixctl_list(struct unixctl_conn *conn,
964 const char *args OVS_UNUSED, void *aux OVS_UNUSED)
966 struct ds ds = DS_EMPTY_INITIALIZER;
967 const struct bond *bond;
969 ds_put_cstr(&ds, "bond\ttype\tslaves\n");
971 HMAP_FOR_EACH (bond, hmap_node, &all_bonds) {
972 const struct bond_slave *slave;
975 ds_put_format(&ds, "%s\t%s\t",
976 bond->name, bond_mode_to_string(bond->balance));
979 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
981 ds_put_cstr(&ds, ", ");
983 ds_put_cstr(&ds, slave->name);
985 ds_put_char(&ds, '\n');
987 unixctl_command_reply(conn, 200, ds_cstr(&ds));
992 bond_unixctl_show(struct unixctl_conn *conn,
993 const char *args, void *aux OVS_UNUSED)
995 struct ds ds = DS_EMPTY_INITIALIZER;
996 const struct bond_slave *slave;
997 const struct bond *bond;
999 bond = bond_find(args);
1001 unixctl_command_reply(conn, 501, "no such bond");
1005 ds_put_format(&ds, "bond_mode: %s\n",
1006 bond_mode_to_string(bond->balance));
1008 if (bond->balance != BM_AB) {
1009 ds_put_format(&ds, "bond-hash-algorithm: %s\n",
1010 bond_is_tcp_hash(bond) ? "balance-tcp" : "balance-slb");
1013 ds_put_format(&ds, "bond-hash-basis: %"PRIu32"\n", bond->basis);
1015 ds_put_format(&ds, "bond-detect-mode: %s\n",
1016 bond->monitor ? "carrier" : "miimon");
1018 if (!bond->monitor) {
1019 ds_put_format(&ds, "bond-miimon-interval: %lld\n",
1020 bond->miimon_interval);
1023 ds_put_format(&ds, "updelay: %d ms\n", bond->updelay);
1024 ds_put_format(&ds, "downdelay: %d ms\n", bond->downdelay);
1026 if (bond_is_balanced(bond)) {
1027 ds_put_format(&ds, "next rebalance: %lld ms\n",
1028 bond->next_rebalance - time_msec());
1031 ds_put_format(&ds, "lacp_negotiated: %s\n",
1032 bond->lacp_negotiated ? "true" : "false");
1034 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1035 struct bond_entry *be;
1039 ds_put_format(&ds, "\nslave %s: %s\n",
1040 slave->name, slave->enabled ? "enabled" : "disabled");
1041 if (slave == bond->active_slave) {
1042 ds_put_cstr(&ds, "\tactive slave\n");
1044 if (slave->delay_expires != LLONG_MAX) {
1045 ds_put_format(&ds, "\t%s expires in %lld ms\n",
1046 slave->enabled ? "downdelay" : "updelay",
1047 slave->delay_expires - time_msec());
1050 ds_put_format(&ds, "\tlacp_may_enable: %s\n",
1051 slave->lacp_may_enable ? "true" : "false");
1053 if (!bond_is_balanced(bond)) {
1058 memset(&flow, 0, sizeof flow);
1059 for (be = bond->hash; be <= &bond->hash[BOND_MASK]; be++) {
1060 int hash = be - bond->hash;
1062 if (be->slave != slave) {
1066 ds_put_format(&ds, "\thash %d: %"PRIu64" kB load\n",
1067 hash, be->tx_bytes / 1024);
1069 if (bond->balance != BM_SLB) {
1073 /* XXX How can we list the MACs assigned to hashes? */
1076 unixctl_command_reply(conn, 200, ds_cstr(&ds));
1081 bond_unixctl_migrate(struct unixctl_conn *conn, const char *args_,
1082 void *aux OVS_UNUSED)
1084 char *args = (char *) args_;
1085 char *save_ptr = NULL;
1086 char *bond_s, *hash_s, *slave_s;
1088 struct bond_slave *slave;
1089 struct bond_entry *entry;
1092 bond_s = strtok_r(args, " ", &save_ptr);
1093 hash_s = strtok_r(NULL, " ", &save_ptr);
1094 slave_s = strtok_r(NULL, " ", &save_ptr);
1096 unixctl_command_reply(conn, 501,
1097 "usage: bond/migrate BOND HASH SLAVE");
1101 bond = bond_find(bond_s);
1103 unixctl_command_reply(conn, 501, "no such bond");
1107 if (bond->balance != BM_SLB) {
1108 unixctl_command_reply(conn, 501, "not an SLB bond");
1112 if (strspn(hash_s, "0123456789") == strlen(hash_s)) {
1113 hash = atoi(hash_s) & BOND_MASK;
1115 unixctl_command_reply(conn, 501, "bad hash");
1119 slave = bond_lookup_slave(bond, slave_s);
1121 unixctl_command_reply(conn, 501, "no such slave");
1125 if (!slave->enabled) {
1126 unixctl_command_reply(conn, 501, "cannot migrate to disabled slave");
1130 entry = &bond->hash[hash];
1131 tag_set_add(&bond->unixctl_tags, entry->tag);
1132 entry->slave = slave;
1133 entry->tag = tag_create_random();
1134 unixctl_command_reply(conn, 200, "migrated");
1138 bond_unixctl_set_active_slave(struct unixctl_conn *conn, const char *args_,
1139 void *aux OVS_UNUSED)
1141 char *args = (char *) args_;
1142 char *save_ptr = NULL;
1143 char *bond_s, *slave_s;
1145 struct bond_slave *slave;
1147 bond_s = strtok_r(args, " ", &save_ptr);
1148 slave_s = strtok_r(NULL, " ", &save_ptr);
1150 unixctl_command_reply(conn, 501,
1151 "usage: bond/set-active-slave BOND SLAVE");
1155 bond = bond_find(bond_s);
1157 unixctl_command_reply(conn, 501, "no such bond");
1161 slave = bond_lookup_slave(bond, slave_s);
1163 unixctl_command_reply(conn, 501, "no such slave");
1167 if (!slave->enabled) {
1168 unixctl_command_reply(conn, 501, "cannot make disabled slave active");
1172 if (bond->active_slave != slave) {
1173 tag_set_add(&bond->unixctl_tags, bond_get_active_slave_tag(bond));
1174 bond->active_slave = slave;
1175 bond->active_slave->tag = tag_create_random();
1176 VLOG_INFO("bond %s: active interface is now %s",
1177 bond->name, slave->name);
1178 bond->send_learning_packets = true;
1179 unixctl_command_reply(conn, 200, "done");
1181 unixctl_command_reply(conn, 200, "no change");
1186 enable_slave(struct unixctl_conn *conn, const char *args_, bool enable)
1188 char *args = (char *) args_;
1189 char *save_ptr = NULL;
1190 char *bond_s, *slave_s;
1192 struct bond_slave *slave;
1194 bond_s = strtok_r(args, " ", &save_ptr);
1195 slave_s = strtok_r(NULL, " ", &save_ptr);
1197 char *usage = xasprintf("usage: bond/%s-slave BOND SLAVE",
1198 enable ? "enable" : "disable");
1199 unixctl_command_reply(conn, 501, usage);
1204 bond = bond_find(bond_s);
1206 unixctl_command_reply(conn, 501, "no such bond");
1210 slave = bond_lookup_slave(bond, slave_s);
1212 unixctl_command_reply(conn, 501, "no such slave");
1216 bond_enable_slave(slave, enable, &bond->unixctl_tags);
1217 unixctl_command_reply(conn, 501, enable ? "enabled" : "disabled");
1221 bond_unixctl_enable_slave(struct unixctl_conn *conn, const char *args,
1222 void *aux OVS_UNUSED)
1224 enable_slave(conn, args, true);
1228 bond_unixctl_disable_slave(struct unixctl_conn *conn, const char *args,
1229 void *aux OVS_UNUSED)
1231 enable_slave(conn, args, false);
1235 bond_unixctl_hash(struct unixctl_conn *conn, const char *args_,
1236 void *aux OVS_UNUSED)
1238 char *args = (char *) args_;
1239 uint8_t mac[ETH_ADDR_LEN];
1244 char *mac_s, *vlan_s, *basis_s;
1245 char *save_ptr = NULL;
1247 mac_s = strtok_r(args, " ", &save_ptr);
1248 vlan_s = strtok_r(NULL, " ", &save_ptr);
1249 basis_s = strtok_r(NULL, " ", &save_ptr);
1252 if (sscanf(vlan_s, "%u", &vlan) != 1) {
1253 unixctl_command_reply(conn, 501, "invalid vlan");
1257 vlan = OFP_VLAN_NONE;
1261 if (sscanf(basis_s, "%"PRIu32, &basis) != 1) {
1262 unixctl_command_reply(conn, 501, "invalid basis");
1269 if (sscanf(mac_s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
1270 == ETH_ADDR_SCAN_COUNT) {
1271 hash = bond_hash_src(mac, vlan, basis) & BOND_MASK;
1273 hash_cstr = xasprintf("%u", hash);
1274 unixctl_command_reply(conn, 200, hash_cstr);
1277 unixctl_command_reply(conn, 501, "invalid mac");
1284 unixctl_command_register("bond/list", bond_unixctl_list, NULL);
1285 unixctl_command_register("bond/show", bond_unixctl_show, NULL);
1286 unixctl_command_register("bond/migrate", bond_unixctl_migrate, NULL);
1287 unixctl_command_register("bond/set-active-slave",
1288 bond_unixctl_set_active_slave, NULL);
1289 unixctl_command_register("bond/enable-slave", bond_unixctl_enable_slave,
1291 unixctl_command_register("bond/disable-slave", bond_unixctl_disable_slave,
1293 unixctl_command_register("bond/hash", bond_unixctl_hash, NULL);
1297 bond_entry_reset(struct bond *bond)
1299 if (bond->balance != BM_AB) {
1300 size_t hash_len = (BOND_MASK + 1) * sizeof *bond->hash;
1303 bond->hash = xmalloc(hash_len);
1305 memset(bond->hash, 0, hash_len);
1307 bond->next_rebalance = time_msec() + bond->rebalance_interval;
1314 static struct bond_slave *
1315 bond_slave_lookup(struct bond *bond, const void *slave_)
1317 struct bond_slave *slave;
1319 HMAP_FOR_EACH_IN_BUCKET (slave, hmap_node, hash_pointer(slave_, 0),
1321 if (slave->aux == slave_) {
1330 bond_is_link_up(struct bond *bond, struct netdev *netdev)
1332 return (bond->detect == BLSM_CARRIER
1333 ? netdev_get_carrier(netdev)
1334 : netdev_get_miimon(netdev));
1338 bond_enable_slave(struct bond_slave *slave, bool enable, struct tag_set *tags)
1340 struct bond *bond = slave->bond;
1341 slave->delay_expires = LLONG_MAX;
1342 if (enable != slave->enabled) {
1343 slave->enabled = enable;
1344 if (!slave->enabled) {
1345 VLOG_WARN("interface %s: disabled", slave->name);
1347 tag_set_add(tags, slave->tag);
1350 VLOG_WARN("interface %s: enabled", slave->name);
1351 slave->tag = tag_create_random();
1354 if (bond->balance == BM_STABLE) {
1355 bond->bond_revalidate = true;
1361 bond_link_status_update(struct bond_slave *slave, struct tag_set *tags)
1363 struct bond *bond = slave->bond;
1366 up = slave->up && slave->lacp_may_enable;
1367 if ((up == slave->enabled) != (slave->delay_expires == LLONG_MAX)) {
1368 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1369 VLOG_INFO_RL(&rl, "interface %s: link state %s",
1370 slave->name, up ? "up" : "down");
1371 if (up == slave->enabled) {
1372 slave->delay_expires = LLONG_MAX;
1373 VLOG_INFO_RL(&rl, "interface %s: will not be %s",
1374 slave->name, up ? "disabled" : "enabled");
1376 int delay = (bond->lacp_negotiated ? 0
1377 : up ? bond->updelay : bond->downdelay);
1378 slave->delay_expires = time_msec() + delay;
1380 VLOG_INFO_RL(&rl, "interface %s: will be %s if it stays %s "
1383 up ? "enabled" : "disabled",
1390 if (time_msec() >= slave->delay_expires) {
1391 bond_enable_slave(slave, up, tags);
1396 bond_is_tcp_hash(const struct bond *bond)
1398 return (bond->balance == BM_TCP || bond->balance == BM_STABLE)
1399 && bond->lacp_negotiated;
1403 bond_hash_src(const uint8_t mac[ETH_ADDR_LEN], uint16_t vlan, uint32_t basis)
1405 return hash_3words(hash_bytes(mac, ETH_ADDR_LEN, 0), vlan, basis);
1409 bond_hash_tcp(const struct flow *flow, uint16_t vlan, uint32_t basis)
1411 struct flow hash_flow = *flow;
1412 hash_flow.vlan_tci = htons(vlan);
1414 /* The symmetric quality of this hash function is not required, but
1415 * flow_hash_symmetric_l4 already exists, and is sufficient for our
1416 * purposes, so we use it out of convenience. */
1417 return flow_hash_symmetric_l4(&hash_flow, basis);
1421 bond_hash(const struct bond *bond, const struct flow *flow, uint16_t vlan)
1423 assert(bond->balance != BM_AB);
1425 return (bond_is_tcp_hash(bond)
1426 ? bond_hash_tcp(flow, vlan, bond->basis)
1427 : bond_hash_src(flow->dl_src, vlan, bond->basis));
1430 static struct bond_entry *
1431 lookup_bond_entry(const struct bond *bond, const struct flow *flow,
1434 return &bond->hash[bond_hash(bond, flow, vlan) & BOND_MASK];
1437 /* This function uses Highest Random Weight hashing to choose an output slave.
1438 * This approach only reassigns a minimal number of flows when slaves are
1439 * enabled or disabled. Unfortunately, it has O(n) performance against the
1440 * number of slaves. There exist algorithms which are O(1), but have slightly
1441 * more complex implementations and require the use of memory. This may need
1442 * to be reimplemented if it becomes a performance bottleneck. */
1443 static struct bond_slave *
1444 choose_stb_slave(const struct bond *bond, const struct flow *flow,
1447 struct bond_slave *best, *slave;
1448 uint32_t best_hash, flow_hash;
1452 flow_hash = bond_hash(bond, flow, vlan);
1453 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1454 if (slave->enabled) {
1457 hash = hash_2words(flow_hash, slave->stb_id);
1458 if (!best || hash > best_hash) {
1468 static struct bond_slave *
1469 choose_output_slave(const struct bond *bond, const struct flow *flow,
1472 struct bond_entry *e;
1474 switch (bond->balance) {
1476 return bond->active_slave;
1479 return choose_stb_slave(bond, flow, vlan);
1482 e = lookup_bond_entry(bond, flow, vlan);
1483 if (!e->slave || !e->slave->enabled) {
1484 e->slave = CONTAINER_OF(hmap_random_node(&bond->slaves),
1485 struct bond_slave, hmap_node);
1486 if (!e->slave->enabled) {
1487 e->slave = bond->active_slave;
1489 e->tag = tag_create_random();
1498 static struct bond_slave *
1499 bond_choose_slave(const struct bond *bond)
1501 struct bond_slave *slave, *best;
1503 /* Find an enabled slave. */
1504 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1505 if (slave->enabled) {
1510 /* All interfaces are disabled. Find an interface that will be enabled
1511 * after its updelay expires. */
1513 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1514 if (slave->delay_expires != LLONG_MAX
1515 && slave->lacp_may_enable
1516 && (!best || slave->delay_expires < best->delay_expires)) {
1524 bond_choose_active_slave(struct bond *bond, struct tag_set *tags)
1526 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1527 struct bond_slave *old_active_slave = bond->active_slave;
1529 bond->active_slave = bond_choose_slave(bond);
1530 if (bond->active_slave) {
1531 if (bond->active_slave->enabled) {
1532 VLOG_INFO_RL(&rl, "bond %s: active interface is now %s",
1533 bond->name, bond->active_slave->name);
1535 VLOG_INFO_RL(&rl, "bond %s: active interface is now %s, skipping "
1536 "remaining %lld ms updelay (since no interface was "
1537 "enabled)", bond->name, bond->active_slave->name,
1538 bond->active_slave->delay_expires - time_msec());
1539 bond_enable_slave(bond->active_slave, true, tags);
1542 if (!old_active_slave) {
1543 tag_set_add(tags, bond->no_slaves_tag);
1546 bond->send_learning_packets = true;
1547 } else if (old_active_slave) {
1548 VLOG_WARN_RL(&rl, "bond %s: all interfaces disabled", bond->name);
1552 /* Returns the tag for 'bond''s active slave, or 'bond''s no_slaves_tag if
1553 * there is no active slave. */
1555 bond_get_active_slave_tag(const struct bond *bond)
1557 return (bond->active_slave
1558 ? bond->active_slave->tag
1559 : bond->no_slaves_tag);
1562 /* Attempts to make the sum of the bond slaves' statistics appear on the fake
1563 * bond interface. */
1565 bond_update_fake_slave_stats(struct bond *bond)
1567 struct netdev_stats bond_stats;
1568 struct bond_slave *slave;
1569 struct netdev *bond_dev;
1571 memset(&bond_stats, 0, sizeof bond_stats);
1573 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1574 struct netdev_stats slave_stats;
1576 if (!netdev_get_stats(slave->netdev, &slave_stats)) {
1577 /* XXX: We swap the stats here because they are swapped back when
1578 * reported by the internal device. The reason for this is
1579 * internal devices normally represent packets going into the
1580 * system but when used as fake bond device they represent packets
1581 * leaving the system. We really should do this in the internal
1582 * device itself because changing it here reverses the counts from
1583 * the perspective of the switch. However, the internal device
1584 * doesn't know what type of device it represents so we have to do
1585 * it here for now. */
1586 bond_stats.tx_packets += slave_stats.rx_packets;
1587 bond_stats.tx_bytes += slave_stats.rx_bytes;
1588 bond_stats.rx_packets += slave_stats.tx_packets;
1589 bond_stats.rx_bytes += slave_stats.tx_bytes;
1593 if (!netdev_open_default(bond->name, &bond_dev)) {
1594 netdev_set_stats(bond_dev, &bond_stats);
1595 netdev_close(bond_dev);