Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-debug-collector / 9e905375839213e15e0ef47f1ee0e514cf2d1167
commit9e905375839213e15e0ef47f1ee0e514cf2d1167[log] [tgz]
authorDhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>Fri Aug 20 04:06:06 2021 -0500
committerDhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>Wed Jun 21 06:14:51 2023 -0500
tree67608d0177037c33a708ab2d15000b08e76229ef
parent64f8da9e70f821dcc29964ae90bc066aa169a178 [diff]
OpenPOWER: Add support for OpenPOWER dump policy

This commit introduces support for the system dump policy,
wherein 'system dump' refers to all OpenPOWER dumps.
This term encompasses all dumps from host subsystems on
OpenPOWER systems, which are collectively referred to
as system dumps. The currently supported policy is
'dump enable'. A dump will be created only if this
policy is enabled. If the policy is not enabled,
a 'dump disabled' error message will be returned.

In scenarios where the settings service is unavailable,
the system will default to considering the dump as enabled.

Tests:
- Create a dump with policy enabled
busctl --verbose call xyz.openbmc_project.Settings \
/xyz/openbmc_project/dump/system_dump_policy \
org.freedesktop.DBus.Properties \
Get ss "xyz.openbmc_project.Object.Enable" "Enabled"
MESSAGE "v" {
        VARIANT "b" {
                BOOLEAN true;
        };
};

busctl --verbose call xyz.openbmc_project.Dump.Manager \
/xyz/openbmc_project/dump/resource \
xyz.openbmc_project.Dump.Create CreateDump a{sv} 2 \
"com.ibm.Dump.Create.CreateParameters.VSPString" s \
"vsp" "com.ibm.Dump.Create.CreateParameters.Password" \
s "password"
MESSAGE "o" {
        OBJECT_PATH "/xyz/openbmc_project/dump/resource/entry/1";
};

Result: Dump created

- Create a dump with policy disabled
busctl --verbose call xyz.openbmc_project.Settings \
/xyz/openbmc_project/dump/system_dump_policy \
org.freedesktop.DBus.Properties Get ss \
"xyz.openbmc_project.Object.Enable" "Enabled"
MESSAGE "v" {
        VARIANT "b" {
                BOOLEAN false;
        };
};

busctl --verbose call xyz.openbmc_project.Dump.Manager \
/xyz/openbmc_project/dump/resource \
xyz.openbmc_project.Dump.Create CreateDump a{sv} 2 \
"com.ibm.Dump.Create.CreateParameters.VSPString" s "vsp" \
"com.ibm.Dump.Create.CreateParameters.Password" s "password"
Call failed: Dump is disabled on this system.

Result: Dump is not allowed

Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
Change-Id: I5dc609b1f4fd0f36df8520f8a75c18a4cd3d7c4c
3 files changed
tree: 67608d0177037c33a708ab2d15000b08e76229ef
  1. dump-extensions/
  2. host-transport-extensions/
  3. subprojects/
  4. test/
  5. tools/
  6. xyz/
  7. .clang-format
  8. .gitignore
  9. .shellcheck-ignore
  10. bmc_dump_entry.cpp
  11. bmc_dump_entry.hpp
  12. core_manager.cpp
  13. core_manager.hpp
  14. core_manager_main.cpp
  15. dump-extensions.hpp
  16. dump_entry.cpp
  17. dump_entry.hpp
  18. dump_internal.hpp
  19. dump_manager.cpp
  20. dump_manager.hpp
  21. dump_manager_bmc.cpp
  22. dump_manager_bmc.hpp
  23. dump_manager_faultlog.cpp
  24. dump_manager_faultlog.hpp
  25. dump_manager_main.cpp
  26. dump_offload.cpp
  27. dump_offload.hpp
  28. dump_serialize.cpp
  29. dump_serialize.hpp
  30. dump_utils.cpp
  31. dump_utils.hpp
  32. elog_watch.cpp
  33. elog_watch.hpp
  34. errors_map.mako.hpp
  35. errors_map_gen.py
  36. example_errors_watch.yaml
  37. faultlog_dump_entry.cpp
  38. faultlog_dump_entry.hpp
  39. ffdc
  40. host_transport_exts.hpp
  41. LICENSE
  42. meson.build
  43. meson_options.txt
  44. OWNERS
  45. ramoops_manager.cpp
  46. ramoops_manager.hpp
  47. ramoops_manager_main.cpp
  48. README.md
  49. watch.cpp
  50. watch.hpp
README.md

phosphor-debug-collector

Phosphor Debug Collector provides mechanisms to collect various log files and system parameters. Used to troubleshoot problems in OpenBMC based systems.

One such mechanism is dreport, a script that collects debug data and packages it into an archive file.

To Build

To build this package with meson, do the following steps:

    1. meson builddir
    2. ninja -C builddir

To clean the built files run ninja -C builddir clean.

To run unit tests

Tests can be run in the CI docker container, refer local-ci-build

or with an OpenBMC x86 sdk(see below for x86 steps).

meson -Dtests=enabled build
ninja -C build test