Generate heartbeat registry

Generate the heartbeat registry, and adjust the #includes of the
other generated registries.

Tested: Redfish service validator succeeds.

Change-Id: Iedbf1ae8dc655966669

Generate heartbeat registry

Generate the heartbeat registry, and adjust the #includes of the
other generated registries.

Tested: Redfish service validator succeeds.

Change-Id: Iedbf1ae8dc6559666691f1feb71af08e856d5c80
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Generate resource event

Generate Resource event registry

Tested: On last patch of series. No behavior changes.

Change-Id: I924919db0e7fbde8ed698de6b59b86f788de9708
Signed-off-by: Ed Tanous <etano

Generate resource event

Generate Resource event registry

Tested: On last patch of series. No behavior changes.

Change-Id: I924919db0e7fbde8ed698de6b59b86f788de9708
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Generate task event

Generate the task event registry.

Tested: on last patch of series

Change-Id: I55b7914978f7a1d637cad6dfae398949af0a7107
Signed-off-by: Ed Tanous <etanous@nvidia.com>

Fix clang-tidy

Change-Id: Iefe1b695b86a640d8dfaafd1f77f374fa34246de
Signed-off-by: Ed Tanous <etanous@nvidia.com>

Disable clang-19 check that doesn't yet pass

Change-Id: Ia88131173ae51284c6e6cbc0149bc6029cabfe59
Signed-off-by: Ed Tanous <etanous@nvidia.com>

Reformat for clang-19

Change-Id: I6d677b16219482db16c64d5d8412ca557142a597
Signed-off-by: Ed Tanous <etanous@nvidia.com>

Move getProperty calls to utility

Having all dbus calls run through the same utility reduces the amount of
generated code, and more importantly, gives us a place where we can log
the requests and re

Move getProperty calls to utility

Having all dbus calls run through the same utility reduces the amount of
generated code, and more importantly, gives us a place where we can log
the requests and responses to help with debugging.

Tested: Redfish service validator passes.

Change-Id: Ic1bf45130b5069cd57f7af26e12c8d3159c87c67
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Fix URI warning in RSV

Redfish service valitator warns:

WARNING - PublicationUri: Empty string found - Services should omit
properties if not supported

This commit adds to our registry the url to

Fix URI warning in RSV

Redfish service valitator warns:

WARNING - PublicationUri: Empty string found - Services should omit
properties if not supported

This commit adds to our registry the url to the openbmc registry file.

Tested: Redfish Service validator no longer returns a warning.

Change-Id: Ia54be175490b4e7e00e3c0c4ab8c60dce1b96863
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Fix boost UUID build issue

Boost seems to have changed to not directly expose
basic_random_generator. This results in an error.

```
../src/ossl_random.cpp:15:1: error: included header random_gener

Fix boost UUID build issue

Boost seems to have changed to not directly expose
basic_random_generator. This results in an error.

```
../src/ossl_random.cpp:15:1: error: included header random_generator.hpp is not used directly [misc-include-cleaner,-warnings-as-errors]
```

Tested: Code builds. #include only change.

Change-Id: Ib17a3520b8207e6e4de5aa7a3807bd6cec6d4e25
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

change default to use fw Update D-Bus interface

Currently, the firmware update images are being downloaded onto
/tmp/images directory which are watched by phosphor-bmc-code-mgmt to
start an update.

change default to use fw Update D-Bus interface

Currently, the firmware update images are being downloaded onto
/tmp/images directory which are watched by phosphor-bmc-code-mgmt to
start an update. The current flow only supports single update at a time.
More details on problem description and specific requirements have been
captured in [1]. The intent of this change is to start the use of an
Update D-Bus interface which has been implemented using
redfish-updateservice-use-dbus feature flag. Through this change BMCWeb
will download the image in memory and pass the image fd to the backend
using D-Bus interface. Change redfish-updateservice-use-dbus default to
enabled.

[1]: https://github.com/openbmc/docs/blob/master/designs/code-update.md

Related PRs:
https://gerrit.openbmc.org/q/topic:EnableUpdateInterface

Tested:

```
Metadata: Namespaces missing from $metadata: set()

Elapsed time: 0:00:33
missingRedfishAlias: 1
pass: 4343
passAction: 16
passGet: 217
passRedfishUri: 208
skipNoSchema: 3
skipOptional: 4001
unvalidated: 1
unverifiedAdditional.complex: 1
warnDeprecated: 5
warningPresent: 6
warnings: 4
Validation has succeeded.

> curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/UpdateService/FirmwareInventory
{
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory",
"@odata.type": "#SoftwareInventoryCollection.SoftwareInventoryCollection",
"Members": [
{
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/a79d71e4"
}
],
"Members@odata.count": 1,
"Name": "Software Inventory Collection"
}

> curl -k -H "X-Auth-Token: $token" -H "Content-Type:multipart/form-data" -X POST -F UpdateParameters="{\"Targets\":[\"/redfish/v1/UpdateService/FirmwareInventory/a79d71e4\"],\"@Redfish.OperationApplyTime\":\"OnReset\"};type=application/json" -F "UpdateFile=@obmc-phosphor-image-romulus-20241015174416.static.mtd.tar;type=application/octet-stream" https://${bmc}/redfish/v1/UpdateService/update

{
"@odata.id": "/redfish/v1/TaskService/Tasks/0",
"@odata.type": "#Task.v1_4_3.Task",
"Id": "0",
"TaskState": "Running",
"TaskStatus": "OK"
}

> curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/TaskService/Tasks/0
{
"@odata.id": "/redfish/v1/TaskService/Tasks/0",
"@odata.type": "#Task.v1_4_3.Task",
"EndTime": "2024-11-14T01:01:36+00:00",
"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.3.TaskStarted",
"MessageSeverity": "OK",
"Resolution": "None."
},
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The task with Id '0' has changed to progress 10 percent complete.",
"MessageArgs": [
"0",
"10"
],
"MessageId": "TaskEvent.1.0.3.TaskProgressChanged",
"MessageSeverity": "OK",
"Resolution": "None."
},
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The task with Id '0' has changed to progress 100 percent complete.",
"MessageArgs": [
"0",
"100"
],
"MessageId": "TaskEvent.1.0.3.TaskProgressChanged",
"MessageSeverity": "OK",
"Resolution": "None."
},
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The task with Id '0' has completed.",
"MessageArgs": [
"0"
],
"MessageId": "TaskEvent.1.0.3.TaskCompletedOK",
"MessageSeverity": "OK",
"Resolution": "None."
}
],
"Name": "Task 0",
"Payload": {
"HttpHeaders": [],
"HttpOperation": "POST",
"JsonBody": "null",
"TargetUri": "/redfish/v1/UpdateService/update"
},
"PercentComplete": 100,
"StartTime": "2024-11-14T01:01:04+00:00",
"TaskMonitor": "/redfish/v1/TaskService/TaskMonitors/0",
"TaskState": "Completed",
"TaskStatus": "OK"
}

