docs/architecture/object-mapper.md

4 mapper, is an OpenBMC application that attempts to ease the pain of using D-Bus
5 by providing APIs that help in discovering and associating other D-Bus objects.
9 - [Methods](#methods) - Provides D-Bus discovery related functionality.
10 - [Associations](#associations) - Associates two different objects with each
26 - path: object path
27 - param: interfaces - an optional list of interfaces to constrain the search to
31 - Map of service names to their interfaces
34 dbus-send --system --print-reply \
35 --dest=xyz.openbmc_project.ObjectMapper \
42          string "xyz.openbmc_project.Hwmon-1025936882.Hwmon1"
67 - param: subtree - the root of the tree. Using "/" will search the whole tree
68 - param: depth - the maximum depth of the tree past the root to search. Use 0 to
70 - param: interfaces - an optional list of interfaces to constrain the search to
74 - Map of object paths to a map of service names to their interfaces
77 dbus-send --system --print-reply \
78 --dest=xyz.openbmc_project.ObjectMapper \
88                string "xyz.openbmc_project.Hwmon-1040041051.Hwmon1"
101                string "xyz.openbmc_project.Hwmon-1025936882.Hwmon1"
121 subtree that implement a certain interface and an endpoint of the input
129 - param: associationPath - the path to look for the association endpoints.
130 - param: subtree - the root of the tree. Using "/" will search the whole tree
131 - param: depth - the maximum depth of the tree past the root to search. Use 0 to
133 - param: interfaces - an optional list of interfaces to constrain the search to
137 - Map of object paths to a map of service names to their interfaces that is in
141 dbus-send --system --print-reply \
142 --dest=xyz.openbmc_project.ObjectMapper \
153                string "xyz.openbmc_project.Hwmon-1040041051.Hwmon1"
166                string "xyz.openbmc_project.Hwmon-1025936882.Hwmon1"
179 busctl get-property  xyz.openbmc_project.ObjectMapper \
190 endpoint of the input associationPath.
195 subtree that implement certain interfaces and endpoints that end by input `id`.
203 - param: id - The leaf name of the dbus path, uniquely identifying a specific
205 - param: objectPath - The object path for which the result should be fetched.
206 - param: subtreeInterfaces - a list of interfaces to constrain the search to
207 - param: association - The endpoint association.
208 - param: endpointInterfaces - An array of interfaces used to filter associated
213 - Map of object paths to a map of service names to their interfaces that are in
219 dbus-send --system --print-reply \
220 --dest=xyz.openbmc_project.ObjectMapper \
262 busctl get-property  xyz.openbmc_project.ObjectMapper \
273 endpoint of the input associationPath.
281 - param: subtree - the root of the tree. Using "/" will search the whole tree
282 - param: depth - the maximum depth of the tree past the root to search. Use 0 to
284 - param: interfaces - an optional list of interfaces to constrain the search to
288 - array of object paths in that subtree
291 dbus-send --system --print-reply \
292 --dest=xyz.openbmc_project.ObjectMapper \
315 - param: associationPath - the path to look for the association endpoints.
316 - param: subtree - the root of the tree. Using "/" will search the whole tree
317 - param: depth - the maximum depth of the tree past the root to search. Use 0 to
319 - param: interfaces - an optional list of interfaces to constrain the search to
323 - array of object paths in that subtree that is in the associated endpoints
326 dbus-send --system --print-reply \
327 --dest=xyz.openbmc_project.ObjectMapper \
340 busctl get-property  xyz.openbmc_project.ObjectMapper \
352 input associationPath.
360 - param: id - The leaf name of the dbus path, uniquely identifying a specific
362 - param: objectPath - The object path for which the result should be fetched.
363 - param: subtreeInterfaces - a list of interfaces to constrain the search to
364 - param: association - The endpoint association.
365 - param: endpointInterfaces - An array of interfaces used to filter associated
370 - Map of object paths to a map of service names to their interfaces that are in
376 dbus-send --system --print-reply \
377 --dest=xyz.openbmc_project.ObjectMapper \
394 busctl get-property  xyz.openbmc_project.ObjectMapper \
405 input associationPath.
415 - param: path - the object path to find the ancestors of
416 - param: interfaces - an optional list of interfaces to constrain the search to
420 - A map of object paths to a map of services names to their interfaces
424 dbus-send --system --print-reply \
425 --dest=xyz.openbmc_project.ObjectMapper \
474 Associations are special D-Bus objects created by the mapper to associate two
486 - forward: this is the name of the forward association object
487 - reverse: this is the name of the reverse association object
488 - object path: this is the other object to associate with
506 So, `pathA/foo->endpoints` will contain `pathB`, and `pathB/bar->endpoints` will
516 addition, if the endpoint path is removed from D-Bus, in this case `pathB`, then
558 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/ObjectMap…