1 /**
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 #include "dbuspassive.hpp"
17 
18 #include "dbuspassiveredundancy.hpp"
19 #include "util.hpp"
20 
21 #include <chrono>
22 #include <cmath>
23 #include <memory>
24 #include <mutex>
25 #include <sdbusplus/bus.hpp>
26 #include <string>
27 #include <variant>
28 
29 std::unique_ptr<ReadInterface> DbusPassive::createDbusPassive(
30     sdbusplus::bus::bus& bus, const std::string& type, const std::string& id,
31     DbusHelperInterface* helper, const conf::SensorConfig* info,
32     const std::shared_ptr<DbusPassiveRedundancy>& redundancy)
33 {
34     if (helper == nullptr)
35     {
36         return nullptr;
37     }
38     if (!validType(type))
39     {
40         return nullptr;
41     }
42 
43     /* Need to get the scale and initial value */
44     auto tempBus = sdbusplus::bus::new_system();
45 
46     /* service == busname */
47     std::string path = getSensorPath(type, id);
48 
49     struct SensorProperties settings;
50     bool failed;
51 
52     try
53     {
54         std::string service = helper->getService(tempBus, sensorintf, path);
55 
56         helper->getProperties(tempBus, service, path, &settings);
57         failed = helper->thresholdsAsserted(tempBus, service, path);
58     }
59     catch (const std::exception& e)
60     {
61         return nullptr;
62     }
63     if (info->max != conf::inheritValueFromDbus)
64     {
65         settings.max = info->max;
66     }
67 
68     if (info->max != conf::inheritValueFromDbus)
69     {
70         settings.min = info->min;
71     }
72 
73     return std::make_unique<DbusPassive>(bus, type, id, helper, settings,
74                                          failed, path, redundancy);
75 }
76 
77 DbusPassive::DbusPassive(
78     sdbusplus::bus::bus& bus, const std::string& type, const std::string& id,
79     DbusHelperInterface* helper, const struct SensorProperties& settings,
80     bool failed, const std::string& path,
81     const std::shared_ptr<DbusPassiveRedundancy>& redundancy) :
82     ReadInterface(),
83     _bus(bus), _signal(bus, getMatch(type, id).c_str(), dbusHandleSignal, this),
84     _id(id), _helper(helper), _failed(failed), path(path),
85     redundancy(redundancy)
86 
87 {
88     _scale = settings.scale;
89     _value = settings.value * pow(10, _scale);
90     _min = settings.min * pow(10, _scale);
91     _max = settings.max * pow(10, _scale);
92     _updated = std::chrono::high_resolution_clock::now();
93 }
94 
95 ReadReturn DbusPassive::read(void)
96 {
97     std::lock_guard<std::mutex> guard(_lock);
98 
99     struct ReadReturn r = {_value, _updated};
100 
101     return r;
102 }
103 
104 void DbusPassive::setValue(double value)
105 {
106     std::lock_guard<std::mutex> guard(_lock);
107 
108     _value = value;
109     _updated = std::chrono::high_resolution_clock::now();
110 }
111 
112 bool DbusPassive::getFailed(void) const
113 {
114     if (redundancy)
115     {
116         const std::set<std::string>& failures = redundancy->getFailed();
117         if (failures.find(path) != failures.end())
118         {
119             return true;
120         }
121     }
122     return _failed;
123 }
124 
125 void DbusPassive::setFailed(bool value)
126 {
127     _failed = value;
128 }
129 
130 int64_t DbusPassive::getScale(void)
131 {
132     return _scale;
133 }
134 
135 std::string DbusPassive::getID(void)
136 {
137     return _id;
138 }
139 
140 double DbusPassive::getMax(void)
141 {
142     return _max;
143 }
144 
145 double DbusPassive::getMin(void)
146 {
147     return _min;
148 }
149 
150 int handleSensorValue(sdbusplus::message::message& msg, DbusPassive* owner)
151 {
152     std::string msgSensor;
153     std::map<std::string, std::variant<int64_t, double, bool>> msgData;
154 
155     msg.read(msgSensor, msgData);
156 
157     if (msgSensor == "xyz.openbmc_project.Sensor.Value")
158     {
159         auto valPropMap = msgData.find("Value");
160         if (valPropMap != msgData.end())
161         {
162             double value =
163                 std::visit(VariantToDoubleVisitor(), valPropMap->second);
164 
165             value *= std::pow(10, owner->getScale());
166 
167             scaleSensorReading(owner->getMin(), owner->getMax(), value);
168 
169             owner->setValue(value);
170         }
171     }
172     else if (msgSensor == "xyz.openbmc_project.Sensor.Threshold.Critical")
173     {
174         auto criticalAlarmLow = msgData.find("CriticalAlarmLow");
175         auto criticalAlarmHigh = msgData.find("CriticalAlarmHigh");
176         if (criticalAlarmHigh == msgData.end() &&
177             criticalAlarmLow == msgData.end())
178         {
179             return 0;
180         }
181 
182         bool asserted = false;
183         if (criticalAlarmLow != msgData.end())
184         {
185             asserted = std::get<bool>(criticalAlarmLow->second);
186         }
187 
188         // checking both as in theory you could de-assert one threshold and
189         // assert the other at the same moment
190         if (!asserted && criticalAlarmHigh != msgData.end())
191         {
192             asserted = std::get<bool>(criticalAlarmHigh->second);
193         }
194         owner->setFailed(asserted);
195     }
196 
197     return 0;
198 }
199 
200 int dbusHandleSignal(sd_bus_message* msg, void* usrData, sd_bus_error* err)
201 {
202     auto sdbpMsg = sdbusplus::message::message(msg);
203     DbusPassive* obj = static_cast<DbusPassive*>(usrData);
204 
205     return handleSensorValue(sdbpMsg, obj);
206 }
207