```

Change-Id: Ice710e9b44e60bc60b7c2d512ac6d98fa770dc56
Signed-off-by: Jagpal Singh Gill <paligill@gmail.com>

show more ...

Fix clang-tidy for gcc-14

We use these pragmas, that we must've been getting transitively through
chrono in the past. Now we need to include them explicitly.

Change-Id: Iee4c0a8866981b91adaa17bee0

Fix clang-tidy for gcc-14

We use these pragmas, that we must've been getting transitively through
chrono in the past. Now we need to include them explicitly.

Change-Id: Iee4c0a8866981b91adaa17bee0678b2c10e65ea9
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Put simple update behind an option

4e338b2313f9f2a91aa1fb36693e36a328d58933 Removed tftp update support
from the codebase, but left SimpleUpdate in a non functional state.

Given that a number of fo

Put simple update behind an option

4e338b2313f9f2a91aa1fb36693e36a328d58933 Removed tftp update support
from the codebase, but left SimpleUpdate in a non functional state.

Given that a number of forks have implemented the HTTPS/SCP versions of
simple update, we don't want to fully delete the code at this time, so
for the moment put it behind an option flag.

Tested: WIP

Change-Id: Ibab1e3a48ff640787eabf8ed5f7a5c08e3381307
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Always fall back to ChassisType RackMount

https://gerrit.openbmc.org/c/openbmc/bmcweb/+/75914 added support for
dynamic ChassisType. Before 75914, ChassisType was hardcoded to
RackMount. If you impl

Always fall back to ChassisType RackMount

https://gerrit.openbmc.org/c/openbmc/bmcweb/+/75914 added support for
dynamic ChassisType. Before 75914, ChassisType was hardcoded to
RackMount. If you implement Inventory.Item.Chassis the default Chassis
Type is Unknown. Unknown in 75914 maps to Invalid and ChassisType is
left off the Redfish Chassis resource. The Redfish Validator flags this
as an error since ChassisType is a required property in the Chassis
schema.

The implementations should be setting the ChassisType but let's get
bmcweb bumps back on the rails and just set ChassisType = RackMount if
there is an error or if the Chassis Type is something we can't map (like
Unknown). This "your default ChassisType is RackMount" matches what we
had before.

Tested: Inspection and unit tests only.

Change-Id: Id577be522be7c2d3463da9c497d9063a284a4d54
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Make message registries use 2 digit versions

Redfish specification, section 9.5.11.2 says:

The MessageId property value shall be in the format:
<MessageRegistryPrefix>.<MajorVersion>.<MinorVersion>

Make message registries use 2 digit versions

Redfish specification, section 9.5.11.2 says:

The MessageId property value shall be in the format:
<MessageRegistryPrefix>.<MajorVersion>.<MinorVersion>.<MessageKey>

bmcweb in certain places has incorrectly used the 3 digit version
instead of the 2 digit version. This commit fixes that by modifying the
parse_registries script to generate 3 separate struct entries to
represent the registry version, and parse them where appropriate.

MessageRegistryFileCollection uses the 3 digit version. No behavior
changes.
Message/event log entries use the 2 digit version. This will cause a
MessageId change from:
Base.1.19.0.InternalError
to
Base.1.19.InternalError

This is a breaking change, so a new option to allow the old behavior is
provided.

Tested: Redfish Service validator passes.
Heartbeat events on EventService show 2 digit versions.

Change-Id: I4165e994f73e200f13bed8ea76cb58bee2b69faa
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Extract reusable logic into separate function

Moved post session creation logic to new function called
processAfterSessionCreation.
This refactor improves code reuse for MFA changes in commit
https:

Extract reusable logic into separate function

Moved post session creation logic to new function called
processAfterSessionCreation.
This refactor improves code reuse for MFA changes in commit
https://gerrit.openbmc.org/c/openbmc/bmcweb/+/74938

Tested by:
Created session with expired password.
Verified password change is forced.

Created session with valid password.

Change-Id: Id91c53661c2c875c229cee9b5a6575560031ad75
Signed-off-by: Jishnu CM <jishnunambiarcm@duck.com>

show more ...

Add content-encoding parser

Similar to content-type, add an http content-encoding parser.

Tested: Unit tests pass.

Change-Id: Ic62809934f84804c910458184de19ca9a4207ce5
Signed-off-by: Ed Tanous <et

Add content-encoding parser

Similar to content-type, add an http content-encoding parser.

Tested: Unit tests pass.

Change-Id: Ic62809934f84804c910458184de19ca9a4207ce5
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Make eventId increment per event

Currently, eventId is incremented for each subscriber even for the same
event. So, this is to increment eventId per event.

Tested:
- Run multiple instance of event

Make eventId increment per event

Currently, eventId is incremented for each subscriber even for the same
event. So, this is to increment eventId per event.

Tested:
- Run multiple instance of event listeners
- Generate an event like
```
curl -k -H "X-Auth-Token: $bmc_token" -H "Content-Type: application/json" \
-X POST https://${bmc}/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData \
-d '{"DiagnosticDataType":"Manager"}'
```

- Check the EventId whether it is incremented per event
```
"@odata.type": "#Event.v1_4_0.Event",
"Events": [
{
...
"MessageId": "TaskEvent.1.0.3.TaskStarted",
"MessageSeverity": "OK",
"OriginOfCondition": "/redfish/v1/TaskService/Tasks/0",
"Resolution": "None."
}
],
"Id": 2, <===
"Name": "Event Log"
}
```

Change-Id: I7a1f61cb932068cac5a50838fefeeaf880516a97
Signed-off-by: Myung Bae <myungbae@us.ibm.com>

show more ...

Refactor Message Header and Url Selector

This is to refactor the access of header and url parts from
MessageRegistry to reduce the replicated comparison of the registry
name.

Tested:
- GET /redfis

Refactor Message Header and Url Selector

This is to refactor the access of header and url parts from
MessageRegistry to reduce the replicated comparison of the registry
name.

Tested:
- GET /redfish/v1/Registries/<str>/<str> like
```
- /redfish/v1/Registries/Base/Base
- /redfish/v1/Registries/TaskEvent/TaskEvent
- /redfish/v1/Registries/ResourceEvent/ResourceEvent
- /redfish/v1/Registries/OpenBMC/OpenBMC
- /redfish/v1/Registries/Telemetry/Telemetry
```

Change-Id: Id5806343709084292273e8021e0d0b4a114ac06f
Signed-off-by: Myung Bae <myungbae@us.ibm.com>

show more ...

Implement Subscription Heartbeat Logic

This implements the subscription heartbeat logic which will send the
message `RedfishServiceFunctional` periodically with the interval of
`HeartbeatIntervalMin

