diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 11:32:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 11:32:39 +0000 |
commit | 56ae875861ab260b80a030f50c4aff9f9dc8fff0 (patch) | |
tree | 531412110fc901a5918c7f7442202804a83cada9 /tools/debug | |
parent | Initial commit. (diff) | |
download | icinga2-upstream.tar.xz icinga2-upstream.zip |
Adding upstream version 2.14.2.upstream/2.14.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'tools/debug')
-rw-r--r-- | tools/debug/gdb/.gitignore | 1 | ||||
-rw-r--r-- | tools/debug/gdb/README.md | 40 | ||||
-rw-r--r-- | tools/debug/gdb/gdbinit | 25 | ||||
-rw-r--r-- | tools/debug/gdb/icingadbg.py | 64 | ||||
-rw-r--r-- | tools/debug/natvis/Visualizers/icinga2.natstepfilter | 9 | ||||
-rw-r--r-- | tools/debug/natvis/Visualizers/icinga2.natvis | 32 | ||||
-rw-r--r-- | tools/debug/natvis/[Content_Types].xml | 1 | ||||
-rw-r--r-- | tools/debug/natvis/extension.vsixmanifest | 18 |
8 files changed, 190 insertions, 0 deletions
diff --git a/tools/debug/gdb/.gitignore b/tools/debug/gdb/.gitignore new file mode 100644 index 0000000..1c9c744 --- /dev/null +++ b/tools/debug/gdb/.gitignore @@ -0,0 +1 @@ +icingadbg.pyc diff --git a/tools/debug/gdb/README.md b/tools/debug/gdb/README.md new file mode 100644 index 0000000..b00f81a --- /dev/null +++ b/tools/debug/gdb/README.md @@ -0,0 +1,40 @@ +# Pretty Printer Installation + +Requirements: +* icinga2 debug symbols +* boost, gcc, etc debug symbols + +Install the `boost`, `python` and `icinga2` pretty printers. Absolute paths are required, +so please make sure to update the installation paths accordingly (`pwd`). + +Boost Pretty Printers: + + $ mkdir ~/.gdb_printers && cd ~/.gdb_printers + $ git clone https://github.com/ruediger/Boost-Pretty-Printer.git && cd Boost-Pretty-Printer + $ pwd + /home/michi/.gdb_printers/Boost-Pretty-Printer + +Python Pretty Printers: + + $ cd ~/.gdb_printers + $ svn co svn://gcc.gnu.org/svn/gcc/trunk/libstdc++-v3/python + +Icinga 2 Pretty Printers: + + $ mkdir -p ~/.gdb_printers/icinga2 && ~/.gdb_printers/icinga2 + $ wget https://raw.githubusercontent.com/Icinga/icinga2/master/tools/debug/gdb/icingadbg.py + +Now you'll need to modify/setup your `~/.gdbinit` configuration file. +You can download the one from Icinga 2 and modify all paths. + +> **Note** +> +> The path to the `pthread` library varies on distributions. Use +> `find /usr/lib* -type f -name '*libpthread.so*'` to get the proper +> path. + + $ wget https://raw.githubusercontent.com/Icinga/icinga2/master/tools/debug/gdb/gdbinit -O ~/.gdbinit + $ vim ~/.gdbinit + + +More details in the [troubleshooting debug documentation](https://docs.icinga.com/icinga2/latest/doc/module/icinga2/chapter/troubleshooting#debug). diff --git a/tools/debug/gdb/gdbinit b/tools/debug/gdb/gdbinit new file mode 100644 index 0000000..a7e6b87 --- /dev/null +++ b/tools/debug/gdb/gdbinit @@ -0,0 +1,25 @@ +set print pretty on + +python +import sys +sys.path.insert(0, '/home/gbeutner/icinga2/tools/debug/gdb') +from icingadbg import register_icinga_printers +register_icinga_printers() +end + +python +import sys +sys.path.insert(0, '/home/gbeutner/gdb_printers/python') +from libstdcxx.v6.printers import register_libstdcxx_printers +try: + register_libstdcxx_printers(None) +except: + pass +end + +python +import sys +sys.path.insert(0, '/home/gbeutner/Boost-Pretty-Printer') +from boost.printers import register_printer_gen +register_printer_gen(None) +end diff --git a/tools/debug/gdb/icingadbg.py b/tools/debug/gdb/icingadbg.py new file mode 100644 index 0000000..d1e1c59 --- /dev/null +++ b/tools/debug/gdb/icingadbg.py @@ -0,0 +1,64 @@ +import gdb +import re + +class IcingaStringPrinter: + def __init__(self, val): + self.val = val + + def to_string(self): + return '"' + self.val['m_Data']['_M_dataplus']['_M_p'].string() + '"' + +class IcingaValuePrinter: + def __init__(self, val): + self.val = val + + def to_string(self): + which = self.val['m_Value']['which_'] + + if which == 0: + return 'Empty' + elif which == 1: + return self.val['m_Value']['storage_']['data_']['buf'].cast(gdb.lookup_type('double').pointer()).dereference() + elif which == 2: + return self.val['m_Value']['storage_']['data_']['buf'].cast(gdb.lookup_type('bool').pointer()).dereference() + elif which == 3: + return self.val['m_Value']['storage_']['data_']['buf'].cast(gdb.lookup_type('icinga::String').pointer()).dereference() + elif which == 4: + return self.val['m_Value']['storage_']['data_']['buf'].cast(gdb.lookup_type('icinga::Object').pointer()).dereference() + else: + return '<INVALID>' + +class IcingaSignalPrinter: + def __init__(self, val): + self.val = val + + def to_string(self): + return '<SIGNAL>' + +class IcingaMutexPrinter: + def __init__(self, val): + self.val = val + + def to_string(self): + owner = self.val['__data']['__owner'] + + if owner == 0: + return '<unlocked>' + else: + return '<locked by #' + str(owner) + '>' + +def lookup_icinga_type(val): + t = val.type.unqualified() + if str(t) == 'icinga::String': + return IcingaStringPrinter(val) + elif str(t) == 'icinga::Value': + return IcingaValuePrinter(val) + elif re.match('^boost::signals2::signal.*<.*>$', str(t)): + return IcingaSignalPrinter(val) + elif str(t) == 'pthread_mutex_t': + return IcingaMutexPrinter(val) + + return None + +def register_icinga_printers(): + gdb.pretty_printers.append(lookup_icinga_type) diff --git a/tools/debug/natvis/Visualizers/icinga2.natstepfilter b/tools/debug/natvis/Visualizers/icinga2.natstepfilter new file mode 100644 index 0000000..f53f002 --- /dev/null +++ b/tools/debug/natvis/Visualizers/icinga2.natstepfilter @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="utf-8"?> +<StepFilter xmlns="http://schemas.microsoft.com/vstudio/debugger/natstepfilter/2010"> + <Function><Name>icinga::String::.*</Name><Action>NoStepInto</Action></Function> + <Function><Name>icinga::Value::.*</Name><Action>NoStepInto</Action></Function> + <Function><Name>icinga::Array::.*</Name><Action>NoStepInto</Action></Function> + <Function><Name>icinga::Dictionary::.*</Name><Action>NoStepInto</Action></Function> + <Function><Name>icinga::Object::.*</Name><Action>NoStepInto</Action></Function> + <Function><Name>icinga::ObjectImpl<.*</Name><Action>NoStepInto</Action></Function> +</StepFilter> diff --git a/tools/debug/natvis/Visualizers/icinga2.natvis b/tools/debug/natvis/Visualizers/icinga2.natvis new file mode 100644 index 0000000..0ec4b78 --- /dev/null +++ b/tools/debug/natvis/Visualizers/icinga2.natvis @@ -0,0 +1,32 @@ +<?xml version='1.0' encoding='utf-8'?> +<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010"> + <Type Name="icinga::String"> + <DisplayString>{m_Data}</DisplayString> + </Type> + + <Type Name="icinga::Value"> + <DisplayString Condition="m_Value.which_ == 0">Empty</DisplayString> + <DisplayString Condition="m_Value.which_ == 1">{*(double *)m_Value.storage_.data_.buf}</DisplayString> + <DisplayString Condition="m_Value.which_ == 2">{*(double *)m_Value.storage_.data_.buf}</DisplayString> + <DisplayString Condition="m_Value.which_ == 3">{*(icinga::String *)m_Value.storage_.data_.buf}</DisplayString> + <DisplayString Condition="m_Value.which_ == 4">{*(boost::intrusive_ptr<icinga::Object> *)m_Value.storage_.data_.buf}</DisplayString> + </Type> + + <Type Name="icinga::Array"> + <DisplayString>{m_Data}</DisplayString> + <Expand> + <ExpandedItem>m_Data</ExpandedItem> + </Expand> + </Type> + + <Type Name="icinga::Dictionary"> + <DisplayString>{m_Data}</DisplayString> + <Expand> + <ExpandedItem>m_Data</ExpandedItem> + </Expand> + </Type> + + <Type Name="icinga::ObjectLock"> + <DisplayString>{m_Lock}</DisplayString> + </Type> +</AutoVisualizer> diff --git a/tools/debug/natvis/[Content_Types].xml b/tools/debug/natvis/[Content_Types].xml new file mode 100644 index 0000000..b1c9cf9 --- /dev/null +++ b/tools/debug/natvis/[Content_Types].xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types"><Default Extension="vsixmanifest" ContentType="text/xml" /><Default Extension="natstepfilter" ContentType="application/octet-stream" /><Default Extension="natvis" ContentType="application/octet-stream" /></Types>
\ No newline at end of file diff --git a/tools/debug/natvis/extension.vsixmanifest b/tools/debug/natvis/extension.vsixmanifest new file mode 100644 index 0000000..d870e89 --- /dev/null +++ b/tools/debug/natvis/extension.vsixmanifest @@ -0,0 +1,18 @@ +<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011"> + <Metadata> + <Identity Id="Icinga2Visualizers.VS2013.D1DFF2F5-FB30-41FE-8EEF-0CEB97ABBC6B" Version="2.0.0" Language="en-US" Publisher="Icinga GmbH" /> + <DisplayName>Icinga 2 Debugger Visualizers for Visual Studio</DisplayName> + <Description xml:space="preserve">Icinga 2 Debugger Visualizers</Description> + </Metadata> + <Installation> + <InstallationTarget Version="[12.0,13.0)" Id="Microsoft.VisualStudio.Premium" /> + <InstallationTarget Version="[12.0,13.0)" Id="Microsoft.VisualStudio.Pro" /> + <InstallationTarget Version="[12.0,13.0)" Id="Microsoft.VisualStudio.Ultimate" /> + <InstallationTarget Version="[12.0,13.0)" Id="Microsoft.VisualStudio.VSWinDesktopExpress" /> + </Installation> + <Dependencies></Dependencies> + <Assets> + <Asset Type="NativeVisualizer" Path="Visualizers\icinga2.natvis" /> + <Asset Type="StepFilter" Path="Visualizers\icinga2.natstepfilter" /> + </Assets> +</PackageManifest> |