clang-format: re-format for clang-18

clang-format-18 isn't compatible with the clang-format-17 output, so we
need to reformat the code with the latest version. The way clang-18
handles lambda forma

clang-format: re-format for clang-18

clang-format-18 isn't compatible with the clang-format-17 output, so we
need to reformat the code with the latest version. The way clang-18
handles lambda formatting also changed, so we have made changes to the
organization default style format to better handle lambda formatting.

See I5e08687e696dd240402a2780158664b7113def0e for updated style.
See Iea0776aaa7edd483fa395e23de25ebf5a6288f71 for clang-18 enablement.

Change-Id: I748aeef75e2078199193cd98013dd2fe7f6b5db8
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

Add nlohmann-json Dependency for Serialization

Added the nlohmann-json dependency to the phosphor-dump-manager for
serialization purposes. This library will be used to handle JSON
serialization and

Add nlohmann-json Dependency for Serialization

Added the nlohmann-json dependency to the phosphor-dump-manager for
serialization purposes. This library will be used to handle JSON
serialization and deserialization of dump entry attributes.

Tests:
- Verified build process with the new dependency.

Change-Id: If3b58be7053741afcd8d39d8b09bb66fed31202c
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

host-transport-extensions: Replace deprecated libpldm header path

There are more OEMs than IBM contributing to libpldm, so the OEM headers
were restructured. Replace the deprecated IBM OEM header pa

host-transport-extensions: Replace deprecated libpldm header path

There are more OEMs than IBM contributing to libpldm, so the OEM headers
were restructured. Replace the deprecated IBM OEM header path with the
namespaced path.

The patch was generated by with the coccinelle[1] script from [2]:

```
$ spatch \
--sp-file .../libpldm/origin/evolutions/current/oem-ibm-header-compat.cocci \
--in-place \
$(git ls-files | grep -E '\.[ch](pp)?')
```

[1]: https://coccinelle.gitlabpages.inria.fr/website/
[2]: https://gerrit.openbmc.org/c/openbmc/libpldm/+/72202

Change-Id: I60f2fb09f1f680e21522f2d3f9d9fa8ecc115bfe
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

Add Serialization Support for Dump Entry Attributes

Implemented serialization of dump entry attributes using the
nlohmann::json library. Added serialization support in the Dump Entry
class, serializ

Add Serialization Support for Dump Entry Attributes

Implemented serialization of dump entry attributes using the
nlohmann::json library. Added serialization support in the Dump Entry
class, serializing attributes including originatorId, originatorType,
and startTime. These attributes are not part of the dump filename and
thus require serialization to ensure their state is preserved.

Deserialization will occur only if the serialization version matches
and the dump ID in the dump object matches the ID in the
serialized file.

Tests:
- Created BMC dumps and restarted service
- Created BMC dumps and restarted BMC
- Created 200 BMC dumps and restarted service and BMC multiple times

File:
```
{"dumpId":2,"originatorId":"","originatorType":1,"startTime":1718199238942411,"version":1}
```

Change-Id: I16ecb058bddd464c8771bd8d08a50ea1877747ed
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

dreport: Adding redundant FW info in BMC dumps

To support additional information, the non booting FW
info is added in a separate file along with active/booting
FW in the os-release file for all the

dreport: Adding redundant FW info in BMC dumps

To support additional information, the non booting FW
info is added in a separate file along with active/booting
FW in the os-release file for all the BMC dumps.

This commit includes the changes to add the redundant or
backup FW version name (if present), in a separate file
named redundant-os-release file for all the BMC dumps.

Test Results:

cat BMCDUMP.13BE960.0000053.20240510180023/redundant-os-release

REDUNDANT_FW="fw1060.00-16-1060.2420.20240508a (NL1060_042)"

Signed-off-by: Swarnendu Roy Chowdhury <swarnendu.roy.chowdhury@ibm.com>
Change-Id: Ie74df4b0371db749908b3cefc6cab6e89df442db

show more ...

OpenPOWER: Replace Password with UserChallenge

This commit replaces the 'Password' field with 'UserChallenge' in the
Resource dump implementation of xyz.openbmc_project.Dump.Entry.Resource
interface

OpenPOWER: Replace Password with UserChallenge

This commit replaces the 'Password' field with 'UserChallenge' in the
Resource dump implementation of xyz.openbmc_project.Dump.Entry.Resource
interface.

The 'UserChallenge' is used to verify user authorization against an
Access Control List provided through PLDM. This ensures that dump
requests are processed only if the user-challenge is validated
successfully.

