blob: 01383cbb7a921bfdffc52ea069f0f39e0b58cef6 [file] [log] [blame]
Patrick Ventureaadb30d2020-08-10 09:17:11 -07001/**
2 * Copyright 2017 Google Inc.
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 */
16
17#include "dbushelper.hpp"
18
19#include "dbushelper_interface.hpp"
20#include "dbusutil.hpp"
Patrick Ventureda4a5dd2018-08-31 09:42:48 -070021
Patrick Venturea83a3ec2020-08-04 09:52:05 -070022#include <phosphor-logging/log.hpp>
Patrick Ventureaadb30d2020-08-10 09:17:11 -070023#include <sdbusplus/bus.hpp>
Patrick Venturea83a3ec2020-08-04 09:52:05 -070024
Patrick Ventureaadb30d2020-08-10 09:17:11 -070025#include <map>
26#include <string>
James Feist1f802f52019-02-08 13:51:43 -080027#include <variant>
Patrick Ventureaadb30d2020-08-10 09:17:11 -070028#include <vector>
29
30namespace pid_control
31{
Patrick Venture863b9242018-03-08 08:29:23 -080032
Patrick Venture863b9242018-03-08 08:29:23 -080033using Property = std::string;
James Feist1f802f52019-02-08 13:51:43 -080034using Value = std::variant<int64_t, double, std::string, bool>;
Patrick Venture863b9242018-03-08 08:29:23 -080035using PropertyMap = std::map<Property, Value>;
36
Patrick Venture34ddc902018-10-30 11:05:17 -070037using namespace phosphor::logging;
38
Patrick Venture863b9242018-03-08 08:29:23 -080039/* TODO(venture): Basically all phosphor apps need this, maybe it should be a
40 * part of sdbusplus. There is an old version in libmapper.
41 */
Patrick Venture9b936922020-08-10 11:28:39 -070042std::string DbusHelper::getService(const std::string& intf,
Patrick Venture0df7c0f2018-06-13 09:02:13 -070043 const std::string& path)
Patrick Venture863b9242018-03-08 08:29:23 -080044{
Patrick Ventureda4a5dd2018-08-31 09:42:48 -070045 auto mapper =
Patrick Venture8729eb92020-08-10 10:38:44 -070046 _bus.new_method_call("xyz.openbmc_project.ObjectMapper",
47 "/xyz/openbmc_project/object_mapper",
48 "xyz.openbmc_project.ObjectMapper", "GetObject");
Patrick Venture863b9242018-03-08 08:29:23 -080049
50 mapper.append(path);
51 mapper.append(std::vector<std::string>({intf}));
52
Patrick Venture863b9242018-03-08 08:29:23 -080053 std::map<std::string, std::vector<std::string>> response;
Patrick Venture34ddc902018-10-30 11:05:17 -070054
55 try
56 {
Patrick Venture8729eb92020-08-10 10:38:44 -070057 auto responseMsg = _bus.call(mapper);
Patrick Venture34ddc902018-10-30 11:05:17 -070058
59 responseMsg.read(response);
60 }
Patrick Williamsb228bc32022-07-22 19:26:56 -050061 catch (const sdbusplus::exception_t& ex)
Patrick Venture34ddc902018-10-30 11:05:17 -070062 {
63 log<level::ERR>("ObjectMapper call failure",
64 entry("WHAT=%s", ex.what()));
65 throw;
66 }
Patrick Venture863b9242018-03-08 08:29:23 -080067
68 if (response.begin() == response.end())
69 {
70 throw std::runtime_error("Unable to find Object: " + path);
71 }
72
73 return response.begin()->first;
74}
75
Patrick Venture9b936922020-08-10 11:28:39 -070076void DbusHelper::getProperties(const std::string& service,
Patrick Venture1df9e872020-10-08 15:35:01 -070077 const std::string& path, SensorProperties* prop)
Patrick Venture863b9242018-03-08 08:29:23 -080078{
Patrick Venture8729eb92020-08-10 10:38:44 -070079 auto pimMsg = _bus.new_method_call(service.c_str(), path.c_str(),
80 propertiesintf, "GetAll");
Patrick Venture863b9242018-03-08 08:29:23 -080081
82 pimMsg.append(sensorintf);
Patrick Venture863b9242018-03-08 08:29:23 -080083
Patrick Venture7dbc5172018-10-30 12:18:45 -070084 PropertyMap propMap;
85
86 try
Patrick Venture863b9242018-03-08 08:29:23 -080087 {
Patrick Venture8729eb92020-08-10 10:38:44 -070088 auto valueResponseMsg = _bus.call(pimMsg);
Patrick Venture7dbc5172018-10-30 12:18:45 -070089 valueResponseMsg.read(propMap);
90 }
Patrick Williamsb228bc32022-07-22 19:26:56 -050091 catch (const sdbusplus::exception_t& ex)
Patrick Venture7dbc5172018-10-30 12:18:45 -070092 {
93 log<level::ERR>("GetAll Properties Failed",
94 entry("WHAT=%s", ex.what()));
95 throw;
Patrick Venture863b9242018-03-08 08:29:23 -080096 }
97
98 // The PropertyMap returned will look like this because it's always
99 // reading a Sensor.Value interface.
100 // a{sv} 3:
101 // "Value" x 24875
102 // "Unit" s "xyz.openbmc_project.Sensor.Value.Unit.DegreesC"
103 // "Scale" x -3
Patrick Venture863b9242018-03-08 08:29:23 -0800104
Patrick Venture0d73b102018-05-09 10:29:42 -0700105 // If no error was set, the values should all be there.
James Feistc065cf12018-07-05 10:23:11 -0700106 auto findUnit = propMap.find("Unit");
107 if (findUnit != propMap.end())
108 {
James Feist1f802f52019-02-08 13:51:43 -0800109 prop->unit = std::get<std::string>(findUnit->second);
James Feistc065cf12018-07-05 10:23:11 -0700110 }
111 auto findScale = propMap.find("Scale");
James Feist75eb7692019-02-25 12:50:02 -0800112 auto findMax = propMap.find("MaxValue");
113 auto findMin = propMap.find("MinValue");
114
115 prop->min = 0;
116 prop->max = 0;
117 prop->scale = 0;
James Feistc065cf12018-07-05 10:23:11 -0700118 if (findScale != propMap.end())
119 {
James Feist1f802f52019-02-08 13:51:43 -0800120 prop->scale = std::get<int64_t>(findScale->second);
James Feistc065cf12018-07-05 10:23:11 -0700121 }
James Feist75eb7692019-02-25 12:50:02 -0800122 if (findMax != propMap.end())
James Feistc065cf12018-07-05 10:23:11 -0700123 {
James Feist75eb7692019-02-25 12:50:02 -0800124 prop->max = std::visit(VariantToDoubleVisitor(), findMax->second);
125 }
126 if (findMin != propMap.end())
127 {
128 prop->min = std::visit(VariantToDoubleVisitor(), findMin->second);
James Feistc065cf12018-07-05 10:23:11 -0700129 }
130
James Feist1f802f52019-02-08 13:51:43 -0800131 prop->value = std::visit(VariantToDoubleVisitor(), propMap["Value"]);
Patrick Venture863b9242018-03-08 08:29:23 -0800132
Alex.Song8f73ad72021-10-07 00:18:27 +0800133 bool available = true;
134 try
135 {
136 getProperty(service, path, availabilityIntf, "Available", available);
137 }
Patrick Williamsb228bc32022-07-22 19:26:56 -0500138 catch (const sdbusplus::exception_t& ex)
Alex.Song8f73ad72021-10-07 00:18:27 +0800139 {
140 // unsupported Available property, leaving reading at 'True'
141 }
142 prop->available = available;
143
Patrick Venture863b9242018-03-08 08:29:23 -0800144 return;
145}
146
Patrick Venture9b936922020-08-10 11:28:39 -0700147bool DbusHelper::thresholdsAsserted(const std::string& service,
James Feist36b7d8e2018-10-05 15:39:01 -0700148 const std::string& path)
149{
150
Patrick Venture8729eb92020-08-10 10:38:44 -0700151 auto critical = _bus.new_method_call(service.c_str(), path.c_str(),
152 propertiesintf, "GetAll");
James Feist36b7d8e2018-10-05 15:39:01 -0700153 critical.append(criticalThreshInf);
154 PropertyMap criticalMap;
155
156 try
157 {
Patrick Venture8729eb92020-08-10 10:38:44 -0700158 auto msg = _bus.call(critical);
Patrick Venture4fd8cff2018-10-31 14:24:12 -0700159 msg.read(criticalMap);
James Feist36b7d8e2018-10-05 15:39:01 -0700160 }
Patrick Williams0001ee02021-10-06 14:44:22 -0500161 catch (const sdbusplus::exception_t&)
James Feist36b7d8e2018-10-05 15:39:01 -0700162 {
163 // do nothing, sensors don't have to expose critical thresholds
164 return false;
165 }
166
167 auto findCriticalLow = criticalMap.find("CriticalAlarmLow");
168 auto findCriticalHigh = criticalMap.find("CriticalAlarmHigh");
169
170 bool asserted = false;
171 if (findCriticalLow != criticalMap.end())
172 {
James Feist1f802f52019-02-08 13:51:43 -0800173 asserted = std::get<bool>(findCriticalLow->second);
James Feist36b7d8e2018-10-05 15:39:01 -0700174 }
175
176 // as we are catching properties changed, a sensor could theoretically jump
177 // from one threshold to the other in one event, so check both thresholds
178 if (!asserted && findCriticalHigh != criticalMap.end())
179 {
James Feist1f802f52019-02-08 13:51:43 -0800180 asserted = std::get<bool>(findCriticalHigh->second);
James Feist36b7d8e2018-10-05 15:39:01 -0700181 }
182 return asserted;
183}
184
Patrick Venturea0764872020-08-08 07:48:43 -0700185} // namespace pid_control