-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* SKA-366: support signal handler * SKA-366: support signal handler on Windows
- Loading branch information
1 parent
59fe4fa
commit eb645c3
Showing
10 changed files
with
308 additions
and
25 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| /* Copyright (c) 2022 Vector Informatik GmbH | ||
| Permission is hereby granted, free of charge, to any person obtaining | ||
| a copy of this software and associated documentation files (the | ||
| "Software"), to deal in the Software without restriction, including | ||
| without limitation the rights to use, copy, modify, merge, publish, | ||
| distribute, sublicense, and/or sell copies of the Software, and to | ||
| permit persons to whom the Software is furnished to do so, subject to | ||
| the following conditions: | ||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ | ||
| #include "SignalHandler.hpp" | ||
| #include <thread> | ||
| #include <stdexcept> | ||
| #include <vector> | ||
|
|
||
| //forward | ||
| namespace { | ||
| class SignalMonitor; | ||
| } // namespace | ||
|
|
||
| // global signal handler | ||
| static std::unique_ptr<SignalMonitor> gSignalMonitor; | ||
|
|
||
| //////////////////////////////////////////// | ||
| // Inline Platform Specific Implementations | ||
| //////////////////////////////////////////// | ||
| #if WIN32 | ||
| #include <windows.h> | ||
|
|
||
| namespace { | ||
|
|
||
| using namespace adapters; | ||
|
|
||
| //forward | ||
| BOOL WINAPI systemHandler(DWORD ctrlType); | ||
|
|
||
| class SignalMonitor | ||
| { | ||
| public: | ||
| SignalMonitor(SignalHandler handler) | ||
| { | ||
| _handler = std::move(handler); | ||
|
|
||
| auto ok = CreatePipe(&_readEnd, &_writeEnd, nullptr, 0); | ||
| if (!ok) | ||
| throw std::runtime_error("CreatePipe failed. Cannot create Signal Handler!"); | ||
| DWORD nowait = PIPE_NOWAIT; | ||
| ok = SetNamedPipeHandleState(_writeEnd, &nowait, nullptr, nullptr); | ||
| if (!ok) | ||
| throw std::runtime_error("Set pipe read end to nonblocking failed. Cannot create Signal Handler!"); | ||
| SetConsoleCtrlHandler(systemHandler, true); | ||
| _worker = std::thread{std::bind(&SignalMonitor::workerMain, this)}; | ||
| } | ||
| ~SignalMonitor() | ||
| { | ||
| SetConsoleCtrlHandler(systemHandler, false); | ||
| Notify(-1); | ||
| _worker.join(); | ||
| CloseHandle(_writeEnd); | ||
| CloseHandle(_readEnd); | ||
| } | ||
| void Notify(int signalNumber) | ||
| { | ||
| // no allocs, no error handling | ||
| _signalNumber = signalNumber; | ||
| uint8_t buf{}; | ||
| auto ok = WriteFile(_writeEnd, &buf, sizeof(buf), nullptr, nullptr); | ||
| (void)ok; | ||
| } | ||
|
|
||
| private: | ||
| void workerMain() | ||
| { | ||
| std::vector<uint8_t> buf(1); | ||
| //blocking read until Notify() was called | ||
| auto ok = ReadFile(_readEnd, buf.data(), static_cast<DWORD>(buf.size()), nullptr, nullptr); | ||
| if (!ok) | ||
| throw std::runtime_error("SignalMonitor::workerMain: cannot read from pipe."); | ||
|
|
||
| if (_handler) | ||
| { | ||
| _handler(_signalNumber); | ||
| } | ||
| } | ||
| HANDLE _readEnd{INVALID_HANDLE_VALUE}, _writeEnd{INVALID_HANDLE_VALUE}; | ||
| SignalHandler _handler; | ||
| std::thread _worker; | ||
| int _signalNumber{-1}; | ||
| }; | ||
|
|
||
| BOOL WINAPI systemHandler(DWORD ctrlType) | ||
| { | ||
| if (gSignalMonitor) | ||
| { | ||
| gSignalMonitor->Notify(static_cast<int>(ctrlType)); | ||
| return TRUE; | ||
| } | ||
| return FALSE; | ||
| } | ||
|
|
||
| } // end anonymous namespace | ||
|
|
||
| #else //UNIX | ||
|
|
||
| #include <csignal> | ||
| #include <cstring> | ||
| #include <cerrno> | ||
| #include <fcntl.h> | ||
| #include <unistd.h> | ||
|
|
||
| namespace { | ||
|
|
||
| using namespace adapters; | ||
|
|
||
| //forward | ||
| void systemHandler(int sigNum); | ||
|
|
||
| auto ErrorMessage() | ||
| { | ||
| return std::string{strerror(errno)}; | ||
| } | ||
|
|
||
| class SignalMonitor | ||
| { | ||
| public: | ||
| SignalMonitor(SignalHandler handler) | ||
| { | ||
| _handler = std::move(handler); | ||
|
|
||
| auto ok = ::pipe(_pipe); | ||
| if (ok == -1) | ||
| throw std::runtime_error("SignalMonitor: pipe() failed! " + ErrorMessage()); | ||
| ok = fcntl(_pipe[1], F_SETFL, O_NONBLOCK); | ||
| if (ok == -1) | ||
| throw std::runtime_error("SignalMonitor: cannot set write end of pipe to non blocking: " + ErrorMessage()); | ||
|
|
||
| signal(SIGINT, &systemHandler); | ||
| signal(SIGTERM, &systemHandler); | ||
| _worker = std::thread{std::bind(&SignalMonitor::workerMain, this)}; | ||
| } | ||
|
|
||
| ~SignalMonitor() | ||
| { | ||
| signal(SIGINT, SIG_DFL); | ||
| signal(SIGTERM, SIG_DFL); | ||
| Notify(-1); | ||
| _worker.join(); | ||
| ::close(_pipe[0]); | ||
| ::close(_pipe[1]); | ||
| } | ||
|
|
||
| void Notify(int signalNumber) | ||
| { | ||
| //in signal handler context: no allocs, no error handling | ||
| _signalNumber = signalNumber; | ||
| uint8_t buf{}; | ||
| auto ok = ::write(_pipe[1], &buf, sizeof(buf)); | ||
| (void)ok; | ||
| } | ||
|
|
||
| private: | ||
| void workerMain() | ||
| { | ||
| std::vector<uint8_t> buf(1); | ||
| //blocking read until Notify() was called | ||
| auto ok = ::read(_pipe[0], buf.data(), buf.size()); | ||
| if (ok == -1) | ||
| throw std::runtime_error("SignalMonitor::workerMain: cannot read from pipe: " + ErrorMessage()); | ||
|
|
||
| if (_handler) | ||
| { | ||
| _handler(_signalNumber); | ||
| } | ||
| } | ||
|
|
||
| int _pipe[2]; | ||
| SignalHandler _handler; | ||
| std::thread _worker; | ||
| int _signalNumber{-1}; | ||
| }; | ||
|
|
||
| void systemHandler(int sigNum) | ||
| { | ||
| if (gSignalMonitor) | ||
| { | ||
| gSignalMonitor->Notify(sigNum); | ||
| } | ||
| } | ||
|
|
||
| } // namespace | ||
| #endif | ||
|
|
||
| namespace adapters { | ||
|
|
||
| void RegisterSignalHandler(SignalHandler handler) | ||
| { | ||
| gSignalMonitor.reset(new SignalMonitor(std::move(handler))); | ||
| } | ||
|
|
||
| } // namespace adapters |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* Copyright (c) 2022 Vector Informatik GmbH | ||
| Permission is hereby granted, free of charge, to any person obtaining | ||
| a copy of this software and associated documentation files (the | ||
| "Software"), to deal in the Software without restriction, including | ||
| without limitation the rights to use, copy, modify, merge, publish, | ||
| distribute, sublicense, and/or sell copies of the Software, and to | ||
| permit persons to whom the Software is furnished to do so, subject to | ||
| the following conditions: | ||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ | ||
| #include <functional> | ||
|
|
||
| namespace adapters { | ||
|
|
||
| //! \brief RegisterSignalHandler can be used to portably register a single signal handler. | ||
| // It only relies on async-signal-safe C functions internally, but | ||
| // it uses a dedicated thread which safely runs the user-provided handler. | ||
|
|
||
| using SignalHandler = std::function<void(int)>; | ||
| void RegisterSignalHandler(SignalHandler handler); | ||
|
|
||
| } // namespace adapters |
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
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
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
Oops, something went wrong.