blob: f4438745dcbc0e8fcf76734ba02cc4eb1438df8f [file] [log] [blame]
James Feist1df06a42019-04-11 14:23:04 -07001/*
2// Copyright (c) 2018 Intel Corporation
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15*/
Brad Bishop1fb9f3f2020-08-28 08:15:13 -040016/// \file EntityManager.hpp
James Feist1df06a42019-04-11 14:23:04 -070017
18#pragma once
19
James Feist733f7652019-11-13 14:32:29 -080020#include "Utils.hpp"
21
James Feist1df06a42019-04-11 14:23:04 -070022#include <systemd/sd-journal.h>
23
James Feist733f7652019-11-13 14:32:29 -080024#include <boost/container/flat_map.hpp>
James Feist1a996582019-05-14 15:10:06 -070025#include <nlohmann/json.hpp>
James Feist4dc617b2020-05-01 09:54:47 -070026#include <sdbusplus/asio/object_server.hpp>
James Feist8c505da2020-05-28 10:06:33 -070027
28#include <iostream>
29#include <list>
Andrew Jeffery666583b2021-12-01 15:50:12 +103030#include <optional>
James Feist1df06a42019-04-11 14:23:04 -070031#include <string>
32
Andrew Jefferyf5772d22022-04-12 22:05:30 +093033struct DBusDeviceDescriptor
34{
35 DBusInterface interface;
36 std::string path;
37};
38
39using FoundDevices = std::vector<DBusDeviceDescriptor>;
James Feist7d807752019-11-13 14:47:57 -080040
Andrew Jeffery47af65a2021-12-01 14:16:31 +103041struct CmpStr
42{
43 bool operator()(const char* a, const char* b) const
44 {
45 return std::strcmp(a, b) < 0;
46 }
47};
48
49// underscore T for collison with dbus c api
50enum class probe_type_codes
51{
52 FALSE_T,
53 TRUE_T,
54 AND,
55 OR,
56 FOUND,
57 MATCH_ONE
58};
59
Andrew Jeffery666583b2021-12-01 15:50:12 +103060using FoundProbeTypeT =
61 std::optional<boost::container::flat_map<const char*, probe_type_codes,
62 CmpStr>::const_iterator>;
63FoundProbeTypeT findProbeType(const std::string& probe);
64
James Feist733f7652019-11-13 14:32:29 -080065struct PerformScan : std::enable_shared_from_this<PerformScan>
66{
67
68 PerformScan(nlohmann::json& systemConfiguration,
69 nlohmann::json& missingConfigurations,
70 std::list<nlohmann::json>& configurations,
James Feist4dc617b2020-05-01 09:54:47 -070071 sdbusplus::asio::object_server& objServer,
72 std::function<void()>&& callback);
Andrew Jefferyae6c1a42022-04-19 15:44:42 +093073 void updateSystemConfiguration(const nlohmann::json& recordRef,
74 const std::string& probeName,
75 FoundDevices& foundDevices,
76 const MapperGetSubTreeResponse& dbusSubtree);
James Feist733f7652019-11-13 14:32:29 -080077 void run(void);
78 virtual ~PerformScan();
79 nlohmann::json& _systemConfiguration;
80 nlohmann::json& _missingConfigurations;
81 std::list<nlohmann::json> _configurations;
James Feist4dc617b2020-05-01 09:54:47 -070082 sdbusplus::asio::object_server& objServer;
83 std::function<void()> _callback;
James Feist733f7652019-11-13 14:32:29 -080084 bool _passed = false;
Andrew Jefferyac20bd92022-04-05 11:11:40 +093085 MapperGetSubTreeResponse dbusProbeObjects;
James Feist733f7652019-11-13 14:32:29 -080086 std::vector<std::string> passedProbes;
87};
88
James Feist7d807752019-11-13 14:47:57 -080089// this class finds the needed dbus fields and on destruction runs the probe
90struct PerformProbe : std::enable_shared_from_this<PerformProbe>
91{
Andrew Jefferyea4ff022022-04-21 12:31:40 +093092 PerformProbe(nlohmann::json& recordRef,
93 const std::vector<std::string>& probeCommand,
94 std::string probeName, std::shared_ptr<PerformScan>& scanPtr);
James Feist7d807752019-11-13 14:47:57 -080095 virtual ~PerformProbe();
96
Andrew Jefferyea4ff022022-04-21 12:31:40 +093097 nlohmann::json& recordRef;
James Feist7d807752019-11-13 14:47:57 -080098 std::vector<std::string> _probeCommand;
Andrew Jefferyea4ff022022-04-21 12:31:40 +093099 std::string probeName;
James Feist7d807752019-11-13 14:47:57 -0800100 std::shared_ptr<PerformScan> scan;
James Feist7d807752019-11-13 14:47:57 -0800101};
102
James Feist1a996582019-05-14 15:10:06 -0700103inline void logDeviceAdded(const nlohmann::json& record)
James Feist1df06a42019-04-11 14:23:04 -0700104{
105
James Feist1ffa4a42020-04-22 18:27:17 -0700106 if (!deviceHasLogging(record))
107 {
108 return;
109 }
James Feist1a996582019-05-14 15:10:06 -0700110 auto findType = record.find("Type");
111 auto findAsset =
112 record.find("xyz.openbmc_project.Inventory.Decorator.Asset");
113
Konstantin Aladysheve7ac9c92021-09-10 09:20:17 +0300114 std::string model = "Unknown";
James Feist1a996582019-05-14 15:10:06 -0700115 std::string type = "Unknown";
Konstantin Aladysheve7ac9c92021-09-10 09:20:17 +0300116 std::string sn = "Unknown";
James Feist1a996582019-05-14 15:10:06 -0700117
118 if (findType != record.end())
119 {
120 type = findType->get<std::string>();
121 }
122 if (findAsset != record.end())
123 {
124 auto findModel = findAsset->find("Model");
125 auto findSn = findAsset->find("SerialNumber");
126 if (findModel != findAsset->end())
127 {
128 model = findModel->get<std::string>();
129 }
130 if (findSn != findAsset->end())
131 {
James Feistf5125b02019-06-06 11:27:43 -0700132 const std::string* getSn = findSn->get_ptr<const std::string*>();
133 if (getSn != nullptr)
134 {
135 sn = *getSn;
136 }
137 else
138 {
139 sn = findSn->dump();
140 }
James Feist1a996582019-05-14 15:10:06 -0700141 }
142 }
143
Konstantin Aladysheve115c782022-01-11 18:56:31 +0300144 sd_journal_send("MESSAGE=%s", "Inventory Added", "PRIORITY=%i", LOG_INFO,
James Feist1df06a42019-04-11 14:23:04 -0700145 "REDFISH_MESSAGE_ID=%s", "OpenBMC.0.1.InventoryAdded",
James Feist1a996582019-05-14 15:10:06 -0700146 "REDFISH_MESSAGE_ARGS=%s,%s,%s", model.c_str(),
147 type.c_str(), sn.c_str(), NULL);
James Feist1df06a42019-04-11 14:23:04 -0700148}
149
James Feist1a996582019-05-14 15:10:06 -0700150inline void logDeviceRemoved(const nlohmann::json& record)
James Feist1df06a42019-04-11 14:23:04 -0700151{
James Feist1ffa4a42020-04-22 18:27:17 -0700152 if (!deviceHasLogging(record))
153 {
154 return;
155 }
James Feist1a996582019-05-14 15:10:06 -0700156 auto findType = record.find("Type");
157 auto findAsset =
158 record.find("xyz.openbmc_project.Inventory.Decorator.Asset");
159
Konstantin Aladysheve7ac9c92021-09-10 09:20:17 +0300160 std::string model = "Unknown";
James Feist1a996582019-05-14 15:10:06 -0700161 std::string type = "Unknown";
Konstantin Aladysheve7ac9c92021-09-10 09:20:17 +0300162 std::string sn = "Unknown";
James Feist1a996582019-05-14 15:10:06 -0700163
164 if (findType != record.end())
165 {
166 type = findType->get<std::string>();
167 }
168 if (findAsset != record.end())
169 {
170 auto findModel = findAsset->find("Model");
171 auto findSn = findAsset->find("SerialNumber");
172 if (findModel != findAsset->end())
173 {
174 model = findModel->get<std::string>();
175 }
176 if (findSn != findAsset->end())
177 {
James Feistf5125b02019-06-06 11:27:43 -0700178 const std::string* getSn = findSn->get_ptr<const std::string*>();
179 if (getSn != nullptr)
180 {
181 sn = *getSn;
182 }
183 else
184 {
185 sn = findSn->dump();
186 }
James Feist1a996582019-05-14 15:10:06 -0700187 }
188 }
James Feist1df06a42019-04-11 14:23:04 -0700189
Konstantin Aladysheve115c782022-01-11 18:56:31 +0300190 sd_journal_send("MESSAGE=%s", "Inventory Removed", "PRIORITY=%i", LOG_INFO,
James Feist1df06a42019-04-11 14:23:04 -0700191 "REDFISH_MESSAGE_ID=%s", "OpenBMC.0.1.InventoryRemoved",
James Feist1a996582019-05-14 15:10:06 -0700192 "REDFISH_MESSAGE_ARGS=%s,%s,%s", model.c_str(),
193 type.c_str(), sn.c_str(), NULL);
James Feist4dc617b2020-05-01 09:54:47 -0700194}