Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / 75800cfb6e9676b620185b741383f886907fe02e
commit75800cfb6e9676b620185b741383f886907fe02e[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Sat Jan 21 15:24:18 2017 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Jan 24 14:39:00 2017 -0500
treeb6e3d90ee75722f857ed08a02ce887990fe8cb4e
parent9b5a12fd5bcc1f8e1dc1474f824a2ce1b6a68e51 [diff]
pimgen: Argument refactoring

Rename the existing argument type to TrivialArgument to prepare
for additional argument types.  Remove inheritance of
sdbusplus.property.

Define an argument interface base type.

Inherit argument interface from DBusSignature, and
move it up by other argument types.

Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
Change-Id: I3fa2b8794838fd0b0b484e618a477de208ead2d9
1 file changed
tree: b6e3d90ee75722f857ed08a02ce887990fe8cb4e
  1. example/
  2. test/
  3. xyz/
  4. .gitignore
  5. actions.hpp
  6. app.cpp
  7. argument.mako.cpp
  8. bootstrap.sh
  9. configure.ac
  10. events.hpp
  11. generated.mako.cpp
  12. LICENSE
  13. Makefile.am
  14. manager.cpp
  15. manager.hpp
  16. method.mako.cpp
  17. pimgen.py
  18. README.md
  19. signature.mako.cpp
  20. utils.hpp
  21. xyz.openbmc_project.Inventory.Manager.cpp
README.md

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 and run-time calls to the Notify method of the Manager interface to provide a generalized inventory state management solution.

YAML

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:

  • description - An optional description of the file.
  • events - One or more events that PIM should monitor.

events

Supported event tags are:

  • name - A globally unique event name.
  • description - An optional description of the event.
  • type - The event type. Supported types are: match.
  • actions - The responses to the event.

Subsequent tags are defined by the event type.

match

Supported match tags are:

  • signatures - A DBus match specification.
  • filters - Filters to apply when a match occurs.

filters

Supported filter tags are:

  • name - The filter to use.
  • args - An optional list of arguments to pass to the filter.

The available filters provided by PIM are:

  • none - A non-filter.
  • propertyChangedTo - Only match events when the specified property has the specified value.

propertyChangedTo

Supported arguments for the propertyChangedTo filter are:

  • interface - The interface hosting the property to be checked.
  • property - The property to check.
  • value - The value to check.

actions

Supported action tags are:

  • name - The action to perform.
  • args - An optional list of arguments to pass to the action.

The available actions provided by PIM are:

  • noop - A non-action.
  • destroyObject - Destroy the specified DBus object.
  • setProperty - Set the specified property on the specified DBus object.

destroyObject

Supported arguments for the destroyObject action are:

  • path - The path of the object to remove from DBus.

setProperty

Supported arguments for the setProperty action are:

  • interface - The interface hosting the property to be set.
  • property - The property to set.
  • path - The object hosting the property to be set.
  • value - The value to set.

Building

After running pimgen.py, build PIM using the following steps:

    ./bootstrap.sh
    ./configure ${CONFIGURE_FLAGS}
    make

To clean the repository run:

 ./bootstrap.sh clean