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