-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Signals.cpp implementation for Windows #16396
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| /* | ||
| * Copyright (C) 2023 Ian Grunert <ian.grunert@gmail.com> | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions | ||
| * are met: | ||
| * 1. Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * 2. Redistributions in binary form must reproduce the above copyright | ||
| * notice, this list of conditions and the following disclaimer in the | ||
| * documentation and/or other materials provided with the distribution. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY | ||
| * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR | ||
| * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
| * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
| * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
| * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | ||
| * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
|
|
||
| #include "config.h" | ||
| #include <wtf/threads/Signals.h> | ||
|
|
||
| #if OS(WINDOWS) | ||
|
|
||
| #include <cstdio> | ||
| #include <mutex> | ||
| #include <signal.h> | ||
| #include <winnt.h> | ||
|
|
||
| #include <wtf/Atomics.h> | ||
| #include <wtf/DataLog.h> | ||
| #include <wtf/MathExtras.h> | ||
| #include <wtf/NeverDestroyed.h> | ||
| #include <wtf/PlatformRegisters.h> | ||
| #include <wtf/ThreadGroup.h> | ||
| #include <wtf/Threading.h> | ||
| #include <wtf/WTFConfig.h> | ||
|
|
||
| namespace WTF { | ||
|
|
||
| void SignalHandlers::add(Signal signal, SignalHandler&& handler) | ||
| { | ||
| Config::AssertNotFrozenScope assertScope; | ||
| static Lock lock; | ||
| Locker locker { lock }; | ||
|
|
||
| size_t signalIndex = static_cast<size_t>(signal); | ||
| size_t nextFree = numberOfHandlers[signalIndex]; | ||
| RELEASE_ASSERT(nextFree < maxNumberOfHandlers); | ||
| SignalHandlerMemory* memory = &handlers[signalIndex][nextFree]; | ||
| new (memory) SignalHandler(WTFMove(handler)); | ||
|
|
||
| // We deliberately do not want to increment the count until after we've | ||
| // fully initialized the memory. This way, forEachHandler() won't see a | ||
| // partially initialized handler. | ||
| storeStoreFence(); | ||
| numberOfHandlers[signalIndex]++; | ||
| loadLoadFence(); | ||
| } | ||
|
|
||
| template<typename Func> | ||
| inline void SignalHandlers::forEachHandler(Signal signal, const Func& func) const | ||
| { | ||
| size_t signalIndex = static_cast<size_t>(signal); | ||
| size_t handlerIndex = numberOfHandlers[signalIndex]; | ||
| while (handlerIndex--) { | ||
| auto* memory = const_cast<SignalHandlerMemory*>(&handlers[signalIndex][handlerIndex]); | ||
| const SignalHandler& handler = *bitwise_cast<SignalHandler*>(memory); | ||
| func(handler); | ||
| } | ||
| } | ||
|
|
||
| inline Signal fromSystemException(int signal) | ||
| { | ||
| switch (signal) { | ||
| case EXCEPTION_FLT_DENORMAL_OPERAND: | ||
| case EXCEPTION_FLT_DIVIDE_BY_ZERO: | ||
| case EXCEPTION_FLT_INEXACT_RESULT: | ||
| case EXCEPTION_FLT_INVALID_OPERATION: | ||
| case EXCEPTION_FLT_OVERFLOW: | ||
| case EXCEPTION_FLT_STACK_CHECK: | ||
| case EXCEPTION_FLT_UNDERFLOW: | ||
| return Signal::FloatingPoint; | ||
| case EXCEPTION_ILLEGAL_INSTRUCTION: | ||
| return Signal::IllegalInstruction; | ||
| case EXCEPTION_ACCESS_VIOLATION: | ||
| return Signal::AccessFault; | ||
| default: | ||
| return Signal::Unknown; | ||
| } | ||
| } | ||
|
|
||
| LONG WINAPI vectoredHandler(struct _EXCEPTION_POINTERS *exceptionInfo) | ||
| { | ||
| Signal signal = fromSystemException(exceptionInfo->ExceptionRecord->ExceptionCode); | ||
| SignalHandlers& handlers = g_wtfConfig.signalHandlers; | ||
|
|
||
| SigInfo sigInfo; | ||
| if (signal == Signal::AccessFault) { | ||
| // The second array element specifies the virtual address of the inaccessible data. | ||
| // https://learn.microsoft.com/en-us/windows/win32/api/winnt/ns-winnt-exception_record | ||
| sigInfo.faultingAddress = reinterpret_cast<void*>(exceptionInfo->ExceptionRecord->ExceptionInformation[1]); | ||
| } | ||
|
|
||
| PlatformRegisters& registers = *(exceptionInfo->ContextRecord); | ||
|
|
||
| long result = EXCEPTION_EXECUTE_HANDLER; | ||
| handlers.forEachHandler(signal, [&] (const SignalHandler& handler) { | ||
| switch (handler(signal, sigInfo, registers)) { | ||
| case SignalAction::Handled: | ||
| result = EXCEPTION_CONTINUE_EXECUTION; | ||
| break; | ||
| default: | ||
| break; | ||
| } | ||
| }); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| void addSignalHandler(Signal signal, SignalHandler&& handler) | ||
| { | ||
| Config::AssertNotFrozenScope assertScope; | ||
| SignalHandlers& handlers = g_wtfConfig.signalHandlers; | ||
| ASSERT(signal < Signal::Unknown); | ||
|
|
||
| static std::once_flag initializeOnceFlags[static_cast<size_t>(Signal::NumberOfSignals)]; | ||
| std::call_once(initializeOnceFlags[static_cast<size_t>(signal)], [&] { | ||
| Config::AssertNotFrozenScope assertScope; | ||
| AddVectoredExceptionHandler(1, vectoredHandler); | ||
| }); | ||
|
|
||
| handlers.add(signal, WTFMove(handler)); | ||
| } | ||
|
|
||
| void activateSignalHandlersFor(Signal signal) | ||
| { | ||
| UNUSED_PARAM(signal); | ||
| } | ||
|
|
||
| void SignalHandlers::initialize() | ||
| { | ||
| // noop | ||
| } | ||
|
|
||
| } // namespace WTF | ||
|
|
||
| #endif // OS(WINDOWS) |
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.
Put this at the top of the block and the build should go back to green.