Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions Source/Thunder/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,27 @@ get_filename_component(TARGET ${CMAKE_CURRENT_SOURCE_DIR} NAME)
set(THREADPOOL_COUNT "4" CACHE STRING "The number of threads in the thread pool")
set(ENABLE_TRACING_MODULES "" CACHE STRING "A space separated list of specific tracing modules to be enabled at start.")

macro(thunder_postmortem_sink_value VAR_IN VAR_OUT)
string(TOUPPER "${${VAR_IN}}" _s)
if (_s STREQUAL "LOG")
set(${VAR_OUT} 1)
elseif(_s STREQUAL "ALL")
set(${VAR_OUT} 2)
elseif(_s STREQUAL "DISABLED")
set(${VAR_OUT} 3)
else()
set(${VAR_OUT} 0)
endif()
endmacro()

set(POSTMORTEM_WORKERPOOL_SINK "FILE" CACHE STRING "Default WorkerPool JSON dump sink on crash (FILE | LOG | ALL | DISABLED)")
set(POSTMORTEM_CALLSTACK_SINK "DISABLED" CACHE STRING "Default inline callstack print sink on crash (FILE | LOG | ALL | DISABLED)")
set_property(CACHE POSTMORTEM_WORKERPOOL_SINK PROPERTY STRINGS FILE LOG ALL DISABLED)
set_property(CACHE POSTMORTEM_CALLSTACK_SINK PROPERTY STRINGS FILE LOG ALL DISABLED)
Comment thread
SatheeshkumarG15 marked this conversation as resolved.

thunder_postmortem_sink_value(POSTMORTEM_WORKERPOOL_SINK _wp_sink)
thunder_postmortem_sink_value(POSTMORTEM_CALLSTACK_SINK _cs_sink)

option(SKIP_PERSISTENT_PATH_INSTALL "This will skip installing the persistent path and its privileges. Needed for local build/installs" OFF)

