1 /* Copyright (c) 2011, 2012 Nicira, Inc.
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.
21 #include "dynamic-string.h"
26 #include "poll-loop.h"
33 VLOG_DEFINE_THIS_MODULE(lacp);
35 /* Masks for lacp_info state member. */
36 #define LACP_STATE_ACT 0x01 /* Activity. Active or passive? */
37 #define LACP_STATE_TIME 0x02 /* Timeout. Short or long timeout? */
38 #define LACP_STATE_AGG 0x04 /* Aggregation. Is the link is bondable? */
39 #define LACP_STATE_SYNC 0x08 /* Synchronization. Is the link in up to date? */
40 #define LACP_STATE_COL 0x10 /* Collecting. Is the link receiving frames? */
41 #define LACP_STATE_DIST 0x20 /* Distributing. Is the link sending frames? */
42 #define LACP_STATE_DEF 0x40 /* Defaulted. Using default partner info? */
43 #define LACP_STATE_EXP 0x80 /* Expired. Using expired partner info? */
45 #define LACP_FAST_TIME_TX 1000 /* Fast transmission rate. */
46 #define LACP_SLOW_TIME_TX 30000 /* Slow transmission rate. */
47 #define LACP_RX_MULTIPLIER 3 /* Multiply by TX rate to get RX rate. */
49 #define LACP_INFO_LEN 15
52 ovs_be16 sys_priority; /* System priority. */
53 uint8_t sys_id[ETH_ADDR_LEN]; /* System ID. */
54 ovs_be16 key; /* Operational key. */
55 ovs_be16 port_priority; /* Port priority. */
56 ovs_be16 port_id; /* Port ID. */
57 uint8_t state; /* State mask. See LACP_STATE macros. */
59 BUILD_ASSERT_DECL(LACP_INFO_LEN == sizeof(struct lacp_info));
61 #define LACP_PDU_LEN 110
64 uint8_t subtype; /* Always 1. */
65 uint8_t version; /* Always 1. */
67 uint8_t actor_type; /* Always 1. */
68 uint8_t actor_len; /* Always 20. */
69 struct lacp_info actor; /* LACP actor information. */
70 uint8_t z1[3]; /* Reserved. Always 0. */
72 uint8_t partner_type; /* Always 2. */
73 uint8_t partner_len; /* Always 20. */
74 struct lacp_info partner; /* LACP partner information. */
75 uint8_t z2[3]; /* Reserved. Always 0. */
77 uint8_t collector_type; /* Always 3. */
78 uint8_t collector_len; /* Always 16. */
79 ovs_be16 collector_delay; /* Maximum collector delay. Set to UINT16_MAX. */
80 uint8_t z3[64]; /* Combination of several fields. Always 0. */
82 BUILD_ASSERT_DECL(LACP_PDU_LEN == sizeof(struct lacp_pdu));
87 LACP_CURRENT, /* Current State. Partner up to date. */
88 LACP_EXPIRED, /* Expired State. Partner out of date. */
89 LACP_DEFAULTED, /* Defaulted State. No partner. */
93 struct list node; /* Node in all_lacps list. */
94 char *name; /* Name of this lacp object. */
95 uint8_t sys_id[ETH_ADDR_LEN]; /* System ID. */
96 uint16_t sys_priority; /* System Priority. */
97 bool active; /* Active or Passive. */
99 struct hmap slaves; /* Slaves this LACP object controls. */
100 struct slave *key_slave; /* Slave whose ID will be the aggregation key. */
102 bool fast; /* True if using fast probe interval. */
103 bool negotiated; /* True if LACP negotiations were successful. */
104 bool update; /* True if lacp_update() needs to be called. */
110 void *aux; /* Handle used to identify this slave. */
111 struct hmap_node node; /* Node in master's slaves map. */
113 struct lacp *lacp; /* LACP object containing this slave. */
114 uint16_t port_id; /* Port ID. */
115 uint16_t port_priority; /* Port Priority. */
116 uint16_t key; /* Aggregation Key. 0 if default. */
117 char *name; /* Name of this slave. */
119 enum slave_status status; /* Slave status. */
120 bool attached; /* Attached. Traffic may flow. */
121 struct lacp_info partner; /* Partner information. */
122 struct lacp_info ntt_actor; /* Used to decide if we Need To Transmit. */
123 struct timer tx; /* Next message transmission timer. */
124 struct timer rx; /* Expected message receive timer. */
127 static struct list all_lacps = LIST_INITIALIZER(&all_lacps);
129 static void lacp_update_attached(struct lacp *);
131 static void slave_destroy(struct slave *);
132 static void slave_set_defaulted(struct slave *);
133 static void slave_set_expired(struct slave *);
134 static void slave_get_actor(struct slave *, struct lacp_info *actor);
135 static void slave_get_priority(struct slave *, struct lacp_info *priority);
136 static bool slave_may_tx(const struct slave *);
137 static struct slave *slave_lookup(const struct lacp *, const void *slave);
138 static bool info_tx_equal(struct lacp_info *, struct lacp_info *);
140 static unixctl_cb_func lacp_unixctl_show;
142 /* Populates 'pdu' with a LACP PDU comprised of 'actor' and 'partner'. */
144 compose_lacp_pdu(const struct lacp_info *actor,
145 const struct lacp_info *partner, struct lacp_pdu *pdu)
147 memset(pdu, 0, sizeof *pdu);
156 pdu->partner_type = 2;
157 pdu->partner_len = 20;
158 pdu->partner = *partner;
160 pdu->collector_type = 3;
161 pdu->collector_len = 16;
162 pdu->collector_delay = htons(0);
165 /* Parses 'b' which represents a packet containing a LACP PDU. This function
166 * returns NULL if 'b' is malformed, or does not represent a LACP PDU format
167 * supported by OVS. Otherwise, it returns a pointer to the lacp_pdu contained
169 static const struct lacp_pdu *
170 parse_lacp_packet(const struct ofpbuf *b)
172 const struct lacp_pdu *pdu;
174 pdu = ofpbuf_at(b, (uint8_t *)b->l3 - (uint8_t *)b->data, LACP_PDU_LEN);
176 if (pdu && pdu->subtype == 1
177 && pdu->actor_type == 1 && pdu->actor_len == 20
178 && pdu->partner_type == 2 && pdu->partner_len == 20) {
185 /* LACP Protocol Implementation. */
187 /* Initializes the lacp module. */
191 unixctl_command_register("lacp/show", "[port]", 0, 1,
192 lacp_unixctl_show, NULL);
195 /* Creates a LACP object. */
201 lacp = xzalloc(sizeof *lacp);
202 hmap_init(&lacp->slaves);
203 list_push_back(&all_lacps, &lacp->node);
209 lacp_ref(const struct lacp *lacp_)
211 struct lacp *lacp = CONST_CAST(struct lacp *, lacp_);
213 ovs_assert(lacp->ref_cnt > 0);
219 /* Destroys 'lacp' and its slaves. Does nothing if 'lacp' is NULL. */
221 lacp_unref(struct lacp *lacp)
227 ovs_assert(lacp->ref_cnt > 0);
228 if (!--lacp->ref_cnt) {
229 struct slave *slave, *next;
231 HMAP_FOR_EACH_SAFE (slave, next, node, &lacp->slaves) {
232 slave_destroy(slave);
235 hmap_destroy(&lacp->slaves);
236 list_remove(&lacp->node);
242 /* Configures 'lacp' with settings from 's'. */
244 lacp_configure(struct lacp *lacp, const struct lacp_settings *s)
246 ovs_assert(!eth_addr_is_zero(s->id));
248 if (!lacp->name || strcmp(s->name, lacp->name)) {
250 lacp->name = xstrdup(s->name);
253 if (!eth_addr_equals(lacp->sys_id, s->id)
254 || lacp->sys_priority != s->priority) {
255 memcpy(lacp->sys_id, s->id, ETH_ADDR_LEN);
256 lacp->sys_priority = s->priority;
260 lacp->active = s->active;
261 lacp->fast = s->fast;
264 /* Returns true if 'lacp' is configured in active mode, false if 'lacp' is
265 * configured for passive mode. */
267 lacp_is_active(const struct lacp *lacp)
272 /* Processes 'packet' which was received on 'slave_'. This function should be
273 * called on all packets received on 'slave_' with Ethernet Type ETH_TYPE_LACP.
276 lacp_process_packet(struct lacp *lacp, const void *slave_,
277 const struct ofpbuf *packet)
279 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
280 struct slave *slave = slave_lookup(lacp, slave_);
281 const struct lacp_pdu *pdu;
282 long long int tx_rate;
288 pdu = parse_lacp_packet(packet);
290 VLOG_WARN_RL(&rl, "%s: received an unparsable LACP PDU.", lacp->name);
294 slave->status = LACP_CURRENT;
295 tx_rate = lacp->fast ? LACP_FAST_TIME_TX : LACP_SLOW_TIME_TX;
296 timer_set_duration(&slave->rx, LACP_RX_MULTIPLIER * tx_rate);
298 slave->ntt_actor = pdu->partner;
300 /* Update our information about our partner if it's out of date. This may
301 * cause priorities to change so re-calculate attached status of all
303 if (memcmp(&slave->partner, &pdu->actor, sizeof pdu->actor)) {
305 slave->partner = pdu->actor;
309 /* Returns the lacp_status of the given 'lacp' object (which may be NULL). */
311 lacp_status(const struct lacp *lacp)
314 return LACP_DISABLED;
315 } else if (lacp->negotiated) {
316 return LACP_NEGOTIATED;
318 return LACP_CONFIGURED;
322 /* Registers 'slave_' as subordinate to 'lacp'. This should be called at least
323 * once per slave in a LACP managed bond. Should also be called whenever a
324 * slave's settings change. */
326 lacp_slave_register(struct lacp *lacp, void *slave_,
327 const struct lacp_slave_settings *s)
329 struct slave *slave = slave_lookup(lacp, slave_);
332 slave = xzalloc(sizeof *slave);
335 hmap_insert(&lacp->slaves, &slave->node, hash_pointer(slave_, 0));
336 slave_set_defaulted(slave);
338 if (!lacp->key_slave) {
339 lacp->key_slave = slave;
343 if (!slave->name || strcmp(s->name, slave->name)) {
345 slave->name = xstrdup(s->name);
348 if (slave->port_id != s->id
349 || slave->port_priority != s->priority
350 || slave->key != s->key) {
351 slave->port_id = s->id;
352 slave->port_priority = s->priority;
357 if (lacp->active || lacp->negotiated) {
358 slave_set_expired(slave);
363 /* Unregisters 'slave_' with 'lacp'. */
365 lacp_slave_unregister(struct lacp *lacp, const void *slave_)
367 struct slave *slave = slave_lookup(lacp, slave_);
370 slave_destroy(slave);
375 /* This function should be called whenever the carrier status of 'slave_' has
376 * changed. If 'lacp' is null, this function has no effect.*/
378 lacp_slave_carrier_changed(const struct lacp *lacp, const void *slave_)
381 struct slave *slave = slave_lookup(lacp, slave_);
387 if (slave->status == LACP_CURRENT || slave->lacp->active) {
388 slave_set_expired(slave);
394 slave_may_enable__(struct slave *slave)
396 /* The slave may be enabled if it's attached to an aggregator and its
397 * partner is synchronized.*/
398 return slave->attached && (slave->partner.state & LACP_STATE_SYNC);
401 /* This function should be called before enabling 'slave_' to send or receive
402 * traffic. If it returns false, 'slave_' should not enabled. As a
403 * convenience, returns true if 'lacp' is NULL. */
405 lacp_slave_may_enable(const struct lacp *lacp, const void *slave_)
408 struct slave *slave = slave_lookup(lacp, slave_);
409 return slave ? slave_may_enable__(slave) : false;
415 /* Returns true if partner information on 'slave_' is up to date. 'slave_'
416 * not being current, generally indicates a connectivity problem, or a
417 * misconfigured (or broken) partner. */
419 lacp_slave_is_current(const struct lacp *lacp, const void *slave_)
421 struct slave *slave = slave_lookup(lacp, slave_);
422 return slave ? slave->status != LACP_DEFAULTED : false;
425 /* This function should be called periodically to update 'lacp'. */
427 lacp_run(struct lacp *lacp, lacp_send_pdu *send_pdu)
431 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
432 if (timer_expired(&slave->rx)) {
433 if (slave->status == LACP_CURRENT) {
434 slave_set_expired(slave);
435 } else if (slave->status == LACP_EXPIRED) {
436 slave_set_defaulted(slave);
442 lacp_update_attached(lacp);
445 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
446 struct lacp_info actor;
448 if (!slave_may_tx(slave)) {
452 slave_get_actor(slave, &actor);
454 if (timer_expired(&slave->tx)
455 || !info_tx_equal(&actor, &slave->ntt_actor)) {
456 long long int duration;
459 slave->ntt_actor = actor;
460 compose_lacp_pdu(&actor, &slave->partner, &pdu);
461 send_pdu(slave->aux, &pdu, sizeof pdu);
463 duration = (slave->partner.state & LACP_STATE_TIME
465 : LACP_SLOW_TIME_TX);
467 timer_set_duration(&slave->tx, duration);
472 /* Causes poll_block() to wake up when lacp_run() needs to be called again. */
474 lacp_wait(struct lacp *lacp)
478 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
479 if (slave_may_tx(slave)) {
480 timer_wait(&slave->tx);
483 if (slave->status != LACP_DEFAULTED) {
484 timer_wait(&slave->rx);
489 /* Static Helpers. */
491 /* Updates the attached status of all slaves controlled by 'lacp' and sets its
492 * negotiated parameter to true if any slaves are attachable. */
494 lacp_update_attached(struct lacp *lacp)
496 struct slave *lead, *slave;
497 struct lacp_info lead_pri;
498 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
500 lacp->update = false;
503 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
504 struct lacp_info pri;
506 slave->attached = false;
508 /* XXX: In the future allow users to configure the expected system ID.
509 * For now just special case loopback. */
510 if (eth_addr_equals(slave->partner.sys_id, slave->lacp->sys_id)) {
511 VLOG_WARN_RL(&rl, "slave %s: Loopback detected. Slave is "
512 "connected to its own bond", slave->name);
516 if (slave->status == LACP_DEFAULTED) {
520 slave->attached = true;
521 slave_get_priority(slave, &pri);
523 if (!lead || memcmp(&pri, &lead_pri, sizeof pri) < 0) {
529 lacp->negotiated = lead != NULL;
532 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
533 if (lead->partner.key != slave->partner.key
534 || !eth_addr_equals(lead->partner.sys_id,
535 slave->partner.sys_id)) {
536 slave->attached = false;
543 slave_destroy(struct slave *slave)
546 struct lacp *lacp = slave->lacp;
549 hmap_remove(&lacp->slaves, &slave->node);
551 if (lacp->key_slave == slave) {
552 struct hmap_node *slave_node = hmap_first(&lacp->slaves);
555 lacp->key_slave = CONTAINER_OF(slave_node, struct slave, node);
557 lacp->key_slave = NULL;
567 slave_set_defaulted(struct slave *slave)
569 memset(&slave->partner, 0, sizeof slave->partner);
571 slave->lacp->update = true;
572 slave->status = LACP_DEFAULTED;
576 slave_set_expired(struct slave *slave)
578 slave->status = LACP_EXPIRED;
579 slave->partner.state |= LACP_STATE_TIME;
580 slave->partner.state &= ~LACP_STATE_SYNC;
582 timer_set_duration(&slave->rx, LACP_RX_MULTIPLIER * LACP_FAST_TIME_TX);
586 slave_get_actor(struct slave *slave, struct lacp_info *actor)
588 struct lacp *lacp = slave->lacp;
593 state |= LACP_STATE_ACT;
597 state |= LACP_STATE_TIME;
600 if (slave->attached) {
601 state |= LACP_STATE_SYNC;
604 if (slave->status == LACP_DEFAULTED) {
605 state |= LACP_STATE_DEF;
608 if (slave->status == LACP_EXPIRED) {
609 state |= LACP_STATE_EXP;
612 if (hmap_count(&lacp->slaves) > 1) {
613 state |= LACP_STATE_AGG;
616 if (slave->attached || !lacp->negotiated) {
617 state |= LACP_STATE_COL | LACP_STATE_DIST;
620 key = lacp->key_slave->key;
622 key = lacp->key_slave->port_id;
625 actor->state = state;
626 actor->key = htons(key);
627 actor->port_priority = htons(slave->port_priority);
628 actor->port_id = htons(slave->port_id);
629 actor->sys_priority = htons(lacp->sys_priority);
630 memcpy(&actor->sys_id, lacp->sys_id, ETH_ADDR_LEN);
633 /* Given 'slave', populates 'priority' with data representing its LACP link
634 * priority. If two priority objects populated by this function are compared
635 * using memcmp, the higher priority link will be less than the lower priority
638 slave_get_priority(struct slave *slave, struct lacp_info *priority)
640 uint16_t partner_priority, actor_priority;
642 /* Choose the lacp_info of the higher priority system by comparing their
643 * system priorities and mac addresses. */
644 actor_priority = slave->lacp->sys_priority;
645 partner_priority = ntohs(slave->partner.sys_priority);
646 if (actor_priority < partner_priority) {
647 slave_get_actor(slave, priority);
648 } else if (partner_priority < actor_priority) {
649 *priority = slave->partner;
650 } else if (eth_addr_compare_3way(slave->lacp->sys_id,
651 slave->partner.sys_id) < 0) {
652 slave_get_actor(slave, priority);
654 *priority = slave->partner;
657 /* Key and state are not used in priority comparisons. */
663 slave_may_tx(const struct slave *slave)
665 return slave->lacp->active || slave->status != LACP_DEFAULTED;
668 static struct slave *
669 slave_lookup(const struct lacp *lacp, const void *slave_)
673 HMAP_FOR_EACH_IN_BUCKET (slave, node, hash_pointer(slave_, 0),
675 if (slave->aux == slave_) {
683 /* Two lacp_info structures are tx_equal if and only if they do not differ in
684 * ways which would require a lacp_pdu transmission. */
686 info_tx_equal(struct lacp_info *a, struct lacp_info *b)
689 /* LACP specification dictates that we transmit whenever the actor and
690 * remote_actor differ in the following fields: Port, Port Priority,
691 * System, System Priority, Aggregation Key, Activity State, Timeout State,
692 * Sync State, and Aggregation State. The state flags are most likely to
693 * change so are checked first. */
694 return !((a->state ^ b->state) & (LACP_STATE_ACT
698 && a->port_id == b->port_id
699 && a->port_priority == b->port_priority
701 && a->sys_priority == b->sys_priority
702 && eth_addr_equals(a->sys_id, b->sys_id);
706 lacp_find(const char *name)
710 LIST_FOR_EACH (lacp, node, &all_lacps) {
711 if (!strcmp(lacp->name, name)) {
720 ds_put_lacp_state(struct ds *ds, uint8_t state)
722 if (state & LACP_STATE_ACT) {
723 ds_put_cstr(ds, " activity");
726 if (state & LACP_STATE_TIME) {
727 ds_put_cstr(ds, " timeout");
730 if (state & LACP_STATE_AGG) {
731 ds_put_cstr(ds, " aggregation");
734 if (state & LACP_STATE_SYNC) {
735 ds_put_cstr(ds, " synchronized");
738 if (state & LACP_STATE_COL) {
739 ds_put_cstr(ds, " collecting");
742 if (state & LACP_STATE_DIST) {
743 ds_put_cstr(ds, " distributing");
746 if (state & LACP_STATE_DEF) {
747 ds_put_cstr(ds, " defaulted");
750 if (state & LACP_STATE_EXP) {
751 ds_put_cstr(ds, " expired");
756 lacp_print_details(struct ds *ds, struct lacp *lacp)
758 struct shash slave_shash = SHASH_INITIALIZER(&slave_shash);
759 const struct shash_node **sorted_slaves = NULL;
764 ds_put_format(ds, "---- %s ----\n", lacp->name);
765 ds_put_format(ds, "\tstatus: %s", lacp->active ? "active" : "passive");
766 if (lacp->negotiated) {
767 ds_put_cstr(ds, " negotiated");
769 ds_put_cstr(ds, "\n");
771 ds_put_format(ds, "\tsys_id: " ETH_ADDR_FMT "\n", ETH_ADDR_ARGS(lacp->sys_id));
772 ds_put_format(ds, "\tsys_priority: %u\n", lacp->sys_priority);
773 ds_put_cstr(ds, "\taggregation key: ");
774 if (lacp->key_slave) {
775 ds_put_format(ds, "%u", lacp->key_slave->key
776 ? lacp->key_slave->key
777 : lacp->key_slave->port_id);
779 ds_put_cstr(ds, "none");
781 ds_put_cstr(ds, "\n");
783 ds_put_cstr(ds, "\tlacp_time: ");
785 ds_put_cstr(ds, "fast\n");
787 ds_put_cstr(ds, "slow\n");
790 HMAP_FOR_EACH (slave, node, &lacp->slaves) {
791 shash_add(&slave_shash, slave->name, slave);
793 sorted_slaves = shash_sort(&slave_shash);
795 for (i = 0; i < shash_count(&slave_shash); i++) {
797 struct lacp_info actor;
799 slave = sorted_slaves[i]->data;
800 slave_get_actor(slave, &actor);
801 switch (slave->status) {
809 status = "defaulted";
815 ds_put_format(ds, "\nslave: %s: %s %s\n", slave->name, status,
816 slave->attached ? "attached" : "detached");
817 ds_put_format(ds, "\tport_id: %u\n", slave->port_id);
818 ds_put_format(ds, "\tport_priority: %u\n", slave->port_priority);
819 ds_put_format(ds, "\tmay_enable: %s\n", (slave_may_enable__(slave)
820 ? "true" : "false"));
822 ds_put_format(ds, "\n\tactor sys_id: " ETH_ADDR_FMT "\n",
823 ETH_ADDR_ARGS(actor.sys_id));
824 ds_put_format(ds, "\tactor sys_priority: %u\n",
825 ntohs(actor.sys_priority));
826 ds_put_format(ds, "\tactor port_id: %u\n",
827 ntohs(actor.port_id));
828 ds_put_format(ds, "\tactor port_priority: %u\n",
829 ntohs(actor.port_priority));
830 ds_put_format(ds, "\tactor key: %u\n",
832 ds_put_cstr(ds, "\tactor state:");
833 ds_put_lacp_state(ds, actor.state);
834 ds_put_cstr(ds, "\n\n");
836 ds_put_format(ds, "\tpartner sys_id: " ETH_ADDR_FMT "\n",
837 ETH_ADDR_ARGS(slave->partner.sys_id));
838 ds_put_format(ds, "\tpartner sys_priority: %u\n",
839 ntohs(slave->partner.sys_priority));
840 ds_put_format(ds, "\tpartner port_id: %u\n",
841 ntohs(slave->partner.port_id));
842 ds_put_format(ds, "\tpartner port_priority: %u\n",
843 ntohs(slave->partner.port_priority));
844 ds_put_format(ds, "\tpartner key: %u\n",
845 ntohs(slave->partner.key));
846 ds_put_cstr(ds, "\tpartner state:");
847 ds_put_lacp_state(ds, slave->partner.state);
848 ds_put_cstr(ds, "\n");
851 shash_destroy(&slave_shash);
856 lacp_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
857 void *aux OVS_UNUSED)
859 struct ds ds = DS_EMPTY_INITIALIZER;
863 lacp = lacp_find(argv[1]);
865 unixctl_command_reply_error(conn, "no such lacp object");
868 lacp_print_details(&ds, lacp);
870 LIST_FOR_EACH (lacp, node, &all_lacps) {
871 lacp_print_details(&ds, lacp);
875 unixctl_command_reply(conn, ds_cstr(&ds));