Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / 48547a85412bcb5c6430978ce58fb96a96234293
commit48547a85412bcb5c6430978ce58fb96a96234293[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Thu Jan 19 15:12:50 2017 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Wed Feb 01 16:10:28 2017 -0500
tree5170152620badd4563a76fbc77c444226865347a
parent76e2f6a511706d375548f645d7af1ecf9fbdfe04 [diff]
Minor event refactoring

Assert that all events will share the same filter interface by
moving event filters to event base class.

Remove virtual on destructors in classes with final.

Improve comments in a number of places.

Change-Id: Ia32c13fd0f3b9a5fa147a2198a285bce37c27cfb
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
3 files changed
tree: 5170152620badd4563a76fbc77c444226865347a
  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.cpp
  11. events.hpp
  12. generated.mako.cpp
  13. LICENSE
  14. Makefile.am
  15. manager.cpp
  16. manager.hpp
  17. method.mako.cpp
  18. pimgen.py
  19. README.md
  20. signature.mako.cpp
  21. utils.hpp
  22. 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.

Subsequent tags are defined by the filter type.

The available filters provided by PIM are:

  • propertyChangedTo - Only match events when the specified property has the specified value.
  • propertyIs - Only match events when the specified property has the specified value.

propertyChangedTo

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:

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

propertyIs

The property under test is obtained by invoking org.freedesktop.Properties.Get on the specified interface.

Supported arguments for the propertyIs filter are:

  • path - The object hosting the property to be checked.
  • interface - The interface hosting the property to be checked.
  • property - The property to check.
  • value - The value to check.
  • service - An optional DBus service name.

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.

actions

Supported action tags are:

  • name - The action to perform.

Subsequent tags are defined by the action type.

The available actions provided by PIM are:

  • destroyObject - Destroy the specified DBus object.
  • setProperty - Set the specified property on the specified DBus object.

destroyObject

Supported arguments for the destroyObject action are:

  • paths - The paths of the objects 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