blob: 083178f95b0d46c3d1fa8fdd8df784fc559870b6 [file] [log] [blame]
Vijay Khemkaabcc94f2020-08-11 15:27:44 -07001#include "virtualSensor.hpp"
2
3#include "config.hpp"
4
Patrick Williams82b39c62021-07-28 16:22:27 -05005#include <phosphor-logging/lg2.hpp>
Vijay Khemkaabcc94f2020-08-11 15:27:44 -07006
7#include <fstream>
Vijay Khemkaabcc94f2020-08-11 15:27:44 -07008
9static constexpr bool DEBUG = false;
10static constexpr auto busName = "xyz.openbmc_project.VirtualSensor";
11static constexpr auto sensorDbusPath = "/xyz/openbmc_project/sensors/";
Rashmica Guptae7efe132021-07-27 19:42:11 +100012static constexpr auto entityManagerBusName =
13 "xyz.openbmc_project.EntityManager";
14static constexpr auto vsThresholdsIfaceSuffix = ".Thresholds";
Rashmica Gupta304fd0e2021-08-10 16:50:44 +100015static constexpr std::array<const char*, 1> calculationIfaces = {
16 "xyz.openbmc_project.Configuration.ModifiedMedian"};
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +100017static constexpr auto defaultHysteresis = 0;
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070018
Patrick Williams82b39c62021-07-28 16:22:27 -050019PHOSPHOR_LOG2_USING_WITH_FLAGS;
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070020
Vijay Khemka51f898e2020-09-09 22:24:18 -070021int handleDbusSignal(sd_bus_message* msg, void* usrData, sd_bus_error*)
22{
23 if (usrData == nullptr)
24 {
25 throw std::runtime_error("Invalid match");
26 }
27
Patrick Williams8e11ccc2022-07-22 19:26:57 -050028 auto sdbpMsg = sdbusplus::message_t(msg);
Vijay Khemka51f898e2020-09-09 22:24:18 -070029 std::string msgIfce;
30 std::map<std::string, std::variant<int64_t, double, bool>> msgData;
31
32 sdbpMsg.read(msgIfce, msgData);
33
34 if (msgData.find("Value") != msgData.end())
35 {
36 using namespace phosphor::virtualSensor;
37 VirtualSensor* obj = static_cast<VirtualSensor*>(usrData);
38 // TODO(openbmc/phosphor-virtual-sensor#1): updateVirtualSensor should
39 // be changed to take the information we got from the signal, to avoid
40 // having to do numerous dbus queries.
41 obj->updateVirtualSensor();
42 }
43 return 0;
44}
45
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070046namespace phosphor
47{
48namespace virtualSensor
49{
50
51void printParams(const VirtualSensor::ParamMap& paramMap)
52{
53 for (const auto& p : paramMap)
54 {
55 const auto& p1 = p.first;
56 const auto& p2 = p.second;
57 auto val = p2->getParamValue();
Patrick Williamsfbd71452021-08-30 06:59:46 -050058 debug("Parameter: {PARAM} = {VALUE}", "PARAM", p1, "VALUE", val);
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070059 }
60}
61
62double SensorParam::getParamValue()
63{
64 switch (paramType)
65 {
66 case constParam:
67 return value;
68 break;
Vijay Khemka7452a862020-08-11 16:01:23 -070069 case dbusParam:
70 return dbusSensor->getSensorValue();
71 break;
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070072 default:
73 throw std::invalid_argument("param type not supported");
74 }
75}
76
Lei YU0fcf0e12021-06-04 11:14:17 +080077using AssociationList =
78 std::vector<std::tuple<std::string, std::string, std::string>>;
79
80AssociationList getAssociationsFromJson(const Json& j)
81{
82 AssociationList assocs{};
83 try
84 {
85 j.get_to(assocs);
86 }
87 catch (const std::exception& ex)
88 {
Patrick Williams82b39c62021-07-28 16:22:27 -050089 error("Failed to parse association: {ERROR}", "ERROR", ex);
Lei YU0fcf0e12021-06-04 11:14:17 +080090 }
91 return assocs;
92}
93
Rashmica Guptae7efe132021-07-27 19:42:11 +100094template <typename U>
95struct VariantToNumber
96{
97 template <typename T>
98 U operator()(const T& t) const
99 {
100 if constexpr (std::is_convertible<T, U>::value)
101 {
102 return static_cast<U>(t);
103 }
104 throw std::invalid_argument("Invalid number type in config\n");
105 }
106};
107
108template <typename U>
109U getNumberFromConfig(const PropertyMap& map, const std::string& name,
Jiaqing Zhao190f6d02022-05-21 23:26:15 +0800110 bool required,
111 U defaultValue = std::numeric_limits<U>::quiet_NaN())
Rashmica Guptae7efe132021-07-27 19:42:11 +1000112{
113 if (auto itr = map.find(name); itr != map.end())
114 {
115 return std::visit(VariantToNumber<U>(), itr->second);
116 }
117 else if (required)
118 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500119 error("Required field {NAME} missing in config", "NAME", name);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000120 throw std::invalid_argument("Required field missing in config");
121 }
Jiaqing Zhao190f6d02022-05-21 23:26:15 +0800122 return defaultValue;
Rashmica Guptae7efe132021-07-27 19:42:11 +1000123}
124
125bool isCalculationType(const std::string& interface)
126{
127 auto itr = std::find(calculationIfaces.begin(), calculationIfaces.end(),
128 interface);
129 if (itr != calculationIfaces.end())
130 {
131 return true;
132 }
133 return false;
134}
135
136const std::string getThresholdType(const std::string& direction,
Rashmica Gupta05b1d412021-11-03 12:01:36 +1100137 const std::string& severity)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000138{
Rashmica Guptae7efe132021-07-27 19:42:11 +1000139 std::string suffix;
Rashmica Guptae7efe132021-07-27 19:42:11 +1000140
141 if (direction == "less than")
142 {
143 suffix = "Low";
144 }
145 else if (direction == "greater than")
146 {
147 suffix = "High";
148 }
149 else
150 {
151 throw std::invalid_argument(
152 "Invalid threshold direction specified in entity manager");
153 }
Rashmica Gupta05b1d412021-11-03 12:01:36 +1100154 return severity + suffix;
155}
156
157std::string getSeverityField(const PropertyMap& propertyMap)
158{
159 static const std::array thresholdTypes{"Warning", "Critical",
160 "PerformanceLoss", "SoftShutdown",
161 "HardShutdown"};
162
163 std::string severity;
164 if (auto itr = propertyMap.find("Severity"); itr != propertyMap.end())
165 {
166 /* Severity should be a string, but can be an unsigned int */
167 if (std::holds_alternative<std::string>(itr->second))
168 {
169 severity = std::get<std::string>(itr->second);
170 if (0 == std::ranges::count(thresholdTypes, severity))
171 {
172 throw std::invalid_argument(
173 "Invalid threshold severity specified in entity manager");
174 }
175 }
176 else
177 {
178 auto sev =
179 getNumberFromConfig<uint64_t>(propertyMap, "Severity", true);
180 /* Checking bounds ourselves so we throw invalid argument on
181 * invalid user input */
182 if (sev >= thresholdTypes.size())
183 {
184 throw std::invalid_argument(
185 "Invalid threshold severity specified in entity manager");
186 }
187 severity = thresholdTypes.at(sev);
188 }
189 }
190 return severity;
Rashmica Guptae7efe132021-07-27 19:42:11 +1000191}
192
193void parseThresholds(Json& thresholds, const PropertyMap& propertyMap)
194{
195 std::string direction;
196
Rashmica Guptae7efe132021-07-27 19:42:11 +1000197 auto value = getNumberFromConfig<double>(propertyMap, "Value", true);
198
Rashmica Gupta05b1d412021-11-03 12:01:36 +1100199 auto severity = getSeverityField(propertyMap);
200
201 if (auto itr = propertyMap.find("Direction"); itr != propertyMap.end())
Rashmica Guptae7efe132021-07-27 19:42:11 +1000202 {
203 direction = std::get<std::string>(itr->second);
204 }
205
206 auto threshold = getThresholdType(direction, severity);
207 thresholds[threshold] = value;
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000208
209 auto hysteresis =
210 getNumberFromConfig<double>(propertyMap, "Hysteresis", false);
211 if (hysteresis != std::numeric_limits<double>::quiet_NaN())
212 {
213 thresholds[threshold + "Hysteresis"] = hysteresis;
214 }
Rashmica Guptae7efe132021-07-27 19:42:11 +1000215}
216
217void VirtualSensor::parseConfigInterface(const PropertyMap& propertyMap,
218 const std::string& sensorType,
219 const std::string& interface)
220{
221 /* Parse sensors / DBus params */
222 if (auto itr = propertyMap.find("Sensors"); itr != propertyMap.end())
223 {
224 auto sensors = std::get<std::vector<std::string>>(itr->second);
225 for (auto sensor : sensors)
226 {
227 std::replace(sensor.begin(), sensor.end(), ' ', '_');
228 auto sensorObjPath = sensorDbusPath + sensorType + "/" + sensor;
229
230 auto paramPtr =
231 std::make_unique<SensorParam>(bus, sensorObjPath, this);
232 symbols.create_variable(sensor);
233 paramMap.emplace(std::move(sensor), std::move(paramPtr));
234 }
235 }
236 /* Get expression string */
237 if (!isCalculationType(interface))
238 {
239 throw std::invalid_argument("Invalid expression in interface");
240 }
241 exprStr = interface;
242
243 /* Get optional min and max input and output values */
244 ValueIface::maxValue(
245 getNumberFromConfig<double>(propertyMap, "MaxValue", false));
246 ValueIface::minValue(
247 getNumberFromConfig<double>(propertyMap, "MinValue", false));
248 maxValidInput =
Jiaqing Zhao190f6d02022-05-21 23:26:15 +0800249 getNumberFromConfig<double>(propertyMap, "MaxValidInput", false,
250 std::numeric_limits<double>::infinity());
Rashmica Guptae7efe132021-07-27 19:42:11 +1000251 minValidInput =
Jiaqing Zhao190f6d02022-05-21 23:26:15 +0800252 getNumberFromConfig<double>(propertyMap, "MinValidInput", false,
253 -std::numeric_limits<double>::infinity());
Rashmica Guptae7efe132021-07-27 19:42:11 +1000254}
255
Matt Spinlerce675222021-01-14 16:38:09 -0600256void VirtualSensor::initVirtualSensor(const Json& sensorConfig,
257 const std::string& objPath)
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700258{
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700259 static const Json empty{};
260
261 /* Get threshold values if defined in config */
262 auto threshold = sensorConfig.value("Threshold", empty);
Matt Spinlerf15189e2021-01-15 10:13:28 -0600263
Rashmica Gupta3e999192021-06-09 16:17:04 +1000264 createThresholds(threshold, objPath);
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700265
Harvey Wuf6443742021-04-09 16:47:36 +0800266 /* Get MaxValue, MinValue setting if defined in config */
267 auto confDesc = sensorConfig.value("Desc", empty);
268 if (auto maxConf = confDesc.find("MaxValue");
269 maxConf != confDesc.end() && maxConf->is_number())
270 {
271 ValueIface::maxValue(maxConf->get<double>());
272 }
273 if (auto minConf = confDesc.find("MinValue");
274 minConf != confDesc.end() && minConf->is_number())
275 {
276 ValueIface::minValue(minConf->get<double>());
277 }
278
Lei YU0fcf0e12021-06-04 11:14:17 +0800279 /* Get optional association */
280 auto assocJson = sensorConfig.value("Associations", empty);
281 if (!assocJson.empty())
282 {
283 auto assocs = getAssociationsFromJson(assocJson);
284 if (!assocs.empty())
285 {
286 associationIface =
287 std::make_unique<AssociationObject>(bus, objPath.c_str());
288 associationIface->associations(assocs);
289 }
290 }
291
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700292 /* Get expression string */
Patrick Williams03c4c8e2022-04-14 22:19:44 -0500293 static constexpr auto exprKey = "Expression";
294 if (sensorConfig.contains(exprKey))
295 {
Patrick Williamsa9596782022-04-15 10:20:07 -0500296 auto& ref = sensorConfig.at(exprKey);
Patrick Williams03c4c8e2022-04-14 22:19:44 -0500297 if (ref.is_array())
298 {
299 exprStr = std::string{};
300 for (auto& s : ref)
301 {
302 exprStr += s;
303 }
304 }
305 else if (ref.is_string())
306 {
307 exprStr = std::string{ref};
308 }
309 }
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700310
311 /* Get all the parameter listed in configuration */
312 auto params = sensorConfig.value("Params", empty);
313
314 /* Check for constant parameter */
315 const auto& consParams = params.value("ConstParam", empty);
316 if (!consParams.empty())
317 {
318 for (auto& j : consParams)
319 {
320 if (j.find("ParamName") != j.end())
321 {
322 auto paramPtr = std::make_unique<SensorParam>(j["Value"]);
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700323 std::string name = j["ParamName"];
324 symbols.create_variable(name);
325 paramMap.emplace(std::move(name), std::move(paramPtr));
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700326 }
327 else
328 {
329 /* Invalid configuration */
330 throw std::invalid_argument(
331 "ParamName not found in configuration");
332 }
333 }
334 }
335
Vijay Khemka7452a862020-08-11 16:01:23 -0700336 /* Check for dbus parameter */
337 auto dbusParams = params.value("DbusParam", empty);
338 if (!dbusParams.empty())
339 {
340 for (auto& j : dbusParams)
341 {
342 /* Get parameter dbus sensor descriptor */
343 auto desc = j.value("Desc", empty);
344 if ((!desc.empty()) && (j.find("ParamName") != j.end()))
345 {
346 std::string sensorType = desc.value("SensorType", "");
347 std::string name = desc.value("Name", "");
348
349 if (!sensorType.empty() && !name.empty())
350 {
George Liu1204b432021-12-29 17:24:48 +0800351 auto path = sensorDbusPath + sensorType + "/" + name;
Vijay Khemka7452a862020-08-11 16:01:23 -0700352
Vijay Khemka51f898e2020-09-09 22:24:18 -0700353 auto paramPtr =
George Liu1204b432021-12-29 17:24:48 +0800354 std::make_unique<SensorParam>(bus, path, this);
355 std::string paramName = j["ParamName"];
356 symbols.create_variable(paramName);
357 paramMap.emplace(std::move(paramName), std::move(paramPtr));
Vijay Khemka7452a862020-08-11 16:01:23 -0700358 }
359 }
360 }
361 }
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700362
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700363 symbols.add_constants();
Matt Spinler9f1ef4f2020-11-09 15:59:11 -0600364 symbols.add_package(vecopsPackage);
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700365 expression.register_symbol_table(symbols);
366
367 /* parser from exprtk */
368 exprtk::parser<double> parser{};
Matt Spinlerddc6dcd2020-11-09 11:16:31 -0600369 if (!parser.compile(exprStr, expression))
370 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500371 error("Expression compilation failed");
Matt Spinlerddc6dcd2020-11-09 11:16:31 -0600372
373 for (std::size_t i = 0; i < parser.error_count(); ++i)
374 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500375 auto err = parser.get_error(i);
376 error("Error parsing token at {POSITION}: {ERROR}", "POSITION",
377 err.token.position, "TYPE",
378 exprtk::parser_error::to_str(err.mode), "ERROR",
379 err.diagnostic);
Matt Spinlerddc6dcd2020-11-09 11:16:31 -0600380 }
381 throw std::runtime_error("Expression compilation failed");
382 }
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700383
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700384 /* Print all parameters for debug purpose only */
385 if (DEBUG)
386 printParams(paramMap);
387}
388
Tao Lindc777012022-07-27 20:41:46 +0800389void VirtualSensor::createAssociation(const std::string& objPath,
390 const std::string& entityPath)
391{
392 if (objPath.empty() || entityPath.empty())
393 {
394 return;
395 }
396
397 std::filesystem::path p(entityPath);
398 auto assocsDbus =
399 AssociationList{{"chassis", "all_sensors", p.parent_path().string()}};
400 associationIface =
401 std::make_unique<AssociationObject>(bus, objPath.c_str());
402 associationIface->associations(assocsDbus);
403}
404
Rashmica Guptae7efe132021-07-27 19:42:11 +1000405void VirtualSensor::initVirtualSensor(const InterfaceMap& interfaceMap,
406 const std::string& objPath,
407 const std::string& sensorType,
408 const std::string& calculationIface)
409{
410 Json thresholds;
411 const std::string vsThresholdsIntf =
412 calculationIface + vsThresholdsIfaceSuffix;
413
414 for (const auto& [interface, propertyMap] : interfaceMap)
415 {
416 /* Each threshold is on it's own interface with a number as a suffix
417 * eg xyz.openbmc_project.Configuration.ModifiedMedian.Thresholds1 */
418 if (interface.find(vsThresholdsIntf) != std::string::npos)
419 {
420 parseThresholds(thresholds, propertyMap);
421 }
422 else if (interface == calculationIface)
423 {
424 parseConfigInterface(propertyMap, sensorType, interface);
425 }
426 }
427
428 createThresholds(thresholds, objPath);
429 symbols.add_constants();
430 symbols.add_package(vecopsPackage);
431 expression.register_symbol_table(symbols);
432
Tao Lindc777012022-07-27 20:41:46 +0800433 createAssociation(objPath, entityPath);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000434 /* Print all parameters for debug purpose only */
435 if (DEBUG)
436 {
437 printParams(paramMap);
438 }
439}
440
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700441void VirtualSensor::setSensorValue(double value)
442{
Patrick Williams543bf662021-04-29 09:03:53 -0500443 value = std::clamp(value, ValueIface::minValue(), ValueIface::maxValue());
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700444 ValueIface::value(value);
445}
446
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000447double VirtualSensor::calculateValue(const std::string& calculation,
448 const VirtualSensor::ParamMap& paramMap)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000449{
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000450 auto itr = std::find(calculationIfaces.begin(), calculationIfaces.end(),
451 calculation);
452 if (itr == calculationIfaces.end())
453 {
454 return std::numeric_limits<double>::quiet_NaN();
455 }
456 else if (calculation == "xyz.openbmc_project.Configuration.ModifiedMedian")
457 {
458 return calculateModifiedMedianValue(paramMap);
459 }
Rashmica Guptae7efe132021-07-27 19:42:11 +1000460 return std::numeric_limits<double>::quiet_NaN();
461}
462
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000463bool VirtualSensor::sensorInRange(double value)
464{
465 if (value <= this->maxValidInput && value >= this->minValidInput)
466 {
467 return true;
468 }
469 return false;
470}
471
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700472void VirtualSensor::updateVirtualSensor()
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700473{
474 for (auto& param : paramMap)
475 {
476 auto& name = param.first;
477 auto& data = param.second;
478 if (auto var = symbols.get_variable(name))
479 {
480 var->ref() = data->getParamValue();
481 }
482 else
483 {
484 /* Invalid parameter */
485 throw std::invalid_argument("ParamName not found in symbols");
486 }
487 }
Rashmica Guptae7efe132021-07-27 19:42:11 +1000488 auto itr =
489 std::find(calculationIfaces.begin(), calculationIfaces.end(), exprStr);
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000490 auto val = (itr == calculationIfaces.end())
491 ? expression.value()
492 : calculateValue(exprStr, paramMap);
Vijay Khemka32a71562020-09-10 15:29:18 -0700493
494 /* Set sensor value to dbus interface */
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700495 setSensorValue(val);
Vijay Khemka32a71562020-09-10 15:29:18 -0700496
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700497 if (DEBUG)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000498 {
Patrick Williamsfbd71452021-08-30 06:59:46 -0500499 debug("Sensor {NAME} = {VALUE}", "NAME", this->name, "VALUE", val);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000500 }
Vijay Khemka32a71562020-09-10 15:29:18 -0700501
Matt Spinler8f5e6112021-01-15 10:44:32 -0600502 /* Check sensor thresholds and log required message */
Matt Spinlerb306b032021-02-01 10:05:46 -0600503 checkThresholds(val, perfLossIface);
Patrick Williamsfdb826d2021-01-20 14:37:53 -0600504 checkThresholds(val, warningIface);
505 checkThresholds(val, criticalIface);
506 checkThresholds(val, softShutdownIface);
507 checkThresholds(val, hardShutdownIface);
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700508}
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700509
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000510double VirtualSensor::calculateModifiedMedianValue(
511 const VirtualSensor::ParamMap& paramMap)
512{
513 std::vector<double> values;
514
515 for (auto& param : paramMap)
516 {
517 auto& name = param.first;
518 if (auto var = symbols.get_variable(name))
519 {
520 if (!sensorInRange(var->ref()))
521 {
522 continue;
523 }
524 values.push_back(var->ref());
525 }
526 }
527
528 size_t size = values.size();
529 std::sort(values.begin(), values.end());
530 switch (size)
531 {
532 case 2:
533 /* Choose biggest value */
534 return values.at(1);
535 case 0:
536 return std::numeric_limits<double>::quiet_NaN();
537 default:
538 /* Choose median value */
539 if (size % 2 == 0)
540 {
541 // Average of the two middle values
542 return (values.at(size / 2) + values.at(size / 2 - 1)) / 2;
543 }
544 else
545 {
546 return values.at((size - 1) / 2);
547 }
548 }
549}
550
Rashmica Gupta3e999192021-06-09 16:17:04 +1000551void VirtualSensor::createThresholds(const Json& threshold,
552 const std::string& objPath)
553{
554 if (threshold.empty())
555 {
556 return;
557 }
558 // Only create the threshold interfaces if
559 // at least one of their values is present.
560 if (threshold.contains("CriticalHigh") || threshold.contains("CriticalLow"))
561 {
562 criticalIface =
563 std::make_unique<Threshold<CriticalObject>>(bus, objPath.c_str());
564
565 criticalIface->criticalHigh(threshold.value(
566 "CriticalHigh", std::numeric_limits<double>::quiet_NaN()));
567 criticalIface->criticalLow(threshold.value(
568 "CriticalLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000569 criticalIface->setHighHysteresis(
570 threshold.value("CriticalHighHysteresis", defaultHysteresis));
571 criticalIface->setLowHysteresis(
572 threshold.value("CriticalLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000573 }
574
575 if (threshold.contains("WarningHigh") || threshold.contains("WarningLow"))
576 {
577 warningIface =
578 std::make_unique<Threshold<WarningObject>>(bus, objPath.c_str());
579
580 warningIface->warningHigh(threshold.value(
581 "WarningHigh", std::numeric_limits<double>::quiet_NaN()));
582 warningIface->warningLow(threshold.value(
583 "WarningLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000584 warningIface->setHighHysteresis(
585 threshold.value("WarningHighHysteresis", defaultHysteresis));
586 warningIface->setLowHysteresis(
587 threshold.value("WarningLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000588 }
589
590 if (threshold.contains("HardShutdownHigh") ||
591 threshold.contains("HardShutdownLow"))
592 {
593 hardShutdownIface = std::make_unique<Threshold<HardShutdownObject>>(
594 bus, objPath.c_str());
595
596 hardShutdownIface->hardShutdownHigh(threshold.value(
597 "HardShutdownHigh", std::numeric_limits<double>::quiet_NaN()));
598 hardShutdownIface->hardShutdownLow(threshold.value(
599 "HardShutdownLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000600 hardShutdownIface->setHighHysteresis(
601 threshold.value("HardShutdownHighHysteresis", defaultHysteresis));
602 hardShutdownIface->setLowHysteresis(
603 threshold.value("HardShutdownLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000604 }
605
606 if (threshold.contains("SoftShutdownHigh") ||
607 threshold.contains("SoftShutdownLow"))
608 {
609 softShutdownIface = std::make_unique<Threshold<SoftShutdownObject>>(
610 bus, objPath.c_str());
611
612 softShutdownIface->softShutdownHigh(threshold.value(
613 "SoftShutdownHigh", std::numeric_limits<double>::quiet_NaN()));
614 softShutdownIface->softShutdownLow(threshold.value(
615 "SoftShutdownLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000616 softShutdownIface->setHighHysteresis(
617 threshold.value("SoftShutdownHighHysteresis", defaultHysteresis));
618 softShutdownIface->setLowHysteresis(
619 threshold.value("SoftShutdownLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000620 }
621
622 if (threshold.contains("PerformanceLossHigh") ||
623 threshold.contains("PerformanceLossLow"))
624 {
625 perfLossIface = std::make_unique<Threshold<PerformanceLossObject>>(
626 bus, objPath.c_str());
627
628 perfLossIface->performanceLossHigh(threshold.value(
629 "PerformanceLossHigh", std::numeric_limits<double>::quiet_NaN()));
630 perfLossIface->performanceLossLow(threshold.value(
631 "PerformanceLossLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000632 perfLossIface->setHighHysteresis(threshold.value(
633 "PerformanceLossHighHysteresis", defaultHysteresis));
634 perfLossIface->setLowHysteresis(
635 threshold.value("PerformanceLossLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000636 }
637}
638
Rashmica Guptae7efe132021-07-27 19:42:11 +1000639ManagedObjectType VirtualSensors::getObjectsFromDBus()
640{
641 ManagedObjectType objects;
642
643 try
644 {
645 auto method = bus.new_method_call(entityManagerBusName, "/",
646 "org.freedesktop.DBus.ObjectManager",
647 "GetManagedObjects");
648 auto reply = bus.call(method);
649 reply.read(objects);
650 }
Patrick Williams8e11ccc2022-07-22 19:26:57 -0500651 catch (const sdbusplus::exception_t& ex)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000652 {
653 // If entity manager isn't running yet, keep going.
654 if (std::string("org.freedesktop.DBus.Error.ServiceUnknown") !=
655 ex.name())
656 {
657 throw ex.name();
658 }
659 }
660
661 return objects;
662}
663
Patrick Williams8e11ccc2022-07-22 19:26:57 -0500664void VirtualSensors::propertiesChanged(sdbusplus::message_t& msg)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000665{
666 std::string path;
667 PropertyMap properties;
668
669 msg.read(path, properties);
670
671 /* We get multiple callbacks for one sensor. 'Type' is a required field and
672 * is a unique label so use to to only proceed once per sensor */
673 if (properties.contains("Type"))
674 {
675 if (isCalculationType(path))
676 {
677 createVirtualSensorsFromDBus(path);
678 }
679 }
680}
681
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700682/** @brief Parsing Virtual Sensor config JSON file */
George Liu1204b432021-12-29 17:24:48 +0800683Json VirtualSensors::parseConfigFile(const std::string& configFile)
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700684{
685 std::ifstream jsonFile(configFile);
686 if (!jsonFile.is_open())
687 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500688 error("config JSON file {FILENAME} not found", "FILENAME", configFile);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000689 return {};
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700690 }
691
692 auto data = Json::parse(jsonFile, nullptr, false);
693 if (data.is_discarded())
694 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500695 error("config readings JSON parser failure with {FILENAME}", "FILENAME",
696 configFile);
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700697 throw std::exception{};
698 }
699
700 return data;
701}
702
Vijay Khemkae0d371e2020-09-21 18:35:52 -0700703std::map<std::string, ValueIface::Unit> unitMap = {
704 {"temperature", ValueIface::Unit::DegreesC},
705 {"fan_tach", ValueIface::Unit::RPMS},
706 {"voltage", ValueIface::Unit::Volts},
707 {"altitude", ValueIface::Unit::Meters},
708 {"current", ValueIface::Unit::Amperes},
709 {"power", ValueIface::Unit::Watts},
710 {"energy", ValueIface::Unit::Joules},
Kumar Thangavel2b56ddb2021-01-13 20:16:11 +0530711 {"utilization", ValueIface::Unit::Percent},
Rashmica Gupta4ac7a7f2021-07-08 12:30:50 +1000712 {"airflow", ValueIface::Unit::CFM},
713 {"pressure", ValueIface::Unit::Pascals}};
Vijay Khemkae0d371e2020-09-21 18:35:52 -0700714
Rashmica Guptae7efe132021-07-27 19:42:11 +1000715const std::string getSensorTypeFromUnit(const std::string& unit)
716{
717 std::string unitPrefix = "xyz.openbmc_project.Sensor.Value.Unit.";
718 for (auto [type, unitObj] : unitMap)
719 {
720 auto unitPath = ValueIface::convertUnitToString(unitObj);
721 if (unitPath == (unitPrefix + unit))
722 {
723 return type;
724 }
725 }
726 return "";
727}
728
729void VirtualSensors::setupMatches()
730{
731 /* Already setup */
732 if (!this->matches.empty())
733 {
734 return;
735 }
736
737 /* Setup matches */
Patrick Williams8e11ccc2022-07-22 19:26:57 -0500738 auto eventHandler = [this](sdbusplus::message_t& message) {
Rashmica Guptae7efe132021-07-27 19:42:11 +1000739 if (message.is_method_error())
740 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500741 error("Callback method error");
Rashmica Guptae7efe132021-07-27 19:42:11 +1000742 return;
743 }
744 this->propertiesChanged(message);
745 };
746
747 for (const char* iface : calculationIfaces)
748 {
Patrick Williams8e11ccc2022-07-22 19:26:57 -0500749 auto match = std::make_unique<sdbusplus::bus::match_t>(
Rashmica Guptae7efe132021-07-27 19:42:11 +1000750 bus,
751 sdbusplus::bus::match::rules::propertiesChangedNamespace(
752 "/xyz/openbmc_project/inventory", iface),
753 eventHandler);
754 this->matches.emplace_back(std::move(match));
755 }
756}
757
758void VirtualSensors::createVirtualSensorsFromDBus(
759 const std::string& calculationIface)
760{
761 if (calculationIface.empty())
762 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500763 error("No calculation type supplied");
Rashmica Guptae7efe132021-07-27 19:42:11 +1000764 return;
765 }
766 auto objects = getObjectsFromDBus();
767
768 /* Get virtual sensors config data */
769 for (const auto& [path, interfaceMap] : objects)
770 {
771 auto objpath = static_cast<std::string>(path);
772 std::string name = path.filename();
773 std::string sensorType, sensorUnit;
774
775 /* Find Virtual Sensor interfaces */
776 if (!interfaceMap.contains(calculationIface))
777 {
778 continue;
779 }
780 if (name.empty())
781 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500782 error("Virtual Sensor name not found in entity manager config");
Rashmica Guptae7efe132021-07-27 19:42:11 +1000783 continue;
784 }
785 if (virtualSensorsMap.contains(name))
786 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500787 error("A virtual sensor named {NAME} already exists", "NAME", name);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000788 continue;
789 }
790
791 /* Extract the virtual sensor type as we need this to initialize the
792 * sensor */
793 for (const auto& [interface, propertyMap] : interfaceMap)
794 {
795 if (interface != calculationIface)
796 {
797 continue;
798 }
799 auto itr = propertyMap.find("Units");
800 if (itr != propertyMap.end())
801 {
802 sensorUnit = std::get<std::string>(itr->second);
803 break;
804 }
805 }
806 sensorType = getSensorTypeFromUnit(sensorUnit);
807 if (sensorType.empty())
808 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500809 error("Sensor unit type {TYPE} is not supported", "TYPE",
810 sensorUnit);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000811 continue;
812 }
813
814 try
815 {
816 auto virtObjPath = sensorDbusPath + sensorType + "/" + name;
817
818 auto virtualSensorPtr = std::make_unique<VirtualSensor>(
819 bus, virtObjPath.c_str(), interfaceMap, name, sensorType,
Tao Lindc777012022-07-27 20:41:46 +0800820 calculationIface, objpath);
Patrick Williams82b39c62021-07-28 16:22:27 -0500821 info("Added a new virtual sensor: {NAME} {TYPE}", "NAME", name,
822 "TYPE", sensorType);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000823 virtualSensorPtr->updateVirtualSensor();
824
825 /* Initialize unit value for virtual sensor */
826 virtualSensorPtr->ValueIface::unit(unitMap[sensorType]);
827 virtualSensorPtr->emit_object_added();
828
829 virtualSensorsMap.emplace(name, std::move(virtualSensorPtr));
830
831 /* Setup match for interfaces removed */
832 auto intfRemoved = [this, objpath,
Patrick Williams8e11ccc2022-07-22 19:26:57 -0500833 name](sdbusplus::message_t& message) {
Rashmica Guptae7efe132021-07-27 19:42:11 +1000834 if (!virtualSensorsMap.contains(name))
835 {
836 return;
837 }
838 sdbusplus::message::object_path path;
839 message.read(path);
840 if (static_cast<const std::string&>(path) == objpath)
841 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500842 info("Removed a virtual sensor: {NAME}", "NAME", name);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000843 virtualSensorsMap.erase(name);
844 }
845 };
Patrick Williams8e11ccc2022-07-22 19:26:57 -0500846 auto matchOnRemove = std::make_unique<sdbusplus::bus::match_t>(
Rashmica Guptae7efe132021-07-27 19:42:11 +1000847 bus,
848 sdbusplus::bus::match::rules::interfacesRemoved() +
849 sdbusplus::bus::match::rules::argNpath(0, objpath),
850 intfRemoved);
851 /* TODO: slight race condition here. Check that the config still
852 * exists */
853 this->matches.emplace_back(std::move(matchOnRemove));
854 }
Patrick Williamsdac26632021-10-06 14:38:47 -0500855 catch (const std::invalid_argument& ia)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000856 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500857 error("Failed to set up virtual sensor: {ERROR}", "ERROR", ia);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000858 }
859 }
860}
861
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700862void VirtualSensors::createVirtualSensors()
863{
864 static const Json empty{};
865
866 auto data = parseConfigFile(VIRTUAL_SENSOR_CONFIG_FILE);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000867
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700868 // print values
869 if (DEBUG)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000870 {
Patrick Williamsfbd71452021-08-30 06:59:46 -0500871 debug("JSON: {JSON}", "JSON", data.dump());
Rashmica Guptae7efe132021-07-27 19:42:11 +1000872 }
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700873
874 /* Get virtual sensors config data */
875 for (const auto& j : data)
876 {
877 auto desc = j.value("Desc", empty);
878 if (!desc.empty())
879 {
Rashmica Guptae7efe132021-07-27 19:42:11 +1000880 if (desc.value("Config", "") == "D-Bus")
881 {
882 /* Look on D-Bus for a virtual sensor config. Set up matches
883 * first because the configs may not be on D-Bus yet and we
884 * don't want to miss them */
885 setupMatches();
886
887 if (desc.contains("Type"))
888 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500889 auto type = desc.value("Type", "");
890 auto path = "xyz.openbmc_project.Configuration." + type;
891
Rashmica Guptae7efe132021-07-27 19:42:11 +1000892 if (!isCalculationType(path))
893 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500894 error("Invalid calculation type {TYPE} supplied.",
895 "TYPE", type);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000896 continue;
897 }
898 createVirtualSensorsFromDBus(path);
899 }
900 continue;
901 }
902
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700903 std::string sensorType = desc.value("SensorType", "");
904 std::string name = desc.value("Name", "");
Rashmica Gupta665a0a22021-06-30 11:35:28 +1000905 std::replace(name.begin(), name.end(), ' ', '_');
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700906
907 if (!name.empty() && !sensorType.empty())
908 {
Vijay Khemkae0d371e2020-09-21 18:35:52 -0700909 if (unitMap.find(sensorType) == unitMap.end())
910 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500911 error("Sensor type {TYPE} is not supported", "TYPE",
912 sensorType);
Vijay Khemkae0d371e2020-09-21 18:35:52 -0700913 }
914 else
915 {
Rashmica Gupta67d8b9d2021-06-30 11:41:14 +1000916 if (virtualSensorsMap.find(name) != virtualSensorsMap.end())
917 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500918 error("A virtual sensor named {NAME} already exists",
919 "NAME", name);
Rashmica Gupta67d8b9d2021-06-30 11:41:14 +1000920 continue;
921 }
Rashmica Gupta862c3d12021-08-06 12:19:31 +1000922 auto objPath = sensorDbusPath + sensorType + "/" + name;
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700923
Vijay Khemkae0d371e2020-09-21 18:35:52 -0700924 auto virtualSensorPtr = std::make_unique<VirtualSensor>(
925 bus, objPath.c_str(), j, name);
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700926
Patrick Williams82b39c62021-07-28 16:22:27 -0500927 info("Added a new virtual sensor: {NAME}", "NAME", name);
Vijay Khemkae0d371e2020-09-21 18:35:52 -0700928 virtualSensorPtr->updateVirtualSensor();
929
930 /* Initialize unit value for virtual sensor */
931 virtualSensorPtr->ValueIface::unit(unitMap[sensorType]);
Rashmica Guptaa2fa63a2021-08-06 12:21:13 +1000932 virtualSensorPtr->emit_object_added();
Vijay Khemkae0d371e2020-09-21 18:35:52 -0700933
934 virtualSensorsMap.emplace(std::move(name),
935 std::move(virtualSensorPtr));
936 }
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700937 }
938 else
939 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500940 error(
941 "Sensor type ({TYPE}) or name ({NAME}) not found in config file",
942 "NAME", name, "TYPE", sensorType);
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700943 }
944 }
945 else
946 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500947 error("Descriptor for new virtual sensor not found in config file");
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700948 }
949 }
950}
951
952} // namespace virtualSensor
953} // namespace phosphor
954
955/**
956 * @brief Main
957 */
958int main()
959{
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700960 // Get a handle to system dbus
961 auto bus = sdbusplus::bus::new_default();
962
Matt Spinler6c19e7d2021-01-12 16:26:45 -0600963 // Add the ObjectManager interface
Patrick Williams8e11ccc2022-07-22 19:26:57 -0500964 sdbusplus::server::manager_t objManager(bus, "/");
Matt Spinler6c19e7d2021-01-12 16:26:45 -0600965
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700966 // Create an virtual sensors object
967 phosphor::virtualSensor::VirtualSensors virtualSensors(bus);
968
969 // Request service bus name
970 bus.request_name(busName);
971
Patrick Williamse6672392022-09-02 09:03:24 -0500972 // Run the dbus loop.
973 bus.process_loop();
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700974
975 return 0;
976}