1 #pragma once
2 
3 #include <sdbusplus/bus.hpp>
4 
5 #include <optional>
6 #include <string>
7 #include <tuple>
8 
9 namespace open_power
10 {
11 namespace occ
12 {
13 namespace utils
14 {
15 
16 constexpr auto MAPPER_BUSNAME = "xyz.openbmc_project.ObjectMapper";
17 constexpr auto MAPPER_OBJ_PATH = "/xyz/openbmc_project/object_mapper";
18 constexpr auto MAPPER_IFACE = "xyz.openbmc_project.ObjectMapper";
19 constexpr auto DBUS_PROPERTY_IFACE = "org.freedesktop.DBus.Properties";
20 
21 // The value of the property(type: variant, contains some basic types)
22 using PropertyValue = std::variant<uint32_t, bool, double, std::string>;
23 
24 /** @brief Get the bus connection. */
25 static auto& getBus()
26 {
27     static auto bus = sdbusplus::bus::new_default();
28     return bus;
29 }
30 
31 /**
32  *  @brief Get service name by the path and interface of the DBus.
33  *
34  *  @param[in] path      -  D-Bus object path
35  *  @param[in] interface -  D-Bus Interface
36  *
37  *  @return std::string  -  the D-Bus service name
38  *
39  */
40 const std::string getService(const std::string& path,
41                              const std::string& interface);
42 
43 /** @brief Get property(type: variant)
44  *
45  *  @param[in] objectPath       -   D-Bus object path
46  *  @param[in] interface        -   D-Bus interface
47  *  @param[in] propertyName     -   D-Bus property name
48  *
49  *  @return The value of the property(type: variant)
50  *
51  *  @throw sdbusplus::exception_t when it fails
52  */
53 const PropertyValue getProperty(const std::string& objectPath,
54                                 const std::string& interface,
55                                 const std::string& propertyName);
56 
57 /**
58  * @brief Sets a given object's property value
59  *
60  * @param[in] object - Name of the object containing the property
61  * @param[in] interface - Interface name containing the property
62  * @param[in] property - Property name
63  * @param[in] value - Property value
64  */
65 void setProperty(const std::string& objectPath, const std::string& interface,
66                  const std::string& propertyName, PropertyValue&& value);
67 
68 /** @brief Get subtree paths
69  *
70  *  @param[in] interfaces -   D-Bus interfaces
71  *  @param[in] path       -   D-Bus object path
72  *
73  *  @return The D-Bus paths from the GetSubTree method
74  *
75  *  @throw sdbusplus::exception_t when it fails
76  */
77 std::vector<std::string>
78     getSubtreePaths(const std::vector<std::string>& interfaces,
79                     const std::string& path = "/");
80 
81 /**
82  * @brief Get the D-Bus service and object path for an interface
83  *
84  * @param[in] interface - D-Bus interface name
85  * @param[in,out] path  - D-Bus object path
86  *
87  * @return D-Bus service name
88  */
89 std::string getServiceUsingSubTree(const std::string& interface,
90                                    std::string& path);
91 
92 /**
93  * @brief Get status of the host
94  *
95  * @return true is the host is running, else false
96  */
97 bool isHostRunning();
98 
99 } // namespace utils
100 } // namespace occ
101 } // namespace open_power
102