Add async cleanup APIs for external execution mode #5127
There are no files selected for viewing
Empty file.
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,12 @@ | |
| #include "registration.c.clog.h" | ||
| #endif | ||
|
|
||
| typedef struct QUIC_REGISTRATION_EX { | ||
| QUIC_REGISTRATION Registration; | ||
| QUIC_REGISTRATION_CLOSE_COMPLETE_HANDLER CloseHandler; | ||
| void* CloseContext; | ||
| } QUIC_REGISTRATION_EX; | ||
|
There was a problem hiding this comment. Instead of making a new EX struct. Just put this stuff inside the existing registration struct. There was a problem hiding this comment. I've removed the QUIC_REGISTRATION_EX struct and instead added the CloseHandler and CloseContext fields directly to the existing QUIC_REGISTRATION struct. This eliminates the need for a separate wrapper struct and makes the code cleaner. 49d380c |
||
|
|
||
| _IRQL_requires_max_(PASSIVE_LEVEL) | ||
| QUIC_STATUS | ||
| QUIC_API | ||
|
|
@@ -61,16 +67,20 @@ MsQuicRegistrationOpen( | |
| goto Error; | ||
| } | ||
|
|
||
| QUIC_REGISTRATION_EX* RegistrationEx = CXPLAT_ALLOC_NONPAGED(RegistrationSize + sizeof(QUIC_REGISTRATION_EX) - sizeof(QUIC_REGISTRATION), QUIC_POOL_REGISTRATION); | ||
| if (RegistrationEx == NULL) { | ||
| QuicTraceEvent( | ||
| AllocFailure, | ||
| "Allocation of '%s' failed. (%llu bytes)", | ||
| "registration", | ||
| sizeof(QUIC_REGISTRATION_EX) + AppNameLength + 1); | ||
| Status = QUIC_STATUS_OUT_OF_MEMORY; | ||
| goto Error; | ||
| } | ||
|
|
||
| Registration = &RegistrationEx->Registration; | ||
| RegistrationEx->CloseHandler = NULL; | ||
| RegistrationEx->CloseContext = NULL; | ||
|
|
||
| CxPlatZeroMemory(Registration, RegistrationSize); | ||
| Registration->Type = QUIC_HANDLE_TYPE_REGISTRATION; | ||
|
|
@@ -143,6 +153,54 @@ MsQuicRegistrationOpen( | |
| return Status; | ||
| } | ||
|
|
||
| _IRQL_requires_max_(PASSIVE_LEVEL) | ||
| void | ||
| QuicRegistrationRundownComplete( | ||
| _In_ void* Context | ||
| ) | ||
| { | ||
| QUIC_REGISTRATION_EX* RegistrationEx = CXPLAT_CONTAINING_RECORD(Context, QUIC_REGISTRATION_EX, Registration); | ||
| QUIC_REGISTRATION* Registration = &RegistrationEx->Registration; | ||
|
|
||
| QuicWorkerPoolUninitialize(Registration->WorkerPool); | ||
| CxPlatRundownUninitialize(&Registration->Rundown); | ||
| CxPlatDispatchLockUninitialize(&Registration->ConnectionLock); | ||
| CxPlatLockUninitialize(&Registration->ConfigLock); | ||
|
|
||
| // Store callback info locally before freeing | ||
| QUIC_REGISTRATION_CLOSE_COMPLETE_HANDLER Handler = RegistrationEx->CloseHandler; | ||
| void* HandlerContext = RegistrationEx->CloseContext; | ||
|
|
||
| CXPLAT_FREE(RegistrationEx, QUIC_POOL_REGISTRATION); | ||
|
|
||
| // Call the callback as the very last thing in the function | ||
| if (Handler != NULL) { | ||
| Handler(HandlerContext); | ||
| } | ||
| } | ||
|
|
||
| // Forward declaration | ||
| _IRQL_requires_max_(PASSIVE_LEVEL) | ||
| QUIC_STATUS | ||
| QUIC_API | ||
| MsQuicRegistrationCloseAsync( | ||
| _In_ _Pre_defensive_ __drv_freesMem(Mem) | ||
| HQUIC Handle, | ||
| _In_opt_ QUIC_REGISTRATION_CLOSE_COMPLETE_HANDLER Handler, | ||
| _In_opt_ void* Context | ||
| ); | ||
|
|
||
| // Helper function for MsQuicRegistrationClose | ||
| void | ||
| QUIC_API | ||
| QuicRegistrationCloseComplete( | ||
| void* Context | ||
| ) | ||
| { | ||
| CXPLAT_EVENT* Event = (CXPLAT_EVENT*)Context; | ||
| CxPlatEventSet(*Event); | ||
| } | ||
|
|
||
| _IRQL_requires_max_(PASSIVE_LEVEL) | ||
| void | ||
| QUIC_API | ||
|
|
@@ -158,12 +216,57 @@ MsQuicRegistrationClose( | |
| QUIC_TRACE_API_REGISTRATION_CLOSE, | ||
| Handle); | ||
|
|
||
| // Create an event to wait on | ||
| CXPLAT_EVENT CompletionEvent; | ||
| CxPlatEventInitialize(&CompletionEvent, TRUE, FALSE); | ||
|
|
||
| // Call the async version with our event as the context | ||
| MsQuicRegistrationCloseAsync( | ||
| Handle, | ||
| QuicRegistrationCloseComplete, | ||
| &CompletionEvent); | ||
|
|
||
| // Wait for the event to be set by the completion callback | ||
| CxPlatEventWaitForever(CompletionEvent); | ||
|
|
||
| // Clean up the event | ||
| CxPlatEventUninitialize(CompletionEvent); | ||
|
|
||
| QuicTraceEvent( | ||
| ApiExit, | ||
| "[ api] Exit"); | ||
| } | ||
| } | ||
|
|
||
| _IRQL_requires_max_(PASSIVE_LEVEL) | ||
| QUIC_STATUS | ||
| QUIC_API | ||
| MsQuicRegistrationCloseAsync( | ||
nibanks marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| _In_ _Pre_defensive_ __drv_freesMem(Mem) | ||
| HQUIC Handle, | ||
| _In_opt_ QUIC_REGISTRATION_CLOSE_COMPLETE_HANDLER Handler, | ||
| _In_opt_ void* Context | ||
| ) | ||
| { | ||
| QUIC_STATUS Status = QUIC_STATUS_INVALID_PARAMETER; | ||
|
|
||
| if (Handle != NULL && Handle->Type == QUIC_HANDLE_TYPE_REGISTRATION) { | ||
| QuicTraceEvent( | ||
| ApiEnter, | ||
| "[ api] Enter %u (%p).", | ||
| QUIC_TRACE_API_REGISTRATION_CLOSE_ASYNC, | ||
| Handle); | ||
|
|
||
| #pragma prefast(suppress: __WARNING_25024, "Pointer cast already validated.") | ||
| QUIC_REGISTRATION* Registration = (QUIC_REGISTRATION*)Handle; | ||
| QUIC_REGISTRATION_EX* RegistrationEx = CXPLAT_CONTAINING_RECORD(Registration, QUIC_REGISTRATION_EX, Registration); | ||
|
|
||
| RegistrationEx->CloseHandler = Handler; | ||
| RegistrationEx->CloseContext = Context; | ||
|
|
||
| QuicTraceEvent( | ||
| RegistrationCleanup, | ||
| "[ reg][%p] Cleaning up (async)", | ||
| Registration); | ||
|
|
||
| if (Registration->ExecProfile != QUIC_EXECUTION_PROFILE_TYPE_INTERNAL) { | ||
|
|
@@ -172,19 +275,20 @@ MsQuicRegistrationClose( | |
| CxPlatLockRelease(&MsQuicLib.Lock); | ||
| } | ||
|
|
||
| Status = QUIC_STATUS_SUCCESS; | ||
|
|
||
| // Release the rundown - this starts the cleanup process | ||
| CxPlatRundownRelease(&Registration->Rundown); | ||
|
|
||
| // Return pending as we don't know when it will complete | ||
| Status = QUIC_STATUS_PENDING; | ||
|
|
||
| QuicTraceEvent( | ||
| ApiExit, | ||
| "[ api] Exit"); | ||
| } | ||
|
|
||
| return Status; | ||
| } | ||
|
|
||
| _IRQL_requires_max_(DISPATCH_LEVEL) | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file has no changes. Please remove it from this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've removed this file from the PR as it has no changes.