Cleanup CASESession and PASESession lifetime #13357
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
pullapprove
bot
requested review from
andy31415,
anush-apple,
balducci-apple,
Byungjoo-Lee,
bzbarsky-apple,
carol-apple,
cecille,
chrisdecenzo,
chshu,
chulspro,
Damian-Nordic,
dhrishi,
electrocucaracha,
emargolis,
erjiaqing,
franck-apple,
gjc13,
hawk248,
holbrookt,
jelderton,
jepenven-silabs,
jmartinez-silabs,
kghost,
LuDuda,
lzgrablic02,
mlepage-google,
pan-apple,
robszewczyk and
sagar-apple
|
PR #13357: Size comparison from 36a759d to 6dc903d Increases (13 builds for efr32, k32w, linux, p6, qpg, telink)
Decreases (2 builds for linux)
Full report (14 builds for efr32, k32w, linux, p6, qpg, telink)
|
In fact, maybe |
It would be my preference not to do this in this PR. |
Co-authored-by: Boris Zbarsky <[email protected]>
Co-authored-by: Boris Zbarsky <[email protected]>
Co-authored-by: Boris Zbarsky <[email protected]>
Co-authored-by: Boris Zbarsky <[email protected]>
bzbarsky-apple
approved these changes
Jan 7, 2022
|
PR #13357: Size comparison from 36a759d to 3d04424 Increases above 0.2%:
Increases (17 builds for efr32, k32w, linux, mbed, p6, qpg, telink)
Decreases (2 builds for linux)
Full report (19 builds for efr32, k32w, linux, mbed, p6, qpg, telink)
|
|
@msandstedt - conflicts |
andy31415
approved these changes
Jan 7, 2022
Conflicts are fixed. Now just need to fix top of tree... |
|
PR #13357: Size comparison from 585cdcb to caf19ce Increases (13 builds for efr32, k32w, linux, p6, qpg, telink)
Decreases (2 builds for linux)
Full report (14 builds for efr32, k32w, linux, p6, qpg, telink)
|
|
PR #13357: Size comparison from c25c4b3 to 87990b6 Increases (23 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
Decreases (2 builds for linux)
Full report (31 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
msandstedt
added a commit
to msandstedt/connectedhomeip
that referenced
this pull request
Jan 7, 2022
msandstedt
added a commit
to msandstedt/connectedhomeip
that referenced
this pull request
Jan 8, 2022
msandstedt
added a commit
to msandstedt/connectedhomeip
that referenced
this pull request
Jan 27, 2022
msandstedt
added a commit
to msandstedt/connectedhomeip
that referenced
this pull request
Feb 3, 2022
step0035
pushed a commit
to hank820/connectedhomeip
that referenced
this pull request
Feb 8, 2022
The fix in project-chip#12794 means that the CASESession and PASESession objects do not need to persist for ExchangeMessageDispatch::SendMessage to succeed at the final ACK of session establishment. Instead, SendMessage uses the SessionEstablishmentExchangeDispatch global singleton. This means we can address 13146 such that CASESession and PASESession may actually be freed or reused when completion callbacks fire. This will only work, however, if these objects clear themselves as delegates for their exchange contexts when discarding references to these. This commit does so. This commit also reorders all calls to mDelegate->OnSessionEstablished and mDelegate->OnSessionEstablishmentError to occur last in any given method in case mDelegate frees or reuses the CASESession or PASESession objects on execution of these completion callbacks. With this, we can remove the code in the OperationalDeviceProxy that defers release of the CASESession object until after an iteration of the event loop. Now when OnSessionEstablished fires, the CASESession can be reused or discarded immediately.
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
CASESession and PASESession objects cannot be freed or reused when OnSessionEstablished and OnSessionEstablishmentError delegate methods are executed. Instead, historically, code needed to wait for one more iteration of the event loop before freeing or reusing these objects.
This was in part due to the problem identified in and fixed by #12794, where these objects needed to persist in order for the ExchangeMessageDispatch::SendMessage call for the final ACK of session establishment to be sent. Instead, with #12794, SendMessage uses the SessionEstablishmentExchangeDispatch global singleton.
But there are two other things that prevent immediate free or reuse of the CASESession and PASESession objects on execution of completion callbacks: these objects clear their references to their exchange contexts at completion, but do not clear themselves as delegates to their exchange contexts. The object's methods can also continue to access instance memory after execution of the callbacks.
Change overview
This commit adds code to CASESession and PASESession to always clear themselves as delegates to their exchange contexts before clearing their references to their exchange contexts, and reorders calls to mDelegate->OnSessionEstablished and mDelegate->OnSessionEstablishmentError to occur last in any given method
in case mDelegate frees or reuses the CASESession or PASESession objects on execution of the completion callbacks.
Additionally, this removes the code in the OperationalDeviceProxy that was deferring release of the CASESession object until after an iteration of the event loop. Now when OnSessionEstablished fires, the CASESession can be reused or discarded immediately.
Fixes #13146
Testing
TestCASESession, TestPASESession and all other unit tests pass. We also expect asan to show clean CI runs with this.
This was also manually tested and seen to fix #13146 in the original feature branch for #13294 where this problem had first been identified.