lib/lacp.c

   1 /* Copyright (c) 2011 Nicira, Inc.
   2  *
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #include <config.h>
  17 #include "lacp.h"
  18
  19 #include <assert.h>
  20 #include <stdlib.h>
  21
  22 #include "dynamic-string.h"
  23 #include "hash.h"
  24 #include "hmap.h"
  25 #include "ofpbuf.h"
  26 #include "packets.h"
  27 #include "poll-loop.h"
  28 #include "shash.h"
  29 #include "timer.h"
  30 #include "timeval.h"
  31 #include "unixctl.h"
  32 #include "vlog.h"
  33
  34 VLOG_DEFINE_THIS_MODULE(lacp);
  35
  36 /* Masks for lacp_info state member. */
  37 #define LACP_STATE_ACT  0x01 /* Activity. Active or passive? */
  38 #define LACP_STATE_TIME 0x02 /* Timeout. Short or long timeout? */
  39 #define LACP_STATE_AGG  0x04 /* Aggregation. Is the link is bondable? */
  40 #define LACP_STATE_SYNC 0x08 /* Synchronization. Is the link in up to date? */
  41 #define LACP_STATE_COL  0x10 /* Collecting. Is the link receiving frames? */
  42 #define LACP_STATE_DIST 0x20 /* Distributing. Is the link sending frames? */
  43 #define LACP_STATE_DEF  0x40 /* Defaulted. Using default partner info? */
  44 #define LACP_STATE_EXP  0x80 /* Expired. Using expired partner info? */
  45
  46 #define LACP_FAST_TIME_TX 1000  /* Fast transmission rate. */
  47 #define LACP_SLOW_TIME_TX 30000 /* Slow transmission rate. */
  48 #define LACP_RX_MULTIPLIER 3    /* Multiply by TX rate to get RX rate. */
  49
  50 #define LACP_INFO_LEN 15
  51 struct lacp_info {
  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. */
  58 } __attribute__((packed));
  59 BUILD_ASSERT_DECL(LACP_INFO_LEN == sizeof(struct lacp_info));
  60
  61 #define LACP_PDU_LEN 110
  62 struct lacp_pdu {
  63     uint8_t subtype;          /* Always 1. */
  64     uint8_t version;          /* Always 1. */
  65
  66     uint8_t actor_type;       /* Always 1. */
  67     uint8_t actor_len;        /* Always 20. */
  68     struct lacp_info actor;   /* LACP actor information. */
  69     uint8_t z1[3];            /* Reserved.  Always 0. */
  70
  71     uint8_t partner_type;     /* Always 2. */
  72     uint8_t partner_len;      /* Always 20. */
  73     struct lacp_info partner; /* LACP partner information. */
  74     uint8_t z2[3];            /* Reserved.  Always 0. */
  75
  76     uint8_t collector_type;   /* Always 3. */
  77     uint8_t collector_len;    /* Always 16. */
  78     ovs_be16 collector_delay; /* Maximum collector delay. Set to UINT16_MAX. */
  79     uint8_t z3[64];           /* Combination of several fields.  Always 0. */
  80 } __attribute__((packed));
  81 BUILD_ASSERT_DECL(LACP_PDU_LEN == sizeof(struct lacp_pdu));
  82 \f
  83 /* Implementation. */
  84
  85 enum slave_status {
  86     LACP_CURRENT,   /* Current State.  Partner up to date. */
  87     LACP_EXPIRED,   /* Expired State.  Partner out of date. */
  88     LACP_DEFAULTED, /* Defaulted State.  No partner. */
  89 };
  90
  91 struct lacp {
  92     struct list node;             /* Node in all_lacps list. */
  93     char *name;                   /* Name of this lacp object. */
  94     uint8_t sys_id[ETH_ADDR_LEN]; /* System ID. */
  95     uint16_t sys_priority;        /* System Priority. */
  96     bool active;                  /* Active or Passive. */
  97
  98     struct hmap slaves;      /* Slaves this LACP object controls. */
  99     struct slave *key_slave; /* Slave whose ID will be the aggregation key. */
 100
 101     bool fast;               /* True if using fast probe interval. */
 102     bool negotiated;         /* True if LACP negotiations were successful. */
 103     bool update;             /* True if lacp_update() needs to be called. */
 104 };
 105
 106 struct slave {
 107     void *aux;                    /* Handle used to identify this slave. */
 108     struct hmap_node node;        /* Node in master's slaves map. */
 109
 110     struct lacp *lacp;            /* LACP object containing this slave. */
 111     uint16_t port_id;             /* Port ID. */
 112     uint16_t port_priority;       /* Port Priority. */
 113     uint16_t key;                 /* Aggregation Key. 0 if default. */
 114     char *name;                   /* Name of this slave. */
 115
 116     enum slave_status status;     /* Slave status. */
 117     bool attached;                /* Attached. Traffic may flow. */
 118     struct lacp_info partner;     /* Partner information. */
 119     struct lacp_info ntt_actor;   /* Used to decide if we Need To Transmit. */
 120     struct timer tx;              /* Next message transmission timer. */
 121     struct timer rx;              /* Expected message receive timer. */
 122 };
 123
 124 static struct list all_lacps = LIST_INITIALIZER(&all_lacps);
 125
 126 static void lacp_update_attached(struct lacp *);
 127
 128 static void slave_destroy(struct slave *);
 129 static void slave_set_defaulted(struct slave *);
 130 static void slave_set_expired(struct slave *);
 131 static void slave_get_actor(struct slave *, struct lacp_info *actor);
 132 static void slave_get_priority(struct slave *, struct lacp_info *priority);
 133 static bool slave_may_tx(const struct slave *);
 134 static struct slave *slave_lookup(const struct lacp *, const void *slave);
 135 static bool info_tx_equal(struct lacp_info *, struct lacp_info *);
 136
 137 static unixctl_cb_func lacp_unixctl_show;
 138
 139 /* Populates 'pdu' with a LACP PDU comprised of 'actor' and 'partner'. */
 140 static void
 141 compose_lacp_pdu(const struct lacp_info *actor,
 142                  const struct lacp_info *partner, struct lacp_pdu *pdu)
 143 {
 144     memset(pdu, 0, sizeof *pdu);
 145
 146     pdu->subtype = 1;
 147     pdu->version = 1;
 148
 149     pdu->actor_type = 1;
 150     pdu->actor_len = 20;
 151     pdu->actor = *actor;
 152
 153     pdu->partner_type = 2;
 154     pdu->partner_len = 20;
 155     pdu->partner = *partner;
 156
 157     pdu->collector_type = 3;
 158     pdu->collector_len = 16;
 159     pdu->collector_delay = htons(0);
 160 }
 161
 162 /* Parses 'b' which represents a packet containing a LACP PDU.  This function
 163  * returns NULL if 'b' is malformed, or does not represent a LACP PDU format
 164  * supported by OVS.  Otherwise, it returns a pointer to the lacp_pdu contained
 165  * within 'b'. */
 166 static const struct lacp_pdu *
 167 parse_lacp_packet(const struct ofpbuf *b)
 168 {
 169     const struct lacp_pdu *pdu;
 170
 171     pdu = ofpbuf_at(b, (uint8_t *)b->l3 - (uint8_t *)b->data, LACP_PDU_LEN);
 172
 173     if (pdu && pdu->subtype == 1
 174         && pdu->actor_type == 1 && pdu->actor_len == 20
 175         && pdu->partner_type == 2 && pdu->partner_len == 20) {
 176         return pdu;
 177     } else {
 178         return NULL;
 179     }
 180 }
 181 \f
 182 /* LACP Protocol Implementation. */
 183
 184 /* Initializes the lacp module. */
 185 void
 186 lacp_init(void)
 187 {
 188     unixctl_command_register("lacp/show", "[port]", 0, 1,
 189                              lacp_unixctl_show, NULL);
 190 }
 191
 192 /* Creates a LACP object. */
 193 struct lacp *
 194 lacp_create(void)
 195 {
 196     struct lacp *lacp;
 197
 198     lacp = xzalloc(sizeof *lacp);
 199     hmap_init(&lacp->slaves);
 200     list_push_back(&all_lacps, &lacp->node);
 201     return lacp;
 202 }
 203
 204 /* Destroys 'lacp' and its slaves. Does nothing if 'lacp' is NULL. */
 205 void
 206 lacp_destroy(struct lacp *lacp)
 207 {
 208     if (lacp) {
 209         struct slave *slave, *next;
 210
 211         HMAP_FOR_EACH_SAFE (slave, next, node, &lacp->slaves) {
 212             slave_destroy(slave);
 213         }
 214
 215         hmap_destroy(&lacp->slaves);
 216         list_remove(&lacp->node);
 217         free(lacp->name);
 218         free(lacp);
 219     }
 220 }
 221
 222 /* Configures 'lacp' with settings from 's'. */
 223 void
 224 lacp_configure(struct lacp *lacp, const struct lacp_settings *s)
 225 {
 226     assert(!eth_addr_is_zero(s->id));
 227
 228     if (!lacp->name || strcmp(s->name, lacp->name)) {
 229         free(lacp->name);
 230         lacp->name = xstrdup(s->name);
 231     }
 232
 233     if (!eth_addr_equals(lacp->sys_id, s->id)
 234         || lacp->sys_priority != s->priority) {
 235         memcpy(lacp->sys_id, s->id, ETH_ADDR_LEN);
 236         lacp->sys_priority = s->priority;
 237         lacp->update = true;
 238     }
 239
 240     lacp->active = s->active;
 241     lacp->fast = s->fast;
 242 }
 243
 244 /* Returns true if 'lacp' is configured in active mode, false if 'lacp' is
 245  * configured for passive mode. */
 246 bool
 247 lacp_is_active(const struct lacp *lacp)
 248 {
 249     return lacp->active;
 250 }
 251
 252 /* Processes 'packet' which was received on 'slave_'.  This function should be
 253  * called on all packets received on 'slave_' with Ethernet Type ETH_TYPE_LACP.
 254  */
 255 void
 256 lacp_process_packet(struct lacp *lacp, const void *slave_,
 257                     const struct ofpbuf *packet)
 258 {
 259     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 260     struct slave *slave = slave_lookup(lacp, slave_);
 261     const struct lacp_pdu *pdu;
 262     long long int tx_rate;
 263
 264     pdu = parse_lacp_packet(packet);
 265     if (!pdu) {
 266         VLOG_WARN_RL(&rl, "%s: received an unparsable LACP PDU.", lacp->name);
 267         return;
 268     }
 269
 270     slave->status = LACP_CURRENT;
 271     tx_rate = lacp->fast ? LACP_FAST_TIME_TX : LACP_SLOW_TIME_TX;
 272     timer_set_duration(&slave->rx, LACP_RX_MULTIPLIER * tx_rate);
 273
 274     slave->ntt_actor = pdu->partner;
 275
 276     /* Update our information about our partner if it's out of date.  This may
 277      * cause priorities to change so re-calculate attached status of all
 278      * slaves.  */
 279     if (memcmp(&slave->partner, &pdu->actor, sizeof pdu->actor)) {
 280         lacp->update = true;
 281         slave->partner = pdu->actor;
 282     }
 283 }
 284
 285 /* Returns the lacp_status of the given 'lacp' object (which may be NULL). */
 286 enum lacp_status
 287 lacp_status(const struct lacp *lacp)
 288 {
 289     if (!lacp) {
 290         return LACP_DISABLED;
 291     } else if (lacp->negotiated) {
 292         return LACP_NEGOTIATED;
 293     } else {
 294         return LACP_CONFIGURED;
 295     }
 296 }
 297
 298 /* Registers 'slave_' as subordinate to 'lacp'.  This should be called at least
 299  * once per slave in a LACP managed bond.  Should also be called whenever a
 300  * slave's settings change. */
 301 void
 302 lacp_slave_register(struct lacp *lacp, void *slave_,
 303                     const struct lacp_slave_settings *s)
 304 {
 305     struct slave *slave = slave_lookup(lacp, slave_);
 306
 307     if (!slave) {
 308         slave = xzalloc(sizeof *slave);
 309         slave->lacp = lacp;
 310         slave->aux = slave_;
 311         hmap_insert(&lacp->slaves, &slave->node, hash_pointer(slave_, 0));
 312         slave_set_defaulted(slave);
 313
 314         if (!lacp->key_slave) {
 315             lacp->key_slave = slave;
 316         }
 317     }
 318
 319     if (!slave->name || strcmp(s->name, slave->name)) {
 320         free(slave->name);
 321         slave->name = xstrdup(s->name);
 322     }
 323
 324     if (slave->port_id != s->id
 325         || slave->port_priority != s->priority
 326         || slave->key != s->key) {
 327         slave->port_id = s->id;
 328         slave->port_priority = s->priority;
 329         slave->key = s->key;
 330
 331         lacp->update = true;
 332
 333         if (lacp->active || lacp->negotiated) {
 334             slave_set_expired(slave);
 335         }
 336     }
 337 }
 338
 339 /* Unregisters 'slave_' with 'lacp'.  */
 340 void
 341 lacp_slave_unregister(struct lacp *lacp, const void *slave_)
 342 {
 343     struct slave *slave = slave_lookup(lacp, slave_);
 344
 345     if (slave) {
 346         slave_destroy(slave);
 347         lacp->update = true;
 348     }
 349 }
 350
 351 /* This function should be called whenever the carrier status of 'slave_' has
 352  * changed.  If 'lacp' is null, this function has no effect.*/
 353 void
 354 lacp_slave_carrier_changed(const struct lacp *lacp, const void *slave_)
 355 {
 356     if (lacp) {
 357         struct slave *slave = slave_lookup(lacp, slave_);
 358
 359         if (slave->status == LACP_CURRENT || slave->lacp->active) {
 360             slave_set_expired(slave);
 361         }
 362     }
 363 }
 364
 365 /* This function should be called before enabling 'slave_' to send or receive
 366  * traffic.  If it returns false, 'slave_' should not enabled.  As a
 367  * convenience, returns true if 'lacp' is NULL. */
 368 bool
 369 lacp_slave_may_enable(const struct lacp *lacp, const void *slave_)
 370 {
 371     if (lacp) {
 372         struct slave *slave = slave_lookup(lacp, slave_);
 373
 374         /* The slave may be enabled if it's attached to an aggregator and its
 375          * partner is synchronized.*/
 376         return slave->attached && (slave->partner.state & LACP_STATE_SYNC);
 377     } else {
 378         return true;
 379     }
 380 }
 381
 382 /* Returns the port ID used for 'slave_' in LACP communications. */
 383 uint16_t
 384 lacp_slave_get_port_id(const struct lacp *lacp, const void *slave_)
 385 {
 386     struct slave *slave = slave_lookup(lacp, slave_);
 387     return slave->port_id;
 388 }
 389
 390 /* Returns true if partner information on 'slave_' is up to date.  'slave_'
 391  * not being current, generally indicates a connectivity problem, or a
 392  * misconfigured (or broken) partner. */
 393 bool
 394 lacp_slave_is_current(const struct lacp *lacp, const void *slave_)
 395 {
 396     return slave_lookup(lacp, slave_)->status != LACP_DEFAULTED;
 397 }
 398
 399 /* This function should be called periodically to update 'lacp'. */
 400 void
 401 lacp_run(struct lacp *lacp, lacp_send_pdu *send_pdu)
 402 {
 403     struct slave *slave;
 404
 405     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
 406         if (timer_expired(&slave->rx)) {
 407             if (slave->status == LACP_CURRENT) {
 408                 slave_set_expired(slave);
 409             } else if (slave->status == LACP_EXPIRED) {
 410                 slave_set_defaulted(slave);
 411             }
 412         }
 413     }
 414
 415     if (lacp->update) {
 416         lacp_update_attached(lacp);
 417     }
 418
 419     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
 420         struct lacp_info actor;
 421
 422         if (!slave_may_tx(slave)) {
 423             continue;
 424         }
 425
 426         slave_get_actor(slave, &actor);
 427
 428         if (timer_expired(&slave->tx)
 429             || !info_tx_equal(&actor, &slave->ntt_actor)) {
 430             long long int duration;
 431             struct lacp_pdu pdu;
 432
 433             slave->ntt_actor = actor;
 434             compose_lacp_pdu(&actor, &slave->partner, &pdu);
 435             send_pdu(slave->aux, &pdu, sizeof pdu);
 436
 437             duration = (slave->partner.state & LACP_STATE_TIME
 438                         ? LACP_FAST_TIME_TX
 439                         : LACP_SLOW_TIME_TX);
 440
 441             timer_set_duration(&slave->tx, duration);
 442         }
 443     }
 444 }
 445
 446 /* Causes poll_block() to wake up when lacp_run() needs to be called again. */
 447 void
 448 lacp_wait(struct lacp *lacp)
 449 {
 450     struct slave *slave;
 451
 452     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
 453         if (slave_may_tx(slave)) {
 454             timer_wait(&slave->tx);
 455         }
 456
 457         if (slave->status != LACP_DEFAULTED) {
 458             timer_wait(&slave->rx);
 459         }
 460     }
 461 }
 462 \f
 463 /* Static Helpers. */
 464
 465 /* Updates the attached status of all slaves controlled by 'lacp' and sets its
 466  * negotiated parameter to true if any slaves are attachable. */
 467 static void
 468 lacp_update_attached(struct lacp *lacp)
 469 {
 470     struct slave *lead, *slave;
 471     struct lacp_info lead_pri;
 472     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
 473
 474     lacp->update = false;
 475
 476     lead = NULL;
 477     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
 478         struct lacp_info pri;
 479
 480         slave->attached = false;
 481
 482         /* XXX: In the future allow users to configure the expected system ID.
 483          * For now just special case loopback. */
 484         if (eth_addr_equals(slave->partner.sys_id, slave->lacp->sys_id)) {
 485             VLOG_WARN_RL(&rl, "slave %s: Loopback detected. Slave is "
 486                          "connected to its own bond", slave->name);
 487             continue;
 488         }
 489
 490         if (slave->status == LACP_DEFAULTED) {
 491             continue;
 492         }
 493
 494         slave->attached = true;
 495         slave_get_priority(slave, &pri);
 496
 497         if (!lead || memcmp(&pri, &lead_pri, sizeof pri) < 0) {
 498             lead = slave;
 499             lead_pri = pri;
 500         }
 501     }
 502
 503     lacp->negotiated = lead != NULL;
 504
 505     if (lead) {
 506         HMAP_FOR_EACH (slave, node, &lacp->slaves) {
 507             if (lead->partner.key != slave->partner.key
 508                 || !eth_addr_equals(lead->partner.sys_id,
 509                                     slave->partner.sys_id)) {
 510                 slave->attached = false;
 511             }
 512         }
 513     }
 514 }
 515
 516 static void
 517 slave_destroy(struct slave *slave)
 518 {
 519     if (slave) {
 520         struct lacp *lacp = slave->lacp;
 521
 522         lacp->update = true;
 523         hmap_remove(&lacp->slaves, &slave->node);
 524
 525         if (lacp->key_slave == slave) {
 526             struct hmap_node *slave_node = hmap_first(&lacp->slaves);
 527
 528             if (slave_node) {
 529                 lacp->key_slave = CONTAINER_OF(slave_node, struct slave, node);
 530             } else {
 531                 lacp->key_slave = NULL;
 532             }
 533         }
 534
 535         free(slave->name);
 536         free(slave);
 537     }
 538 }
 539
 540 static void
 541 slave_set_defaulted(struct slave *slave)
 542 {
 543     memset(&slave->partner, 0, sizeof slave->partner);
 544
 545     slave->lacp->update = true;
 546     slave->status = LACP_DEFAULTED;
 547 }
 548
 549 static void
 550 slave_set_expired(struct slave *slave)
 551 {
 552     slave->status = LACP_EXPIRED;
 553     slave->partner.state |= LACP_STATE_TIME;
 554     slave->partner.state &= ~LACP_STATE_SYNC;
 555
 556     timer_set_duration(&slave->rx, LACP_RX_MULTIPLIER * LACP_FAST_TIME_TX);
 557 }
 558
 559 static void
 560 slave_get_actor(struct slave *slave, struct lacp_info *actor)
 561 {
 562     struct lacp *lacp = slave->lacp;
 563     uint16_t key;
 564     uint8_t state = 0;
 565
 566     if (lacp->active) {
 567         state |= LACP_STATE_ACT;
 568     }
 569
 570     if (lacp->fast) {
 571         state |= LACP_STATE_TIME;
 572     }
 573
 574     if (slave->attached) {
 575         state |= LACP_STATE_SYNC;
 576     }
 577
 578     if (slave->status == LACP_DEFAULTED) {
 579         state |= LACP_STATE_DEF;
 580     }
 581
 582     if (slave->status == LACP_EXPIRED) {
 583         state |= LACP_STATE_EXP;
 584     }
 585
 586     if (hmap_count(&lacp->slaves) > 1) {
 587         state |= LACP_STATE_AGG;
 588     }
 589
 590     if (slave->attached || !lacp->negotiated) {
 591         state |= LACP_STATE_COL | LACP_STATE_DIST;
 592     }
 593
 594     key = lacp->key_slave->key;
 595     if (!key) {
 596         key = lacp->key_slave->port_id;
 597     }
 598
 599     actor->state = state;
 600     actor->key = htons(key);
 601     actor->port_priority = htons(slave->port_priority);
 602     actor->port_id = htons(slave->port_id);
 603     actor->sys_priority = htons(lacp->sys_priority);
 604     memcpy(&actor->sys_id, lacp->sys_id, ETH_ADDR_LEN);
 605 }
 606
 607 /* Given 'slave', populates 'priority' with data representing its LACP link
 608  * priority.  If two priority objects populated by this function are compared
 609  * using memcmp, the higher priority link will be less than the lower priority
 610  * link. */
 611 static void
 612 slave_get_priority(struct slave *slave, struct lacp_info *priority)
 613 {
 614     uint16_t partner_priority, actor_priority;
 615
 616     /* Choose the lacp_info of the higher priority system by comparing their
 617      * system priorities and mac addresses. */
 618     actor_priority = slave->lacp->sys_priority;
 619     partner_priority = ntohs(slave->partner.sys_priority);
 620     if (actor_priority < partner_priority) {
 621         slave_get_actor(slave, priority);
 622     } else if (partner_priority < actor_priority) {
 623         *priority = slave->partner;
 624     } else if (eth_addr_compare_3way(slave->lacp->sys_id,
 625                                      slave->partner.sys_id) < 0) {
 626         slave_get_actor(slave, priority);
 627     } else {
 628         *priority = slave->partner;
 629     }
 630
 631     /* Key and state are not used in priority comparisons. */
 632     priority->key = 0;
 633     priority->state = 0;
 634 }
 635
 636 static bool
 637 slave_may_tx(const struct slave *slave)
 638 {
 639     return slave->lacp->active || slave->status != LACP_DEFAULTED;
 640 }
 641
 642 static struct slave *
 643 slave_lookup(const struct lacp *lacp, const void *slave_)
 644 {
 645     struct slave *slave;
 646
 647     HMAP_FOR_EACH_IN_BUCKET (slave, node, hash_pointer(slave_, 0),
 648                              &lacp->slaves) {
 649         if (slave->aux == slave_) {
 650             return slave;
 651         }
 652     }
 653
 654     return NULL;
 655 }
 656
 657 /* Two lacp_info structures are tx_equal if and only if they do not differ in
 658  * ways which would require a lacp_pdu transmission. */
 659 static bool
 660 info_tx_equal(struct lacp_info *a, struct lacp_info *b)
 661 {
 662
 663     /* LACP specification dictates that we transmit whenever the actor and
 664      * remote_actor differ in the following fields: Port, Port Priority,
 665      * System, System Priority, Aggregation Key, Activity State, Timeout State,
 666      * Sync State, and Aggregation State. The state flags are most likely to
 667      * change so are checked first. */
 668     return !((a->state ^ b->state) & (LACP_STATE_ACT
 669                                       | LACP_STATE_TIME
 670                                       | LACP_STATE_SYNC
 671                                       | LACP_STATE_AGG))
 672         && a->port_id == b->port_id
 673         && a->port_priority == b->port_priority
 674         && a->key == b->key
 675         && a->sys_priority == b->sys_priority
 676         && eth_addr_equals(a->sys_id, b->sys_id);
 677 }
 678 \f
 679 static struct lacp *
 680 lacp_find(const char *name)
 681 {
 682     struct lacp *lacp;
 683
 684     LIST_FOR_EACH (lacp, node, &all_lacps) {
 685         if (!strcmp(lacp->name, name)) {
 686             return lacp;
 687         }
 688     }
 689
 690     return NULL;
 691 }
 692
 693 static void
 694 ds_put_lacp_state(struct ds *ds, uint8_t state)
 695 {
 696     if (state & LACP_STATE_ACT) {
 697         ds_put_cstr(ds, " activity");
 698     }
 699
 700     if (state & LACP_STATE_TIME) {
 701         ds_put_cstr(ds, " timeout");
 702     }
 703
 704     if (state & LACP_STATE_AGG) {
 705         ds_put_cstr(ds, " aggregation");
 706     }
 707
 708     if (state & LACP_STATE_SYNC) {
 709         ds_put_cstr(ds, " synchronized");
 710     }
 711
 712     if (state & LACP_STATE_COL) {
 713         ds_put_cstr(ds, " collecting");
 714     }
 715
 716     if (state & LACP_STATE_DIST) {
 717         ds_put_cstr(ds, " distributing");
 718     }
 719
 720     if (state & LACP_STATE_DEF) {
 721         ds_put_cstr(ds, " defaulted");
 722     }
 723
 724     if (state & LACP_STATE_EXP) {
 725         ds_put_cstr(ds, " expired");
 726     }
 727 }
 728
 729 static void
 730 lacp_print_details(struct ds *ds, struct lacp *lacp)
 731 {
 732     struct shash slave_shash = SHASH_INITIALIZER(&slave_shash);
 733     const struct shash_node **sorted_slaves = NULL;
 734
 735     struct slave *slave;
 736     int i;
 737
 738     ds_put_format(ds, "---- %s ----\n", lacp->name);
 739     ds_put_format(ds, "\tstatus: %s", lacp->active ? "active" : "passive");
 740     if (lacp->negotiated) {
 741         ds_put_cstr(ds, " negotiated");
 742     }
 743     ds_put_cstr(ds, "\n");
 744
 745     ds_put_format(ds, "\tsys_id: " ETH_ADDR_FMT "\n", ETH_ADDR_ARGS(lacp->sys_id));
 746     ds_put_format(ds, "\tsys_priority: %u\n", lacp->sys_priority);
 747     ds_put_cstr(ds, "\taggregation key: ");
 748     if (lacp->key_slave) {
 749         ds_put_format(ds, "%u", lacp->key_slave->port_id);
 750     } else {
 751         ds_put_cstr(ds, "none");
 752     }
 753     ds_put_cstr(ds, "\n");
 754
 755     ds_put_cstr(ds, "\tlacp_time: ");
 756     if (lacp->fast) {
 757         ds_put_cstr(ds, "fast\n");
 758     } else {
 759         ds_put_cstr(ds, "slow\n");
 760     }
 761
 762     HMAP_FOR_EACH (slave, node, &lacp->slaves) {
 763         shash_add(&slave_shash, slave->name, slave);
 764     }
 765     sorted_slaves = shash_sort(&slave_shash);
 766
 767     for (i = 0; i < shash_count(&slave_shash); i++) {
 768         char *status;
 769         struct lacp_info actor;
 770
 771         slave = sorted_slaves[i]->data;
 772         slave_get_actor(slave, &actor);
 773         switch (slave->status) {
 774         case LACP_CURRENT:
 775             status = "current";
 776             break;
 777         case LACP_EXPIRED:
 778             status = "expired";
 779             break;
 780         case LACP_DEFAULTED:
 781             status = "defaulted";
 782             break;
 783         default:
 784             NOT_REACHED();
 785         }
 786
 787         ds_put_format(ds, "\nslave: %s: %s %s\n", slave->name, status,
 788                       slave->attached ? "attached" : "detached");
 789         ds_put_format(ds, "\tport_id: %u\n", slave->port_id);
 790         ds_put_format(ds, "\tport_priority: %u\n", slave->port_priority);
 791
 792         ds_put_format(ds, "\n\tactor sys_id: " ETH_ADDR_FMT "\n",
 793                       ETH_ADDR_ARGS(actor.sys_id));
 794         ds_put_format(ds, "\tactor sys_priority: %u\n",
 795                       ntohs(actor.sys_priority));
 796         ds_put_format(ds, "\tactor port_id: %u\n",
 797                       ntohs(actor.port_id));
 798         ds_put_format(ds, "\tactor port_priority: %u\n",
 799                       ntohs(actor.port_priority));
 800         ds_put_format(ds, "\tactor key: %u\n",
 801                       ntohs(actor.key));
 802         ds_put_cstr(ds, "\tactor state:");
 803         ds_put_lacp_state(ds, actor.state);
 804         ds_put_cstr(ds, "\n\n");
 805
 806         ds_put_format(ds, "\tpartner sys_id: " ETH_ADDR_FMT "\n",
 807                       ETH_ADDR_ARGS(slave->partner.sys_id));
 808         ds_put_format(ds, "\tpartner sys_priority: %u\n",
 809                       ntohs(slave->partner.sys_priority));
 810         ds_put_format(ds, "\tpartner port_id: %u\n",
 811                       ntohs(slave->partner.port_id));
 812         ds_put_format(ds, "\tpartner port_priority: %u\n",
 813                       ntohs(slave->partner.port_priority));
 814         ds_put_format(ds, "\tpartner key: %u\n",
 815                       ntohs(slave->partner.key));
 816         ds_put_cstr(ds, "\tpartner state:");
 817         ds_put_lacp_state(ds, slave->partner.state);
 818         ds_put_cstr(ds, "\n");
 819     }
 820
 821     shash_destroy(&slave_shash);
 822     free(sorted_slaves);
 823 }
 824
 825 static void
 826 lacp_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
 827                   void *aux OVS_UNUSED)
 828 {
 829     struct ds ds = DS_EMPTY_INITIALIZER;
 830     struct lacp *lacp;
 831
 832     if (argc > 1) {
 833         lacp = lacp_find(argv[1]);
 834         if (!lacp) {
 835             unixctl_command_reply_error(conn, "no such lacp object");
 836             return;
 837         }
 838         lacp_print_details(&ds, lacp);
 839     } else {
 840         LIST_FOR_EACH (lacp, node, &all_lacps) {
 841             lacp_print_details(&ds, lacp);
 842         }
 843     }
 844
 845     unixctl_command_reply(conn, ds_cstr(&ds));
 846     ds_destroy(&ds);
 847 }