blob: a022fea04924a6f5b3aebe9c1110f8d8c4d693bd [file] [log] [blame]
Matthew Barthb86374d2017-04-12 10:57:19 -05001#pragma once
2
Patrick Venture3d6d3182018-08-31 09:33:09 -07003#include "tupleref.hpp"
4
Brad Bishop186aa672017-05-15 22:27:57 -04005#include <experimental/any>
Matthew Barthb86374d2017-04-12 10:57:19 -05006#include <sdbusplus/message.hpp>
Brad Bishop186aa672017-05-15 22:27:57 -04007
8namespace any_ns = std::experimental;
Matthew Barthb86374d2017-04-12 10:57:19 -05009
10namespace phosphor
11{
12namespace dbus
13{
14namespace monitoring
15{
16
Matt Spinlerdf1b7cf2017-10-31 14:17:23 -050017constexpr auto MAPPER_BUSNAME = "xyz.openbmc_project.ObjectMapper";
18constexpr auto MAPPER_PATH = "/xyz/openbmc_project/object_mapper";
19constexpr auto MAPPER_INTERFACE = "xyz.openbmc_project.ObjectMapper";
Matt Spinler1abcb062018-02-26 09:14:31 -060020
Brad Bishopd1eac882018-03-29 10:34:05 -040021// PropertyIndex::key_type fields
Ratan Gupta90bfaea2017-10-06 20:56:31 +053022constexpr auto pathIndex = 0;
Matt Spinler1abcb062018-02-26 09:14:31 -060023constexpr auto interfaceIndex = 1;
Ratan Gupta90bfaea2017-10-06 20:56:31 +053024constexpr auto propertyIndex = 2;
Matt Spinler1abcb062018-02-26 09:14:31 -060025
Brad Bishopd1eac882018-03-29 10:34:05 -040026// PropertyIndex::mapped_type fields
Matt Spinler1abcb062018-02-26 09:14:31 -060027constexpr auto pathMetaIndex = 0;
28constexpr auto propertyMetaIndex = 1;
Matt Spinlerabe43ab2018-02-19 13:34:43 -060029constexpr auto storageIndex = 2;
Matt Spinler1abcb062018-02-26 09:14:31 -060030
Brad Bishopd1eac882018-03-29 10:34:05 -040031// ConfigPropertyStorage fields
Matt Spinlerabe43ab2018-02-19 13:34:43 -060032constexpr auto valueIndex = 0;
Matt Spinler1abcb062018-02-26 09:14:31 -060033constexpr auto resultIndex = 1;
Matt Spinlerdf1b7cf2017-10-31 14:17:23 -050034
Ratan Guptaa45e0862018-02-21 19:03:13 +053035enum class Context
36{
37 START,
38 SIGNAL,
39};
40
Brad Bishop186aa672017-05-15 22:27:57 -040041/** @brief A map with references as keys. */
42template <typename Key, typename Value>
43using RefKeyMap = std::map<std::reference_wrapper<Key>, Value, std::less<Key>>;
44
45/** @brief A map with a tuple of references as keys. */
Brad Bishopd1eac882018-03-29 10:34:05 -040046template <typename Value, typename... Keys>
Brad Bishop186aa672017-05-15 22:27:57 -040047using TupleRefMap = std::map<TupleOfRefs<Keys...>, Value, TupleOfRefsLess>;
48
49/** @brief A vector of references. */
Patrick Venture3d6d3182018-08-31 09:33:09 -070050template <typename T>
51using RefVector = std::vector<std::reference_wrapper<T>>;
Brad Bishop186aa672017-05-15 22:27:57 -040052
53/** @brief
54 *
55 * The mapper has a defect such that it provides strings
56 * rather than object paths. Use an alias for easy refactoring
57 * when the mapper is fixed.
58 */
59using MapperPath = std::string;
60
61/** @brief ObjectManager.InterfacesAdded signal signature alias. */
62template <typename T>
Brad Bishopd1eac882018-03-29 10:34:05 -040063using InterfacesAdded =
Patrick Williams35b4f332020-05-13 17:53:09 -050064 std::map<std::string, std::map<std::string, std::variant<T>>>;
65using Value = std::variant<bool, uint8_t, int16_t, uint16_t, int32_t, uint32_t,
66 int64_t, uint64_t, std::string>;
Marri Devender Rao70aafbb2018-04-12 01:11:48 -050067
68/** @brief ObjectManager.InterfacesAdded signal signature alias. */
69using Interface = std::string;
70using Property = std::string;
71using PathInterfacesAdded = std::map<Interface, std::map<Property, Value>>;
Brad Bishop186aa672017-05-15 22:27:57 -040072
73/** @brief ObjectMapper.GetObject response signature alias. */
74using GetObject = std::map<MapperPath, std::vector<std::string>>;
75
76/** @brief Properties.GetAll response signature alias. */
77template <typename T>
Patrick Williams35b4f332020-05-13 17:53:09 -050078using PropertiesChanged = std::map<std::string, std::variant<T>>;
Brad Bishop186aa672017-05-15 22:27:57 -040079
Brad Bishop4b916f12017-05-23 18:06:38 -040080/** @brief Lookup index for properties . */
81// *INDENT-OFF*
Brad Bishopd1eac882018-03-29 10:34:05 -040082using PropertyIndex =
83 TupleRefMap<TupleOfRefs<const std::string, const std::string,
84 std::tuple<any_ns::any, any_ns::any>>,
85 const std::string, const std::string, const std::string>;
Brad Bishop4b916f12017-05-23 18:06:38 -040086// *INDENT-ON*
Brad Bishop893b3482017-05-23 18:17:25 -040087
88/** @brief Convert some C++ types to others.
89 *
90 * Remove type decorators to reduce template specializations.
91 *
92 * 1. Remove references.
93 * 2. Remove 'const' and 'volatile'.
94 */
Patrick Venture3d6d3182018-08-31 09:33:09 -070095template <typename T>
96struct Downcast
Brad Bishop893b3482017-05-23 18:17:25 -040097{
98 using Type = std::remove_cv_t<std::remove_reference_t<T>>;
99};
Patrick Venture3d6d3182018-08-31 09:33:09 -0700100template <typename T>
101using DowncastType = typename Downcast<T>::Type;
Brad Bishop893b3482017-05-23 18:17:25 -0400102
Matthew Barthb86374d2017-04-12 10:57:19 -0500103} // namespace monitoring
104} // namespace dbus
105} // namespace phosphor