1 /* Copyright (c) 2011 Nicira Networks
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
22 #include "dynamic-string.h"
27 #include "poll-loop.h"
33 VLOG_DEFINE_THIS_MODULE(lacp);
36 LACP_CURRENT, /* Current State. Partner up to date. */
37 LACP_EXPIRED, /* Expired State. Partner out of date. */
38 LACP_DEFAULTED, /* Defaulted State. No partner. */
42 struct list node; /* Node in all_lacps list. */
43 char *name; /* Name of this lacp object. */
44 uint8_t sys_id[ETH_ADDR_LEN]; /* System ID. */
45 uint16_t sys_priority; /* System Priority. */
46 bool active; /* Active or Passive. */
48 struct hmap slaves; /* Slaves this LACP object controls. */
49 struct slave *key_slave; /* Slave whose ID will be the aggregation key. */
51 bool fast; /* Fast or Slow LACP time. */
52 bool negotiated; /* True if LACP negotiations were successful. */
53 bool update; /* True if lacp_update() needs to be called. */
57 void *aux; /* Handle used to identify this slave. */
58 struct hmap_node node; /* Node in master's slaves map. */
60 struct lacp *lacp; /* LACP object containing this slave. */
61 uint16_t port_id; /* Port ID. */
62 uint16_t port_priority; /* Port Priority. */
63 char *name; /* Name of this slave. */
65 enum slave_status status; /* Slave status. */
66 bool attached; /* Attached. Traffic may flow. */
67 bool enabled; /* Enabled. Traffic is flowing. */
68 struct lacp_info partner; /* Partner information. */
69 struct lacp_info ntt_actor; /* Used to decide if we Need To Transmit. */
70 struct timer tx; /* Next message transmission timer. */
71 struct timer rx; /* Expected message receive timer. */
74 static struct list all_lacps = LIST_INITIALIZER(&all_lacps);
76 static void lacp_update_attached(struct lacp *);
78 static void slave_destroy(struct slave *);
79 static void slave_set_defaulted(struct slave *);
80 static void slave_set_expired(struct slave *);
81 static void slave_get_actor(struct slave *, struct lacp_info *actor);
82 static void slave_get_priority(struct slave *, struct lacp_info *priority);
83 static bool slave_may_tx(const struct slave *);
84 static struct slave *slave_lookup(const struct lacp *, const void *slave);
85 static bool info_tx_equal(struct lacp_info *, struct lacp_info *);
87 static void lacp_unixctl_show(struct unixctl_conn *, const char *args,
90 /* Initializes the lacp module. */
94 unixctl_command_register("lacp/show", lacp_unixctl_show, NULL);
97 /* Creates a LACP object. */
103 lacp = xzalloc(sizeof *lacp);
104 hmap_init(&lacp->slaves);
105 list_push_back(&all_lacps, &lacp->node);
109 /* Destroys 'lacp' and its slaves. Does nothing if 'lacp' is NULL. */
111 lacp_destroy(struct lacp *lacp)
114 struct slave *slave, *next;
116 HMAP_FOR_EACH_SAFE (slave, next, node, &lacp->slaves) {
117 slave_destroy(slave);
120 hmap_destroy(&lacp->slaves);
121 list_remove(&lacp->node);
127 /* Configures 'lacp' with the given 'name', 'sys_id', 'sys_priority', and
128 * 'active' parameters. */
130 lacp_configure(struct lacp *lacp, const char *name,
131 const uint8_t sys_id[ETH_ADDR_LEN], uint16_t sys_priority,
132 bool active, bool fast)
134 if (!lacp->name || strcmp(name, lacp->name)) {
136 lacp->name = xstrdup(name);
139 memcpy(lacp->sys_id, sys_id, ETH_ADDR_LEN);
140 lacp->sys_priority = sys_priority;
141 lacp->active = active;
145 /* Returns true if 'lacp' is configured in active mode, false if 'lacp' is
146 * configured for passive mode. */
148 lacp_is_active(const struct lacp *lacp)
153 /* Processes 'pdu', a parsed LACP packet received on 'slave_'. This function
154 * should be called on all packets received on 'slave_' with Ethernet Type
155 * ETH_TYPE_LACP and parsable by parse_lacp_packet(). */
157 lacp_process_pdu(struct lacp *lacp, const void *slave_,
158 const struct lacp_pdu *pdu)
160 struct slave *slave = slave_lookup(lacp, slave_);
162 slave->status = LACP_CURRENT;
163 timer_set_duration(&slave->rx, (lacp->fast
165 : LACP_SLOW_TIME_RX));
167 slave->ntt_actor = pdu->partner;
169 /* Update our information about our partner if it's out of date. This may
170 * cause priorities to change so re-calculate attached status of all
172 if (memcmp(&slave->partner, &pdu->actor, sizeof pdu->actor)) {
174 slave->partner = pdu->actor;
178 /* Returns true if 'lacp' has successfully negotiated with its partner. False
179 * if 'lacp' is NULL. */
181 lacp_negotiated(const struct lacp *lacp)
183 return lacp ? lacp->negotiated : false;
186 /* Registers 'slave_' as subordinate to 'lacp'. This should be called at least
187 * once per slave in a LACP managed bond. Should also be called whenever a
188 * slave's name, port_id, or port_priority change. */
190 lacp_slave_register(struct lacp *lacp, void *slave_, const char *name,
191 uint16_t port_id, uint16_t port_priority)
193 struct slave *slave = slave_lookup(lacp, slave_);
196 slave = xzalloc(sizeof *slave);
199 hmap_insert(&lacp->slaves, &slave->node, hash_pointer(slave_, 0));
200 slave_set_defaulted(slave);
202 if (!lacp->key_slave) {
203 lacp->key_slave = slave;
207 if (!slave->name || strcmp(name, slave->name)) {
209 slave->name = xstrdup(name);
212 if (slave->port_id != port_id || slave->port_priority != port_priority) {
214 slave->port_id = port_id;
215 slave->port_priority = port_priority;
219 if (lacp->active || lacp->negotiated) {
220 slave_set_expired(slave);
225 /* Unregisters 'slave_' with 'lacp'. */
227 lacp_slave_unregister(struct lacp *lacp, const void *slave_)
229 struct slave *slave = slave_lookup(lacp, slave_);
232 slave_destroy(slave);
236 /* Should be called regularly to indicate whether 'slave_' is enabled. An
237 * enabled slave is allowed to send and receive traffic. Generally a slave
238 * should not be enabled if its carrier is down, or lacp_slave_may_enable()
239 * indicates it should not be enabled. */
241 lacp_slave_enable(struct lacp *lacp, void *slave_, bool enabled)
243 slave_lookup(lacp, slave_)->enabled = enabled;
246 /* This function should be called whenever the carrier status of 'slave_' has
249 lacp_slave_carrier_changed(const struct lacp *lacp, const void *slave_)
251 struct slave *slave = slave_lookup(lacp, slave_);
253 if (slave->status == LACP_CURRENT || slave->lacp->active) {
254 slave_set_expired(slave);
258 /* This function should be called before enabling 'slave_' to send or receive
259 * traffic. If it returns false, 'slave_' should not enabled. As a
260 * convenience, returns true if 'lacp' is NULL. */
262 lacp_slave_may_enable(const struct lacp *lacp, const void *slave_)
265 struct slave *slave = slave_lookup(lacp, slave_);
267 /* The slave may be enabled if it's attached to an aggregator and its
268 * partner is synchronized. The only exception is defaulted slaves.
269 * They are not required to have synchronized partners because they
270 * have no partners at all. They will only be attached if negotiations
271 * failed on all slaves in the bond. */
272 return slave->attached && (slave->partner.state & LACP_STATE_SYNC
273 || slave->status == LACP_DEFAULTED);
279 /* This function should be called periodically to update 'lacp'. */
281 lacp_run(struct lacp *lacp, lacp_send_pdu *send_pdu)
285 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
286 if (timer_expired(&slave->rx)) {
287 if (slave->status == LACP_CURRENT) {
288 slave_set_expired(slave);
289 } else if (slave->status == LACP_EXPIRED) {
290 slave_set_defaulted(slave);
296 lacp_update_attached(lacp);
299 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
301 struct lacp_info actor;
303 if (!slave_may_tx(slave)) {
307 slave_get_actor(slave, &actor);
309 if (timer_expired(&slave->tx)
310 || !info_tx_equal(&actor, &slave->ntt_actor)) {
312 slave->ntt_actor = actor;
313 compose_lacp_pdu(&actor, &slave->partner, &pdu);
314 send_pdu(slave->aux, &pdu);
316 timer_set_duration(&slave->tx,
317 (slave->partner.state & LACP_STATE_TIME
319 : LACP_SLOW_TIME_TX));
324 /* Causes poll_block() to wake up when lacp_run() needs to be called again. */
326 lacp_wait(struct lacp *lacp)
330 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
331 if (slave_may_tx(slave)) {
332 timer_wait(&slave->tx);
335 if (slave->status != LACP_DEFAULTED) {
336 timer_wait(&slave->rx);
341 /* Static Helpers. */
343 /* Updates the attached status of all slaves controlled b 'lacp' and sets its
344 * negotiated parameter to true if any slaves are attachable. */
346 lacp_update_attached(struct lacp *lacp)
348 struct slave *lead, *slave;
349 struct lacp_info lead_pri;
350 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
352 lacp->update = false;
355 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
356 struct lacp_info pri;
358 slave->attached = true;
360 /* XXX: In the future allow users to configure the expected system ID.
361 * For now just special case loopback. */
362 if (eth_addr_equals(slave->partner.sys_id, slave->lacp->sys_id)) {
363 VLOG_WARN_RL(&rl, "slave %s: Loopback detected. Slave is "
364 "connected to its own bond", slave->name);
365 slave->attached = false;
369 if (slave->status == LACP_DEFAULTED) {
373 slave_get_priority(slave, &pri);
375 if (!lead || memcmp(&pri, &lead_pri, sizeof pri) < 0) {
381 lacp->negotiated = lead != NULL;
384 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
385 if (slave->status == LACP_DEFAULTED
386 || lead->partner.key != slave->partner.key
387 || !eth_addr_equals(lead->partner.sys_id,
388 slave->partner.sys_id)) {
389 slave->attached = false;
396 slave_destroy(struct slave *slave)
399 struct lacp *lacp = slave->lacp;
402 hmap_remove(&lacp->slaves, &slave->node);
404 if (lacp->key_slave == slave) {
405 struct hmap_node *slave_node = hmap_first(&lacp->slaves);
408 lacp->key_slave = CONTAINER_OF(slave_node, struct slave, node);
410 lacp->key_slave = NULL;
420 slave_set_defaulted(struct slave *slave)
422 memset(&slave->partner, 0, sizeof slave->partner);
424 slave->lacp->update = true;
425 slave->status = LACP_DEFAULTED;
429 slave_set_expired(struct slave *slave)
431 slave->status = LACP_EXPIRED;
432 slave->partner.state |= LACP_STATE_TIME;
433 slave->partner.state &= ~LACP_STATE_SYNC;
434 timer_set_duration(&slave->rx, LACP_FAST_TIME_RX);
438 slave_get_actor(struct slave *slave, struct lacp_info *actor)
442 if (slave->lacp->active) {
443 state |= LACP_STATE_ACT;
446 if (slave->lacp->fast) {
447 state |= LACP_STATE_TIME;
450 if (slave->attached) {
451 state |= LACP_STATE_SYNC;
454 if (slave->status == LACP_DEFAULTED) {
455 state |= LACP_STATE_DEF;
458 if (slave->status == LACP_EXPIRED) {
459 state |= LACP_STATE_EXP;
462 if (hmap_count(&slave->lacp->slaves) > 1) {
463 state |= LACP_STATE_AGG;
466 if (slave->enabled) {
467 state |= LACP_STATE_COL | LACP_STATE_DIST;
470 actor->state = state;
471 actor->key = htons(slave->lacp->key_slave->port_id);
472 actor->port_priority = htons(slave->port_priority);
473 actor->port_id = htons(slave->port_id);
474 actor->sys_priority = htons(slave->lacp->sys_priority);
475 memcpy(&actor->sys_id, slave->lacp->sys_id, ETH_ADDR_LEN);
478 /* Given 'slave', populates 'priority' with data representing its LACP link
479 * priority. If two priority objects populated by this function are compared
480 * using memcmp, the higher priority link will be less than the lower priority
483 slave_get_priority(struct slave *slave, struct lacp_info *priority)
485 uint16_t partner_priority, actor_priority;
487 /* Choose the lacp_info of the higher priority system by comparing their
488 * system priorities and mac addresses. */
489 actor_priority = slave->lacp->sys_priority;
490 partner_priority = ntohs(slave->partner.sys_priority);
491 if (actor_priority < partner_priority) {
492 slave_get_actor(slave, priority);
493 } else if (partner_priority < actor_priority) {
494 *priority = slave->partner;
495 } else if (eth_addr_compare_3way(slave->lacp->sys_id,
496 slave->partner.sys_id) < 0) {
497 slave_get_actor(slave, priority);
499 *priority = slave->partner;
502 /* Key and state are not used in priority comparisons. */
508 slave_may_tx(const struct slave *slave)
510 return slave->lacp->active || slave->status != LACP_DEFAULTED;
513 static struct slave *
514 slave_lookup(const struct lacp *lacp, const void *slave_)
518 HMAP_FOR_EACH_IN_BUCKET (slave, node, hash_pointer(slave_, 0),
520 if (slave->aux == slave_) {
528 /* Two lacp_info structures are tx_equal if and only if they do not differ in
529 * ways which would require a lacp_pdu transmission. */
531 info_tx_equal(struct lacp_info *a, struct lacp_info *b)
534 /* LACP specification dictates that we transmit whenever the actor and
535 * remote_actor differ in the following fields: Port, Port Priority,
536 * System, System Priority, Aggregation Key, Activity State, Timeout State,
537 * Sync State, and Aggregation State. The state flags are most likely to
538 * change so are checked first. */
539 return !((a->state ^ b->state) & (LACP_STATE_ACT
543 && a->port_id == b->port_id
544 && a->port_priority == b->port_priority
546 && a->sys_priority == b->sys_priority
547 && eth_addr_equals(a->sys_id, b->sys_id);
551 lacp_find(const char *name)
555 LIST_FOR_EACH (lacp, node, &all_lacps) {
556 if (!strcmp(lacp->name, name)) {
565 ds_put_lacp_state(struct ds *ds, uint8_t state)
567 if (state & LACP_STATE_ACT) {
568 ds_put_cstr(ds, "activity ");
571 if (state & LACP_STATE_TIME) {
572 ds_put_cstr(ds, "timeout ");
575 if (state & LACP_STATE_AGG) {
576 ds_put_cstr(ds, "aggregation ");
579 if (state & LACP_STATE_SYNC) {
580 ds_put_cstr(ds, "synchronized ");
583 if (state & LACP_STATE_COL) {
584 ds_put_cstr(ds, "collecting ");
587 if (state & LACP_STATE_DIST) {
588 ds_put_cstr(ds, "distributing ");
591 if (state & LACP_STATE_DEF) {
592 ds_put_cstr(ds, "defaulted ");
595 if (state & LACP_STATE_EXP) {
596 ds_put_cstr(ds, "expired ");
601 lacp_unixctl_show(struct unixctl_conn *conn,
602 const char *args, void *aux OVS_UNUSED)
604 struct ds ds = DS_EMPTY_INITIALIZER;
608 lacp = lacp_find(args);
610 unixctl_command_reply(conn, 501, "no such lacp object");
614 ds_put_format(&ds, "lacp: %s\n", lacp->name);
615 ds_put_format(&ds, "\tstatus: %s %s\n",
616 lacp->active ? "active" : "passive",
617 lacp->negotiated ? "negotiated" : "");
618 ds_put_format(&ds, "\tsys_id: " ETH_ADDR_FMT "\n", ETH_ADDR_ARGS(lacp->sys_id));
619 ds_put_format(&ds, "\tsys_priority: %u\n", lacp->sys_priority);
620 ds_put_cstr(&ds, "\taggregation key: ");
621 if (lacp->key_slave) {
622 ds_put_format(&ds, "%u", lacp->key_slave->port_id);
624 ds_put_cstr(&ds, "none");
626 ds_put_cstr(&ds, "\n");
628 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
630 struct lacp_info actor;
632 slave_get_actor(slave, &actor);
633 switch (slave->status) {
641 status = "defaulted";
647 ds_put_format(&ds, "\nslave: %s: %s %s %s\n", slave->name, status,
648 slave->attached ? "attached" : "detached",
649 slave->enabled ? "enabled" : "disabled");
650 ds_put_format(&ds, "\tport_id: %u\n", slave->port_id);
651 ds_put_format(&ds, "\tport_priority: %u\n", slave->port_priority);
653 ds_put_format(&ds, "\n\tactor sys_id: " ETH_ADDR_FMT "\n",
654 ETH_ADDR_ARGS(actor.sys_id));
655 ds_put_format(&ds, "\tactor sys_priority: %u\n",
656 ntohs(actor.sys_priority));
657 ds_put_format(&ds, "\tactor port_id: %u\n",
658 ntohs(actor.port_id));
659 ds_put_format(&ds, "\tactor port_priority: %u\n",
660 ntohs(actor.port_priority));
661 ds_put_format(&ds, "\tactor key: %u\n",
663 ds_put_cstr(&ds, "\tactor state: ");
664 ds_put_lacp_state(&ds, actor.state);
665 ds_put_cstr(&ds, "\n\n");
667 ds_put_format(&ds, "\tpartner sys_id: " ETH_ADDR_FMT "\n",
668 ETH_ADDR_ARGS(slave->partner.sys_id));
669 ds_put_format(&ds, "\tpartner sys_priority: %u\n",
670 ntohs(slave->partner.sys_priority));
671 ds_put_format(&ds, "\tpartner port_id: %u\n",
672 ntohs(slave->partner.port_id));
673 ds_put_format(&ds, "\tpartner port_priority: %u\n",
674 ntohs(slave->partner.port_priority));
675 ds_put_format(&ds, "\tpartner key: %u\n",
676 ntohs(slave->partner.key));
677 ds_put_cstr(&ds, "\tpartner state: ");
678 ds_put_lacp_state(&ds, slave->partner.state);
679 ds_put_cstr(&ds, "\n");
682 unixctl_command_reply(conn, 200, ds_cstr(&ds));