| commit | d8fba8bec76389c4a21d000fb17b07a9cea3bf0c | [log] [tgz] |
|---|---|---|
| author | Patrick Williams <patrick@stwcx.xyz> | Fri Aug 16 15:20:15 2024 -0400 |
| committer | Patrick Williams <patrick@stwcx.xyz> | Fri Aug 16 15:20:15 2024 -0400 |
| tree | d80649ddccdfe5e1d79f679497ef168d8bdd858b | |
| parent | 58a0c359fb9984698a702a3580ddee0a848c05e3 [diff] |
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: I8078c8196a2d5706179dc10bf20c0af1a69ec962 Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Phosphor Inventory Manager (PIM) is an implementation of the xyz.openbmc_project.Inventory.Manager DBus interface, and supporting tools. PIM uses a combination of build-time YAML files, run-time calls to the Notify method of the Manager interface, and association definition JSON files to provide a generalized inventory state management solution.
PIM includes a YAML parser (pimgen.py). For PIM to do anything useful, a set of YAML files must be provided externally that tell it what to do. Examples can be found in the examples directory.
The following top level YAML tags are supported:
Supported event tags are:
Subsequent tags are defined by the event type.
Supported match tags are:
Supported startup tags are:
Supported filter tags are:
Subsequent tags are defined by the filter type.
The available filters provided by PIM are:
The property under test is obtained from an sdbus message generated from an org.freedesktop.DBus.Properties.PropertiesChanged signal payload.
Supported arguments for the propertyChangedTo filter are:
The property under test is obtained by invoking org.freedesktop.Properties.Get on the specified interface.
Supported arguments for the propertyIs filter are:
The service argument is optional. If provided that service will be called explicitly. If omitted, the service will be obtained with an xyz.openbmc_project.ObjectMapper lookup.
propertyIs can be used in an action condition context when the action operates on a dbus object path.
Supported action tags are:
Subsequent tags are defined by the action type.
The available actions provided by PIM are:
Supported arguments for the destroyObject action are:
Conditions are tested and logically ANDed. If the conditions do not pass, the object is not destroyed. Any condition that accepts a path parameter is supported.
Supported arguments for the setProperty action are:
Conditions are tested and logically ANDed. If the conditions do not pass, the property is not set. Any condition that accepts a path parameter is supported.
Supported arguments for the createObjects action are:
PIM can create associations between inventory items and other D-Bus objects.
This functionality is optional and is controlled with the --enable-associations configure option. It defaults to disabled.
To use this, the associations to create should be defined in a JSON file which is specified by the ASSOCIATIONS_FILE_PATH configure variable, which defaults to /usr/share/phosphor-inventory-manager/associations.json. This file is processed at runtime.
An example of this JSON is:
[ { "path": "system/chassis/motherboard/cpu0/core1", "endpoints": [ { "types": { "fType": "sensors", "rType": "inventory" }, "paths": ["/xyz/openbmc_project/sensors/temperature/p0_core0_temp"] } ] } ]
Then, when/if PIM creates the xyz/openbmc_project/system/chassis/motherboard/cpu0/core1 inventory object, it will add an xyz.openbmc_project.Association.Definitions interface on it such that the object mapper creates the 2 association objects:
/xyz/openbmc_project/inventory/system/chassis/motherboard/cpu0/core1/sensors endpoints property: ['/xyz/openbmc_project/sensors/temperature/p0_core0_temp'] /xyz/openbmc_project/sensors/temperature/p0_core0_temp/inventory endpoints property: ['/xyz/openbmc_project/inventory/system/chassis/motherboard/cpu0/core1']
The JSON description is:
[ { "path": "The relative path of the inventory object to create the xyz.openbmc_project.Association.Definitions interface on." "endpoints": [ { "types": { "fType": "The forward association type." "rType": "The reverse association type." }, "paths": [ "The list of association endpoints for this inventory path and association type." ] } ] } ]
In the case where different systems that require different associations reside in the same flash image, multiple JSON files must be used. These files must be in the same directory as the default associations file would go, but it does not matter what they are named as long as the name ends in '.json'. Each file then contains a 'condition' entry that specifies an inventory path, interface, property, and list of values. If the actual value of that property is in the list of values, then the condition is met and those associations are activated.
If a file with a conditions section is found, then the default associations file is ignored. The end result is that associations are only ever loaded from one file, either the default file if there aren't any files with conditions in them, or the first file that had a condition that matched.
An example is:
{ "condition": { "path": "system/chassis/motherboard", "interface": "xyz.openbmc_project.Inventory.Decorator.Asset", "property": "Model", "values": ["ModelA", "ModelB"] }, "associations": [ { "path": "system/chassis/motherboard/cpu0/core1", "endpoints": [ { "types": { "fType": "sensors", "rType": "inventory" }, "paths": ["/xyz/openbmc_project/sensors/temperature/p0_core0_temp"] } ] } ] }
This states that these associations are valid if the system/chassis/motherboard inventory object has a Model property with a value of either ModelA or ModelB.
The values field supports the same types as in the inventory, so either a bool (true/false), int64_t, std::string, or std::vector<uint8_t>([1, 2]).
After running pimgen.py, build PIM using the following steps:
meson setup builddir ninja -C builddir