Implement Subscription Heartbeat Logic

This implements the subscription heartbeat logic which will send the
message `RedfishServiceFunctional` periodically with the interval of
`HeartbeatIntervalMinutes` specified in subscription property [1][2], if
`SendHeartbeat` is enabled..

Note the heartbeat enablement is per event destination as DMTF specifies
[3] like
```
... This message shall only be sent if specifically requested by an event
destination during the creation of a subscription...
```

This also add `HeartbeatEvent` to supported registry prefixes like
```
curl -k -X GET https://${bmc}/redfish/v1/EventService/
{
...
"RegistryPrefixes": [
"Base",
"OpenBMC",
"TaskEvent",
"HeartbeatEvent"
],
"ResourceTypes": [
"Task",
"Heartbeat"
],
```

Tested:

1) A single subscription and heartbeat via Redfish Event Listener

- Create a subscription via Redfish Event Listener
- PATCH `SendHeartbeat=true` and `HeartbeatIntervalMinutes` like

```
curl -k -X PATCH https://${bmc}/redfish/v1/EventService/Subscriptions/${SUBID} \
-H "Content-Type: application/json" \
-d '{"SendHeartbeat":true, "HeartbeatIntervalMinutes":1}'
```

- Monitor the Redfish Event Listener and check the following heartbeat
messages periodically (per HeartbeatIntervalMinutes)

```
response_type: POST
headers: {'Host': '9.3.62.209', 'Content-Length': '230'}

response={
"@odata.type": "#Event.v1_4_0.Event",
"Events": [
{
"@odata.type": "#Message.v1_1_1.Message",
"EventId": "HeartbeatId",
"EventTimestamp": "2024-11-21T12:21:47+00:00",
"MemberId": "0",
"Message": "Redfish service is functional.",
"MessageArgs": [],
"MessageId": "HeartbeatEvent.1.0.1.RedfishServiceFunctional",
"MessageSeverity": "OK",
"OriginOfCondition": "/redfish/v1/EventService/Subscriptions/1521743607",
"Resolution": "None."
}
],
"Id": "HeartbeatId",
"Name": "Event Log"
}
```

- Change `SendHeartbeat` to false and see whether the heartbeat message
is stopped.

2) Multiple sbscribers with the different heartbeat setups

- create 2 event listeners with 2 different destinations (e.g., port
8080 and 8081).
- Patch sendheartbeat=true to only one subscriber.
- Check whether the only subscriber that enables `SendHeartbeat` is
receiving the heartbeat messages.

3) Redfish Service Validator passes

[1] https://github.com/openbmc/bmcweb/blob/02ea923f13de196726ac2f022766a6f80bee1c0a/redfish-core/schema/dmtf/json-schema/EventDestination.v1_15_0.json#L356
[2] https://redfish.dmtf.org/registries/HeartbeatEvent.1.0.1.json
[3] https://github.com/DMTF/Redfish/blob/d9e54fc8393d8930bd42e8b134741f5051a2680f/registries/HeartbeatEvent.1.0.1.json#L14

Change-Id: I8682e05f4459940913ba189f1ed016874e38dd4a
Signed-off-by: Myung Bae <myungbae@us.ibm.com>

show more ...

Add Persistent Heartbeat subscription properties

