lib/stp.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 /* Based on sample implementation in 802.1D-1998.  Above copyright and license
  35  * applies to all modifications. */
  36
  37 #include "stp.h"
  38 #include <arpa/inet.h>
  39 #include <assert.h>
  40 #include <inttypes.h>
  41 #include <stdlib.h>
  42 #include "packets.h"
  43 #include "util.h"
  44 #include "xtoxll.h"
  45
  46 #include "vlog.h"
  47 #define THIS_MODULE VLM_stp
  48
  49 /* Ethernet address used as the destination for STP frames. */
  50 const uint8_t stp_eth_addr[ETH_ADDR_LEN]
  51 = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x01 };
  52
  53 #define STP_PROTOCOL_ID 0x0000
  54 #define STP_PROTOCOL_VERSION 0x00
  55 #define STP_TYPE_CONFIG 0x00
  56 #define STP_TYPE_TCN 0x80
  57
  58 struct stp_bpdu_header {
  59     uint16_t protocol_id;       /* STP_PROTOCOL_ID. */
  60     uint8_t protocol_version;   /* STP_PROTOCOL_VERSION. */
  61     uint8_t bpdu_type;          /* One of STP_TYPE_*. */
  62 } __attribute__((packed));
  63 BUILD_ASSERT_DECL(sizeof(struct stp_bpdu_header) == 4);
  64
  65 enum stp_config_bpdu_flags {
  66     STP_CONFIG_TOPOLOGY_CHANGE_ACK = 0x80,
  67     STP_CONFIG_TOPOLOGY_CHANGE = 0x01
  68 };
  69
  70 struct stp_config_bpdu {
  71     struct stp_bpdu_header header; /* Type STP_TYPE_CONFIG. */
  72     uint8_t flags;                 /* STP_CONFIG_* flags. */
  73     uint64_t root_id;              /* 8.5.1.1: Bridge believed to be root. */
  74     uint32_t root_path_cost;       /* 8.5.1.2: Cost of path to root. */
  75     uint64_t bridge_id;            /* 8.5.1.3: ID of transmitting bridge. */
  76     uint16_t port_id;              /* 8.5.1.4: Port transmitting the BPDU. */
  77     uint16_t message_age;          /* 8.5.1.5: Age of BPDU at tx time. */
  78     uint16_t max_age;              /* 8.5.1.6: Timeout for received data. */
  79     uint16_t hello_time;           /* 8.5.1.7: Time between BPDU generation. */
  80     uint16_t forward_delay;        /* 8.5.1.8: State progression delay. */
  81 } __attribute__((packed));
  82 BUILD_ASSERT_DECL(sizeof(struct stp_config_bpdu) == 35);
  83
  84 struct stp_tcn_bpdu {
  85     struct stp_bpdu_header header; /* Type STP_TYPE_TCN. */
  86 } __attribute__((packed));
  87 BUILD_ASSERT_DECL(sizeof(struct stp_tcn_bpdu) == 4);
  88
  89 struct stp_timer {
  90     bool active;                 /* Timer in use? */
  91     int value;                   /* Current value of timer, counting up. */
  92 };
  93
  94 struct stp_port {
  95     struct stp *stp;
  96     int port_id;                    /* 8.5.5.1: Unique port identifier. */
  97     enum stp_state state;           /* 8.5.5.2: Current state. */
  98     int path_cost;                  /* 8.5.5.3: Cost of tx/rx on this port. */
  99     stp_identifier designated_root; /* 8.5.5.4. */
 100     int designated_cost;            /* 8.5.5.5: Path cost to root on port. */
 101     stp_identifier designated_bridge; /* 8.5.5.6. */
 102     int designated_port;            /* 8.5.5.7: Port to send config msgs on. */
 103     bool topology_change_ack;       /* 8.5.5.8: Flag for next config BPDU. */
 104     bool config_pending;            /* 8.5.5.9: Send BPDU when hold expires? */
 105     bool change_detection_enabled;  /* 8.5.5.10: Detect topology changes? */
 106
 107     struct stp_timer message_age_timer; /* 8.5.6.1: Age of received info. */
 108     struct stp_timer forward_delay_timer; /* 8.5.6.2: State change timer. */
 109     struct stp_timer hold_timer;        /* 8.5.6.3: BPDU rate limit timer. */
 110
 111     bool state_changed;
 112 };
 113
 114 struct stp {
 115     /* Static bridge data. */
 116     char *name;                     /* Human-readable name for log messages. */
 117     stp_identifier bridge_id;       /* 8.5.3.7: This bridge. */
 118     int max_age;                    /* 8.5.3.4: Time to drop received data. */
 119     int hello_time;                 /* 8.5.3.5: Time between sending BPDUs. */
 120     int forward_delay;              /* 8.5.3.6: Delay between state changes. */
 121     int bridge_max_age;             /* 8.5.3.8: max_age when we're root. */
 122     int bridge_hello_time;          /* 8.5.3.9: hello_time as root. */
 123     int bridge_forward_delay;       /* 8.5.3.10: forward_delay as root. */
 124
 125     /* Dynamic bridge data. */
 126     stp_identifier designated_root; /* 8.5.3.1: Bridge believed to be root. */
 127     unsigned int root_path_cost;    /* 8.5.3.2: Cost of path to root. */
 128     struct stp_port *root_port;     /* 8.5.3.3: Lowest cost port to root. */
 129     bool topology_change_detected;  /* 8.5.3.11: Detected a topology change? */
 130     bool topology_change;           /* 8.5.3.12: Received topology change? */
 131
 132     /* Bridge timers. */
 133     struct stp_timer hello_timer;   /* 8.5.4.1: Hello timer. */
 134     struct stp_timer tcn_timer;     /* 8.5.4.2: Topology change timer. */
 135     struct stp_timer topology_change_timer; /* 8.5.4.3. */
 136
 137     /* Ports. */
 138     struct stp_port ports[STP_MAX_PORTS];
 139
 140     /* Interface to client. */
 141     struct stp_port *first_changed_port;
 142     void (*send_bpdu)(const void *bpdu, size_t bpdu_size,
 143                       int port_no, void *aux);
 144     void *aux;
 145 };
 146
 147 #define FOR_EACH_ENABLED_PORT(PORT, STP)                        \
 148     for ((PORT) = stp_next_enabled_port((STP), (STP)->ports);   \
 149          (PORT);                                                \
 150          (PORT) = stp_next_enabled_port((STP), (PORT) + 1))
 151 static struct stp_port *
 152 stp_next_enabled_port(const struct stp *stp, const struct stp_port *port)
 153 {
 154     for (; port < &stp->ports[ARRAY_SIZE(stp->ports)]; port++) {
 155         if (port->state != STP_DISABLED) {
 156             return (struct stp_port *) port;
 157         }
 158     }
 159     return NULL;
 160 }
 161
 162 #define SECONDS_TO_TIMER(SECS) ((SECS) * 0x100)
 163
 164 #define MESSAGE_AGE_INCREMENT 1
 165
 166 static void stp_transmit_config(struct stp_port *);
 167 static bool stp_supersedes_port_info(const struct stp_port *,
 168                                      const struct stp_config_bpdu *);
 169 static void stp_record_config_information(struct stp_port *,
 170                                           const struct stp_config_bpdu *);
 171 static void stp_record_config_timeout_values(struct stp *,
 172                                              const struct stp_config_bpdu  *);
 173 static bool stp_is_designated_port(const struct stp_port *);
 174 static void stp_config_bpdu_generation(struct stp *);
 175 static void stp_transmit_tcn(struct stp *);
 176 static void stp_configuration_update(struct stp *);
 177 static bool stp_supersedes_root(const struct stp_port *root,
 178                                 const struct stp_port *);
 179 static void stp_root_selection(struct stp *);
 180 static void stp_designated_port_selection(struct stp *);
 181 static void stp_become_designated_port(struct stp_port *);
 182 static void stp_port_state_selection(struct stp *);
 183 static void stp_make_forwarding(struct stp_port *);
 184 static void stp_make_blocking(struct stp_port *);
 185 static void stp_set_port_state(struct stp_port *, enum stp_state);
 186 static void stp_topology_change_detection(struct stp *);
 187 static void stp_topology_change_acknowledged(struct stp *);
 188 static void stp_acknowledge_topology_change(struct stp_port *);
 189 static void stp_received_config_bpdu(struct stp *, struct stp_port *,
 190                                      const struct stp_config_bpdu *);
 191 static void stp_received_tcn_bpdu(struct stp *, struct stp_port *,
 192                                   const struct stp_tcn_bpdu *);
 193 static void stp_hello_timer_expiry(struct stp *);
 194 static void stp_message_age_timer_expiry(struct stp_port *);
 195 static bool stp_is_designated_for_some_port(const struct stp *);
 196 static void stp_forward_delay_timer_expiry(struct stp_port *);
 197 static void stp_tcn_timer_expiry(struct stp *);
 198 static void stp_topology_change_timer_expiry(struct stp *);
 199 static void stp_hold_timer_expiry(struct stp_port *);
 200 static void stp_initialize_port(struct stp_port *, enum stp_state);
 201 static void stp_become_root_bridge(struct stp *stp);
 202
 203 static void stp_start_timer(struct stp_timer *, int value);
 204 static void stp_stop_timer(struct stp_timer *);
 205 static bool stp_timer_expired(struct stp_timer *, int elapsed, int timeout);
 206
 207 /* Creates and returns a new STP instance that initially has no port enabled.
 208  *
 209  * 'bridge_id' should be a 48-bit MAC address as returned by
 210  * eth_addr_to_uint64().  'bridge_id' may also have a priority value in its top
 211  * 16 bits; if those bits are set to 0, the default bridge priority of 32768 is
 212  * used.  (This priority may be changed with stp_set_bridge_priority().)
 213  *
 214  * When the bridge needs to send out a BPDU, it calls 'send_bpdu', passing
 215  * 'aux' as auxiliary data.  This callback may be called from stp_tick() or
 216  * stp_received_bpdu().
 217  */
 218 struct stp *
 219 stp_create(const char *name, stp_identifier bridge_id,
 220            void (*send_bpdu)(const void *bpdu, size_t bpdu_size,
 221                              int port_no, void *aux),
 222            void *aux)
 223 {
 224     struct stp *stp;
 225     struct stp_port *p;
 226
 227     stp = xcalloc(1, sizeof *stp);
 228     stp->name = xstrdup(name);
 229     stp->bridge_id = bridge_id;
 230     if (!(stp->bridge_id >> 48)) {
 231         stp->bridge_id |= UINT64_C(32768) << 48;
 232     }
 233     stp->max_age = SECONDS_TO_TIMER(6);
 234     stp->hello_time = SECONDS_TO_TIMER(2);
 235     stp->forward_delay = SECONDS_TO_TIMER(4);
 236     stp->bridge_max_age = stp->max_age;
 237     stp->bridge_hello_time = stp->hello_time;
 238     stp->bridge_forward_delay = stp->forward_delay;
 239
 240     stp->designated_root = stp->bridge_id;
 241     stp->root_path_cost = 0;
 242     stp->root_port = NULL;
 243     stp->topology_change_detected = false;
 244     stp->topology_change = false;
 245
 246     stp_stop_timer(&stp->tcn_timer);
 247     stp_stop_timer(&stp->topology_change_timer);
 248     stp_start_timer(&stp->hello_timer, 0);
 249
 250     stp->send_bpdu = send_bpdu;
 251     stp->aux = aux;
 252
 253     stp->first_changed_port = &stp->ports[ARRAY_SIZE(stp->ports)];
 254     for (p = stp->ports; p < &stp->ports[ARRAY_SIZE(stp->ports)]; p++) {
 255         p->stp = stp;
 256         p->port_id = (stp_port_no(p) + 1) | (128 << 8);
 257         p->path_cost = 19;      /* Recommended default for 100 Mb/s link. */
 258         stp_initialize_port(p, STP_DISABLED);
 259     }
 260     return stp;
 261 }
 262
 263 /* Destroys 'stp'. */
 264 void
 265 stp_destroy(struct stp *stp)
 266 {
 267     free(stp);
 268 }
 269
 270 void
 271 stp_tick(struct stp *stp, int elapsed)
 272 {
 273     struct stp_port *p;
 274
 275     if (stp_timer_expired(&stp->hello_timer, elapsed, stp->hello_time)) {
 276         stp_hello_timer_expiry(stp);
 277     }
 278     if (stp_timer_expired(&stp->tcn_timer, elapsed, stp->bridge_hello_time)) {
 279         stp_tcn_timer_expiry(stp);
 280     }
 281     if (stp_timer_expired(&stp->topology_change_timer, elapsed,
 282                           stp->max_age + stp->forward_delay)) {
 283         stp_topology_change_timer_expiry(stp);
 284     }
 285     FOR_EACH_ENABLED_PORT (p, stp) {
 286         if (stp_timer_expired(&p->message_age_timer, elapsed, stp->max_age)) {
 287             stp_message_age_timer_expiry(p);
 288         }
 289     }
 290     FOR_EACH_ENABLED_PORT (p, stp) {
 291         if (stp_timer_expired(&p->forward_delay_timer, elapsed,
 292                               stp->forward_delay)) {
 293             stp_forward_delay_timer_expiry(p);
 294         }
 295         if (stp_timer_expired(&p->hold_timer, elapsed, SECONDS_TO_TIMER(1))) {
 296             stp_hold_timer_expiry(p);
 297         }
 298     }
 299 }
 300
 301 static void
 302 set_bridge_id(struct stp *stp, stp_identifier new_bridge_id)
 303 {
 304     if (new_bridge_id != stp->bridge_id) {
 305         bool root;
 306         struct stp_port *p;
 307
 308         root = stp_is_root_bridge(stp);
 309         FOR_EACH_ENABLED_PORT (p, stp) {
 310             if (stp_is_designated_port(p)) {
 311                 p->designated_bridge = new_bridge_id;
 312             }
 313         }
 314         stp->bridge_id = new_bridge_id;
 315         stp_configuration_update(stp);
 316         stp_port_state_selection(stp);
 317         if (stp_is_root_bridge(stp) && !root) {
 318             stp_become_root_bridge(stp);
 319         }
 320     }
 321 }
 322
 323 void
 324 stp_set_bridge_id(struct stp *stp, stp_identifier bridge_id)
 325 {
 326     const uint64_t mac_bits = (UINT64_C(1) << 48) - 1;
 327     const uint64_t pri_bits = ~mac_bits;
 328     set_bridge_id(stp, (stp->bridge_id & pri_bits) | (bridge_id & mac_bits));
 329 }
 330
 331 void
 332 stp_set_bridge_priority(struct stp *stp, uint16_t new_priority)
 333 {
 334     const uint64_t mac_bits = (UINT64_C(1) << 48) - 1;
 335     set_bridge_id(stp, ((stp->bridge_id & mac_bits)
 336                         | ((uint64_t) new_priority << 48)));
 337 }
 338
 339 /* Returns the name given to 'stp' in the call to stp_create(). */
 340 const char *
 341 stp_get_name(const struct stp *stp)
 342 {
 343     return stp->name;
 344 }
 345
 346 /* Returns the bridge ID for 'stp'. */
 347 stp_identifier
 348 stp_get_bridge_id(const struct stp *stp)
 349 {
 350     return stp->bridge_id;
 351 }
 352
 353 /* Returns the bridge ID of the bridge currently believed to be the root. */
 354 stp_identifier
 355 stp_get_designated_root(const struct stp *stp)
 356 {
 357     return stp->designated_root;
 358 }
 359
 360 /* Returns true if 'stp' believes itself to the be root of the spanning tree,
 361  * false otherwise. */
 362 bool
 363 stp_is_root_bridge(const struct stp *stp)
 364 {
 365     return stp->bridge_id == stp->designated_root;
 366 }
 367
 368 /* Returns the cost of the path from 'stp' to the root of the spanning tree. */
 369 int
 370 stp_get_root_path_cost(const struct stp *stp)
 371 {
 372     return stp->root_path_cost;
 373 }
 374
 375 /* Returns the port in 'stp' with index 'port_no', which must be between 0 and
 376  * STP_MAX_PORTS. */
 377 struct stp_port *
 378 stp_get_port(struct stp *stp, int port_no)
 379 {
 380     assert(port_no >= 0 && port_no < ARRAY_SIZE(stp->ports));
 381     return &stp->ports[port_no];
 382 }
 383
 384 /* Returns the port connecting 'stp' to the root bridge, or a null pointer if
 385  * there is no such port. */
 386 struct stp_port *
 387 stp_get_root_port(struct stp *stp)
 388 {
 389     return stp->root_port;
 390 }
 391
 392 /* Finds a port whose state has changed.  If successful, stores the port whose
 393  * state changed in '*portp' and returns true.  If no port has changed, stores
 394  * NULL in '*portp' and returns false. */
 395 bool
 396 stp_get_changed_port(struct stp *stp, struct stp_port **portp)
 397 {
 398     struct stp_port *end = &stp->ports[ARRAY_SIZE(stp->ports)];
 399     struct stp_port *p;
 400
 401     for (p = stp->first_changed_port; p < end; p++) {
 402         if (p->state_changed) {
 403             p->state_changed = false;
 404             stp->first_changed_port = p + 1;
 405             *portp = p;
 406             return true;
 407         }
 408     }
 409     stp->first_changed_port = end;
 410     *portp = NULL;
 411     return false;
 412 }
 413
 414 /* Returns the name for the given 'state' (for use in debugging and log
 415  * messages). */
 416 const char *
 417 stp_state_name(enum stp_state state)
 418 {
 419     switch (state) {
 420     case STP_DISABLED:
 421         return "disabled";
 422     case STP_LISTENING:
 423         return "listening";
 424     case STP_LEARNING:
 425         return "learning";
 426     case STP_FORWARDING:
 427         return "forwarding";
 428     case STP_BLOCKING:
 429         return "blocking";
 430     default:
 431         NOT_REACHED();
 432     }
 433 }
 434
 435 /* Returns true if 'state' is one in which packets received on a port should
 436  * be forwarded, false otherwise. */
 437 bool
 438 stp_forward_in_state(enum stp_state state)
 439 {
 440     return state == STP_FORWARDING;
 441 }
 442
 443 /* Returns true if 'state' is one in which MAC learning should be done on
 444  * packets received on a port, false otherwise. */
 445 bool
 446 stp_learn_in_state(enum stp_state state)
 447 {
 448     return state & (STP_LEARNING | STP_FORWARDING);
 449 }
 450
 451 /* Notifies the STP entity that bridge protocol data unit 'bpdu', which is
 452  * 'bpdu_size' bytes in length, was received on port 'p'.
 453  *
 454  * This function may call the 'send_bpdu' function provided to stp_create(). */
 455 void
 456 stp_received_bpdu(struct stp_port *p, const void *bpdu, size_t bpdu_size)
 457 {
 458     struct stp *stp = p->stp;
 459     const struct stp_bpdu_header *header;
 460
 461     if (p->state == STP_DISABLED) {
 462         return;
 463     }
 464
 465     if (bpdu_size < sizeof(struct stp_bpdu_header)) {
 466         VLOG_WARN("%s: received runt %zu-byte BPDU", stp->name, bpdu_size);
 467         return;
 468     }
 469
 470     header = bpdu;
 471     if (header->protocol_id != htons(STP_PROTOCOL_ID)) {
 472         VLOG_WARN("%s: received BPDU with unexpected protocol ID %"PRIu16,
 473                   stp->name, ntohs(header->protocol_id));
 474         return;
 475     }
 476     if (header->protocol_version != STP_PROTOCOL_VERSION) {
 477         VLOG_DBG("%s: received BPDU with unexpected protocol version %"PRIu8,
 478                  stp->name, header->protocol_version);
 479     }
 480
 481     switch (header->bpdu_type) {
 482     case STP_TYPE_CONFIG:
 483         if (bpdu_size < sizeof(struct stp_config_bpdu)) {
 484             VLOG_WARN("%s: received config BPDU with invalid size %zu",
 485                       stp->name, bpdu_size);
 486             return;
 487         }
 488         stp_received_config_bpdu(stp, p, bpdu);
 489         break;
 490
 491     case STP_TYPE_TCN:
 492         if (bpdu_size != sizeof(struct stp_tcn_bpdu)) {
 493             VLOG_WARN("%s: received TCN BPDU with invalid size %zu",
 494                       stp->name, bpdu_size);
 495             return;
 496         }
 497         stp_received_tcn_bpdu(stp, p, bpdu);
 498         break;
 499
 500     default:
 501         VLOG_WARN("%s: received BPDU of unexpected type %"PRIu8,
 502                   stp->name, header->bpdu_type);
 503         return;
 504     }
 505 }
 506
 507 /* Returns the STP entity in which 'p' is nested. */
 508 struct stp *
 509 stp_port_get_stp(struct stp_port *p)
 510 {
 511     return p->stp;
 512 }
 513
 514 /* Returns the index of port 'p' within its bridge. */
 515 int
 516 stp_port_no(const struct stp_port *p)
 517 {
 518     struct stp *stp = p->stp;
 519     assert(p >= stp->ports && p < &stp->ports[ARRAY_SIZE(stp->ports)]);
 520     return p - stp->ports;
 521 }
 522
 523 /* Returns the state of port 'p'. */
 524 enum stp_state
 525 stp_port_get_state(const struct stp_port *p)
 526 {
 527     return p->state;
 528 }
 529
 530 /* Disables STP on port 'p'. */
 531 void
 532 stp_port_disable(struct stp_port *p)
 533 {
 534     struct stp *stp = p->stp;
 535     if (p->state != STP_DISABLED) {
 536         bool root = stp_is_root_bridge(stp);
 537         stp_become_designated_port(p);
 538         stp_set_port_state(p, STP_DISABLED);
 539         p->topology_change_ack = false;
 540         p->config_pending = false;
 541         stp_stop_timer(&p->message_age_timer);
 542         stp_stop_timer(&p->forward_delay_timer);
 543         stp_configuration_update(stp);
 544         stp_port_state_selection(stp);
 545         if (stp_is_root_bridge(stp) && !root) {
 546             stp_become_root_bridge(stp);
 547         }
 548     }
 549 }
 550
 551 /* Enables STP on port 'p'.  The port will initially be in "blocking" state. */
 552 void
 553 stp_port_enable(struct stp_port *p)
 554 {
 555     if (p->state == STP_DISABLED) {
 556         stp_initialize_port(p, STP_BLOCKING);
 557         stp_port_state_selection(p->stp);
 558     }
 559 }
 560
 561 /* Sets the priority of port 'p' to 'new_priority'.  Lower numerical values
 562  * are interpreted as higher priorities. */
 563 void
 564 stp_port_set_priority(struct stp_port *p, uint8_t new_priority)
 565 {
 566     uint16_t new_port_id = (p->port_id & 0xff) | (new_priority << 8);
 567     if (p->port_id != new_port_id) {
 568         struct stp *stp = p->stp;
 569         if (stp_is_designated_port(p)) {
 570             p->designated_port = new_port_id;
 571         }
 572         p->port_id = new_port_id;
 573         if (stp->bridge_id == p->designated_bridge
 574             && p->port_id < p->designated_port) {
 575             stp_become_designated_port(p);
 576             stp_port_state_selection(stp);
 577         }
 578     }
 579 }
 580
 581 /* Sets the path cost of port 'p' to 'path_cost'.  Lower values are generally
 582  * used to indicate faster links.  Use stp_port_set_speed() to automatically
 583  * generate a default path cost from a link speed. */
 584 void
 585 stp_port_set_path_cost(struct stp_port *p, unsigned int path_cost)
 586 {
 587     if (p->path_cost != path_cost) {
 588         struct stp *stp = p->stp;
 589         p->path_cost = path_cost;
 590         stp_configuration_update(stp);
 591         stp_port_state_selection(stp);
 592     }
 593 }
 594
 595 /* Sets the path cost of port 'p' based on 'speed' (measured in Mb/s). */
 596 void
 597 stp_port_set_speed(struct stp_port *p, unsigned int speed)
 598 {
 599     stp_port_set_path_cost(p, (speed >= 10000 ? 2  /* 10 Gb/s. */
 600                                : speed >= 1000 ? 4 /* 1 Gb/s. */
 601                                : speed >= 100 ? 19 /* 100 Mb/s. */
 602                                : speed >= 16 ? 62  /* 16 Mb/s. */
 603                                : speed >= 10 ? 100 /* 10 Mb/s. */
 604                                : speed >= 4 ? 250  /* 4 Mb/s. */
 605                                : 19));             /* 100 Mb/s (guess). */
 606 }
 607
 608 /* Enables topology change detection on port 'p'. */
 609 void
 610 stp_port_enable_change_detection(struct stp_port *p)
 611 {
 612     p->change_detection_enabled = true;
 613 }
 614
 615 /* Disables topology change detection on port 'p'. */
 616 void
 617 stp_port_disable_change_detection(struct stp_port *p)
 618 {
 619     p->change_detection_enabled = false;
 620 }
 621 \f
 622 static void
 623 stp_transmit_config(struct stp_port *p)
 624 {
 625     struct stp *stp = p->stp;
 626     bool root = stp_is_root_bridge(stp);
 627     if (!root && !stp->root_port) {
 628         return;
 629     }
 630     if (p->hold_timer.active) {
 631         p->config_pending = true;
 632     } else {
 633         struct stp_config_bpdu config;
 634         memset(&config, 0, sizeof config);
 635         config.header.protocol_id = htons(STP_PROTOCOL_ID);
 636         config.header.protocol_version = STP_PROTOCOL_VERSION;
 637         config.header.bpdu_type = STP_TYPE_CONFIG;
 638         config.flags = 0;
 639         if (p->topology_change_ack) {
 640             config.flags |= htons(STP_CONFIG_TOPOLOGY_CHANGE_ACK);
 641         }
 642         if (stp->topology_change) {
 643             config.flags |= htons(STP_CONFIG_TOPOLOGY_CHANGE);
 644         }
 645         config.root_id = htonll(stp->designated_root);
 646         config.root_path_cost = htonl(stp->root_path_cost);
 647         config.bridge_id = htonll(stp->bridge_id);
 648         config.port_id = htons(p->port_id);
 649         if (root) {
 650             config.message_age = htons(0);
 651         } else {
 652             config.message_age = htons(stp->root_port->message_age_timer.value
 653                                        + MESSAGE_AGE_INCREMENT);
 654         }
 655         config.max_age = htons(stp->max_age);
 656         config.hello_time = htons(stp->hello_time);
 657         config.forward_delay = htons(stp->forward_delay);
 658         if (ntohs(config.message_age) < stp->max_age) {
 659             p->topology_change_ack = false;
 660             p->config_pending = false;
 661             stp->send_bpdu(&config, sizeof config, stp_port_no(p), stp->aux);
 662             stp_start_timer(&p->hold_timer, 0);
 663         }
 664     }
 665 }
 666
 667 static bool
 668 stp_supersedes_port_info(const struct stp_port *p,
 669                          const struct stp_config_bpdu *config)
 670 {
 671     if (ntohll(config->root_id) != p->designated_root) {
 672         return ntohll(config->root_id) < p->designated_root;
 673     } else if (ntohl(config->root_path_cost) != p->designated_cost) {
 674         return ntohl(config->root_path_cost) < p->designated_cost;
 675     } else if (ntohll(config->bridge_id) != p->designated_bridge) {
 676         return ntohll(config->bridge_id) < p->designated_bridge;
 677     } else {
 678         return (ntohll(config->bridge_id) != p->stp->bridge_id
 679                 || ntohs(config->port_id) <= p->designated_port);
 680     }
 681 }
 682
 683 static void
 684 stp_record_config_information(struct stp_port *p,
 685                               const struct stp_config_bpdu *config)
 686 {
 687     p->designated_root = ntohll(config->root_id);
 688     p->designated_cost = ntohl(config->root_path_cost);
 689     p->designated_bridge = ntohll(config->bridge_id);
 690     p->designated_port = ntohs(config->port_id);
 691     stp_start_timer(&p->message_age_timer, ntohs(config->message_age));
 692 }
 693
 694 static void
 695 stp_record_config_timeout_values(struct stp *stp,
 696                                  const struct stp_config_bpdu  *config)
 697 {
 698     stp->max_age = ntohs(config->max_age);
 699     stp->hello_time = ntohs(config->hello_time);
 700     stp->forward_delay = ntohs(config->forward_delay);
 701     stp->topology_change = config->flags & htons(STP_CONFIG_TOPOLOGY_CHANGE);
 702 }
 703
 704 static bool
 705 stp_is_designated_port(const struct stp_port *p)
 706 {
 707     return (p->designated_bridge == p->stp->bridge_id
 708             && p->designated_port == p->port_id);
 709 }
 710
 711 static void
 712 stp_config_bpdu_generation(struct stp *stp)
 713 {
 714     struct stp_port *p;
 715
 716     FOR_EACH_ENABLED_PORT (p, stp) {
 717         if (stp_is_designated_port(p)) {
 718             stp_transmit_config(p);
 719         }
 720     }
 721 }
 722
 723 static void
 724 stp_transmit_tcn(struct stp *stp)
 725 {
 726     struct stp_port *p = stp->root_port;
 727     struct stp_tcn_bpdu tcn_bpdu;
 728     if (!p) {
 729         return;
 730     }
 731     tcn_bpdu.header.protocol_id = htons(STP_PROTOCOL_ID);
 732     tcn_bpdu.header.protocol_version = STP_PROTOCOL_VERSION;
 733     tcn_bpdu.header.bpdu_type = STP_TYPE_TCN;
 734     stp->send_bpdu(&tcn_bpdu, sizeof tcn_bpdu, stp_port_no(p), stp->aux);
 735 }
 736
 737 static void
 738 stp_configuration_update(struct stp *stp)
 739 {
 740     stp_root_selection(stp);
 741     stp_designated_port_selection(stp);
 742 }
 743
 744 static bool
 745 stp_supersedes_root(const struct stp_port *root, const struct stp_port *p)
 746 {
 747     int p_cost = p->designated_cost + p->path_cost;
 748     int root_cost = root->designated_cost + root->path_cost;
 749
 750     if (p->designated_root != root->designated_root) {
 751         return p->designated_root < root->designated_root;
 752     } else if (p_cost != root_cost) {
 753         return p_cost < root_cost;
 754     } else if (p->designated_bridge != root->designated_bridge) {
 755         return p->designated_bridge < root->designated_bridge;
 756     } else if (p->designated_port != root->designated_port) {
 757         return p->designated_port < root->designated_port;
 758     } else {
 759         return p->port_id < root->port_id;
 760     }
 761 }
 762
 763 static void
 764 stp_root_selection(struct stp *stp)
 765 {
 766     struct stp_port *p, *root;
 767
 768     root = NULL;
 769     FOR_EACH_ENABLED_PORT (p, stp) {
 770         if (stp_is_designated_port(p)
 771             || p->designated_root >= stp->bridge_id) {
 772             continue;
 773         }
 774         if (root && !stp_supersedes_root(root, p)) {
 775             continue;
 776         }
 777         root = p;
 778     }
 779     stp->root_port = root;
 780     if (!root) {
 781         stp->designated_root = stp->bridge_id;
 782         stp->root_path_cost = 0;
 783     } else {
 784         stp->designated_root = root->designated_root;
 785         stp->root_path_cost = root->designated_cost + root->path_cost;
 786     }
 787 }
 788
 789 static void
 790 stp_designated_port_selection(struct stp *stp)
 791 {
 792     struct stp_port *p;
 793
 794     FOR_EACH_ENABLED_PORT (p, stp) {
 795         if (stp_is_designated_port(p)
 796             || p->designated_root != stp->designated_root
 797             || stp->root_path_cost < p->designated_cost
 798             || (stp->root_path_cost == p->designated_cost
 799                 && (stp->bridge_id < p->designated_bridge
 800                     || (stp->bridge_id == p->designated_bridge
 801                         && p->port_id <= p->designated_port))))
 802         {
 803             stp_become_designated_port(p);
 804         }
 805     }
 806 }
 807
 808 static void
 809 stp_become_designated_port(struct stp_port *p)
 810 {
 811     struct stp *stp = p->stp;
 812     p->designated_root = stp->designated_root;
 813     p->designated_cost = stp->root_path_cost;
 814     p->designated_bridge = stp->bridge_id;
 815     p->designated_port = p->port_id;
 816 }
 817
 818 static void
 819 stp_port_state_selection(struct stp *stp)
 820 {
 821     struct stp_port *p;
 822
 823     FOR_EACH_ENABLED_PORT (p, stp) {
 824         if (p == stp->root_port) {
 825             p->config_pending = false;
 826             p->topology_change_ack = false;
 827             stp_make_forwarding(p);
 828         } else if (stp_is_designated_port(p)) {
 829             stp_stop_timer(&p->message_age_timer);
 830             stp_make_forwarding(p);
 831         } else {
 832             p->config_pending = false;
 833             p->topology_change_ack = false;
 834             stp_make_blocking(p);
 835         }
 836     }
 837 }
 838
 839 static void
 840 stp_make_forwarding(struct stp_port *p)
 841 {
 842     if (p->state == STP_BLOCKING) {
 843         stp_set_port_state(p, STP_LISTENING);
 844         stp_start_timer(&p->forward_delay_timer, 0);
 845     }
 846 }
 847
 848 static void
 849 stp_make_blocking(struct stp_port *p)
 850 {
 851     if (!(p->state & (STP_DISABLED | STP_BLOCKING))) {
 852         if (p->state & (STP_FORWARDING | STP_LEARNING)) {
 853             if (p->change_detection_enabled) {
 854                 stp_topology_change_detection(p->stp);
 855             }
 856         }
 857         stp_set_port_state(p, STP_BLOCKING);
 858         stp_stop_timer(&p->forward_delay_timer);
 859     }
 860 }
 861
 862 static void
 863 stp_set_port_state(struct stp_port *p, enum stp_state state)
 864 {
 865     if (state != p->state && !p->state_changed) {
 866         p->state_changed = true;
 867         if (p < p->stp->first_changed_port) {
 868             p->stp->first_changed_port = p;
 869         }
 870     }
 871     p->state = state;
 872 }
 873
 874 static void
 875 stp_topology_change_detection(struct stp *stp)
 876 {
 877     if (stp_is_root_bridge(stp)) {
 878         stp->topology_change = true;
 879         stp_start_timer(&stp->topology_change_timer, 0);
 880     } else if (!stp->topology_change_detected) {
 881         stp_transmit_tcn(stp);
 882         stp_start_timer(&stp->tcn_timer, 0);
 883     }
 884     stp->topology_change_detected = true;
 885 }
 886
 887 static void
 888 stp_topology_change_acknowledged(struct stp *stp)
 889 {
 890     stp->topology_change_detected = false;
 891     stp_stop_timer(&stp->tcn_timer);
 892 }
 893
 894 static void
 895 stp_acknowledge_topology_change(struct stp_port *p)
 896 {
 897     p->topology_change_ack = true;
 898     stp_transmit_config(p);
 899 }
 900
 901 void
 902 stp_received_config_bpdu(struct stp *stp, struct stp_port *p,
 903                          const struct stp_config_bpdu *config)
 904 {
 905     if (ntohs(config->message_age) >= ntohs(config->max_age)) {
 906         VLOG_WARN("%s: received config BPDU with message age (%u) greater "
 907                   "than max age (%u)",
 908                   stp->name,
 909                   ntohs(config->message_age), ntohs(config->max_age));
 910         return;
 911     }
 912     if (p->state != STP_DISABLED) {
 913         bool root = stp_is_root_bridge(stp);
 914         if (stp_supersedes_port_info(p, config)) {
 915             stp_record_config_information(p, config);
 916             stp_configuration_update(stp);
 917             stp_port_state_selection(stp);
 918             if (!stp_is_root_bridge(stp) && root) {
 919                 stp_stop_timer(&stp->hello_timer);
 920                 if (stp->topology_change_detected) {
 921                     stp_stop_timer(&stp->topology_change_timer);
 922                     stp_transmit_tcn(stp);
 923                     stp_start_timer(&stp->tcn_timer, 0);
 924                 }
 925             }
 926             if (p == stp->root_port) {
 927                 stp_record_config_timeout_values(stp, config);
 928                 stp_config_bpdu_generation(stp);
 929                 if (config->flags & htons(STP_CONFIG_TOPOLOGY_CHANGE_ACK)) {
 930                     stp_topology_change_acknowledged(stp);
 931                 }
 932             }
 933         } else if (stp_is_designated_port(p)) {
 934             stp_transmit_config(p);
 935         }
 936     }
 937 }
 938
 939 void
 940 stp_received_tcn_bpdu(struct stp *stp, struct stp_port *p,
 941                       const struct stp_tcn_bpdu *tcn)
 942 {
 943     if (p->state != STP_DISABLED) {
 944         if (stp_is_designated_port(p)) {
 945             stp_topology_change_detection(stp);
 946             stp_acknowledge_topology_change(p);
 947         }
 948     }
 949 }
 950
 951 static void
 952 stp_hello_timer_expiry(struct stp *stp)
 953 {
 954     stp_config_bpdu_generation(stp);
 955     stp_start_timer(&stp->hello_timer, 0);
 956 }
 957
 958 static void
 959 stp_message_age_timer_expiry(struct stp_port *p)
 960 {
 961     struct stp *stp = p->stp;
 962     bool root = stp_is_root_bridge(stp);
 963     stp_become_designated_port(p);
 964     stp_configuration_update(stp);
 965     stp_port_state_selection(stp);
 966     if (stp_is_root_bridge(stp) && !root) {
 967         stp->max_age = stp->bridge_max_age;
 968         stp->hello_time = stp->bridge_hello_time;
 969         stp->forward_delay = stp->bridge_forward_delay;
 970         stp_topology_change_detection(stp);
 971         stp_stop_timer(&stp->tcn_timer);
 972         stp_config_bpdu_generation(stp);
 973         stp_start_timer(&stp->hello_timer, 0);
 974     }
 975 }
 976
 977 static bool
 978 stp_is_designated_for_some_port(const struct stp *stp)
 979 {
 980     const struct stp_port *p;
 981
 982     FOR_EACH_ENABLED_PORT (p, stp) {
 983         if (p->designated_bridge == stp->bridge_id) {
 984             return true;
 985         }
 986     }
 987     return false;
 988 }
 989
 990 static void
 991 stp_forward_delay_timer_expiry(struct stp_port *p)
 992 {
 993     if (p->state == STP_LISTENING) {
 994         stp_set_port_state(p, STP_LEARNING);
 995         stp_start_timer(&p->forward_delay_timer, 0);
 996     } else if (p->state == STP_LEARNING) {
 997         stp_set_port_state(p, STP_FORWARDING);
 998         if (stp_is_designated_for_some_port(p->stp)) {
 999             if (p->change_detection_enabled) {
1000                 stp_topology_change_detection(p->stp);
1001             }
1002         }
1003     }
1004 }
1005
1006 static void
1007 stp_tcn_timer_expiry(struct stp *stp)
1008 {
1009     stp_transmit_tcn(stp);
1010     stp_start_timer(&stp->tcn_timer, 0);
1011 }
1012
1013 static void
1014 stp_topology_change_timer_expiry(struct stp *stp)
1015 {
1016     stp->topology_change_detected = false;
1017     stp->topology_change = false;
1018 }
1019
1020 static void
1021 stp_hold_timer_expiry(struct stp_port *p)
1022 {
1023     if (p->config_pending) {
1024         stp_transmit_config(p);
1025     }
1026 }
1027
1028 static void
1029 stp_initialize_port(struct stp_port *p, enum stp_state state)
1030 {
1031     assert(state & (STP_DISABLED | STP_BLOCKING));
1032     stp_become_designated_port(p);
1033     stp_set_port_state(p, state);
1034     p->topology_change_ack = false;
1035     p->config_pending = false;
1036     p->change_detection_enabled = true;
1037     stp_stop_timer(&p->message_age_timer);
1038     stp_stop_timer(&p->forward_delay_timer);
1039     stp_stop_timer(&p->hold_timer);
1040 }
1041
1042 static void
1043 stp_become_root_bridge(struct stp *stp)
1044 {
1045     stp->max_age = stp->bridge_max_age;
1046     stp->hello_time = stp->bridge_hello_time;
1047     stp->forward_delay = stp->bridge_forward_delay;
1048     stp_topology_change_detection(stp);
1049     stp_stop_timer(&stp->tcn_timer);
1050     stp_config_bpdu_generation(stp);
1051     stp_start_timer(&stp->hello_timer, 0);
1052 }
1053
1054 static void
1055 stp_start_timer(struct stp_timer *timer, int value)
1056 {
1057     timer->value = value;
1058     timer->active = true;
1059 }
1060
1061 static void
1062 stp_stop_timer(struct stp_timer *timer)
1063 {
1064     timer->active = false;
1065 }
1066
1067 static bool
1068 stp_timer_expired(struct stp_timer *timer, int elapsed, int timeout)
1069 {
1070     if (timer->active) {
1071         timer->value += elapsed;
1072         if (timer->value >= timeout) {
1073             timer->active = false;
1074             return true;
1075         }
1076     }
1077     return false;
1078 }
1079