Add GetFileHandle method to dump entry

This commit introduces the GetFileHandle method in the dump entry
interface. This method provides direct access to the Unix file
handle of the dump entry, facilitating more direct read operations
on the dump file.

The returned file descriptor will be read-only, ensuring the integrity
of the dump file.

This change is primarily introduced to support the PLDM for offloading
the dump to the host and bmcweb for offloading the dump to Redfish
clients. Previously, a direct file path was provided for these
operations. However, if the applications are running in a non-root
context, they may lack the necessary access to the file. By providing
a file handle, this access issue is resolved.

Change-Id: I1c9dd5ae6dad503288f39227876e13308043fefd
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
1 file changed
tree: bfde440d5079b539af1ff64e7c3094c260b99bb9
  1. gen/
  2. subprojects/
  3. yaml/
  4. .gitignore
  5. .markdownlint.yaml
  6. .prettierrc.yaml
  7. .shellcheck
  8. LICENSE
  9. meson.build
  10. meson_options.txt
  11. OWNERS
  12. README.md
  13. requirements.md
README.md

phosphor-dbus-interfaces

YAML descriptors of standard D-Bus interfaces. The format is described by the sdbusplus binding generation tool sdbus++.

Before defining a new D-Bus interface or modifying an existing one, please read through the documented set of the common requirements and expectations.

Building

This project can be built with meson. The typical meson workflow is: meson builddir && ninja -C builddir.

The meson files used to handle the YAML files are automatically generated and found under the gen subdirectory. When adding or removing YAML files, this must be regenerated. This can be done with the helper script found in the gen subdirectory: cd gen && ./regenerate-meson.

Configuration

Only the xyz/openbmc_project and org/freedesktop interfaces are built by default. Other interfaces can be enabled by meson options:

  • com/ibm - -Ddata_com_ibm=true
  • org/open_power - -Ddata_org_open_power=true

Example: meson builddir -Ddata_com_ibm=true && ninja -C builddir

References