BMC/OpenBmc/bmcweb.git/redfish-core/include/utils/dump_utils.hpp, branch master

Refactor remaining lambdas in dump utility

2026-09-09T15:12:57+00:00

Remove all remaining lambdas violating the lambda length rule. Tested: Code compiles. Validator was run on romulus in qemu with phosphor-debug-collector ibm extension enabled to get access to /xyz/openbmc_project/dump/system. Via the 'CreateDump' method empty dump entries were manually created for: /xyz/openbmc_project/dump/system /xyz/openbmc_project/dump/bmc /xyz/openbmc_project/dump/faultlog ``` busctl call xyz.openbmc_project.Dump.Manager /xyz/openbmc_project/dump/bmc \ xyz.openbmc_project.Dump.Create CreateDump a{sv} 0 > o "/xyz/openbmc_project/dump/bmc/entry/1" busctl tree xyz.openbmc_project.Dump.Manager `- /xyz `- /xyz/openbmc_project `- /xyz/openbmc_project/dump |- /xyz/openbmc_project/dump/bmc | `- /xyz/openbmc_project/dump/bmc/entry | `- /xyz/openbmc_project/dump/bmc/entry/1 |- /xyz/openbmc_project/dump/faultlog | `- /xyz/openbmc_project/dump/faultlog/entry | `- /xyz/openbmc_project/dump/faultlog/entry/1 |- /xyz/openbmc_project/dump/resource `- /xyz/openbmc_project/dump/system `- /xyz/openbmc_project/dump/system/entry `- /xyz/openbmc_project/dump/system/entry/1 ``` Overwrite OperationStatus of /xyz/openbmc_project/dump/system/entry/1 for the entry to be added to the collection: ``` busctl set-property xyz.openbmc_project.Dump.Manager \ /xyz/openbmc_project/dump/system/entry/1 \ xyz.openbmc_project.Common.Progress Status \ s xyz.openbmc_project.Common.Progress.OperationStatus.Completed \ ``` Systems/Dump Validating /redfish/v1/Systems/system/LogServices/Dump... - Pass: 14, Warn: 0, Fail: 0, Skip: 9 Validating /redfish/v1/Systems/system/LogServices/Dump/Entries... - Pass: 17, Warn: 0, Fail: 0, Skip: 30 Validating /redfish/v1/Systems/system/LogServices/Dump/Entries/1... - Pass: 10, Warn: 0, Fail: 0, Skip: 26 +--------------+--------------+--------------+--------------+ | PASS | WARN | FAIL | NOT TESTED | +--------------+--------------+--------------+--------------+ | 41 | 0 | 0 | 65 | +--------------+--------------+--------------+--------------+ Managers/Dump Validating /redfish/v1/Managers/bmc/LogServices/Dump... - Pass: 14, Warn: 0, Fail: 0, Skip: 9 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries... - Pass: 26, Warn: 0, Fail: 0, Skip: 58 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries/1... - Pass: 9, Warn: 0, Fail: 0, Skip: 27 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries/2... - Pass: 9, Warn: 0, Fail: 0, Skip: 27 +--------------+--------------+--------------+--------------+ | PASS | WARN | FAIL | NOT TESTED | +--------------+--------------+--------------+--------------+ | 58 | 0 | 0 | 121 | +--------------+--------------+--------------+--------------+ Managers/FaultLog Validating /redfish/v1/Managers/bmc/LogServices/FaultLog... - Pass: 12, Warn: 0, Fail: 0, Skip: 9 Validating /redfish/v1/Managers/bmc/LogServices/FaultLog/Entries... - Pass: 13, Warn: 0, Fail: 0, Skip: 34 Validating /redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/1... - Pass: 6, Warn: 0, Fail: 0, Skip: 30 +--------------+--------------+--------------+--------------+ | PASS | WARN | FAIL | NOT TESTED | +--------------+--------------+--------------+--------------+ | 31 | 0 | 0 | 73 | +--------------+--------------+--------------+--------------+ Change-Id: Iaac0b9b14b898b079765eb18f513aaea3c417740 Signed-off-by: Oliver Brewka

Inline dump util function

2026-09-07T15:19:59+00:00

It should be avoided using static for header only functions. Tested: Code compiles. Change-Id: Icb944588fc6f64c663960bf40da29e2de9e0b8bd Signed-off-by: Oliver Brewka

Fix createDump progress logic

2026-09-07T15:06:19+00:00