Test:
Successfully built with p10bmc

Change-Id: I1896c4645d1329e47556b8d75fff8cb6aae45945
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

meson: Fix meson.build_root warning

Currently local build outputs warning messages:
"""
WARNING: Project targets '>=1.1.1' but uses feature deprecated since
'0.56.0': meson.build_root. use meson.pro

meson: Fix meson.build_root warning

Currently local build outputs warning messages:
"""
WARNING: Project targets '>=1.1.1' but uses feature deprecated since
'0.56.0': meson.build_root. use meson.project_build_root() or
meson.global_build_root() instead.
"""
Replace all the "meson.build_root()" to "meson.project_build_root()" to
fix the issue.

Change-Id: Iab5e33df185eaf9a37bf1c610d2f82e9253f7205
Signed-off-by: Konstantin Aladyshev <aladyshev22@gmail.com>

show more ...

meson: Fix local cereal build

Currently local build is failing with a message:
"""
cereal| Exception: Failed to configure the CMake subproject: Could NOT
find Boost (missing: Boost_INCLUDE_DIR seria

meson: Fix local cereal build

Currently local build is failing with a message:
"""
cereal| Exception: Failed to configure the CMake subproject: Could NOT
find Boost (missing: Boost_INCLUDE_DIR serialization)
Subproject subprojects/cereal is buildable: NO (disabling)
"""
Since cereal requires boost only for the sandbox build and this
functionality is not needed, add option to skip building performance
sandbox comparison to solve the issue.

Tested:
"meson setup build" no longer fails with the cereal error.

Change-Id: I6fb89685223e045faf9baceffa6a89c985ab7960
Signed-off-by: Konstantin Aladyshev <aladyshev22@gmail.com>

show more ...

dreport: Added support to collect LDAP config data

LDAP related detailed data will be collected as part of BMC user
initiated Dump.
This commit will add 2 new file:
1. usrmgrldap.log (size: 3.1K)
2.

dreport: Added support to collect LDAP config data

LDAP related detailed data will be collected as part of BMC user
initiated Dump.
This commit will add 2 new file:
1. usrmgrldap.log (size: 3.1K)
2. nslcd.conf (size: 526B)

Tested By:
Tested by collecting BMC dump.

Change-Id: I09e35379935838c6f06d8604303f16a1febc8d3a
Signed-off-by: nitinkotania <gitnkotania@gmail.com>

show more ...

meson: fix missing dependencies

Building in subproject wrap mode reveals missing dependencies.
Add them as necessary.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I883df9770661f3a

meson: fix missing dependencies

Building in subproject wrap mode reveals missing dependencies.
Add them as necessary.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I883df9770661f3a859a5eb9d16cdd022227cd324

show more ...

pldm_oem_cmds: fix compile fail

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I5730c247fe7d83d2dcef29eb3429971f1d847b87

lg2: use direct enum conversion

lg2 now allows logging an enum directly without extra casting. Remove
the `underlying_cast` to simplify the code.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz

lg2: use direct enum conversion

lg2 now allows logging an enum directly without extra casting. Remove
the `underlying_cast` to simplify the code.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I3415be5f7e9be2302c870b5499f96cda3545d0fa

show more ...

owners: updated Jayanth email

Change-Id: I4eb21f20438431134cd3ef2f297e3ce7153adb45
Signed-off-by: Jayanth Othayoth <ojayanth@gmail.com>

build: use allowed over enabled

Meson feature options are typically in a tri-state of enabled, disabled,
or auto. The enabled and disabled functions on an option (from
`get_option`) no longer retur

build: use allowed over enabled

Meson feature options are typically in a tri-state of enabled, disabled,
or auto. The enabled and disabled functions on an option (from
`get_option`) no longer return true for auto features. Instead, the
expectation is to use `allowed()` which is true for both enabled and auto.

Switch all uses of `enabled` to `allowed`.

Change-Id: I8671a81c57e5032c776691d30a941c19b1d53e9d
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

ramoops: generate error log when ramoops detected

A ramoops being detected is a critical event for a BMC based system. It
indicates the BMC had an unexpected reboot because of a kernel panic.
Ensure

ramoops: generate error log when ramoops detected

A ramoops being detected is a critical event for a BMC based system. It
indicates the BMC had an unexpected reboot because of a kernel panic.
Ensure a log is reported so the user of the system knows to look for a
BMC dump with the debug information.

Tested:
- Manually created some files in /var/lib/systemd/pstore/ and ran the
ramoops application and verified the expected log was created.

Change-Id: Id1162fa0cca72e5dcc8cf59e75bd298d2ddada2e
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

clang-format: copy latest and re-format

clang-format-17 has some backwards incompatible changes that require
additional settings for best compatibility and re-running the formatter.
Copy the latest

clang-format: copy latest and re-format

clang-format-17 has some backwards incompatible changes that require
additional settings for best compatibility and re-running the formatter.
Copy the latest .clang-format from the docs repository and reformat the
repository.

Change-Id: I04f38c33863fd3e2c9c6e9e20efc14105b79aedd
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

Fix compiler warning

Fix the following warning, as any warning will be treated as error
../../../dump_utils.hpp:38:9: warning: Value stored to 'event' is never read

event = sd_event_unref(event);

Fix compiler warning

Fix the following warning, as any warning will be treated as error
../../../dump_utils.hpp:38:9: warning: Value stored to 'event' is never read

event = sd_event_unref(event);

Change-Id: I020c2b2028e19ce8998754a38cb55830792a0118
Signed-off-by: Deepa Karthikeyan <deepakala.karthikeyan@ibm.com>

show more ...

Remove internal dump create interface

The createDump method was revised to support key-value parameters,
allowing flexible dump type specification. This change negates the need
for the internal crea

Remove internal dump create interface

The createDump method was revised to support key-value parameters,
allowing flexible dump type specification. This change negates the need
for the internal create interface, exclusive to the
phosphor-debug-collector repository.

This commit removes all instances of the internal create method,
replacing them with the updated createDump method. The modified
createDump approach ensures a consistent dump initiation procedure
and enables all applications to request various dump types.

Manual Tests:
- Validate the creation of a user-requested BMC dump.
- Validate the creation of a dump due to an InternalFailure.
- Generate a core dump to validate the corresponding BMC dump creation.
- Ensure that system-generated dumps are allowed when user-requested
dump is in progress.
- Ensure simultaneous user requested dumps are prevented

Checkstop dump
busctl call xyz.openbmc_project.Logging /xyz/openbmc_project/logging \
xyz.openbmc_project.Logging.Create Create ssa{ss} \
org.open_power.Host.Boot.Error.Checkstop \
xyz.openbmc_project.Logging.Entry.Level.Error 0

Logs:
Initiating new BMC dump with type: checkstop path: /xyz/openbmc_\
project/logging/entry/78
performing dump compression /tmp/BMCDUMP.XX.0000003.20230724015349
Report is available in /var/lib/phosphor-debug-collector/dumps/3

Automated tests:
Create_And_Delete_User_Initiated_BMC_Dump_Multiple_Times
Create_Two_User_Initiated_BMC_Dumps
Create_Two_User_Initiated_BMC_Dumps_And_Delete_One
Delete_All_User_Initiated_BMC_Dumps_And_Verify
Delete_User_Initiated_BMC_Dump_And_Verify
Verify_BMC_Core_Dump_When_Host_Powered_Off
Verify_BMC_Dump_Create_Errors_While_Another_BMC_Dump_In_Progress
Verify_BMC_Dump_Default_Location_In_BMC
Verify_Core_Dump_Size
Verify_Core_Watchdog_Initiated_BMC_Dump
Verify_Dump_Persistency_On_BMC_Reset
Verify_Dump_Persistency_On_Dump_Service_Restart
Verify_Error_Log_And_Dump_For_Internal_Failure
Verify_Error_Response_For_Already_Deleted_Dump_Id
Verify_Error_While_Initiating_BMC_Dump_During_Dumping_State
Verify_Internal_Failure_Initiated_BMC_Dump_Size
Verify_Multiple_BMC_Dump_Creation
Verify_User_Initiated_BMC_Dump_At_Host_Booting
Verify_User_Initiated_BMC_Dump_Size
Verify_User_Initiated_BMC_Dump_When_Host_Booted
Verify_User_Initiated_BMC_Dump_When_Host_Powered_Off

Built with master and p10bmc

Change-Id: I9f91375788201e2badf51d87f8117154a8e1ed8a
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Add elog dump type to common create

This commit modifies the Elog BMC dump creation process to utilize the
common BMC dump creation interface. Elog BMC dumps are a special type
of dumps triggered up

Add elog dump type to common create

This commit modifies the Elog BMC dump creation process to utilize the
common BMC dump creation interface. Elog BMC dumps are a special type
of dumps triggered upon the logging of certain predefined set of error
logs. These dumps incorporate data based on the type of the error log.
In the existing process, upon occurrence of a predefined error log, the
error log watch function would inform the dump manager via an internal
DBus interface. Now, with this change, the error log watch function will
request the dump manager to create an Elog BMC dump that includes the
relevant error data, error type, and the object path of the error log
entry via the common create DBus interface.

Test:
Create an InternalFailure and make sure dump is created
>busctl call xyz.openbmc_project.Logging \
/xyz/openbmc_project/logging \
xyz.openbmc_project.Logging.Create Create ssa{ss} \
xyz.openbmc_project.Common.Error.InternalFailure \
xyz.openbmc_project.Logging.Entry.Level.Error 0

Trace:
phosphor-dump-manager[542]: Initiating new BMC dump \
with type: elog path: /xyz/openbmc_project/logging/entry/12

phosphor-dump-manager[2918]: Report is available in \
/var/lib/phosphor-debug-collector/dumps/6

Tested checkstop dump

Built with master and p10bmc

Change-Id: I734b052fc24e7893a61755790be49e8a1e594be5
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Generate error map as part of dump types

An error type is a specific type of BMC dump that is generated
when a particular error is logged in the BMC. Previously,
dump types and error types were mana

Generate error map as part of dump types

An error type is a specific type of BMC dump that is generated
when a particular error is logged in the BMC. Previously,
dump types and error types were managed independently, with
error types being defined in separate files, namely 'error_map.hpp'
and its associated mako template 'error_map.mako.cpp'. However, this
practice led to inconsistencies, as the dreport script, which is used
for handling dump collection and packaging, was interpreting error
type as another dump type rather than as additional parameters.

The separate error_map.hpp file and its associated mako template
(error_map.mako.cpp) have been removed. Instead, error types are now
incorporated directly into the dump types along with an error type map
for validating the error names. This integration aligns the code with
the existing behaviour of the dreport script, allowing for more
consistent processing of dump types

As a result of this integration, the error map generation is now part
of the dump_types_mako.cpp file. To support these changes, a second
input YAML file has been added to the map_gen.py script to generate
the dump types and error types together.

Tests:
Create InternalFailure
> busctl call xyz.openbmc_project.Logging /xyz/openbmc_project/logging \
xyz.openbmc_project.Logging.Create Create ssa{ss} \
xyz.openbmc_project.Common.Error.InternalFailure \
xyz.openbmc_project.Logging.Entry.Level.Error 0
> dump created
/var/lib/phosphor-debug-collector/dumps/1/\
BMCDUMP.XXXXXXXX.0000001.20230723084043

Create Checkstop
> busctl call xyz.openbmc_project.Logging /xyz/openbmc_project/logging \
xyz.openbmc_project.Logging.Create Create ssa{ss} \
org.open_power.Host.Boot.Error.Checkstop \
xyz.openbmc_project.Logging.Entry.Level.Error 0
> /var/lib/phosphor-debug-collector/dumps/4/\
BMCDUMP.XXXXXXXX.0000004.20230723094150

Change-Id: Iac483f4993b59cf0fc063ed9584785f1a1fa04a8
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Generate dump types table

This commit refines the map generation process in
phosphor-debug-collector. The existing Python script is enhanced to
accept varying templates and variable names, A new Mak

Generate dump types table

This commit refines the map generation process in
phosphor-debug-collector. The existing Python script is enhanced to
accept varying templates and variable names, A new Mako template is
introduced for generating dump types. This enhancement allows different
architectures to support various types of dumps without requiring major
changes.

Tests:
Successfully tested the creation of different types of
BMC dumps.

Built with master and p10bmc

Change-Id: I347e218cb66386665bd15b72612dbe8e1e4fc7cf
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

meson_options.txt: Support for reading options from meson.options

Support has been added for reading options from meson.options instead
of meson_options.txt[1]. These are equivalent, but not using t

meson_options.txt: Support for reading options from meson.options

Support has been added for reading options from meson.options instead
of meson_options.txt[1]. These are equivalent, but not using the .txt
extension for a build file has a few advantages, chief among them
many tools and text editors expect a file with the .txt extension to
be plain text files, not build scripts.

[1] https://mesonbuild.com/Release-notes-for-1-1-0.html#support-for-reading-options-from-mesonoptions

Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: I5a3c4f0f468cd7bb3767350c24b5dc8e47987bd9

show more ...

Correct the timing of emit_object_added

The deletion of the dump objects emits InterfacesRemoved signal, but the
interfaces removed in the signal does not contain the interfaces defined
in the base

Correct the timing of emit_object_added

The deletion of the dump objects emits InterfacesRemoved signal, but the
interfaces removed in the signal does not contain the interfaces defined
in the base class phosphor::dump::Entry:
```
xyz.openbmc_project.Common.OriginatedBy
xyz.openbmc_project.Common.Progress
xyz.openbmc_project.Dump.Entry
xyz.openbmc_project.Object.Delete
xyz.openbmc_project.Time.EpochTime
```

This results in the mapper still keeping the objects even if the object
is removed from DBus, and it becomes inconsistent between the DBus
objects and mapper.

Adjust the inheritance sequence, so that in destruction,
emit_object_removed() is called when all the interfaces are there, so
that all the interfaces could be included in the signal.

Without this change, the destructor sequence is (Taking BMCEntry as
example):
1. phosphor::dump::Entry is destructed, no signal is emitted;
2. phosphor::dump::bmc::EntryIfaces is destructed, signal is emitted,
but at this time, only the interfaces implemented by
phosphor::dump::bmc::EntryIfaces is included, which is the root cause of
the problem.

With the change, the destructor sequence is:
1. phosphor::dump::bmc::EntryIfaces is destructed, signal is emitted,
and all the interfaces are included in the signal;
2. phosphor::dump::Entry is destructed, no signal is emitted.

So all the interfaces implemented by BMCEntry is included in the
InterfacesRemoved signal, and thus the issue is fixed.

Tested: Before this change:
1. Create a dump, say /xyz/openbmc_project/dump/bmc/entry/2
2. Delete it
3. Mapper still list the above object although it does not
really exist.
With this fix, verify the above issue is fixed.

Signed-off-by: Lei YU <yulei.sh@bytedance.com>
Change-Id: I76710fa9b8d23344cf979bd8f3bdcc331e663264

show more ...

Add Ramoops dump to common create

This commit adjusts the handling of ramoops (RAM OOPS) dumps to use
the common BMC dump creation interface. Previously, when a ramoops
dump was detected, the ramoop

Add Ramoops dump to common create

This commit adjusts the handling of ramoops (RAM OOPS) dumps to use
the common BMC dump creation interface. Previously, when a ramoops
dump was detected, the ramoops manager would inform the dump manager
via an internal D-Bus interface. With the changes in this commit,
upon detecting a ramoops event, the ramoops manager will now request
the dump manager to create a BMC dump, incorporating the relevant
ramoops data, via the common create DBus interface.

Tested:
Create a Ramoops dump
busctl --verbose call xyz.openbmc_project.Dump.Manager \
/xyz/openbmc_project/dump/bmc xyz.openbmc_project.Dump.Create \
CreateDump a{sv} 2 "xyz.openbmc_project.Dump.Create.CreateParameters.\
DumpType" s "xyz.openbmc_project.Dump.Create.DumpType.Ramoops" \
"xyz.openbmc_project.Dump.Create.CreateParameters.FilePath" \
s "/tmp/ramoops"
MESSAGE "o" {
OBJECT_PATH "/xyz/openbmc_project/dump/bmc/entry/4";
};

> Initiating new BMC dump with type: ramoops path: /tmp/ramoops

Change-Id: I0437cfa6c63fe261ca9b51f6a90c8183abacd5c7
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...

Add support core dump in common create

This commit modifies the interaction between the core dump monitor and
the BMC dump manager. Earlier, when a process managed by systemd
crashed, it generated a

Add support core dump in common create

This commit modifies the interaction between the core dump monitor and
the BMC dump manager. Earlier, when a process managed by systemd
crashed, it generated a core dump. The core dump monitor would then
inform the dump manager about this event through a dedicated internal
D-Bus interface.

With this commit, we change this approach and leverage the common BMC
dump creation interface. Now, when a core dump is generated, the core
dump monitor requests the dump manager to create a specific BMC dump
that incorporates this core dump data.

Tests:
Create a core dump and make sure BMC dump with core
is created

>kill -3 2232
Trace:
phosphor-dump-manager[542]: Initiating new BMC dump with \
type: core path: /var/lib/systemd/coredump/core.openpower\
-occ-c.0.0b16f513a5bc43f98ea11ed525f1a0c5.2232.16889058660\
00000.zst

Built with master and p10bmc

phosphor-dump-manager[2738]: Report is available in /var/\
lib/phosphor-debug-collector/dumps/5

Change-Id: Ic2cc723babccb0f8d36504992996bcf418db8463
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>

show more ...