add_executable(${TARGET}
Expand All @@ -38,6 +59,8 @@ target_compile_definitions(${TARGET}
NAMESPACE=${NAMESPACE}
APPLICATION_NAME=${TARGET}
THREADPOOL_COUNT=${THREADPOOL_COUNT}
THUNDER_POSTMORTEM_WORKERPOOL_SINK_DEFAULT=${_wp_sink}
Comment thread
sebaszm marked this conversation as resolved.
THUNDER_POSTMORTEM_CALLSTACK_SINK_DEFAULT=${_cs_sink}
)

target_compile_options (${TARGET} PRIVATE -Wno-psabi)
Expand Down
43 changes: 43 additions & 0 deletions Source/Thunder/Config.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,25 @@
namespace Thunder {

namespace PluginHost {

enum class PostMortemDataSink : uint8_t {
FILE = 0,
LOG = 1,
ALL = 2,
DISABLED = 3
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Outdated
};

static inline PostMortemDataSink ParsePostMortemDataSink(const string& input, PostMortemDataSink fallback)
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Outdated
{
string s(input);
std::transform(s.begin(), s.end(), s.begin(), [](unsigned char c) { return static_cast<char>(::tolower(c)); });
if (s == _T("log")) return PostMortemDataSink::LOG;
else if (s == _T("all")) return PostMortemDataSink::ALL;
else if (s == _T("disabled")) return PostMortemDataSink::DISABLED;
else if (s == _T("file")) return PostMortemDataSink::FILE;
return fallback;
}

/**
* IMPORTANT: If updating this class to add/remove/modify configuration options, ensure
* the documentation in docs/introduction/config.md is updated to reflect the changes!
Expand Down Expand Up @@ -459,6 +478,8 @@ namespace PluginHost {
Add(_T("volatilepath"), &VolatilePath);
Add(_T("proxystubpath"), &ProxyStubPath);
Add(_T("postmortempath"), &PostMortemPath);
Add(_T("postmortemworkerpoolsink"), &PostMortemWorkerPoolSink);
Add(_T("postmortemcallstacksink"), &PostMortemCallstackSink);
Add(_T("communicator"), &Communicator);
Add(_T("signature"), &Signature);
Add(_T("idletime"), &IdleTime);
Expand Down Expand Up @@ -515,6 +536,8 @@ namespace PluginHost {
Core::JSON::String VolatilePath;
Core::JSON::String ProxyStubPath;
Core::JSON::String PostMortemPath;
Core::JSON::String PostMortemWorkerPoolSink;
Core::JSON::String PostMortemCallstackSink;
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Outdated
Core::JSON::String Communicator;
Core::JSON::String Redirect;
Core::JSON::String Signature;
Expand Down Expand Up @@ -695,6 +718,8 @@ namespace PluginHost {
, _proxyStubPath()
, _observableProxyStubPath()
, _postMortemPath()
, _workerPoolSink(static_cast<PostMortemDataSink>(THUNDER_POSTMORTEM_WORKERPOOL_SINK_DEFAULT))
, _callstackSink(static_cast<PostMortemDataSink>(THUNDER_POSTMORTEM_CALLSTACK_SINK_DEFAULT))
, _pluginConfigPath()
, _accessor()
, _communicator()
Expand Down Expand Up @@ -808,6 +833,14 @@ namespace PluginHost {
_pluginConfigPath = Core::Directory::Normalize(config.Observe.PluginConfigPath.Value());
}
_postMortemPath = Core::Directory::Normalize(config.PostMortemPath.Value());
_workerPoolSink = config.PostMortemWorkerPoolSink.IsSet()
? ParsePostMortemDataSink(config.PostMortemWorkerPoolSink.Value(),
PostMortemDataSink::FILE)
: static_cast<PostMortemDataSink>(THUNDER_POSTMORTEM_WORKERPOOL_SINK_DEFAULT);
_callstackSink = config.PostMortemCallstackSink.IsSet()
? ParsePostMortemDataSink(config.PostMortemCallstackSink.Value(),
PostMortemDataSink::DISABLED)
: static_cast<PostMortemDataSink>(THUNDER_POSTMORTEM_CALLSTACK_SINK_DEFAULT);
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
_appPath = Core::Directory::Normalize(Core::File::PathName(Core::ProcessInfo().Executable()));
_hashKey = config.Signature.Value();
_communicator = Core::NodeId(config.Communicator.Value().c_str());
Expand Down Expand Up @@ -1039,6 +1072,14 @@ namespace PluginHost {
{
return (_postMortemPath);
}
inline PostMortemDataSink PostMortemWorkerPoolSink() const
{
return (_workerPoolSink);
}
inline PostMortemDataSink PostMortemCallstackSink() const
{
return (_callstackSink);
}
inline bool PostMortemAllowed(PluginHost::IShell::reason why) const
{
std::list<PluginHost::IShell::reason>::const_iterator index(std::find(_reasons.begin(), _reasons.end(), why));
Expand Down Expand Up @@ -1334,6 +1375,8 @@ namespace PluginHost {
string _proxyStubPath;
string _observableProxyStubPath;
string _postMortemPath;
PostMortemDataSink _workerPoolSink;
PostMortemDataSink _callstackSink;
string _pluginConfigPath;
Core::NodeId _accessor;
Core::NodeId _communicator;
Expand Down
2 changes: 2 additions & 0 deletions Source/Thunder/GenericConfig.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ map_set(${CONFIG} systempath ${SYSTEM_PATH})
map_set(${CONFIG} extensionpath ${EXTENSION_PATH})
map_set(${CONFIG} proxystubpath ${PROXYSTUB_PATH})
map_set(${CONFIG} postmortempath ${POSTMORTEM_PATH})
map_set(${CONFIG} postmortemworkerpoolsink ${POSTMORTEM_WORKERPOOL_SINK})
map_set(${CONFIG} postmortemcallstacksink ${POSTMORTEM_CALLSTACK_SINK})
map_set(${CONFIG} redirect "/Service/Controller/UI/index.html")
map_set(${CONFIG} ethernetcard ${ETHERNETCARD_NAME})
if(NOT COMMUNICATOR STREQUAL "")
Expand Down
47 changes: 38 additions & 9 deletions Source/Thunder/PluginServer.h
Original file line number Diff line number Diff line change
Expand Up @@ -5694,15 +5694,32 @@ namespace PluginHost {

Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Outdated
Core::JSON::ArrayType<Metadata::Server::Minion>::Iterator index(data.WorkerPool.ThreadPoolRuns.Elements());

const PluginHost::PostMortemDataSink wpSink = _config.PostMortemWorkerPoolSink();
const PluginHost::PostMortemDataSink csSink = _config.PostMortemCallstackSink();

Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
if ((wpSink == PluginHost::PostMortemDataSink::DISABLED) && (csSink == PluginHost::PostMortemDataSink::DISABLED)) {
return;
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Outdated
}

while (index.Next() == true) {

const uint64_t threadIdRaw = index.Current().Id.Value();

std::list<Core::callstack_info> stackList;
if (index.Current().Id.Value() != 0) {
::DumpCallStack(PluginHost::Metadata::ThreadId(index.Current().Id.Value()), stackList);
if (threadIdRaw != 0) {
::DumpCallStack(PluginHost::Metadata::ThreadId(threadIdRaw), stackList);
}
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Outdated

if (csSink == PluginHost::PostMortemDataSink::LOG || csSink == PluginHost::PostMortemDataSink::ALL) {
for (const Core::callstack_info& entry : stackList) {
const char* sym = entry.function.empty() ? "Unknown symbol" : entry.function.c_str();
SYSLOG(Logging::Shutdown, (_T("[%s]:[%s]:[%u]:[%p]"),
entry.module.c_str(), sym, static_cast<unsigned int>(entry.line), entry.address));
}
}

PostMortemData::Callstack dump;
dump.Id = index.Current().Id.Value();
dump.Id = threadIdRaw;

for (const Core::callstack_info& info : stackList) {
dump.Data.Add() = CallstackData(info);
Expand All @@ -5711,13 +5728,25 @@ namespace PluginHost {
data.Callstacks.Add(dump);
}

if (csSink == PluginHost::PostMortemDataSink::FILE || csSink == PluginHost::PostMortemDataSink::ALL) {
DumpReadableMetadata(data, _config.PostMortemPath());
}

// Drop the workerpool info (what is currently running and what is pending) to a file..
Core::File dumpFile(_config.PostMortemPath() + "ThunderInternals.json");
if (dumpFile.Create(false) == true) {
data.IElement::ToFile(dumpFile);
if (wpSink == PluginHost::PostMortemDataSink::FILE || wpSink == PluginHost::PostMortemDataSink::ALL) {
Core::File dumpFile(_config.PostMortemPath() + "ThunderInternals.json");
if (dumpFile.Create(false) == true) {
data.IElement::ToFile(dumpFile);
}
}

DumpReadableMetadata(data);
if (wpSink == PluginHost::PostMortemDataSink::LOG || wpSink == PluginHost::PostMortemDataSink::ALL) {
string jsonContent;
data.IElement::ToString(jsonContent);
SYSLOG(Logging::Shutdown, (_T("WorkerPool snapshot start\n")));
SYSLOG(Logging::Shutdown, (_T("[%s]\n"), jsonContent.c_str()));
SYSLOG(Logging::Shutdown, (_T("WorkerPool snapshot end\n")));
}
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
Outdated
}
inline ServiceMap& Services()
{
Expand Down Expand Up @@ -5797,7 +5826,7 @@ namespace PluginHost {
}

private:
void DumpReadableMetadata(PostMortemData& data) const
void DumpReadableMetadata(PostMortemData& data, const string& outputPath) const
{
string readableDump;

Expand Down Expand Up @@ -5874,7 +5903,7 @@ namespace PluginHost {
appendReadableStack(index.Current());
}

Core::File readableDumpFile(_config.PostMortemPath() + "ThunderInternals.txt");
Core::File readableDumpFile(outputPath + "ThunderInternals.txt");
if (readableDumpFile.Create(false) == true) {
const uint32_t dumpSize = static_cast<uint32_t>(readableDump.length() * sizeof(string::value_type));
const uint32_t written = readableDumpFile.Write(reinterpret_cast<const uint8_t*>(readableDump.c_str()), dumpSize);
Expand Down
2 changes: 2 additions & 0 deletions Source/Thunder/Thunder.conf.in
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ systempath = '@SYSTEM_PATH@'
extensionpath = '@EXTENSION_PATH@'
proxystubpath = '@PROXYSTUB_PATH@'
postmortempath = '@POSTMORTEM_PATH@'
postmortemworkerpoolsink = '@POSTMORTEM_WORKERPOOL_SINK@'
postmortemcallstacksink = '@POSTMORTEM_CALLSTACK_SINK@'
redirect = '/Service/Controller/UI/index.html'
ethernetcard = '@ETHERNETCARD_NAME@'
communicator = '@COMMUNICATOR@'
Expand Down
8 changes: 4 additions & 4 deletions Source/Thunder/bridge.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
<FunctionLevelLinking>true</FunctionLevelLinking>
<IntrinsicFunctions>true</IntrinsicFunctions>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>APPLICATION_NAME=Thunder;__CORE_MESSAGING__;_CRT_SECURE_NO_WARNINGS;_WINDOWS;THREADPOOL_COUNT=4;HOSTING_COMPROCESS=comprocess.exe;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<PreprocessorDefinitions>APPLICATION_NAME=Thunder;__CORE_MESSAGING__;_CRT_SECURE_NO_WARNINGS;_WINDOWS;THREADPOOL_COUNT=4;HOSTING_COMPROCESS=comprocess.exe;THUNDER_POSTMORTEM_WORKERPOOL_SINK_DEFAULT=0;THUNDER_POSTMORTEM_CALLSTACK_SINK_DEFAULT=3;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
<PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
<AdditionalIncludeDirectories>$(FrameworkPath)plugins;$(FrameworkPath);$(WindowsPath);$(WindowsPath)zlib;$(FrameworkPath)addons</AdditionalIncludeDirectories>
Expand All @@ -143,7 +143,7 @@
<WarningLevel>Level3</WarningLevel>
<Optimization>Disabled</Optimization>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>APPLICATION_NAME=Thunder;__CORE_MESSAGING__;_CRT_SECURE_NO_WARNINGS;_WINDOWS;THREADPOOL_COUNT=4;HOSTING_COMPROCESS=comprocess.exe;WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<PreprocessorDefinitions>APPLICATION_NAME=Thunder;__CORE_MESSAGING__;_CRT_SECURE_NO_WARNINGS;_WINDOWS;THREADPOOL_COUNT=4;HOSTING_COMPROCESS=comprocess.exe;THUNDER_POSTMORTEM_WORKERPOOL_SINK_DEFAULT=0;THUNDER_POSTMORTEM_CALLSTACK_SINK_DEFAULT=3;WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
<PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
<AdditionalIncludeDirectories>$(FrameworkPath)plugins;$(FrameworkPath);$(WindowsPath);$(WindowsPath)zlib;$(FrameworkPath)addons</AdditionalIncludeDirectories>
Expand All @@ -165,7 +165,7 @@
<WarningLevel>Level3</WarningLevel>
<Optimization>Disabled</Optimization>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>APPLICATION_NAME=Thunder;__CORE_MESSAGING__;_CRT_SECURE_NO_WARNINGS;_WINDOWS;THREADPOOL_COUNT=4;HOSTING_COMPROCESS=comprocess.exe;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<PreprocessorDefinitions>APPLICATION_NAME=Thunder;__CORE_MESSAGING__;_CRT_SECURE_NO_WARNINGS;_WINDOWS;THREADPOOL_COUNT=4;HOSTING_COMPROCESS=comprocess.exe;THUNDER_POSTMORTEM_WORKERPOOL_SINK_DEFAULT=0;THUNDER_POSTMORTEM_CALLSTACK_SINK_DEFAULT=3;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
<PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
<AdditionalIncludeDirectories>$(FrameworkPath)plugins;$(FrameworkPath);$(WindowsPath);$(WindowsPath)zlib;$(FrameworkPath)addons</AdditionalIncludeDirectories>
Expand All @@ -189,7 +189,7 @@
<FunctionLevelLinking>true</FunctionLevelLinking>
<IntrinsicFunctions>true</IntrinsicFunctions>
<SDLCheck>true</SDLCheck>
<PreprocessorDefinitions>APPLICATION_NAME=Thunder;__CORE_MESSAGING__;_CRT_SECURE_NO_WARNINGS;_WINDOWS;THREADPOOL_COUNT=4;HOSTING_COMPROCESS=comprocess.exe;WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<PreprocessorDefinitions>APPLICATION_NAME=Thunder;__CORE_MESSAGING__;_CRT_SECURE_NO_WARNINGS;_WINDOWS;THREADPOOL_COUNT=4;HOSTING_COMPROCESS=comprocess.exe;THUNDER_POSTMORTEM_WORKERPOOL_SINK_DEFAULT=0;THUNDER_POSTMORTEM_CALLSTACK_SINK_DEFAULT=3;WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
<PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
<AdditionalIncludeDirectories>$(FrameworkPath)plugins;$(FrameworkPath);$(WindowsPath);$(WindowsPath)zlib;$(FrameworkPath)addons</AdditionalIncludeDirectories>
Expand Down
2 changes: 2 additions & 0 deletions Source/Thunder/params.config
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ systempath
extensionpath
proxystubpath
postmortempath
postmortemworkerpoolsink
postmortemcallstacksink
redirect
ethernetcard
communicator
Expand Down
2 changes: 2 additions & 0 deletions Tests/test_support/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ target_compile_definitions(${TARGET}
THREADPOOL_COUNT=${THREADPOOL_COUNT}
DEFAULT_SYSTEM_PATH="${SYSTEM_PATH}"
DEFAULT_PROXYSTUB_PATH="${PROXYSTUB_PATH}"
THUNDER_POSTMORTEM_WORKERPOOL_SINK_DEFAULT=0
THUNDER_POSTMORTEM_CALLSTACK_SINK_DEFAULT=3
)
Comment thread
SatheeshkumarG15 marked this conversation as resolved.

target_compile_options(${TARGET} PRIVATE -Wno-psabi)
Expand Down
2 changes: 2 additions & 0 deletions docs/introduction/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ This section documents the available options for Thunder. This is different from
| volatilepath | Directory to store volatile temporary data. <br /><br />Each plugin will have an associated directory underneath this corresponding to the callsign of the plugin | string | /tmp | /tmp/ |
| proxystubpath | Directory to search for the generated proxy stub libraries | string | - | /usr/lib/thunder/proxystubs |
| postmortempath | Directory to store debugging info (worker pool information, debug data) in the event of a plugin or server crash. <br /><br />If breakpad is found during build, will store breakpad mindumps here | string | /opt/minidumps | /opt/minidumps |
| postmortemworkerpoolsink | Controls where the WorkerPool JSON snapshot is written on crash. <br /><br />Allowed values: `FILE` (write ThunderInternals.json to `postmortempath`), `LOG` (emit via SYSLOG), `ALL` (both), `DISABLED` (skip) | string | FILE | FILE |
| postmortemcallstacksink | Controls where per-thread callstack output is written on crash. <br /><br />Allowed values: `FILE` (write ThunderInternals.txt to `postmortempath`), `LOG` (emit via SYSLOG), `ALL` (both), `DISABLED` (skip) | string | DISABLED | DISABLED |
Comment thread
SatheeshkumarG15 marked this conversation as resolved.
| communicator | Socket to listen for COM-RPC messages. Can be a filesystem path on Linux for a Unix domain socket, or a TCP socket. <br /><br />For unix sockets, the file permissions can be specified by adding a `|` followed by the numeric permissions | string | /tmp/communicator\|0777 | 127.0.0.1:4000 |
| redirect | Redirect incoming HTTP requests to the root Thunder URL to this address (please note it must contain the resource that is required e.g. index.html ) | string | http://127.0.0.1/Service/Controller/UI/index.html | http://127.0.0.1/Service/Controller/UI/index.html |
| idletime | Amount of time (in seconds) to wait before closing and cleaning up idle client connections. If no activity occurs over a connection for this time Thunder will close it. | integer | 180 | 180 |
Expand Down
Loading