The current logic in createDump always sets the isProgressIntfPresent flag to true, even if it is not present at all. It breaks out of the search loop on the first interface that may not be xyz.openbmc_project.Common.Progress. This can cause a task to time out and not be handled properly since completion is only reported when the Progress interface a) exists and b) reports Status=Completed. Tested: Manually tested on romulus running in qemu with ibm dump extension enabled. POST request to Managers/Dump action ``` curl -v -k POST 'https://localhost:44443/redfish/v1/Managers/bmc/ LogServices/Dump/Actions/LogService.CollectDiagnosticData' \ -H 'X-Auth-Token: '"$BMCWEB_SESSION_TOKEN_ROML"'' \ -H "Content-Type: application/json" -d \ '{"DiagnosticDataType":"Manager", \ "OEMDiagnosticDataType":"Manager"}' { "@odata.id": "/redfish/v1/TaskService/Tasks/2", "@odata.type": "#Task.v1_4_3.Task", "HidePayload": false, "Id": "2", "Messages": [ { "@odata.type": "#Message.v1_1_1.Message", "Message": "The task with Id '2' has started.", "MessageArgs": [ "2" ], "MessageId": "TaskEvent.1.0.TaskStarted", "MessageSeverity": "OK", "Resolution": "None." } ], "Name": "Task 2", "Payload": { "HttpHeaders": [ "user-agent: curl/8.20.0", "accept: */*", "content-length: 66" ], "HttpOperation": "POST", "JsonBody": "{\"DiagnosticDataType\":\"Manager\",\"OEMDiagnosticDataType\":\"Manager\"}", "TargetUri": "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData" }, "PercentComplete": 0, "StartTime": "2026-09-07T15:10:26+00:00", "TaskMonitor": "/redfish/v1/TaskService/TaskMonitors/2", "TaskState": "Running", "TaskStatus": "OK" * Connection #1 to host localhost:44443 left intact } ``` dbus tree dump manager ``` busctl tree xyz.openbmc_project.Dump.Manager `- /xyz `- /xyz/openbmc_project `- /xyz/openbmc_project/dump |- /xyz/openbmc_project/dump/bmc | `- /xyz/openbmc_project/dump/bmc/entry | |- /xyz/openbmc_project/dump/bmc/entry/1 | |- /xyz/openbmc_project/dump/bmc/entry/2 | `- /xyz/openbmc_project/dump/bmc/entry/3 |- /xyz/openbmc_project/dump/faultlog |- /xyz/openbmc_project/dump/resource `- /xyz/openbmc_project/dump/system `- /xyz/openbmc_project/dump/system/entry |- /xyz/openbmc_project/dump/system/entry/1 `- /xyz/openbmc_project/dump/system/entry/2 ``` bmcweb debug log ``` Sep 07 15:11:02 romulus bmcweb[200]: [dump_utils.hpp:655] /xyz/openbmc_project/dump/bmc/entry/3: Dump creation task is in progress Sep 07 15:11:02 romulus bmcweb[200]: [dump_utils.hpp:655] /xyz/openbmc_project/dump/bmc/entry/3: Dump creation task is in progress Sep 07 15:11:02 romulus bmcweb[200]: [dump_utils.hpp:679] /xyz/openbmc_project/dump/bmc/entry/3: Dump creation task completed ``` Systems/Dump Set machine state to Quiesced ``` busctl set-property xyz.openbmc_project.State.Host0 \ /xyz/openbmc_project/state/host0 \ xyz.openbmc_project.State.Host CurrentHostState \ s "xyz.openbmc_project.State.Host.HostState.Quiesced" ``` POST request to Systems/Dump action ``` curl -v -k POST 'https://localhost:44443/redfish/v1/Systems/system/ LogServices/Dump/Actions/LogService.CollectDiagnosticData' \ -H 'X-Auth-Token: '"$BMCWEB_SESSION_TOKEN_ROML"'' \ -H "Content-Type: application/json" -d \ '{"DiagnosticDataType":"OEM", \ "OEMDiagnosticDataType":"Systems"}' { "@odata.id": "/redfish/v1/TaskService/Tasks/3", "@odata.type": "#Task.v1_4_3.Task", "HidePayload": false, "Id": "3", "Messages": [ { "@odata.type": "#Message.v1_1_1.Message", "Message": "The task with Id '3' has started.", "MessageArgs": [ "3" ], "MessageId": "TaskEvent.1.0.TaskStarted", "MessageSeverity": "OK", "Resolution": "None." } ], "Name": "Task 3", "Payload": { "HttpHeaders": [ "user-agent: curl/8.20.0", "accept: */*", "content-length: 61" ], "HttpOperation": "POST", "JsonBody": "{\"DiagnosticDataType\":\"OEM\",\"OEMDiagnosticDataType\":\"System\"}", "TargetUri": "/redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.CollectDiagnosticData" }, "PercentComplete": 0, "StartTime": "2026-09-07T15:14:53+00:00", "TaskMonitor": "/redfish/v1/TaskService/TaskMonitors/3", "TaskState": "Running", "TaskStatus": "OK" * Connection #1 to host localhost:44443 left intact } busctl tree xyz.openbmc_project.Dump.Manager `- /xyz `- /xyz/openbmc_project `- /xyz/openbmc_project/dump |- /xyz/openbmc_project/dump/bmc | `- /xyz/openbmc_project/dump/bmc/entry | |- /xyz/openbmc_project/dump/bmc/entry/1 | |- /xyz/openbmc_project/dump/bmc/entry/2 | |- /xyz/openbmc_project/dump/bmc/entry/3 | `- /xyz/openbmc_project/dump/bmc/entry/4 |- /xyz/openbmc_project/dump/faultlog |- /xyz/openbmc_project/dump/resource `- /xyz/openbmc_project/dump/system `- /xyz/openbmc_project/dump/system/entry |- /xyz/openbmc_project/dump/system/entry/1 |- /xyz/openbmc_project/dump/system/entry/2 `- /xyz/openbmc_project/dump/system/entry/3 ``` Set /xyz/openbmc_project/dump/system/entry/3 status to Completed ``` busctl set-property xyz.openbmc_project.Dump.Manager \ /xyz/openbmc_project/dump/system/entry/3 \ xyz.openbmc_project.Common.Progress Status \ s "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" journalctl -u bmcewb Sep 07 15:17:24 romulus bmcweb[200]: [dump_utils.hpp:679] /xyz/openbmc_project/dump/system/entry/3: Dump creation task completed ``` Change-Id: I8efc2588e31d9b838b6a4bf1d33f08b589ed5808 Signed-off-by: Oliver Brewka

