blob: 5e4ca5f20e4461f40efc68313295909ffbf002ec [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 vsThresholdsIfaceSuffix = ".Thresholds";
Rashmica Gupta304fd0e2021-08-10 16:50:44 +100013static constexpr std::array<const char*, 1> calculationIfaces = {
14 "xyz.openbmc_project.Configuration.ModifiedMedian"};
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +100015static constexpr auto defaultHysteresis = 0;
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070016
Patrick Williams82b39c62021-07-28 16:22:27 -050017PHOSPHOR_LOG2_USING_WITH_FLAGS;
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070018
Vijay Khemka51f898e2020-09-09 22:24:18 -070019int handleDbusSignal(sd_bus_message* msg, void* usrData, sd_bus_error*)
20{
21 if (usrData == nullptr)
22 {
23 throw std::runtime_error("Invalid match");
24 }
25
Patrick Williams8e11ccc2022-07-22 19:26:57 -050026 auto sdbpMsg = sdbusplus::message_t(msg);
Vijay Khemka51f898e2020-09-09 22:24:18 -070027 std::string msgIfce;
28 std::map<std::string, std::variant<int64_t, double, bool>> msgData;
29
30 sdbpMsg.read(msgIfce, msgData);
31
32 if (msgData.find("Value") != msgData.end())
33 {
34 using namespace phosphor::virtualSensor;
35 VirtualSensor* obj = static_cast<VirtualSensor*>(usrData);
36 // TODO(openbmc/phosphor-virtual-sensor#1): updateVirtualSensor should
37 // be changed to take the information we got from the signal, to avoid
38 // having to do numerous dbus queries.
39 obj->updateVirtualSensor();
40 }
41 return 0;
42}
43
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070044namespace phosphor
45{
46namespace virtualSensor
47{
48
49void printParams(const VirtualSensor::ParamMap& paramMap)
50{
51 for (const auto& p : paramMap)
52 {
53 const auto& p1 = p.first;
54 const auto& p2 = p.second;
55 auto val = p2->getParamValue();
Patrick Williamsfbd71452021-08-30 06:59:46 -050056 debug("Parameter: {PARAM} = {VALUE}", "PARAM", p1, "VALUE", val);
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070057 }
58}
59
60double SensorParam::getParamValue()
61{
62 switch (paramType)
63 {
64 case constParam:
65 return value;
66 break;
Vijay Khemka7452a862020-08-11 16:01:23 -070067 case dbusParam:
68 return dbusSensor->getSensorValue();
69 break;
Vijay Khemkaabcc94f2020-08-11 15:27:44 -070070 default:
71 throw std::invalid_argument("param type not supported");
72 }
73}
74
Lei YU0fcf0e12021-06-04 11:14:17 +080075using AssociationList =
76 std::vector<std::tuple<std::string, std::string, std::string>>;
77
78AssociationList getAssociationsFromJson(const Json& j)
79{
80 AssociationList assocs{};
81 try
82 {
83 j.get_to(assocs);
84 }
85 catch (const std::exception& ex)
86 {
Patrick Williams82b39c62021-07-28 16:22:27 -050087 error("Failed to parse association: {ERROR}", "ERROR", ex);
Lei YU0fcf0e12021-06-04 11:14:17 +080088 }
89 return assocs;
90}
91
Rashmica Guptae7efe132021-07-27 19:42:11 +100092template <typename U>
93struct VariantToNumber
94{
95 template <typename T>
96 U operator()(const T& t) const
97 {
98 if constexpr (std::is_convertible<T, U>::value)
99 {
100 return static_cast<U>(t);
101 }
102 throw std::invalid_argument("Invalid number type in config\n");
103 }
104};
105
106template <typename U>
107U getNumberFromConfig(const PropertyMap& map, const std::string& name,
Jiaqing Zhao190f6d02022-05-21 23:26:15 +0800108 bool required,
109 U defaultValue = std::numeric_limits<U>::quiet_NaN())
Rashmica Guptae7efe132021-07-27 19:42:11 +1000110{
111 if (auto itr = map.find(name); itr != map.end())
112 {
113 return std::visit(VariantToNumber<U>(), itr->second);
114 }
115 else if (required)
116 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500117 error("Required field {NAME} missing in config", "NAME", name);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000118 throw std::invalid_argument("Required field missing in config");
119 }
Jiaqing Zhao190f6d02022-05-21 23:26:15 +0800120 return defaultValue;
Rashmica Guptae7efe132021-07-27 19:42:11 +1000121}
122
123bool isCalculationType(const std::string& interface)
124{
125 auto itr = std::find(calculationIfaces.begin(), calculationIfaces.end(),
126 interface);
127 if (itr != calculationIfaces.end())
128 {
129 return true;
130 }
131 return false;
132}
133
134const std::string getThresholdType(const std::string& direction,
Rashmica Gupta05b1d412021-11-03 12:01:36 +1100135 const std::string& severity)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000136{
Rashmica Guptae7efe132021-07-27 19:42:11 +1000137 std::string suffix;
Rashmica Guptae7efe132021-07-27 19:42:11 +1000138
139 if (direction == "less than")
140 {
141 suffix = "Low";
142 }
143 else if (direction == "greater than")
144 {
145 suffix = "High";
146 }
147 else
148 {
149 throw std::invalid_argument(
150 "Invalid threshold direction specified in entity manager");
151 }
Rashmica Gupta05b1d412021-11-03 12:01:36 +1100152 return severity + suffix;
153}
154
155std::string getSeverityField(const PropertyMap& propertyMap)
156{
157 static const std::array thresholdTypes{"Warning", "Critical",
158 "PerformanceLoss", "SoftShutdown",
159 "HardShutdown"};
160
161 std::string severity;
162 if (auto itr = propertyMap.find("Severity"); itr != propertyMap.end())
163 {
164 /* Severity should be a string, but can be an unsigned int */
165 if (std::holds_alternative<std::string>(itr->second))
166 {
167 severity = std::get<std::string>(itr->second);
168 if (0 == std::ranges::count(thresholdTypes, severity))
169 {
170 throw std::invalid_argument(
171 "Invalid threshold severity specified in entity manager");
172 }
173 }
174 else
175 {
176 auto sev =
177 getNumberFromConfig<uint64_t>(propertyMap, "Severity", true);
178 /* Checking bounds ourselves so we throw invalid argument on
179 * invalid user input */
180 if (sev >= thresholdTypes.size())
181 {
182 throw std::invalid_argument(
183 "Invalid threshold severity specified in entity manager");
184 }
185 severity = thresholdTypes.at(sev);
186 }
187 }
188 return severity;
Rashmica Guptae7efe132021-07-27 19:42:11 +1000189}
190
191void parseThresholds(Json& thresholds, const PropertyMap& propertyMap)
192{
193 std::string direction;
194
Rashmica Guptae7efe132021-07-27 19:42:11 +1000195 auto value = getNumberFromConfig<double>(propertyMap, "Value", true);
196
Rashmica Gupta05b1d412021-11-03 12:01:36 +1100197 auto severity = getSeverityField(propertyMap);
198
199 if (auto itr = propertyMap.find("Direction"); itr != propertyMap.end())
Rashmica Guptae7efe132021-07-27 19:42:11 +1000200 {
201 direction = std::get<std::string>(itr->second);
202 }
203
204 auto threshold = getThresholdType(direction, severity);
205 thresholds[threshold] = value;
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000206
207 auto hysteresis =
208 getNumberFromConfig<double>(propertyMap, "Hysteresis", false);
209 if (hysteresis != std::numeric_limits<double>::quiet_NaN())
210 {
211 thresholds[threshold + "Hysteresis"] = hysteresis;
212 }
Rashmica Guptae7efe132021-07-27 19:42:11 +1000213}
214
215void VirtualSensor::parseConfigInterface(const PropertyMap& propertyMap,
216 const std::string& sensorType,
217 const std::string& interface)
218{
219 /* Parse sensors / DBus params */
220 if (auto itr = propertyMap.find("Sensors"); itr != propertyMap.end())
221 {
222 auto sensors = std::get<std::vector<std::string>>(itr->second);
223 for (auto sensor : sensors)
224 {
225 std::replace(sensor.begin(), sensor.end(), ' ', '_');
226 auto sensorObjPath = sensorDbusPath + sensorType + "/" + sensor;
227
228 auto paramPtr =
229 std::make_unique<SensorParam>(bus, sensorObjPath, this);
230 symbols.create_variable(sensor);
231 paramMap.emplace(std::move(sensor), std::move(paramPtr));
232 }
233 }
234 /* Get expression string */
235 if (!isCalculationType(interface))
236 {
237 throw std::invalid_argument("Invalid expression in interface");
238 }
239 exprStr = interface;
240
241 /* Get optional min and max input and output values */
242 ValueIface::maxValue(
243 getNumberFromConfig<double>(propertyMap, "MaxValue", false));
244 ValueIface::minValue(
245 getNumberFromConfig<double>(propertyMap, "MinValue", false));
246 maxValidInput =
Jiaqing Zhao190f6d02022-05-21 23:26:15 +0800247 getNumberFromConfig<double>(propertyMap, "MaxValidInput", false,
248 std::numeric_limits<double>::infinity());
Rashmica Guptae7efe132021-07-27 19:42:11 +1000249 minValidInput =
Jiaqing Zhao190f6d02022-05-21 23:26:15 +0800250 getNumberFromConfig<double>(propertyMap, "MinValidInput", false,
251 -std::numeric_limits<double>::infinity());
Rashmica Guptae7efe132021-07-27 19:42:11 +1000252}
253
Matt Spinlerce675222021-01-14 16:38:09 -0600254void VirtualSensor::initVirtualSensor(const Json& sensorConfig,
255 const std::string& objPath)
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700256{
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700257 static const Json empty{};
258
259 /* Get threshold values if defined in config */
260 auto threshold = sensorConfig.value("Threshold", empty);
Matt Spinlerf15189e2021-01-15 10:13:28 -0600261
Rashmica Gupta3e999192021-06-09 16:17:04 +1000262 createThresholds(threshold, objPath);
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700263
Harvey Wuf6443742021-04-09 16:47:36 +0800264 /* Get MaxValue, MinValue setting if defined in config */
265 auto confDesc = sensorConfig.value("Desc", empty);
266 if (auto maxConf = confDesc.find("MaxValue");
267 maxConf != confDesc.end() && maxConf->is_number())
268 {
269 ValueIface::maxValue(maxConf->get<double>());
270 }
271 if (auto minConf = confDesc.find("MinValue");
272 minConf != confDesc.end() && minConf->is_number())
273 {
274 ValueIface::minValue(minConf->get<double>());
275 }
276
Lei YU0fcf0e12021-06-04 11:14:17 +0800277 /* Get optional association */
278 auto assocJson = sensorConfig.value("Associations", empty);
279 if (!assocJson.empty())
280 {
281 auto assocs = getAssociationsFromJson(assocJson);
282 if (!assocs.empty())
283 {
284 associationIface =
285 std::make_unique<AssociationObject>(bus, objPath.c_str());
286 associationIface->associations(assocs);
287 }
288 }
289
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700290 /* Get expression string */
Patrick Williams03c4c8e2022-04-14 22:19:44 -0500291 static constexpr auto exprKey = "Expression";
292 if (sensorConfig.contains(exprKey))
293 {
Patrick Williamsa9596782022-04-15 10:20:07 -0500294 auto& ref = sensorConfig.at(exprKey);
Patrick Williams03c4c8e2022-04-14 22:19:44 -0500295 if (ref.is_array())
296 {
297 exprStr = std::string{};
298 for (auto& s : ref)
299 {
300 exprStr += s;
301 }
302 }
303 else if (ref.is_string())
304 {
305 exprStr = std::string{ref};
306 }
307 }
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700308
309 /* Get all the parameter listed in configuration */
310 auto params = sensorConfig.value("Params", empty);
311
312 /* Check for constant parameter */
313 const auto& consParams = params.value("ConstParam", empty);
314 if (!consParams.empty())
315 {
316 for (auto& j : consParams)
317 {
318 if (j.find("ParamName") != j.end())
319 {
320 auto paramPtr = std::make_unique<SensorParam>(j["Value"]);
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700321 std::string name = j["ParamName"];
322 symbols.create_variable(name);
323 paramMap.emplace(std::move(name), std::move(paramPtr));
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700324 }
325 else
326 {
327 /* Invalid configuration */
328 throw std::invalid_argument(
329 "ParamName not found in configuration");
330 }
331 }
332 }
333
Vijay Khemka7452a862020-08-11 16:01:23 -0700334 /* Check for dbus parameter */
335 auto dbusParams = params.value("DbusParam", empty);
336 if (!dbusParams.empty())
337 {
338 for (auto& j : dbusParams)
339 {
340 /* Get parameter dbus sensor descriptor */
341 auto desc = j.value("Desc", empty);
342 if ((!desc.empty()) && (j.find("ParamName") != j.end()))
343 {
344 std::string sensorType = desc.value("SensorType", "");
345 std::string name = desc.value("Name", "");
346
347 if (!sensorType.empty() && !name.empty())
348 {
George Liu1204b432021-12-29 17:24:48 +0800349 auto path = sensorDbusPath + sensorType + "/" + name;
Vijay Khemka7452a862020-08-11 16:01:23 -0700350
Vijay Khemka51f898e2020-09-09 22:24:18 -0700351 auto paramPtr =
George Liu1204b432021-12-29 17:24:48 +0800352 std::make_unique<SensorParam>(bus, path, this);
353 std::string paramName = j["ParamName"];
354 symbols.create_variable(paramName);
355 paramMap.emplace(std::move(paramName), std::move(paramPtr));
Vijay Khemka7452a862020-08-11 16:01:23 -0700356 }
357 }
358 }
359 }
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700360
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700361 symbols.add_constants();
Matt Spinler9f1ef4f2020-11-09 15:59:11 -0600362 symbols.add_package(vecopsPackage);
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700363 expression.register_symbol_table(symbols);
364
365 /* parser from exprtk */
366 exprtk::parser<double> parser{};
Matt Spinlerddc6dcd2020-11-09 11:16:31 -0600367 if (!parser.compile(exprStr, expression))
368 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500369 error("Expression compilation failed");
Matt Spinlerddc6dcd2020-11-09 11:16:31 -0600370
371 for (std::size_t i = 0; i < parser.error_count(); ++i)
372 {
Patrick Williams82b39c62021-07-28 16:22:27 -0500373 auto err = parser.get_error(i);
374 error("Error parsing token at {POSITION}: {ERROR}", "POSITION",
375 err.token.position, "TYPE",
376 exprtk::parser_error::to_str(err.mode), "ERROR",
377 err.diagnostic);
Matt Spinlerddc6dcd2020-11-09 11:16:31 -0600378 }
379 throw std::runtime_error("Expression compilation failed");
380 }
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700381
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700382 /* Print all parameters for debug purpose only */
383 if (DEBUG)
384 printParams(paramMap);
385}
386
Tao Lindc777012022-07-27 20:41:46 +0800387void VirtualSensor::createAssociation(const std::string& objPath,
388 const std::string& entityPath)
389{
390 if (objPath.empty() || entityPath.empty())
391 {
392 return;
393 }
394
395 std::filesystem::path p(entityPath);
396 auto assocsDbus =
397 AssociationList{{"chassis", "all_sensors", p.parent_path().string()}};
398 associationIface =
399 std::make_unique<AssociationObject>(bus, objPath.c_str());
400 associationIface->associations(assocsDbus);
401}
402
Rashmica Guptae7efe132021-07-27 19:42:11 +1000403void VirtualSensor::initVirtualSensor(const InterfaceMap& interfaceMap,
404 const std::string& objPath,
405 const std::string& sensorType,
406 const std::string& calculationIface)
407{
408 Json thresholds;
409 const std::string vsThresholdsIntf =
410 calculationIface + vsThresholdsIfaceSuffix;
411
412 for (const auto& [interface, propertyMap] : interfaceMap)
413 {
414 /* Each threshold is on it's own interface with a number as a suffix
415 * eg xyz.openbmc_project.Configuration.ModifiedMedian.Thresholds1 */
416 if (interface.find(vsThresholdsIntf) != std::string::npos)
417 {
418 parseThresholds(thresholds, propertyMap);
419 }
420 else if (interface == calculationIface)
421 {
422 parseConfigInterface(propertyMap, sensorType, interface);
423 }
424 }
425
426 createThresholds(thresholds, objPath);
427 symbols.add_constants();
428 symbols.add_package(vecopsPackage);
429 expression.register_symbol_table(symbols);
430
Tao Lindc777012022-07-27 20:41:46 +0800431 createAssociation(objPath, entityPath);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000432 /* Print all parameters for debug purpose only */
433 if (DEBUG)
434 {
435 printParams(paramMap);
436 }
437}
438
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700439void VirtualSensor::setSensorValue(double value)
440{
Patrick Williams543bf662021-04-29 09:03:53 -0500441 value = std::clamp(value, ValueIface::minValue(), ValueIface::maxValue());
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700442 ValueIface::value(value);
443}
444
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000445double VirtualSensor::calculateValue(const std::string& calculation,
446 const VirtualSensor::ParamMap& paramMap)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000447{
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000448 auto itr = std::find(calculationIfaces.begin(), calculationIfaces.end(),
449 calculation);
450 if (itr == calculationIfaces.end())
451 {
452 return std::numeric_limits<double>::quiet_NaN();
453 }
454 else if (calculation == "xyz.openbmc_project.Configuration.ModifiedMedian")
455 {
456 return calculateModifiedMedianValue(paramMap);
457 }
Rashmica Guptae7efe132021-07-27 19:42:11 +1000458 return std::numeric_limits<double>::quiet_NaN();
459}
460
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000461bool VirtualSensor::sensorInRange(double value)
462{
463 if (value <= this->maxValidInput && value >= this->minValidInput)
464 {
465 return true;
466 }
467 return false;
468}
469
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700470void VirtualSensor::updateVirtualSensor()
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700471{
472 for (auto& param : paramMap)
473 {
474 auto& name = param.first;
475 auto& data = param.second;
476 if (auto var = symbols.get_variable(name))
477 {
478 var->ref() = data->getParamValue();
479 }
480 else
481 {
482 /* Invalid parameter */
483 throw std::invalid_argument("ParamName not found in symbols");
484 }
485 }
Rashmica Guptae7efe132021-07-27 19:42:11 +1000486 auto itr =
487 std::find(calculationIfaces.begin(), calculationIfaces.end(), exprStr);
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000488 auto val = (itr == calculationIfaces.end())
489 ? expression.value()
490 : calculateValue(exprStr, paramMap);
Vijay Khemka32a71562020-09-10 15:29:18 -0700491
492 /* Set sensor value to dbus interface */
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700493 setSensorValue(val);
Vijay Khemka32a71562020-09-10 15:29:18 -0700494
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700495 if (DEBUG)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000496 {
Patrick Williamsfbd71452021-08-30 06:59:46 -0500497 debug("Sensor {NAME} = {VALUE}", "NAME", this->name, "VALUE", val);
Rashmica Guptae7efe132021-07-27 19:42:11 +1000498 }
Vijay Khemka32a71562020-09-10 15:29:18 -0700499
Matt Spinler8f5e6112021-01-15 10:44:32 -0600500 /* Check sensor thresholds and log required message */
Matt Spinlerb306b032021-02-01 10:05:46 -0600501 checkThresholds(val, perfLossIface);
Patrick Williamsfdb826d2021-01-20 14:37:53 -0600502 checkThresholds(val, warningIface);
503 checkThresholds(val, criticalIface);
504 checkThresholds(val, softShutdownIface);
505 checkThresholds(val, hardShutdownIface);
Vijay Khemka3ed9a512020-08-21 16:13:05 -0700506}
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700507
Rashmica Gupta304fd0e2021-08-10 16:50:44 +1000508double VirtualSensor::calculateModifiedMedianValue(
509 const VirtualSensor::ParamMap& paramMap)
510{
511 std::vector<double> values;
512
513 for (auto& param : paramMap)
514 {
515 auto& name = param.first;
516 if (auto var = symbols.get_variable(name))
517 {
518 if (!sensorInRange(var->ref()))
519 {
520 continue;
521 }
522 values.push_back(var->ref());
523 }
524 }
525
526 size_t size = values.size();
527 std::sort(values.begin(), values.end());
528 switch (size)
529 {
530 case 2:
531 /* Choose biggest value */
532 return values.at(1);
533 case 0:
534 return std::numeric_limits<double>::quiet_NaN();
535 default:
536 /* Choose median value */
537 if (size % 2 == 0)
538 {
539 // Average of the two middle values
540 return (values.at(size / 2) + values.at(size / 2 - 1)) / 2;
541 }
542 else
543 {
544 return values.at((size - 1) / 2);
545 }
546 }
547}
548
Rashmica Gupta3e999192021-06-09 16:17:04 +1000549void VirtualSensor::createThresholds(const Json& threshold,
550 const std::string& objPath)
551{
552 if (threshold.empty())
553 {
554 return;
555 }
556 // Only create the threshold interfaces if
557 // at least one of their values is present.
558 if (threshold.contains("CriticalHigh") || threshold.contains("CriticalLow"))
559 {
560 criticalIface =
561 std::make_unique<Threshold<CriticalObject>>(bus, objPath.c_str());
562
563 criticalIface->criticalHigh(threshold.value(
564 "CriticalHigh", std::numeric_limits<double>::quiet_NaN()));
565 criticalIface->criticalLow(threshold.value(
566 "CriticalLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000567 criticalIface->setHighHysteresis(
568 threshold.value("CriticalHighHysteresis", defaultHysteresis));
569 criticalIface->setLowHysteresis(
570 threshold.value("CriticalLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000571 }
572
573 if (threshold.contains("WarningHigh") || threshold.contains("WarningLow"))
574 {
575 warningIface =
576 std::make_unique<Threshold<WarningObject>>(bus, objPath.c_str());
577
578 warningIface->warningHigh(threshold.value(
579 "WarningHigh", std::numeric_limits<double>::quiet_NaN()));
580 warningIface->warningLow(threshold.value(
581 "WarningLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000582 warningIface->setHighHysteresis(
583 threshold.value("WarningHighHysteresis", defaultHysteresis));
584 warningIface->setLowHysteresis(
585 threshold.value("WarningLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000586 }
587
588 if (threshold.contains("HardShutdownHigh") ||
589 threshold.contains("HardShutdownLow"))
590 {
591 hardShutdownIface = std::make_unique<Threshold<HardShutdownObject>>(
592 bus, objPath.c_str());
593
594 hardShutdownIface->hardShutdownHigh(threshold.value(
595 "HardShutdownHigh", std::numeric_limits<double>::quiet_NaN()));
596 hardShutdownIface->hardShutdownLow(threshold.value(
597 "HardShutdownLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000598 hardShutdownIface->setHighHysteresis(
599 threshold.value("HardShutdownHighHysteresis", defaultHysteresis));
600 hardShutdownIface->setLowHysteresis(
601 threshold.value("HardShutdownLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000602 }
603
604 if (threshold.contains("SoftShutdownHigh") ||
605 threshold.contains("SoftShutdownLow"))
606 {
607 softShutdownIface = std::make_unique<Threshold<SoftShutdownObject>>(
608 bus, objPath.c_str());
609
610 softShutdownIface->softShutdownHigh(threshold.value(
611 "SoftShutdownHigh", std::numeric_limits<double>::quiet_NaN()));
612 softShutdownIface->softShutdownLow(threshold.value(
613 "SoftShutdownLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000614 softShutdownIface->setHighHysteresis(
615 threshold.value("SoftShutdownHighHysteresis", defaultHysteresis));
616 softShutdownIface->setLowHysteresis(
617 threshold.value("SoftShutdownLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000618 }
619
620 if (threshold.contains("PerformanceLossHigh") ||
621 threshold.contains("PerformanceLossLow"))
622 {
623 perfLossIface = std::make_unique<Threshold<PerformanceLossObject>>(
624 bus, objPath.c_str());
625
626 perfLossIface->performanceLossHigh(threshold.value(
627 "PerformanceLossHigh", std::numeric_limits<double>::quiet_NaN()));
628 perfLossIface->performanceLossLow(threshold.value(
629 "PerformanceLossLow", std::numeric_limits<double>::quiet_NaN()));
Rashmica Gupta1dff7dc2021-07-27 19:43:31 +1000630 perfLossIface->setHighHysteresis(threshold.value(
631 "PerformanceLossHighHysteresis", defaultHysteresis));
632 perfLossIface->setLowHysteresis(
633 threshold.value("PerformanceLossLowHysteresis", defaultHysteresis));
Rashmica Gupta3e999192021-06-09 16:17:04 +1000634 }
635}
636
Rashmica Guptae7efe132021-07-27 19:42:11 +1000637ManagedObjectType VirtualSensors::getObjectsFromDBus()
638{
639 ManagedObjectType objects;
640
641 try
642 {
Nan Zhouf6825b92022-09-20 20:52:43 +0000643 auto method = bus.new_method_call("xyz.openbmc_project.EntityManager",
644 "/xyz/openbmc_project/inventory",
Rashmica Guptae7efe132021-07-27 19:42:11 +1000645 "org.freedesktop.DBus.ObjectManager",
646 "GetManagedObjects");
647 auto reply = bus.call(method);
648 reply.read(objects);
649 }
Patrick Williams8e11ccc2022-07-22 19:26:57 -0500650 catch (const sdbusplus::exception_t& ex)
Rashmica Guptae7efe132021-07-27 19:42:11 +1000651 {
652 // If entity manager isn't running yet, keep going.
653 if (std::string("org.freedesktop.DBus.Error.ServiceUnknown") !=
654 ex.name())
655 {
Matt Spinler71b9c112022-10-18 09:14:45 -0500656 error("Could not reach entity-manager: {ERROR}", "ERROR", ex);
657 throw;
Rashmica Guptae7efe132021-07-27 19:42:11 +1000658 }
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
Ed Tanousf7ec40a2022-10-04 17:39:40 -0700964 sdbusplus::server::manager_t objManager(bus,
965 "/xyz/openbmc_project/sensors");
Matt Spinler6c19e7d2021-01-12 16:26:45 -0600966
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700967 // Create an virtual sensors object
968 phosphor::virtualSensor::VirtualSensors virtualSensors(bus);
969
970 // Request service bus name
971 bus.request_name(busName);
972
Patrick Williamse6672392022-09-02 09:03:24 -0500973 // Run the dbus loop.
974 bus.process_loop();
Vijay Khemkaabcc94f2020-08-11 15:27:44 -0700975
976 return 0;
977}