2 * Copyright (c) 2011-2014 M3S, Srl - Italy
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * Rapid Spanning Tree Protocol (IEEE 802.1D-2004) state machines
22 * Martino Fornasa <mf@fornasa.it>
23 * Daniele Venturino <daniele.venturino@m3s.it>
25 * References to IEEE 802.1D-2004 standard are enclosed in square brackets.
26 * E.g. [17.3], [Table 17-1], etc.
32 #include "rstp-state-machines.h"
33 #include <arpa/inet.h>
35 #include <netinet/in.h>
37 #include <sys/types.h>
38 #include "byte-order.h"
39 #include "connectivity.h"
41 #include "dp-packet.h"
46 #include "openvswitch/vlog.h"
48 VLOG_DEFINE_THIS_MODULE(rstp_sm);
50 #define ROLE_FLAG_MASK 0xC
51 #define ROLE_FLAG_SHIFT 2
61 CONFIGURATION_BPDU_SIZE = 35,
62 TOPOLOGY_CHANGE_NOTIFICATION_BPDU_SIZE = 4,
63 RAPID_SPANNING_TREE_BPDU_SIZE = 36
66 /* Same is a subset of SUPERIOR, so can be used as a boolean when the
67 * distinction is not significant. */
68 enum vector_comparison {
74 static void decrement_timer(uint16_t *);
75 static void rstp_send_bpdu(struct rstp_port *, const void *, size_t)
76 OVS_REQUIRES(rstp_mutex);
77 static int validate_received_bpdu(struct rstp_port *, const void *, size_t)
78 OVS_REQUIRES(rstp_mutex);
79 static ovs_be16 time_encode(uint8_t);
80 static uint8_t time_decode(ovs_be16);
81 static enum vector_comparison
82 compare_rstp_priority_vectors(const struct rstp_priority_vector *,
83 const struct rstp_priority_vector *);
84 static bool rstp_times_equal(struct rstp_times *, struct rstp_times *);
86 /* Per-Bridge State Machine */
87 static int port_role_selection_sm(struct rstp *)
88 OVS_REQUIRES(rstp_mutex);
89 /* Per-Port State Machines */
90 static int port_receive_sm(struct rstp_port *)
91 OVS_REQUIRES(rstp_mutex);
92 static int port_protocol_migration_sm(struct rstp_port *)
93 OVS_REQUIRES(rstp_mutex);
94 static int bridge_detection_sm(struct rstp_port *)
95 OVS_REQUIRES(rstp_mutex);
96 static int port_transmit_sm(struct rstp_port *)
97 OVS_REQUIRES(rstp_mutex);
98 static int port_information_sm(struct rstp_port *)
99 OVS_REQUIRES(rstp_mutex);
100 static int port_role_transition_sm(struct rstp_port *)
101 OVS_REQUIRES(rstp_mutex);
102 static int port_state_transition_sm(struct rstp_port *)
103 OVS_REQUIRES(rstp_mutex);
104 static int topology_change_sm(struct rstp_port *)
105 OVS_REQUIRES(rstp_mutex);
106 /* port_timers_sm() not defined as a state machine */
109 process_received_bpdu__(struct rstp_port *p, const void *bpdu_,
111 OVS_REQUIRES(rstp_mutex)
113 struct rstp *rstp = p->rstp;
114 struct rstp_bpdu *bpdu = (struct rstp_bpdu *)bpdu_;
116 if (!p->port_enabled) {
123 /* [9.2.9 Encoding of Port Role values]
124 * NOTE. If the Unknown value of the Port Role parameter is received, the
125 * state machines will effectively treat the RST BPDU as if it were a
126 * Configuration BPDU.
128 if (bpdu->bpdu_type == RAPID_SPANNING_TREE_BPDU) {
129 uint8_t role = (bpdu->flags & ROLE_FLAG_MASK) >> ROLE_FLAG_SHIFT;
131 if (role == PORT_UNKN) {
132 bpdu->bpdu_type = CONFIGURATION_BPDU;
136 if (validate_received_bpdu(p, bpdu, bpdu_size) == 0) {
138 p->rx_rstp_bpdu_cnt++;
140 memcpy(&p->received_bpdu_buffer, bpdu, sizeof(struct rstp_bpdu));
142 rstp->changes = true;
145 VLOG_DBG("%s, port %u: Bad STP or RSTP BPDU received", p->rstp->name,
151 /* Returns 0 on success. */
153 validate_received_bpdu(struct rstp_port *p, const void *bpdu, size_t bpdu_size)
154 OVS_REQUIRES(rstp_mutex)
156 /* Validation of received BPDU, see [9.3.4]. */
157 const struct rstp_bpdu *temp;
160 if (bpdu_size < TOPOLOGY_CHANGE_NOTIFICATION_BPDU_SIZE ||
161 ntohs(temp->protocol_identifier) != 0) {
164 if (temp->bpdu_type == CONFIGURATION_BPDU
165 && bpdu_size >= CONFIGURATION_BPDU_SIZE
166 && (time_decode(temp->message_age) < time_decode(temp->max_age))) {
167 if ((ntohll(temp->designated_bridge_id) !=
168 p->rstp->bridge_identifier)
169 || ((ntohll(temp->designated_bridge_id) ==
170 p->rstp->bridge_identifier)
171 && (ntohs(temp->designated_port_id) != p->port_id))) {
176 } else if (temp->bpdu_type == TOPOLOGY_CHANGE_NOTIFICATION_BPDU) {
178 } else if (temp->bpdu_type == RAPID_SPANNING_TREE_BPDU &&
179 bpdu_size >= RAPID_SPANNING_TREE_BPDU_SIZE) {
189 * This method is invoked to move the State Machines. The SMs move only if the
190 * boolean 'changes' is true, meaning that something changed and the SMs need
191 * to work to process this change.
192 * The boolean 'changes' is set every time a SM modifies its state, a BPDU is
193 * received, a timer expires or port down event is detected. If a parameter is
194 * set by management, then 'changes' is set.
196 #define MAX_RSTP_ITERATIONS 1000 /* safeguard */
198 move_rstp__(struct rstp *rstp)
199 OVS_REQUIRES(rstp_mutex)
204 while (rstp->changes == true && num_iterations < MAX_RSTP_ITERATIONS) {
207 VLOG_DBG("%s: move_rstp()", rstp->name);
209 rstp->changes = false;
210 port_role_selection_sm(rstp);
211 HMAP_FOR_EACH (p, node, &rstp->ports) {
212 if (p->rstp_state != RSTP_DISABLED) {
214 bridge_detection_sm(p);
215 port_information_sm(p);
216 port_role_transition_sm(p);
217 port_state_transition_sm(p);
218 topology_change_sm(p);
220 port_protocol_migration_sm(p);
224 seq_change(connectivity_seq_get());
226 if (num_iterations >= MAX_RSTP_ITERATIONS) {
227 VLOG_ERR("%s: move_rstp() reached the iteration safeguard limit!",
233 void decrease_rstp_port_timers__(struct rstp *r)
234 OVS_REQUIRES(rstp_mutex)
238 HMAP_FOR_EACH (p, node, &r->ports) {
239 decrement_timer(&p->hello_when);
240 decrement_timer(&p->tc_while);
241 decrement_timer(&p->fd_while);
242 decrement_timer(&p->rcvd_info_while);
243 decrement_timer(&p->rr_while);
244 decrement_timer(&p->rb_while);
245 decrement_timer(&p->mdelay_while);
246 decrement_timer(&p->edge_delay_while);
247 decrement_timer(&p->tx_count);
255 decrement_timer(uint16_t *timer)
262 /* Bridge State Machine. */
263 /* [17.28] Port Role Selection state machine. */
266 updt_role_disabled_tree(struct rstp *r)
267 OVS_REQUIRES(rstp_mutex)
271 HMAP_FOR_EACH (p, node, &r->ports) {
272 p->selected_role = ROLE_DISABLED;
277 clear_reselect_tree(struct rstp *r)
278 OVS_REQUIRES(rstp_mutex)
282 HMAP_FOR_EACH (p, node, &r->ports) {
288 updt_roles_tree__(struct rstp *r)
289 OVS_REQUIRES(rstp_mutex)
293 struct rstp_priority_vector best_vector, candidate_vector;
294 enum rstp_port_role new_root_old_role = ROLE_DESIGNATED;
295 uint16_t old_root_port_number = 0;
296 uint16_t new_root_port_number = 0;
298 old_root_port_number = r->root_port_id & 0x00ff;
299 if (old_root_port_number) {
300 r->old_root_aux = rstp_get_port_aux__(r, old_root_port_number);
303 best_vector = r->bridge_priority;
305 r->root_times = r->bridge_times;
306 /* Letters a) b) c) */
307 HMAP_FOR_EACH (p, node, &r->ports) {
308 uint32_t old_root_path_cost;
309 uint32_t root_path_cost;
311 if (p->info_is != INFO_IS_RECEIVED) {
315 candidate_vector = p->port_priority;
316 candidate_vector.bridge_port_id = p->port_id;
317 old_root_path_cost = candidate_vector.root_path_cost;
318 root_path_cost = old_root_path_cost + p->port_path_cost;
319 candidate_vector.root_path_cost = root_path_cost;
321 if ((candidate_vector.designated_bridge_id & 0xffffffffffffULL) ==
322 (r->bridge_priority.designated_bridge_id & 0xffffffffffffULL)) {
325 if (compare_rstp_priority_vectors(&candidate_vector,
326 &best_vector) == SUPERIOR) {
327 best_vector = candidate_vector;
328 r->root_times = p->port_times;
329 r->root_times.message_age++;
330 vsel = p->port_number;
331 new_root_old_role = p->role;
334 r->root_priority = best_vector;
335 r->root_port_id = best_vector.bridge_port_id;
336 VLOG_DBG("%s: new Root is "RSTP_ID_FMT, r->name,
337 RSTP_ID_ARGS(r->root_priority.root_bridge_id));
338 new_root_port_number = r->root_port_id & 0x00ff;
339 if (new_root_port_number) {
340 r->new_root_aux = rstp_get_port_aux__(r, new_root_port_number);
342 /* Shift learned MAC addresses from an old Root Port to an existing
345 && new_root_old_role == ROLE_ALTERNATE
346 && new_root_port_number
347 && old_root_port_number
348 && new_root_port_number != old_root_port_number) {
349 r->root_changed = true;
352 HMAP_FOR_EACH (p, node, &r->ports) {
353 p->designated_priority_vector.root_bridge_id =
354 r->root_priority.root_bridge_id;
355 p->designated_priority_vector.root_path_cost =
356 r->root_priority.root_path_cost;
357 p->designated_priority_vector.designated_bridge_id =
358 r->bridge_identifier;
359 p->designated_priority_vector.designated_port_id =
361 p->designated_times = r->root_times;
362 p->designated_times.hello_time = r->bridge_times.hello_time;
364 HMAP_FOR_EACH (p, node, &r->ports) {
365 switch (p->info_is) {
366 case INFO_IS_DISABLED:
367 p->selected_role = ROLE_DISABLED;
371 p->selected_role = ROLE_DESIGNATED;
374 p->selected_role = ROLE_DESIGNATED;
375 if (compare_rstp_priority_vectors(
376 &p->port_priority, &p->designated_priority_vector) != SAME
377 || !rstp_times_equal(&p->designated_times, &r->root_times)) {
381 case INFO_IS_RECEIVED:
382 if (vsel == p->port_number) { /* Letter i) */
383 p->selected_role = ROLE_ROOT;
384 p->updt_info = false;
385 } else if (compare_rstp_priority_vectors(
386 &p->designated_priority_vector,
387 &p->port_priority) == INFERIOR) {
388 if (p->port_priority.designated_bridge_id !=
389 r->bridge_identifier) {
390 p->selected_role = ROLE_ALTERNATE;
391 p->updt_info = false;
393 p->selected_role = ROLE_BACKUP;
394 p->updt_info = false;
397 p->selected_role = ROLE_DESIGNATED;
406 seq_change(connectivity_seq_get());
410 set_selected_tree(struct rstp *r)
411 OVS_REQUIRES(rstp_mutex)
415 HMAP_FOR_EACH (p, node, &r->ports) {
420 HMAP_FOR_EACH (p, node, &r->ports) {
426 port_role_selection_sm(struct rstp *r)
427 OVS_REQUIRES(rstp_mutex)
429 enum port_role_selection_state_machine old_state;
432 old_state = r->port_role_selection_sm_state;
434 switch (r->port_role_selection_sm_state) {
435 case PORT_ROLE_SELECTION_SM_INIT:
437 r->port_role_selection_sm_state =
438 PORT_ROLE_SELECTION_SM_INIT_BRIDGE_EXEC;
441 case PORT_ROLE_SELECTION_SM_INIT_BRIDGE_EXEC:
442 updt_role_disabled_tree(r);
443 r->port_role_selection_sm_state = PORT_ROLE_SELECTION_SM_INIT_BRIDGE;
445 case PORT_ROLE_SELECTION_SM_INIT_BRIDGE:
446 r->port_role_selection_sm_state =
447 PORT_ROLE_SELECTION_SM_ROLE_SELECTION_EXEC;
449 case PORT_ROLE_SELECTION_SM_ROLE_SELECTION_EXEC:
450 clear_reselect_tree(r);
451 updt_roles_tree__(r);
452 set_selected_tree(r);
453 r->port_role_selection_sm_state =
454 PORT_ROLE_SELECTION_SM_ROLE_SELECTION;
456 case PORT_ROLE_SELECTION_SM_ROLE_SELECTION:
457 HMAP_FOR_EACH (p, node, &r->ports) {
459 r->port_role_selection_sm_state =
460 PORT_ROLE_SELECTION_SM_ROLE_SELECTION_EXEC;
469 if (old_state != r->port_role_selection_sm_state) {
471 VLOG_DBG("%s: Port_role_selection_sm %d -> %d", r->name,
472 old_state, r->port_role_selection_sm_state);
477 /* Port State Machines */
479 /* [17.23 - Port receive state machine] */
482 updt_bpdu_version(struct rstp_port *p) /* [17.21.22] */
483 OVS_REQUIRES(rstp_mutex)
485 switch (p->received_bpdu_buffer.bpdu_type) {
486 case CONFIGURATION_BPDU:
487 case TOPOLOGY_CHANGE_NOTIFICATION_BPDU:
488 p->rcvd_rstp = false;
491 case RAPID_SPANNING_TREE_BPDU:
502 port_receive_sm(struct rstp_port *p)
503 OVS_REQUIRES(rstp_mutex)
505 enum port_receive_state_machine old_state;
508 old_state = p->port_receive_sm_state;
511 switch (p->port_receive_sm_state) {
512 case PORT_RECEIVE_SM_INIT:
513 if (r->begin || ((p->rcvd_bpdu || (p->edge_delay_while !=
514 r->migrate_time)) && !p->port_enabled)) {
515 p->port_receive_sm_state = PORT_RECEIVE_SM_DISCARD_EXEC;
518 case PORT_RECEIVE_SM_DISCARD_EXEC:
519 p->rcvd_bpdu = p->rcvd_rstp = p->rcvd_stp = false;
521 p->edge_delay_while = r->migrate_time;
522 p->port_receive_sm_state = PORT_RECEIVE_SM_DISCARD;
524 case PORT_RECEIVE_SM_DISCARD:
525 if ((p->rcvd_bpdu || (p->edge_delay_while != r->migrate_time))
526 && !p->port_enabled) {
527 /* Global transition. */
528 p->port_receive_sm_state = PORT_RECEIVE_SM_DISCARD_EXEC;
529 } else if (p->rcvd_bpdu && p->port_enabled) {
530 p->port_receive_sm_state = PORT_RECEIVE_SM_RECEIVE_EXEC;
533 case PORT_RECEIVE_SM_RECEIVE_EXEC:
534 updt_bpdu_version(p);
535 p->oper_edge = p->rcvd_bpdu = false;
537 p->edge_delay_while = r->migrate_time;
538 p->port_receive_sm_state = PORT_RECEIVE_SM_RECEIVE;
540 case PORT_RECEIVE_SM_RECEIVE:
541 if ((p->rcvd_bpdu || (p->edge_delay_while != r->migrate_time))
542 && !p->port_enabled) {
543 /* Global transition. */
544 p->port_receive_sm_state = PORT_RECEIVE_SM_DISCARD_EXEC;
545 } else if (p->rcvd_bpdu && p->port_enabled && !p->rcvd_msg) {
546 p->port_receive_sm_state = PORT_RECEIVE_SM_RECEIVE_EXEC;
553 if (old_state != p->port_receive_sm_state) {
555 VLOG_DBG("%s, port %u: Port_receive_sm %d -> %d", p->rstp->name,
556 p->port_number, old_state, p->port_receive_sm_state);
561 /* [17.24 - Port Protocol Migration state machine] */
563 port_protocol_migration_sm(struct rstp_port *p)
564 OVS_REQUIRES(rstp_mutex)
566 enum port_protocol_migration_state_machine old_state;
569 old_state = p->port_protocol_migration_sm_state;
572 switch (p->port_protocol_migration_sm_state) {
573 case PORT_PROTOCOL_MIGRATION_SM_INIT:
574 p->port_protocol_migration_sm_state =
575 PORT_PROTOCOL_MIGRATION_SM_CHECKING_RSTP_EXEC;
577 case PORT_PROTOCOL_MIGRATION_SM_CHECKING_RSTP_EXEC:
579 p->send_rstp = r->rstp_version;
580 p->mdelay_while = r->migrate_time;
581 p->port_protocol_migration_sm_state =
582 PORT_PROTOCOL_MIGRATION_SM_CHECKING_RSTP;
584 case PORT_PROTOCOL_MIGRATION_SM_CHECKING_RSTP:
585 if (p->mdelay_while == 0) {
586 p->port_protocol_migration_sm_state =
587 PORT_PROTOCOL_MIGRATION_SM_SENSING_EXEC;
588 } else if ((p->mdelay_while != r->migrate_time) && !p->port_enabled) {
589 p->port_protocol_migration_sm_state =
590 PORT_PROTOCOL_MIGRATION_SM_CHECKING_RSTP_EXEC;
593 case PORT_PROTOCOL_MIGRATION_SM_SELECTING_STP_EXEC:
594 p->send_rstp = false;
595 p->mdelay_while = r->migrate_time;
596 p->port_protocol_migration_sm_state =
597 PORT_PROTOCOL_MIGRATION_SM_SELECTING_STP;
599 case PORT_PROTOCOL_MIGRATION_SM_SELECTING_STP:
600 if ((p->mdelay_while == 0) || (!p->port_enabled) || p->mcheck) {
601 p->port_protocol_migration_sm_state =
602 PORT_PROTOCOL_MIGRATION_SM_SENSING_EXEC;
605 case PORT_PROTOCOL_MIGRATION_SM_SENSING_EXEC:
606 p->rcvd_rstp = false;
608 p->port_protocol_migration_sm_state =
609 PORT_PROTOCOL_MIGRATION_SM_SENSING;
611 case PORT_PROTOCOL_MIGRATION_SM_SENSING:
612 if (!p->port_enabled || p->mcheck || ((r->rstp_version) &&
613 !p->send_rstp && p->rcvd_rstp)) {
614 p->port_protocol_migration_sm_state =
615 PORT_PROTOCOL_MIGRATION_SM_CHECKING_RSTP_EXEC;
616 } else if (p->send_rstp && p->rcvd_stp) {
617 p->port_protocol_migration_sm_state =
618 PORT_PROTOCOL_MIGRATION_SM_SELECTING_STP_EXEC;
625 if (old_state != p->port_protocol_migration_sm_state) {
627 VLOG_DBG("%s, port %u: port_protocol_migration_sm %d -> %d",
628 p->rstp->name, p->port_number, old_state,
629 p->port_protocol_migration_sm_state);
635 /* [17.25 - Bridge Detection state machine] */
637 bridge_detection_sm(struct rstp_port *p)
638 OVS_REQUIRES(rstp_mutex)
640 enum bridge_detection_state_machine old_state;
643 old_state = p->bridge_detection_sm_state;
646 switch (p->bridge_detection_sm_state) {
647 case BRIDGE_DETECTION_SM_INIT:
648 if (r->begin && p->admin_edge) {
649 p->bridge_detection_sm_state = BRIDGE_DETECTION_SM_EDGE_EXEC;
650 } else if (r->begin && !p->admin_edge) {
651 p->bridge_detection_sm_state = BRIDGE_DETECTION_SM_NOT_EDGE_EXEC;
654 case BRIDGE_DETECTION_SM_EDGE_EXEC:
656 p->bridge_detection_sm_state = BRIDGE_DETECTION_SM_EDGE;
658 case BRIDGE_DETECTION_SM_EDGE:
659 if ((!p->port_enabled && !p->admin_edge) || !p->oper_edge) {
660 p->bridge_detection_sm_state = BRIDGE_DETECTION_SM_NOT_EDGE_EXEC;
663 case BRIDGE_DETECTION_SM_NOT_EDGE_EXEC:
664 p->oper_edge = false;
665 p->bridge_detection_sm_state = BRIDGE_DETECTION_SM_NOT_EDGE;
667 case BRIDGE_DETECTION_SM_NOT_EDGE:
668 if ((!p->port_enabled && p->admin_edge)
669 || ((p->edge_delay_while == 0) && p->auto_edge && p->send_rstp
671 p->bridge_detection_sm_state = BRIDGE_DETECTION_SM_EDGE_EXEC;
678 if (old_state != p->bridge_detection_sm_state) {
680 VLOG_DBG("%s, port %u: bridge_detection_sm %d -> %d", p->rstp->name,
681 p->port_number, old_state, p->bridge_detection_sm_state);
686 /* [17.26 - Port Transmit state machine] */
688 rstp_send_bpdu(struct rstp_port *p, const void *bpdu, size_t bpdu_size)
689 OVS_REQUIRES(rstp_mutex)
691 struct eth_header *eth;
692 struct llc_header *llc;
693 struct dp_packet *pkt;
696 pkt = dp_packet_new(ETH_HEADER_LEN + LLC_HEADER_LEN + bpdu_size);
697 eth = dp_packet_put_zeros(pkt, sizeof *eth);
698 llc = dp_packet_put_zeros(pkt, sizeof *llc);
699 dp_packet_set_frame(pkt, eth);
700 dp_packet_set_l3(pkt, dp_packet_put(pkt, bpdu, bpdu_size));
703 memcpy(eth->eth_dst, eth_addr_stp, ETH_ADDR_LEN);
704 /* p->rstp->send_bpdu() must fill in source address. */
705 eth->eth_type = htons(dp_packet_size(pkt) - ETH_HEADER_LEN);
708 llc->llc_dsap = STP_LLC_DSAP;
709 llc->llc_ssap = STP_LLC_SSAP;
710 llc->llc_cntl = STP_LLC_CNTL;
711 p->rstp->send_bpdu(pkt, p->aux, p->rstp->aux);
715 record_agreement(struct rstp_port *p)
716 OVS_REQUIRES(rstp_mutex)
721 if (r->rstp_version && p->oper_point_to_point_mac &&
722 ((p->received_bpdu_buffer.flags & BPDU_FLAG_AGREEMENT))) {
724 p->proposing = false;
731 set_tc_flags(struct rstp_port *p)
732 OVS_REQUIRES(rstp_mutex)
734 /* Sets rcvd_tc and/or rcvd_tc_ack if the Topology Change and/or Topology
735 * Change Acknowledgment flags, respectively, are set in a ConfigBPDU or
738 if (p->received_bpdu_buffer.bpdu_type == CONFIGURATION_BPDU ||
739 p->received_bpdu_buffer.bpdu_type == RAPID_SPANNING_TREE_BPDU) {
740 if ((p->received_bpdu_buffer.flags & BPDU_FLAG_TOPCHANGE) != 0) {
743 if ((p->received_bpdu_buffer.flags & BPDU_FLAG_TOPCHANGEACK) != 0) {
744 p->rcvd_tc_ack = true;
747 /* Sets rcvd_tcn true if the BPDU is a TCN BPDU. */
748 if (p->received_bpdu_buffer.bpdu_type
749 == TOPOLOGY_CHANGE_NOTIFICATION_BPDU) {
755 record_dispute(struct rstp_port *p)
756 OVS_REQUIRES(rstp_mutex)
758 if ((p->received_bpdu_buffer.flags & BPDU_FLAG_LEARNING) != 0) {
759 /* 802.1D-2004 says to set the agreed flag and to clear the proposing
760 * flag. 802.1q-2008 instead says to set the disputed variable and to
761 * clear the agreed variable. */
768 record_proposal(struct rstp_port *p)
769 OVS_REQUIRES(rstp_mutex)
771 enum port_flag role =
772 ((p->received_bpdu_buffer.flags) & ROLE_FLAG_MASK) >> ROLE_FLAG_SHIFT;
774 if ((role == PORT_DES)
775 && ((p->received_bpdu_buffer.flags & BPDU_FLAG_PROPOSAL) != 0)) {
781 record_priority(struct rstp_port *p)
782 OVS_REQUIRES(rstp_mutex)
784 p->port_priority.root_bridge_id = p->msg_priority.root_bridge_id;
785 p->port_priority.root_path_cost = p->msg_priority.root_path_cost;
786 p->port_priority.designated_bridge_id =
787 p->msg_priority.designated_bridge_id;
788 p->port_priority.designated_port_id = p->msg_priority.designated_port_id;
792 record_times(struct rstp_port *p)
793 OVS_REQUIRES(rstp_mutex)
795 p->port_times = p->msg_times;
796 if (p->msg_times.hello_time == 0) {
797 p->port_times.hello_time = 1;
802 updt_rcvd_info_while(struct rstp_port *p)
803 OVS_REQUIRES(rstp_mutex)
806 * The value assigned to rcvdInfoWhile is the three times the Hello Time,
807 * if Message Age, incremented by 1 second and rounded to the nearest whole
808 * second, does not exceed Max Age, and is zero otherwise.
810 if (p->port_times.message_age < p->port_times.max_age) {
811 p->rcvd_info_while = p->port_times.hello_time * 3;
813 p->rcvd_info_while = 0;
817 /* Times are internally held in seconds, while the protocol uses 1/256 seconds.
818 * time_encode() is used to convert time values sent in bpdus, while
819 * time_decode() is used to convert time values received in bpdus.
822 time_encode(uint8_t value)
824 return htons(value * 256);
828 time_decode(ovs_be16 encoded)
830 return ntohs(encoded) / 256;
835 tx_config(struct rstp_port *p)
836 OVS_REQUIRES(rstp_mutex)
838 struct rstp_bpdu bpdu;
840 bpdu.protocol_identifier = htons(0);
841 bpdu.protocol_version_identifier = 0;
842 bpdu.bpdu_type = CONFIGURATION_BPDU;
843 bpdu.root_bridge_id = htonll(p->designated_priority_vector.root_bridge_id);
844 bpdu.root_path_cost = htonl(p->designated_priority_vector.root_path_cost);
845 bpdu.designated_bridge_id =
846 htonll(p->designated_priority_vector.designated_bridge_id);
847 bpdu.designated_port_id =
848 htons(p->designated_priority_vector.designated_port_id);
849 bpdu.message_age = time_encode(p->designated_times.message_age);
850 bpdu.max_age = time_encode(p->designated_times.max_age);
851 bpdu.hello_time = time_encode(p->designated_times.hello_time);
852 bpdu.forward_delay = time_encode(p->designated_times.forward_delay);
854 if (p->tc_while != 0) {
855 bpdu.flags |= BPDU_FLAG_TOPCHANGE;
857 if (p->tc_ack != 0) {
858 bpdu.flags |= BPDU_FLAG_TOPCHANGEACK;
860 rstp_send_bpdu(p, &bpdu, sizeof(struct rstp_bpdu));
865 tx_rstp(struct rstp_port *p)
866 OVS_REQUIRES(rstp_mutex)
868 struct rstp_bpdu bpdu;
870 bpdu.protocol_identifier = htons(0);
871 bpdu.protocol_version_identifier = 2;
872 bpdu.bpdu_type = RAPID_SPANNING_TREE_BPDU;
873 bpdu.root_bridge_id = htonll(p->designated_priority_vector.root_bridge_id);
874 bpdu.root_path_cost = htonl(p->designated_priority_vector.root_path_cost);
875 bpdu.designated_bridge_id =
876 htonll(p->designated_priority_vector.designated_bridge_id);
877 bpdu.designated_port_id =
878 htons(p->designated_priority_vector.designated_port_id);
879 bpdu.message_age = time_encode(p->designated_times.message_age);
880 bpdu.max_age = time_encode(p->designated_times.max_age);
881 bpdu.hello_time = time_encode(p->designated_times.hello_time);
882 bpdu.forward_delay = time_encode(p->designated_times.forward_delay);
887 bpdu.flags = PORT_ROOT << ROLE_FLAG_SHIFT;
889 case ROLE_DESIGNATED:
890 bpdu.flags = PORT_DES << ROLE_FLAG_SHIFT;
894 bpdu.flags = PORT_ALT_BACK << ROLE_FLAG_SHIFT;
897 /* Should not happen! */
898 VLOG_ERR("%s transmitting bpdu in disabled role on port "
899 RSTP_PORT_ID_FMT, p->rstp->name, p->port_id);
903 bpdu.flags |= BPDU_FLAG_AGREEMENT;
906 bpdu.flags |= BPDU_FLAG_PROPOSAL;
908 if (p->tc_while != 0) {
909 bpdu.flags |= BPDU_FLAG_TOPCHANGE;
912 bpdu.flags |= BPDU_FLAG_LEARNING;
915 bpdu.flags |= BPDU_FLAG_FORWARDING;
917 bpdu.version1_length = 0;
918 rstp_send_bpdu(p, &bpdu, sizeof(struct rstp_bpdu));
923 tx_tcn(struct rstp_port *p)
924 OVS_REQUIRES(rstp_mutex)
926 struct rstp_bpdu bpdu;
928 memset(&bpdu, 0, sizeof(struct rstp_bpdu));
930 bpdu.protocol_identifier = htons(0);
931 bpdu.protocol_version_identifier = 0;
932 bpdu.bpdu_type = TOPOLOGY_CHANGE_NOTIFICATION_BPDU;
933 rstp_send_bpdu(p, &bpdu, sizeof(struct rstp_bpdu));
937 port_transmit_sm(struct rstp_port *p)
938 OVS_REQUIRES(rstp_mutex)
940 enum port_transmit_state_machine old_state;
943 old_state = p->port_transmit_sm_state;
946 switch (p->port_transmit_sm_state) {
947 case PORT_TRANSMIT_SM_INIT:
949 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_INIT_EXEC;
952 case PORT_TRANSMIT_SM_TRANSMIT_INIT_EXEC:
955 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_INIT;
957 case PORT_TRANSMIT_SM_TRANSMIT_INIT:
958 p->port_transmit_sm_state = PORT_TRANSMIT_SM_IDLE_EXEC;
960 case PORT_TRANSMIT_SM_TRANSMIT_PERIODIC_EXEC:
961 p->new_info = p->new_info || (p->role == ROLE_DESIGNATED ||
962 (p->role == ROLE_ROOT && p->tc_while != 0));
963 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_PERIODIC;
965 case PORT_TRANSMIT_SM_TRANSMIT_PERIODIC:
966 p->port_transmit_sm_state = PORT_TRANSMIT_SM_IDLE_EXEC;
968 case PORT_TRANSMIT_SM_IDLE_EXEC:
969 p->hello_when = r->bridge_hello_time;
970 p->port_transmit_sm_state = PORT_TRANSMIT_SM_IDLE;
972 case PORT_TRANSMIT_SM_IDLE:
973 if (p->role == ROLE_DISABLED) {
974 VLOG_DBG("%s, port %u: port_transmit_sm ROLE == DISABLED.",
975 p->rstp->name, p->port_number);
977 } else if (p->send_rstp && p->new_info
978 && p->tx_count < r->transmit_hold_count
979 && p->hello_when != 0 && p->selected && !p->updt_info) {
980 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_RSTP_EXEC;
981 } else if (p->hello_when == 0 && p->selected && !p->updt_info) {
982 p->port_transmit_sm_state =
983 PORT_TRANSMIT_SM_TRANSMIT_PERIODIC_EXEC;
984 } else if (!p->send_rstp && p->new_info && p->role == ROLE_ROOT
985 && p->tx_count < r->transmit_hold_count
986 && p->hello_when != 0 && p->selected && !p->updt_info) {
987 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_TCN_EXEC;
988 } else if (!p->send_rstp && p->new_info && p->role == ROLE_DESIGNATED
989 && p->tx_count < r->transmit_hold_count
990 && p->hello_when != 0 && p->selected && !p->updt_info) {
991 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_CONFIG_EXEC;
994 case PORT_TRANSMIT_SM_TRANSMIT_CONFIG_EXEC:
999 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_CONFIG;
1001 case PORT_TRANSMIT_SM_TRANSMIT_CONFIG:
1002 p->port_transmit_sm_state = PORT_TRANSMIT_SM_IDLE_EXEC;
1004 case PORT_TRANSMIT_SM_TRANSMIT_TCN_EXEC:
1005 p->new_info = false;
1008 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_TCN;
1010 case PORT_TRANSMIT_SM_TRANSMIT_TCN:
1011 p->port_transmit_sm_state = PORT_TRANSMIT_SM_IDLE_EXEC;
1013 case PORT_TRANSMIT_SM_TRANSMIT_RSTP_EXEC:
1014 p->new_info = false;
1018 p->port_transmit_sm_state = PORT_TRANSMIT_SM_TRANSMIT_RSTP;
1020 case PORT_TRANSMIT_SM_TRANSMIT_RSTP:
1021 p->port_transmit_sm_state = PORT_TRANSMIT_SM_IDLE_EXEC;
1027 if (old_state != p->port_transmit_sm_state) {
1029 VLOG_DBG("%s, port %u: port_transmit_sm %d -> %d", p->rstp->name,
1030 p->port_number, old_state, p->port_transmit_sm_state);
1035 /* [17.27 Port Information state machine] */
1040 rcv_info(struct rstp_port *p)
1041 OVS_REQUIRES(rstp_mutex)
1043 enum vector_comparison cp;
1045 enum port_flag role;
1047 p->msg_priority.root_bridge_id =
1048 ntohll(p->received_bpdu_buffer.root_bridge_id);
1049 p->msg_priority.root_path_cost =
1050 ntohl(p->received_bpdu_buffer.root_path_cost);
1051 p->msg_priority.designated_bridge_id =
1052 ntohll(p->received_bpdu_buffer.designated_bridge_id);
1053 p->msg_priority.designated_port_id =
1054 ntohs(p->received_bpdu_buffer.designated_port_id);
1056 p->msg_times.forward_delay =
1057 time_decode(p->received_bpdu_buffer.forward_delay);
1058 p->msg_times.hello_time = time_decode(p->received_bpdu_buffer.hello_time);
1059 p->msg_times.max_age = time_decode(p->received_bpdu_buffer.max_age);
1060 p->msg_times.message_age =
1061 time_decode(p->received_bpdu_buffer.message_age);
1063 cp = compare_rstp_priority_vectors(&p->msg_priority, &p->port_priority);
1064 ct = rstp_times_equal(&p->port_times, &p->msg_times);
1065 /* Configuration BPDU conveys a Designated Port Role. */
1066 if (p->received_bpdu_buffer.bpdu_type == CONFIGURATION_BPDU) {
1070 (p->received_bpdu_buffer.flags & ROLE_FLAG_MASK) >> ROLE_FLAG_SHIFT;
1073 /* 802.1D-2004 does not report this behaviour.
1074 * 802.1Q-2008 says set rcvdTcn. */
1075 if (p->received_bpdu_buffer.bpdu_type ==
1076 TOPOLOGY_CHANGE_NOTIFICATION_BPDU) {
1081 /* Returns SuperiorDesignatedInfo if:
1082 * a) The received message conveys a Designated Port Role, and
1083 * 1) The message priority is superior (17.6) to the Port.s port priority
1085 * 2) The message priority vector is the same as the Port.s port priority
1086 * vector, and any of the received timer parameter values (msg_times.
1087 * 17.19.15) differ from those already held for the Port (port_times
1089 * NOTE: Configuration BPDU explicitly conveys a Designated Port Role.
1091 if (role == PORT_DES && (cp == SUPERIOR || (cp == SAME && ct == false))) {
1092 return SUPERIOR_DESIGNATED_INFO;
1094 /* Returns RepeatedDesignatedInfo if:
1095 * b) The received message conveys Designated Port Role, and a message
1096 * priority vector and timer parameters that are the same as the
1097 * Port's port priority vector or timer values. */
1098 } else if (role == PORT_DES && cp == SAME && ct == true) {
1099 return REPEATED_DESIGNATED_INFO;
1101 /* Returns InferiorDesignatedInfo if:
1102 * c) The received message conveys a Designated Port Role, and a
1103 * message priority vector that is worse than the Port's port
1104 * priority vector. */
1105 } else if (role == PORT_DES && cp == INFERIOR) {
1106 return INFERIOR_DESIGNATED_INFO;
1108 /* Returns InferiorRootAlternateInfo if:
1109 * d) The received message conveys a Root Port, Alternate Port, or
1110 * Backup Port Role and a message priority that is the same as or
1111 * worse than the port priority vector. */
1112 } else if ((role == PORT_ROOT || role == PORT_ALT_BACK) &&
1113 (cp == INFERIOR || cp == SAME)) {
1114 return INFERIOR_ROOT_ALTERNATE_INFO;
1116 /* Otherwise, returns OtherInfo. */
1123 better_or_same_info(struct rstp_port *p, int new_info_is)
1124 OVS_REQUIRES(rstp_mutex)
1127 (new_info_is == RECEIVED && p->info_is == INFO_IS_RECEIVED
1128 && compare_rstp_priority_vectors(&p->msg_priority,
1130 || (new_info_is == MINE && p->info_is == INFO_IS_MINE
1131 && compare_rstp_priority_vectors(&p->designated_priority_vector,
1132 &p->port_priority));
1136 port_information_sm(struct rstp_port *p)
1137 OVS_REQUIRES(rstp_mutex)
1139 enum port_information_state_machine old_state;
1141 struct rstp_port *p1;
1143 old_state = p->port_information_sm_state;
1146 switch (p->port_information_sm_state) {
1147 case PORT_INFORMATION_SM_INIT:
1149 || (!p->port_enabled && p->info_is != INFO_IS_DISABLED)) {
1150 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1153 case PORT_INFORMATION_SM_DISABLED_EXEC:
1154 p->rcvd_msg = false;
1155 p->proposing = p->proposed = p->agree = p->agreed = false;
1156 p->rcvd_info_while = 0;
1157 p->info_is = INFO_IS_DISABLED;
1159 p->selected = false;
1160 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED;
1162 case PORT_INFORMATION_SM_DISABLED:
1163 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1164 /* Global transition. */
1165 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1166 } else if (p->port_enabled) {
1167 p->port_information_sm_state = PORT_INFORMATION_SM_AGED_EXEC;
1168 } else if (p->rcvd_msg) {
1169 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1172 case PORT_INFORMATION_SM_AGED_EXEC:
1173 p->info_is = INFO_IS_AGED;
1175 p->selected = false;
1176 p->port_information_sm_state = PORT_INFORMATION_SM_AGED;
1178 case PORT_INFORMATION_SM_AGED:
1179 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1180 /* Global transition. */
1181 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1182 } else if (p->selected && p->updt_info) {
1183 p->port_information_sm_state = PORT_INFORMATION_SM_UPDATE_EXEC;
1186 case PORT_INFORMATION_SM_UPDATE_EXEC:
1187 p->proposing = p->proposed = false;
1188 /* MINE is not specified in Standard 802.1D-2004. */
1189 p->agreed = p->agreed && better_or_same_info(p, MINE);
1190 p->synced = p->synced && p->agreed;
1191 p->port_priority.root_bridge_id =
1192 p->designated_priority_vector.root_bridge_id;
1193 p->port_priority.root_path_cost =
1194 p->designated_priority_vector.root_path_cost;
1195 p->port_priority.designated_bridge_id =
1196 p->designated_priority_vector.designated_bridge_id;
1197 p->port_priority.designated_port_id =
1198 p->designated_priority_vector.designated_port_id;
1199 p->port_times = p->designated_times;
1200 p->updt_info = false;
1201 p->info_is = INFO_IS_MINE;
1203 p->port_information_sm_state = PORT_INFORMATION_SM_UPDATE;
1205 case PORT_INFORMATION_SM_UPDATE:
1206 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1207 /* Global transition. */
1208 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1210 p->port_information_sm_state = PORT_INFORMATION_SM_CURRENT_EXEC;
1213 case PORT_INFORMATION_SM_CURRENT_EXEC:
1214 p->port_information_sm_state = PORT_INFORMATION_SM_CURRENT;
1216 case PORT_INFORMATION_SM_CURRENT:
1217 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1218 /* Global transition. */
1219 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1220 } else if (p->rcvd_msg && !p->updt_info) {
1221 p->port_information_sm_state = PORT_INFORMATION_SM_RECEIVE_EXEC;
1222 } else if (p->selected && p->updt_info) {
1223 p->port_information_sm_state = PORT_INFORMATION_SM_UPDATE_EXEC;
1224 } else if ((p->info_is == INFO_IS_RECEIVED) &&
1225 (p->rcvd_info_while == 0) && !p->updt_info &&
1227 p->port_information_sm_state = PORT_INFORMATION_SM_AGED_EXEC;
1230 case PORT_INFORMATION_SM_RECEIVE_EXEC:
1231 p->rcvd_info = rcv_info(p);
1232 p->port_information_sm_state = PORT_INFORMATION_SM_RECEIVE;
1234 case PORT_INFORMATION_SM_RECEIVE:
1235 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1236 /* Global transition. */
1237 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1239 switch (p->rcvd_info) {
1240 case SUPERIOR_DESIGNATED_INFO:
1241 /* 802.1q-2008 has a checkBPDUConsistency() function, called on
1242 * a BPDU reception. checkBPDUConsistency() clears the agreed
1243 * variable if the received message priority vector is superior
1244 * to the port priority vector, the BPDU is an ST BPDU or an
1245 * RST BPDU, its port role is Designated and its Learning flag
1247 if (p->received_bpdu_buffer.flags & BPDU_FLAG_LEARNING) {
1248 HMAP_FOR_EACH (p1, node, &r->ports) {
1249 if (p1->port_number != p->port_number) {
1254 p->port_information_sm_state =
1255 PORT_INFORMATION_SM_SUPERIOR_DESIGNATED_EXEC;
1257 case REPEATED_DESIGNATED_INFO:
1258 p->port_information_sm_state =
1259 PORT_INFORMATION_SM_REPEATED_DESIGNATED_EXEC;
1261 case INFERIOR_DESIGNATED_INFO:
1262 p->port_information_sm_state =
1263 PORT_INFORMATION_SM_INFERIOR_DESIGNATED_EXEC;
1265 case INFERIOR_ROOT_ALTERNATE_INFO:
1266 p->port_information_sm_state =
1267 PORT_INFORMATION_SM_NOT_DESIGNATED_EXEC;
1270 p->port_information_sm_state = PORT_INFORMATION_SM_OTHER_EXEC;
1278 case PORT_INFORMATION_SM_OTHER_EXEC:
1279 p->rcvd_msg = false;
1280 p->port_information_sm_state = PORT_INFORMATION_SM_OTHER;
1282 case PORT_INFORMATION_SM_OTHER:
1283 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1284 /* Global transition. */
1285 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1287 p->port_information_sm_state = PORT_INFORMATION_SM_CURRENT_EXEC;
1290 case PORT_INFORMATION_SM_NOT_DESIGNATED_EXEC:
1291 record_agreement(p);
1293 p->rcvd_msg = false;
1294 p->port_information_sm_state = PORT_INFORMATION_SM_NOT_DESIGNATED;
1296 case PORT_INFORMATION_SM_NOT_DESIGNATED:
1297 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1298 /* Global transition. */
1299 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1301 p->port_information_sm_state = PORT_INFORMATION_SM_CURRENT_EXEC;
1304 case PORT_INFORMATION_SM_INFERIOR_DESIGNATED_EXEC:
1306 p->rcvd_msg = false;
1307 p->port_information_sm_state = PORT_INFORMATION_SM_INFERIOR_DESIGNATED;
1309 case PORT_INFORMATION_SM_INFERIOR_DESIGNATED:
1310 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1311 /* Global transition. */
1312 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1314 p->port_information_sm_state = PORT_INFORMATION_SM_CURRENT_EXEC;
1317 case PORT_INFORMATION_SM_REPEATED_DESIGNATED_EXEC:
1320 /* This record_agreement() is missing in 802.1D-2004, but it's present
1321 * in 802.1q-2008. */
1322 record_agreement(p);
1323 updt_rcvd_info_while(p);
1324 p->rcvd_msg = false;
1325 p->port_information_sm_state = PORT_INFORMATION_SM_REPEATED_DESIGNATED;
1327 case PORT_INFORMATION_SM_REPEATED_DESIGNATED:
1328 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1329 /* Global transition. */
1330 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1332 p->port_information_sm_state = PORT_INFORMATION_SM_CURRENT_EXEC;
1335 case PORT_INFORMATION_SM_SUPERIOR_DESIGNATED_EXEC:
1336 p->agreed = p->proposing = false;
1339 /* RECEIVED is not specified in Standard 802.1D-2004. */
1340 p->agree = p->agree && better_or_same_info(p, RECEIVED);
1341 /* This record_agreement() and the synced assignment are missing in
1342 * 802.1D-2004, but they're present in 802.1q-2008. */
1343 record_agreement(p);
1344 p->synced = p->synced && p->agreed;
1347 updt_rcvd_info_while(p);
1348 p->info_is = INFO_IS_RECEIVED;
1350 p->selected = false;
1351 p->rcvd_msg = false;
1352 p->port_information_sm_state = PORT_INFORMATION_SM_SUPERIOR_DESIGNATED;
1354 case PORT_INFORMATION_SM_SUPERIOR_DESIGNATED:
1355 if (!p->port_enabled && p->info_is != INFO_IS_DISABLED) {
1356 /* Global transition. */
1357 p->port_information_sm_state = PORT_INFORMATION_SM_DISABLED_EXEC;
1359 p->port_information_sm_state = PORT_INFORMATION_SM_CURRENT_EXEC;
1366 if (old_state != p->port_information_sm_state) {
1368 VLOG_DBG("%s, port %u: Port_information_sm %d -> %d", p->rstp->name,
1369 p->port_number, old_state, p->port_information_sm_state);
1374 /* [17.29 Port Role Transitions state machine] */
1377 set_re_root_tree(struct rstp_port *p)
1378 OVS_REQUIRES(rstp_mutex)
1381 struct rstp_port *p1;
1384 HMAP_FOR_EACH (p1, node, &r->ports) {
1390 set_sync_tree(struct rstp_port *p)
1391 OVS_REQUIRES(rstp_mutex)
1394 struct rstp_port *p1;
1397 HMAP_FOR_EACH (p1, node, &r->ports) {
1403 hello_time(struct rstp_port *p)
1404 OVS_REQUIRES(rstp_mutex)
1406 return p->designated_times.hello_time;
1410 fwd_delay(struct rstp_port *p)
1411 OVS_REQUIRES(rstp_mutex)
1413 return p->designated_times.forward_delay;
1417 forward_delay(struct rstp_port *p)
1418 OVS_REQUIRES(rstp_mutex)
1421 return hello_time(p);
1423 return fwd_delay(p);
1428 edge_delay(struct rstp_port *p)
1429 OVS_REQUIRES(rstp_mutex)
1434 if (p->oper_point_to_point_mac == 1) {
1435 return r->migrate_time;
1437 return p->designated_times.max_age;
1442 check_selected_role_change(struct rstp_port *p, int current_role_state)
1443 OVS_REQUIRES(rstp_mutex)
1445 if (p->selected && !p->updt_info && p->role != p->selected_role
1446 && p->selected_role != current_role_state) {
1447 VLOG_DBG("%s, port %u: case: current = %s role = %s selected = %d",
1448 p->rstp->name, p->port_number,
1449 rstp_port_role_name(current_role_state),
1450 rstp_port_role_name(p->role), p->selected_role);
1451 switch (p->selected_role) {
1453 p->port_role_transition_sm_state =
1454 PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC;
1456 case ROLE_DESIGNATED:
1457 p->port_role_transition_sm_state =
1458 PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT_EXEC;
1460 case ROLE_ALTERNATE:
1461 p->port_role_transition_sm_state =
1462 PORT_ROLE_TRANSITION_SM_BLOCK_PORT_EXEC;
1465 p->port_role_transition_sm_state =
1466 PORT_ROLE_TRANSITION_SM_BLOCK_PORT_EXEC;
1469 p->port_role_transition_sm_state =
1470 PORT_ROLE_TRANSITION_SM_DISABLE_PORT_EXEC;
1478 re_rooted(struct rstp_port *p)
1479 OVS_REQUIRES(rstp_mutex)
1482 struct rstp_port *p1;
1485 HMAP_FOR_EACH (p1, node, &r->ports) {
1486 if ((p1 != p) && (p1->rr_while != 0)) {
1494 all_synced(struct rstp *r)
1495 OVS_REQUIRES(rstp_mutex)
1497 struct rstp_port *p;
1499 HMAP_FOR_EACH (p, node, &r->ports) {
1500 if (!(p->selected && p->role == p->selected_role &&
1501 (p->role == ROLE_ROOT || p->synced == true))) {
1509 port_role_transition_sm(struct rstp_port *p)
1510 OVS_REQUIRES(rstp_mutex)
1512 enum port_role_transition_state_machine old_state;
1514 enum rstp_port_role last_role;
1516 old_state = p->port_role_transition_sm_state;
1518 last_role = p->role;
1520 switch (p->port_role_transition_sm_state) {
1521 case PORT_ROLE_TRANSITION_SM_INIT:
1523 p->port_role_transition_sm_state =
1524 PORT_ROLE_TRANSITION_SM_INIT_PORT_EXEC;
1527 case PORT_ROLE_TRANSITION_SM_INIT_PORT_EXEC:
1528 p->role = ROLE_DISABLED;
1529 p->learn = p->forward = false;
1531 p->sync = p->re_root = true;
1532 p->rr_while = p->designated_times.forward_delay;
1533 p->fd_while = p->designated_times.max_age;
1535 p->port_role_transition_sm_state =
1536 PORT_ROLE_TRANSITION_SM_DISABLE_PORT_EXEC;
1538 case PORT_ROLE_TRANSITION_SM_DISABLE_PORT_EXEC:
1539 p->role = p->selected_role;
1540 p->learn = p->forward = false;
1541 p->port_role_transition_sm_state =
1542 PORT_ROLE_TRANSITION_SM_DISABLE_PORT;
1544 case PORT_ROLE_TRANSITION_SM_DISABLE_PORT:
1545 if (check_selected_role_change(p, ROLE_DISABLED)) {
1546 /* Global transition. */
1547 } else if (p->selected && !p->updt_info && !p->learning
1548 && !p->forwarding) {
1549 p->port_role_transition_sm_state =
1550 PORT_ROLE_TRANSITION_SM_DISABLED_PORT_EXEC;
1553 case PORT_ROLE_TRANSITION_SM_DISABLED_PORT_EXEC:
1554 p->fd_while = p->designated_times.max_age;
1557 p->sync = p->re_root = false;
1558 p->port_role_transition_sm_state =
1559 PORT_ROLE_TRANSITION_SM_DISABLED_PORT;
1561 case PORT_ROLE_TRANSITION_SM_DISABLED_PORT:
1562 if (check_selected_role_change(p, ROLE_DISABLED)) {
1563 /* Global transition. */
1564 } else if (p->selected && !p->updt_info
1565 && (p->fd_while != p->designated_times.max_age || p->sync
1566 || p->re_root || !p->synced)) {
1567 p->port_role_transition_sm_state =
1568 PORT_ROLE_TRANSITION_SM_DISABLED_PORT_EXEC;
1571 case PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC:
1572 p->role = ROLE_ROOT;
1573 p->rr_while = p->designated_times.forward_delay;
1574 p->port_role_transition_sm_state = PORT_ROLE_TRANSITION_SM_ROOT_PORT;
1576 case PORT_ROLE_TRANSITION_SM_ROOT_PORT:
1577 if (check_selected_role_change(p, ROLE_ROOT)) {
1578 /* Global transition. */
1579 } else if (p->selected && !p->updt_info) {
1580 if (p->rr_while != p->designated_times.forward_delay) {
1581 p->port_role_transition_sm_state =
1582 PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC;
1584 } else if (p->re_root && p->forward) {
1585 p->port_role_transition_sm_state =
1586 PORT_ROLE_TRANSITION_SM_REROOTED_EXEC;
1588 } else if ((p->fd_while == 0
1589 || ((re_rooted(p) && p->rb_while == 0)
1590 && r->rstp_version)) && !p->learn) {
1591 p->port_role_transition_sm_state =
1592 PORT_ROLE_TRANSITION_SM_ROOT_LEARN_EXEC;
1594 } else if ((p->fd_while == 0
1595 || ((re_rooted(p) && p->rb_while == 0)
1596 && r->rstp_version)) && p->learn && !p->forward) {
1597 p->port_role_transition_sm_state =
1598 PORT_ROLE_TRANSITION_SM_ROOT_FORWARD_EXEC;
1600 } else if (p->proposed && !p->agree) {
1601 p->port_role_transition_sm_state =
1602 PORT_ROLE_TRANSITION_SM_ROOT_PROPOSED_EXEC;
1604 } else if ((all_synced(r) && !p->agree) ||
1605 (p->proposed && p->agree)) {
1606 p->port_role_transition_sm_state =
1607 PORT_ROLE_TRANSITION_SM_ROOT_AGREED_EXEC;
1609 } else if (!p->forward && !p->re_root) {
1610 p->port_role_transition_sm_state =
1611 PORT_ROLE_TRANSITION_SM_REROOT_EXEC;
1616 case PORT_ROLE_TRANSITION_SM_REROOT_EXEC:
1617 if (check_selected_role_change(p, ROLE_ROOT)) {
1618 /* Global transition. */
1620 set_re_root_tree(p);
1621 p->port_role_transition_sm_state =
1622 PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC;
1625 case PORT_ROLE_TRANSITION_SM_ROOT_AGREED_EXEC:
1626 if (check_selected_role_change(p, ROLE_ROOT)) {
1627 /* Global transition. */
1629 p->proposed = p->sync = false;
1630 p->agree = p->new_info = true;
1631 p->port_role_transition_sm_state =
1632 PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC;
1635 case PORT_ROLE_TRANSITION_SM_ROOT_PROPOSED_EXEC:
1637 p->proposed = false;
1638 if (check_selected_role_change(p, ROLE_ROOT)) {
1639 /* Global transition. */
1641 p->port_role_transition_sm_state =
1642 PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC;
1645 case PORT_ROLE_TRANSITION_SM_ROOT_FORWARD_EXEC:
1648 if (check_selected_role_change(p, ROLE_ROOT)) {
1649 /* Global transition. */
1651 p->port_role_transition_sm_state =
1652 PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC;
1655 case PORT_ROLE_TRANSITION_SM_ROOT_LEARN_EXEC:
1656 p->fd_while = forward_delay(p);
1658 if (check_selected_role_change(p, ROLE_ROOT)) {
1659 /* Global transition. */
1661 p->port_role_transition_sm_state =
1662 PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC;
1665 case PORT_ROLE_TRANSITION_SM_REROOTED_EXEC:
1667 if (check_selected_role_change(p, ROLE_ROOT)) {
1668 /* Global transition. */
1670 p->port_role_transition_sm_state =
1671 PORT_ROLE_TRANSITION_SM_ROOT_PORT_EXEC;
1674 case PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT_EXEC:
1675 p->role = ROLE_DESIGNATED;
1676 p->port_role_transition_sm_state =
1677 PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT;
1679 case PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT:
1680 if (check_selected_role_change(p, ROLE_DESIGNATED)) {
1681 /* Global transition. */
1682 } else if (p->selected && !p->updt_info) {
1683 if (((p->sync && !p->synced)
1684 || (p->re_root && p->rr_while != 0) || p->disputed)
1685 && !p->oper_edge && (p->learn || p->forward)) {
1686 p->port_role_transition_sm_state =
1687 PORT_ROLE_TRANSITION_SM_DESIGNATED_DISCARD_EXEC;
1688 } else if ((p->fd_while == 0 || p->agreed || p->oper_edge)
1689 && (p->rr_while == 0 || !p->re_root)
1690 && !p->sync && !p->learn) {
1691 p->port_role_transition_sm_state =
1692 PORT_ROLE_TRANSITION_SM_DESIGNATED_LEARN_EXEC;
1693 } else if ((p->fd_while == 0 || p->agreed || p->oper_edge)
1694 && (p->rr_while == 0 || !p->re_root)
1695 && !p->sync && (p->learn && !p->forward)) {
1696 p->port_role_transition_sm_state =
1697 PORT_ROLE_TRANSITION_SM_DESIGNATED_FORWARD_EXEC;
1698 } else if (!p->forward && !p->agreed && !p->proposing &&
1700 p->port_role_transition_sm_state =
1701 PORT_ROLE_TRANSITION_SM_DESIGNATED_PROPOSE_EXEC;
1702 } else if ((!p->learning && !p->forwarding && !p->synced)
1703 || (p->agreed && !p->synced)
1704 || (p->oper_edge && !p->synced)
1705 || (p->sync && p->synced)) {
1706 p->port_role_transition_sm_state =
1707 PORT_ROLE_TRANSITION_SM_DESIGNATED_SYNCED_EXEC;
1708 } else if (p->rr_while == 0 && p->re_root) {
1709 p->port_role_transition_sm_state =
1710 PORT_ROLE_TRANSITION_SM_DESIGNATED_RETIRED_EXEC;
1714 case PORT_ROLE_TRANSITION_SM_DESIGNATED_RETIRED_EXEC:
1716 if (check_selected_role_change(p, ROLE_DESIGNATED)) {
1717 /* Global transition. */
1719 p->port_role_transition_sm_state =
1720 PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT_EXEC;
1723 case PORT_ROLE_TRANSITION_SM_DESIGNATED_SYNCED_EXEC:
1727 if (check_selected_role_change(p, ROLE_DESIGNATED)) {
1728 /* Global transition. */
1730 p->port_role_transition_sm_state =
1731 PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT_EXEC;
1734 case PORT_ROLE_TRANSITION_SM_DESIGNATED_PROPOSE_EXEC:
1735 p->proposing = true;
1736 p->edge_delay_while = edge_delay(p);
1738 if (check_selected_role_change(p, ROLE_DESIGNATED)) {
1739 /* Global transition. */
1741 p->port_role_transition_sm_state =
1742 PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT_EXEC;
1745 case PORT_ROLE_TRANSITION_SM_DESIGNATED_FORWARD_EXEC:
1748 p->agreed = p->send_rstp;
1749 if (check_selected_role_change(p, ROLE_DESIGNATED)) {
1750 /* Global transition. */
1752 p->port_role_transition_sm_state =
1753 PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT_EXEC;
1756 case PORT_ROLE_TRANSITION_SM_DESIGNATED_LEARN_EXEC:
1758 p->fd_while = forward_delay(p);
1759 if (check_selected_role_change(p, ROLE_DESIGNATED)) {
1760 /* Global transition. */
1762 p->port_role_transition_sm_state =
1763 PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT_EXEC;
1766 case PORT_ROLE_TRANSITION_SM_DESIGNATED_DISCARD_EXEC:
1767 p->learn = p->forward = p->disputed = false;
1768 p->fd_while = forward_delay(p);
1769 if (check_selected_role_change(p, ROLE_DESIGNATED)) {
1770 /* Global transition. */
1772 p->port_role_transition_sm_state =
1773 PORT_ROLE_TRANSITION_SM_DESIGNATED_PORT_EXEC;
1776 case PORT_ROLE_TRANSITION_SM_ALTERNATE_PORT_EXEC:
1777 p->fd_while = p->designated_times.forward_delay;
1780 p->sync = p->re_root = false;
1781 p->port_role_transition_sm_state =
1782 PORT_ROLE_TRANSITION_SM_ALTERNATE_PORT;
1784 case PORT_ROLE_TRANSITION_SM_ALTERNATE_PORT:
1785 if (check_selected_role_change(p, ROLE_ALTERNATE)) {
1786 /* Global transition. */
1787 } else if (p->selected && !p->updt_info) {
1788 if (p->rb_while != 2 * p->designated_times.hello_time
1789 && p->role == ROLE_BACKUP) {
1790 p->port_role_transition_sm_state =
1791 PORT_ROLE_TRANSITION_SM_BACKUP_PORT_EXEC;
1792 } else if ((p->fd_while != forward_delay(p)) || p->sync
1793 || p->re_root || !p->synced) {
1794 p->port_role_transition_sm_state =
1795 PORT_ROLE_TRANSITION_SM_ALTERNATE_PORT_EXEC;
1796 } else if (p->proposed && !p->agree) {
1797 p->port_role_transition_sm_state =
1798 PORT_ROLE_TRANSITION_SM_ALTERNATE_PROPOSED_EXEC;
1799 } else if ((all_synced(r) && !p->agree)
1800 || (p->proposed && p->agree)) {
1801 p->port_role_transition_sm_state =
1802 PORT_ROLE_TRANSITION_SM_ALTERNATE_AGREED_EXEC;
1806 case PORT_ROLE_TRANSITION_SM_ALTERNATE_AGREED_EXEC:
1807 p->proposed = false;
1810 if (check_selected_role_change(p, ROLE_ALTERNATE)) {
1811 /* Global transition. */
1813 p->port_role_transition_sm_state =
1814 PORT_ROLE_TRANSITION_SM_ALTERNATE_PORT_EXEC;
1817 case PORT_ROLE_TRANSITION_SM_ALTERNATE_PROPOSED_EXEC:
1819 p->proposed = false;
1820 if (check_selected_role_change(p, ROLE_ALTERNATE)) {
1821 /* Global transition. */
1823 p->port_role_transition_sm_state =
1824 PORT_ROLE_TRANSITION_SM_ALTERNATE_PORT_EXEC;
1827 case PORT_ROLE_TRANSITION_SM_BLOCK_PORT_EXEC:
1828 p->role = p->selected_role;
1829 p->learn = p->forward = false;
1830 p->port_role_transition_sm_state = PORT_ROLE_TRANSITION_SM_BLOCK_PORT;
1832 case PORT_ROLE_TRANSITION_SM_BLOCK_PORT:
1833 if (check_selected_role_change(p, ROLE_ALTERNATE)) {
1834 /* Global transition. */
1835 } else if (p->selected && !p->updt_info && !p->learning &&
1837 p->port_role_transition_sm_state =
1838 PORT_ROLE_TRANSITION_SM_ALTERNATE_PORT_EXEC;
1841 case PORT_ROLE_TRANSITION_SM_BACKUP_PORT_EXEC:
1842 p->rb_while = 2 * p->designated_times.hello_time;
1843 if (check_selected_role_change(p, ROLE_ALTERNATE)) {
1844 /* Global transition. */
1846 p->port_role_transition_sm_state =
1847 PORT_ROLE_TRANSITION_SM_ALTERNATE_PORT_EXEC;
1854 if (old_state != p->port_role_transition_sm_state) {
1856 VLOG_DBG("%s, port %u: Port_role_transition_sm %d -> %d",
1857 p->rstp->name, p->port_number, old_state,
1858 p->port_role_transition_sm_state);
1860 if (last_role != p->role) {
1861 VLOG_DBG("%s, port %u, port role ["RSTP_PORT_ID_FMT"] = %s",
1862 p->rstp->name, p->port_number, p->port_id,
1863 rstp_port_role_name(p->role));
1868 /* [17.30 - Port state transition state machine] */
1871 enable_learning(struct rstp_port *p)
1872 OVS_REQUIRES(rstp_mutex)
1874 /* [17.21.6 enableLearning()] An implementation dependent procedure that
1875 * causes the Learning Process (7.8) to start learning from frames received
1876 * on the Port. The procedure does not complete until learning has been
1879 rstp_port_set_state__(p, RSTP_LEARNING);
1883 enable_forwarding(struct rstp_port *p)
1884 OVS_REQUIRES(rstp_mutex)
1886 /* [17.21.5 enableForwarding()] An implementation dependent procedure that
1887 * causes the Forwarding Process (7.7) to start forwarding frames through
1888 * the Port. The procedure does not complete until forwarding has been
1891 rstp_port_set_state__(p, RSTP_FORWARDING);
1895 disable_learning(struct rstp_port *p)
1896 OVS_REQUIRES(rstp_mutex)
1898 /* [17.21.4 - disableLearning()] An implementation dependent procedure that
1899 * causes the Learning Process (7.8) to stop learning from the source
1900 * address of frames received on the Port. The procedure does not complete
1901 * until learning has stopped.
1903 rstp_port_set_state__(p, RSTP_DISCARDING);
1907 disable_forwarding(struct rstp_port *p)
1908 OVS_REQUIRES(rstp_mutex)
1910 /* [17.21.3 - disableForwarding()] An implementation dependent procedure
1911 * that causes the Forwarding Process (7.7) to stop forwarding frames
1912 * through the Port. The procedure does not complete until forwarding has
1915 rstp_port_set_state__(p, RSTP_DISCARDING);
1919 port_state_transition_sm(struct rstp_port *p)
1920 OVS_REQUIRES(rstp_mutex)
1922 enum port_state_transition_state_machine old_state;
1925 old_state = p->port_state_transition_sm_state;
1928 switch (p->port_state_transition_sm_state) {
1929 case PORT_STATE_TRANSITION_SM_INIT:
1931 p->port_state_transition_sm_state =
1932 PORT_STATE_TRANSITION_SM_DISCARDING_EXEC;
1935 case PORT_STATE_TRANSITION_SM_DISCARDING_EXEC:
1936 disable_learning(p);
1937 p->learning = false;
1938 disable_forwarding(p);
1939 p->forwarding = false;
1940 p->port_state_transition_sm_state =
1941 PORT_STATE_TRANSITION_SM_DISCARDING;
1943 case PORT_STATE_TRANSITION_SM_DISCARDING:
1945 p->port_state_transition_sm_state =
1946 PORT_STATE_TRANSITION_SM_LEARNING_EXEC;
1949 case PORT_STATE_TRANSITION_SM_LEARNING_EXEC:
1952 p->port_state_transition_sm_state = PORT_STATE_TRANSITION_SM_LEARNING;
1954 case PORT_STATE_TRANSITION_SM_LEARNING:
1956 p->port_state_transition_sm_state =
1957 PORT_STATE_TRANSITION_SM_DISCARDING_EXEC;
1958 } else if (p->forward) {
1959 p->port_state_transition_sm_state =
1960 PORT_STATE_TRANSITION_SM_FORWARDING_EXEC;
1963 case PORT_STATE_TRANSITION_SM_FORWARDING_EXEC:
1964 enable_forwarding(p);
1965 p->forwarding = true;
1966 p->port_state_transition_sm_state =
1967 PORT_STATE_TRANSITION_SM_FORWARDING;
1969 case PORT_STATE_TRANSITION_SM_FORWARDING:
1971 p->port_state_transition_sm_state =
1972 PORT_STATE_TRANSITION_SM_DISCARDING_EXEC;
1979 if (old_state != p->port_state_transition_sm_state) {
1981 VLOG_DBG("%s, port %u: Port_state_transition_sm %d -> %d",
1982 p->rstp->name, p->port_number, old_state,
1983 p->port_state_transition_sm_state);
1988 /* [17.31 - Topology Change state machine] */
1991 new_tc_while(struct rstp_port *p)
1992 OVS_REQUIRES(rstp_mutex)
1997 if (p->tc_while == 0 && p->send_rstp == true) {
1998 p->tc_while = r->bridge_hello_time + 1;
2000 } else if (p->tc_while == 0 && p->send_rstp == false) {
2001 p->tc_while = r->bridge_max_age + r->bridge_forward_delay;
2005 /* [17.21.18 setTcPropTree()]
2006 * Sets tcprop for all Ports except the Port that called the procedure.
2009 set_tc_prop_tree(struct rstp_port *p)
2010 OVS_REQUIRES(rstp_mutex)
2013 struct rstp_port *p1;
2016 HMAP_FOR_EACH (p1, node, &r->ports) {
2017 /* Set tc_prop on every port, except the one calling this
2019 if (p1->port_number != p->port_number) {
2026 set_tc_prop_bridge(struct rstp_port *p) /* not specified in 802.1D-2004. */
2027 OVS_REQUIRES(rstp_mutex)
2029 set_tc_prop_tree(p); /* see 802.1w-2001. */
2033 topology_change_sm(struct rstp_port *p)
2034 OVS_REQUIRES(rstp_mutex)
2036 enum topology_change_state_machine old_state;
2039 old_state = p->topology_change_sm_state;
2042 switch (p->topology_change_sm_state) {
2043 case TOPOLOGY_CHANGE_SM_INIT:
2045 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_INACTIVE_EXEC;
2048 case TOPOLOGY_CHANGE_SM_INACTIVE_EXEC:
2049 p->fdb_flush = true;
2052 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_INACTIVE;
2054 case TOPOLOGY_CHANGE_SM_INACTIVE:
2055 if (p->learn && !p->fdb_flush) {
2056 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_LEARNING_EXEC;
2059 case TOPOLOGY_CHANGE_SM_LEARNING_EXEC:
2060 p->rcvd_tc = p->rcvd_tcn = p->rcvd_tc_ack = false;
2061 p->tc_prop = p->rcvd_tc_ack = false;
2062 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_LEARNING;
2064 case TOPOLOGY_CHANGE_SM_LEARNING:
2065 if (p->role != ROLE_ROOT && p->role != ROLE_DESIGNATED &&
2066 !(p->learn || p->learning) && !(p->rcvd_tc || p->rcvd_tcn ||
2067 p->rcvd_tc_ack || p->tc_prop)) {
2068 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_INACTIVE_EXEC;
2069 } else if (p->rcvd_tc || p->rcvd_tcn || p->rcvd_tc_ack || p->tc_prop) {
2070 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_LEARNING_EXEC;
2071 } else if ((p->role == ROLE_ROOT || p->role == ROLE_DESIGNATED)
2072 && p->forward && !p->oper_edge) {
2073 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_DETECTED_EXEC;
2076 case TOPOLOGY_CHANGE_SM_DETECTED_EXEC:
2078 set_tc_prop_tree(p);
2080 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_ACTIVE_EXEC;
2082 case TOPOLOGY_CHANGE_SM_ACTIVE_EXEC:
2083 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_ACTIVE;
2085 case TOPOLOGY_CHANGE_SM_ACTIVE:
2086 if ((p->role != ROLE_ROOT && p->role != ROLE_DESIGNATED)
2088 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_LEARNING_EXEC;
2089 } else if (p->rcvd_tcn) {
2090 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_NOTIFIED_TCN_EXEC;
2091 } else if (p->rcvd_tc) {
2092 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_NOTIFIED_TC_EXEC;
2093 } else if (p->tc_prop && !p->oper_edge) {
2094 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_PROPAGATING_EXEC;
2095 } else if (p->rcvd_tc_ack) {
2096 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_ACKNOWLEDGED_EXEC;
2099 case TOPOLOGY_CHANGE_SM_ACKNOWLEDGED_EXEC:
2101 p->rcvd_tc_ack = false;
2102 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_ACTIVE;
2104 case TOPOLOGY_CHANGE_SM_PROPAGATING_EXEC:
2106 p->fdb_flush = true;
2108 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_ACTIVE;
2110 case TOPOLOGY_CHANGE_SM_NOTIFIED_TC_EXEC:
2111 p->rcvd_tcn = p->rcvd_tc = false;
2112 if (p->role == ROLE_DESIGNATED) {
2115 set_tc_prop_bridge(p);
2116 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_ACTIVE;
2118 case TOPOLOGY_CHANGE_SM_NOTIFIED_TCN_EXEC:
2120 p->topology_change_sm_state = TOPOLOGY_CHANGE_SM_NOTIFIED_TC_EXEC;
2126 if (old_state != p->topology_change_sm_state) {
2128 VLOG_DBG("%s, port %u: Topology_change_sm %d -> %d", p->rstp->name,
2129 p->port_number, old_state, p->topology_change_sm_state);
2134 /****************************************************************************
2135 * [17.6] Priority vector calculation helper functions
2136 ****************************************************************************/
2138 /* compare_rstp_priority_vectors() compares two struct rstp_priority_vectors
2139 * and returns a value indicating if the first rstp_priority_vector is
2140 * superior, same or inferior to the second one.
2142 * Zero return value indicates INFERIOR, a non-zero return value indicates
2143 * SUPERIOR. When it makes a difference the non-zero return value SAME
2144 * indicates the priority vectors are identical (a subset of SUPERIOR).
2146 static enum vector_comparison
2147 compare_rstp_priority_vectors(const struct rstp_priority_vector *v1,
2148 const struct rstp_priority_vector *v2)
2150 VLOG_DBG("v1: "RSTP_ID_FMT", %u, "RSTP_ID_FMT", %d, %d",
2151 RSTP_ID_ARGS(v1->root_bridge_id), v1->root_path_cost,
2152 RSTP_ID_ARGS(v1->designated_bridge_id), v1->designated_port_id,
2153 v1->bridge_port_id);
2154 VLOG_DBG("v2: "RSTP_ID_FMT", %u, "RSTP_ID_FMT", %d, %d",
2155 RSTP_ID_ARGS(v2->root_bridge_id), v2->root_path_cost,
2156 RSTP_ID_ARGS(v2->designated_bridge_id), v2->designated_port_id,
2157 v2->bridge_port_id);
2160 * This message priority vector is superior to the port priority vector and
2161 * will replace it if, and only if, the message priority vector is better
2162 * than the port priority vector, or the message has been transmitted from
2163 * the same Designated Bridge and Designated Port as the port priority
2164 * vector, i.e., if the following is true:
2166 * ((RD < RootBridgeID)) ||
2167 * ((RD == RootBridgeID) && (RPCD < RootPathCost)) ||
2168 * ((RD == RootBridgeID) && (RPCD == RootPathCost) &&
2169 * (D < designated_bridge_id)) ||
2170 * ((RD == RootBridgeID) && (RPCD == RootPathCost) &&
2171 * (D == designated_bridge_id) && (PD < designated_port_id)) ||
2172 * ((D == designated_bridge_id.BridgeAddress) &&
2173 * (PD == designated_port_id.PortNumber))
2175 if ((v1->root_bridge_id < v2->root_bridge_id)
2176 || (v1->root_bridge_id == v2->root_bridge_id
2177 && v1->root_path_cost < v2->root_path_cost)
2178 || (v1->root_bridge_id == v2->root_bridge_id
2179 && v1->root_path_cost == v2->root_path_cost
2180 && v1->designated_bridge_id < v2->designated_bridge_id)
2181 || (v1->root_bridge_id == v2->root_bridge_id
2182 && v1->root_path_cost == v2->root_path_cost
2183 && v1->designated_bridge_id == v2->designated_bridge_id
2184 && v1->designated_port_id < v2->designated_port_id)
2185 || (v1->designated_bridge_id == v2->designated_bridge_id
2186 && v1->designated_port_id == v2->designated_port_id)) {
2187 /* SAME is a subset of SUPERIOR. */
2188 if (v1->root_bridge_id == v2->root_bridge_id
2189 && v1->root_path_cost == v2->root_path_cost
2190 && v1->designated_bridge_id == v2->designated_bridge_id
2191 && v1->designated_port_id == v2->designated_port_id) {
2192 if (v1->bridge_port_id < v2->bridge_port_id) {
2193 VLOG_DBG("superior");
2196 else if (v1->bridge_port_id > v2->bridge_port_id) {
2197 VLOG_DBG("inferior");
2200 VLOG_DBG("superior_same");
2203 VLOG_DBG("superior");
2207 VLOG_DBG("inferior");
2212 rstp_times_equal(struct rstp_times *t1, struct rstp_times *t2)
2214 return t1->forward_delay == t2->forward_delay
2215 && t1->hello_time == t2->hello_time
2216 && t1->max_age == t2->max_age
2217 && t1->message_age == t2->message_age;