Refactor createDump function

2026-09-07T12:20:55+00:00

The function as well as the task callback consisted of multiple lambdas that exceeded the lambda length rule. Extract each lambda into separate functions. Tested: Code compiles. Manually tested on romulus running in qemu with ibm dump extension enabled. POST Managers/bmc ``` curl -v -k POST 'https://localhost:44443/redfish/v1/Managers/bmc/ LogServices/Dump/Actions/LogService.CollectDiagnosticData' \ -H 'X-Auth-Token: '"$BMCWEB_SESSION_TOKEN_ROML"'' \ -H "Content-Type: application/json" -d \ '{"DiagnosticDataType":"Manager", \ "OEMDiagnosticDataType":"Manager"}' { "@odata.id": "/redfish/v1/TaskService/Tasks/0", "@odata.type": "#Task.v1_4_3.Task", "HidePayload": false, "Id": "0", "Messages": [ { "@odata.type": "#Message.v1_1_1.Message", "Message": "The task with Id '0' has started.", "MessageArgs": [ "0" ], "MessageId": "TaskEvent.1.0.TaskStarted", "MessageSeverity": "OK", "Resolution": "None." } ], "Name": "Task 0", "Payload": { "HttpHeaders": [ "user-agent: curl/8.20.0", "accept: */*", "content-length: 68" ], "HttpOperation": "POST", "JsonBody": "{\"DiagnosticDataType\":\"Manager\", \"OEMDiagnosticDataType\":\"Manager\"}", "TargetUri": "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/ LogService.CollectDiagnosticData" }, "PercentComplete": 0, "StartTime": "2026-09-01T03:39:42-07:00", "TaskMonitor": "/redfish/v1/TaskService/TaskMonitors/0", "TaskState": "Running", "TaskStatus": "OK" * Connection #1 to host localhost:4343 left intact } ``` bmcweb log output: ``` Sep 01 14:58:28 romulus bmcweb[200]: [dump_utils.hpp:720] Dump Created. Path: /xyz/openbmc_project/dump/bmc/entry/2 ... Sep 01 14:58:53 romulus bmcweb[200]: [dump_utils.hpp:564] /xyz/ openbmc_project/dump/bmc/entry/2: Dump creation task is in progress Sep 01 14:58:53 romulus bmcweb[200]: [dump_utils.hpp:564] /xyz/ openbmc_project/dump/bmc/entry/2: Dump creation task is in progress Sep 01 14:58:53 romulus bmcweb[200]: [dump_utils.hpp:588] /xyz/ openbmc_project/dump/bmc/entry/2: Dump creation task completed ``` dump/bmc tree after two POST request ``` busctl tree xyz.openbmc_project.Dump.Manager `- /xyz `- /xyz/openbmc_project `- /xyz/openbmc_project/dump |- /xyz/openbmc_project/dump/bmc | `- /xyz/openbmc_project/dump/bmc/entry | |- /xyz/openbmc_project/dump/bmc/entry/1 | |- /xyz/openbmc_project/dump/bmc/entry/2 |- /xyz/openbmc_project/dump/faultlog |- /xyz/openbmc_project/dump/resource `- /xyz/openbmc_project/dump/system ``` POST Systems/system CreateDump only works if the host is either in "Running", "Quiesced" or "TransitioningToOff" state. ``` busctl set-property xyz.openbmc_project.State.Host0 /xyz/openbmc_project/state/host0 \ xyz.openbmc_project.State.Host \ CurrentHostState \ s "xyz.openbmc_project.State.Host.HostState.Quiesced" ``` ``` curl -v -k POST 'https://localhost:44443/redfish/v1/Systems/system/ LogServices/Dump/Actions/LogService.CollectDiagnosticData' \ -H 'X-Auth-Token: '"$BMCWEB_SESSION_TOKEN_ROML"'' \ -H "Content-Type: application/json" -d \ '{"DiagnosticDataType":"OEM", "OEMDiagnosticDataType":"System"}' { "@odata.id": "/redfish/v1/TaskService/Tasks/2", "@odata.type": "#Task.v1_4_3.Task", "HidePayload": false, "Id": "2", "Messages": [ { "@odata.type": "#Message.v1_1_1.Message", "Message": "The task with Id '2' has started.", "MessageArgs": [ "2" ], "MessageId": "TaskEvent.1.0.TaskStarted", "MessageSeverity": "OK", "Resolution": "None." } ], "Name": "Task 2", "Payload": { "HttpHeaders": [ "user-agent: curl/8.20.0", "accept: */*", "content-length: 62" ], "HttpOperation": "POST", "JsonBody": "{\"DiagnosticDataType\":\"OEM\", \"OEMDiagnosticDataType\":\"System\"}", "TargetUri": "/redfish/v1/Systems/system/LogServices/Dump/Actions/ LogService.CollectDiagnosticData" }, "PercentComplete": 0, "StartTime": "2026-09-01T03:54:01-07:00", "TaskMonitor": "/redfish/v1/TaskService/TaskMonitors/2", "TaskState": "Running", "TaskStatus": "OK" * Connection #1 to host localhost:4343 left intact } ``` Set system dump entry to completed: ``` busctl set-property xyz.openbmc_project.Dump.Manager /xyz/ openbmc_project/dump/system/entry/1 \ xyz.openbmc_project.Common.Progress Status \ s "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" ``` bmcweb log output: ``` Sep 02 11:26:44 romulus bmcweb[200]: [dump_utils.hpp:804] Dump Created. Path: /xyz/openbmc_project/dump/system/entry/1 ... Sep 02 11:28:13 romulus bmcweb[200]: [dump_utils.hpp:672] /xyz/ openbmc_project/dump/system/entry/1: Dump creation task completed ``` busctl tree xyz.openbmc_project.Dump.Manager ``` `- /xyz `- /xyz/openbmc_project `- /xyz/openbmc_project/dump |- /xyz/openbmc_project/dump/bmc | `- /xyz/openbmc_project/dump/bmc/entry | |- /xyz/openbmc_project/dump/bmc/entry/1 | |- /xyz/openbmc_project/dump/bmc/entry/2 |- /xyz/openbmc_project/dump/faultlog |- /xyz/openbmc_project/dump/resource `- /xyz/openbmc_project/dump/system `- /xyz/openbmc_project/dump/system/entry `- /xyz/openbmc_project/dump/system/entry/1 ``` Change-Id: Id48b4643fcb634405b06db928e9a5c9d951f3ee4 Signed-off-by: Oliver Brewka

Fix unchecked optional value in dump createTask

2026-09-03T12:29:02+00:00

In order to silence clang-tidy, check payload value. Tested: Code compiles. clang-tidy runs through. Change-Id: Ib9db2552b0c9f8974728b8afe909a138d948b278 Signed-off-by: Oliver Brewka

Break out dump / faultlog log services

2026-09-03T12:25:00+00:00

Similar to how other log services got broken out into own header files, do the same for dump / faultlog. A new dump utility header has been created, request handler and route register function went into manager / systems log service header files respectively. Code logic stays untouched in this patch. Tested: Code compiles. Unit test runs through. Validator was run on romulus in qemu with phosphor-debug-collector ibm extension enabled to get access to /xyz/openbmc_project/dump/system. Via the 'CreateDump' method empty dump entries were manually created for: /xyz/openbmc_project/dump/system /xyz/openbmc_project/dump/bmc /xyz/openbmc_project/dump/faultlog ``` busctl call xyz.openbmc_project.Dump.Manager \ /xyz/openbmc_project/dump/bmc \ xyz.openbmc_project.Dump.Create \ CreateDump a{sv} 0 > o "/xyz/openbmc_project/dump/bmc/entry/1" busctl tree xyz.openbmc_project.Dump.Manager `- /xyz `- /xyz/openbmc_project `- /xyz/openbmc_project/dump |- /xyz/openbmc_project/dump/bmc | `- /xyz/openbmc_project/dump/bmc/entry | |- /xyz/openbmc_project/dump/bmc/entry/1 | |- /xyz/openbmc_project/dump/bmc/entry/2 | |- /xyz/openbmc_project/dump/bmc/entry/3 | |- /xyz/openbmc_project/dump/bmc/entry/4 | |- /xyz/openbmc_project/dump/bmc/entry/5 | `- /xyz/openbmc_project/dump/bmc/entry/6 |- /xyz/openbmc_project/dump/faultlog | `- /xyz/openbmc_project/dump/faultlog/entry | `- /xyz/openbmc_project/dump/faultlog/entry/1 |- /xyz/openbmc_project/dump/resource `- /xyz/openbmc_project/dump/system `- /xyz/openbmc_project/dump/system/entry `- /xyz/openbmc_project/dump/system/entry/1 ``` Overwrite OperationStatus of /xyz/openbmc_project/dump/system/entry/1 for the entry to be added to the collection: ``` busctl set-property xyz.openbmc_project.Dump.Manager \ /xyz/openbmc_project/dump/system/entry/1 \ xyz.openbmc_project.Common.Progress Status \ s xyz.openbmc_project.Common.Progress.OperationStatus.Completed \ ``` Systems/Dump Validating /redfish/v1/Systems/system/LogServices/Dump... - Pass: 14, Warn: 0, Fail: 0, Skip: 9 Validating /redfish/v1/Systems/system/LogServices/Dump/Entries... - Pass: 17, Warn: 0, Fail: 0, Skip: 30 Validating /redfish/v1/Systems/system/LogServices/Dump/Entries/1... - Pass: 10, Warn: 0, Fail: 0, Skip: 26 +--------------+--------------+--------------+--------------+ | PASS | WARN | FAIL | NOT TESTED | +--------------+--------------+--------------+--------------+ | 41 | 0 | 0 | 65 | +--------------+--------------+--------------+--------------+ Managers/Dump Validating /redfish/v1/Managers/bmc/LogServices/Dump... - Pass: 14, Warn: 0, Fail: 0, Skip: 9 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries... - Pass: 70, Warn: 0, Fail: 0, Skip: 162 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries/1... - Pass: 11, Warn: 0, Fail: 0, Skip: 25 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries/2... - Pass: 11, Warn: 0, Fail: 0, Skip: 25 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries/3... - Pass: 9, Warn: 0, Fail: 0, Skip: 27 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries/4... - Pass: 9, Warn: 0, Fail: 0, Skip: 27 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries/5... - Pass: 9, Warn: 0, Fail: 0, Skip: 27 Validating /redfish/v1/Managers/bmc/LogServices/Dump/Entries/6... - Pass: 9, Warn: 0, Fail: 0, Skip: 27 +--------------+--------------+--------------+--------------+ | PASS | WARN | FAIL | NOT TESTED | +--------------+--------------+--------------+--------------+ | 142 | 0 | 0 | 329 | +--------------+--------------+--------------+--------------+ Managers/FaultLog Validating /redfish/v1/Managers/bmc/LogServices/FaultLog... - Pass: 12, Warn: 0, Fail: 0, Skip: 9 Validating /redfish/v1/Managers/bmc/LogServices/FaultLog/Entries... - Pass: 13, Warn: 0, Fail: 0, Skip: 34 Validating /redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/1... - Pass: 6, Warn: 0, Fail: 0, Skip: 30 +--------------+--------------+--------------+--------------+ | PASS | WARN | FAIL | NOT TESTED | +--------------+--------------+--------------+--------------+ | 31 | 0 | 0 | 73 | +--------------+--------------+--------------+--------------+ Change-Id: I6379f877149c545b3b3bfcda8510c6ee1085dcf9 Signed-off-by: Oliver Brewka