blob: 34bb17391b7617fa6f981912b7c8f54222d1cb27 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
#pragma once
#include <sdbusplus/bus.hpp>
#include <sdbusplus/bus/match.hpp>
namespace openpower
{
namespace pels
{
using DBusValue = sdbusplus::message::variant<std::string>;
using DBusProperty = std::string;
using DBusInterface = std::string;
using DBusService = std::string;
using DBusPath = std::string;
using DBusInterfaceList = std::vector<DBusInterface>;
using DBusPropertyMap = std::map<DBusProperty, DBusValue>;
/**
* @class DataInterface
*
* An abstract interface class for gathering data about the system
* for use in PELs. Implemented this way to facilitate mocking.
*/
class DataInterfaceBase
{
public:
DataInterfaceBase() = default;
virtual ~DataInterfaceBase() = default;
DataInterfaceBase(const DataInterfaceBase&) = default;
DataInterfaceBase& operator=(const DataInterfaceBase&) = default;
DataInterfaceBase(DataInterfaceBase&&) = default;
DataInterfaceBase& operator=(DataInterfaceBase&&) = default;
/**
* @brief Pure virtual for returning the MTM
*
* @return string - The machine Type/Model string
*/
virtual std::string getMachineTypeModel() const = 0;
/**
* @brief Pure virtual for returning the machine SN
*
* @return string - The machine serial number
*/
virtual std::string getMachineSerialNumber() const = 0;
};
/**
* @class DataInterface
*
* Concrete implementation of DataInterfaceBase.
*/
class DataInterface : public DataInterfaceBase
{
public:
DataInterface() = delete;
~DataInterface() = default;
DataInterface(const DataInterface&) = default;
DataInterface& operator=(const DataInterface&) = default;
DataInterface(DataInterface&&) = default;
DataInterface& operator=(DataInterface&&) = default;
/**
* @brief Constructor
*
* @param[in] bus - The sdbusplus bus object
*/
explicit DataInterface(sdbusplus::bus::bus& bus);
/**
* @brief Returns the machine type/model value
*
* @return string - The machine Type/Model string
*/
std::string getMachineTypeModel() const override
{
return _machineTypeModel;
}
/**
* @brief Returns the machine SN
*
* @return string - The machine serial number
*/
std::string getMachineSerialNumber() const override
{
return _machineSerialNumber;
}
private:
/**
* @brief Reads the machine type/model and SN from D-Bus.
*
* Looks for them on the 'system' inventory object, and also
* places a properties changed watch on them to obtain any changes
* (or read them for the first time if the inventory isn't ready
* when this function runs.)
*/
void readMTMS();
/**
* @brief Finds the D-Bus service name that hosts the
* passed in path and interface.
*
* @param[in] objectPath - The D-Bus object path
* @param[in] interface - The D-Bus interface
*/
DBusService getService(const std::string& objectPath,
const std::string& interface);
/**
* @brief Wrapper for the 'GetAll' properties method call
*
* @param[in] service - The D-Bus service to call it on
* @param[in] objectPath - The D-Bus object path
* @param[in] interface - The interface to get the props on
*
* @return DBusPropertyMap - The property results
*/
DBusPropertyMap getAllProperties(const std::string& service,
const std::string& objectPath,
const std::string& interface);
/**
* @brief The properties changed callback for the Asset iface
* on the system inventory object.
*
* @param[in] msg - The sdbusplus message of the signal
*/
void sysAssetPropChanged(sdbusplus::message::message& msg);
/**
* @brief The machine type-model. Always kept up to date
*/
std::string _machineTypeModel;
/**
* @brief The machine serial number. Always kept up to date
*/
std::string _machineSerialNumber;
/**
* @brief The match object for the system path's properties
*/
std::unique_ptr<sdbusplus::bus::match_t> _sysInventoryPropMatch;
/**
* @brief The sdbusplus bus object for making D-Bus calls.
*/
sdbusplus::bus::bus& _bus;
};
} // namespace pels
} // namespace openpower
|
