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 enabled; /* May be chosen for flows? */
67 bool lacp_may_enable; /* LACP considers this interface bondable. */
68 tag_type tag; /* Tag associated with this slave. */
70 /* Rebalancing info. Used only by bond_rebalance(). */
71 struct list bal_node; /* In bond_rebalance()'s 'bals' list. */
72 struct list entries; /* 'struct bond_entry's assigned here. */
73 uint64_t tx_bytes; /* Sum across 'tx_bytes' of entries. */
75 /* BM_STABLE specific bonding info. */
76 uint32_t stb_id; /* ID used for 'stb_slaves' ordering. */
79 /* A bond, that is, a set of network devices grouped to improve performance or
82 struct hmap_node hmap_node; /* In 'all_bonds' hmap. */
83 char *name; /* Name provided by client. */
89 enum bond_mode balance; /* Balancing mode, one of BM_*. */
90 struct bond_slave *active_slave;
91 tag_type no_slaves_tag; /* Tag for flows when all slaves disabled. */
92 int updelay, downdelay; /* Delay before slave goes up/down, in ms. */
93 bool lacp_negotiated; /* LACP negotiations were successful. */
94 bool bond_revalidate; /* True if flows need revalidation. */
95 uint32_t basis; /* Basis for flow hash function. */
97 /* SLB specific bonding info. */
98 struct bond_entry *hash; /* An array of (BOND_MASK + 1) elements. */
99 int rebalance_interval; /* Interval between rebalances, in ms. */
100 long long int next_rebalance; /* Next rebalancing time. */
101 bool send_learning_packets;
103 /* BM_STABLE specific bonding info. */
104 tag_type stb_tag; /* Tag associated with this bond. */
107 struct netdev_monitor *monitor; /* detect == BLSM_CARRIER only. */
109 /* Legacy compatibility. */
110 long long int next_fake_iface_update; /* LLONG_MAX if disabled. */
112 /* Tag set saved for next bond_run(). This tag set is a kluge for cases
113 * where we can't otherwise provide revalidation feedback to the client.
114 * That's only unixctl commands now; I hope no other cases will arise. */
115 struct tag_set unixctl_tags;
118 static struct hmap all_bonds = HMAP_INITIALIZER(&all_bonds);
120 static void bond_entry_reset(struct bond *);
121 static struct bond_slave *bond_slave_lookup(struct bond *, const void *slave_);
122 static void bond_enable_slave(struct bond_slave *, bool enable,
124 static void bond_link_status_update(struct bond_slave *, struct tag_set *);
125 static void bond_choose_active_slave(struct bond *, struct tag_set *);
126 static bool bond_is_tcp_hash(const struct bond *);
127 static unsigned int bond_hash_src(const uint8_t mac[ETH_ADDR_LEN],
128 uint16_t vlan, uint32_t basis);
129 static unsigned int bond_hash_tcp(const struct flow *, uint16_t vlan,
131 static struct bond_entry *lookup_bond_entry(const struct bond *,
134 static tag_type bond_get_active_slave_tag(const struct bond *);
135 static struct bond_slave *choose_output_slave(const struct bond *,
138 static void bond_update_fake_slave_stats(struct bond *);
140 /* Attempts to parse 's' as the name of a bond balancing mode. If successful,
141 * stores the mode in '*balance' and returns true. Otherwise returns false
142 * without modifying '*balance'. */
144 bond_mode_from_string(enum bond_mode *balance, const char *s)
146 if (!strcmp(s, bond_mode_to_string(BM_TCP))) {
148 } else if (!strcmp(s, bond_mode_to_string(BM_SLB))) {
150 } else if (!strcmp(s, bond_mode_to_string(BM_STABLE))) {
151 *balance = BM_STABLE;
152 } else if (!strcmp(s, bond_mode_to_string(BM_AB))) {
160 /* Returns a string representing 'balance'. */
162 bond_mode_to_string(enum bond_mode balance) {
165 return "balance-tcp";
167 return "balance-slb";
171 return "active-backup";
177 /* Creates and returns a new bond whose configuration is initially taken from
180 * The caller should register each slave on the new bond by calling
181 * bond_slave_register(). */
183 bond_create(const struct bond_settings *s)
187 bond = xzalloc(sizeof *bond);
188 hmap_init(&bond->slaves);
189 bond->no_slaves_tag = tag_create_random();
190 bond->stb_tag = tag_create_random();
191 bond->next_fake_iface_update = LLONG_MAX;
192 bond->monitor = netdev_monitor_create();
194 bond_reconfigure(bond, s);
196 tag_set_init(&bond->unixctl_tags);
203 bond_destroy(struct bond *bond)
205 struct bond_slave *slave, *next_slave;
211 hmap_remove(&all_bonds, &bond->hmap_node);
213 HMAP_FOR_EACH_SAFE (slave, next_slave, hmap_node, &bond->slaves) {
214 hmap_remove(&bond->slaves, &slave->hmap_node);
215 /* Client owns 'slave->netdev'. */
219 hmap_destroy(&bond->slaves);
223 netdev_monitor_destroy(bond->monitor);
229 /* Updates 'bond''s overall configuration to 's'.
231 * The caller should register each slave on 'bond' by calling
232 * bond_slave_register(). This is optional if none of the slaves'
233 * configuration has changed. In any case it can't hurt.
235 * Returns true if the configuration has changed in such a way that requires
239 bond_reconfigure(struct bond *bond, const struct bond_settings *s)
241 bool revalidate = false;
243 if (!bond->name || strcmp(bond->name, s->name)) {
245 hmap_remove(&all_bonds, &bond->hmap_node);
248 bond->name = xstrdup(s->name);
249 hmap_insert(&all_bonds, &bond->hmap_node, hash_string(bond->name, 0));
252 bond->updelay = s->up_delay;
253 bond->downdelay = s->down_delay;
254 bond->rebalance_interval = s->rebalance_interval;
256 if (bond->balance != s->balance) {
257 bond->balance = s->balance;
261 if (bond->basis != s->basis) {
262 bond->basis = s->basis;
267 if (bond->next_fake_iface_update == LLONG_MAX) {
268 bond->next_fake_iface_update = time_msec();
271 bond->next_fake_iface_update = LLONG_MAX;
274 if (bond->bond_revalidate) {
276 bond->bond_revalidate = false;
279 if (bond->balance == BM_AB || !bond->hash || revalidate) {
280 bond_entry_reset(bond);
287 bond_slave_set_netdev__(struct bond *bond, struct bond_slave *slave,
288 struct netdev *netdev)
290 if (slave->netdev != netdev) {
292 netdev_monitor_remove(bond->monitor, slave->netdev);
294 netdev_monitor_add(bond->monitor, netdev);
295 slave->netdev = netdev;
299 /* Registers 'slave_' as a slave of 'bond'. The 'slave_' pointer is an
300 * arbitrary client-provided pointer that uniquely identifies a slave within a
301 * bond. If 'slave_' already exists within 'bond' then this function
302 * reconfigures the existing slave.
304 * 'stb_id' is used in BM_STABLE bonds to guarantee consistent slave choices
305 * across restarts and distributed vswitch instances. It should be unique per
306 * slave, and preferably consistent across restarts and reconfigurations.
308 * 'netdev' must be the network device that 'slave_' represents. It is owned
309 * by the client, so the client must not close it before either unregistering
310 * 'slave_' or destroying 'bond'.
313 bond_slave_register(struct bond *bond, void *slave_, uint32_t stb_id,
314 struct netdev *netdev)
316 struct bond_slave *slave = bond_slave_lookup(bond, slave_);
319 slave = xzalloc(sizeof *slave);
321 hmap_insert(&bond->slaves, &slave->hmap_node, hash_pointer(slave_, 0));
324 slave->delay_expires = LLONG_MAX;
325 slave->name = xstrdup(netdev_get_name(netdev));
326 bond->bond_revalidate = true;
328 slave->enabled = false;
329 bond_enable_slave(slave, netdev_get_carrier(netdev), NULL);
332 if (slave->stb_id != stb_id) {
333 slave->stb_id = stb_id;
334 bond->bond_revalidate = true;
337 bond_slave_set_netdev__(bond, slave, netdev);
340 slave->name = xstrdup(netdev_get_name(netdev));
343 /* Updates the network device to be used with 'slave_' to 'netdev'.
345 * This is useful if the caller closes and re-opens the network device
346 * registered with bond_slave_register() but doesn't need to change anything
349 bond_slave_set_netdev(struct bond *bond, void *slave_, struct netdev *netdev)
351 struct bond_slave *slave = bond_slave_lookup(bond, slave_);
353 bond_slave_set_netdev__(bond, slave, netdev);
357 /* Unregisters 'slave_' from 'bond'. If 'bond' does not contain such a slave
358 * then this function has no effect.
360 * Unregistering a slave invalidates all flows. */
362 bond_slave_unregister(struct bond *bond, const void *slave_)
364 struct bond_slave *slave = bond_slave_lookup(bond, slave_);
371 netdev_monitor_remove(bond->monitor, slave->netdev);
372 bond_enable_slave(slave, false, NULL);
374 del_active = bond->active_slave == slave;
376 struct bond_entry *e;
377 for (e = bond->hash; e <= &bond->hash[BOND_MASK]; e++) {
378 if (e->slave == slave) {
386 hmap_remove(&bond->slaves, &slave->hmap_node);
387 /* Client owns 'slave->netdev'. */
394 bond_choose_active_slave(bond, &tags);
395 bond->send_learning_packets = true;
399 /* Should be called on each slave in 'bond' before bond_run() to indicate the
400 * results of lacp_slave_may_enable() on 'slave_'. */
402 bond_slave_set_lacp_may_enable(struct bond *bond, void *slave_,
405 bond_slave_lookup(bond, slave_)->lacp_may_enable = may_enable;
408 /* Performs periodic maintenance on 'bond'. The caller must provide 'tags' to
409 * allow tagged flows to be invalidated.
411 * The caller should check bond_should_send_learning_packets() afterward. */
413 bond_run(struct bond *bond, struct tag_set *tags, bool lacp_negotiated)
415 struct bond_slave *slave;
416 bool is_tcp_hash = bond_is_tcp_hash(bond);
418 bond->lacp_negotiated = lacp_negotiated;
421 netdev_monitor_flush(bond->monitor);
424 /* Enable slaves based on link status and LACP feedback. */
425 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
426 bond_link_status_update(slave, tags);
428 if (!bond->active_slave || !bond->active_slave->enabled) {
429 bond_choose_active_slave(bond, tags);
432 /* Update fake bond interface stats. */
433 if (time_msec() >= bond->next_fake_iface_update) {
434 bond_update_fake_slave_stats(bond);
435 bond->next_fake_iface_update = time_msec() + 1000;
438 if (is_tcp_hash != bond_is_tcp_hash(bond)) {
439 bond->bond_revalidate = true;
442 if (bond->bond_revalidate) {
443 bond->bond_revalidate = false;
445 bond_entry_reset(bond);
446 if (bond->balance != BM_STABLE) {
447 struct bond_slave *slave;
449 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
450 tag_set_add(tags, slave->tag);
453 tag_set_add(tags, bond->stb_tag);
455 tag_set_add(tags, bond->no_slaves_tag);
458 /* Invalidate any tags required by */
459 tag_set_union(tags, &bond->unixctl_tags);
460 tag_set_init(&bond->unixctl_tags);
463 /* Causes poll_block() to wake up when 'bond' needs something to be done. */
465 bond_wait(struct bond *bond)
467 struct bond_slave *slave;
469 netdev_monitor_poll_wait(bond->monitor);
471 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
472 if (slave->delay_expires != LLONG_MAX) {
473 poll_timer_wait_until(slave->delay_expires);
477 if (bond->next_fake_iface_update != LLONG_MAX) {
478 poll_timer_wait_until(bond->next_fake_iface_update);
481 /* Ensure that any saved tags get revalidated right away. */
482 if (!tag_set_is_empty(&bond->unixctl_tags)) {
483 poll_immediate_wake();
486 /* We don't wait for bond->next_rebalance because rebalancing can only run
487 * at a flow account checkpoint. ofproto does checkpointing on its own
488 * schedule and bond_rebalance() gets called afterward, so we'd just be
489 * waking up for no purpose. */
492 /* MAC learning table interaction. */
495 may_send_learning_packets(const struct bond *bond)
497 return !bond->lacp_negotiated && bond->balance != BM_AB;
500 /* Returns true if 'bond' needs the client to send out packets to assist with
501 * MAC learning on 'bond'. If this function returns true, then the client
502 * should iterate through its MAC learning table for the bridge on which 'bond'
503 * is located. For each MAC that has been learned on a port other than 'bond',
504 * it should call bond_send_learning_packet().
506 * This function will only return true if 'bond' is in SLB mode and LACP is not
507 * negotiated. Otherwise sending learning packets isn't necessary.
509 * Calling this function resets the state that it checks. */
511 bond_should_send_learning_packets(struct bond *bond)
513 bool send = bond->send_learning_packets && may_send_learning_packets(bond);
514 bond->send_learning_packets = false;
518 /* Sends a gratuitous learning packet on 'bond' from 'eth_src' on 'vlan'.
520 * See bond_should_send_learning_packets() for description of usage. */
522 bond_send_learning_packet(struct bond *bond,
523 const uint8_t eth_src[ETH_ADDR_LEN],
526 struct bond_slave *slave;
527 struct ofpbuf packet;
531 assert(may_send_learning_packets(bond));
532 if (!bond->active_slave) {
533 /* Nowhere to send the learning packet. */
537 memset(&flow, 0, sizeof flow);
538 memcpy(flow.dl_src, eth_src, ETH_ADDR_LEN);
539 slave = choose_output_slave(bond, &flow, vlan);
541 ofpbuf_init(&packet, 0);
542 compose_benign_packet(&packet, "Open vSwitch Bond Failover", 0xf177,
545 eth_set_vlan_tci(&packet, htons(vlan));
547 error = netdev_send(slave->netdev, &packet);
548 ofpbuf_uninit(&packet);
553 /* Checks whether a packet that arrived on 'slave_' within 'bond', with an
554 * Ethernet destination address of 'eth_dst', should be admitted.
556 * The return value is one of the following:
558 * - BV_ACCEPT: Admit the packet.
560 * - BV_DROP: Drop the packet.
562 * - BV_DROP_IF_MOVED: Consult the MAC learning table for the packet's
563 * Ethernet source address and VLAN. If there is none, or if the packet
564 * is on the learned port, then admit the packet. If a different port has
565 * been learned, however, drop the packet (and do not use it for MAC
569 bond_check_admissibility(struct bond *bond, const void *slave_,
570 const uint8_t eth_dst[ETH_ADDR_LEN], tag_type *tags)
572 /* Admit all packets if LACP has been negotiated, because that means that
573 * the remote switch is aware of the bond and will "do the right thing". */
574 if (bond->lacp_negotiated) {
578 /* Drop all multicast packets on inactive slaves. */
579 if (eth_addr_is_multicast(eth_dst)) {
580 *tags |= bond_get_active_slave_tag(bond);
581 if (bond->active_slave != bond_slave_lookup(bond, slave_)) {
586 /* Drop all packets for which we have learned a different input port,
587 * because we probably sent the packet on one slave and got it back on the
588 * other. Gratuitous ARP packets are an exception to this rule: the host
589 * has moved to another switch. The exception to the exception is if we
590 * locked the learning table to avoid reflections on bond slaves. */
591 return BV_DROP_IF_MOVED;
594 /* Returns the slave (registered on 'bond' by bond_slave_register()) to which
595 * a packet with the given 'flow' and 'vlan' should be forwarded. Returns
596 * NULL if the packet should be dropped because no slaves are enabled.
598 * 'vlan' is not necessarily the same as 'flow->vlan_tci'. First, 'vlan'
599 * should be a VID only (i.e. excluding the PCP bits). Second,
600 * 'flow->vlan_tci' is the VLAN TCI that appeared on the packet (so it will be
601 * nonzero only for trunk ports), whereas 'vlan' is the logical VLAN that the
602 * packet belongs to (so for an access port it will be the access port's VLAN).
604 * Adds a tag to '*tags' that associates the flow with the returned slave.
607 bond_choose_output_slave(struct bond *bond, const struct flow *flow,
608 uint16_t vlan, tag_type *tags)
610 struct bond_slave *slave = choose_output_slave(bond, flow, vlan);
612 *tags |= bond->balance == BM_STABLE ? bond->stb_tag : slave->tag;
615 *tags |= bond->no_slaves_tag;
623 bond_is_balanced(const struct bond *bond)
625 return bond->balance == BM_SLB || bond->balance == BM_TCP;
628 /* Notifies 'bond' that 'n_bytes' bytes were sent in 'flow' within 'vlan'. */
630 bond_account(struct bond *bond, const struct flow *flow, uint16_t vlan,
634 if (bond_is_balanced(bond)) {
635 lookup_bond_entry(bond, flow, vlan)->tx_bytes += n_bytes;
639 static struct bond_slave *
640 bond_slave_from_bal_node(struct list *bal)
642 return CONTAINER_OF(bal, struct bond_slave, bal_node);
646 log_bals(struct bond *bond, const struct list *bals)
648 if (VLOG_IS_DBG_ENABLED()) {
649 struct ds ds = DS_EMPTY_INITIALIZER;
650 const struct bond_slave *slave;
652 LIST_FOR_EACH (slave, bal_node, bals) {
654 ds_put_char(&ds, ',');
656 ds_put_format(&ds, " %s %"PRIu64"kB",
657 slave->name, slave->tx_bytes / 1024);
659 if (!slave->enabled) {
660 ds_put_cstr(&ds, " (disabled)");
662 if (!list_is_empty(&slave->entries)) {
663 struct bond_entry *e;
665 ds_put_cstr(&ds, " (");
666 LIST_FOR_EACH (e, list_node, &slave->entries) {
667 if (&e->list_node != list_front(&slave->entries)) {
668 ds_put_cstr(&ds, " + ");
670 ds_put_format(&ds, "h%td: %"PRIu64"kB",
671 e - bond->hash, e->tx_bytes / 1024);
673 ds_put_cstr(&ds, ")");
676 VLOG_DBG("bond %s:%s", bond->name, ds_cstr(&ds));
681 /* Shifts 'hash' from its current slave to 'to'. */
683 bond_shift_load(struct bond_entry *hash, struct bond_slave *to,
686 struct bond_slave *from = hash->slave;
687 struct bond *bond = from->bond;
688 uint64_t delta = hash->tx_bytes;
690 VLOG_INFO("bond %s: shift %"PRIu64"kB of load (with hash %td) "
691 "from %s to %s (now carrying %"PRIu64"kB and "
692 "%"PRIu64"kB load, respectively)",
693 bond->name, delta / 1024, hash - bond->hash,
694 from->name, to->name,
695 (from->tx_bytes - delta) / 1024,
696 (to->tx_bytes + delta) / 1024);
698 /* Shift load away from 'from' to 'to'. */
699 from->tx_bytes -= delta;
700 to->tx_bytes += delta;
702 /* Arrange for flows to be revalidated. */
703 tag_set_add(set, hash->tag);
705 hash->tag = tag_create_random();
708 /* Pick and returns a bond_entry to migrate to 'to' (the least-loaded slave),
709 * given that doing so must decrease the ratio of the load on the two slaves by
710 * at least 0.1. Returns NULL if there is no appropriate entry.
712 * The list of entries isn't sorted. I don't know of a reason to prefer to
713 * shift away small hashes or large hashes. */
714 static struct bond_entry *
715 choose_entry_to_migrate(const struct bond_slave *from, uint64_t to_tx_bytes)
717 struct bond_entry *e;
719 if (list_is_short(&from->entries)) {
720 /* 'from' carries no more than one MAC hash, so shifting load away from
721 * it would be pointless. */
725 LIST_FOR_EACH (e, list_node, &from->entries) {
726 double old_ratio, new_ratio;
729 if (to_tx_bytes == 0) {
730 /* Nothing on the new slave, move it. */
735 old_ratio = (double)from->tx_bytes / to_tx_bytes;
736 new_ratio = (double)(from->tx_bytes - delta) / (to_tx_bytes + delta);
737 if (old_ratio - new_ratio > 0.1) {
738 /* Would decrease the ratio, move it. */
746 /* Inserts 'slave' into 'bals' so that descending order of 'tx_bytes' is
749 insert_bal(struct list *bals, struct bond_slave *slave)
751 struct bond_slave *pos;
753 LIST_FOR_EACH (pos, bal_node, bals) {
754 if (slave->tx_bytes > pos->tx_bytes) {
758 list_insert(&pos->bal_node, &slave->bal_node);
761 /* Removes 'slave' from its current list and then inserts it into 'bals' so
762 * that descending order of 'tx_bytes' is maintained. */
764 reinsert_bal(struct list *bals, struct bond_slave *slave)
766 list_remove(&slave->bal_node);
767 insert_bal(bals, slave);
770 /* If 'bond' needs rebalancing, does so.
772 * The caller should have called bond_account() for each active flow, to ensure
773 * that flow data is consistently accounted at this point. */
775 bond_rebalance(struct bond *bond, struct tag_set *tags)
777 struct bond_slave *slave;
778 struct bond_entry *e;
781 if (!bond_is_balanced(bond) || time_msec() < bond->next_rebalance) {
784 bond->next_rebalance = time_msec() + bond->rebalance_interval;
786 /* Add each bond_entry to its slave's 'entries' list.
787 * Compute each slave's tx_bytes as the sum of its entries' tx_bytes. */
788 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
790 list_init(&slave->entries);
792 for (e = &bond->hash[0]; e <= &bond->hash[BOND_MASK]; e++) {
793 if (e->slave && e->tx_bytes) {
794 e->slave->tx_bytes += e->tx_bytes;
795 list_push_back(&e->slave->entries, &e->list_node);
799 /* Add enabled slaves to 'bals' in descending order of tx_bytes.
801 * XXX This is O(n**2) in the number of slaves but it could be O(n lg n)
802 * with a proper list sort algorithm. */
804 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
805 if (slave->enabled) {
806 insert_bal(&bals, slave);
809 log_bals(bond, &bals);
811 /* Shift load from the most-loaded slaves to the least-loaded slaves. */
812 while (!list_is_short(&bals)) {
813 struct bond_slave *from = bond_slave_from_bal_node(list_front(&bals));
814 struct bond_slave *to = bond_slave_from_bal_node(list_back(&bals));
817 overload = from->tx_bytes - to->tx_bytes;
818 if (overload < to->tx_bytes >> 5 || overload < 100000) {
819 /* The extra load on 'from' (and all less-loaded slaves), compared
820 * to that of 'to' (the least-loaded slave), is less than ~3%, or
821 * it is less than ~1Mbps. No point in rebalancing. */
825 /* 'from' is carrying significantly more load than 'to', and that load
826 * is split across at least two different hashes. */
827 e = choose_entry_to_migrate(from, to->tx_bytes);
829 bond_shift_load(e, to, tags);
831 /* Delete element from from->entries.
833 * We don't add the element to to->hashes. That would only allow
834 * 'e' to be migrated to another slave in this rebalancing run, and
835 * there is no point in doing that. */
836 list_remove(&e->list_node);
838 /* Re-sort 'bals'. */
839 reinsert_bal(&bals, from);
840 reinsert_bal(&bals, to);
842 /* Can't usefully migrate anything away from 'from'.
843 * Don't reconsider it. */
844 list_remove(&from->bal_node);
848 /* Implement exponentially weighted moving average. A weight of 1/2 causes
849 * historical data to decay to <1% in 7 rebalancing runs. 1,000,000 bytes
850 * take 20 rebalancing runs to decay to 0 and get deleted entirely. */
851 for (e = &bond->hash[0]; e <= &bond->hash[BOND_MASK]; e++) {
859 /* Bonding unixctl user interface functions. */
862 bond_find(const char *name)
866 HMAP_FOR_EACH_WITH_HASH (bond, hmap_node, hash_string(name, 0),
868 if (!strcmp(bond->name, name)) {
875 static struct bond_slave *
876 bond_lookup_slave(struct bond *bond, const char *slave_name)
878 struct bond_slave *slave;
880 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
881 if (!strcmp(slave->name, slave_name)) {
889 bond_unixctl_list(struct unixctl_conn *conn,
890 const char *args OVS_UNUSED, void *aux OVS_UNUSED)
892 struct ds ds = DS_EMPTY_INITIALIZER;
893 const struct bond *bond;
895 ds_put_cstr(&ds, "bond\ttype\tslaves\n");
897 HMAP_FOR_EACH (bond, hmap_node, &all_bonds) {
898 const struct bond_slave *slave;
901 ds_put_format(&ds, "%s\t%s\t",
902 bond->name, bond_mode_to_string(bond->balance));
905 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
907 ds_put_cstr(&ds, ", ");
909 ds_put_cstr(&ds, slave->name);
911 ds_put_char(&ds, '\n');
913 unixctl_command_reply(conn, 200, ds_cstr(&ds));
918 bond_unixctl_show(struct unixctl_conn *conn,
919 const char *args, void *aux OVS_UNUSED)
921 struct ds ds = DS_EMPTY_INITIALIZER;
922 const struct bond_slave *slave;
923 const struct bond *bond;
925 bond = bond_find(args);
927 unixctl_command_reply(conn, 501, "no such bond");
931 ds_put_format(&ds, "bond_mode: %s\n",
932 bond_mode_to_string(bond->balance));
934 if (bond->balance != BM_AB) {
935 ds_put_format(&ds, "bond-hash-algorithm: %s\n",
936 bond_is_tcp_hash(bond) ? "balance-tcp" : "balance-slb");
939 ds_put_format(&ds, "bond-hash-basis: %"PRIu32"\n", bond->basis);
941 ds_put_format(&ds, "updelay: %d ms\n", bond->updelay);
942 ds_put_format(&ds, "downdelay: %d ms\n", bond->downdelay);
944 if (bond_is_balanced(bond)) {
945 ds_put_format(&ds, "next rebalance: %lld ms\n",
946 bond->next_rebalance - time_msec());
949 ds_put_format(&ds, "lacp_negotiated: %s\n",
950 bond->lacp_negotiated ? "true" : "false");
952 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
953 struct bond_entry *be;
956 ds_put_format(&ds, "\nslave %s: %s\n",
957 slave->name, slave->enabled ? "enabled" : "disabled");
958 if (slave == bond->active_slave) {
959 ds_put_cstr(&ds, "\tactive slave\n");
961 if (slave->delay_expires != LLONG_MAX) {
962 ds_put_format(&ds, "\t%s expires in %lld ms\n",
963 slave->enabled ? "downdelay" : "updelay",
964 slave->delay_expires - time_msec());
967 ds_put_format(&ds, "\tlacp_may_enable: %s\n",
968 slave->lacp_may_enable ? "true" : "false");
970 if (!bond_is_balanced(bond)) {
975 for (be = bond->hash; be <= &bond->hash[BOND_MASK]; be++) {
976 int hash = be - bond->hash;
978 if (be->slave != slave) {
982 ds_put_format(&ds, "\thash %d: %"PRIu64" kB load\n",
983 hash, be->tx_bytes / 1024);
985 if (bond->balance != BM_SLB) {
989 /* XXX How can we list the MACs assigned to hashes? */
992 unixctl_command_reply(conn, 200, ds_cstr(&ds));
997 bond_unixctl_migrate(struct unixctl_conn *conn, const char *args_,
998 void *aux OVS_UNUSED)
1000 char *args = (char *) args_;
1001 char *save_ptr = NULL;
1002 char *bond_s, *hash_s, *slave_s;
1004 struct bond_slave *slave;
1005 struct bond_entry *entry;
1008 bond_s = strtok_r(args, " ", &save_ptr);
1009 hash_s = strtok_r(NULL, " ", &save_ptr);
1010 slave_s = strtok_r(NULL, " ", &save_ptr);
1012 unixctl_command_reply(conn, 501,
1013 "usage: bond/migrate BOND HASH SLAVE");
1017 bond = bond_find(bond_s);
1019 unixctl_command_reply(conn, 501, "no such bond");
1023 if (bond->balance != BM_SLB) {
1024 unixctl_command_reply(conn, 501, "not an SLB bond");
1028 if (strspn(hash_s, "0123456789") == strlen(hash_s)) {
1029 hash = atoi(hash_s) & BOND_MASK;
1031 unixctl_command_reply(conn, 501, "bad hash");
1035 slave = bond_lookup_slave(bond, slave_s);
1037 unixctl_command_reply(conn, 501, "no such slave");
1041 if (!slave->enabled) {
1042 unixctl_command_reply(conn, 501, "cannot migrate to disabled slave");
1046 entry = &bond->hash[hash];
1047 tag_set_add(&bond->unixctl_tags, entry->tag);
1048 entry->slave = slave;
1049 entry->tag = tag_create_random();
1050 unixctl_command_reply(conn, 200, "migrated");
1054 bond_unixctl_set_active_slave(struct unixctl_conn *conn, const char *args_,
1055 void *aux OVS_UNUSED)
1057 char *args = (char *) args_;
1058 char *save_ptr = NULL;
1059 char *bond_s, *slave_s;
1061 struct bond_slave *slave;
1063 bond_s = strtok_r(args, " ", &save_ptr);
1064 slave_s = strtok_r(NULL, " ", &save_ptr);
1066 unixctl_command_reply(conn, 501,
1067 "usage: bond/set-active-slave BOND SLAVE");
1071 bond = bond_find(bond_s);
1073 unixctl_command_reply(conn, 501, "no such bond");
1077 slave = bond_lookup_slave(bond, slave_s);
1079 unixctl_command_reply(conn, 501, "no such slave");
1083 if (!slave->enabled) {
1084 unixctl_command_reply(conn, 501, "cannot make disabled slave active");
1088 if (bond->active_slave != slave) {
1089 tag_set_add(&bond->unixctl_tags, bond_get_active_slave_tag(bond));
1090 bond->active_slave = slave;
1091 bond->active_slave->tag = tag_create_random();
1092 VLOG_INFO("bond %s: active interface is now %s",
1093 bond->name, slave->name);
1094 bond->send_learning_packets = true;
1095 unixctl_command_reply(conn, 200, "done");
1097 unixctl_command_reply(conn, 200, "no change");
1102 enable_slave(struct unixctl_conn *conn, const char *args_, bool enable)
1104 char *args = (char *) args_;
1105 char *save_ptr = NULL;
1106 char *bond_s, *slave_s;
1108 struct bond_slave *slave;
1110 bond_s = strtok_r(args, " ", &save_ptr);
1111 slave_s = strtok_r(NULL, " ", &save_ptr);
1113 char *usage = xasprintf("usage: bond/%s-slave BOND SLAVE",
1114 enable ? "enable" : "disable");
1115 unixctl_command_reply(conn, 501, usage);
1120 bond = bond_find(bond_s);
1122 unixctl_command_reply(conn, 501, "no such bond");
1126 slave = bond_lookup_slave(bond, slave_s);
1128 unixctl_command_reply(conn, 501, "no such slave");
1132 bond_enable_slave(slave, enable, &bond->unixctl_tags);
1133 unixctl_command_reply(conn, 501, enable ? "enabled" : "disabled");
1137 bond_unixctl_enable_slave(struct unixctl_conn *conn, const char *args,
1138 void *aux OVS_UNUSED)
1140 enable_slave(conn, args, true);
1144 bond_unixctl_disable_slave(struct unixctl_conn *conn, const char *args,
1145 void *aux OVS_UNUSED)
1147 enable_slave(conn, args, false);
1151 bond_unixctl_hash(struct unixctl_conn *conn, const char *args_,
1152 void *aux OVS_UNUSED)
1154 char *args = (char *) args_;
1155 uint8_t mac[ETH_ADDR_LEN];
1160 char *mac_s, *vlan_s, *basis_s;
1161 char *save_ptr = NULL;
1163 mac_s = strtok_r(args, " ", &save_ptr);
1164 vlan_s = strtok_r(NULL, " ", &save_ptr);
1165 basis_s = strtok_r(NULL, " ", &save_ptr);
1168 if (sscanf(vlan_s, "%u", &vlan) != 1) {
1169 unixctl_command_reply(conn, 501, "invalid vlan");
1173 vlan = OFP_VLAN_NONE;
1177 if (sscanf(basis_s, "%"PRIu32, &basis) != 1) {
1178 unixctl_command_reply(conn, 501, "invalid basis");
1185 if (sscanf(mac_s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
1186 == ETH_ADDR_SCAN_COUNT) {
1187 hash = bond_hash_src(mac, vlan, basis) & BOND_MASK;
1189 hash_cstr = xasprintf("%u", hash);
1190 unixctl_command_reply(conn, 200, hash_cstr);
1193 unixctl_command_reply(conn, 501, "invalid mac");
1200 unixctl_command_register("bond/list", bond_unixctl_list, NULL);
1201 unixctl_command_register("bond/show", bond_unixctl_show, NULL);
1202 unixctl_command_register("bond/migrate", bond_unixctl_migrate, NULL);
1203 unixctl_command_register("bond/set-active-slave",
1204 bond_unixctl_set_active_slave, NULL);
1205 unixctl_command_register("bond/enable-slave", bond_unixctl_enable_slave,
1207 unixctl_command_register("bond/disable-slave", bond_unixctl_disable_slave,
1209 unixctl_command_register("bond/hash", bond_unixctl_hash, NULL);
1213 bond_entry_reset(struct bond *bond)
1215 if (bond->balance != BM_AB) {
1216 size_t hash_len = (BOND_MASK + 1) * sizeof *bond->hash;
1219 bond->hash = xmalloc(hash_len);
1221 memset(bond->hash, 0, hash_len);
1223 bond->next_rebalance = time_msec() + bond->rebalance_interval;
1230 static struct bond_slave *
1231 bond_slave_lookup(struct bond *bond, const void *slave_)
1233 struct bond_slave *slave;
1235 HMAP_FOR_EACH_IN_BUCKET (slave, hmap_node, hash_pointer(slave_, 0),
1237 if (slave->aux == slave_) {
1246 bond_enable_slave(struct bond_slave *slave, bool enable, struct tag_set *tags)
1248 struct bond *bond = slave->bond;
1249 slave->delay_expires = LLONG_MAX;
1250 if (enable != slave->enabled) {
1251 slave->enabled = enable;
1252 if (!slave->enabled) {
1253 VLOG_WARN("interface %s: disabled", slave->name);
1255 tag_set_add(tags, slave->tag);
1258 VLOG_WARN("interface %s: enabled", slave->name);
1259 slave->tag = tag_create_random();
1262 if (bond->balance == BM_STABLE) {
1263 bond->bond_revalidate = true;
1269 bond_link_status_update(struct bond_slave *slave, struct tag_set *tags)
1271 struct bond *bond = slave->bond;
1274 up = netdev_get_carrier(slave->netdev) && slave->lacp_may_enable;
1275 if ((up == slave->enabled) != (slave->delay_expires == LLONG_MAX)) {
1276 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1277 VLOG_INFO_RL(&rl, "interface %s: link state %s",
1278 slave->name, up ? "up" : "down");
1279 if (up == slave->enabled) {
1280 slave->delay_expires = LLONG_MAX;
1281 VLOG_INFO_RL(&rl, "interface %s: will not be %s",
1282 slave->name, up ? "disabled" : "enabled");
1284 int delay = (bond->lacp_negotiated ? 0
1285 : up ? bond->updelay : bond->downdelay);
1286 slave->delay_expires = time_msec() + delay;
1288 VLOG_INFO_RL(&rl, "interface %s: will be %s if it stays %s "
1291 up ? "enabled" : "disabled",
1298 if (time_msec() >= slave->delay_expires) {
1299 bond_enable_slave(slave, up, tags);
1304 bond_is_tcp_hash(const struct bond *bond)
1306 return (bond->balance == BM_TCP || bond->balance == BM_STABLE)
1307 && bond->lacp_negotiated;
1311 bond_hash_src(const uint8_t mac[ETH_ADDR_LEN], uint16_t vlan, uint32_t basis)
1313 return hash_3words(hash_bytes(mac, ETH_ADDR_LEN, 0), vlan, basis);
1317 bond_hash_tcp(const struct flow *flow, uint16_t vlan, uint32_t basis)
1319 struct flow hash_flow = *flow;
1320 hash_flow.vlan_tci = htons(vlan);
1322 /* The symmetric quality of this hash function is not required, but
1323 * flow_hash_symmetric_l4 already exists, and is sufficient for our
1324 * purposes, so we use it out of convenience. */
1325 return flow_hash_symmetric_l4(&hash_flow, basis);
1329 bond_hash(const struct bond *bond, const struct flow *flow, uint16_t vlan)
1331 assert(bond->balance != BM_AB);
1333 return (bond_is_tcp_hash(bond)
1334 ? bond_hash_tcp(flow, vlan, bond->basis)
1335 : bond_hash_src(flow->dl_src, vlan, bond->basis));
1338 static struct bond_entry *
1339 lookup_bond_entry(const struct bond *bond, const struct flow *flow,
1342 return &bond->hash[bond_hash(bond, flow, vlan) & BOND_MASK];
1345 /* This function uses Highest Random Weight hashing to choose an output slave.
1346 * This approach only reassigns a minimal number of flows when slaves are
1347 * enabled or disabled. Unfortunately, it has O(n) performance against the
1348 * number of slaves. There exist algorithms which are O(1), but have slightly
1349 * more complex implementations and require the use of memory. This may need
1350 * to be reimplemented if it becomes a performance bottleneck. */
1351 static struct bond_slave *
1352 choose_stb_slave(const struct bond *bond, const struct flow *flow,
1355 struct bond_slave *best, *slave;
1356 uint32_t best_hash, flow_hash;
1360 flow_hash = bond_hash(bond, flow, vlan);
1361 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1362 if (slave->enabled) {
1365 hash = hash_2words(flow_hash, slave->stb_id);
1366 if (!best || hash > best_hash) {
1376 static struct bond_slave *
1377 choose_output_slave(const struct bond *bond, const struct flow *flow,
1380 struct bond_entry *e;
1382 switch (bond->balance) {
1384 return bond->active_slave;
1387 return choose_stb_slave(bond, flow, vlan);
1390 e = lookup_bond_entry(bond, flow, vlan);
1391 if (!e->slave || !e->slave->enabled) {
1392 e->slave = CONTAINER_OF(hmap_random_node(&bond->slaves),
1393 struct bond_slave, hmap_node);
1394 if (!e->slave->enabled) {
1395 e->slave = bond->active_slave;
1397 e->tag = tag_create_random();
1406 static struct bond_slave *
1407 bond_choose_slave(const struct bond *bond)
1409 struct bond_slave *slave, *best;
1411 /* Find an enabled slave. */
1412 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1413 if (slave->enabled) {
1418 /* All interfaces are disabled. Find an interface that will be enabled
1419 * after its updelay expires. */
1421 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1422 if (slave->delay_expires != LLONG_MAX
1423 && slave->lacp_may_enable
1424 && (!best || slave->delay_expires < best->delay_expires)) {
1432 bond_choose_active_slave(struct bond *bond, struct tag_set *tags)
1434 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1435 struct bond_slave *old_active_slave = bond->active_slave;
1437 bond->active_slave = bond_choose_slave(bond);
1438 if (bond->active_slave) {
1439 if (bond->active_slave->enabled) {
1440 VLOG_INFO_RL(&rl, "bond %s: active interface is now %s",
1441 bond->name, bond->active_slave->name);
1443 VLOG_INFO_RL(&rl, "bond %s: active interface is now %s, skipping "
1444 "remaining %lld ms updelay (since no interface was "
1445 "enabled)", bond->name, bond->active_slave->name,
1446 bond->active_slave->delay_expires - time_msec());
1447 bond_enable_slave(bond->active_slave, true, tags);
1450 if (!old_active_slave) {
1451 tag_set_add(tags, bond->no_slaves_tag);
1454 bond->send_learning_packets = true;
1455 } else if (old_active_slave) {
1456 VLOG_WARN_RL(&rl, "bond %s: all interfaces disabled", bond->name);
1460 /* Returns the tag for 'bond''s active slave, or 'bond''s no_slaves_tag if
1461 * there is no active slave. */
1463 bond_get_active_slave_tag(const struct bond *bond)
1465 return (bond->active_slave
1466 ? bond->active_slave->tag
1467 : bond->no_slaves_tag);
1470 /* Attempts to make the sum of the bond slaves' statistics appear on the fake
1471 * bond interface. */
1473 bond_update_fake_slave_stats(struct bond *bond)
1475 struct netdev_stats bond_stats;
1476 struct bond_slave *slave;
1477 struct netdev *bond_dev;
1479 memset(&bond_stats, 0, sizeof bond_stats);
1481 HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1482 struct netdev_stats slave_stats;
1484 if (!netdev_get_stats(slave->netdev, &slave_stats)) {
1485 /* XXX: We swap the stats here because they are swapped back when
1486 * reported by the internal device. The reason for this is
1487 * internal devices normally represent packets going into the
1488 * system but when used as fake bond device they represent packets
1489 * leaving the system. We really should do this in the internal
1490 * device itself because changing it here reverses the counts from
1491 * the perspective of the switch. However, the internal device
1492 * doesn't know what type of device it represents so we have to do
1493 * it here for now. */
1494 bond_stats.tx_packets += slave_stats.rx_packets;
1495 bond_stats.tx_bytes += slave_stats.rx_bytes;
1496 bond_stats.rx_packets += slave_stats.tx_packets;
1497 bond_stats.rx_bytes += slave_stats.tx_bytes;
1501 if (!netdev_open_default(bond->name, &bond_dev)) {
1502 netdev_set_stats(bond_dev, &bond_stats);
1503 netdev_close(bond_dev);