2 * mstp.c State machines from IEEE 802.1Q-2005
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Authors: Vitalii Demianets <dvitasgs@gmail.com>
12 /* NOTE: The standard messes up Hello_Time timer management.
13 * The portTimes and msgTimes structures have it, while
14 * designatedTimes, rootTimes and BridgeTimes do not!
15 * And there are places, where standard says:
16 * "portTimes = designatedTimes" (13.32)
17 * "rootTimes = portTimes" (13.26.23)
19 * For now I decide: All structures will hold Hello_Time,
20 * because in 802.1D they do.
21 * Besides, it is necessary for compatibility with old STP implementations.
24 /* 802.1Q-2005 does not define but widely use variable name newInfoXst.
25 * From the 802.1s I can guess that it means:
26 * - "newInfo" when tree is CIST;
27 * - "newInfoMsti" when tree is not CIST (is MSTI).
28 * But that is only a guess and I could be wrong here ;)
31 /* Important coding convention:
32 * All functions that have dry_run argument must follow the
33 * return value convention:
34 * They should return true if state change detected during dry run.
35 * Otherwise (!dry_run || !state_change) they return false.
41 #include <netinet/in.h>
42 #include <linux/if_bridge.h>
43 #include <asm/byteorder.h>
51 static void PTSM_tick(port_t
*prt
);
52 static bool TCSM_run(per_tree_port_t
*ptp
, bool dry_run
);
53 static void BDSM_begin(port_t
*prt
);
54 static void br_state_machines_begin(bridge_t
*br
);
55 static void prt_state_machines_begin(port_t
*prt
);
56 static void tree_state_machines_begin(tree_t
*tree
);
57 static void br_state_machines_run(bridge_t
*br
);
58 static void updtbrAssuRcvdInfoWhile(port_t
*prt
);
60 #define FOREACH_PORT_IN_BRIDGE(port, bridge) \
61 list_for_each_entry((port), &(bridge)->ports, br_list)
62 #define FOREACH_TREE_IN_BRIDGE(tree, bridge) \
63 list_for_each_entry((tree), &(bridge)->trees, bridge_list)
64 #define FOREACH_PTP_IN_TREE(ptp, tree) \
65 list_for_each_entry((ptp), &(tree)->ports, tree_list)
66 #define FOREACH_PTP_IN_PORT(ptp, port) \
67 list_for_each_entry((ptp), &(port)->trees, port_list)
69 /* 17.20.11 of 802.1D */
70 #define rstpVersion(br) ((br)->ForceProtocolVersion >= protoRSTP)
71 /* Bridge assurance is operational only when NetworkPort type is configured
72 * and the operation status is pointToPoint and version is RSTP/MSTP
74 #define assurancePort(prt) ((prt)->NetworkPort && (prt)->operPointToPointMAC \
77 * Recalculate configuration digest. (13.7)
79 static void RecalcConfigDigest(bridge_t
*br
)
81 __be16 vid2mstid
[MAX_VID
+ 2];
82 unsigned char mstp_key
[] = HMAC_KEY
;
85 vid2mstid
[0] = vid2mstid
[MAX_VID
+ 1] = 0;
86 for(vid
= 1; vid
<= MAX_VID
; ++vid
)
87 vid2mstid
[vid
] = br
->fid2mstid
[br
->vid2fid
[vid
]];
89 hmac_md5((void *)vid2mstid
, sizeof(vid2mstid
), mstp_key
, sizeof(mstp_key
),
90 (caddr_t
)br
->MstConfigId
.s
.configuration_digest
);
94 * 13.37.1 - Table 13-3
96 static __u32
compute_pcost(int speed
)
100 return (speed
< 20000000) ? 20000000 / speed
: 1;
102 return MAX_PATH_COST
;
105 static void bridge_default_internal_vars(bridge_t
*br
)
110 static void tree_default_internal_vars(tree_t
*tree
)
112 /* 12.8.1.1.3.(b,c,d) */
113 tree
->time_since_topology_change
= 0;
114 tree
->topology_change_count
= 0;
115 tree
->topology_change
= false; /* since all tcWhile are initialized to 0 */
116 strncpy(tree
->topology_change_port
, "None", IFNAMSIZ
);
117 strncpy(tree
->last_topology_change_port
, "None", IFNAMSIZ
);
119 /* The following are initialized in BEGIN state:
120 * - rootPortId, rootPriority, rootTimes: in Port Role Selection SM
124 static void port_default_internal_vars(port_t
*prt
)
126 prt
->infoInternal
= false;
127 prt
->rcvdInternal
= false;
128 prt
->rcvdTcAck
= false;
129 prt
->rcvdTcn
= false;
130 assign(prt
->rapidAgeingWhile
, 0u);
131 assign(prt
->brAssuRcvdInfoWhile
, 0u);
132 prt
->BaInconsistent
= false;
133 prt
->num_rx_bpdu_filtered
= 0;
134 prt
->num_rx_bpdu
= 0;
136 prt
->num_tx_bpdu
= 0;
138 prt
->num_trans_fwd
= 0;
139 prt
->num_trans_blk
= 0;
141 /* The following are initialized in BEGIN state:
142 * - mdelayWhile. mcheck, sendRSTP: in Port Protocol Migration SM
143 * - helloWhen, newInfo, newInfoMsti, txCount: in Port Transmit SM
144 * - edgeDelayWhile, rcvdBpdu, rcvdRSTP, rcvdSTP : in Port Receive SM
145 * - operEdge: in Bridge Detection SM
146 * - tcAck: in Topology Change SM
150 static void ptp_default_internal_vars(per_tree_port_t
*ptp
)
154 ptp
->updtInfo
= false;
155 ptp
->master
= false; /* 13.24.5 */
156 ptp
->disputed
= false;
157 assign(ptp
->rcvdInfo
, (port_info_t
)0);
158 ptp
->mastered
= false;
159 memset(&ptp
->msgPriority
, 0, sizeof(ptp
->msgPriority
));
160 memset(&ptp
->msgTimes
, 0, sizeof(ptp
->msgTimes
));
162 /* The following are initialized in BEGIN state:
163 * - rcvdMsg: in Port Receive SM
164 * - fdWhile, rrWhile, rbWhile, role, learn, forward,
165 * sync, synced, reRoot: in Port Role Transitions SM
166 * - tcWhile, fdbFlush: Topology Change SM
167 * - rcvdInfoWhile, proposed, proposing, agree, agreed,
168 * infoIs, reselect, selected: Port Information SM
169 * - forwarding, learning: Port State Transition SM
170 * - selectedRole, designatedPriority, designatedTimes: Port Role Selection SM
174 static tree_t
* create_tree(bridge_t
*br
, __u8
*macaddr
, __be16 MSTID
)
176 /* Initialize all fields except anchor */
177 tree_t
*tree
= calloc(1, sizeof(*tree
));
180 ERROR_BRNAME(br
, "Out of memory");
185 INIT_LIST_HEAD(&tree
->ports
);
187 memcpy(tree
->BridgeIdentifier
.s
.mac_address
, macaddr
, ETH_ALEN
);
188 /* 0x8000 = default bridge priority (17.14 of 802.1D) */
189 tree
->BridgeIdentifier
.s
.priority
= __constant_cpu_to_be16(0x8000) | MSTID
;
190 assign(tree
->BridgePriority
.RootID
, tree
->BridgeIdentifier
);
191 assign(tree
->BridgePriority
.RRootID
, tree
->BridgeIdentifier
);
192 assign(tree
->BridgePriority
.DesignatedBridgeID
, tree
->BridgeIdentifier
);
194 assign(tree
->BridgeTimes
.remainingHops
, br
->MaxHops
);
195 assign(tree
->BridgeTimes
.Forward_Delay
, br
->Forward_Delay
);
196 assign(tree
->BridgeTimes
.Max_Age
, br
->Max_Age
);
197 assign(tree
->BridgeTimes
.Message_Age
, (__u8
)0);
198 assign(tree
->BridgeTimes
.Hello_Time
, br
->Hello_Time
);
200 tree_default_internal_vars(tree
);
205 static per_tree_port_t
* create_ptp(tree_t
*tree
, port_t
*prt
)
207 /* Initialize all fields except anchors */
208 per_tree_port_t
*ptp
= calloc(1, sizeof(*ptp
));
211 ERROR_PRTNAME(prt
->bridge
, prt
, "Out of memory");
216 ptp
->MSTID
= tree
->MSTID
;
218 ptp
->state
= BR_STATE_DISABLED
;
219 /* 0x80 = default port priority (17.14 of 802.1D) */
220 ptp
->portId
= __constant_cpu_to_be16(0x8000) | prt
->port_number
;
221 assign(ptp
->AdminInternalPortPathCost
, 0u);
222 assign(ptp
->InternalPortPathCost
, compute_pcost(GET_PORT_SPEED(prt
)));
223 /* 802.1Q leaves portPriority and portTimes uninitialized */
224 assign(ptp
->portPriority
, tree
->BridgePriority
);
225 assign(ptp
->portTimes
, tree
->BridgeTimes
);
227 ptp
->calledFromFlushRoutine
= false;
229 ptp_default_internal_vars(ptp
);
234 /* External events */
236 bool MSTP_IN_bridge_create(bridge_t
*br
, __u8
*macaddr
)
240 if (!driver_create_bridge(br
, macaddr
))
243 /* Initialize all fields except sysdeps and anchor */
244 INIT_LIST_HEAD(&br
->ports
);
245 INIT_LIST_HEAD(&br
->trees
);
246 br
->bridgeEnabled
= false;
247 memset(br
->vid2fid
, 0, sizeof(br
->vid2fid
));
248 memset(br
->fid2mstid
, 0, sizeof(br
->fid2mstid
));
249 assign(br
->MstConfigId
.s
.selector
, (__u8
)0);
250 sprintf((char *)br
->MstConfigId
.s
.configuration_name
,
251 "%02hhX%02hhX%02hhX%02hhX%02hhX%02hhX",
252 macaddr
[0], macaddr
[1], macaddr
[2],
253 macaddr
[3], macaddr
[4], macaddr
[5]);
254 assign(br
->MstConfigId
.s
.revision_level
, __constant_cpu_to_be16(0));
255 RecalcConfigDigest(br
); /* set br->MstConfigId.s.configuration_digest */
256 br
->ForceProtocolVersion
= protoRSTP
;
257 assign(br
->MaxHops
, (__u8
)20); /* 13.37.3 */
258 assign(br
->Forward_Delay
, (__u8
)15); /* 17.14 of 802.1D */
259 assign(br
->Max_Age
, (__u8
)20); /* 17.14 of 802.1D */
260 assign(br
->Transmit_Hold_Count
, 6u); /* 17.14 of 802.1D */
261 assign(br
->Migrate_Time
, 3u); /* 17.14 of 802.1D */
262 assign(br
->Ageing_Time
, 300u);/* 8.8.3 Table 8-3 */
263 assign(br
->Hello_Time
, (__u8
)2); /* 17.14 of 802.1D */
265 bridge_default_internal_vars(br
);
268 if(!(cist
= create_tree(br
, macaddr
, 0)))
270 list_add_tail(&cist
->bridge_list
, &br
->trees
);
275 bool MSTP_IN_port_create_and_add_tail(port_t
*prt
, __u16 portno
)
278 per_tree_port_t
*ptp
, *nxt
;
279 bridge_t
*br
= prt
->bridge
;
281 if (!driver_create_port(prt
, portno
))
284 /* Initialize all fields except sysdeps and bridge */
285 INIT_LIST_HEAD(&prt
->trees
);
286 prt
->port_number
= __cpu_to_be16(portno
);
288 assign(prt
->AdminExternalPortPathCost
, 0u);
289 /* Default for operP2P is false because by default AdminP2P
290 * says to auto-detect p2p state, and it is derived from duplex
291 * and initially port is in down state and in this down state
292 * duplex is set to false (half) */
293 prt
->AdminP2P
= p2pAuto
;
294 prt
->operPointToPointMAC
= false;
295 prt
->portEnabled
= false;
296 prt
->restrictedRole
= false; /* 13.25.14 */
297 prt
->restrictedTcn
= false; /* 13.25.15 */
298 assign(prt
->ExternalPortPathCost
, MAX_PATH_COST
); /* 13.37.1 */
299 prt
->AdminEdgePort
= false; /* 13.25 */
300 prt
->AutoEdge
= true; /* 13.25 */
301 prt
->BpduGuardPort
= false;
302 prt
->BpduGuardError
= false;
303 prt
->NetworkPort
= false;
304 prt
->dontTxmtBpdu
= false;
305 prt
->bpduFilterPort
= false;
306 prt
->deleted
= false;
308 port_default_internal_vars(prt
);
310 /* Create PerTreePort structures for all existing trees */
311 FOREACH_TREE_IN_BRIDGE(tree
, br
)
313 if(!(ptp
= create_ptp(tree
, prt
)))
315 /* Remove and free all previously created entries in port's list */
316 list_for_each_entry_safe(ptp
, nxt
, &prt
->trees
, port_list
)
318 list_del(&ptp
->port_list
);
319 list_del(&ptp
->tree_list
);
324 list_add_tail(&ptp
->port_list
, &prt
->trees
);
325 list_add_tail(&ptp
->tree_list
, &tree
->ports
);
328 /* Add new port to the tail of the list in the bridge */
329 /* NOTE: if one wants add port NOT to the tail of the list of ports,
330 * one should revise above loop (FOREACH_TREE_IN_BRIDGE)
331 * because it heavily depends on the fact that port is added to the tail.
333 list_add_tail(&prt
->br_list
, &br
->ports
);
335 prt_state_machines_begin(prt
);
339 void MSTP_IN_delete_port(port_t
*prt
)
341 per_tree_port_t
*ptp
, *nxt
;
342 bridge_t
*br
= prt
->bridge
;
344 driver_delete_port(prt
);
349 prt
->portEnabled
= false;
350 br_state_machines_run(br
);
353 list_for_each_entry_safe(ptp
, nxt
, &prt
->trees
, port_list
)
355 list_del(&ptp
->port_list
);
356 list_del(&ptp
->tree_list
);
360 list_del(&prt
->br_list
);
361 br_state_machines_run(br
);
364 void MSTP_IN_delete_bridge(bridge_t
*br
)
366 tree_t
*tree
, *nxt_tree
;
367 port_t
*prt
, *nxt_prt
;
369 driver_delete_bridge(br
);
371 br
->bridgeEnabled
= false;
373 /* We SHOULD first delete all ports and only THEN delete all tree_t
374 * structures as the tree_t structure contains the head for the per-port
375 * list of tree data (tree_t.ports).
376 * If this list_head will be deleted before all the per_tree_ports
377 * bad things will happen ;)
380 list_for_each_entry_safe(prt
, nxt_prt
, &br
->ports
, br_list
)
382 MSTP_IN_delete_port(prt
);
386 list_for_each_entry_safe(tree
, nxt_tree
, &br
->trees
, bridge_list
)
388 list_del(&tree
->bridge_list
);
393 void MSTP_IN_set_bridge_address(bridge_t
*br
, __u8
*macaddr
)
396 bool changed
= false;
398 FOREACH_TREE_IN_BRIDGE(tree
, br
)
400 if(0 == memcmp(tree
->BridgeIdentifier
.s
.mac_address
, macaddr
, ETH_ALEN
))
403 memcpy(tree
->BridgeIdentifier
.s
.mac_address
, macaddr
, ETH_ALEN
);
404 tree
->BridgePriority
.RootID
= tree
->BridgePriority
.RRootID
=
405 tree
->BridgePriority
.DesignatedBridgeID
= tree
->BridgeIdentifier
;
409 br_state_machines_begin(br
);
412 void MSTP_IN_set_bridge_enable(bridge_t
*br
, bool up
)
415 per_tree_port_t
*ptp
;
418 if(br
->bridgeEnabled
== up
)
420 br
->bridgeEnabled
= up
;
422 /* Reset all internal states and variables,
423 * except those which are user-configurable */
424 bridge_default_internal_vars(br
);
425 FOREACH_TREE_IN_BRIDGE(tree
, br
)
427 tree_default_internal_vars(tree
);
429 FOREACH_PORT_IN_BRIDGE(prt
, br
)
431 /* NOTE: Don't check prt->deleted here, as it is imposible condition */
432 /* NOTE: In the port_default_internal_vars() rapidAgeingWhile will be
433 * reset, so we should stop rapid ageing procedure here.
435 if(prt
->rapidAgeingWhile
)
437 MSTP_OUT_set_ageing_time(prt
, br
->Ageing_Time
);
439 port_default_internal_vars(prt
);
440 FOREACH_PTP_IN_PORT(ptp
, prt
)
442 if(BR_STATE_DISABLED
!= ptp
->state
)
444 MSTP_OUT_set_state(ptp
, BR_STATE_DISABLED
);
446 ptp_default_internal_vars(ptp
);
449 br_state_machines_begin(br
);
452 void MSTP_IN_set_port_enable(port_t
*prt
, bool up
, int speed
, int duplex
)
454 __u32 computed_pcost
, new_ExternalPathCost
, new_InternalPathCost
;
455 per_tree_port_t
*ptp
;
457 bool changed
= false;
461 computed_pcost
= compute_pcost(speed
);
462 new_ExternalPathCost
= (0 == prt
->AdminExternalPortPathCost
) ?
464 : prt
->AdminExternalPortPathCost
;
465 if(prt
->ExternalPortPathCost
!= new_ExternalPathCost
)
467 assign(prt
->ExternalPortPathCost
, new_ExternalPathCost
);
470 FOREACH_PTP_IN_PORT(ptp
, prt
)
472 new_InternalPathCost
= (0 == ptp
->AdminInternalPortPathCost
) ?
474 : ptp
->AdminInternalPortPathCost
;
475 if(ptp
->InternalPortPathCost
!= new_InternalPathCost
)
477 assign(ptp
->InternalPortPathCost
, new_InternalPathCost
);
482 switch(prt
->AdminP2P
)
495 if(prt
->operPointToPointMAC
!= new_p2p
)
497 prt
->operPointToPointMAC
= new_p2p
;
501 if(!prt
->portEnabled
)
503 prt
->portEnabled
= true;
504 prt
->BpduGuardError
= false;
505 prt
->BaInconsistent
= false;
506 prt
->num_rx_bpdu_filtered
= 0;
507 prt
->num_rx_bpdu
= 0;
509 prt
->num_tx_bpdu
= 0;
512 /* When port is enabled, initialize bridge assurance timer,
513 * so that enough time is given before port is put in
514 * inconsistent state.
516 updtbrAssuRcvdInfoWhile(prt
);
523 prt
->portEnabled
= false;
529 br_state_machines_run(prt
->bridge
);
532 void MSTP_IN_one_second(bridge_t
*br
)
539 if(!br
->bridgeEnabled
)
542 FOREACH_TREE_IN_BRIDGE(tree
, br
)
543 if(!(tree
->topology_change
))
544 ++(tree
->time_since_topology_change
);
546 FOREACH_PORT_IN_BRIDGE(prt
, br
)
549 /* support for rapid ageing */
550 if(prt
->rapidAgeingWhile
)
552 if((--(prt
->rapidAgeingWhile
)) == 0)
555 MSTP_OUT_set_ageing_time(prt
, br
->Ageing_Time
);
560 br_state_machines_run(br
);
563 void MSTP_IN_all_fids_flushed(per_tree_port_t
*ptp
)
565 bridge_t
*br
= ptp
->port
->bridge
;
566 ptp
->fdbFlush
= false;
567 if(!br
->bridgeEnabled
)
569 if(!ptp
->calledFromFlushRoutine
)
571 TCSM_run(ptp
, false /* actual run */);
572 br_state_machines_run(br
);
576 /* NOTE: bpdu pointer is unaligned, but it works because
577 * bpdu_t is packed. Don't try to cast bpdu to non-packed type ;)
579 void MSTP_IN_rx_bpdu(port_t
*prt
, bpdu_t
*bpdu
, int size
)
582 bridge_t
*br
= prt
->bridge
;
584 ++(prt
->num_rx_bpdu
);
586 if(prt
->BpduGuardPort
)
588 prt
->BpduGuardError
= true;
589 ERROR_PRTNAME(br
, prt
,
590 "Received BPDU on BPDU Guarded Port - Port Down");
591 MSTP_OUT_shutdown_port(prt
);
595 if(prt
->bpduFilterPort
)
598 "Received BPDU on BPDU Filtered Port - discarded");
599 ++(prt
->num_rx_bpdu_filtered
);
603 if(!br
->bridgeEnabled
)
605 INFO_PRTNAME(br
, prt
, "Received BPDU while bridge is disabled");
611 ERROR_PRTNAME(br
, prt
, "Port hasn't processed previous BPDU");
615 /* 14.4 Validation */
616 if((TCN_BPDU_SIZE
> size
) || (0 != bpdu
->protocolIdentifier
))
618 bpdu_validation_failed
:
619 INFO_PRTNAME(br
, prt
, "BPDU validation failed");
622 switch(bpdu
->bpduType
)
627 bpdu
->protocolVersion
= protoSTP
;
628 LOG_PRTNAME(br
, prt
, "received TCN BPDU");
632 if(CONFIG_BPDU_SIZE
> size
)
633 goto bpdu_validation_failed
;
634 /* Valid Config BPDU */
635 bpdu
->protocolVersion
= protoSTP
;
636 LOG_PRTNAME(br
, prt
, "received Config BPDU%s",
637 (bpdu
->flags
& (1 << offsetTc
)) ? ", tcFlag" : ""
641 if(protoRSTP
== bpdu
->protocolVersion
)
643 if(RST_BPDU_SIZE
> size
)
644 goto bpdu_validation_failed
;
646 /* bpdu->protocolVersion = protoRSTP; */
647 LOG_PRTNAME(br
, prt
, "received RST BPDU%s",
648 (bpdu
->flags
& (1 << offsetTc
)) ? ", tcFlag" : ""
652 if(protoMSTP
> bpdu
->protocolVersion
)
653 goto bpdu_validation_failed
;
654 /* Yes, 802.1Q-2005 says here to check if it contains
655 * "35 or more octets", not 36! (see 14.4.d).1) )
656 * That's why I check size against CONFIG_BPDU_SIZE
657 * and not RST_BPDU_SIZE.
659 if(CONFIG_BPDU_SIZE
> size
)
660 goto bpdu_validation_failed
;
661 mstis_size
= __be16_to_cpu(bpdu
->version3_len
)
662 - MST_BPDU_VER3LEN_WO_MSTI_MSGS
;
663 if((MST_BPDU_SIZE_WO_MSTI_MSGS
> size
) || (0 != bpdu
->version1_len
)
665 || ((MAX_STANDARD_MSTIS
* sizeof(msti_configuration_message_t
))
667 || (0 != (mstis_size
% sizeof(msti_configuration_message_t
)))
671 bpdu
->protocolVersion
= protoRSTP
;
672 LOG_PRTNAME(br
, prt
, "received RST BPDU");
677 bpdu
->protocolVersion
= protoMSTP
;
678 prt
->rcvdBpduNumOfMstis
= mstis_size
679 / sizeof(msti_configuration_message_t
);
680 LOG_PRTNAME(br
, prt
, "received MST BPDU%s with %d MSTIs",
681 (bpdu
->flags
& (1 << offsetTc
)) ? ", tcFlag" : "",
682 prt
->rcvdBpduNumOfMstis
686 goto bpdu_validation_failed
;
689 if((protoSTP
== bpdu
->protocolVersion
) && (bpduTypeTCN
== bpdu
->bpduType
))
695 if(bpdu
->flags
& (1 << offsetTc
))
699 assign(prt
->rcvdBpduData
, *bpdu
);
700 prt
->rcvdBpdu
= true;
702 /* Reset bridge assurance on receipt of valid BPDU */
703 if(prt
->BaInconsistent
)
705 prt
->BaInconsistent
= false;
706 INFO_PRTNAME(br
, prt
, "Clear Bridge assurance inconsistency");
708 updtbrAssuRcvdInfoWhile(prt
);
710 br_state_machines_run(br
);
713 /* 12.8.1.1 Read CIST Bridge Protocol Parameters */
714 void MSTP_IN_get_cist_bridge_status(bridge_t
*br
, CIST_BridgeStatus
*status
)
716 tree_t
*cist
= GET_CIST_TREE(br
);
717 assign(status
->bridge_id
, cist
->BridgeIdentifier
);
718 assign(status
->time_since_topology_change
,
719 cist
->time_since_topology_change
);
720 assign(status
->topology_change_count
, cist
->topology_change_count
);
721 status
->topology_change
= cist
->topology_change
;
722 strncpy(status
->topology_change_port
, cist
->topology_change_port
,
724 strncpy(status
->last_topology_change_port
, cist
->last_topology_change_port
,
726 assign(status
->designated_root
, cist
->rootPriority
.RootID
);
727 assign(status
->root_path_cost
,
728 __be32_to_cpu(cist
->rootPriority
.ExtRootPathCost
));
729 assign(status
->regional_root
, cist
->rootPriority
.RRootID
);
730 assign(status
->internal_path_cost
,
731 __be32_to_cpu(cist
->rootPriority
.IntRootPathCost
));
732 assign(status
->root_port_id
, cist
->rootPortId
);
733 assign(status
->root_max_age
, cist
->rootTimes
.Max_Age
);
734 assign(status
->root_forward_delay
, cist
->rootTimes
.Forward_Delay
);
735 assign(status
->bridge_max_age
, br
->Max_Age
);
736 assign(status
->bridge_forward_delay
, br
->Forward_Delay
);
737 assign(status
->max_hops
, br
->MaxHops
);
738 assign(status
->tx_hold_count
, br
->Transmit_Hold_Count
);
739 status
->protocol_version
= br
->ForceProtocolVersion
;
740 status
->enabled
= br
->bridgeEnabled
;
741 assign(status
->bridge_hello_time
, br
->Hello_Time
);
742 assign(status
->Ageing_Time
, br
->Ageing_Time
);
745 /* 12.8.1.2 Read MSTI Bridge Protocol Parameters */
746 void MSTP_IN_get_msti_bridge_status(tree_t
*tree
, MSTI_BridgeStatus
*status
)
748 assign(status
->bridge_id
, tree
->BridgeIdentifier
);
749 assign(status
->time_since_topology_change
,
750 tree
->time_since_topology_change
);
751 assign(status
->topology_change_count
, tree
->topology_change_count
);
752 status
->topology_change
= tree
->topology_change
;
753 strncpy(status
->topology_change_port
, tree
->topology_change_port
,
755 strncpy(status
->last_topology_change_port
, tree
->last_topology_change_port
,
757 assign(status
->regional_root
, tree
->rootPriority
.RRootID
);
758 assign(status
->internal_path_cost
,
759 __be32_to_cpu(tree
->rootPriority
.IntRootPathCost
));
760 assign(status
->root_port_id
, tree
->rootPortId
);
763 /* 12.8.1.3 Set CIST Bridge Protocol Parameters */
764 int MSTP_IN_set_cist_bridge_config(bridge_t
*br
, CIST_BridgeConfig
*cfg
)
766 bool changed
, changedBridgeTimes
, init
;
768 __u8 new_forward_delay
, new_max_age
;
771 per_tree_port_t
*ptp
;
773 /* Firstly, validation */
774 if(cfg
->set_bridge_max_age
)
776 new_max_age
= cfg
->bridge_max_age
;
777 if((6 > new_max_age
) || (40 < new_max_age
))
780 "Bridge Max Age must be between 6 and 40 seconds");
785 new_max_age
= br
->Max_Age
;
787 if(cfg
->set_bridge_forward_delay
)
789 new_forward_delay
= cfg
->bridge_forward_delay
;
790 if((4 > new_forward_delay
) || (30 < new_forward_delay
))
793 "Bridge Forward Delay must be between 4 and 30 seconds");
798 new_forward_delay
= br
->Forward_Delay
;
800 if(cfg
->set_bridge_max_age
|| cfg
->set_bridge_forward_delay
)
802 if((2 * (new_forward_delay
- 1)) < new_max_age
)
804 ERROR_BRNAME(br
, "Configured Bridge Times don't meet "
805 "2 * (Bridge Foward Delay - 1 second) >= Bridge Max Age");
810 if(cfg
->set_protocol_version
)
812 switch(cfg
->protocol_version
)
819 ERROR_BRNAME(br
, "Bad protocol version (%d)",
820 cfg
->protocol_version
);
825 if(cfg
->set_tx_hold_count
)
827 if((1 > cfg
->tx_hold_count
) || (10 < cfg
->tx_hold_count
))
830 "Transmit Hold Count must be between 1 and 10 seconds");
835 if(cfg
->set_max_hops
)
837 if((6 > cfg
->max_hops
) || (40 < cfg
->max_hops
))
839 ERROR_BRNAME(br
, "Bridge Max Hops must be between 6 and 40");
844 if(cfg
->set_bridge_hello_time
)
846 if((1 > cfg
->bridge_hello_time
) || (10 < cfg
->bridge_hello_time
))
848 ERROR_BRNAME(br
, "Bridge Hello Time must be between 1 and 10");
853 if(cfg
->set_bridge_ageing_time
)
855 if((10 > cfg
->bridge_ageing_time
)||(1000000 < cfg
->bridge_ageing_time
))
858 "Bridge Ageing Time must be between 10 and 1000000 seconds");
866 /* Secondly, do set */
867 changed
= changedBridgeTimes
= init
= false;
869 if(cfg
->set_bridge_max_age
|| cfg
->set_bridge_forward_delay
)
871 if(cmp(new_max_age
, !=, br
->Max_Age
)
872 || cmp(new_forward_delay
, !=, br
->Forward_Delay
)
875 assign(br
->Max_Age
, new_max_age
);
876 assign(br
->Forward_Delay
, new_forward_delay
);
877 changed
= changedBridgeTimes
= true;
881 if((cfg
->set_protocol_version
)
882 && (cfg
->protocol_version
!= br
->ForceProtocolVersion
)
885 br
->ForceProtocolVersion
= cfg
->protocol_version
;
886 changed
= init
= true;
889 if(cfg
->set_tx_hold_count
)
891 if(cfg
->tx_hold_count
!= br
->Transmit_Hold_Count
)
893 assign(br
->Transmit_Hold_Count
, cfg
->tx_hold_count
);
894 FOREACH_PORT_IN_BRIDGE(prt
, br
)
895 assign(prt
->txCount
, 0u);
900 if(cfg
->set_max_hops
)
902 if(cfg
->max_hops
!= br
->MaxHops
)
904 assign(br
->MaxHops
, cfg
->max_hops
);
905 changed
= changedBridgeTimes
= true;
909 if(cfg
->set_bridge_hello_time
)
911 if(cfg
->bridge_hello_time
!= br
->Hello_Time
)
913 INFO_BRNAME(br
, "bridge hello_time new=%hhu, old=%hhu",
914 cfg
->bridge_hello_time
, br
->Hello_Time
);
915 assign(br
->Hello_Time
, cfg
->bridge_hello_time
);
916 changed
= changedBridgeTimes
= true;
920 if(cfg
->set_bridge_ageing_time
)
922 if(cfg
->bridge_ageing_time
!= br
->Ageing_Time
)
924 INFO_BRNAME(br
, "bridge ageing_time new=%u, old=%u",
925 cfg
->bridge_ageing_time
, br
->Ageing_Time
);
926 assign(br
->Ageing_Time
, cfg
->bridge_ageing_time
);
930 /* Thirdly, finalize changes */
931 if(changedBridgeTimes
)
933 FOREACH_TREE_IN_BRIDGE(tree
, br
)
935 assign(tree
->BridgeTimes
.remainingHops
, br
->MaxHops
);
936 assign(tree
->BridgeTimes
.Forward_Delay
, br
->Forward_Delay
);
937 assign(tree
->BridgeTimes
.Max_Age
, br
->Max_Age
);
938 assign(tree
->BridgeTimes
.Hello_Time
, br
->Hello_Time
);
939 /* Comment found in rstpd by Srinivas Aji:
940 * Do this for any change in BridgeTimes.
941 * Otherwise we fail UNH rstp.op_D test 3.2 since when administratively
942 * setting BridgeForwardDelay, etc, the values don't propagate from
943 * rootTimes to designatedTimes immediately without this change.
945 FOREACH_PTP_IN_TREE(ptp
, tree
)
947 ptp
->selected
= false;
948 ptp
->reselect
= true;
949 /* TODO: change this when Hello_Time will be configurable
950 * per-port. For now, copy Bridge's Hello_Time
951 * to the port's Hello_Time.
953 assign(ptp
->portTimes
.Hello_Time
, br
->Hello_Time
);
958 if(changed
&& br
->bridgeEnabled
)
961 br_state_machines_begin(br
);
963 br_state_machines_run(br
);
969 /* 12.8.1.4 Set MSTI Bridge Protocol Parameters */
970 int MSTP_IN_set_msti_bridge_config(tree_t
*tree
, __u8 bridge_priority
)
972 per_tree_port_t
*ptp
;
975 if(15 < bridge_priority
)
977 ERROR_BRNAME(tree
->bridge
,
978 "MSTI %hu: Bridge Priority must be between 0 and 15",
979 __be16_to_cpu(tree
->MSTID
));
983 valuePri
= bridge_priority
<< 4;
984 if(GET_PRIORITY_FROM_IDENTIFIER(tree
->BridgeIdentifier
) == valuePri
)
986 SET_PRIORITY_IN_IDENTIFIER(valuePri
, tree
->BridgeIdentifier
);
987 tree
->BridgePriority
.RootID
= tree
->BridgePriority
.RRootID
=
988 tree
->BridgePriority
.DesignatedBridgeID
= tree
->BridgeIdentifier
;
989 /* 12.8.1.4.4 do not require reselect, but I think it is needed,
990 * because 12.8.1.3.4.c) requires it */
991 FOREACH_PTP_IN_TREE(ptp
, tree
)
993 ptp
->selected
= false;
994 ptp
->reselect
= true;
999 /* 12.8.2.1 Read CIST Port Parameters */
1000 void MSTP_IN_get_cist_port_status(port_t
*prt
, CIST_PortStatus
*status
)
1002 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
1004 status
->uptime
= (signed int)((prt
->bridge
)->uptime
)
1005 - (signed int)(cist
->start_time
);
1006 status
->state
= cist
->state
;
1007 assign(status
->port_id
, cist
->portId
);
1008 assign(status
->admin_external_port_path_cost
,
1009 prt
->AdminExternalPortPathCost
);
1010 assign(status
->external_port_path_cost
, prt
->ExternalPortPathCost
);
1011 assign(status
->designated_root
, cist
->portPriority
.RootID
);
1012 assign(status
->designated_external_cost
,
1013 __be32_to_cpu(cist
->portPriority
.ExtRootPathCost
));
1014 assign(status
->designated_bridge
, cist
->portPriority
.DesignatedBridgeID
);
1015 assign(status
->designated_port
, cist
->portPriority
.DesignatedPortID
);
1016 assign(status
->designated_regional_root
, cist
->portPriority
.RRootID
);
1017 assign(status
->designated_internal_cost
,
1018 __be32_to_cpu(cist
->portPriority
.IntRootPathCost
));
1019 status
->tc_ack
= prt
->tcAck
;
1020 assign(status
->port_hello_time
, cist
->portTimes
.Hello_Time
);
1021 status
->admin_edge_port
= prt
->AdminEdgePort
;
1022 status
->auto_edge_port
= prt
->AutoEdge
;
1023 status
->oper_edge_port
= prt
->operEdge
;
1024 status
->enabled
= prt
->portEnabled
;
1025 status
->admin_p2p
= prt
->AdminP2P
;
1026 status
->oper_p2p
= prt
->operPointToPointMAC
;
1027 status
->restricted_role
= prt
->restrictedRole
;
1028 status
->restricted_tcn
= prt
->restrictedTcn
;
1029 status
->role
= cist
->role
;
1030 status
->disputed
= cist
->disputed
;
1031 assign(status
->admin_internal_port_path_cost
,
1032 cist
->AdminInternalPortPathCost
);
1033 assign(status
->internal_port_path_cost
, cist
->InternalPortPathCost
);
1034 status
->bpdu_guard_port
= prt
->BpduGuardPort
;
1035 status
->bpdu_guard_error
= prt
->BpduGuardError
;
1036 status
->network_port
= prt
->NetworkPort
;
1037 status
->ba_inconsistent
= prt
->BaInconsistent
;
1038 status
->bpdu_filter_port
= prt
->bpduFilterPort
;
1039 status
->num_rx_bpdu_filtered
= prt
->num_rx_bpdu_filtered
;
1040 status
->num_rx_bpdu
= prt
->num_rx_bpdu
;
1041 status
->num_rx_tcn
= prt
->num_rx_tcn
;
1042 status
->num_tx_bpdu
= prt
->num_tx_bpdu
;
1043 status
->num_tx_tcn
= prt
->num_tx_tcn
;
1044 status
->num_trans_fwd
= prt
->num_trans_fwd
;
1045 status
->num_trans_blk
= prt
->num_trans_blk
;
1046 status
->rcvdBpdu
= prt
->rcvdBpdu
;
1047 status
->rcvdRSTP
= prt
->rcvdRSTP
;
1048 status
->rcvdSTP
= prt
->rcvdSTP
;
1049 status
->rcvdTcAck
= prt
->rcvdTcAck
;
1050 status
->rcvdTcn
= prt
->rcvdTcn
;
1051 status
->sendRSTP
= prt
->sendRSTP
;
1054 /* 12.8.2.2 Read MSTI Port Parameters */
1055 void MSTP_IN_get_msti_port_status(per_tree_port_t
*ptp
,
1056 MSTI_PortStatus
*status
)
1058 status
->uptime
= (signed int)((ptp
->port
->bridge
)->uptime
)
1059 - (signed int)(ptp
->start_time
);
1060 status
->state
= ptp
->state
;
1061 assign(status
->port_id
, ptp
->portId
);
1062 assign(status
->admin_internal_port_path_cost
,
1063 ptp
->AdminInternalPortPathCost
);
1064 assign(status
->internal_port_path_cost
, ptp
->InternalPortPathCost
);
1065 assign(status
->designated_regional_root
, ptp
->portPriority
.RRootID
);
1066 assign(status
->designated_internal_cost
,
1067 __be32_to_cpu(ptp
->portPriority
.IntRootPathCost
));
1068 assign(status
->designated_bridge
, ptp
->portPriority
.DesignatedBridgeID
);
1069 assign(status
->designated_port
, ptp
->portPriority
.DesignatedPortID
);
1070 status
->role
= ptp
->role
;
1071 status
->disputed
= ptp
->disputed
;
1074 /* 12.8.2.3 Set CIST port parameters */
1075 int MSTP_IN_set_cist_port_config(port_t
*prt
, CIST_PortConfig
*cfg
)
1078 __u32 new_ExternalPathCost
;
1080 per_tree_port_t
*cist
;
1081 bridge_t
*br
= prt
->bridge
;
1083 /* Firstly, validation */
1084 if(cfg
->set_admin_p2p
)
1086 switch(cfg
->admin_p2p
)
1093 cfg
->admin_p2p
= p2pAuto
;
1097 /* Secondly, do set */
1100 if(cfg
->set_admin_external_port_path_cost
)
1102 prt
->AdminExternalPortPathCost
= cfg
->admin_external_port_path_cost
;
1103 new_ExternalPathCost
= (0 == prt
->AdminExternalPortPathCost
) ?
1104 compute_pcost(GET_PORT_SPEED(prt
))
1105 : prt
->AdminExternalPortPathCost
;
1106 if(prt
->ExternalPortPathCost
!= new_ExternalPathCost
)
1108 assign(prt
->ExternalPortPathCost
, new_ExternalPathCost
);
1111 cist
= GET_CIST_PTP_FROM_PORT(prt
);
1112 cist
->selected
= false;
1113 cist
->reselect
= true;
1117 if(cfg
->set_admin_p2p
)
1119 prt
->AdminP2P
= cfg
->admin_p2p
;
1120 switch(prt
->AdminP2P
)
1130 new_p2p
= !!GET_PORT_DUPLEX(prt
);
1133 if(prt
->operPointToPointMAC
!= new_p2p
)
1135 prt
->operPointToPointMAC
= new_p2p
;
1140 if(cfg
->set_admin_edge_port
)
1142 if(prt
->AdminEdgePort
!= cfg
->admin_edge_port
)
1144 prt
->AdminEdgePort
= cfg
->admin_edge_port
;
1150 if(cfg
->set_auto_edge_port
)
1152 if(prt
->AutoEdge
!= cfg
->auto_edge_port
)
1154 prt
->AutoEdge
= cfg
->auto_edge_port
;
1159 if(cfg
->set_restricted_role
)
1161 if(prt
->restrictedRole
!= cfg
->restricted_role
)
1163 prt
->restrictedRole
= cfg
->restricted_role
;
1168 if(cfg
->set_restricted_tcn
)
1170 if(prt
->restrictedTcn
!= cfg
->restricted_tcn
)
1172 prt
->restrictedTcn
= cfg
->restricted_tcn
;
1177 if(cfg
->set_bpdu_guard_port
)
1179 if(prt
->BpduGuardPort
!= cfg
->bpdu_guard_port
)
1181 prt
->BpduGuardPort
= cfg
->bpdu_guard_port
;
1182 INFO_PRTNAME(br
, prt
,"BpduGuardPort new=%d", prt
->BpduGuardPort
);
1186 if(cfg
->set_network_port
)
1188 if(prt
->NetworkPort
!= cfg
->network_port
)
1190 prt
->NetworkPort
= cfg
->network_port
;
1191 INFO_PRTNAME(br
, prt
, "NetworkPort new=%d", prt
->NetworkPort
);
1192 /* When Network port config is removed and bridge assurance
1193 * inconsistency is set, clear the inconsistency.
1195 if(!prt
->NetworkPort
&& prt
->BaInconsistent
)
1197 prt
->BaInconsistent
= false;
1198 INFO_PRTNAME(br
, prt
, "Clear Bridge assurance inconsistency");
1204 if(cfg
->set_dont_txmt
)
1206 if(prt
->dontTxmtBpdu
!= cfg
->dont_txmt
)
1208 prt
->dontTxmtBpdu
= cfg
->dont_txmt
;
1209 INFO_PRTNAME(br
, prt
, "donttxmt new=%d", prt
->dontTxmtBpdu
);
1213 if(cfg
->set_bpdu_filter_port
)
1215 if (prt
->bpduFilterPort
!= cfg
->bpdu_filter_port
)
1217 prt
->bpduFilterPort
= cfg
->bpdu_filter_port
;
1218 prt
->num_rx_bpdu_filtered
= 0;
1219 INFO_PRTNAME(br
, prt
,"bpduFilterPort new=%d", prt
->bpduFilterPort
);
1223 if(changed
&& prt
->portEnabled
)
1224 br_state_machines_run(prt
->bridge
);
1229 /* 12.8.2.4 Set MSTI port parameters */
1230 int MSTP_IN_set_msti_port_config(per_tree_port_t
*ptp
, MSTI_PortConfig
*cfg
)
1233 __u32 new_InternalPathCost
;
1234 bool changed
= false;
1235 port_t
*prt
= ptp
->port
;
1236 bridge_t
*br
= prt
->bridge
;
1238 if(cfg
->set_port_priority
)
1240 if(15 < cfg
->port_priority
)
1242 ERROR_MSTINAME(br
, prt
, ptp
,
1243 "Port Priority must be between 0 and 15");
1246 valuePri
= cfg
->port_priority
<< 4;
1247 if(GET_PRIORITY_FROM_IDENTIFIER(ptp
->portId
) != valuePri
)
1249 SET_PRIORITY_IN_IDENTIFIER(valuePri
, ptp
->portId
);
1254 if(cfg
->set_admin_internal_port_path_cost
)
1256 ptp
->AdminInternalPortPathCost
= cfg
->admin_internal_port_path_cost
;
1257 new_InternalPathCost
= (0 == ptp
->AdminInternalPortPathCost
) ?
1258 compute_pcost(GET_PORT_SPEED(prt
))
1259 : ptp
->AdminInternalPortPathCost
;
1260 if(ptp
->InternalPortPathCost
!= new_InternalPathCost
)
1262 assign(ptp
->InternalPortPathCost
, new_InternalPathCost
);
1267 if(changed
&& prt
->portEnabled
)
1270 ptp
->selected
= false;
1271 ptp
->reselect
= true;
1273 br_state_machines_run(br
);
1279 /* 12.8.2.5 Force BPDU Migration Check */
1280 int MSTP_IN_port_mcheck(port_t
*prt
)
1282 bridge_t
*br
= prt
->bridge
;
1283 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
1285 if(rstpVersion(br
) && prt
->portEnabled
&& br
->bridgeEnabled
)
1288 cist
->proposing
= true;
1289 br_state_machines_run(br
);
1295 /* 12.10.3.8 Set VID to FID allocation */
1296 bool MSTP_IN_set_vid2fid(bridge_t
*br
, __u16 vid
, __u16 fid
)
1298 bool vid2mstid_changed
;
1300 if((vid
< 1) || (vid
> MAX_VID
) || (fid
> MAX_FID
))
1302 ERROR_BRNAME(br
, "Error allocating VID(%hu) to FID(%hu)", vid
, fid
);
1307 (br
->fid2mstid
[fid
] != br
->fid2mstid
[br
->vid2fid
[vid
]]);
1308 br
->vid2fid
[vid
] = fid
;
1309 if(vid2mstid_changed
)
1311 RecalcConfigDigest(br
);
1312 br_state_machines_begin(br
);
1318 /* Set all VID-to-FID mappings at once */
1319 bool MSTP_IN_set_all_vids2fids(bridge_t
*br
, __u16
*vids2fids
)
1321 bool vid2mstid_changed
;
1324 vid2mstid_changed
= false;
1325 for(vid
= 1; vid
<= MAX_VID
; ++vid
)
1327 if(vids2fids
[vid
] > MAX_FID
)
1328 { /* Incorrect value == keep prev value */
1329 vids2fids
[vid
] = br
->vid2fid
[vid
];
1332 if(br
->fid2mstid
[vids2fids
[vid
]] != br
->fid2mstid
[br
->vid2fid
[vid
]])
1333 vid2mstid_changed
= true;
1335 memcpy(br
->vid2fid
, vids2fids
, sizeof(br
->vid2fid
));
1336 if(vid2mstid_changed
)
1338 RecalcConfigDigest(br
);
1339 br_state_machines_begin(br
);
1345 /* 12.12.2.2 Set FID to MSTID allocation */
1346 bool MSTP_IN_set_fid2mstid(bridge_t
*br
, __u16 fid
, __u16 mstid
)
1355 ERROR_BRNAME(br
, "Bad FID(%hu)", fid
);
1359 MSTID
= __cpu_to_be16(mstid
);
1361 FOREACH_TREE_IN_BRIDGE(tree
, br
)
1363 if(tree
->MSTID
== MSTID
)
1371 ERROR_BRNAME(br
, "MSTID(%hu) not found", mstid
);
1375 if(br
->fid2mstid
[fid
] != MSTID
)
1377 br
->fid2mstid
[fid
] = MSTID
;
1378 /* check if there are VLANs using this FID */
1379 for(vid
= 1; vid
<= MAX_VID
; ++vid
)
1381 if(br
->vid2fid
[vid
] == fid
)
1383 RecalcConfigDigest(br
);
1384 br_state_machines_begin(br
);
1393 /* Set all FID-to-MSTID mappings at once */
1394 bool MSTP_IN_set_all_fids2mstids(bridge_t
*br
, __u16
*fids2mstids
)
1397 __be16 MSTID
[MAX_FID
+ 1];
1398 bool found
, vid2mstid_changed
;
1400 __be16 prev_vid2mstid
[MAX_VID
+ 2];
1402 for(fid
= 0; fid
<= MAX_FID
; ++fid
)
1404 if(fids2mstids
[fid
] > MAX_MSTID
)
1405 { /* Incorrect value == keep prev value */
1406 fids2mstids
[fid
] = __be16_to_cpu(MSTID
[fid
] = br
->fid2mstid
[fid
]);
1409 MSTID
[fid
] = __cpu_to_be16(fids2mstids
[fid
]);
1411 FOREACH_TREE_IN_BRIDGE(tree
, br
)
1413 if(tree
->MSTID
== MSTID
[fid
])
1422 "Error allocating FID(%hu) to MSTID(%hu): MSTID not found",
1423 fid
, fids2mstids
[fid
]);
1428 for(vid
= 1; vid
<= MAX_VID
; ++vid
)
1429 prev_vid2mstid
[vid
] = br
->fid2mstid
[br
->vid2fid
[vid
]];
1430 memcpy(br
->fid2mstid
, MSTID
, sizeof(br
->fid2mstid
));
1431 vid2mstid_changed
= false;
1432 for(vid
= 1; vid
<= MAX_VID
; ++vid
)
1434 if(prev_vid2mstid
[vid
] != br
->fid2mstid
[br
->vid2fid
[vid
]])
1436 vid2mstid_changed
= true;
1440 if(vid2mstid_changed
)
1442 RecalcConfigDigest(br
);
1443 br_state_machines_begin(br
);
1449 /* 12.12.1.1 Read MSTI List */
1450 bool MSTP_IN_get_mstilist(bridge_t
*br
, int *num_mstis
, __u16
*mstids
)
1455 FOREACH_TREE_IN_BRIDGE(tree
, br
)
1457 mstids
[*num_mstis
] = __be16_to_cpu(tree
->MSTID
);
1458 /* Check for "<", not for "<=", as num_mstis include CIST */
1459 if(MAX_IMPLEMENTATION_MSTIS
< ++(*num_mstis
))
1466 /* 12.12.1.2 Create MSTI */
1467 bool MSTP_IN_create_msti(bridge_t
*br
, __u16 mstid
)
1469 tree_t
*tree
, *tree_after
, *new_tree
;
1470 per_tree_port_t
*ptp
, *nxt
, *ptp_after
, *new_ptp
;
1474 if((mstid
< 1) || (mstid
> MAX_MSTID
))
1476 ERROR_BRNAME(br
, "Bad MSTID(%hu)", mstid
);
1480 MSTID
= __cpu_to_be16(mstid
);
1481 /* Find place where to insert new MSTID.
1482 * Also check if such MSTID is already in the list.
1483 * Also count existing mstis.
1487 FOREACH_TREE_IN_BRIDGE(tree
, br
)
1489 if(tree
->MSTID
== MSTID
)
1491 INFO_BRNAME(br
, "MSTID(%hu) is already in the list", mstid
);
1492 return true; /* yes, it is success */
1494 if(cmp(tree
->MSTID
, <, MSTID
))
1499 if(NULL
== tree_after
)
1501 ERROR_BRNAME(br
, "Can't add MSTID(%hu): no CIST in the list", mstid
);
1504 /* End of Sanity check */
1506 /* Check for "<", not for "<=", as num_of_mstis include CIST */
1507 if(MAX_IMPLEMENTATION_MSTIS
< num_of_mstis
)
1509 ERROR_BRNAME(br
, "Can't add MSTID(%hu): maximum count(%u) reached",
1510 mstid
, MAX_IMPLEMENTATION_MSTIS
);
1514 /* Create new tree and its list of PerTreePort structures */
1515 tree
= GET_CIST_TREE(br
);
1516 if(!(new_tree
=create_tree(br
,tree
->BridgeIdentifier
.s
.mac_address
,MSTID
)))
1519 FOREACH_PTP_IN_TREE(ptp_after
, tree_after
)
1521 if(!(new_ptp
= create_ptp(new_tree
, ptp_after
->port
)))
1523 /* Remove and free all previously created entries in tree's list */
1524 list_for_each_entry_safe(ptp
, nxt
, &new_tree
->ports
, tree_list
)
1526 list_del(&ptp
->port_list
);
1527 list_del(&ptp
->tree_list
);
1532 list_add(&new_ptp
->port_list
, &ptp_after
->port_list
);
1533 list_add_tail(&new_ptp
->tree_list
, &new_tree
->ports
);
1536 list_add(&new_tree
->bridge_list
, &tree_after
->bridge_list
);
1537 /* There are no FIDs allocated to this MSTID, so VID-to-MSTID mapping
1538 * did not change. So, no need in RecalcConfigDigest.
1539 * Just initialize state machines for this tree.
1541 tree_state_machines_begin(new_tree
);
1545 /* 12.12.1.3 Delete MSTI */
1546 bool MSTP_IN_delete_msti(bridge_t
*br
, __u16 mstid
)
1549 per_tree_port_t
*ptp
, *nxt
;
1552 __be16 MSTID
= __cpu_to_be16(mstid
);
1554 if((mstid
< 1) || (mstid
> MAX_MSTID
))
1556 ERROR_BRNAME(br
, "Bad MSTID(%hu)", mstid
);
1560 /* Check if there are FIDs associated with this MSTID */
1561 for(fid
= 0; fid
<= MAX_FID
; ++fid
)
1563 if(br
->fid2mstid
[fid
] == MSTID
)
1566 "Can't delete MSTID(%hu): there are FIDs allocated to it",
1573 FOREACH_TREE_IN_BRIDGE(tree
, br
)
1575 if(tree
->MSTID
== MSTID
)
1583 INFO_BRNAME(br
, "MSTID(%hu) is not in the list", mstid
);
1584 return true; /* yes, it is success */
1587 list_del(&tree
->bridge_list
);
1588 list_for_each_entry_safe(ptp
, nxt
, &tree
->ports
, tree_list
)
1590 list_del(&ptp
->port_list
);
1591 list_del(&ptp
->tree_list
);
1596 /* There are no FIDs allocated to this MSTID, so VID-to-MSTID mapping
1597 * did not change. So, no need in RecalcConfigDigest.
1598 * Give state machine a spare run, just for the case...
1600 br_state_machines_run(br
);
1604 /* 12.12.3.4 Set MST Configuration Identifier Elements */
1605 void MSTP_IN_set_mst_config_id(bridge_t
*br
, __u16 revision
, __u8
*name
)
1607 __be16 valueRevision
= __cpu_to_be16(revision
);
1608 bool changed
= (0 != strncmp((char *)name
, (char *)br
->MstConfigId
.s
.configuration_name
,
1609 sizeof(br
->MstConfigId
.s
.configuration_name
))
1611 || (valueRevision
!= br
->MstConfigId
.s
.revision_level
);
1615 assign(br
->MstConfigId
.s
.revision_level
, valueRevision
);
1616 memset(br
->MstConfigId
.s
.configuration_name
, 0,
1617 sizeof(br
->MstConfigId
.s
.configuration_name
));
1618 strncpy((char *)br
->MstConfigId
.s
.configuration_name
, (char *)name
,
1619 sizeof(br
->MstConfigId
.s
.configuration_name
) - 1);
1620 br_state_machines_begin(br
);
1625 * If hint_SetToYes == true, some tcWhile in this tree has non-zero value.
1626 * If hint_SetToYes == false, some tcWhile in this tree has just became zero,
1627 * so we should check all other tcWhile's in this tree.
1629 static void set_TopologyChange(tree_t
*tree
, bool hint_SetToYes
, port_t
*port
)
1631 per_tree_port_t
*ptp
;
1632 bool prev_tc_not_set
= !tree
->topology_change
;
1636 tree
->topology_change
= true;
1637 tree
->time_since_topology_change
= 0;
1639 ++(tree
->topology_change_count
);
1640 strncpy(tree
->topology_change_port
, tree
->last_topology_change_port
,
1642 strncpy(tree
->last_topology_change_port
, port
->sysdeps
.name
, IFNAMSIZ
);
1646 /* Some tcWhile has just became zero. Check if we need reset
1647 * topology_change flag */
1651 tree
->topology_change
= false;
1652 FOREACH_PTP_IN_TREE(ptp
, tree
)
1654 if(0 != ptp
->tcWhile
)
1656 tree
->topology_change
= true;
1657 tree
->time_since_topology_change
= 0;
1663 /* Helper functions, compare two priority vectors */
1664 static bool samePriorityAndTimers(port_priority_vector_t
*vec1
,
1665 port_priority_vector_t
*vec2
,
1672 if(cmp(time1
->Forward_Delay
, !=, time2
->Forward_Delay
))
1674 if(cmp(time1
->Max_Age
, !=, time2
->Max_Age
))
1676 if(cmp(time1
->Message_Age
, !=, time2
->Message_Age
))
1678 if(cmp(time1
->Hello_Time
, !=, time2
->Hello_Time
))
1681 if(cmp(vec1
->RootID
, !=, vec2
->RootID
))
1683 if(cmp(vec1
->ExtRootPathCost
, !=, vec2
->ExtRootPathCost
))
1687 if(cmp(time1
->remainingHops
, !=, time2
->remainingHops
))
1690 if(cmp(vec1
->RRootID
, !=, vec2
->RRootID
))
1692 if(cmp(vec1
->IntRootPathCost
, !=, vec2
->IntRootPathCost
))
1694 if(cmp(vec1
->DesignatedBridgeID
, !=, vec2
->DesignatedBridgeID
))
1696 if(cmp(vec1
->DesignatedPortID
, !=, vec2
->DesignatedPortID
))
1702 static bool betterorsamePriority(port_priority_vector_t
*vec1
,
1703 port_priority_vector_t
*vec2
,
1704 port_identifier_t pId1
,
1705 port_identifier_t pId2
,
1712 if(0 < (result
= _ncmp(vec1
->RootID
, vec2
->RootID
)))
1713 return false; /* worse */
1715 return true; /* better */
1716 /* The same. Check further. */
1717 if(0 < (result
= _ncmp(vec1
->ExtRootPathCost
, vec2
->ExtRootPathCost
)))
1718 return false; /* worse */
1720 return true; /* better */
1721 /* The same. Check further. */
1724 if(0 < (result
= _ncmp(vec1
->RRootID
, vec2
->RRootID
)))
1725 return false; /* worse */
1727 return true; /* better */
1728 /* The same. Check further. */
1730 if(0 < (result
= _ncmp(vec1
->IntRootPathCost
, vec2
->IntRootPathCost
)))
1731 return false; /* worse */
1733 return true; /* better */
1734 /* The same. Check further. */
1736 if(0 < (result
= _ncmp(vec1
->DesignatedBridgeID
, vec2
->DesignatedBridgeID
)))
1737 return false; /* worse */
1739 return true; /* better */
1740 /* The same. Check further. */
1742 if(0 < (result
= _ncmp(vec1
->DesignatedPortID
, vec2
->DesignatedPortID
)))
1743 return false; /* worse */
1745 return true; /* better */
1746 /* The same. Check further. */
1748 /* Port ID is a tie-breaker */
1749 return cmp(pId1
, <=, pId2
);
1752 /* 13.26.1 betterorsameInfo */
1753 static bool betterorsameInfo(per_tree_port_t
*ptp
, port_info_origin_t newInfoIs
)
1755 if((ioReceived
== newInfoIs
) && (ioReceived
== ptp
->infoIs
))
1756 return betterorsamePriority(&ptp
->msgPriority
,
1758 0, 0, (0 == ptp
->MSTID
));
1759 else if((ioMine
== newInfoIs
) && (ioMine
== ptp
->infoIs
))
1760 return betterorsamePriority(&ptp
->designatedPriority
,
1762 0, 0, (0 == ptp
->MSTID
));
1766 /* 13.26.2 clearAllRcvdMsgs */
1767 static bool clearAllRcvdMsgs(port_t
*prt
, bool dry_run
)
1769 per_tree_port_t
*ptp
;
1773 FOREACH_PTP_IN_PORT(ptp
, prt
)
1779 FOREACH_PTP_IN_PORT(ptp
, prt
)
1780 ptp
->rcvdMsg
= false;
1785 /* 13.26.3 clearReselectTree */
1786 static void clearReselectTree(tree_t
*tree
)
1788 per_tree_port_t
*ptp
;
1790 FOREACH_PTP_IN_TREE(ptp
, tree
)
1791 ptp
->reselect
= false;
1794 /* 13.26.4 fromSameRegion */
1795 static bool fromSameRegion(port_t
*prt
)
1797 /* Check for rcvdRSTP is superfluous here */
1798 if((protoMSTP
> prt
->rcvdBpduData
.protocolVersion
)/* || (!prt->rcvdRSTP)*/)
1800 return cmp(prt
->bridge
->MstConfigId
,
1801 ==, prt
->rcvdBpduData
.mstConfigurationIdentifier
);
1804 /* 13.26.5 newTcWhile */
1805 static void newTcWhile(per_tree_port_t
*ptp
)
1807 if(0 != ptp
->tcWhile
)
1810 tree_t
*tree
= ptp
->tree
;
1811 port_t
*prt
= ptp
->port
;
1815 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
1817 ptp
->tcWhile
= cist
->portTimes
.Hello_Time
+ 1;
1818 set_TopologyChange(tree
, true, prt
);
1821 prt
->newInfo
= true;
1823 prt
->newInfoMsti
= true;
1827 times_t
*times
= &tree
->rootTimes
;
1829 ptp
->tcWhile
= times
->Max_Age
+ times
->Forward_Delay
;
1830 set_TopologyChange(tree
, true, prt
);
1833 /* 13.26.6 rcvInfo */
1834 static port_info_t
rcvInfo(per_tree_port_t
*ptp
)
1836 msti_configuration_message_t
*msti_msg
;
1837 per_tree_port_t
*ptp_1
;
1838 bool roleIsDesignated
, cist
;
1839 bool msg_Better_port
, msg_SamePriorityAndTimers_port
;
1840 port_priority_vector_t
*mPri
= &(ptp
->msgPriority
);
1841 times_t
*mTimes
= &(ptp
->msgTimes
);
1842 port_t
*prt
= ptp
->port
;
1843 bpdu_t
*b
= &(prt
->rcvdBpduData
);
1845 if(bpduTypeTCN
== b
->bpduType
)
1847 prt
->rcvdTcn
= true;
1848 FOREACH_PTP_IN_PORT(ptp_1
, prt
)
1849 ptp_1
->rcvdTc
= true;
1855 if(protoSTP
!= b
->protocolVersion
)
1857 switch(BPDU_FLAGS_ROLE_GET(b
->flags
))
1859 case encodedRoleAlternateBackup
:
1860 case encodedRoleRoot
:
1861 roleIsDesignated
= false;
1863 case encodedRoleDesignated
:
1864 roleIsDesignated
= true;
1866 case encodedRoleMaster
:
1867 /* 802.1D-2004 S9.2.9 P61. The Unknown value of Port Role
1868 * cannot be generated by a valid implementation; however,
1869 * this value is accepted on receipt. roleMaster in MSTP is
1870 * roleUnknown in RSTP.
1871 * NOTE.If the Unknown value of the Port Role parameter is
1872 * received, the state machines will effectively treat the RST
1873 * BPDU as if it were a Configuration BPDU
1875 if(protoRSTP
== b
->protocolVersion
)
1877 roleIsDesignated
= true;
1890 { /* 13.26.6.NOTE: A Configuration BPDU implicitly conveys a
1891 * Designated Port Role */
1892 roleIsDesignated
= true;
1896 assign(mPri
->RRootID
, b
->cistRRootID
);
1897 assign(mPri
->DesignatedPortID
, b
->cistPortID
);
1898 assign(mPri
->RootID
, b
->cistRootID
);
1899 assign(mPri
->ExtRootPathCost
, b
->cistExtRootPathCost
);
1901 #define NEAREST_WHOLE_SECOND(msgTime) \
1902 ((128 > msgTime[1]) ? msgTime[0] : msgTime[0] + 1)
1903 mTimes
->Forward_Delay
= NEAREST_WHOLE_SECOND(b
->ForwardDelay
);
1904 mTimes
->Max_Age
= NEAREST_WHOLE_SECOND(b
->MaxAge
);
1905 mTimes
->Message_Age
= NEAREST_WHOLE_SECOND(b
->MessageAge
);
1906 mTimes
->Hello_Time
= NEAREST_WHOLE_SECOND(b
->HelloTime
);
1907 if(protoMSTP
> b
->protocolVersion
)
1908 { /* STP Configuration BPDU or RST BPDU */
1909 assign(mPri
->IntRootPathCost
, __constant_cpu_to_be32(0));
1910 assign(mPri
->DesignatedBridgeID
, b
->cistRRootID
);
1911 /* messageTimes.remainingHops */
1912 assign(mTimes
->remainingHops
, prt
->bridge
->MaxHops
);
1916 assign(mPri
->IntRootPathCost
, b
->cistIntRootPathCost
);
1917 assign(mPri
->DesignatedBridgeID
, b
->cistBridgeID
);
1918 /* messageTimes.remainingHops */
1919 assign(mTimes
->remainingHops
, b
->cistRemainingHops
);
1924 if(protoMSTP
> b
->protocolVersion
)
1926 msti_msg
= ptp
->rcvdMstiConfig
;
1927 switch(BPDU_FLAGS_ROLE_GET(msti_msg
->flags
))
1929 case encodedRoleAlternateBackup
:
1930 case encodedRoleRoot
:
1931 roleIsDesignated
= false;
1933 case encodedRoleDesignated
:
1934 roleIsDesignated
= true;
1941 assign(mPri
->RRootID
, msti_msg
->mstiRRootID
);
1942 assign(mPri
->IntRootPathCost
, msti_msg
->mstiIntRootPathCost
);
1943 /* Build MSTI DesignatedBridgeID */
1944 assign(mPri
->DesignatedBridgeID
, b
->cistBridgeID
);
1945 assign(mPri
->DesignatedBridgeID
.s
.priority
, ptp
->MSTID
);
1946 SET_PRIORITY_IN_IDENTIFIER(msti_msg
->bridgeIdentifierPriority
,
1947 mPri
->DesignatedBridgeID
);
1948 /* Build MSTI DesignatedPortID */
1949 assign(mPri
->DesignatedPortID
, b
->cistPortID
);
1950 SET_PRIORITY_IN_IDENTIFIER(msti_msg
->portIdentifierPriority
,
1951 mPri
->DesignatedPortID
);
1953 assign(mTimes
->remainingHops
, msti_msg
->remainingHops
);
1956 msg_Better_port
= !betterorsamePriority(&(ptp
->portPriority
), mPri
,
1958 if(roleIsDesignated
)
1962 || ((0 == memcmp(mPri
->DesignatedBridgeID
.s
.mac_address
,
1963 ptp
->portPriority
.DesignatedBridgeID
.s
.mac_address
,
1966 && (0 == ((mPri
->DesignatedPortID
1967 ^ ptp
->portPriority
.DesignatedPortID
1968 ) & __constant_cpu_to_be16(0x0FFF)
1973 return SuperiorDesignatedInfo
;
1976 /* We already know that msgPriority _IS_NOT_BETTER_than portPriority.
1977 * So, if msgPriority _IS_SAME_OR_BETTER_than portPriority then
1978 * msgPriority _IS_SAME_as portPriority.
1980 msg_SamePriorityAndTimers_port
=
1981 samePriorityAndTimers(mPri
, &(ptp
->portPriority
),
1982 mTimes
, &(ptp
->portTimes
),
1984 if((!msg_SamePriorityAndTimers_port
)
1985 && betterorsamePriority(mPri
, &(ptp
->portPriority
), 0, 0, cist
)
1987 return SuperiorDesignatedInfo
;
1990 if(msg_SamePriorityAndTimers_port
&& (ioReceived
== ptp
->infoIs
))
1991 return RepeatedDesignatedInfo
;
1994 return InferiorDesignatedInfo
;
1998 if(!msg_Better_port
)
1999 return InferiorRootAlternateInfo
;
2004 /* 13.26.7 recordAgreement */
2005 static void recordAgreement(per_tree_port_t
*ptp
)
2007 bool cist_agreed
, cist_proposing
;
2008 per_tree_port_t
*cist
;
2009 port_t
*prt
= ptp
->port
;
2010 bpdu_t
*b
= &(prt
->rcvdBpduData
);
2014 if(rstpVersion(prt
->bridge
) && prt
->operPointToPointMAC
2015 && (b
->flags
& (1 << offsetAgreement
))
2019 ptp
->proposing
= false;
2022 ptp
->agreed
= false;
2023 cist_agreed
= ptp
->agreed
;
2024 cist_proposing
= ptp
->proposing
;
2025 if(!prt
->rcvdInternal
)
2026 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
2028 ptp
->agreed
= cist_agreed
;
2029 ptp
->proposing
= cist_proposing
;
2034 cist
= GET_CIST_PTP_FROM_PORT(prt
);
2035 if(prt
->operPointToPointMAC
2036 && cmp(b
->cistRootID
, ==, cist
->portPriority
.RootID
)
2037 && cmp(b
->cistExtRootPathCost
, ==, cist
->portPriority
.ExtRootPathCost
)
2038 && cmp(b
->cistRRootID
, ==, cist
->portPriority
.RRootID
)
2039 && (ptp
->rcvdMstiConfig
->flags
& (1 << offsetAgreement
))
2043 ptp
->proposing
= false;
2046 ptp
->agreed
= false;
2049 /* 13.26.8 recordDispute */
2050 static void recordDispute(per_tree_port_t
*ptp
)
2057 /* 802.1Q-2005(-2011) is somewhat unclear for the case
2058 * (!prt->rcvdInternal): if we should record dispute for all MSTIs
2059 * unconditionally or only when CIST Learning flag is set in BPDU.
2060 * I guess that in this case MSTIs should be in sync with CIST
2061 * so record dispute for the MSTIs only when the same is done for CIST.
2062 * Additional supporting argument to this guess is that in
2063 * setTcFlags() we do the same.
2064 * But that is only a guess and I could be wrong here ;)
2066 if(prt
->rcvdBpduData
.flags
& (1 << offsetLearnig
))
2068 ptp
->disputed
= true;
2069 ptp
->agreed
= false;
2070 if(!prt
->rcvdInternal
)
2071 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
2073 ptp
->disputed
= true;
2074 ptp
->agreed
= false;
2080 if(ptp
->rcvdMstiConfig
->flags
& (1 << offsetLearnig
))
2082 ptp
->disputed
= true;
2083 ptp
->agreed
= false;
2087 /* 13.26.9 recordMastered */
2088 static void recordMastered(per_tree_port_t
*ptp
)
2090 port_t
*prt
= ptp
->port
;
2094 if(!prt
->rcvdInternal
)
2095 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
2096 ptp
->mastered
= false;
2100 ptp
->mastered
= prt
->operPointToPointMAC
2101 && (ptp
->rcvdMstiConfig
->flags
& (1 << offsetMaster
));
2104 /* 13.26.f) recordPriority */
2105 static void recordPriority(per_tree_port_t
*ptp
)
2107 assign(ptp
->portPriority
, ptp
->msgPriority
);
2110 /* 13.26.10 recordProposal */
2111 static void recordProposal(per_tree_port_t
*ptp
)
2116 /* 802.1Q-2005 says to check if received message conveys
2117 * a Designated Port Role. But there is no need in this check,
2118 * as it is always true. This function is called only in two states:
2119 * PISM_SUPERIOR_DESIGNATED and PISM_REPEATED_DESIGNATED, which
2120 * can be entered only if rcvInfo returns
2121 * SuperiorDesignatedInfo or RepeatedDesignatedInfo.
2122 * Which in turn can only happen if message conveys designated role
2128 if(prt
->rcvdBpduData
.flags
& (1 << offsetProposal
))
2129 ptp
->proposed
= true;
2130 cist_proposed
= ptp
->proposed
;
2131 if(!prt
->rcvdInternal
)
2132 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
2133 ptp
->proposed
= cist_proposed
;
2137 if(ptp
->rcvdMstiConfig
->flags
& (1 << offsetProposal
))
2138 ptp
->proposed
= true;
2141 /* 13.26.11 recordTimes */
2142 static void recordTimes(per_tree_port_t
*ptp
)
2144 /* 802.1Q-2005 and 802.1D-2004 both say that we have to copy
2145 * Hello_Time from msgTimes to portTimes.
2146 * 802.1Q-2011, on the other hand, says that Hello_Time should be set
2147 * to the default here.
2148 * As we have configurable Hello_Time, I choose the third option:
2149 * preserve the configured Hello_Time, It is in accordance with the
2150 * spirit of 802.1Q-2011, if we allow Hello_Time to be configurable.
2152 __u8 prev_Hello_Time
= 0;
2153 assign(prev_Hello_Time
, ptp
->portTimes
.Hello_Time
);
2154 assign(ptp
->portTimes
, ptp
->msgTimes
);
2155 assign(ptp
->portTimes
.Hello_Time
, prev_Hello_Time
);
2158 /* 13.24.s) + 17.19.7 of 802.1D : fdbFlush */
2159 static void set_fdbFlush(per_tree_port_t
*ptp
)
2161 port_t
*prt
= ptp
->port
;
2163 if(prt
->operEdge
|| prt
->deleted
)
2165 ptp
->fdbFlush
= false;
2169 bridge_t
*br
= prt
->bridge
;
2173 ptp
->fdbFlush
= true;
2174 ptp
->calledFromFlushRoutine
= true;
2175 MSTP_OUT_flush_all_fids(ptp
);
2176 ptp
->calledFromFlushRoutine
= false;
2180 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
2181 unsigned int FwdDelay
= cist
->designatedTimes
.Forward_Delay
;
2182 /* Initiate rapid ageing */
2183 MSTP_OUT_set_ageing_time(prt
, FwdDelay
);
2184 assign(prt
->rapidAgeingWhile
, FwdDelay
);
2185 ptp
->fdbFlush
= false;
2189 /* 13.26.12 setRcvdMsgs */
2190 static void setRcvdMsgs(port_t
*prt
)
2192 msti_configuration_message_t
*msti_msg
;
2196 per_tree_port_t
*ptp
= GET_CIST_PTP_FROM_PORT(prt
);
2197 ptp
->rcvdMsg
= true;
2199 /* 802.1Q-2005 says:
2200 * "Make the received CST or CIST message available to the CIST Port
2201 * Information state machines"
2202 * No need to do something special here, we already have rcvdBpduData.
2205 if(prt
->rcvdInternal
)
2207 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
2210 /* Find if message for this MSTI is conveyed in the BPDU */
2211 for(i
= 0, msti_msg
= prt
->rcvdBpduData
.mstConfiguration
;
2212 i
< prt
->rcvdBpduNumOfMstis
;
2215 msg_MSTID
= msti_msg
->mstiRRootID
.s
.priority
2216 & __constant_cpu_to_be16(0x0FFF);
2217 if(msg_MSTID
== ptp
->MSTID
)
2225 ptp
->rcvdMsg
= true;
2226 /* 802.1Q-2005 says:
2227 * "Make available each MSTI message and the common parts of
2228 * the CIST message priority (the CIST Root Identifier,
2229 * External Root Path Cost and Regional Root Identifier)
2230 * to the Port Information state machine for that MSTI"
2231 * We set pointer to the MSTI configuration message for
2232 * fast access, while do not anything special for common
2233 * parts of the message, as the whole message is available
2236 ptp
->rcvdMstiConfig
= msti_msg
;
2242 /* 13.26.13 setReRootTree */
2243 static void setReRootTree(tree_t
*tree
)
2245 per_tree_port_t
*ptp
;
2247 FOREACH_PTP_IN_TREE(ptp
, tree
)
2251 /* 13.26.14 setSelectedTree */
2252 static void setSelectedTree(tree_t
*tree
)
2254 per_tree_port_t
*ptp
;
2257 * 802.1Q-2005 says that I should check "reselect" var
2258 * and take no action if it is "true" for any of the ports.
2259 * But there is no need in this check as setSelectedTree is called
2260 * only from PRSSM_to_ROLE_SELECTION, which is atomic, and it is called
2261 * in this sequence (13.33):
2262 * clearReselectTree(tree);
2263 * updtRolesTree(tree);
2264 * setSelectedTree(tree);
2265 * And we know that clearReselectTree resets "reselect" for all ports
2266 * and updtRolesTree() does not change value of "reselect".
2268 FOREACH_PTP_IN_TREE(ptp
, tree
)
2269 ptp
->selected
= true;
2272 /* 13.26.15 setSyncTree */
2273 static void setSyncTree(tree_t
*tree
)
2275 per_tree_port_t
*ptp
;
2277 FOREACH_PTP_IN_TREE(ptp
, tree
)
2281 /* 13.26.16 setTcFlags */
2282 static void setTcFlags(per_tree_port_t
*ptp
)
2290 cistFlags
= prt
->rcvdBpduData
.flags
;
2291 if(cistFlags
& (1 << offsetTcAck
))
2292 prt
->rcvdTcAck
= true;
2293 if(cistFlags
& (1 << offsetTc
))
2296 if(!prt
->rcvdInternal
)
2297 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
2298 ptp
->proposed
= true;
2303 if(ptp
->rcvdMstiConfig
->flags
& (1 << offsetTc
))
2307 /* 13.26.17 setTcPropTree */
2308 static void setTcPropTree(per_tree_port_t
*ptp
)
2310 per_tree_port_t
*ptp_1
;
2312 if(ptp
->port
->restrictedTcn
)
2315 FOREACH_PTP_IN_TREE(ptp_1
, ptp
->tree
)
2318 ptp_1
->tcProp
= true;
2322 /* 13.26.18 syncMaster */
2323 static void syncMaster(bridge_t
*br
)
2325 per_tree_port_t
*ptp
;
2326 tree_t
*tree
= GET_CIST_TREE(br
);
2329 list_for_each_entry_continue(tree
, &br
->trees
, bridge_list
)
2331 FOREACH_PTP_IN_TREE(ptp
, tree
)
2333 /* for each Port that has infoInternal set */
2334 if(ptp
->port
->infoInternal
)
2337 ptp
->agreed
= false;
2338 ptp
->synced
= false;
2345 /* 13.26.19 txConfig */
2346 static void txConfig(port_t
*prt
)
2349 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
2351 if(prt
->deleted
|| (roleDisabled
== cist
->role
) || prt
->dontTxmtBpdu
)
2354 b
.protocolIdentifier
= 0;
2355 b
.protocolVersion
= protoSTP
;
2356 b
.bpduType
= bpduTypeConfig
;
2357 /* Standard says "tcWhile ... for the Port". Which one tcWhile?
2358 * I guess that this means tcWhile for the CIST.
2359 * But that is only a guess and I could be wrong here ;)
2361 b
.flags
= (0 != cist
->tcWhile
) ? (1 << offsetTc
) : 0;
2363 b
.flags
|= (1 << offsetTcAck
);
2364 assign(b
.cistRootID
, cist
->designatedPriority
.RootID
);
2365 assign(b
.cistExtRootPathCost
, cist
->designatedPriority
.ExtRootPathCost
);
2366 assign(b
.cistRRootID
, cist
->designatedPriority
.DesignatedBridgeID
);
2367 assign(b
.cistPortID
, cist
->designatedPriority
.DesignatedPortID
);
2368 b
.MessageAge
[0] = cist
->designatedTimes
.Message_Age
;
2369 b
.MessageAge
[1] = 0;
2370 b
.MaxAge
[0] = cist
->designatedTimes
.Max_Age
;
2372 b
.HelloTime
[0] = cist
->portTimes
.Hello_Time
; /* ! use portTimes ! */
2374 b
.ForwardDelay
[0] = cist
->designatedTimes
.Forward_Delay
;
2375 b
.ForwardDelay
[1] = 0;
2377 MSTP_OUT_tx_bpdu(prt
, &b
, CONFIG_BPDU_SIZE
);
2380 static inline __u8
message_role_from_port_role(per_tree_port_t
*ptp
)
2385 return encodedRoleRoot
;
2386 case roleDesignated
:
2387 return encodedRoleDesignated
;
2390 return encodedRoleAlternateBackup
;
2392 return encodedRoleMaster
;
2394 ERROR_PRTNAME(ptp
->port
->bridge
, ptp
->port
,
2395 "Attempt to send from port with Disabled role");
2396 return encodedRoleAlternateBackup
;
2400 /* 802.1Q-2005: 13.26.20 txMstp
2401 * 802.1Q-2011: 13.27.27 txRstp
2403 static void txMstp(port_t
*prt
)
2406 bridge_t
*br
= prt
->bridge
;
2407 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
2408 int msti_msgs_total_size
;
2409 per_tree_port_t
*ptp
;
2410 msti_configuration_message_t
*msti_msg
;
2412 if(prt
->deleted
|| (roleDisabled
== cist
->role
) || prt
->dontTxmtBpdu
)
2415 b
.protocolIdentifier
= 0;
2416 b
.bpduType
= bpduTypeRST
;
2417 /* Standard says "{tcWhile, agree, proposing} ... for the Port".
2418 * Which one {tcWhile, agree, proposing}?
2419 * I guess that this means {tcWhile, agree, proposing} for the CIST.
2420 * But that is only a guess and I could be wrong here ;)
2422 b
.flags
= BPDU_FLAGS_ROLE_SET(message_role_from_port_role(cist
));
2423 if(0 != cist
->tcWhile
)
2424 b
.flags
|= (1 << offsetTc
);
2426 b
.flags
|= (1 << offsetProposal
);
2428 b
.flags
|= (1 << offsetLearnig
);
2429 if(cist
->forwarding
)
2430 b
.flags
|= (1 << offsetForwarding
);
2432 b
.flags
|= (1 << offsetAgreement
);
2433 assign(b
.cistRootID
, cist
->designatedPriority
.RootID
);
2434 assign(b
.cistExtRootPathCost
, cist
->designatedPriority
.ExtRootPathCost
);
2435 assign(b
.cistRRootID
, cist
->designatedPriority
.RRootID
);
2436 assign(b
.cistPortID
, cist
->designatedPriority
.DesignatedPortID
);
2437 b
.MessageAge
[0] = cist
->designatedTimes
.Message_Age
;
2438 b
.MessageAge
[1] = 0;
2439 b
.MaxAge
[0] = cist
->designatedTimes
.Max_Age
;
2441 b
.HelloTime
[0] = cist
->portTimes
.Hello_Time
; /* ! use portTimes ! */
2443 b
.ForwardDelay
[0] = cist
->designatedTimes
.Forward_Delay
;
2444 b
.ForwardDelay
[1] = 0;
2448 if(br
->ForceProtocolVersion
< protoMSTP
)
2450 b
.protocolVersion
= protoRSTP
;
2451 MSTP_OUT_tx_bpdu(prt
, &b
, RST_BPDU_SIZE
);
2455 b
.protocolVersion
= protoMSTP
;
2457 /* MST specific fields */
2458 assign(b
.mstConfigurationIdentifier
, br
->MstConfigId
);
2459 assign(b
.cistIntRootPathCost
, cist
->designatedPriority
.IntRootPathCost
);
2460 assign(b
.cistBridgeID
, cist
->designatedPriority
.DesignatedBridgeID
);
2461 assign(b
.cistRemainingHops
, cist
->designatedTimes
.remainingHops
);
2463 msti_msgs_total_size
= 0;
2465 msti_msg
= b
.mstConfiguration
;
2466 /* 13.26.20.f) requires that msti configs should be inserted in
2467 * MSTID order. This is met by inserting trees in port's list of trees
2468 * in sorted (by MSTID) order (see MSTP_IN_create_msti) */
2469 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
2472 BPDU_FLAGS_ROLE_SET(message_role_from_port_role(ptp
));
2473 if(0 != ptp
->tcWhile
)
2474 msti_msg
->flags
|= (1 << offsetTc
);
2476 msti_msg
->flags
|= (1 << offsetProposal
);
2478 msti_msg
->flags
|= (1 << offsetLearnig
);
2480 msti_msg
->flags
|= (1 << offsetForwarding
);
2482 msti_msg
->flags
|= (1 << offsetAgreement
);
2484 msti_msg
->flags
|= (1 << offsetMaster
);
2485 assign(msti_msg
->mstiRRootID
, ptp
->designatedPriority
.RRootID
);
2486 assign(msti_msg
->mstiIntRootPathCost
,
2487 ptp
->designatedPriority
.IntRootPathCost
);
2488 msti_msg
->bridgeIdentifierPriority
=
2489 GET_PRIORITY_FROM_IDENTIFIER(ptp
->designatedPriority
.DesignatedBridgeID
);
2490 msti_msg
->portIdentifierPriority
=
2491 GET_PRIORITY_FROM_IDENTIFIER(ptp
->designatedPriority
.DesignatedPortID
);
2492 assign(msti_msg
->remainingHops
, ptp
->designatedTimes
.remainingHops
);
2494 msti_msgs_total_size
+= sizeof(msti_configuration_message_t
);
2498 assign(b
.version3_len
, __cpu_to_be16(MST_BPDU_VER3LEN_WO_MSTI_MSGS
2499 + msti_msgs_total_size
));
2500 MSTP_OUT_tx_bpdu(prt
, &b
, MST_BPDU_SIZE_WO_MSTI_MSGS
2501 + msti_msgs_total_size
);
2504 /* 13.26.a) txTcn */
2505 static void txTcn(port_t
*prt
)
2508 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
2510 if(prt
->deleted
|| (roleDisabled
== cist
->role
) || prt
->dontTxmtBpdu
)
2513 b
.protocolIdentifier
= 0;
2514 b
.protocolVersion
= protoSTP
;
2515 b
.bpduType
= bpduTypeTCN
;
2517 MSTP_OUT_tx_bpdu(prt
, &b
, TCN_BPDU_SIZE
);
2520 /* 13.26.21 updtBPDUVersion */
2521 static void updtBPDUVersion(port_t
*prt
)
2523 if(protoRSTP
<= prt
->rcvdBpduData
.protocolVersion
)
2524 prt
->rcvdRSTP
= true;
2526 prt
->rcvdSTP
= true;
2529 /* 13.26.22 updtRcvdInfoWhile */
2530 static void updtRcvdInfoWhile(per_tree_port_t
*ptp
)
2532 port_t
*prt
= ptp
->port
;
2533 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
2534 unsigned int Message_Age
= cist
->portTimes
.Message_Age
;
2535 unsigned int Max_Age
= cist
->portTimes
.Max_Age
;
2536 unsigned int Hello_Time
= cist
->portTimes
.Hello_Time
;
2538 /* NOTE: 802.1Q-2005(-2011) says that we should use
2539 * "remainingHops ... from the CIST's portTimes parameter"
2540 * As for me this is clear oversight in the standard,
2541 * the remainingHops should be taken form the port's own portTimes,
2542 * not from CIST's. After all, if we don't use port's own
2543 * remainingHops here, they aren't used anywhere at all.
2544 * Besides, there is a scenario which breaks if we use CIST's
2545 * remainingHops here:
2546 * 1) Connect two switches (SW1,SW2) with two ports, thus forming a loop
2547 * 2) Configure them to be in the same region, with two trees:
2549 * 3) at SW1# mstpctl settreeprio br0 1 4
2550 * SW1 becomes regional root in tree 1
2551 * 4) at SW2# mstpctl settreeprio br0 1 14
2552 * 5) at SW1# mstpctl settreeprio br0 1 9
2554 * And now we have the classic "count-to-infinity" problem when the old
2555 * info ("Regional Root is SW1 with priority 4") circulates in the loop,
2556 * because it is better than current info ("Regional Root is SW1 with
2557 * priority 9"). The only way to get rid of that old info is
2558 * to age it out by the means of remainingHops counter.
2559 * In this situation we certainly must use counter from tree 1,
2562 if((!prt
->rcvdInternal
&& ((Message_Age
+ 1) <= Max_Age
))
2563 || (prt
->rcvdInternal
&& (ptp
->portTimes
.remainingHops
> 1))
2565 ptp
->rcvdInfoWhile
= 3 * Hello_Time
;
2567 ptp
->rcvdInfoWhile
= 0;
2570 static void updtbrAssuRcvdInfoWhile(port_t
*prt
)
2572 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
2574 prt
->brAssuRcvdInfoWhile
= 3 * cist
->portTimes
.Hello_Time
;
2577 /* 13.26.24 updtRolesDisabledTree */
2578 static void updtRolesDisabledTree(tree_t
*tree
)
2580 per_tree_port_t
*ptp
;
2582 FOREACH_PTP_IN_TREE(ptp
, tree
)
2583 ptp
->selectedRole
= roleDisabled
;
2586 /* Aux function, not in standard.
2587 * Sets reselect for all MSTIs in the case CIST state for the port changes
2589 static void reselectMSTIs(port_t
*prt
)
2591 per_tree_port_t
*ptp
= GET_CIST_PTP_FROM_PORT(prt
);
2593 /* For each non-CIST ptp */
2594 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
2595 ptp
->reselect
= true;
2598 /* 13.26.23 updtRolesTree */
2599 static void updtRolesTree(tree_t
*tree
)
2601 per_tree_port_t
*ptp
, *root_ptp
= NULL
;
2602 port_priority_vector_t root_path_priority
;
2603 bridge_identifier_t prevRRootID
= tree
->rootPriority
.RRootID
;
2604 __be32 prevExtRootPathCost
= tree
->rootPriority
.ExtRootPathCost
;
2605 bool cist
= (0 == tree
->MSTID
);
2607 /* a), b) Select new root priority vector = {rootPriority, rootPortId} */
2608 /* Initial value = bridge priority vector = {BridgePriority, 0} */
2609 assign(tree
->rootPriority
, tree
->BridgePriority
);
2610 assign(tree
->rootPortId
, __constant_cpu_to_be16(0));
2611 /* Now check root path priority vectors of all ports in tree and see if
2612 * there is a better vector */
2613 FOREACH_PTP_IN_TREE(ptp
, tree
)
2615 port_t
*prt
= ptp
->port
;
2616 /* 802.1Q says to calculate root priority vector only if port
2617 * is not Disabled, but check (infoIs == ioReceived) covers
2618 * the case (infoIs != ioDisabled).
2620 if((ioReceived
== ptp
->infoIs
) && !prt
->restrictedRole
2621 && cmp(ptp
->portPriority
.DesignatedBridgeID
, !=,
2622 tree
->BridgeIdentifier
)
2625 root_path_priority
= ptp
->portPriority
;
2626 if(prt
->rcvdInternal
)
2628 assign(root_path_priority
.IntRootPathCost
,
2629 __cpu_to_be32(__be32_to_cpu(root_path_priority
.IntRootPathCost
)
2630 + ptp
->InternalPortPathCost
)
2633 else if(cist
) /* Yes, this check might be superfluous,
2634 * but I want to be on the safe side */
2636 assign(root_path_priority
.ExtRootPathCost
,
2637 __cpu_to_be32(__be32_to_cpu(root_path_priority
.ExtRootPathCost
)
2638 + prt
->ExternalPortPathCost
)
2640 assign(root_path_priority
.RRootID
, tree
->BridgeIdentifier
);
2641 assign(root_path_priority
.IntRootPathCost
,
2642 __constant_cpu_to_be32(0));
2644 if(betterorsamePriority(&root_path_priority
, &tree
->rootPriority
,
2645 ptp
->portId
, tree
->rootPortId
, cist
))
2647 assign(tree
->rootPriority
, root_path_priority
);
2648 assign(tree
->rootPortId
, ptp
->portId
);
2654 /* 802.1q-2005 says, that at some point we need compare portTimes with
2655 * "... one for the Root Port ...". Bad IEEE! Why not mention explicit
2656 * var names??? (see 13.26.23.g) for instance)
2657 * These comparisons happen three times, twice in clause g)
2658 * and once in clause i). Look for samePriorityAndTimers() calls.
2659 * So, now I should guess what will work for the "times for the Root Port".
2660 * Thanks to Rajani's experiments I know for sure that I should use
2661 * designatedTimes here. Thank you, Rajani!
2662 * NOTE: Both Alex Rozin (author of rstplib) and Srinivas Aji (author
2663 * of rstpd) also compare portTimes with designatedTimes.
2666 /* c) Set new rootTimes */
2669 assign(tree
->rootTimes
, root_ptp
->portTimes
);
2670 port_t
*prt
= root_ptp
->port
;
2671 if(prt
->rcvdInternal
)
2673 if(tree
->rootTimes
.remainingHops
)
2674 --(tree
->rootTimes
.remainingHops
);
2677 ++(tree
->rootTimes
.Message_Age
);
2681 assign(tree
->rootTimes
, tree
->BridgeTimes
);
2684 FOREACH_PTP_IN_TREE(ptp
, tree
)
2686 port_t
*prt
= ptp
->port
;
2688 /* d) Set new designatedPriority */
2689 assign(ptp
->designatedPriority
, tree
->rootPriority
);
2690 assign(ptp
->designatedPriority
.DesignatedBridgeID
,
2691 tree
->BridgeIdentifier
);
2692 assign(ptp
->designatedPriority
.DesignatedPortID
, ptp
->portId
);
2693 /* I am not sure which condition to check here, as 802.1Q-2005 says:
2694 * "... If {Port} is attached to a LAN that has one or more STP Bridges
2695 * attached (as determined by the Port Protocol Migration state
2696 * machine) ..." -- why not to mention explicit var name? Bad IEEE.
2697 * But I guess that sendSTP (i.e. !sendRSTP) var will do ;)
2699 if(cist
&& !prt
->sendRSTP
)
2700 assign(ptp
->designatedPriority
.RRootID
, tree
->BridgeIdentifier
);
2702 /* e) Set new designatedTimes */
2703 assign(ptp
->designatedTimes
, tree
->rootTimes
);
2704 /* Keep the configured Hello_Time for the port.
2705 * NOTE: this is in accordance with the spirit of 802.1D-2004.
2706 * Also, this does not contradict 802.1Q-2005(-2011), as in these
2707 * standards both designatedTimes and rootTimes structures
2708 * don't have Hello_Time member.
2710 assign(ptp
->designatedTimes
.Hello_Time
, ptp
->portTimes
.Hello_Time
);
2714 if(cist
&& cmp(tree
->rootPriority
.RRootID
, !=, prevRRootID
)
2715 && ((0 != tree
->rootPriority
.ExtRootPathCost
)
2716 || (0 != prevExtRootPathCost
)
2719 syncMaster(tree
->bridge
);
2721 FOREACH_PTP_IN_TREE(ptp
, tree
)
2723 port_t
*prt
= ptp
->port
;
2724 per_tree_port_t
*cist_tree
= GET_CIST_PTP_FROM_PORT(prt
);
2726 /* f) Set Disabled role */
2727 if(ioDisabled
== ptp
->infoIs
)
2729 ptp
->selectedRole
= roleDisabled
;
2733 if(!cist
&& (ioReceived
== cist_tree
->infoIs
) && !prt
->infoInternal
)
2735 /* g) Set role for the boundary port in MSTI */
2736 if(roleRoot
== cist_tree
->selectedRole
)
2738 ptp
->selectedRole
= roleMaster
;
2739 if(!samePriorityAndTimers(&ptp
->portPriority
,
2740 &ptp
->designatedPriority
,
2742 &ptp
->designatedTimes
,
2744 ptp
->updtInfo
= true;
2747 /* Bad IEEE again! It says in 13.26.23 g) 2) that
2748 * MSTI state should follow CIST state only for the case of
2749 * Alternate port. This is obviously wrong!
2750 * In the descriptive clause 13.13 f) it says:
2751 * "At a Boundary Port frames allocated to the CIST and
2752 * all MSTIs are forwarded or not forwarded alike.
2753 * This is because Port Role assignments are such that
2754 * if the CIST Port Role is Root Port, the MSTI Port Role
2755 * will be Master Port, and if the CIST Port Role is
2756 * Designated Port, Alternate Port, Backup Port,
2757 * or Disabled Port, each MSTI’s Port Role will be the same."
2758 * So, ignore wrong 13.26.23 g) 2) and do as stated in 13.13 f) !
2760 /* if(roleAlternate == cist_tree->selectedRole) */
2762 ptp
->selectedRole
= cist_tree
->selectedRole
;
2763 if(!samePriorityAndTimers(&ptp
->portPriority
,
2764 &ptp
->designatedPriority
,
2766 &ptp
->designatedTimes
,
2768 ptp
->updtInfo
= true;
2773 /* if(cist || (ioReceived != cist_tree->infoIs) || prt->infoInternal) */
2775 /* h) Set role for the aged info */
2776 if(ioAged
== ptp
->infoIs
)
2778 ptp
->selectedRole
= roleDesignated
;
2779 ptp
->updtInfo
= true;
2782 /* i) Set role for the mine info */
2783 if(ioMine
== ptp
->infoIs
)
2785 ptp
->selectedRole
= roleDesignated
;
2786 if(!samePriorityAndTimers(&ptp
->portPriority
,
2787 &ptp
->designatedPriority
,
2789 &ptp
->designatedTimes
,
2791 ptp
->updtInfo
= true;
2794 if(ioReceived
== ptp
->infoIs
)
2796 /* j) Set Root role */
2799 ptp
->selectedRole
= roleRoot
;
2800 ptp
->updtInfo
= false;
2804 if(betterorsamePriority(&ptp
->portPriority
,
2805 &ptp
->designatedPriority
,
2808 if(cmp(ptp
->portPriority
.DesignatedBridgeID
, !=,
2809 tree
->BridgeIdentifier
))
2811 /* k) Set Alternate role */
2812 ptp
->selectedRole
= roleAlternate
;
2816 /* l) Set Backup role */
2817 ptp
->selectedRole
= roleBackup
;
2819 /* reset updtInfo for both k) and l) */
2820 ptp
->updtInfo
= false;
2822 else /* designatedPriority is better than portPriority */
2824 /* m) Set Designated role */
2825 ptp
->selectedRole
= roleDesignated
;
2826 ptp
->updtInfo
= true;
2829 /* This is not in standard. But we really should set here
2830 * reselect for all MSTIs so that updtRolesTree is called
2831 * for each MSTI and due to above clause g) MSTI role is
2832 * changed to Master or reflects CIST port role.
2833 * Because in 802.1Q-2005 this will not happen when BPDU arrives
2834 * at boundary port - the rcvdMsg is not set for the MSTIs and
2835 * updtRolesTree is not called.
2838 if(cist
&& (ptp
->selectedRole
!= ptp
->role
))
2846 /* 13.27 The Port Timers state machine */
2848 static void PTSM_tick(port_t
*prt
)
2850 per_tree_port_t
*ptp
;
2854 if(prt
->mdelayWhile
)
2855 --(prt
->mdelayWhile
);
2856 if(prt
->edgeDelayWhile
)
2857 --(prt
->edgeDelayWhile
);
2860 if(prt
->brAssuRcvdInfoWhile
)
2861 --(prt
->brAssuRcvdInfoWhile
);
2863 FOREACH_PTP_IN_PORT(ptp
, prt
)
2873 if(0 == --(ptp
->tcWhile
))
2874 set_TopologyChange(ptp
->tree
, false, prt
);
2876 if(ptp
->rcvdInfoWhile
)
2877 --(ptp
->rcvdInfoWhile
);
2881 /* 13.28 Port Receive state machine */
2882 #define PRSM_begin(prt) PRSM_to_DISCARD((prt), false)
2883 static bool PRSM_to_DISCARD(port_t
*prt
, bool dry_run
)
2887 return (prt
->PRSM_state
!= PRSM_DISCARD
)
2888 || prt
->rcvdBpdu
|| prt
->rcvdRSTP
|| prt
->rcvdSTP
2889 || (prt
->edgeDelayWhile
!= prt
->bridge
->Migrate_Time
)
2890 || clearAllRcvdMsgs(prt
, dry_run
);
2893 prt
->PRSM_state
= PRSM_DISCARD
;
2895 prt
->rcvdBpdu
= false;
2896 prt
->rcvdRSTP
= false;
2897 prt
->rcvdSTP
= false;
2898 clearAllRcvdMsgs(prt
, false /* actual run */);
2899 assign(prt
->edgeDelayWhile
, prt
->bridge
->Migrate_Time
);
2901 /* No need to run, no one condition will be met
2903 * PRSM_run(prt, false); */
2907 static void PRSM_to_RECEIVE(port_t
*prt
)
2909 prt
->PRSM_state
= PRSM_RECEIVE
;
2911 updtBPDUVersion(prt
);
2912 prt
->rcvdInternal
= fromSameRegion(prt
);
2914 prt
->operEdge
= false;
2915 prt
->rcvdBpdu
= false;
2916 assign(prt
->edgeDelayWhile
, prt
->bridge
->Migrate_Time
);
2918 /* No need to run, no one condition will be met
2919 PRSM_run(prt, false); */
2922 static bool PRSM_run(port_t
*prt
, bool dry_run
)
2924 per_tree_port_t
*ptp
;
2927 if((prt
->rcvdBpdu
|| (prt
->edgeDelayWhile
!= prt
->bridge
->Migrate_Time
))
2928 && !prt
->portEnabled
)
2930 return PRSM_to_DISCARD(prt
, dry_run
);
2933 switch(prt
->PRSM_state
)
2936 if(prt
->rcvdBpdu
&& prt
->portEnabled
)
2938 if(dry_run
) /* state change */
2940 PRSM_to_RECEIVE(prt
);
2945 FOREACH_PTP_IN_PORT(ptp
, prt
)
2953 if(prt
->rcvdBpdu
&& prt
->portEnabled
&& !rcvdAnyMsg
)
2955 if(dry_run
) /* at least rcvdBpdu will change */
2957 PRSM_to_RECEIVE(prt
);
2964 /* 13.29 Port Protocol Migration state machine */
2966 static bool PPMSM_run(port_t
*prt
, bool dry_run
);
2967 #define PPMSM_begin(prt) PPMSM_to_CHECKING_RSTP(prt)
2969 static void PPMSM_to_CHECKING_RSTP(port_t
*prt
/*, bool begin*/)
2971 prt
->PPMSM_state
= PPMSM_CHECKING_RSTP
;
2973 bridge_t
*br
= prt
->bridge
;
2974 prt
->mcheck
= false;
2975 prt
->sendRSTP
= rstpVersion(br
);
2976 assign(prt
->mdelayWhile
, br
->Migrate_Time
);
2978 /* No need to run, no one condition will be met
2980 * PPMSM_run(prt, false); */
2983 static void PPMSM_to_SELECTING_STP(port_t
*prt
)
2985 prt
->PPMSM_state
= PPMSM_SELECTING_STP
;
2987 prt
->sendRSTP
= false;
2988 assign(prt
->mdelayWhile
, prt
->bridge
->Migrate_Time
);
2990 PPMSM_run(prt
, false /* actual run */);
2993 static void PPMSM_to_SENSING(port_t
*prt
)
2995 prt
->PPMSM_state
= PPMSM_SENSING
;
2997 prt
->rcvdRSTP
= false;
2998 prt
->rcvdSTP
= false;
3000 PPMSM_run(prt
, false /* actual run */);
3003 static bool PPMSM_run(port_t
*prt
, bool dry_run
)
3005 bridge_t
*br
= prt
->bridge
;
3007 switch(prt
->PPMSM_state
)
3009 case PPMSM_CHECKING_RSTP
:
3010 if((prt
->mdelayWhile
!= br
->Migrate_Time
)
3011 && !prt
->portEnabled
)
3013 if(dry_run
) /* at least mdelayWhile will change */
3015 PPMSM_to_CHECKING_RSTP(prt
);
3018 if(0 == prt
->mdelayWhile
)
3020 if(dry_run
) /* state change */
3022 PPMSM_to_SENSING(prt
);
3025 case PPMSM_SELECTING_STP
:
3026 if(0 == prt
->mdelayWhile
|| !prt
->portEnabled
|| prt
->mcheck
)
3028 if(dry_run
) /* state change */
3030 PPMSM_to_SENSING(prt
);
3034 if(!prt
->portEnabled
|| prt
->mcheck
3035 || (rstpVersion(br
) && !prt
->sendRSTP
&& prt
->rcvdRSTP
))
3037 if(dry_run
) /* state change */
3039 PPMSM_to_CHECKING_RSTP(prt
);
3042 if(prt
->sendRSTP
&& prt
->rcvdSTP
)
3044 if(dry_run
) /* state change */
3046 PPMSM_to_SELECTING_STP(prt
);
3054 /* 13.30 Bridge Detection state machine */
3055 static void BDSM_to_EDGE(port_t
*prt
/*, bool begin*/)
3057 prt
->BDSM_state
= BDSM_EDGE
;
3059 prt
->operEdge
= true;
3061 /* No need to run, no one condition will be met
3063 * BDSM_run(prt, false); */
3066 static void BDSM_to_NOT_EDGE(port_t
*prt
/*, bool begin*/)
3068 prt
->BDSM_state
= BDSM_NOT_EDGE
;
3070 prt
->operEdge
= false;
3072 /* No need to run, no one condition will be met
3074 * BDSM_run(prt, false); */
3077 static void BDSM_begin(port_t
*prt
/*, bool begin*/)
3079 if(prt
->AdminEdgePort
)
3080 BDSM_to_EDGE(prt
/*, begin*/);
3082 BDSM_to_NOT_EDGE(prt
/*, begin*/);
3085 static bool BDSM_run(port_t
*prt
, bool dry_run
)
3087 per_tree_port_t
*cist
;
3089 switch(prt
->BDSM_state
)
3092 if(((!prt
->portEnabled
|| !prt
->AutoEdge
) && !prt
->AdminEdgePort
)
3096 if(dry_run
) /* state change */
3098 BDSM_to_NOT_EDGE(prt
);
3102 cist
= GET_CIST_PTP_FROM_PORT(prt
);
3103 /* NOTE: 802.1Q-2005(-2011) is not clear, which of the per-tree
3104 * "proposing" flags to use here, or one should combine
3105 * them all for all trees?
3106 * So, I decide that it will be the "proposing" flag
3107 * from CIST tree - it seems like a good bet.
3109 if((!prt
->portEnabled
&& prt
->AdminEdgePort
)
3110 || ((0 == prt
->edgeDelayWhile
) && prt
->AutoEdge
&& prt
->sendRSTP
3114 if(dry_run
) /* state change */
3123 /* 13.31 Port Transmit state machine */
3125 static bool PTSM_run(port_t
*prt
, bool dry_run
);
3126 #define PTSM_begin(prt) PTSM_to_TRANSMIT_INIT((prt), true, false)
3128 static bool PTSM_to_TRANSMIT_INIT(port_t
*prt
, bool begin
, bool dry_run
)
3132 return (prt
->PTSM_state
!= PTSM_TRANSMIT_INIT
)
3133 || (!prt
->newInfo
) || (!prt
->newInfoMsti
)
3134 || (0 != prt
->txCount
);
3137 prt
->PTSM_state
= PTSM_TRANSMIT_INIT
;
3139 prt
->newInfo
= true;
3140 prt
->newInfoMsti
= true;
3141 assign(prt
->txCount
, 0u);
3143 if(!begin
&& prt
->portEnabled
) /* prevent infinite loop */
3144 PTSM_run(prt
, false /* actual run */);
3148 static void PTSM_to_TRANSMIT_CONFIG(port_t
*prt
)
3150 prt
->PTSM_state
= PTSM_TRANSMIT_CONFIG
;
3152 prt
->newInfo
= false;
3157 PTSM_run(prt
, false /* actual run */);
3160 static void PTSM_to_TRANSMIT_TCN(port_t
*prt
)
3162 prt
->PTSM_state
= PTSM_TRANSMIT_TCN
;
3164 prt
->newInfo
= false;
3168 PTSM_run(prt
, false /* actual run */);
3171 static void PTSM_to_TRANSMIT_RSTP(port_t
*prt
)
3173 prt
->PTSM_state
= PTSM_TRANSMIT_RSTP
;
3175 prt
->newInfo
= false;
3176 prt
->newInfoMsti
= false;
3181 PTSM_run(prt
, false /* actual run */);
3184 static void PTSM_to_TRANSMIT_PERIODIC(port_t
*prt
)
3186 prt
->PTSM_state
= PTSM_TRANSMIT_PERIODIC
;
3188 per_tree_port_t
*ptp
= GET_CIST_PTP_FROM_PORT(prt
);
3189 bool cistDesignatedOrTCpropagatingRootPort
=
3190 (roleDesignated
== ptp
->role
)
3191 || ((roleRoot
== ptp
->role
) && (0 != ptp
->tcWhile
));
3192 bool mstiDesignatedOrTCpropagatingRootPort
;
3194 mstiDesignatedOrTCpropagatingRootPort
= false;
3195 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
3197 if((roleDesignated
== ptp
->role
)
3198 || ((roleRoot
== ptp
->role
) && (0 != ptp
->tcWhile
))
3201 mstiDesignatedOrTCpropagatingRootPort
= true;
3206 prt
->newInfo
= prt
->newInfo
|| cistDesignatedOrTCpropagatingRootPort
;
3207 prt
->newInfoMsti
= prt
->newInfoMsti
3208 || mstiDesignatedOrTCpropagatingRootPort
;
3210 PTSM_run(prt
, false /* actual run */);
3213 static void PTSM_to_IDLE(port_t
*prt
)
3215 prt
->PTSM_state
= PTSM_IDLE
;
3217 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
3218 prt
->helloWhen
= cist
->portTimes
.Hello_Time
;
3220 PTSM_run(prt
, false /* actual run */);
3223 static bool PTSM_run(port_t
*prt
, bool dry_run
)
3225 /* bool allTransmitReady; */
3226 per_tree_port_t
*ptp
;
3227 port_role_t cistRole
;
3228 bool mstiMasterPort
;
3230 if(!prt
->portEnabled
)
3232 return PTSM_to_TRANSMIT_INIT(prt
, false, dry_run
);
3235 switch(prt
->PTSM_state
)
3237 case PTSM_TRANSMIT_INIT
:
3239 case PTSM_TRANSMIT_CONFIG
:
3241 case PTSM_TRANSMIT_TCN
:
3243 case PTSM_TRANSMIT_RSTP
:
3245 case PTSM_TRANSMIT_PERIODIC
:
3246 if(dry_run
) /* state change */
3248 PTSM_to_IDLE(prt
); /* UnConditional Transition */
3251 /* allTransmitReady = true; */
3252 ptp
= GET_CIST_PTP_FROM_PORT(prt
);
3253 if(!ptp
->selected
|| ptp
->updtInfo
)
3255 /* allTransmitReady = false; */
3258 cistRole
= ptp
->role
;
3259 mstiMasterPort
= false;
3260 list_for_each_entry_continue(ptp
, &prt
->trees
, port_list
)
3262 if(!ptp
->selected
|| ptp
->updtInfo
)
3264 /* allTransmitReady = false; */
3267 if(roleMaster
== ptp
->role
)
3268 mstiMasterPort
= true;
3270 if(0 == prt
->helloWhen
)
3272 if(dry_run
) /* state change */
3274 PTSM_to_TRANSMIT_PERIODIC(prt
);
3277 if(!(prt
->txCount
< prt
->bridge
->Transmit_Hold_Count
))
3280 if(prt
->bpduFilterPort
)
3284 { /* implement MSTP */
3285 if(prt
->newInfo
|| (prt
->newInfoMsti
&& !mstiMasterPort
)
3286 || assurancePort(prt
)
3289 if(dry_run
) /* state change */
3291 PTSM_to_TRANSMIT_RSTP(prt
);
3296 { /* fallback to STP */
3297 if(prt
->newInfo
&& (roleDesignated
== cistRole
))
3299 if(dry_run
) /* state change */
3301 PTSM_to_TRANSMIT_CONFIG(prt
);
3304 if(prt
->newInfo
&& (roleRoot
== cistRole
))
3306 if(dry_run
) /* state change */
3308 PTSM_to_TRANSMIT_TCN(prt
);
3318 /* 13.32 Port Information state machine */
3320 #ifdef PISM_ENABLE_LOG
3321 #define PISM_LOG(_fmt, _args...) SMLOG_MSTINAME(ptp, _fmt, ##_args)
3323 #define PISM_LOG(_fmt, _args...) {}
3324 #endif /* PISM_ENABLE_LOG */
3326 static bool PISM_run(per_tree_port_t
*ptp
, bool dry_run
);
3327 #define PISM_begin(ptp) PISM_to_DISABLED((ptp), true)
3329 static void PISM_to_DISABLED(per_tree_port_t
*ptp
, bool begin
)
3332 ptp
->PISM_state
= PISM_DISABLED
;
3334 ptp
->rcvdMsg
= false;
3335 ptp
->proposing
= false;
3336 ptp
->proposed
= false;
3338 ptp
->agreed
= false;
3339 assign(ptp
->rcvdInfoWhile
, 0u);
3340 ptp
->infoIs
= ioDisabled
;
3341 ptp
->reselect
= true;
3342 ptp
->selected
= false;
3345 PISM_run(ptp
, false /* actual run */);
3348 static void PISM_to_AGED(per_tree_port_t
*ptp
)
3351 ptp
->PISM_state
= PISM_AGED
;
3353 ptp
->infoIs
= ioAged
;
3354 ptp
->reselect
= true;
3355 ptp
->selected
= false;
3357 PISM_run(ptp
, false /* actual run */);
3360 static void PISM_to_UPDATE(per_tree_port_t
*ptp
)
3363 ptp
->PISM_state
= PISM_UPDATE
;
3365 ptp
->proposing
= false;
3366 ptp
->proposed
= false;
3367 ptp
->agreed
= ptp
->agreed
&& betterorsameInfo(ptp
, ioMine
);
3368 ptp
->synced
= ptp
->synced
&& ptp
->agreed
;
3369 assign(ptp
->portPriority
, ptp
->designatedPriority
);
3370 assign(ptp
->portTimes
, ptp
->designatedTimes
);
3371 ptp
->updtInfo
= false;
3372 ptp
->infoIs
= ioMine
;
3373 /* newInfoXst = TRUE; */
3374 port_t
*prt
= ptp
->port
;
3376 prt
->newInfo
= true;
3378 prt
->newInfoMsti
= true;
3380 PISM_run(ptp
, false /* actual run */);
3383 static void PISM_to_SUPERIOR_DESIGNATED(per_tree_port_t
*ptp
)
3386 ptp
->PISM_state
= PISM_SUPERIOR_DESIGNATED
;
3388 port_t
*prt
= ptp
->port
;
3390 prt
->infoInternal
= prt
->rcvdInternal
;
3391 ptp
->agreed
= false;
3392 ptp
->proposing
= false;
3393 recordProposal(ptp
);
3395 ptp
->agree
= ptp
->agree
&& betterorsameInfo(ptp
, ioReceived
);
3396 recordAgreement(ptp
);
3397 ptp
->synced
= ptp
->synced
&& ptp
->agreed
;
3398 recordPriority(ptp
);
3400 updtRcvdInfoWhile(ptp
);
3401 ptp
->infoIs
= ioReceived
;
3402 ptp
->reselect
= true;
3403 ptp
->selected
= false;
3404 ptp
->rcvdMsg
= false;
3406 PISM_run(ptp
, false /* actual run */);
3409 static void PISM_to_REPEATED_DESIGNATED(per_tree_port_t
*ptp
)
3412 ptp
->PISM_state
= PISM_REPEATED_DESIGNATED
;
3414 port_t
*prt
= ptp
->port
;
3416 prt
->infoInternal
= prt
->rcvdInternal
;
3417 recordProposal(ptp
);
3419 recordAgreement(ptp
);
3420 updtRcvdInfoWhile(ptp
);
3421 ptp
->rcvdMsg
= false;
3423 PISM_run(ptp
, false /* actual run */);
3426 static void PISM_to_INFERIOR_DESIGNATED(per_tree_port_t
*ptp
)
3429 ptp
->PISM_state
= PISM_INFERIOR_DESIGNATED
;
3432 ptp
->rcvdMsg
= false;
3434 PISM_run(ptp
, false /* actual run */);
3437 static void PISM_to_NOT_DESIGNATED(per_tree_port_t
*ptp
)
3440 ptp
->PISM_state
= PISM_NOT_DESIGNATED
;
3442 recordAgreement(ptp
);
3444 ptp
->rcvdMsg
= false;
3446 PISM_run(ptp
, false /* actual run */);
3449 static void PISM_to_OTHER(per_tree_port_t
*ptp
)
3452 ptp
->PISM_state
= PISM_OTHER
;
3454 ptp
->rcvdMsg
= false;
3456 PISM_run(ptp
, false /* actual run */);
3459 static void PISM_to_CURRENT(per_tree_port_t
*ptp
)
3462 ptp
->PISM_state
= PISM_CURRENT
;
3464 PISM_run(ptp
, false /* actual run */);
3467 static void PISM_to_RECEIVE(per_tree_port_t
*ptp
)
3470 ptp
->PISM_state
= PISM_RECEIVE
;
3472 ptp
->rcvdInfo
= rcvInfo(ptp
);
3473 recordMastered(ptp
);
3475 PISM_run(ptp
, false /* actual run */);
3478 static bool PISM_run(per_tree_port_t
*ptp
, bool dry_run
)
3480 bool rcvdXstMsg
, updtXstInfo
;
3481 port_t
*prt
= ptp
->port
;
3483 if((!prt
->portEnabled
) && (ioDisabled
!= ptp
->infoIs
))
3485 if(dry_run
) /* at least infoIs will change */
3487 PISM_to_DISABLED(ptp
, false);
3491 switch(ptp
->PISM_state
)
3494 if(prt
->portEnabled
)
3496 if(dry_run
) /* state change */
3503 if(dry_run
) /* at least rcvdMsg will change */
3505 PISM_to_DISABLED(ptp
, false);
3509 if(ptp
->selected
&& ptp
->updtInfo
)
3511 if(dry_run
) /* state change */
3513 PISM_to_UPDATE(ptp
);
3518 case PISM_SUPERIOR_DESIGNATED
:
3520 case PISM_REPEATED_DESIGNATED
:
3522 case PISM_INFERIOR_DESIGNATED
:
3524 case PISM_NOT_DESIGNATED
:
3527 if(dry_run
) /* state change */
3529 PISM_to_CURRENT(ptp
);
3533 * Although 802.1Q-2005 does not define rcvdXstMsg and updtXstInfo
3534 * from 802.1s we can conclude that they are:
3535 * - rcvdXstMsg = rcvdCistMsg, if tree is CIST
3536 * rcvdMstiMsg, if tree is MSTI.
3537 * - updtXstInfo = updtCistInfo, if tree is CIST
3538 * updtMstiInfo, if tree is MSTI.
3542 rcvdXstMsg
= ptp
->rcvdMsg
; /* 13.25.12 */
3543 updtXstInfo
= ptp
->updtInfo
; /* 13.25.16 */
3547 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(prt
);
3548 rcvdXstMsg
= !cist
->rcvdMsg
&& ptp
->rcvdMsg
; /* 13.25.13 */
3549 updtXstInfo
= ptp
->updtInfo
|| cist
->updtInfo
; /* 13.25.17 */
3551 if(rcvdXstMsg
&& !updtXstInfo
)
3553 if(dry_run
) /* state change */
3555 PISM_to_RECEIVE(ptp
);
3558 if((ioReceived
== ptp
->infoIs
) && (0 == ptp
->rcvdInfoWhile
)
3559 && !ptp
->updtInfo
&& !rcvdXstMsg
)
3561 if(dry_run
) /* state change */
3566 if(ptp
->selected
&& ptp
->updtInfo
)
3568 if(dry_run
) /* state change */
3570 PISM_to_UPDATE(ptp
);
3574 switch(ptp
->rcvdInfo
)
3576 case SuperiorDesignatedInfo
:
3577 if(dry_run
) /* state change */
3579 PISM_to_SUPERIOR_DESIGNATED(ptp
);
3581 case RepeatedDesignatedInfo
:
3582 if(dry_run
) /* state change */
3584 PISM_to_REPEATED_DESIGNATED(ptp
);
3586 case InferiorDesignatedInfo
:
3587 if(dry_run
) /* state change */
3589 PISM_to_INFERIOR_DESIGNATED(ptp
);
3591 case InferiorRootAlternateInfo
:
3592 if(dry_run
) /* state change */
3594 PISM_to_NOT_DESIGNATED(ptp
);
3597 if(dry_run
) /* state change */
3608 /* 13.33 Port Role Selection state machine */
3610 static bool PRSSM_run(tree_t
*tree
, bool dry_run
);
3611 #define PRSSM_begin(tree) PRSSM_to_INIT_TREE(tree)
3613 static void PRSSM_to_INIT_TREE(tree_t
*tree
/*, bool begin*/)
3615 tree
->PRSSM_state
= PRSSM_INIT_TREE
;
3617 updtRolesDisabledTree(tree
);
3619 /* No need to check, as we assume begin = true here
3620 * because transition to this state can be initiated only by BEGIN var.
3621 * In other words, this function is called via xxx_begin macro only.
3623 * PRSSM_run(prt, false); */
3626 static void PRSSM_to_ROLE_SELECTION(tree_t
*tree
)
3628 tree
->PRSSM_state
= PRSSM_ROLE_SELECTION
;
3630 clearReselectTree(tree
);
3631 updtRolesTree(tree
);
3632 setSelectedTree(tree
);
3634 /* No need to run, no one condition will be met
3635 PRSSM_run(tree, false); */
3638 static bool PRSSM_run(tree_t
*tree
, bool dry_run
)
3640 per_tree_port_t
*ptp
;
3642 switch(tree
->PRSSM_state
)
3644 case PRSSM_INIT_TREE
:
3645 if(dry_run
) /* state change */
3647 PRSSM_to_ROLE_SELECTION(tree
);
3649 case PRSSM_ROLE_SELECTION
:
3650 FOREACH_PTP_IN_TREE(ptp
, tree
)
3653 if(dry_run
) /* at least reselect will change */
3655 PRSSM_to_ROLE_SELECTION(tree
);
3664 /* 13.34 Port Role Transitions state machine */
3666 #ifdef PRTSM_ENABLE_LOG
3667 #define PRTSM_LOG(_fmt, _args...) SMLOG_MSTINAME(ptp, _fmt, ##_args)
3669 #define PRTSM_LOG(_fmt, _args...) {}
3670 #endif /* PRTSM_ENABLE_LOG */
3672 static bool PRTSM_runr(per_tree_port_t
*ptp
, bool recursive_call
, bool dry_run
);
3673 #define PRTSM_run(ptp, dry_run) PRTSM_runr((ptp), false, (dry_run))
3674 #define PRTSM_begin(ptp) PRTSM_to_INIT_PORT(ptp)
3676 /* Disabled Port role transitions */
3678 static void PRTSM_to_INIT_PORT(per_tree_port_t
*ptp
/*, bool begin*/)
3681 ptp
->PRTSM_state
= PRTSM_INIT_PORT
;
3683 unsigned int MaxAge
, FwdDelay
;
3684 per_tree_port_t
*cist
= GET_CIST_PTP_FROM_PORT(ptp
->port
);
3686 ptp
->role
= roleDisabled
;
3688 ptp
->forward
= false;
3689 ptp
->synced
= false;
3693 FwdDelay
= cist
->designatedTimes
.Forward_Delay
;
3694 assign(ptp
->rrWhile
, FwdDelay
);
3696 MaxAge
= cist
->designatedTimes
.Max_Age
;
3697 assign(ptp
->fdWhile
, MaxAge
);
3698 assign(ptp
->rbWhile
, 0u);
3700 /* No need to check, as we assume begin = true here
3701 * because transition to this state can be initiated only by BEGIN var.
3702 * In other words, this function is called via xxx_begin macro only.
3704 * PRTSM_runr(ptp, false, false); */
3707 static void PRTSM_to_DISABLE_PORT(per_tree_port_t
*ptp
)
3710 ptp
->PRTSM_state
= PRTSM_DISABLE_PORT
;
3712 /* Although 802.1Q-2005 says here to do role = selectedRole
3713 * I have difficulties with it in the next scenario:
3714 * 1) port was designated (role == selectedRole == roleDesignated)
3715 * 2) some config event occurs, e.g. MAC address changes and
3716 * br_state_machines_begin is called
3717 * 3) role == selectedRole == roleDisabled, PRTSM_state = PRTSM_INIT_PORT
3718 * Because port was not actually down, on the next run
3719 * Port Role Selection state machine sets selectedRole = roleDesignated
3720 * and updtInfo = true:
3721 * 4) we have unconditional transition to DISABLE_PORT, and because
3722 * updtInfo = true we can not follow transition to DESIGNATED_PORT
3723 * 5) if we follow standard, role = selectedRole = roleDesignated and
3724 * on the next run we have transition to the DISABLED_PORT
3725 * And there we stuck. role == selectedRole, so we can not transit to
3726 * DESIGNATED_PORT (it requires role != selectedRole ).
3728 * Solution: do not follow the standard, and do role = roleDisabled
3729 * instead of role = selectedRole.
3731 ptp
->role
= roleDisabled
;
3733 ptp
->forward
= false;
3735 PRTSM_runr(ptp
, true, false /* actual run */);
3738 static void PRTSM_to_DISABLED_PORT(per_tree_port_t
*ptp
, unsigned int MaxAge
)
3741 ptp
->PRTSM_state
= PRTSM_DISABLED_PORT
;
3743 assign(ptp
->fdWhile
, MaxAge
);
3745 assign(ptp
->rrWhile
, 0u);
3747 ptp
->reRoot
= false;
3749 PRTSM_runr(ptp
, true, false /* actual run */);
3752 /* MasterPort role transitions */
3754 static void PRTSM_to_MASTER_PROPOSED(per_tree_port_t
*ptp
)
3757 ptp
->PRTSM_state
= PRTSM_MASTER_PROPOSED
;
3759 setSyncTree(ptp
->tree
);
3760 ptp
->proposed
= false;
3762 PRTSM_runr(ptp
, true, false /* actual run */);
3765 static void PRTSM_to_MASTER_AGREED(per_tree_port_t
*ptp
)
3768 ptp
->PRTSM_state
= PRTSM_MASTER_AGREED
;
3770 ptp
->proposed
= false;
3774 PRTSM_runr(ptp
, true, false /* actual run */);
3777 static void PRTSM_to_MASTER_SYNCED(per_tree_port_t
*ptp
)
3780 ptp
->PRTSM_state
= PRTSM_MASTER_SYNCED
;
3782 assign(ptp
->rrWhile
, 0u);
3786 PRTSM_runr(ptp
, true, false /* actual run */);
3789 static void PRTSM_to_MASTER_RETIRED(per_tree_port_t
*ptp
)
3792 ptp
->PRTSM_state
= PRTSM_MASTER_RETIRED
;
3794 ptp
->reRoot
= false;
3796 PRTSM_runr(ptp
, true, false /* actual run */);
3799 static void PRTSM_to_MASTER_FORWARD(per_tree_port_t
*ptp
)
3802 ptp
->PRTSM_state
= PRTSM_MASTER_FORWARD
;
3804 ptp
->forward
= true;
3805 assign(ptp
->fdWhile
, 0u);
3806 ptp
->agreed
= ptp
->port
->sendRSTP
;
3808 PRTSM_runr(ptp
, true, false /* actual run */);
3811 static void PRTSM_to_MASTER_LEARN(per_tree_port_t
*ptp
, unsigned int forwardDelay
)
3814 ptp
->PRTSM_state
= PRTSM_MASTER_LEARN
;
3817 assign(ptp
->fdWhile
, forwardDelay
);
3819 PRTSM_runr(ptp
, true, false /* actual run */);
3822 static void PRTSM_to_MASTER_DISCARD(per_tree_port_t
*ptp
, unsigned int forwardDelay
)
3825 ptp
->PRTSM_state
= PRTSM_MASTER_DISCARD
;
3828 ptp
->forward
= false;
3829 ptp
->disputed
= false;
3830 assign(ptp
->fdWhile
, forwardDelay
);
3832 PRTSM_runr(ptp
, true, false /* actual run */);
3835 static void PRTSM_to_MASTER_PORT(per_tree_port_t
*ptp
)
3838 ptp
->PRTSM_state
= PRTSM_MASTER_PORT
;
3840 ptp
->role
= roleMaster
;
3842 PRTSM_runr(ptp
, true, false /* actual run */);
3845 /* RootPort role transitions */
3847 static void PRTSM_to_ROOT_PROPOSED(per_tree_port_t
*ptp
)
3850 ptp
->PRTSM_state
= PRTSM_ROOT_PROPOSED
;
3852 setSyncTree(ptp
->tree
);
3853 ptp
->proposed
= false;
3855 PRTSM_runr(ptp
, true, false /* actual run */);
3858 static void PRTSM_to_ROOT_AGREED(per_tree_port_t
*ptp
)
3861 ptp
->PRTSM_state
= PRTSM_ROOT_AGREED
;
3863 ptp
->proposed
= false;
3866 /* newInfoXst = TRUE; */
3867 port_t
*prt
= ptp
->port
;
3869 prt
->newInfo
= true;
3871 prt
->newInfoMsti
= true;
3873 PRTSM_runr(ptp
, true, false /* actual run */);
3876 static void PRTSM_to_ROOT_SYNCED(per_tree_port_t
*ptp
)
3879 ptp
->PRTSM_state
= PRTSM_ROOT_SYNCED
;
3884 PRTSM_runr(ptp
, true, false /* actual run */);
3887 static void PRTSM_to_REROOT(per_tree_port_t
*ptp
)
3890 ptp
->PRTSM_state
= PRTSM_REROOT
;
3892 setReRootTree(ptp
->tree
);
3894 PRTSM_runr(ptp
, true, false /* actual run */);
3897 static void PRTSM_to_ROOT_FORWARD(per_tree_port_t
*ptp
)
3900 ptp
->PRTSM_state
= PRTSM_ROOT_FORWARD
;
3902 assign(ptp
->fdWhile
, 0u);
3903 ptp
->forward
= true;
3905 PRTSM_runr(ptp
, true, false /* actual run */);
3908 static void PRTSM_to_ROOT_LEARN(per_tree_port_t
*ptp
, unsigned int forwardDelay
)
3911 ptp
->PRTSM_state
= PRTSM_ROOT_LEARN
;
3913 assign(ptp
->fdWhile
, forwardDelay
);
3916 PRTSM_runr(ptp
, true, false /* actual run */);
3919 static void PRTSM_to_REROOTED(per_tree_port_t
*ptp
)
3922 ptp
->PRTSM_state
= PRTSM_REROOTED
;
3924 ptp
->reRoot
= false;
3926 PRTSM_runr(ptp
, true, false /* actual run */);
3929 static void PRTSM_to_ROOT_PORT(per_tree_port_t
*ptp
, unsigned int FwdDelay
)
3932 ptp
->PRTSM_state
= PRTSM_ROOT_PORT
;
3934 ptp
->role
= roleRoot
;
3935 assign(ptp
->rrWhile
, FwdDelay
);
3937 PRTSM_runr(ptp
, true, false /* actual run */);
3940 /* DesignatedPort role transitions */
3942 static void PRTSM_to_DESIGNATED_PROPOSE(per_tree_port_t
*ptp
)
3945 ptp
->PRTSM_state
= PRTSM_DESIGNATED_PROPOSE
;
3947 port_t
*prt
= ptp
->port
;
3949 ptp
->proposing
= true;
3950 /* newInfoXst = TRUE; */
3953 /* 13.25.8. This tree is CIST. */
3954 unsigned int MaxAge
= ptp
->designatedTimes
.Max_Age
;
3955 /* 13.25.c) -> 17.20.4 of 802.1D : EdgeDelay */
3956 unsigned int EdgeDelay
= prt
->operPointToPointMAC
?
3957 prt
->bridge
->Migrate_Time
3959 assign(prt
->edgeDelayWhile
, EdgeDelay
);
3960 prt
->newInfo
= true;
3963 prt
->newInfoMsti
= true;
3965 PRTSM_runr(ptp
, true, false /* actual run */);
3968 static void PRTSM_to_DESIGNATED_AGREED(per_tree_port_t
*ptp
)
3971 ptp
->PRTSM_state
= PRTSM_DESIGNATED_AGREED
;
3973 ptp
->proposed
= false;
3976 /* newInfoXst = TRUE; */
3977 port_t
*prt
= ptp
->port
;
3979 prt
->newInfo
= true;
3981 prt
->newInfoMsti
= true;
3983 PRTSM_runr(ptp
, true, false /* actual run */);
3986 static void PRTSM_to_DESIGNATED_SYNCED(per_tree_port_t
*ptp
)
3989 ptp
->PRTSM_state
= PRTSM_DESIGNATED_SYNCED
;
3991 assign(ptp
->rrWhile
, 0u);
3995 PRTSM_runr(ptp
, true, false /* actual run */);
3998 static void PRTSM_to_DESIGNATED_RETIRED(per_tree_port_t
*ptp
)
4001 ptp
->PRTSM_state
= PRTSM_DESIGNATED_RETIRED
;
4003 ptp
->reRoot
= false;
4005 PRTSM_runr(ptp
, true, false /* actual run */);
4008 static void PRTSM_to_DESIGNATED_FORWARD(per_tree_port_t
*ptp
)
4011 ptp
->PRTSM_state
= PRTSM_DESIGNATED_FORWARD
;
4013 ptp
->forward
= true;
4014 assign(ptp
->fdWhile
, 0u);
4015 ptp
->agreed
= ptp
->port
->sendRSTP
;
4017 PRTSM_runr(ptp
, true, false /* actual run */);
4020 static void PRTSM_to_DESIGNATED_LEARN(per_tree_port_t
*ptp
, unsigned int forwardDelay
)
4023 ptp
->PRTSM_state
= PRTSM_DESIGNATED_LEARN
;
4026 assign(ptp
->fdWhile
, forwardDelay
);
4028 PRTSM_runr(ptp
, true, false /* actual run */);
4031 static void PRTSM_to_DESIGNATED_DISCARD(per_tree_port_t
*ptp
, unsigned int forwardDelay
)
4034 ptp
->PRTSM_state
= PRTSM_DESIGNATED_DISCARD
;
4037 ptp
->forward
= false;
4038 ptp
->disputed
= false;
4039 assign(ptp
->fdWhile
, forwardDelay
);
4041 PRTSM_runr(ptp
, true, false /* actual run */);
4044 static void PRTSM_to_DESIGNATED_PORT(per_tree_port_t
*ptp
)
4047 ptp
->PRTSM_state
= PRTSM_DESIGNATED_PORT
;
4049 ptp
->role
= roleDesignated
;
4051 PRTSM_runr(ptp
, true, false /* actual run */);
4054 /* AlternatePort and BackupPort role transitions */
4056 static void PRTSM_to_BLOCK_PORT(per_tree_port_t
*ptp
)
4059 ptp
->PRTSM_state
= PRTSM_BLOCK_PORT
;
4061 ptp
->role
= ptp
->selectedRole
;
4063 ptp
->forward
= false;
4065 PRTSM_runr(ptp
, true, false /* actual run */);
4068 static void PRTSM_to_BACKUP_PORT(per_tree_port_t
*ptp
, unsigned int HelloTime
)
4071 ptp
->PRTSM_state
= PRTSM_BACKUP_PORT
;
4073 assign(ptp
->rbWhile
, 2 * HelloTime
);
4075 PRTSM_runr(ptp
, true, false /* actual run */);
4078 static void PRTSM_to_ALTERNATE_PROPOSED(per_tree_port_t
*ptp
)
4081 ptp
->PRTSM_state
= PRTSM_ALTERNATE_PROPOSED
;
4083 setSyncTree(ptp
->tree
);
4084 ptp
->proposed
= false;
4086 PRTSM_runr(ptp
, true, false /* actual run */);
4089 static void PRTSM_to_ALTERNATE_AGREED(per_tree_port_t
*ptp
)
4092 ptp
->PRTSM_state
= PRTSM_ALTERNATE_AGREED
;
4094 ptp
->proposed
= false;
4096 /* newInfoXst = TRUE; */
4097 port_t
*prt
= ptp
->port
;
4099 prt
->newInfo
= true;
4101 prt
->newInfoMsti
= true;
4103 PRTSM_runr(ptp
, true, false /* actual run */);
4106 static void PRTSM_to_ALTERNATE_PORT(per_tree_port_t
*ptp
, unsigned int forwardDelay
)
4109 ptp
->PRTSM_state
= PRTSM_ALTERNATE_PORT
;
4111 assign(ptp
->fdWhile
, forwardDelay
);
4113 assign(ptp
->rrWhile
, 0u);
4115 ptp
->reRoot
= false;
4117 PRTSM_runr(ptp
, true, false /* actual run */);
4120 static bool PRTSM_runr(per_tree_port_t
*ptp
, bool recursive_call
, bool dry_run
)
4122 /* Following vars do not need recalculating on recursive calls */
4123 static unsigned int MaxAge
, FwdDelay
, forwardDelay
, HelloTime
;
4125 static tree_t
*tree
;
4126 static per_tree_port_t
*cist
;
4127 /* Following vars are recalculated on each state transition */
4128 bool allSynced
, reRooted
;
4129 /* Following vars are auxiliary and don't depend on recursive_call */
4130 per_tree_port_t
*ptp_1
;
4133 { /* calculate these intermediate vars only first time in chain of
4134 * recursive calls */
4138 cist
= GET_CIST_PTP_FROM_PORT(prt
);
4141 FwdDelay
= cist
->designatedTimes
.Forward_Delay
;
4144 HelloTime
= cist
->portTimes
.Hello_Time
;
4146 /* 13.25.d) -> 17.20.5 of 802.1D */
4147 forwardDelay
= prt
->sendRSTP
? HelloTime
: FwdDelay
;
4150 MaxAge
= cist
->designatedTimes
.Max_Age
;
4153 PRTSM_LOG("role = %d, selectedRole = %d, selected = %d, updtInfo = %d",
4154 ptp
->role
, ptp
->selectedRole
, ptp
->selected
, ptp
->updtInfo
);
4155 if((ptp
->role
!= ptp
->selectedRole
) && ptp
->selected
&& !ptp
->updtInfo
)
4157 switch(ptp
->selectedRole
)
4160 if(dry_run
) /* at least role will change */
4162 PRTSM_to_DISABLE_PORT(ptp
);
4165 if(dry_run
) /* at least role will change */
4167 PRTSM_to_MASTER_PORT(ptp
);
4170 if(dry_run
) /* at least role will change */
4172 PRTSM_to_ROOT_PORT(ptp
, FwdDelay
);
4174 case roleDesignated
:
4175 if(dry_run
) /* at least role will change */
4177 PRTSM_to_DESIGNATED_PORT(ptp
);
4181 if(dry_run
) /* at least role will change */
4183 PRTSM_to_BLOCK_PORT(ptp
);
4190 FOREACH_PTP_IN_TREE(ptp_1
, tree
)
4194 || (ptp_1
->role
!= ptp_1
->selectedRole
)
4207 if((roleRoot
!= ptp_1
->role
) && !ptp_1
->synced
)
4210 case roleDesignated
:
4212 if((ptp
!= ptp_1
) && !ptp_1
->synced
)
4222 switch(ptp
->PRTSM_state
)
4224 /* Disabled Port role transitions */
4225 case PRTSM_INIT_PORT
:
4226 if(dry_run
) /* state change */
4228 PRTSM_to_DISABLE_PORT(ptp
);
4230 case PRTSM_DISABLE_PORT
:
4231 if(ptp
->selected
&& !ptp
->updtInfo
4232 && !ptp
->learning
&& !ptp
->forwarding
4235 if(dry_run
) /* state change */
4237 PRTSM_to_DISABLED_PORT(ptp
, MaxAge
);
4240 case PRTSM_DISABLED_PORT
:
4241 if(ptp
->selected
&& !ptp
->updtInfo
4242 && (ptp
->sync
|| ptp
->reRoot
|| !ptp
->synced
4243 || (ptp
->fdWhile
!= MaxAge
))
4246 if(dry_run
) /* one of (sync,reRoot,synced,fdWhile) will change */
4248 PRTSM_to_DISABLED_PORT(ptp
, MaxAge
);
4251 /* MasterPort role transitions */
4252 case PRTSM_MASTER_PROPOSED
:
4254 case PRTSM_MASTER_AGREED
:
4256 case PRTSM_MASTER_SYNCED
:
4258 case PRTSM_MASTER_RETIRED
:
4260 case PRTSM_MASTER_FORWARD
:
4262 case PRTSM_MASTER_LEARN
:
4264 case PRTSM_MASTER_DISCARD
:
4265 if(dry_run
) /* state change */
4267 PRTSM_to_MASTER_PORT(ptp
);
4269 case PRTSM_MASTER_PORT
:
4270 if(!(ptp
->selected
&& !ptp
->updtInfo
))
4272 if(ptp
->reRoot
&& (0 == ptp
->rrWhile
))
4274 if(dry_run
) /* state change */
4276 PRTSM_to_MASTER_RETIRED(ptp
);
4279 if((!ptp
->learning
&& !ptp
->forwarding
&& !ptp
->synced
)
4280 || (ptp
->agreed
&& !ptp
->synced
)
4281 || (prt
->operEdge
&& !ptp
->synced
)
4282 || (ptp
->sync
&& ptp
->synced
)
4285 if(dry_run
) /* state change */
4287 PRTSM_to_MASTER_SYNCED(ptp
);
4290 if((allSynced
&& !ptp
->agree
)
4291 || (ptp
->proposed
&& ptp
->agree
)
4294 if(dry_run
) /* state change */
4296 PRTSM_to_MASTER_AGREED(ptp
);
4299 if(ptp
->proposed
&& !ptp
->agree
)
4301 if(dry_run
) /* state change */
4303 PRTSM_to_MASTER_PROPOSED(ptp
);
4306 if(((0 == ptp
->fdWhile
) || allSynced
)
4307 && ptp
->learn
&& !ptp
->forward
4310 if(dry_run
) /* state change */
4312 PRTSM_to_MASTER_FORWARD(ptp
);
4315 if(((0 == ptp
->fdWhile
) || allSynced
)
4319 if(dry_run
) /* state change */
4321 PRTSM_to_MASTER_LEARN(ptp
, forwardDelay
);
4324 if(((ptp
->sync
&& !ptp
->synced
)
4325 || (ptp
->reRoot
&& (0 != ptp
->rrWhile
))
4328 && !prt
->operEdge
&& (ptp
->learn
|| ptp
->forward
)
4331 if(dry_run
) /* state change */
4333 PRTSM_to_MASTER_DISCARD(ptp
, forwardDelay
);
4337 /* RootPort role transitions */
4338 case PRTSM_ROOT_PROPOSED
:
4340 case PRTSM_ROOT_AGREED
:
4342 case PRTSM_ROOT_SYNCED
:
4346 case PRTSM_ROOT_FORWARD
:
4348 case PRTSM_ROOT_LEARN
:
4350 case PRTSM_REROOTED
:
4351 if(dry_run
) /* state change */
4353 PRTSM_to_ROOT_PORT(ptp
, FwdDelay
);
4355 case PRTSM_ROOT_PORT
:
4356 if(!(ptp
->selected
&& !ptp
->updtInfo
))
4358 if(!ptp
->forward
&& !ptp
->reRoot
)
4360 if(dry_run
) /* state change */
4362 PRTSM_to_REROOT(ptp
);
4365 if((ptp
->agreed
&& !ptp
->synced
) || (ptp
->sync
&& ptp
->synced
))
4367 if(dry_run
) /* state change */
4369 PRTSM_to_ROOT_SYNCED(ptp
);
4372 if((allSynced
&& !ptp
->agree
) || (ptp
->proposed
&& ptp
->agree
))
4374 if(dry_run
) /* state change */
4376 PRTSM_to_ROOT_AGREED(ptp
);
4379 if(ptp
->proposed
&& !ptp
->agree
)
4381 if(dry_run
) /* state change */
4383 PRTSM_to_ROOT_PROPOSED(ptp
);
4386 /* 17.20.10 of 802.1D : reRooted */
4388 FOREACH_PTP_IN_TREE(ptp_1
, tree
)
4390 if((ptp
!= ptp_1
) && (0 != ptp_1
->rrWhile
))
4396 if((0 == ptp
->fdWhile
)
4397 || (reRooted
&& (0 == ptp
->rbWhile
) && rstpVersion(prt
->bridge
))
4402 if(dry_run
) /* state change */
4404 PRTSM_to_ROOT_LEARN(ptp
, forwardDelay
);
4407 else if(!ptp
->forward
)
4409 if(dry_run
) /* state change */
4411 PRTSM_to_ROOT_FORWARD(ptp
);
4415 if(ptp
->reRoot
&& ptp
->forward
)
4417 if(dry_run
) /* state change */
4419 PRTSM_to_REROOTED(ptp
);
4422 if(ptp
->rrWhile
!= FwdDelay
)
4424 if(dry_run
) /* state change */
4426 PRTSM_to_ROOT_PORT(ptp
, FwdDelay
);
4430 /* DesignatedPort role transitions */
4431 case PRTSM_DESIGNATED_PROPOSE
:
4433 case PRTSM_DESIGNATED_AGREED
:
4435 case PRTSM_DESIGNATED_SYNCED
:
4437 case PRTSM_DESIGNATED_RETIRED
:
4439 case PRTSM_DESIGNATED_FORWARD
:
4441 case PRTSM_DESIGNATED_LEARN
:
4443 case PRTSM_DESIGNATED_DISCARD
:
4444 if(dry_run
) /* state change */
4446 PRTSM_to_DESIGNATED_PORT(ptp
);
4448 case PRTSM_DESIGNATED_PORT
:
4449 if(!(ptp
->selected
&& !ptp
->updtInfo
))
4451 if(ptp
->reRoot
&& (0 == ptp
->rrWhile
))
4453 if(dry_run
) /* state change */
4455 PRTSM_to_DESIGNATED_RETIRED(ptp
);
4458 if((!ptp
->learning
&& !ptp
->forwarding
&& !ptp
->synced
)
4459 || (ptp
->agreed
&& !ptp
->synced
)
4460 || (prt
->operEdge
&& !ptp
->synced
)
4461 || (ptp
->sync
&& ptp
->synced
)
4464 if(dry_run
) /* state change */
4466 PRTSM_to_DESIGNATED_SYNCED(ptp
);
4469 if(allSynced
&& (ptp
->proposed
|| !ptp
->agree
))
4471 if(dry_run
) /* state change */
4473 PRTSM_to_DESIGNATED_AGREED(ptp
);
4476 if(!ptp
->forward
&& !ptp
->agreed
&& !ptp
->proposing
4479 if(dry_run
) /* state change */
4481 PRTSM_to_DESIGNATED_PROPOSE(ptp
);
4484 /* Dont transition to learn/forward when BA inconsistent */
4485 if(((0 == ptp
->fdWhile
) || ptp
->agreed
|| prt
->operEdge
)
4486 && ((0 == ptp
->rrWhile
) || !ptp
->reRoot
) && !ptp
->sync
4487 && !ptp
->port
->BaInconsistent
4492 if(dry_run
) /* state change */
4494 PRTSM_to_DESIGNATED_LEARN(ptp
, forwardDelay
);
4497 else if(!ptp
->forward
)
4499 if(dry_run
) /* state change */
4501 PRTSM_to_DESIGNATED_FORWARD(ptp
);
4505 /* Transition to discarding when BA inconsistent */
4506 if(((ptp
->sync
&& !ptp
->synced
)
4507 || (ptp
->reRoot
&& (0 != ptp
->rrWhile
))
4509 || ptp
->port
->BaInconsistent
4511 && !prt
->operEdge
&& (ptp
->learn
|| ptp
->forward
)
4514 if(dry_run
) /* state change */
4516 PRTSM_to_DESIGNATED_DISCARD(ptp
, forwardDelay
);
4520 /* AlternatePort and BackupPort role transitions */
4521 case PRTSM_BLOCK_PORT
:
4522 if(ptp
->selected
&& !ptp
->updtInfo
4523 && !ptp
->learning
&& !ptp
->forwarding
4526 if(dry_run
) /* state change */
4528 PRTSM_to_ALTERNATE_PORT(ptp
, forwardDelay
);
4531 case PRTSM_BACKUP_PORT
:
4533 case PRTSM_ALTERNATE_PROPOSED
:
4535 case PRTSM_ALTERNATE_AGREED
:
4536 if(dry_run
) /* state change */
4538 PRTSM_to_ALTERNATE_PORT(ptp
, forwardDelay
);
4540 case PRTSM_ALTERNATE_PORT
:
4541 if(!(ptp
->selected
&& !ptp
->updtInfo
))
4543 if((allSynced
&& !ptp
->agree
) || (ptp
->proposed
&& ptp
->agree
))
4545 if(dry_run
) /* state change */
4547 PRTSM_to_ALTERNATE_AGREED(ptp
);
4550 if(ptp
->proposed
&& !ptp
->agree
)
4552 if(dry_run
) /* state change */
4554 PRTSM_to_ALTERNATE_PROPOSED(ptp
);
4557 if((ptp
->rbWhile
!= 2 * HelloTime
) && (roleBackup
== ptp
->role
))
4559 if(dry_run
) /* state change */
4561 PRTSM_to_BACKUP_PORT(ptp
, HelloTime
);
4564 if((ptp
->fdWhile
!= forwardDelay
) || ptp
->sync
|| ptp
->reRoot
4567 if(dry_run
) /* state change */
4569 PRTSM_to_ALTERNATE_PORT(ptp
, forwardDelay
);
4578 /* 13.35 Port State Transition state machine */
4580 static bool PSTSM_run(per_tree_port_t
*ptp
, bool dry_run
);
4581 #define PSTSM_begin(ptp) PSTSM_to_DISCARDING((ptp), true)
4583 static void PSTSM_to_DISCARDING(per_tree_port_t
*ptp
, bool begin
)
4585 ptp
->PSTSM_state
= PSTSM_DISCARDING
;
4587 /* This effectively sets BLOCKING state:
4589 disableForwarding();
4591 if(BR_STATE_BLOCKING
!= ptp
->state
)
4593 if(!ptp
->port
->deleted
)
4594 MSTP_OUT_set_state(ptp
, BR_STATE_BLOCKING
);
4596 ptp
->learning
= false;
4597 ptp
->forwarding
= false;
4600 PSTSM_run(ptp
, false /* actual run */);
4603 static void PSTSM_to_LEARNING(per_tree_port_t
*ptp
)
4605 ptp
->PSTSM_state
= PSTSM_LEARNING
;
4607 /* enableLearning(); */
4608 if(BR_STATE_LEARNING
!= ptp
->state
)
4610 if(!ptp
->port
->deleted
)
4611 MSTP_OUT_set_state(ptp
, BR_STATE_LEARNING
);
4613 ptp
->learning
= true;
4615 PSTSM_run(ptp
, false /* actual run */);
4618 static void PSTSM_to_FORWARDING(per_tree_port_t
*ptp
)
4620 ptp
->PSTSM_state
= PSTSM_FORWARDING
;
4622 /* enableForwarding(); */
4623 if(BR_STATE_FORWARDING
!= ptp
->state
)
4625 if(!ptp
->port
->deleted
)
4626 MSTP_OUT_set_state(ptp
, BR_STATE_FORWARDING
);
4628 ptp
->forwarding
= true;
4630 /* No need to run, no one condition will be met
4631 PSTSM_run(ptp, false); */
4634 static bool PSTSM_run(per_tree_port_t
*ptp
, bool dry_run
)
4636 switch(ptp
->PSTSM_state
)
4638 case PSTSM_DISCARDING
:
4641 if(dry_run
) /* state change */
4643 PSTSM_to_LEARNING(ptp
);
4646 case PSTSM_LEARNING
:
4649 if(dry_run
) /* state change */
4651 PSTSM_to_DISCARDING(ptp
, false);
4653 else if(ptp
->forward
)
4655 if(dry_run
) /* state change */
4657 PSTSM_to_FORWARDING(ptp
);
4660 case PSTSM_FORWARDING
:
4663 if(dry_run
) /* state change */
4665 PSTSM_to_DISCARDING(ptp
, false);
4673 /* 13.36 Topology Change state machine */
4675 #define TCSM_begin(ptp) TCSM_to_INACTIVE((ptp), true)
4677 static void TCSM_to_INACTIVE(per_tree_port_t
*ptp
, bool begin
)
4679 ptp
->TCSM_state
= TCSM_INACTIVE
;
4682 assign(ptp
->tcWhile
, 0u);
4683 set_TopologyChange(ptp
->tree
, false, ptp
->port
);
4684 if(0 == ptp
->MSTID
) /* CIST */
4685 ptp
->port
->tcAck
= false;
4688 TCSM_run(ptp
, false /* actual run */);
4691 static bool TCSM_to_LEARNING(per_tree_port_t
*ptp
, bool dry_run
)
4695 if((ptp
->TCSM_state
!= TCSM_LEARNING
) || ptp
->rcvdTc
|| ptp
->tcProp
)
4697 if(0 == ptp
->MSTID
) /* CIST */
4699 port_t
*prt
= ptp
->port
;
4700 if(prt
->rcvdTcn
|| prt
->rcvdTcAck
)
4706 ptp
->TCSM_state
= TCSM_LEARNING
;
4708 if(0 == ptp
->MSTID
) /* CIST */
4710 port_t
*prt
= ptp
->port
;
4711 prt
->rcvdTcn
= false;
4712 prt
->rcvdTcAck
= false;
4714 ptp
->rcvdTc
= false;
4715 ptp
->tcProp
= false;
4717 TCSM_run(ptp
, false /* actual run */);
4721 static void TCSM_to_DETECTED(per_tree_port_t
*ptp
)
4723 ptp
->TCSM_state
= TCSM_DETECTED
;
4727 /* newInfoXst = TRUE; */
4728 port_t
*prt
= ptp
->port
;
4730 prt
->newInfo
= true;
4732 prt
->newInfoMsti
= true;
4734 TCSM_run(ptp
, false /* actual run */);
4737 static void TCSM_to_NOTIFIED_TCN(per_tree_port_t
*ptp
)
4739 ptp
->TCSM_state
= TCSM_NOTIFIED_TCN
;
4743 TCSM_run(ptp
, false /* actual run */);
4746 static void TCSM_to_NOTIFIED_TC(per_tree_port_t
*ptp
)
4748 ptp
->TCSM_state
= TCSM_NOTIFIED_TC
;
4750 ptp
->rcvdTc
= false;
4751 if(0 == ptp
->MSTID
) /* CIST */
4753 port_t
*prt
= ptp
->port
;
4754 prt
->rcvdTcn
= false;
4755 if(roleDesignated
== ptp
->role
)
4760 TCSM_run(ptp
, false /* actual run */);
4763 static void TCSM_to_PROPAGATING(per_tree_port_t
*ptp
)
4765 ptp
->TCSM_state
= TCSM_PROPAGATING
;
4769 ptp
->tcProp
= false;
4771 TCSM_run(ptp
, false /* actual run */);
4774 static void TCSM_to_ACKNOWLEDGED(per_tree_port_t
*ptp
)
4776 ptp
->TCSM_state
= TCSM_ACKNOWLEDGED
;
4778 assign(ptp
->tcWhile
, 0u);
4779 set_TopologyChange(ptp
->tree
, false, ptp
->port
);
4780 ptp
->port
->rcvdTcAck
= false;
4782 TCSM_run(ptp
, false /* actual run */);
4785 static void TCSM_to_ACTIVE(per_tree_port_t
*ptp
)
4787 ptp
->TCSM_state
= TCSM_ACTIVE
;
4789 TCSM_run(ptp
, false /* actual run */);
4792 static bool TCSM_run(per_tree_port_t
*ptp
, bool dry_run
)
4795 port_t
*prt
= ptp
->port
;
4797 switch(ptp
->TCSM_state
)
4800 if(ptp
->learn
&& !ptp
->fdbFlush
)
4802 if(dry_run
) /* state change */
4804 TCSM_to_LEARNING(ptp
, false /* actual run */);
4808 active_port
= (roleRoot
== ptp
->role
)
4809 || (roleDesignated
== ptp
->role
)
4810 || (roleMaster
== ptp
->role
);
4811 if(active_port
&& ptp
->forward
&& !prt
->operEdge
)
4813 if(dry_run
) /* state change */
4815 TCSM_to_DETECTED(ptp
);
4818 if(ptp
->rcvdTc
|| prt
->rcvdTcn
|| prt
->rcvdTcAck
|| ptp
->tcProp
)
4820 return TCSM_to_LEARNING(ptp
, dry_run
);
4822 else if(!active_port
&& !(ptp
->learn
|| ptp
->learning
))
4824 if(dry_run
) /* state change */
4826 TCSM_to_INACTIVE(ptp
, false);
4829 case TCSM_NOTIFIED_TCN
:
4830 if(dry_run
) /* state change */
4832 TCSM_to_NOTIFIED_TC(ptp
);
4836 case TCSM_NOTIFIED_TC
:
4838 case TCSM_PROPAGATING
:
4840 case TCSM_ACKNOWLEDGED
:
4841 if(dry_run
) /* state change */
4843 TCSM_to_ACTIVE(ptp
);
4846 active_port
= (roleRoot
== ptp
->role
)
4847 || (roleDesignated
== ptp
->role
)
4848 || (roleMaster
== ptp
->role
);
4849 if(!active_port
|| prt
->operEdge
)
4851 if(dry_run
) /* state change */
4853 TCSM_to_LEARNING(ptp
, false /* actual run */);
4858 if(dry_run
) /* state change */
4860 TCSM_to_NOTIFIED_TCN(ptp
);
4865 if(dry_run
) /* state change */
4867 TCSM_to_NOTIFIED_TC(ptp
);
4870 if(ptp
->tcProp
/* && !prt->operEdge */)
4872 if(dry_run
) /* state change */
4874 TCSM_to_PROPAGATING(ptp
);
4879 if(dry_run
) /* state change */
4881 TCSM_to_ACKNOWLEDGED(ptp
);
4890 /* Execute BEGIN state. We do not define BEGIN variable
4891 * but instead xxx_state_machines_begin execute begin state
4892 * abd do one step out of it
4895 static void tree_state_machines_begin(tree_t
*tree
)
4897 bridge_t
*br
= tree
->bridge
;
4898 per_tree_port_t
*ptp
;
4900 if(!br
->bridgeEnabled
)
4903 /* 13.32 Port Information state machine */
4904 FOREACH_PTP_IN_TREE(ptp
, tree
)
4906 ptp
->start_time
= br
->uptime
; /* 12.8.2.2.3 b) */
4910 /* 13.33 Port Role Selection state machine */
4913 /* 13.34 Port Role Transitions state machine */
4914 FOREACH_PTP_IN_TREE(ptp
, tree
)
4916 /* 13.35 Port State Transition state machine */
4917 FOREACH_PTP_IN_TREE(ptp
, tree
)
4919 /* 13.36 Topology Change state machine */
4920 FOREACH_PTP_IN_TREE(ptp
, tree
)
4923 br_state_machines_run(br
);
4926 static void prt_state_machines_begin(port_t
*prt
)
4928 bridge_t
*br
= prt
->bridge
;
4930 per_tree_port_t
*ptp
;
4932 if(!br
->bridgeEnabled
)
4935 /* 13.28 Port Receive state machine */
4937 /* 13.29 Port Protocol Migration state machine */
4939 /* 13.30 Bridge Detection state machine */
4941 /* 13.31 Port Transmit state machine */
4944 /* 13.32 Port Information state machine */
4945 FOREACH_PTP_IN_PORT(ptp
, prt
)
4947 ptp
->start_time
= br
->uptime
; /* 12.8.2.2.3 b) */
4951 /* 13.33 Port Role Selection state machine */
4952 FOREACH_TREE_IN_BRIDGE(tree
, br
)
4953 PRSSM_run(tree
, false /* actual run */);
4955 /* 13.34 Port Role Transitions state machine */
4956 FOREACH_PTP_IN_PORT(ptp
, prt
)
4958 /* 13.35 Port State Transition state machine */
4959 FOREACH_PTP_IN_PORT(ptp
, prt
)
4961 /* 13.36 Topology Change state machine */
4962 FOREACH_PTP_IN_PORT(ptp
, prt
)
4965 br_state_machines_run(br
);
4968 static void br_state_machines_begin(bridge_t
*br
)
4971 per_tree_port_t
*ptp
;
4974 if(!br
->bridgeEnabled
)
4977 /* 13.28 Port Receive state machine */
4978 FOREACH_PORT_IN_BRIDGE(prt
, br
)
4980 /* 13.29 Port Protocol Migration state machine */
4981 FOREACH_PORT_IN_BRIDGE(prt
, br
)
4983 /* 13.30 Bridge Detection state machine */
4984 FOREACH_PORT_IN_BRIDGE(prt
, br
)
4986 /* 13.31 Port Transmit state machine */
4987 FOREACH_PORT_IN_BRIDGE(prt
, br
)
4990 /* 13.32 Port Information state machine */
4991 FOREACH_PORT_IN_BRIDGE(prt
, br
)
4993 FOREACH_PTP_IN_PORT(ptp
, prt
)
4995 ptp
->start_time
= br
->uptime
; /* 12.8.2.2.3 b) */
5000 /* 13.33 Port Role Selection state machine */
5001 FOREACH_TREE_IN_BRIDGE(tree
, br
)
5004 /* 13.34 Port Role Transitions state machine */
5005 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5007 FOREACH_PTP_IN_PORT(ptp
, prt
)
5010 /* 13.35 Port State Transition state machine */
5011 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5013 FOREACH_PTP_IN_PORT(ptp
, prt
)
5016 /* 13.36 Topology Change state machine */
5017 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5019 FOREACH_PTP_IN_PORT(ptp
, prt
)
5023 br_state_machines_run(br
);
5026 /* Run each state machine.
5027 * Return false iff all state machines in dry run indicate that
5028 * state will not be changed. Otherwise return true.
5030 static bool __br_state_machines_run(bridge_t
*br
, bool dry_run
)
5033 per_tree_port_t
*ptp
;
5036 /* Check if bridge assurance timer expires */
5037 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5039 if(prt
->portEnabled
&& assurancePort(prt
)
5040 && (0 == prt
->brAssuRcvdInfoWhile
) && !prt
->BaInconsistent
5043 if(dry_run
) /* state change */
5045 prt
->BaInconsistent
= true;
5046 ERROR_PRTNAME(prt
->bridge
, prt
, "Bridge assurance inconsistent");
5050 /* 13.28 Port Receive state machine */
5051 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5053 if(PRSM_run(prt
, dry_run
) && dry_run
)
5056 /* 13.29 Port Protocol Migration state machine */
5057 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5059 if(PPMSM_run(prt
, dry_run
) && dry_run
)
5062 /* 13.30 Bridge Detection state machine */
5063 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5065 if(BDSM_run(prt
, dry_run
) && dry_run
)
5068 /* 13.31 Port Transmit state machine */
5069 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5071 if(PTSM_run(prt
, dry_run
) && dry_run
)
5075 /* 13.32 Port Information state machine */
5076 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5078 FOREACH_PTP_IN_PORT(ptp
, prt
)
5080 if(PISM_run(ptp
, dry_run
) && dry_run
)
5085 /* 13.33 Port Role Selection state machine */
5086 FOREACH_TREE_IN_BRIDGE(tree
, br
)
5088 if(PRSSM_run(tree
, dry_run
) && dry_run
)
5092 /* 13.34 Port Role Transitions state machine */
5093 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5095 FOREACH_PTP_IN_PORT(ptp
, prt
)
5097 if(PRTSM_run(ptp
, dry_run
) && dry_run
)
5101 /* 13.35 Port State Transition state machine */
5102 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5104 FOREACH_PTP_IN_PORT(ptp
, prt
)
5106 if(PSTSM_run(ptp
, dry_run
) && dry_run
)
5110 /* 13.36 Topology Change state machine */
5111 FOREACH_PORT_IN_BRIDGE(prt
, br
)
5113 FOREACH_PTP_IN_PORT(ptp
, prt
)
5115 if(TCSM_run(ptp
, dry_run
) && dry_run
)
5123 /* Run state machines until their state stabilizes.
5124 * Do not consume more than 1 second.
5126 static void br_state_machines_run(bridge_t
*br
)
5128 struct timespec tv
, tv_end
;
5131 if(!br
->bridgeEnabled
)
5134 clock_gettime(CLOCK_MONOTONIC
, &tv_end
);
5138 if(!__br_state_machines_run(br
, true /* dry run */))
5140 __br_state_machines_run(br
, false /* actual run */);
5142 /* Check for the timeout */
5143 clock_gettime(CLOCK_MONOTONIC
, &tv
);
5144 if(0 < (delta
= tv
.tv_sec
- tv_end
.tv_sec
))
5148 delta
= tv
.tv_nsec
- tv_end
.tv_nsec
;