Fix src/lib/support/StateMachine pattern matching #13664
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
PR #13664: Size comparison from 78a6636 to 3693b83 Full report (14 builds for efr32, k32w, linux, p6, qpg, telink)
|
msandstedt
force-pushed
the
bugfix/state-machine-pattern-matching
branch
from
3693b83 to
5facee3
Compare
pullapprove
bot
requested review from
anush-apple,
balducci-apple,
Byungjoo-Lee,
bzbarsky-apple,
carol-apple,
cecille,
chrisdecenzo,
chshu,
chulspro,
Damian-Nordic,
dhrishi,
electrocucaracha,
emargolis,
franck-apple,
gjc13,
harimau-qirex,
hawk248,
holbrookt,
jelderton,
jepenven-silabs,
jmartinez-silabs,
LuDuda,
lzgrablic02,
mlepage-google and
mspang
pullapprove
bot
requested review from
sagar-apple,
saurabhst,
selissia,
tecimovic,
vijs,
vivien-apple,
wbschiller,
woody-apple,
xylophone21,
yufengwangca and
yunhanw-google
|
PR #13664: Size comparison from 78a6636 to 5facee3 Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
msandstedt
force-pushed
the
bugfix/state-machine-pattern-matching
branch
2 times, most recently
from
03232f1 to
5facee3
Compare
|
PR #13664: Size comparison from 150c479 to 5facee3 Full report (6 builds for k32w, qpg, telink)
|
msandstedt
force-pushed
the
bugfix/state-machine-pattern-matching
branch
from
5facee3 to
3690bb6
Compare
|
PR #13664: Size comparison from 150c479 to 3690bb6 Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
|
PR #13664: Size comparison from 41d3a6c to b07ee40 Full report (14 builds for efr32, k32w, linux, p6, qpg, telink)
|
The Enter method can rewrite the state objects during pattern matching traversal. We need a one-shot bool to ensure we only execute Enter once. And although state changes from Exit, LogTransition and GetName aren't expected, we should check in these too. In all cases, the pattern match should only execute once. This commit adds the necessary check and a test case to verify this is working correctly.
msandstedt
force-pushed
the
bugfix/state-machine-pattern-matching
branch
from
b07ee40 to
5f459ad
Compare
|
PR #13664: Size comparison from 5274676 to 5f459ad Full report (32 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
saurabhst
approved these changes
Jan 19, 2022
andy31415
approved these changes
Jan 19, 2022
|
fast track: small delta with unit tests, created by a domain owner. |
selissia
pushed a commit
to selissia/connectedhomeip
that referenced
this pull request
Jan 28, 2022
The Enter method can rewrite the state objects during pattern matching traversal. We need a one-shot bool to ensure we only execute Enter once. And although state changes from Exit, LogTransition and GetName aren't expected, we should check in these too. In all cases, the pattern match should only execute once. This commit adds the necessary check and a test case to verify this is working correctly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The variant state Enter method can rewrite state objects during pattern matching traversal if Dispatch is called and a state transition occurs. We therefore need to ensure that the Enter method pattern matching can only evaluate true once. Without a check for this, the pattern matching may continue accessing the state object after its destructor has been called.
Change overview
Add a one-shot bool to ensure that Enter is only executed once. And although state changes from Exit, LogTransition and GetName aren't expected, checks are added for these too. In all cases, the pattern match should only execute once.
Testing
A new unit test has been added to check for the bug that is fixed by this PR.