Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / 4f20a3e3ccbfb8b08de0bdac96c037d81546c573
commit4f20a3e3ccbfb8b08de0bdac96c037d81546c573[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Nov 29 15:21:46 2016 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Wed Jan 11 12:17:01 2017 -0500
tree661d770858a4a633b58fca38eda8f01888868409
parent370421bef4e395577233f55180bf6655d9cd2303 [diff]
Add event framework

Introduce the concept of events, where the existing Dbus signal
match event is one of many possible event classes.

Change-Id: I9b0c6ca12daaa109f8ceb537a5fb0cc6b5f7181b
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
4 files changed
tree: 661d770858a4a633b58fca38eda8f01888868409
  1. example/
  2. test/
  3. xyz/
  4. .gitignore
  5. actions.hpp
  6. app.cpp
  7. bootstrap.sh
  8. configure.ac
  9. events.hpp
  10. generated.mako.cpp
  11. LICENSE
  12. Makefile.am
  13. manager.cpp
  14. manager.hpp
  15. pimgen.py
  16. README.md
  17. utils.hpp
  18. 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. An example 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.
  • type - The event type. Supported types are: match.
  • action - The response to the event.

Subsequent tags are defined by the event type.

action

Supported action tags are:

  • type - The action to perform.
  • args - An optional list of arguments to pass to the action.
    • value - The argument value.
    • type - The argument type (defaults to string if unspecified).

The available actions provided by PIM are:

  • noop - A non-action.
  • destroyObject - Destroy the specified DBus object.

match

Supported match tags are:

  • signature - A DBus match specification.
  • filter - A filter to apply when a match occurs.

filter

Supported filter tags are:

  • type - The filter to use.
  • args - An optional list of arguments to pass to the filter.
    • value - The argument value.
    • type - The argument type (defaults to string if unspecified).

The available filters provided by PIM are:

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

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