bond: Be more careful about adding and removing netdevs in the monitor.
[openvswitch] / lib / bond.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18
19 #include "bond.h"
20
21 #include <limits.h>
22 #include <stdint.h>
23 #include <stdlib.h>
24
25 #include "coverage.h"
26 #include "dynamic-string.h"
27 #include "flow.h"
28 #include "hmap.h"
29 #include "list.h"
30 #include "netdev.h"
31 #include "odp-util.h"
32 #include "ofpbuf.h"
33 #include "packets.h"
34 #include "poll-loop.h"
35 #include "tag.h"
36 #include "timeval.h"
37 #include "unixctl.h"
38 #include "vlog.h"
39
40 VLOG_DEFINE_THIS_MODULE(bond);
41
42 /* Bit-mask for hashing a flow down to a bucket.
43  * There are (BOND_MASK + 1) buckets. */
44 #define BOND_MASK 0xff
45
46 /* A hash bucket for mapping a flow to a slave.
47  * "struct bond" has an array of (BOND_MASK + 1) of these. */
48 struct bond_entry {
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. */
53 };
54
55 /* A bond slave, that is, one of the links comprising a bond. */
56 struct bond_slave {
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. */
60
61     struct netdev *netdev;      /* Network device, owned by the client. */
62     char *name;                 /* Name (a copy of netdev_get_name(netdev)). */
63
64     /* Link status. */
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. */
70
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. */
75
76     /* BM_STABLE specific bonding info. */
77     uint16_t stb_id;            /* ID used for 'stb_slaves' ordering. */
78 };
79
80 /* A bond, that is, a set of network devices grouped to improve performance or
81  * robustness.  */
82 struct bond {
83     struct hmap_node hmap_node; /* In 'all_bonds' hmap. */
84     char *name;                 /* Name provided by client. */
85
86     /* Slaves. */
87     struct hmap slaves;
88
89     /* Bonding info. */
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
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;
102
103     /* BM_STABLE specific bonding info. */
104     tag_type stb_tag;               /* Tag associated with this bond. */
105
106     /* Monitoring. */
107     enum bond_detect_mode detect;     /* Link status mode, one of BLSM_*. */
108     struct netdev_monitor *monitor;   /* detect == BLSM_CARRIER only. */
109     long long int miimon_interval;    /* Miimon status refresh interval. */
110     long long int miimon_next_update; /* Time of next miimon update. */
111
112     /* Legacy compatibility. */
113     long long int next_fake_iface_update; /* LLONG_MAX if disabled. */
114
115     /* Tag set saved for next bond_run().  This tag set is a kluge for cases
116      * where we can't otherwise provide revalidation feedback to the client.
117      * That's only unixctl commands now; I hope no other cases will arise. */
118     struct tag_set unixctl_tags;
119 };
120
121 static struct hmap all_bonds = HMAP_INITIALIZER(&all_bonds);
122
123 static void bond_entry_reset(struct bond *);
124 static struct bond_slave *bond_slave_lookup(struct bond *, const void *slave_);
125 static bool bond_is_link_up(struct bond *, struct netdev *);
126 static void bond_enable_slave(struct bond_slave *, bool enable,
127                               struct tag_set *);
128 static void bond_link_status_update(struct bond_slave *, struct tag_set *);
129 static void bond_choose_active_slave(struct bond *, struct tag_set *);
130 static bool bond_is_tcp_hash(const struct bond *);
131 static unsigned int bond_hash_src(const uint8_t mac[ETH_ADDR_LEN],
132                                   uint16_t vlan);
133 static unsigned int bond_hash_tcp(const struct flow *, uint16_t vlan);
134 static struct bond_entry *lookup_bond_entry(const struct bond *,
135                                             const struct flow *,
136                                             uint16_t vlan);
137 static tag_type bond_get_active_slave_tag(const struct bond *);
138 static struct bond_slave *choose_output_slave(const struct bond *,
139                                               const struct flow *,
140                                               uint16_t vlan);
141 static void bond_update_fake_slave_stats(struct bond *);
142
143 /* Attempts to parse 's' as the name of a bond balancing mode.  If successful,
144  * stores the mode in '*balance' and returns true.  Otherwise returns false
145  * without modifying '*balance'. */
146 bool
147 bond_mode_from_string(enum bond_mode *balance, const char *s)
148 {
149     if (!strcmp(s, bond_mode_to_string(BM_TCP))) {
150         *balance = BM_TCP;
151     } else if (!strcmp(s, bond_mode_to_string(BM_SLB))) {
152         *balance = BM_SLB;
153     } else if (!strcmp(s, bond_mode_to_string(BM_STABLE))) {
154         *balance = BM_STABLE;
155     } else if (!strcmp(s, bond_mode_to_string(BM_AB))) {
156         *balance = BM_AB;
157     } else {
158         return false;
159     }
160     return true;
161 }
162
163 /* Returns a string representing 'balance'. */
164 const char *
165 bond_mode_to_string(enum bond_mode balance) {
166     switch (balance) {
167     case BM_TCP:
168         return "balance-tcp";
169     case BM_SLB:
170         return "balance-slb";
171     case BM_STABLE:
172         return "stable";
173     case BM_AB:
174         return "active-backup";
175     }
176     NOT_REACHED();
177 }
178
179 /* Attempts to parse 's' as the name of a bond link status detection mode.  If
180  * successful, stores the mode in '*detect' and returns true.  Otherwise
181  * returns false without modifying '*detect'. */
182 bool
183 bond_detect_mode_from_string(enum bond_detect_mode *detect, const char *s)
184 {
185     if (!strcmp(s, bond_detect_mode_to_string(BLSM_CARRIER))) {
186         *detect = BLSM_CARRIER;
187     } else if (!strcmp(s, bond_detect_mode_to_string(BLSM_MIIMON))) {
188         *detect = BLSM_MIIMON;
189     } else {
190         return false;
191     }
192     return true;
193 }
194
195 /* Returns a string representing 'detect'. */
196 const char *
197 bond_detect_mode_to_string(enum bond_detect_mode detect)
198 {
199     switch (detect) {
200     case BLSM_CARRIER:
201         return "carrier";
202     case BLSM_MIIMON:
203         return "miimon";
204     }
205     NOT_REACHED();
206 }
207 \f
208 /* Creates and returns a new bond whose configuration is initially taken from
209  * 's'.
210  *
211  * The caller should register each slave on the new bond by calling
212  * bond_slave_register().  */
213 struct bond *
214 bond_create(const struct bond_settings *s)
215 {
216     struct bond *bond;
217
218     bond = xzalloc(sizeof *bond);
219     hmap_init(&bond->slaves);
220     bond->no_slaves_tag = tag_create_random();
221     bond->stb_tag = tag_create_random();
222     bond->miimon_next_update = LLONG_MAX;
223     bond->next_fake_iface_update = LLONG_MAX;
224
225     bond_reconfigure(bond, s);
226
227     tag_set_init(&bond->unixctl_tags);
228
229     return bond;
230 }
231
232 /* Frees 'bond'. */
233 void
234 bond_destroy(struct bond *bond)
235 {
236     struct bond_slave *slave, *next_slave;
237
238     if (!bond) {
239         return;
240     }
241
242     hmap_remove(&all_bonds, &bond->hmap_node);
243
244     HMAP_FOR_EACH_SAFE (slave, next_slave, hmap_node, &bond->slaves) {
245         hmap_remove(&bond->slaves, &slave->hmap_node);
246         /* Client owns 'slave->netdev'. */
247         free(slave->name);
248         free(slave);
249     }
250     hmap_destroy(&bond->slaves);
251
252     free(bond->hash);
253
254     netdev_monitor_destroy(bond->monitor);
255
256     free(bond->name);
257     free(bond);
258 }
259
260 /* Updates 'bond''s overall configuration to 's'.
261  *
262  * The caller should register each slave on 'bond' by calling
263  * bond_slave_register().  This is optional if none of the slaves'
264  * configuration has changed.  In any case it can't hurt.
265  *
266  * Returns true if the configuration has changed in such a way that requires
267  * flow revalidation.
268  * */
269 bool
270 bond_reconfigure(struct bond *bond, const struct bond_settings *s)
271 {
272     bool revalidate = false;
273
274     if (!bond->name || strcmp(bond->name, s->name)) {
275         if (bond->name) {
276             hmap_remove(&all_bonds, &bond->hmap_node);
277             free(bond->name);
278         }
279         bond->name = xstrdup(s->name);
280         hmap_insert(&all_bonds, &bond->hmap_node, hash_string(bond->name, 0));
281     }
282
283     bond->detect = s->detect;
284     bond->miimon_interval = s->miimon_interval;
285     bond->updelay = s->up_delay;
286     bond->downdelay = s->down_delay;
287     bond->rebalance_interval = s->rebalance_interval;
288
289     if (bond->balance != s->balance) {
290         bond->balance = s->balance;
291         revalidate = true;
292     }
293
294     if (bond->detect == BLSM_CARRIER) {
295         struct bond_slave *slave;
296
297         if (!bond->monitor) {
298             bond->monitor = netdev_monitor_create();
299         }
300
301         HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
302             netdev_monitor_add(bond->monitor, slave->netdev);
303         }
304     } else {
305         netdev_monitor_destroy(bond->monitor);
306         bond->monitor = NULL;
307
308         if (bond->miimon_next_update == LLONG_MAX) {
309             bond->miimon_next_update = time_msec() + bond->miimon_interval;
310         }
311     }
312
313     if (s->fake_iface) {
314         if (bond->next_fake_iface_update == LLONG_MAX) {
315             bond->next_fake_iface_update = time_msec();
316         }
317     } else {
318         bond->next_fake_iface_update = LLONG_MAX;
319     }
320
321     if (bond->bond_revalidate) {
322         revalidate = true;
323         bond->bond_revalidate = false;
324     }
325
326     if (bond->balance == BM_AB || !bond->hash || revalidate) {
327         bond_entry_reset(bond);
328     }
329
330     return revalidate;
331 }
332
333 /* Registers 'slave_' as a slave of 'bond'.  The 'slave_' pointer is an
334  * arbitrary client-provided pointer that uniquely identifies a slave within a
335  * bond.  If 'slave_' already exists within 'bond' then this function
336  * reconfigures the existing slave.
337  *
338  * 'stb_id' is used in BM_STABLE bonds to guarantee consistent slave choices
339  * across restarts and distributed vswitch instances.  It should be unique per
340  * slave, and preferably consistent across restarts and reconfigurations.
341  *
342  * 'netdev' must be the network device that 'slave_' represents.  It is owned
343  * by the client, so the client must not close it before either unregistering
344  * 'slave_' or destroying 'bond'.
345  */
346 void
347 bond_slave_register(struct bond *bond, void *slave_, uint16_t stb_id,
348                     struct netdev *netdev)
349 {
350     struct bond_slave *slave = bond_slave_lookup(bond, slave_);
351
352     if (!slave) {
353         slave = xzalloc(sizeof *slave);
354
355         hmap_insert(&bond->slaves, &slave->hmap_node, hash_pointer(slave_, 0));
356         slave->bond = bond;
357         slave->aux = slave_;
358         slave->delay_expires = LLONG_MAX;
359         slave->up = bond_is_link_up(bond, netdev);
360         slave->name = xstrdup(netdev_get_name(netdev));
361         bond->bond_revalidate = true;
362
363         slave->enabled = false;
364         bond_enable_slave(slave, slave->up, NULL);
365     }
366
367     if (slave->stb_id != stb_id) {
368         slave->stb_id = stb_id;
369         bond->bond_revalidate = true;
370     }
371
372     if (slave->netdev != netdev) {
373         if (bond->monitor) {
374             if (slave->netdev) {
375                 netdev_monitor_remove(bond->monitor, slave->netdev);
376             }
377             netdev_monitor_add(bond->monitor, netdev);
378         }
379         slave->netdev = netdev;
380     }
381
382     free(slave->name);
383     slave->name = xstrdup(netdev_get_name(netdev));
384 }
385
386 /* Unregisters 'slave_' from 'bond'.  If 'bond' does not contain such a slave
387  * then this function has no effect.
388  *
389  * Unregistering a slave invalidates all flows. */
390 void
391 bond_slave_unregister(struct bond *bond, const void *slave_)
392 {
393     struct bond_slave *slave = bond_slave_lookup(bond, slave_);
394     bool del_active;
395
396     if (!slave) {
397         return;
398     }
399
400     if (bond->monitor) {
401         netdev_monitor_remove(bond->monitor, slave->netdev);
402     }
403
404     bond_enable_slave(slave, false, NULL);
405
406     del_active = bond->active_slave == slave;
407     if (bond->hash) {
408         struct bond_entry *e;
409         for (e = bond->hash; e <= &bond->hash[BOND_MASK]; e++) {
410             if (e->slave == slave) {
411                 e->slave = NULL;
412             }
413         }
414     }
415
416     free(slave->name);
417
418     hmap_remove(&bond->slaves, &slave->hmap_node);
419     /* Client owns 'slave->netdev'. */
420     free(slave);
421
422     if (del_active) {
423         struct tag_set tags;
424
425         tag_set_init(&tags);
426         bond_choose_active_slave(bond, &tags);
427         bond->send_learning_packets = true;
428     }
429 }
430
431 /* Should be called on each slave in 'bond' before bond_run() to indicate the
432  * results of lacp_slave_may_enable() on 'slave_'. */
433 void
434 bond_slave_set_lacp_may_enable(struct bond *bond, void *slave_,
435                                bool may_enable)
436 {
437     bond_slave_lookup(bond, slave_)->lacp_may_enable = may_enable;
438 }
439
440 /* Performs periodic maintenance on 'bond'.  The caller must provide 'tags' to
441  * allow tagged flows to be invalidated.
442  *
443  * The caller should check bond_should_send_learning_packets() afterward. */
444 void
445 bond_run(struct bond *bond, struct tag_set *tags, bool lacp_negotiated)
446 {
447     struct bond_slave *slave;
448     bool is_tcp_hash = bond_is_tcp_hash(bond);
449
450     bond->lacp_negotiated = lacp_negotiated;
451
452     /* Update link status. */
453     if (bond->detect == BLSM_CARRIER
454         || time_msec() >= bond->miimon_next_update)
455     {
456         HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
457             slave->up = bond_is_link_up(bond, slave->netdev);
458         }
459         bond->miimon_next_update = time_msec() + bond->miimon_interval;
460     }
461
462     /* Enable slaves based on link status and LACP feedback. */
463     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
464         bond_link_status_update(slave, tags);
465     }
466     if (!bond->active_slave || !bond->active_slave->enabled) {
467         bond_choose_active_slave(bond, tags);
468     }
469
470     /* Update fake bond interface stats. */
471     if (time_msec() >= bond->next_fake_iface_update) {
472         bond_update_fake_slave_stats(bond);
473         bond->next_fake_iface_update = time_msec() + 1000;
474     }
475
476     if (is_tcp_hash != bond_is_tcp_hash(bond)) {
477         bond->bond_revalidate = true;
478     }
479
480     if (bond->bond_revalidate) {
481         bond->bond_revalidate = false;
482
483         bond_entry_reset(bond);
484         if (bond->balance != BM_STABLE) {
485             struct bond_slave *slave;
486
487             HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
488                 tag_set_add(tags, slave->tag);
489             }
490         } else {
491             tag_set_add(tags, bond->stb_tag);
492         }
493         tag_set_add(tags, bond->no_slaves_tag);
494     }
495
496     /* Invalidate any tags required by  */
497     tag_set_union(tags, &bond->unixctl_tags);
498     tag_set_init(&bond->unixctl_tags);
499 }
500
501 /* Causes poll_block() to wake up when 'bond' needs something to be done. */
502 void
503 bond_wait(struct bond *bond)
504 {
505     struct bond_slave *slave;
506
507     if (bond->detect == BLSM_CARRIER) {
508         netdev_monitor_poll_wait(bond->monitor);
509     } else {
510         poll_timer_wait_until(bond->miimon_next_update);
511     }
512
513     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
514         if (slave->delay_expires != LLONG_MAX) {
515             poll_timer_wait_until(slave->delay_expires);
516         }
517     }
518
519     if (bond->next_fake_iface_update != LLONG_MAX) {
520         poll_timer_wait_until(bond->next_fake_iface_update);
521     }
522
523     /* Ensure that any saved tags get revalidated right away. */
524     if (!tag_set_is_empty(&bond->unixctl_tags)) {
525         poll_immediate_wake();
526     }
527
528     /* We don't wait for bond->next_rebalance because rebalancing can only run
529      * at a flow account checkpoint.  ofproto does checkpointing on its own
530      * schedule and bond_rebalance() gets called afterward, so we'd just be
531      * waking up for no purpose. */
532 }
533 \f
534 /* MAC learning table interaction. */
535
536 static bool
537 may_send_learning_packets(const struct bond *bond)
538 {
539     return !bond->lacp_negotiated && bond->balance != BM_AB;
540 }
541
542 /* Returns true if 'bond' needs the client to send out packets to assist with
543  * MAC learning on 'bond'.  If this function returns true, then the client
544  * should iterate through its MAC learning table for the bridge on which 'bond'
545  * is located.  For each MAC that has been learned on a port other than 'bond',
546  * it should call bond_send_learning_packet().
547  *
548  * This function will only return true if 'bond' is in SLB mode and LACP is not
549  * negotiated.  Otherwise sending learning packets isn't necessary.
550  *
551  * Calling this function resets the state that it checks. */
552 bool
553 bond_should_send_learning_packets(struct bond *bond)
554 {
555     bool send = bond->send_learning_packets && may_send_learning_packets(bond);
556     bond->send_learning_packets = false;
557     return send;
558 }
559
560 /* Sends a gratuitous learning packet on 'bond' from 'eth_src' on 'vlan'.
561  *
562  * See bond_should_send_learning_packets() for description of usage. */
563 int
564 bond_send_learning_packet(struct bond *bond,
565                           const uint8_t eth_src[ETH_ADDR_LEN],
566                           uint16_t vlan)
567 {
568     struct bond_slave *slave;
569     struct ofpbuf packet;
570     struct flow flow;
571     int error;
572
573     assert(may_send_learning_packets(bond));
574     if (!bond->active_slave) {
575         /* Nowhere to send the learning packet. */
576         return 0;
577     }
578
579     memset(&flow, 0, sizeof flow);
580     memcpy(flow.dl_src, eth_src, ETH_ADDR_LEN);
581     slave = choose_output_slave(bond, &flow, vlan);
582
583     ofpbuf_init(&packet, 0);
584     compose_benign_packet(&packet, "Open vSwitch Bond Failover", 0xf177,
585                           eth_src);
586     if (vlan) {
587         eth_set_vlan_tci(&packet, htons(vlan));
588     }
589     error = netdev_send(slave->netdev, &packet);
590     ofpbuf_uninit(&packet);
591
592     return error;
593 }
594 \f
595 /* Checks whether a packet that arrived on 'slave_' within 'bond', with an
596  * Ethernet destination address of 'eth_dst', should be admitted.
597  *
598  * The return value is one of the following:
599  *
600  *    - BV_ACCEPT: Admit the packet.
601  *
602  *    - BV_DROP: Drop the packet.
603  *
604  *    - BV_DROP_IF_MOVED: Consult the MAC learning table for the packet's
605  *      Ethernet source address and VLAN.  If there is none, or if the packet
606  *      is on the learned port, then admit the packet.  If a different port has
607  *      been learned, however, drop the packet (and do not use it for MAC
608  *      learning).
609  */
610 enum bond_verdict
611 bond_check_admissibility(struct bond *bond, const void *slave_,
612                          const uint8_t eth_dst[ETH_ADDR_LEN], tag_type *tags)
613 {
614     /* Admit all packets if LACP has been negotiated, because that means that
615      * the remote switch is aware of the bond and will "do the right thing". */
616     if (bond->lacp_negotiated) {
617         return BV_ACCEPT;
618     }
619
620     /* Drop all multicast packets on inactive slaves. */
621     if (eth_addr_is_multicast(eth_dst)) {
622         *tags |= bond_get_active_slave_tag(bond);
623         if (bond->active_slave != bond_slave_lookup(bond, slave_)) {
624             return BV_DROP;
625         }
626     }
627
628     /* Drop all packets for which we have learned a different input port,
629      * because we probably sent the packet on one slave and got it back on the
630      * other.  Gratuitous ARP packets are an exception to this rule: the host
631      * has moved to another switch.  The exception to the exception is if we
632      * locked the learning table to avoid reflections on bond slaves. */
633     return BV_DROP_IF_MOVED;
634 }
635
636 /* Returns the slave (registered on 'bond' by bond_slave_register()) to which
637  * a packet with the given 'flow' and 'vlan' should be forwarded.  Returns
638  * NULL if the packet should be dropped because no slaves are enabled.
639  *
640  * 'vlan' is not necessarily the same as 'flow->vlan_tci'.  First, 'vlan'
641  * should be a VID only (i.e. excluding the PCP bits).  Second,
642  * 'flow->vlan_tci' is the VLAN TCI that appeared on the packet (so it will be
643  * nonzero only for trunk ports), whereas 'vlan' is the logical VLAN that the
644  * packet belongs to (so for an access port it will be the access port's VLAN).
645  *
646  * Adds a tag to '*tags' that associates the flow with the returned slave.
647  */
648 void *
649 bond_choose_output_slave(struct bond *bond, const struct flow *flow,
650                          uint16_t vlan, tag_type *tags)
651 {
652     struct bond_slave *slave = choose_output_slave(bond, flow, vlan);
653     if (slave) {
654         *tags |= bond->balance == BM_STABLE ? bond->stb_tag : slave->tag;
655         return slave->aux;
656     } else {
657         *tags |= bond->no_slaves_tag;
658         return NULL;
659     }
660 }
661 \f
662 /* Rebalancing. */
663
664 static bool
665 bond_is_balanced(const struct bond *bond)
666 {
667     return bond->balance == BM_SLB || bond->balance == BM_TCP;
668 }
669
670 /* Notifies 'bond' that 'n_bytes' bytes were sent in 'flow' within 'vlan'. */
671 void
672 bond_account(struct bond *bond, const struct flow *flow, uint16_t vlan,
673              uint64_t n_bytes)
674 {
675
676     if (bond_is_balanced(bond)) {
677         lookup_bond_entry(bond, flow, vlan)->tx_bytes += n_bytes;
678     }
679 }
680
681 static struct bond_slave *
682 bond_slave_from_bal_node(struct list *bal)
683 {
684     return CONTAINER_OF(bal, struct bond_slave, bal_node);
685 }
686
687 static void
688 log_bals(struct bond *bond, const struct list *bals)
689 {
690     if (VLOG_IS_DBG_ENABLED()) {
691         struct ds ds = DS_EMPTY_INITIALIZER;
692         const struct bond_slave *slave;
693
694         LIST_FOR_EACH (slave, bal_node, bals) {
695             if (ds.length) {
696                 ds_put_char(&ds, ',');
697             }
698             ds_put_format(&ds, " %s %"PRIu64"kB",
699                           slave->name, slave->tx_bytes / 1024);
700
701             if (!slave->enabled) {
702                 ds_put_cstr(&ds, " (disabled)");
703             }
704             if (!list_is_empty(&slave->entries)) {
705                 struct bond_entry *e;
706
707                 ds_put_cstr(&ds, " (");
708                 LIST_FOR_EACH (e, list_node, &slave->entries) {
709                     if (&e->list_node != list_front(&slave->entries)) {
710                         ds_put_cstr(&ds, " + ");
711                     }
712                     ds_put_format(&ds, "h%td: %"PRIu64"kB",
713                                   e - bond->hash, e->tx_bytes / 1024);
714                 }
715                 ds_put_cstr(&ds, ")");
716             }
717         }
718         VLOG_DBG("bond %s:%s", bond->name, ds_cstr(&ds));
719         ds_destroy(&ds);
720     }
721 }
722
723 /* Shifts 'hash' from its current slave to 'to'. */
724 static void
725 bond_shift_load(struct bond_entry *hash, struct bond_slave *to,
726                 struct tag_set *set)
727 {
728     struct bond_slave *from = hash->slave;
729     struct bond *bond = from->bond;
730     uint64_t delta = hash->tx_bytes;
731
732     VLOG_INFO("bond %s: shift %"PRIu64"kB of load (with hash %td) "
733               "from %s to %s (now carrying %"PRIu64"kB and "
734               "%"PRIu64"kB load, respectively)",
735               bond->name, delta / 1024, hash - bond->hash,
736               from->name, to->name,
737               (from->tx_bytes - delta) / 1024,
738               (to->tx_bytes + delta) / 1024);
739
740     /* Shift load away from 'from' to 'to'. */
741     from->tx_bytes -= delta;
742     to->tx_bytes += delta;
743
744     /* Arrange for flows to be revalidated. */
745     tag_set_add(set, hash->tag);
746     hash->slave = to;
747     hash->tag = tag_create_random();
748 }
749
750 /* Pick and returns a bond_entry to migrate to 'to' (the least-loaded slave),
751  * given that doing so must decrease the ratio of the load on the two slaves by
752  * at least 0.1.  Returns NULL if there is no appropriate entry.
753  *
754  * The list of entries isn't sorted.  I don't know of a reason to prefer to
755  * shift away small hashes or large hashes. */
756 static struct bond_entry *
757 choose_entry_to_migrate(const struct bond_slave *from, uint64_t to_tx_bytes)
758 {
759     struct bond_entry *e;
760
761     if (list_is_short(&from->entries)) {
762         /* 'from' carries no more than one MAC hash, so shifting load away from
763          * it would be pointless. */
764         return NULL;
765     }
766
767     LIST_FOR_EACH (e, list_node, &from->entries) {
768         double old_ratio, new_ratio;
769         uint64_t delta;
770
771         if (to_tx_bytes == 0) {
772             /* Nothing on the new slave, move it. */
773             return e;
774         }
775
776         delta = e->tx_bytes;
777         old_ratio = (double)from->tx_bytes / to_tx_bytes;
778         new_ratio = (double)(from->tx_bytes - delta) / (to_tx_bytes + delta);
779         if (old_ratio - new_ratio > 0.1) {
780             /* Would decrease the ratio, move it. */
781             return e;
782         }
783     }
784
785     return NULL;
786 }
787
788 /* Inserts 'slave' into 'bals' so that descending order of 'tx_bytes' is
789  * maintained. */
790 static void
791 insert_bal(struct list *bals, struct bond_slave *slave)
792 {
793     struct bond_slave *pos;
794
795     LIST_FOR_EACH (pos, bal_node, bals) {
796         if (slave->tx_bytes > pos->tx_bytes) {
797             break;
798         }
799     }
800     list_insert(&pos->bal_node, &slave->bal_node);
801 }
802
803 /* Removes 'slave' from its current list and then inserts it into 'bals' so
804  * that descending order of 'tx_bytes' is maintained. */
805 static void
806 reinsert_bal(struct list *bals, struct bond_slave *slave)
807 {
808     list_remove(&slave->bal_node);
809     insert_bal(bals, slave);
810 }
811
812 /* If 'bond' needs rebalancing, does so.
813  *
814  * The caller should have called bond_account() for each active flow, to ensure
815  * that flow data is consistently accounted at this point. */
816 void
817 bond_rebalance(struct bond *bond, struct tag_set *tags)
818 {
819     struct bond_slave *slave;
820     struct bond_entry *e;
821     struct list bals;
822
823     if (!bond_is_balanced(bond) || time_msec() < bond->next_rebalance) {
824         return;
825     }
826     bond->next_rebalance = time_msec() + bond->rebalance_interval;
827
828     /* Add each bond_entry to its slave's 'entries' list.
829      * Compute each slave's tx_bytes as the sum of its entries' tx_bytes. */
830     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
831         slave->tx_bytes = 0;
832         list_init(&slave->entries);
833     }
834     for (e = &bond->hash[0]; e <= &bond->hash[BOND_MASK]; e++) {
835         if (e->slave && e->tx_bytes) {
836             e->slave->tx_bytes += e->tx_bytes;
837             list_push_back(&e->slave->entries, &e->list_node);
838         }
839     }
840
841     /* Add enabled slaves to 'bals' in descending order of tx_bytes.
842      *
843      * XXX This is O(n**2) in the number of slaves but it could be O(n lg n)
844      * with a proper list sort algorithm. */
845     list_init(&bals);
846     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
847         if (slave->enabled) {
848             insert_bal(&bals, slave);
849         }
850     }
851     log_bals(bond, &bals);
852
853     /* Shift load from the most-loaded slaves to the least-loaded slaves. */
854     while (!list_is_short(&bals)) {
855         struct bond_slave *from = bond_slave_from_bal_node(list_front(&bals));
856         struct bond_slave *to = bond_slave_from_bal_node(list_back(&bals));
857         uint64_t overload;
858
859         overload = from->tx_bytes - to->tx_bytes;
860         if (overload < to->tx_bytes >> 5 || overload < 100000) {
861             /* The extra load on 'from' (and all less-loaded slaves), compared
862              * to that of 'to' (the least-loaded slave), is less than ~3%, or
863              * it is less than ~1Mbps.  No point in rebalancing. */
864             break;
865         }
866
867         /* 'from' is carrying significantly more load than 'to', and that load
868          * is split across at least two different hashes. */
869         e = choose_entry_to_migrate(from, to->tx_bytes);
870         if (e) {
871             bond_shift_load(e, to, tags);
872
873             /* Delete element from from->entries.
874              *
875              * We don't add the element to to->hashes.  That would only allow
876              * 'e' to be migrated to another slave in this rebalancing run, and
877              * there is no point in doing that. */
878             list_remove(&e->list_node);
879
880             /* Re-sort 'bals'. */
881             reinsert_bal(&bals, from);
882             reinsert_bal(&bals, to);
883         } else {
884             /* Can't usefully migrate anything away from 'from'.
885              * Don't reconsider it. */
886             list_remove(&from->bal_node);
887         }
888     }
889
890     /* Implement exponentially weighted moving average.  A weight of 1/2 causes
891      * historical data to decay to <1% in 7 rebalancing runs.  1,000,000 bytes
892      * take 20 rebalancing runs to decay to 0 and get deleted entirely. */
893     for (e = &bond->hash[0]; e <= &bond->hash[BOND_MASK]; e++) {
894         e->tx_bytes /= 2;
895         if (!e->tx_bytes) {
896             e->slave = NULL;
897         }
898     }
899 }
900 \f
901 /* Bonding unixctl user interface functions. */
902
903 static struct bond *
904 bond_find(const char *name)
905 {
906     struct bond *bond;
907
908     HMAP_FOR_EACH_WITH_HASH (bond, hmap_node, hash_string(name, 0),
909                              &all_bonds) {
910         if (!strcmp(bond->name, name)) {
911             return bond;
912         }
913     }
914     return NULL;
915 }
916
917 static struct bond_slave *
918 bond_lookup_slave(struct bond *bond, const char *slave_name)
919 {
920     struct bond_slave *slave;
921
922     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
923         if (!strcmp(slave->name, slave_name)) {
924             return slave;
925         }
926     }
927     return NULL;
928 }
929
930 static void
931 bond_unixctl_list(struct unixctl_conn *conn,
932                   const char *args OVS_UNUSED, void *aux OVS_UNUSED)
933 {
934     struct ds ds = DS_EMPTY_INITIALIZER;
935     const struct bond *bond;
936
937     ds_put_cstr(&ds, "bond\ttype\tslaves\n");
938
939     HMAP_FOR_EACH (bond, hmap_node, &all_bonds) {
940         const struct bond_slave *slave;
941         size_t i;
942
943         ds_put_format(&ds, "%s\t%s\t",
944                       bond->name, bond_mode_to_string(bond->balance));
945
946         i = 0;
947         HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
948             if (i++ > 0) {
949                 ds_put_cstr(&ds, ", ");
950             }
951             ds_put_cstr(&ds, slave->name);
952         }
953         ds_put_char(&ds, '\n');
954     }
955     unixctl_command_reply(conn, 200, ds_cstr(&ds));
956     ds_destroy(&ds);
957 }
958
959 static void
960 bond_unixctl_show(struct unixctl_conn *conn,
961                   const char *args, void *aux OVS_UNUSED)
962 {
963     struct ds ds = DS_EMPTY_INITIALIZER;
964     const struct bond_slave *slave;
965     const struct bond *bond;
966
967     bond = bond_find(args);
968     if (!bond) {
969         unixctl_command_reply(conn, 501, "no such bond");
970         return;
971     }
972
973     ds_put_format(&ds, "bond_mode: %s\n",
974                   bond_mode_to_string(bond->balance));
975
976     if (bond->balance != BM_AB) {
977         ds_put_format(&ds, "bond-hash-algorithm: %s\n",
978                       bond_is_tcp_hash(bond) ? "balance-tcp" : "balance-slb");
979     }
980
981     ds_put_format(&ds, "bond-detect-mode: %s\n",
982                   bond->monitor ? "carrier" : "miimon");
983
984     if (!bond->monitor) {
985         ds_put_format(&ds, "bond-miimon-interval: %lld\n",
986                       bond->miimon_interval);
987     }
988
989     ds_put_format(&ds, "updelay: %d ms\n", bond->updelay);
990     ds_put_format(&ds, "downdelay: %d ms\n", bond->downdelay);
991
992     if (bond_is_balanced(bond)) {
993         ds_put_format(&ds, "next rebalance: %lld ms\n",
994                       bond->next_rebalance - time_msec());
995     }
996
997     ds_put_format(&ds, "lacp_negotiated: %s\n",
998                   bond->lacp_negotiated ? "true" : "false");
999
1000     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1001         struct bond_entry *be;
1002         struct flow flow;
1003
1004         /* Basic info. */
1005         ds_put_format(&ds, "\nslave %s: %s\n",
1006                       slave->name, slave->enabled ? "enabled" : "disabled");
1007         if (slave == bond->active_slave) {
1008             ds_put_cstr(&ds, "\tactive slave\n");
1009         }
1010         if (slave->delay_expires != LLONG_MAX) {
1011             ds_put_format(&ds, "\t%s expires in %lld ms\n",
1012                           slave->enabled ? "downdelay" : "updelay",
1013                           slave->delay_expires - time_msec());
1014         }
1015
1016         ds_put_format(&ds, "\tlacp_may_enable: %s\n",
1017                       slave->lacp_may_enable ? "true" : "false");
1018
1019         if (!bond_is_balanced(bond)) {
1020             continue;
1021         }
1022
1023         /* Hashes. */
1024         memset(&flow, 0, sizeof flow);
1025         for (be = bond->hash; be <= &bond->hash[BOND_MASK]; be++) {
1026             int hash = be - bond->hash;
1027
1028             if (be->slave != slave) {
1029                 continue;
1030             }
1031
1032             ds_put_format(&ds, "\thash %d: %"PRIu64" kB load\n",
1033                           hash, be->tx_bytes / 1024);
1034
1035             if (bond->balance != BM_SLB) {
1036                 continue;
1037             }
1038
1039             /* XXX How can we list the MACs assigned to hashes? */
1040         }
1041     }
1042     unixctl_command_reply(conn, 200, ds_cstr(&ds));
1043     ds_destroy(&ds);
1044 }
1045
1046 static void
1047 bond_unixctl_migrate(struct unixctl_conn *conn, const char *args_,
1048                      void *aux OVS_UNUSED)
1049 {
1050     char *args = (char *) args_;
1051     char *save_ptr = NULL;
1052     char *bond_s, *hash_s, *slave_s;
1053     struct bond *bond;
1054     struct bond_slave *slave;
1055     struct bond_entry *entry;
1056     int hash;
1057
1058     bond_s = strtok_r(args, " ", &save_ptr);
1059     hash_s = strtok_r(NULL, " ", &save_ptr);
1060     slave_s = strtok_r(NULL, " ", &save_ptr);
1061     if (!slave_s) {
1062         unixctl_command_reply(conn, 501,
1063                               "usage: bond/migrate BOND HASH SLAVE");
1064         return;
1065     }
1066
1067     bond = bond_find(bond_s);
1068     if (!bond) {
1069         unixctl_command_reply(conn, 501, "no such bond");
1070         return;
1071     }
1072
1073     if (bond->balance != BM_SLB) {
1074         unixctl_command_reply(conn, 501, "not an SLB bond");
1075         return;
1076     }
1077
1078     if (strspn(hash_s, "0123456789") == strlen(hash_s)) {
1079         hash = atoi(hash_s) & BOND_MASK;
1080     } else {
1081         unixctl_command_reply(conn, 501, "bad hash");
1082         return;
1083     }
1084
1085     slave = bond_lookup_slave(bond, slave_s);
1086     if (!slave) {
1087         unixctl_command_reply(conn, 501, "no such slave");
1088         return;
1089     }
1090
1091     if (!slave->enabled) {
1092         unixctl_command_reply(conn, 501, "cannot migrate to disabled slave");
1093         return;
1094     }
1095
1096     entry = &bond->hash[hash];
1097     tag_set_add(&bond->unixctl_tags, entry->tag);
1098     entry->slave = slave;
1099     entry->tag = tag_create_random();
1100     unixctl_command_reply(conn, 200, "migrated");
1101 }
1102
1103 static void
1104 bond_unixctl_set_active_slave(struct unixctl_conn *conn, const char *args_,
1105                               void *aux OVS_UNUSED)
1106 {
1107     char *args = (char *) args_;
1108     char *save_ptr = NULL;
1109     char *bond_s, *slave_s;
1110     struct bond *bond;
1111     struct bond_slave *slave;
1112
1113     bond_s = strtok_r(args, " ", &save_ptr);
1114     slave_s = strtok_r(NULL, " ", &save_ptr);
1115     if (!slave_s) {
1116         unixctl_command_reply(conn, 501,
1117                               "usage: bond/set-active-slave BOND SLAVE");
1118         return;
1119     }
1120
1121     bond = bond_find(bond_s);
1122     if (!bond) {
1123         unixctl_command_reply(conn, 501, "no such bond");
1124         return;
1125     }
1126
1127     slave = bond_lookup_slave(bond, slave_s);
1128     if (!slave) {
1129         unixctl_command_reply(conn, 501, "no such slave");
1130         return;
1131     }
1132
1133     if (!slave->enabled) {
1134         unixctl_command_reply(conn, 501, "cannot make disabled slave active");
1135         return;
1136     }
1137
1138     if (bond->active_slave != slave) {
1139         tag_set_add(&bond->unixctl_tags, bond_get_active_slave_tag(bond));
1140         bond->active_slave = slave;
1141         bond->active_slave->tag = tag_create_random();
1142         VLOG_INFO("bond %s: active interface is now %s",
1143                   bond->name, slave->name);
1144         bond->send_learning_packets = true;
1145         unixctl_command_reply(conn, 200, "done");
1146     } else {
1147         unixctl_command_reply(conn, 200, "no change");
1148     }
1149 }
1150
1151 static void
1152 enable_slave(struct unixctl_conn *conn, const char *args_, bool enable)
1153 {
1154     char *args = (char *) args_;
1155     char *save_ptr = NULL;
1156     char *bond_s, *slave_s;
1157     struct bond *bond;
1158     struct bond_slave *slave;
1159
1160     bond_s = strtok_r(args, " ", &save_ptr);
1161     slave_s = strtok_r(NULL, " ", &save_ptr);
1162     if (!slave_s) {
1163         char *usage = xasprintf("usage: bond/%s-slave BOND SLAVE",
1164                                 enable ? "enable" : "disable");
1165         unixctl_command_reply(conn, 501, usage);
1166         free(usage);
1167         return;
1168     }
1169
1170     bond = bond_find(bond_s);
1171     if (!bond) {
1172         unixctl_command_reply(conn, 501, "no such bond");
1173         return;
1174     }
1175
1176     slave = bond_lookup_slave(bond, slave_s);
1177     if (!slave) {
1178         unixctl_command_reply(conn, 501, "no such slave");
1179         return;
1180     }
1181
1182     bond_enable_slave(slave, enable, &bond->unixctl_tags);
1183     unixctl_command_reply(conn, 501, enable ? "enabled" : "disabled");
1184 }
1185
1186 static void
1187 bond_unixctl_enable_slave(struct unixctl_conn *conn, const char *args,
1188                           void *aux OVS_UNUSED)
1189 {
1190     enable_slave(conn, args, true);
1191 }
1192
1193 static void
1194 bond_unixctl_disable_slave(struct unixctl_conn *conn, const char *args,
1195                            void *aux OVS_UNUSED)
1196 {
1197     enable_slave(conn, args, false);
1198 }
1199
1200 static void
1201 bond_unixctl_hash(struct unixctl_conn *conn, const char *args_,
1202                   void *aux OVS_UNUSED)
1203 {
1204     char *args = (char *) args_;
1205     uint8_t mac[ETH_ADDR_LEN];
1206     uint8_t hash;
1207     char *hash_cstr;
1208     unsigned int vlan;
1209     char *mac_s, *vlan_s;
1210     char *save_ptr = NULL;
1211
1212     mac_s  = strtok_r(args, " ", &save_ptr);
1213     vlan_s = strtok_r(NULL, " ", &save_ptr);
1214
1215     if (vlan_s) {
1216         if (sscanf(vlan_s, "%u", &vlan) != 1) {
1217             unixctl_command_reply(conn, 501, "invalid vlan");
1218             return;
1219         }
1220     } else {
1221         vlan = OFP_VLAN_NONE;
1222     }
1223
1224     if (sscanf(mac_s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
1225         == ETH_ADDR_SCAN_COUNT) {
1226         hash = bond_hash_src(mac, vlan) & BOND_MASK;
1227
1228         hash_cstr = xasprintf("%u", hash);
1229         unixctl_command_reply(conn, 200, hash_cstr);
1230         free(hash_cstr);
1231     } else {
1232         unixctl_command_reply(conn, 501, "invalid mac");
1233     }
1234 }
1235
1236 void
1237 bond_init(void)
1238 {
1239     unixctl_command_register("bond/list", bond_unixctl_list, NULL);
1240     unixctl_command_register("bond/show", bond_unixctl_show, NULL);
1241     unixctl_command_register("bond/migrate", bond_unixctl_migrate, NULL);
1242     unixctl_command_register("bond/set-active-slave",
1243                              bond_unixctl_set_active_slave, NULL);
1244     unixctl_command_register("bond/enable-slave", bond_unixctl_enable_slave,
1245                              NULL);
1246     unixctl_command_register("bond/disable-slave", bond_unixctl_disable_slave,
1247                              NULL);
1248     unixctl_command_register("bond/hash", bond_unixctl_hash, NULL);
1249 }
1250 \f
1251 static void
1252 bond_entry_reset(struct bond *bond)
1253 {
1254     if (bond->balance != BM_AB) {
1255         size_t hash_len = (BOND_MASK + 1) * sizeof *bond->hash;
1256
1257         if (!bond->hash) {
1258             bond->hash = xmalloc(hash_len);
1259         }
1260         memset(bond->hash, 0, hash_len);
1261
1262         bond->next_rebalance = time_msec() + bond->rebalance_interval;
1263     } else {
1264         free(bond->hash);
1265         bond->hash = NULL;
1266     }
1267 }
1268
1269 static struct bond_slave *
1270 bond_slave_lookup(struct bond *bond, const void *slave_)
1271 {
1272     struct bond_slave *slave;
1273
1274     HMAP_FOR_EACH_IN_BUCKET (slave, hmap_node, hash_pointer(slave_, 0),
1275                              &bond->slaves) {
1276         if (slave->aux == slave_) {
1277             return slave;
1278         }
1279     }
1280
1281     return NULL;
1282 }
1283
1284 static bool
1285 bond_is_link_up(struct bond *bond, struct netdev *netdev)
1286 {
1287     return (bond->detect == BLSM_CARRIER
1288             ? netdev_get_carrier(netdev)
1289             : netdev_get_miimon(netdev));
1290 }
1291
1292 static void
1293 bond_enable_slave(struct bond_slave *slave, bool enable, struct tag_set *tags)
1294 {
1295     struct bond *bond = slave->bond;
1296     slave->delay_expires = LLONG_MAX;
1297     if (enable != slave->enabled) {
1298         slave->enabled = enable;
1299         if (!slave->enabled) {
1300             VLOG_WARN("interface %s: disabled", slave->name);
1301             if (tags) {
1302                 tag_set_add(tags, slave->tag);
1303             }
1304         } else {
1305             VLOG_WARN("interface %s: enabled", slave->name);
1306             slave->tag = tag_create_random();
1307         }
1308
1309         if (bond->balance == BM_STABLE) {
1310             bond->bond_revalidate = true;
1311         }
1312     }
1313 }
1314
1315 static void
1316 bond_link_status_update(struct bond_slave *slave, struct tag_set *tags)
1317 {
1318     struct bond *bond = slave->bond;
1319     bool up;
1320
1321     up = slave->up && slave->lacp_may_enable;
1322     if ((up == slave->enabled) != (slave->delay_expires == LLONG_MAX)) {
1323         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1324         VLOG_INFO_RL(&rl, "interface %s: link state %s",
1325                      slave->name, up ? "up" : "down");
1326         if (up == slave->enabled) {
1327             slave->delay_expires = LLONG_MAX;
1328             VLOG_INFO_RL(&rl, "interface %s: will not be %s",
1329                          slave->name, up ? "disabled" : "enabled");
1330         } else {
1331             int delay = (bond->lacp_negotiated ? 0
1332                          : up ? bond->updelay : bond->downdelay);
1333             slave->delay_expires = time_msec() + delay;
1334             if (delay) {
1335                 VLOG_INFO_RL(&rl, "interface %s: will be %s if it stays %s "
1336                              "for %d ms",
1337                              slave->name,
1338                              up ? "enabled" : "disabled",
1339                              up ? "up" : "down",
1340                              delay);
1341             }
1342         }
1343     }
1344
1345     if (time_msec() >= slave->delay_expires) {
1346         bond_enable_slave(slave, up, tags);
1347     }
1348 }
1349
1350 static bool
1351 bond_is_tcp_hash(const struct bond *bond)
1352 {
1353     return (bond->balance == BM_TCP || bond->balance == BM_STABLE)
1354         && bond->lacp_negotiated;
1355 }
1356
1357 static unsigned int
1358 bond_hash_src(const uint8_t mac[ETH_ADDR_LEN], uint16_t vlan)
1359 {
1360     return hash_bytes(mac, ETH_ADDR_LEN, vlan);
1361 }
1362
1363 static unsigned int
1364 bond_hash_tcp(const struct flow *flow, uint16_t vlan)
1365 {
1366     struct flow hash_flow = *flow;
1367     hash_flow.vlan_tci = vlan;
1368
1369     /* The symmetric quality of this hash function is not required, but
1370      * flow_hash_symmetric_l4 already exists, and is sufficient for our
1371      * purposes, so we use it out of convenience. */
1372     return flow_hash_symmetric_l4(&hash_flow, 0);
1373 }
1374
1375 static unsigned int
1376 bond_hash(const struct bond *bond, const struct flow *flow, uint16_t vlan)
1377 {
1378     assert(bond->balance != BM_AB);
1379
1380     return (bond_is_tcp_hash(bond)
1381             ? bond_hash_tcp(flow, vlan)
1382             : bond_hash_src(flow->dl_src, vlan));
1383 }
1384
1385 static struct bond_entry *
1386 lookup_bond_entry(const struct bond *bond, const struct flow *flow,
1387                   uint16_t vlan)
1388 {
1389     return &bond->hash[bond_hash(bond, flow, vlan) & BOND_MASK];
1390 }
1391
1392 /* This function uses Highest Random Weight hashing to choose an output slave.
1393  * This approach only reassigns a minimal number of flows when slaves are
1394  * enabled or disabled.  Unfortunately, it has O(n) performance against the
1395  * number of slaves.  There exist algorithms which are O(1), but have slightly
1396  * more complex implementations and require the use of memory.  This may need
1397  * to be reimplemented if it becomes a performance bottleneck. */
1398 static struct bond_slave *
1399 choose_stb_slave(const struct bond *bond, const struct flow *flow,
1400                  uint16_t vlan)
1401 {
1402     struct bond_slave *best, *slave;
1403     uint32_t best_hash, flow_hash;
1404
1405     best = NULL;
1406     best_hash = 0;
1407     flow_hash = bond_hash(bond, flow, vlan);
1408     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1409         if (slave->enabled) {
1410             uint32_t hash;
1411
1412             hash = hash_2words(flow_hash, slave->stb_id);
1413             if (!best || hash > best_hash) {
1414                 best = slave;
1415                 best_hash = hash;
1416             }
1417         }
1418     }
1419
1420     return best;
1421 }
1422
1423 static struct bond_slave *
1424 choose_output_slave(const struct bond *bond, const struct flow *flow,
1425                     uint16_t vlan)
1426 {
1427     struct bond_entry *e;
1428
1429     switch (bond->balance) {
1430     case BM_AB:
1431         return bond->active_slave;
1432
1433     case BM_STABLE:
1434         return choose_stb_slave(bond, flow, vlan);
1435     case BM_SLB:
1436     case BM_TCP:
1437         e = lookup_bond_entry(bond, flow, vlan);
1438         if (!e->slave || !e->slave->enabled) {
1439             e->slave = CONTAINER_OF(hmap_random_node(&bond->slaves),
1440                                     struct bond_slave, hmap_node);
1441             if (!e->slave->enabled) {
1442                 e->slave = bond->active_slave;
1443             }
1444             e->tag = tag_create_random();
1445         }
1446         return e->slave;
1447
1448     default:
1449         NOT_REACHED();
1450     }
1451 }
1452
1453 static struct bond_slave *
1454 bond_choose_slave(const struct bond *bond)
1455 {
1456     struct bond_slave *slave, *best;
1457
1458     /* Find an enabled slave. */
1459     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1460         if (slave->enabled) {
1461             return slave;
1462         }
1463     }
1464
1465     /* All interfaces are disabled.  Find an interface that will be enabled
1466      * after its updelay expires.  */
1467     best = NULL;
1468     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1469         if (slave->delay_expires != LLONG_MAX
1470             && slave->lacp_may_enable
1471             && (!best || slave->delay_expires < best->delay_expires)) {
1472             best = slave;
1473         }
1474     }
1475     return best;
1476 }
1477
1478 static void
1479 bond_choose_active_slave(struct bond *bond, struct tag_set *tags)
1480 {
1481     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1482     struct bond_slave *old_active_slave = bond->active_slave;
1483
1484     bond->active_slave = bond_choose_slave(bond);
1485     if (bond->active_slave) {
1486         if (bond->active_slave->enabled) {
1487             VLOG_INFO_RL(&rl, "bond %s: active interface is now %s",
1488                          bond->name, bond->active_slave->name);
1489         } else {
1490             VLOG_INFO_RL(&rl, "bond %s: active interface is now %s, skipping "
1491                          "remaining %lld ms updelay (since no interface was "
1492                          "enabled)", bond->name, bond->active_slave->name,
1493                          bond->active_slave->delay_expires - time_msec());
1494             bond_enable_slave(bond->active_slave, true, tags);
1495         }
1496
1497         if (!old_active_slave) {
1498             tag_set_add(tags, bond->no_slaves_tag);
1499         }
1500
1501         bond->send_learning_packets = true;
1502     } else if (old_active_slave) {
1503         VLOG_WARN_RL(&rl, "bond %s: all interfaces disabled", bond->name);
1504     }
1505 }
1506
1507 /* Returns the tag for 'bond''s active slave, or 'bond''s no_slaves_tag if
1508  * there is no active slave. */
1509 static tag_type
1510 bond_get_active_slave_tag(const struct bond *bond)
1511 {
1512     return (bond->active_slave
1513             ? bond->active_slave->tag
1514             : bond->no_slaves_tag);
1515 }
1516
1517 /* Attempts to make the sum of the bond slaves' statistics appear on the fake
1518  * bond interface. */
1519 static void
1520 bond_update_fake_slave_stats(struct bond *bond)
1521 {
1522     struct netdev_stats bond_stats;
1523     struct bond_slave *slave;
1524     struct netdev *bond_dev;
1525
1526     memset(&bond_stats, 0, sizeof bond_stats);
1527
1528     HMAP_FOR_EACH (slave, hmap_node, &bond->slaves) {
1529         struct netdev_stats slave_stats;
1530
1531         if (!netdev_get_stats(slave->netdev, &slave_stats)) {
1532             /* XXX: We swap the stats here because they are swapped back when
1533              * reported by the internal device.  The reason for this is
1534              * internal devices normally represent packets going into the
1535              * system but when used as fake bond device they represent packets
1536              * leaving the system.  We really should do this in the internal
1537              * device itself because changing it here reverses the counts from
1538              * the perspective of the switch.  However, the internal device
1539              * doesn't know what type of device it represents so we have to do
1540              * it here for now. */
1541             bond_stats.tx_packets += slave_stats.rx_packets;
1542             bond_stats.tx_bytes += slave_stats.rx_bytes;
1543             bond_stats.rx_packets += slave_stats.tx_packets;
1544             bond_stats.rx_bytes += slave_stats.tx_bytes;
1545         }
1546     }
1547
1548     if (!netdev_open_default(bond->name, &bond_dev)) {
1549         netdev_set_stats(bond_dev, &bond_stats);
1550         netdev_close(bond_dev);
1551     }
1552 }