Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-power / af7321ebf1e68c842487782a366abcf683fcd292
commitaf7321ebf1e68c842487782a366abcf683fcd292[log] [tgz]
authorMatt Spinler <spinler@us.ibm.com>Tue Sep 16 13:01:21 2025 -0500
committerMatt Spinler <spinler@us.ibm.com>Tue Sep 16 13:10:22 2025 -0500
tree20bc2c6b3269901b470fa43f6cea55ef41487c51
parent9ed0f38e1d59564106c6020b854416ece6753776 [diff]
pmbus: Safely call std::filesystem::canonical()

There are a few different places where CALLOUT_DEVICE_PATH elog metadata
is used that passes in the result of a std::filesystem::canonical()
call.

That function will throw if the path passed in does not exist. Since
that code isn't in a try/catch block, the application will crash.

Fix that by using the version of the function that sets a
std::error_code in an output parameter to indicate failure.  If it does
fail, then just use the original path given to it.

As canonical() was used for a reason, there may be side affects such as
proper error analysis not being done, but there is not much that can be
done about that.

Tested:
The app doesn't crash, and can see:

```
Failed to read sysfs file errno=2 FILENAME=/sys/kernel/debug/pmbus/status0
Could not get canonical path from /sys/bus/i2c/devices/3-006a
Failed to read from the device.
```

And in the event log
```
"CALLOUT_DEVICE_PATH" "/sys/bus/i2c/devices/3-006a"
```

Change-Id: I9ea374dc685cc325b40a1f2bb0c8ae0ce71df650
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
1 file changed
tree: 20bc2c6b3269901b470fa43f6cea55ef41487c51
  1. cold-redundancy/
  2. example/
  3. org/
  4. phosphor-power-sequencer/
  5. phosphor-power-supply/
  6. phosphor-regulators/
  7. power-sequencer/
  8. power-supply/
  9. services/
  10. subprojects/
  11. test/
  12. tools/
  13. .clang-format
  14. .clang-tidy
  15. .clang-tidy-ignore
  16. .gitignore
  17. .shellcheck
  18. compatible_system_types_finder.cpp
  19. compatible_system_types_finder.hpp
  20. dbus_interfaces_finder.cpp
  21. dbus_interfaces_finder.hpp
  22. device.hpp
  23. device_monitor.hpp
  24. elog-errors.hpp
  25. file_descriptor.hpp
  26. format_utils.hpp
  27. gpio.cpp
  28. gpio.hpp
  29. LICENSE
  30. meson.build
  31. meson.options
  32. names_values.hpp
  33. OWNERS
  34. pmbus.cpp
  35. pmbus.hpp
  36. README.md
  37. temporary_file.cpp
  38. temporary_file.hpp
  39. temporary_subdirectory.cpp
  40. temporary_subdirectory.hpp
  41. types.hpp
  42. utility.cpp
  43. utility.hpp
README.md

phosphor-power

Overview

This repository contains applications for configuring and monitoring devices that deliver power to the system.

Actively-maintained applications:

  • cold-redundancy: Application that makes power supplies work in Cold Redundancy mode and rotates them at intervals.
  • phosphor-power-sequencer: JSON-driven application that powers the chassis on/off and monitors the power sequencer device.
  • phosphor-power-supply: Next generation power supply monitoring application.
  • phosphor-regulators: JSON-driven application that configures and monitors voltage regulators.
  • tools/power-utils: Power supply utilities.

Legacy applications:

  • power-sequencer: Original power sequencer monitoring application.
  • power-supply: Original power supply monitoring application.

Build

To build all applications in this repository:

  meson setup build
  ninja -C build

To clean the repository and remove all build output:

  rm -rf build

You can specify meson options to customize the build process. For example, you can specify:

  • Which applications to build and install.
  • Application-specific configuration data, such as power sequencer type.
  • Whether to build tests.

Power Supply Monitor and Util JSON config

Several applications in this repository require a PSU JSON config to run. The JSON config file provides information for:

  • Where to access the pmbus attributes
  • Which attribute file in pmbus maps to which property and interface in D-Bus
  • Which kernel device directory is used on which PSU

There is an example psu.json to describe the necessary configurations.

  • inventoryPMBusAccessType defines the pmbus access type, which tells the service which sysfs type to use to read the attributes. The possible values are:

    • Base: The base dir, e.g. /sys/bus/i2c/devices/3-0069/
    • Hwmon: The hwmon dir, e.g. /sys/bus/i2c/devices/3-0069/hwmon/hwmonX/
    • Debug: The pmbus debug dir, e.g. /sys/kernel/debug/pmbus/hwmonX/
    • DeviceDebug: The device debug dir, e.g. /sys/kernel/debug/<driver>.<instance>/
    • HwmonDeviceDebug: The hwmon device debug dir, e.g. /sys/kernel/debug/pmbus/hwmonX/cffps1/

  • fruConfigs defines the mapping between the attribute file and the FRU inventory interface and property. The configuration example below indicates that the service will read part_number attribute file from a directory specified by the above pmbus access type, and assign to PartNumber property in xyz.openbmc_project.Inventory.Decorator.Asset interface.

      "fruConfigs": [
    {
      "propertyName": "PartNumber",
      "fileName": "part_number",
      "interface": "xyz.openbmc_project.Inventory.Decorator.Asset"
    }
  ]

  • psuDevices defines the kernel device dir for each PSU in inventory. The configuration example below indicates that powersupply0's device is located in /sys/bus/i2c/devices/3-0069.

      "psuDevices": {
    "/xyz/openbmc_project/inventory/system/chassis/motherboard/powersupply0" : "/sys/bus/i2c/devices/3-0069",
  }