This adds Heartbeat parameters to subscriptions so that the future
heartbeat implementation can use those parameters specified by the
schema [1][2][3

Add Persistent Heartbeat subscription properties

This adds Heartbeat parameters to subscriptions so that the future
heartbeat implementation can use those parameters specified by the
schema [1][2][3].
- SendHeartbeat
- HeartbeatIntervalMinutes

Tested:

1. POST Subscription
- Create a subscription (e.g. via Redfish-Event-Listener) or like

```
curl -k -H "Content-Type: application/json" -X POST https://${bmc}/redfish/v1/EventService/Subscriptions \
-d '{
"Context": "Public",
"DeliveryRetryPolicy": "TerminateAfterRetries",
"Destination": "https://DESTINATION-IPADDR/Redfish-Evt-Listener",
"EventFormatType": "Event",
"HeartbeatIntervalMinutes": 2,
"HttpHeaders": [],
"MessageIds": [],
"MetricReportDefinitions": [],
"Protocol": "Redfish",
"RegistryPrefixes": [],
"ResourceTypes": [],
"SendHeartbeat": true,
"SubscriptionType": "RedfishEvent",
"VerifyCertificate": true
}'
```

2. GET the subscription and check the content
```
SUBID=<id>
curl -k -X GET https://${bmc}/redfish/v1/EventService/Subscriptions/${SUBID}
```

3. PATCH Subscription
- PATCH with various SendHeartbeat & HeartbeatIntervalMinutes

For example,
```
curl -k -X PATCH https://${bmc}/redfish/v1/EventService/Subscriptions/${SUBID} \
-H "Content-Type: application/json" \
-d '{"SendHeartbeat":true, "HeartbeatIntervalMinutes":10}'
```

- Restart bmcweb or reboot BMC

- Get the subscription data and see whether the heartbeat properties are
persistent.

4. Redfish Validator Service passes

[1] https://github.com/openbmc/bmcweb/blob/d109e2b60f7bb367dc8115475c6cb86bca6e1914/redfish-core/schema/dmtf/json-schema/EventDestination.v1_15_0.json#L356
[2] https://github.com/openbmc/bmcweb/blob/d109e2b60f7bb367dc8115475c6cb86bca6e1914/redfish-core/schema/dmtf/json-schema/EventDestination.v1_15_0.json#L222
[3] https://www.dmtf.org/sites/default/files/standards/documents/DSP2046_2022.3.html

Change-Id: I9e7feadb2e851ca320147df2231f65ece58ddf25
Signed-off-by: Myung Bae <myungbae@us.ibm.com>

show more ...

Remove check_base_registry

We now generate our registries, this script is no longer useful.

Change-Id: I8e0e18e5c9d2683738e67fb318d663ae960f808d
Signed-off-by: Ed Tanous <etanous@nvidia.com>

Simplify journal paging

sd-journal has its own paging mechanisms for generating and seeking to
unique ids. Ironically they look fairly similar to what we've
implemented here, but they have more con

Simplify journal paging

sd-journal has its own paging mechanisms for generating and seeking to
unique ids. Ironically they look fairly similar to what we've
implemented here, but they have more content, presumably because they
can use internal implementation details to do paging.

This commit switches all sd-journal paging to use cursors. Functionally
this changes the odata.id from being a concatenated string into being a
base64 encoded identifier that is much longer.

The end result is vastly simplified code.

Tested:
check journal script [1] succeeds

[1] https://github.com/openbmc/openbmc-tools/blob/master/check_journal/check_journal

Script runs to completion and shows all tests passed.

Change-Id: Ia49fbfc272bef6dfbe1ea45a8d993dc785041659
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Refactor swutils to break down in to functions

Prior to this patch, this is one of the offenders in the bmcweb
codebase for complexity. It does 4 levels of nested lambdas in a single
method, making

Refactor swutils to break down in to functions

Prior to this patch, this is one of the offenders in the bmcweb
codebase for complexity. It does 4 levels of nested lambdas in a single
method, making it basically impossible to read. As a side note, this
came up because of an unrelated refactoring, and clang-format seemed to
have just given up, and formatted this block in a nonsensical way.

Tested: Inspection only. Don't have systems that use this code.

Change-Id: Ica5fa97bae6be2ba1d83d2ad01eeff85bdff6649
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

Make accepts a real parser

We somewhat copped out a little with regards to this originally, because
writing parsers is hard, and we don't have to implement the full field
of what the Accepts header

Make accepts a real parser

We somewhat copped out a little with regards to this originally, because
writing parsers is hard, and we don't have to implement the full field
of what the Accepts header allows.

We should aim to be correct where we can, so implement a real parser
that parses values, including the floats.

Tested: Unit tests pass, good coverage.

Change-Id: I1b4232929367d230641be9f41f5af6e6dbcea037
Signed-off-by: Ed Tanous <etanous@nvidia.com>

show more ...

boost version 1.86 support

Based on Boost 1.86 documentation
https://www.boost.org/users/history/version_1_86_0.html
Process:
Turned v2 into a compile library.

Conditionally include

boost version 1.86 support

Based on Boost 1.86 documentation
https://www.boost.org/users/history/version_1_86_0.html
Process:
Turned v2 into a compile library.

Conditionally included the Boost Process library for versions >= 1.86
to fix the following linker errors:

```
undefined reference to `boost::process::v2::error::get_utf8_category()
undefined reference to `boost::process::v2::error::get_collect2()
```

Tested: verified build

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

show more ...