blob: 09f0d8801666b50cab0f340dee440c5d1e0c1350 [file] [log] [blame]
James Feist7136a5a2018-07-19 09:52:05 -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*/
Patrick Venture7e952d92020-10-05 15:58:52 -070016#include "dbusconfiguration.hpp"
James Feist7136a5a2018-07-19 09:52:05 -070017
Patrick Venture07716592018-10-14 11:46:40 -070018#include "conf.hpp"
Patrick Ventureef1f8862020-08-17 09:34:35 -070019#include "dbushelper.hpp"
20#include "dbusutil.hpp"
James Feist0c8223b2019-05-08 15:33:33 -070021#include "util.hpp"
Patrick Venture07716592018-10-14 11:46:40 -070022
James Feist1fe08952019-05-07 09:17:16 -070023#include <boost/asio/steady_timer.hpp>
Patrick Venturea83a3ec2020-08-04 09:52:05 -070024#include <sdbusplus/bus.hpp>
25#include <sdbusplus/bus/match.hpp>
26#include <sdbusplus/exception.hpp>
27
28#include <algorithm>
James Feist64f072a2018-08-10 16:39:24 -070029#include <chrono>
James Feist64f072a2018-08-10 16:39:24 -070030#include <functional>
James Feist7136a5a2018-07-19 09:52:05 -070031#include <iostream>
James Feist1fe08952019-05-07 09:17:16 -070032#include <list>
James Feist7136a5a2018-07-19 09:52:05 -070033#include <set>
34#include <unordered_map>
James Feist1f802f52019-02-08 13:51:43 -080035#include <variant>
James Feist7136a5a2018-07-19 09:52:05 -070036
Patrick Venturea0764872020-08-08 07:48:43 -070037namespace pid_control
38{
39
James Feistf81f2882019-02-26 11:26:36 -080040extern std::map<std::string, struct conf::SensorConfig> sensorConfig;
41extern std::map<int64_t, conf::PIDConf> zoneConfig;
42extern std::map<int64_t, struct conf::ZoneConfig> zoneDetailsConfig;
James Feist7136a5a2018-07-19 09:52:05 -070043
Patrick Venturee2ec0f62018-09-04 12:30:27 -070044constexpr const char* pidConfigurationInterface =
James Feist7136a5a2018-07-19 09:52:05 -070045 "xyz.openbmc_project.Configuration.Pid";
Patrick Venturee2ec0f62018-09-04 12:30:27 -070046constexpr const char* objectManagerInterface =
James Feist7136a5a2018-07-19 09:52:05 -070047 "org.freedesktop.DBus.ObjectManager";
Patrick Venturee2ec0f62018-09-04 12:30:27 -070048constexpr const char* pidZoneConfigurationInterface =
James Feist7136a5a2018-07-19 09:52:05 -070049 "xyz.openbmc_project.Configuration.Pid.Zone";
James Feist22c257a2018-08-31 14:07:12 -070050constexpr const char* stepwiseConfigurationInterface =
51 "xyz.openbmc_project.Configuration.Stepwise";
James Feistf0096a02019-02-21 11:25:22 -080052constexpr const char* thermalControlIface =
53 "xyz.openbmc_project.Control.ThermalMode";
Patrick Venturee2ec0f62018-09-04 12:30:27 -070054constexpr const char* sensorInterface = "xyz.openbmc_project.Sensor.Value";
Patrick Venture0911bfe2020-08-10 12:51:40 -070055constexpr const char* defaultPwmInterface =
56 "xyz.openbmc_project.Control.FanPwm";
James Feist7136a5a2018-07-19 09:52:05 -070057
James Feist991ebd82020-07-21 11:14:52 -070058using Association = std::tuple<std::string, std::string, std::string>;
59using Associations = std::vector<Association>;
60
James Feist5ec20272019-07-10 11:59:57 -070061namespace thresholds
62{
63constexpr const char* warningInterface =
64 "xyz.openbmc_project.Sensor.Threshold.Warning";
65constexpr const char* criticalInterface =
66 "xyz.openbmc_project.Sensor.Threshold.Critical";
67const std::array<const char*, 4> types = {"CriticalLow", "CriticalHigh",
68 "WarningLow", "WarningHigh"};
69
70} // namespace thresholds
71
James Feist7136a5a2018-07-19 09:52:05 -070072namespace dbus_configuration
73{
Jason Lingf3b04fd2020-07-24 09:33:04 -070074using SensorInterfaceType = std::pair<std::string, std::string>;
75
76inline std::string getSensorNameFromPath(const std::string& dbusPath)
77{
78 return dbusPath.substr(dbusPath.find_last_of("/") + 1);
79}
80
81inline std::string sensorNameToDbusName(const std::string& sensorName)
82{
83 std::string retString = sensorName;
84 std::replace(retString.begin(), retString.end(), ' ', '_');
85 return retString;
86}
James Feist5ec20272019-07-10 11:59:57 -070087
James Feistf0096a02019-02-21 11:25:22 -080088std::vector<std::string> getSelectedProfiles(sdbusplus::bus::bus& bus)
89{
90 std::vector<std::string> ret;
91 auto mapper =
92 bus.new_method_call("xyz.openbmc_project.ObjectMapper",
93 "/xyz/openbmc_project/object_mapper",
94 "xyz.openbmc_project.ObjectMapper", "GetSubTree");
95 mapper.append("/", 0, std::array<const char*, 1>{thermalControlIface});
96 std::unordered_map<
97 std::string, std::unordered_map<std::string, std::vector<std::string>>>
98 respData;
99
100 try
101 {
102 auto resp = bus.call(mapper);
103 resp.read(respData);
104 }
105 catch (sdbusplus::exception_t&)
106 {
107 // can't do anything without mapper call data
108 throw std::runtime_error("ObjectMapper Call Failure");
109 }
110 if (respData.empty())
111 {
112 // if the user has profiles but doesn't expose the interface to select
113 // one, just go ahead without using profiles
114 return ret;
115 }
116
117 // assumption is that we should only have a small handful of selected
118 // profiles at a time (probably only 1), so calling each individually should
119 // not incur a large cost
120 for (const auto& objectPair : respData)
121 {
122 const std::string& path = objectPair.first;
123 for (const auto& ownerPair : objectPair.second)
124 {
125 const std::string& busName = ownerPair.first;
126 auto getProfile =
127 bus.new_method_call(busName.c_str(), path.c_str(),
128 "org.freedesktop.DBus.Properties", "Get");
129 getProfile.append(thermalControlIface, "Current");
130 std::variant<std::string> variantResp;
131 try
132 {
133 auto resp = bus.call(getProfile);
134 resp.read(variantResp);
135 }
136 catch (sdbusplus::exception_t&)
137 {
138 throw std::runtime_error("Failure getting profile");
139 }
140 std::string mode = std::get<std::string>(variantResp);
141 ret.emplace_back(std::move(mode));
142 }
143 }
Patrick Venture39199b42020-10-08 14:40:29 -0700144 if constexpr (pid_control::conf::DEBUG)
James Feistf0096a02019-02-21 11:25:22 -0800145 {
146 std::cout << "Profiles selected: ";
147 for (const auto& profile : ret)
148 {
149 std::cout << profile << " ";
150 }
151 std::cout << "\n";
152 }
153 return ret;
154}
155
James Feist991ebd82020-07-21 11:14:52 -0700156int eventHandler(sd_bus_message* m, void* context, sd_bus_error*)
James Feist7136a5a2018-07-19 09:52:05 -0700157{
James Feist1fe08952019-05-07 09:17:16 -0700158
James Feist991ebd82020-07-21 11:14:52 -0700159 if (context == nullptr || m == nullptr)
James Feist1fe08952019-05-07 09:17:16 -0700160 {
161 throw std::runtime_error("Invalid match");
162 }
James Feist991ebd82020-07-21 11:14:52 -0700163
164 // we skip associations because the mapper populates these, not the sensors
165 const std::array<const char*, 1> skipList = {
166 "xyz.openbmc_project.Association"};
167
168 sdbusplus::message::message message(m);
169 if (std::string(message.get_member()) == "InterfacesAdded")
170 {
171 sdbusplus::message::object_path path;
172 std::unordered_map<
173 std::string,
174 std::unordered_map<std::string, std::variant<Associations, bool>>>
175 data;
176
177 message.read(path, data);
178
179 for (const char* skip : skipList)
180 {
181 auto find = data.find(skip);
182 if (find != data.end())
183 {
184 data.erase(find);
185 if (data.empty())
186 {
187 return 1;
188 }
189 }
190 }
191 }
192
James Feist1fe08952019-05-07 09:17:16 -0700193 boost::asio::steady_timer* timer =
194 static_cast<boost::asio::steady_timer*>(context);
195
196 // do a brief sleep as we tend to get a bunch of these events at
197 // once
198 timer->expires_after(std::chrono::seconds(2));
199 timer->async_wait([](const boost::system::error_code ec) {
200 if (ec == boost::asio::error::operation_aborted)
201 {
202 /* another timer started*/
203 return;
204 }
205
206 std::cout << "New configuration detected, reloading\n.";
Yong Li298a95c2020-04-07 15:11:02 +0800207 tryRestartControlLoops();
James Feist1fe08952019-05-07 09:17:16 -0700208 });
209
210 return 1;
211}
212
213void createMatches(sdbusplus::bus::bus& bus, boost::asio::steady_timer& timer)
214{
215 // this is a list because the matches can't be moved
216 static std::list<sdbusplus::bus::match::match> matches;
217
James Feist3987c8b2019-05-13 10:43:17 -0700218 const std::array<std::string, 4> interfaces = {
219 thermalControlIface, pidConfigurationInterface,
220 pidZoneConfigurationInterface, stepwiseConfigurationInterface};
James Feist1fe08952019-05-07 09:17:16 -0700221
222 // this list only needs to be created once
223 if (!matches.empty())
224 {
225 return;
226 }
227
228 // we restart when the configuration changes or there are new sensors
229 for (const auto& interface : interfaces)
230 {
231 matches.emplace_back(
232 bus,
233 "type='signal',member='PropertiesChanged',arg0namespace='" +
234 interface + "'",
235 eventHandler, &timer);
236 }
237 matches.emplace_back(
238 bus,
239 "type='signal',member='InterfacesAdded',arg0path='/xyz/openbmc_project/"
240 "sensors/'",
241 eventHandler, &timer);
242}
243
Jason Ling6fc301f2020-07-23 12:39:57 -0700244/**
245 * retrieve an attribute from the pid configuration map
246 * @param[in] base - the PID configuration map, keys are the attributes and
247 * value is the variant associated with that attribute.
248 * @param attributeName - the name of the attribute
249 * @return a variant holding the value associated with a key
250 * @throw runtime_error : attributeName is not in base
251 */
252inline DbusVariantType getPIDAttribute(
253 const std::unordered_map<std::string, DbusVariantType>& base,
254 const std::string& attributeName)
255{
256 auto search = base.find(attributeName);
257 if (search == base.end())
258 {
259 throw std::runtime_error("missing attribute " + attributeName);
260 }
261 return search->second;
262}
263
James Feist5ec20272019-07-10 11:59:57 -0700264void populatePidInfo(
265 sdbusplus::bus::bus& bus,
266 const std::unordered_map<std::string, DbusVariantType>& base,
267 struct conf::ControllerInfo& info, const std::string* thresholdProperty)
268{
Jason Ling6fc301f2020-07-23 12:39:57 -0700269 info.type = std::get<std::string>(getPIDAttribute(base, "Class"));
James Feist5ec20272019-07-10 11:59:57 -0700270 if (info.type == "fan")
271 {
272 info.setpoint = 0;
273 }
274 else
275 {
Jason Ling6fc301f2020-07-23 12:39:57 -0700276 info.setpoint = std::visit(VariantToDoubleVisitor(),
277 getPIDAttribute(base, "SetPoint"));
James Feist5ec20272019-07-10 11:59:57 -0700278 }
279
280 if (thresholdProperty != nullptr)
281 {
282 std::string interface;
283 if (*thresholdProperty == "WarningHigh" ||
284 *thresholdProperty == "WarningLow")
285 {
286 interface = thresholds::warningInterface;
287 }
288 else
289 {
290 interface = thresholds::criticalInterface;
291 }
292 const std::string& path = sensorConfig[info.inputs.front()].readPath;
293
Patrick Venture8729eb92020-08-10 10:38:44 -0700294 DbusHelper helper(sdbusplus::bus::new_system());
Patrick Venture9b936922020-08-10 11:28:39 -0700295 std::string service = helper.getService(interface, path);
James Feist5ec20272019-07-10 11:59:57 -0700296 double reading = 0;
297 try
298 {
Patrick Venture9b936922020-08-10 11:28:39 -0700299 helper.getProperty(service, path, interface, *thresholdProperty,
300 reading);
James Feist5ec20272019-07-10 11:59:57 -0700301 }
302 catch (const sdbusplus::exception::SdBusError& ex)
303 {
304 // unsupported threshold, leaving reading at 0
305 }
306
307 info.setpoint += reading;
308 }
309
310 info.pidInfo.ts = 1.0; // currently unused
Jason Ling6fc301f2020-07-23 12:39:57 -0700311 info.pidInfo.proportionalCoeff = std::visit(
312 VariantToDoubleVisitor(), getPIDAttribute(base, "PCoefficient"));
313 info.pidInfo.integralCoeff = std::visit(
314 VariantToDoubleVisitor(), getPIDAttribute(base, "ICoefficient"));
315 info.pidInfo.feedFwdOffset = std::visit(
316 VariantToDoubleVisitor(), getPIDAttribute(base, "FFOffCoefficient"));
317 info.pidInfo.feedFwdGain = std::visit(
318 VariantToDoubleVisitor(), getPIDAttribute(base, "FFGainCoefficient"));
319 info.pidInfo.integralLimit.max = std::visit(
320 VariantToDoubleVisitor(), getPIDAttribute(base, "ILimitMax"));
321 info.pidInfo.integralLimit.min = std::visit(
322 VariantToDoubleVisitor(), getPIDAttribute(base, "ILimitMin"));
323 info.pidInfo.outLim.max = std::visit(VariantToDoubleVisitor(),
324 getPIDAttribute(base, "OutLimitMax"));
325 info.pidInfo.outLim.min = std::visit(VariantToDoubleVisitor(),
326 getPIDAttribute(base, "OutLimitMin"));
James Feist5ec20272019-07-10 11:59:57 -0700327 info.pidInfo.slewNeg =
Jason Ling6fc301f2020-07-23 12:39:57 -0700328 std::visit(VariantToDoubleVisitor(), getPIDAttribute(base, "SlewNeg"));
James Feist5ec20272019-07-10 11:59:57 -0700329 info.pidInfo.slewPos =
Jason Ling6fc301f2020-07-23 12:39:57 -0700330 std::visit(VariantToDoubleVisitor(), getPIDAttribute(base, "SlewPos"));
James Feist5ec20272019-07-10 11:59:57 -0700331 double negativeHysteresis = 0;
332 double positiveHysteresis = 0;
333
334 auto findNeg = base.find("NegativeHysteresis");
335 auto findPos = base.find("PositiveHysteresis");
336
337 if (findNeg != base.end())
338 {
339 negativeHysteresis =
340 std::visit(VariantToDoubleVisitor(), findNeg->second);
341 }
342
343 if (findPos != base.end())
344 {
345 positiveHysteresis =
346 std::visit(VariantToDoubleVisitor(), findPos->second);
347 }
James Feist5ec20272019-07-10 11:59:57 -0700348 info.pidInfo.negativeHysteresis = negativeHysteresis;
349 info.pidInfo.positiveHysteresis = positiveHysteresis;
350}
351
James Feist1fe08952019-05-07 09:17:16 -0700352bool init(sdbusplus::bus::bus& bus, boost::asio::steady_timer& timer)
353{
354
355 sensorConfig.clear();
356 zoneConfig.clear();
357 zoneDetailsConfig.clear();
358
359 createMatches(bus, timer);
360
James Feist7136a5a2018-07-19 09:52:05 -0700361 auto mapper =
362 bus.new_method_call("xyz.openbmc_project.ObjectMapper",
363 "/xyz/openbmc_project/object_mapper",
364 "xyz.openbmc_project.ObjectMapper", "GetSubTree");
James Feist26e8c6a2018-10-25 10:38:26 -0700365 mapper.append("/", 0,
Patrick Venture0911bfe2020-08-10 12:51:40 -0700366 std::array<const char*, 6>{
367 objectManagerInterface, pidConfigurationInterface,
368 pidZoneConfigurationInterface,
369 stepwiseConfigurationInterface, sensorInterface,
370 defaultPwmInterface});
James Feist7136a5a2018-07-19 09:52:05 -0700371 std::unordered_map<
372 std::string, std::unordered_map<std::string, std::vector<std::string>>>
373 respData;
James Feist22c257a2018-08-31 14:07:12 -0700374 try
375 {
376 auto resp = bus.call(mapper);
James Feist22c257a2018-08-31 14:07:12 -0700377 resp.read(respData);
378 }
379 catch (sdbusplus::exception_t&)
380 {
381 // can't do anything without mapper call data
382 throw std::runtime_error("ObjectMapper Call Failure");
383 }
James Feist7136a5a2018-07-19 09:52:05 -0700384
James Feist7136a5a2018-07-19 09:52:05 -0700385 if (respData.empty())
386 {
James Feist22c257a2018-08-31 14:07:12 -0700387 // can't do anything without mapper call data
James Feist7136a5a2018-07-19 09:52:05 -0700388 throw std::runtime_error("No configuration data available from Mapper");
389 }
390 // create a map of pair of <has pid configuration, ObjectManager path>
391 std::unordered_map<std::string, std::pair<bool, std::string>> owners;
392 // and a map of <path, interface> for sensors
393 std::unordered_map<std::string, std::string> sensors;
Patrick Venturee2ec0f62018-09-04 12:30:27 -0700394 for (const auto& objectPair : respData)
James Feist7136a5a2018-07-19 09:52:05 -0700395 {
Patrick Venturee2ec0f62018-09-04 12:30:27 -0700396 for (const auto& ownerPair : objectPair.second)
James Feist7136a5a2018-07-19 09:52:05 -0700397 {
Patrick Venturee2ec0f62018-09-04 12:30:27 -0700398 auto& owner = owners[ownerPair.first];
399 for (const std::string& interface : ownerPair.second)
James Feist7136a5a2018-07-19 09:52:05 -0700400 {
401
402 if (interface == objectManagerInterface)
403 {
404 owner.second = objectPair.first;
405 }
406 if (interface == pidConfigurationInterface ||
James Feist22c257a2018-08-31 14:07:12 -0700407 interface == pidZoneConfigurationInterface ||
408 interface == stepwiseConfigurationInterface)
James Feist7136a5a2018-07-19 09:52:05 -0700409 {
410 owner.first = true;
411 }
Patrick Venture0911bfe2020-08-10 12:51:40 -0700412 if (interface == sensorInterface ||
413 interface == defaultPwmInterface)
James Feist7136a5a2018-07-19 09:52:05 -0700414 {
415 // we're not interested in pwm sensors, just pwm control
416 if (interface == sensorInterface &&
417 objectPair.first.find("pwm") != std::string::npos)
418 {
419 continue;
420 }
421 sensors[objectPair.first] = interface;
422 }
423 }
424 }
425 }
426 ManagedObjectType configurations;
Patrick Venturee2ec0f62018-09-04 12:30:27 -0700427 for (const auto& owner : owners)
James Feist7136a5a2018-07-19 09:52:05 -0700428 {
429 // skip if no pid configuration (means probably a sensor)
430 if (!owner.second.first)
431 {
432 continue;
433 }
434 auto endpoint = bus.new_method_call(
435 owner.first.c_str(), owner.second.second.c_str(),
436 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
James Feist22c257a2018-08-31 14:07:12 -0700437 ManagedObjectType configuration;
438 try
James Feist7136a5a2018-07-19 09:52:05 -0700439 {
James Feist22c257a2018-08-31 14:07:12 -0700440 auto responce = bus.call(endpoint);
James Feist22c257a2018-08-31 14:07:12 -0700441 responce.read(configuration);
442 }
443 catch (sdbusplus::exception_t&)
444 {
445 // this shouldn't happen, probably means daemon crashed
James Feist7136a5a2018-07-19 09:52:05 -0700446 throw std::runtime_error("Error getting managed objects from " +
447 owner.first);
448 }
James Feist22c257a2018-08-31 14:07:12 -0700449
Patrick Venturee2ec0f62018-09-04 12:30:27 -0700450 for (auto& pathPair : configuration)
James Feist7136a5a2018-07-19 09:52:05 -0700451 {
452 if (pathPair.second.find(pidConfigurationInterface) !=
453 pathPair.second.end() ||
454 pathPair.second.find(pidZoneConfigurationInterface) !=
James Feist22c257a2018-08-31 14:07:12 -0700455 pathPair.second.end() ||
456 pathPair.second.find(stepwiseConfigurationInterface) !=
James Feist7136a5a2018-07-19 09:52:05 -0700457 pathPair.second.end())
458 {
459 configurations.emplace(pathPair);
460 }
James Feistf0096a02019-02-21 11:25:22 -0800461 }
462 }
463
464 // remove controllers from config that aren't in the current profile(s)
James Feist3987c8b2019-05-13 10:43:17 -0700465 std::vector<std::string> selectedProfiles = getSelectedProfiles(bus);
466 if (selectedProfiles.size())
James Feistf0096a02019-02-21 11:25:22 -0800467 {
James Feist3987c8b2019-05-13 10:43:17 -0700468 for (auto pathIt = configurations.begin();
469 pathIt != configurations.end();)
James Feistf0096a02019-02-21 11:25:22 -0800470 {
James Feist3987c8b2019-05-13 10:43:17 -0700471 for (auto confIt = pathIt->second.begin();
472 confIt != pathIt->second.end();)
James Feistf0096a02019-02-21 11:25:22 -0800473 {
James Feist3987c8b2019-05-13 10:43:17 -0700474 auto profilesFind = confIt->second.find("Profiles");
475 if (profilesFind == confIt->second.end())
James Feistf0096a02019-02-21 11:25:22 -0800476 {
James Feist3987c8b2019-05-13 10:43:17 -0700477 confIt++;
478 continue; // if no profiles selected, apply always
479 }
480 auto profiles =
481 std::get<std::vector<std::string>>(profilesFind->second);
482 if (profiles.empty())
483 {
484 confIt++;
485 continue;
486 }
487
488 bool found = false;
489 for (const std::string& profile : profiles)
490 {
491 if (std::find(selectedProfiles.begin(),
492 selectedProfiles.end(),
493 profile) != selectedProfiles.end())
494 {
495 found = true;
496 break;
497 }
498 }
499 if (found)
500 {
501 confIt++;
James Feistf0096a02019-02-21 11:25:22 -0800502 }
503 else
504 {
James Feist3987c8b2019-05-13 10:43:17 -0700505 confIt = pathIt->second.erase(confIt);
James Feistf0096a02019-02-21 11:25:22 -0800506 }
507 }
James Feist3987c8b2019-05-13 10:43:17 -0700508 if (pathIt->second.empty())
James Feistf0096a02019-02-21 11:25:22 -0800509 {
James Feist3987c8b2019-05-13 10:43:17 -0700510 pathIt = configurations.erase(pathIt);
James Feistf0096a02019-02-21 11:25:22 -0800511 }
James Feist3987c8b2019-05-13 10:43:17 -0700512 else
James Feistf0096a02019-02-21 11:25:22 -0800513 {
James Feist3987c8b2019-05-13 10:43:17 -0700514 pathIt++;
James Feistf0096a02019-02-21 11:25:22 -0800515 }
James Feist7136a5a2018-07-19 09:52:05 -0700516 }
517 }
James Feist8c3c51e2018-08-08 16:31:43 -0700518
Josh Lehan998fbe62020-09-20 21:21:05 -0700519 // On D-Bus, although not necessary,
520 // having the "zoneID" field can still be useful,
521 // as it is used for diagnostic messages,
522 // logging file names, and so on.
523 // Accept optional "ZoneIndex" parameter to explicitly specify.
524 // If not present, or not unique, auto-assign index,
525 // using 0-based numbering, ensuring uniqueness.
526 std::map<std::string, int64_t> foundZones;
Patrick Venturee2ec0f62018-09-04 12:30:27 -0700527 for (const auto& configuration : configurations)
James Feist7136a5a2018-07-19 09:52:05 -0700528 {
529 auto findZone =
530 configuration.second.find(pidZoneConfigurationInterface);
531 if (findZone != configuration.second.end())
532 {
Patrick Venturee2ec0f62018-09-04 12:30:27 -0700533 const auto& zone = findZone->second;
James Feistffd418b2018-11-15 14:46:36 -0800534
James Feist1f802f52019-02-08 13:51:43 -0800535 const std::string& name = std::get<std::string>(zone.at("Name"));
Josh Lehan998fbe62020-09-20 21:21:05 -0700536
537 auto findZoneIndex = zone.find("ZoneIndex");
538 if (findZoneIndex == zone.end())
539 {
540 continue;
541 }
542
543 auto ptrZoneIndex = std::get_if<double>(&(findZoneIndex->second));
544 if (!ptrZoneIndex)
545 {
546 continue;
547 }
548
549 auto desiredIndex = static_cast<int64_t>(*ptrZoneIndex);
550 auto grantedIndex = setZoneIndex(name, foundZones, desiredIndex);
551 std::cout << "Zone " << name << " is at ZoneIndex " << grantedIndex
552 << "\n";
553 }
554 }
555
556 for (const auto& configuration : configurations)
557 {
558 auto findZone =
559 configuration.second.find(pidZoneConfigurationInterface);
560 if (findZone != configuration.second.end())
561 {
562 const auto& zone = findZone->second;
563
564 const std::string& name = std::get<std::string>(zone.at("Name"));
565
566 auto index = getZoneIndex(name, foundZones);
James Feist8c3c51e2018-08-08 16:31:43 -0700567
Patrick Venturec54fbd82018-10-30 19:40:05 -0700568 auto& details = zoneDetailsConfig[index];
Josh Lehan998fbe62020-09-20 21:21:05 -0700569
James Feist3484bed2019-02-25 13:28:18 -0800570 details.minThermalOutput = std::visit(VariantToDoubleVisitor(),
571 zone.at("MinThermalOutput"));
Patrick Venture8e2fdb32019-02-11 09:39:59 -0800572 details.failsafePercent = std::visit(VariantToDoubleVisitor(),
James Feist1f802f52019-02-08 13:51:43 -0800573 zone.at("FailSafePercent"));
James Feist7136a5a2018-07-19 09:52:05 -0700574 }
575 auto findBase = configuration.second.find(pidConfigurationInterface);
Jason Lingf3b04fd2020-07-24 09:33:04 -0700576 // loop through all the PID configurations and fill out a sensor config
James Feist22c257a2018-08-31 14:07:12 -0700577 if (findBase != configuration.second.end())
James Feist7136a5a2018-07-19 09:52:05 -0700578 {
James Feist22c257a2018-08-31 14:07:12 -0700579 const auto& base =
580 configuration.second.at(pidConfigurationInterface);
Jason Lingf3b04fd2020-07-24 09:33:04 -0700581 const std::string pidName = std::get<std::string>(base.at("Name"));
582 const std::string pidClass =
583 std::get<std::string>(base.at("Class"));
James Feist22c257a2018-08-31 14:07:12 -0700584 const std::vector<std::string>& zones =
James Feist1f802f52019-02-08 13:51:43 -0800585 std::get<std::vector<std::string>>(base.at("Zones"));
James Feist22c257a2018-08-31 14:07:12 -0700586 for (const std::string& zone : zones)
James Feist7136a5a2018-07-19 09:52:05 -0700587 {
Josh Lehan998fbe62020-09-20 21:21:05 -0700588 auto index = getZoneIndex(zone, foundZones);
589
James Feistf81f2882019-02-26 11:26:36 -0800590 conf::PIDConf& conf = zoneConfig[index];
Jason Lingf3b04fd2020-07-24 09:33:04 -0700591 std::vector<std::string> inputSensorNames(
592 std::get<std::vector<std::string>>(base.at("Inputs")));
593 std::vector<std::string> outputSensorNames;
James Feist50fdfe32018-09-24 15:51:09 -0700594
Jason Lingf3b04fd2020-07-24 09:33:04 -0700595 // assumption: all fan pids must have at least one output
596 if (pidClass == "fan")
James Feist50fdfe32018-09-24 15:51:09 -0700597 {
Jason Lingf3b04fd2020-07-24 09:33:04 -0700598 outputSensorNames = std::get<std::vector<std::string>>(
599 getPIDAttribute(base, "Outputs"));
James Feist50fdfe32018-09-24 15:51:09 -0700600 }
James Feist1738e2a2019-02-04 15:57:03 -0800601
Jason Lingf3b04fd2020-07-24 09:33:04 -0700602 std::vector<SensorInterfaceType> inputSensorInterfaces;
603 std::vector<SensorInterfaceType> outputSensorInterfaces;
604 /* populate an interface list for different sensor direction
605 * types (input,output)
606 */
607 /* take the Inputs from the configuration and generate
608 * a list of dbus descriptors (path, interface).
609 * Mapping can be many-to-one since an element of Inputs can be
610 * a regex
611 */
612 for (const std::string& sensorName : inputSensorNames)
James Feist50fdfe32018-09-24 15:51:09 -0700613 {
Jason Lingf3b04fd2020-07-24 09:33:04 -0700614 findSensors(sensors, sensorNameToDbusName(sensorName),
615 inputSensorInterfaces);
616 }
617 for (const std::string& sensorName : outputSensorNames)
618 {
619 findSensors(sensors, sensorNameToDbusName(sensorName),
620 outputSensorInterfaces);
James Feist1738e2a2019-02-04 15:57:03 -0800621 }
James Feist50fdfe32018-09-24 15:51:09 -0700622
Jason Lingf3b04fd2020-07-24 09:33:04 -0700623 inputSensorNames.clear();
624 for (const SensorInterfaceType& inputSensorInterface :
625 inputSensorInterfaces)
James Feist1738e2a2019-02-04 15:57:03 -0800626 {
Jason Lingf3b04fd2020-07-24 09:33:04 -0700627 const std::string& dbusInterface =
628 inputSensorInterface.second;
629 const std::string& inputSensorPath =
630 inputSensorInterface.first;
631 std::string inputSensorName =
632 getSensorNameFromPath(inputSensorPath);
633 auto& config = sensorConfig[inputSensorName];
634 inputSensorNames.push_back(inputSensorName);
635 config.type = pidClass;
636 config.readPath = inputSensorInterface.first;
637 // todo: maybe un-hardcode this if we run into slower
638 // timeouts with sensors
639 if (config.type == "temp")
James Feist50fdfe32018-09-24 15:51:09 -0700640 {
Jason Lingf3b04fd2020-07-24 09:33:04 -0700641 config.timeout = 0;
642 config.ignoreDbusMinMax = true;
James Feist50fdfe32018-09-24 15:51:09 -0700643 }
Jason Lingf3b04fd2020-07-24 09:33:04 -0700644 if (dbusInterface != sensorInterface)
James Feist50fdfe32018-09-24 15:51:09 -0700645 {
Jason Lingf3b04fd2020-07-24 09:33:04 -0700646 /* all expected inputs in the configuration are expected
647 * to be sensor interfaces
648 */
649 throw std::runtime_error(
650 "sensor at dbus path [" + inputSensorPath +
651 "] has an interface [" + dbusInterface +
652 "] that does not match the expected interface of " +
653 sensorInterface);
James Feist50fdfe32018-09-24 15:51:09 -0700654 }
655 }
James Feist1738e2a2019-02-04 15:57:03 -0800656
Jason Lingf3b04fd2020-07-24 09:33:04 -0700657 /* fan pids need to pair up tach sensors with their pwm
658 * counterparts
659 */
660 if (pidClass == "fan")
661 {
662 /* If a PID is a fan there should be either
663 * (1) one output(pwm) per input(tach)
664 * OR
665 * (2) one putput(pwm) for all inputs(tach)
666 * everything else indicates a bad configuration.
667 */
668 bool singlePwm = false;
669 if (outputSensorInterfaces.size() == 1)
670 {
671 /* one pwm, set write paths for all fan sensors to it */
672 singlePwm = true;
673 }
674 else if (inputSensorInterfaces.size() ==
675 outputSensorInterfaces.size())
676 {
677 /* one to one mapping, each fan sensor gets its own pwm
678 * control */
679 singlePwm = false;
680 }
681 else
682 {
683 throw std::runtime_error(
684 "fan PID has invalid number of Outputs");
685 }
686 std::string fanSensorName;
687 std::string pwmPath;
688 std::string pwmInterface;
689 if (singlePwm)
690 {
691 /* if just a single output(pwm) is provided then use
692 * that pwm control path for all the fan sensor write
693 * path configs
694 */
695 pwmPath = outputSensorInterfaces.at(0).first;
696 pwmInterface = outputSensorInterfaces.at(0).second;
697 }
698 for (uint32_t idx = 0; idx < inputSensorInterfaces.size();
699 idx++)
700 {
701 if (!singlePwm)
702 {
703 pwmPath = outputSensorInterfaces.at(idx).first;
704 pwmInterface =
705 outputSensorInterfaces.at(idx).second;
706 }
Patrick Venture0911bfe2020-08-10 12:51:40 -0700707 if (defaultPwmInterface != pwmInterface)
Jason Lingf3b04fd2020-07-24 09:33:04 -0700708 {
709 throw std::runtime_error(
710 "fan pwm control at dbus path [" + pwmPath +
711 "] has an interface [" + pwmInterface +
712 "] that does not match the expected interface "
713 "of " +
Patrick Venture0911bfe2020-08-10 12:51:40 -0700714 defaultPwmInterface);
Jason Lingf3b04fd2020-07-24 09:33:04 -0700715 }
716 const std::string& fanPath =
717 inputSensorInterfaces.at(idx).first;
718 fanSensorName = getSensorNameFromPath(fanPath);
719 auto& fanConfig = sensorConfig[fanSensorName];
720 fanConfig.writePath = pwmPath;
721 // todo: un-hardcode this if there are fans with
722 // different ranges
723 fanConfig.max = 255;
724 fanConfig.min = 0;
725 }
726 }
James Feist11d243d2019-06-24 16:18:40 -0700727 // if the sensors aren't available in the current state, don't
728 // add them to the configuration.
Jason Lingf3b04fd2020-07-24 09:33:04 -0700729 if (inputSensorNames.empty())
James Feist11d243d2019-06-24 16:18:40 -0700730 {
731 continue;
732 }
733
James Feist5ec20272019-07-10 11:59:57 -0700734 std::string offsetType;
James Feist50fdfe32018-09-24 15:51:09 -0700735
James Feist5ec20272019-07-10 11:59:57 -0700736 // SetPointOffset is a threshold value to pull from the sensor
737 // to apply an offset. For upper thresholds this means the
738 // setpoint is usually negative.
739 auto findSetpointOffset = base.find("SetPointOffset");
740 if (findSetpointOffset != base.end())
James Feist22c257a2018-08-31 14:07:12 -0700741 {
James Feist5ec20272019-07-10 11:59:57 -0700742 offsetType =
743 std::get<std::string>(findSetpointOffset->second);
744 if (std::find(thresholds::types.begin(),
745 thresholds::types.end(),
746 offsetType) == thresholds::types.end())
747 {
748 throw std::runtime_error("Unsupported type: " +
749 offsetType);
750 }
751 }
752
753 if (offsetType.empty())
754 {
755 struct conf::ControllerInfo& info =
756 conf[std::get<std::string>(base.at("Name"))];
Jason Lingf3b04fd2020-07-24 09:33:04 -0700757 info.inputs = std::move(inputSensorNames);
James Feist5ec20272019-07-10 11:59:57 -0700758 populatePidInfo(bus, base, info, nullptr);
James Feist22c257a2018-08-31 14:07:12 -0700759 }
760 else
761 {
James Feist5ec20272019-07-10 11:59:57 -0700762 // we have to split up the inputs, as in practice t-control
763 // values will differ, making setpoints differ
Jason Lingf3b04fd2020-07-24 09:33:04 -0700764 for (const std::string& input : inputSensorNames)
James Feist5ec20272019-07-10 11:59:57 -0700765 {
766 struct conf::ControllerInfo& info = conf[input];
767 info.inputs.emplace_back(input);
768 populatePidInfo(bus, base, info, &offsetType);
769 }
James Feist22c257a2018-08-31 14:07:12 -0700770 }
James Feist22c257a2018-08-31 14:07:12 -0700771 }
772 }
773 auto findStepwise =
774 configuration.second.find(stepwiseConfigurationInterface);
775 if (findStepwise != configuration.second.end())
776 {
777 const auto& base = findStepwise->second;
778 const std::vector<std::string>& zones =
James Feist1f802f52019-02-08 13:51:43 -0800779 std::get<std::vector<std::string>>(base.at("Zones"));
James Feist22c257a2018-08-31 14:07:12 -0700780 for (const std::string& zone : zones)
781 {
Josh Lehan998fbe62020-09-20 21:21:05 -0700782 auto index = getZoneIndex(zone, foundZones);
783
James Feistf81f2882019-02-26 11:26:36 -0800784 conf::PIDConf& conf = zoneConfig[index];
James Feist50fdfe32018-09-24 15:51:09 -0700785
786 std::vector<std::string> inputs;
787 std::vector<std::string> sensorNames =
James Feist1f802f52019-02-08 13:51:43 -0800788 std::get<std::vector<std::string>>(base.at("Inputs"));
James Feist50fdfe32018-09-24 15:51:09 -0700789
James Feist1738e2a2019-02-04 15:57:03 -0800790 bool sensorFound = false;
James Feist50fdfe32018-09-24 15:51:09 -0700791 for (const std::string& sensorName : sensorNames)
792 {
James Feist1738e2a2019-02-04 15:57:03 -0800793 std::vector<std::pair<std::string, std::string>>
794 sensorPathIfacePairs;
Jason Lingf3b04fd2020-07-24 09:33:04 -0700795 if (!findSensors(sensors, sensorNameToDbusName(sensorName),
796 sensorPathIfacePairs))
James Feist50fdfe32018-09-24 15:51:09 -0700797 {
James Feist50fdfe32018-09-24 15:51:09 -0700798 break;
799 }
800
James Feist1738e2a2019-02-04 15:57:03 -0800801 for (const auto& sensorPathIfacePair : sensorPathIfacePairs)
802 {
803 size_t idx =
804 sensorPathIfacePair.first.find_last_of("/") + 1;
805 std::string shortName =
806 sensorPathIfacePair.first.substr(idx);
James Feist50fdfe32018-09-24 15:51:09 -0700807
James Feist1738e2a2019-02-04 15:57:03 -0800808 inputs.push_back(shortName);
809 auto& config = sensorConfig[shortName];
Patrick Venture69c51062019-02-11 09:46:03 -0800810 config.readPath = sensorPathIfacePair.first;
James Feist1738e2a2019-02-04 15:57:03 -0800811 config.type = "temp";
James Feist3660b382019-11-11 16:29:19 -0800812 config.ignoreDbusMinMax = true;
James Feist1738e2a2019-02-04 15:57:03 -0800813 // todo: maybe un-hardcode this if we run into slower
814 // timeouts with sensors
815
James Feist2642cb52019-02-25 13:00:16 -0800816 config.timeout = 0;
James Feist1738e2a2019-02-04 15:57:03 -0800817 sensorFound = true;
818 }
James Feist50fdfe32018-09-24 15:51:09 -0700819 }
820 if (!sensorFound)
821 {
822 continue;
823 }
James Feistf81f2882019-02-26 11:26:36 -0800824 struct conf::ControllerInfo& info =
James Feist1f802f52019-02-08 13:51:43 -0800825 conf[std::get<std::string>(base.at("Name"))];
James Feist50fdfe32018-09-24 15:51:09 -0700826 info.inputs = std::move(inputs);
827
James Feist22c257a2018-08-31 14:07:12 -0700828 info.type = "stepwise";
829 info.stepwiseInfo.ts = 1.0; // currently unused
James Feist3dfaafd2018-09-20 15:46:58 -0700830 info.stepwiseInfo.positiveHysteresis = 0.0;
831 info.stepwiseInfo.negativeHysteresis = 0.0;
James Feist608304d2019-02-25 10:01:42 -0800832 std::string subtype = std::get<std::string>(base.at("Class"));
833
834 info.stepwiseInfo.isCeiling = (subtype == "Ceiling");
James Feist3dfaafd2018-09-20 15:46:58 -0700835 auto findPosHyst = base.find("PositiveHysteresis");
836 auto findNegHyst = base.find("NegativeHysteresis");
837 if (findPosHyst != base.end())
838 {
James Feist1f802f52019-02-08 13:51:43 -0800839 info.stepwiseInfo.positiveHysteresis = std::visit(
James Feist208abce2018-12-06 09:59:10 -0800840 VariantToDoubleVisitor(), findPosHyst->second);
James Feist3dfaafd2018-09-20 15:46:58 -0700841 }
842 if (findNegHyst != base.end())
843 {
James Feist5782ab82019-04-02 08:38:48 -0700844 info.stepwiseInfo.negativeHysteresis = std::visit(
James Feist208abce2018-12-06 09:59:10 -0800845 VariantToDoubleVisitor(), findNegHyst->second);
James Feist3dfaafd2018-09-20 15:46:58 -0700846 }
James Feist22c257a2018-08-31 14:07:12 -0700847 std::vector<double> readings =
James Feist1f802f52019-02-08 13:51:43 -0800848 std::get<std::vector<double>>(base.at("Reading"));
James Feist22c257a2018-08-31 14:07:12 -0700849 if (readings.size() > ec::maxStepwisePoints)
850 {
851 throw std::invalid_argument("Too many stepwise points.");
852 }
853 if (readings.empty())
854 {
855 throw std::invalid_argument(
856 "Must have one stepwise point.");
857 }
858 std::copy(readings.begin(), readings.end(),
859 info.stepwiseInfo.reading);
860 if (readings.size() < ec::maxStepwisePoints)
861 {
862 info.stepwiseInfo.reading[readings.size()] =
Patrick Venture5f59c0f2018-11-11 12:55:14 -0800863 std::numeric_limits<double>::quiet_NaN();
James Feist22c257a2018-08-31 14:07:12 -0700864 }
865 std::vector<double> outputs =
James Feist1f802f52019-02-08 13:51:43 -0800866 std::get<std::vector<double>>(base.at("Output"));
James Feist22c257a2018-08-31 14:07:12 -0700867 if (readings.size() != outputs.size())
868 {
869 throw std::invalid_argument(
870 "Outputs size must match readings");
871 }
872 std::copy(outputs.begin(), outputs.end(),
873 info.stepwiseInfo.output);
874 if (outputs.size() < ec::maxStepwisePoints)
875 {
876 info.stepwiseInfo.output[outputs.size()] =
Patrick Venture5f59c0f2018-11-11 12:55:14 -0800877 std::numeric_limits<double>::quiet_NaN();
James Feist22c257a2018-08-31 14:07:12 -0700878 }
James Feist7136a5a2018-07-19 09:52:05 -0700879 }
880 }
881 }
Patrick Venture39199b42020-10-08 14:40:29 -0700882 if constexpr (pid_control::conf::DEBUG)
James Feist7136a5a2018-07-19 09:52:05 -0700883 {
Patrick Venture39199b42020-10-08 14:40:29 -0700884 debugPrint(sensorConfig, zoneConfig, zoneDetailsConfig);
James Feist7136a5a2018-07-19 09:52:05 -0700885 }
James Feistc959c422018-11-01 12:33:40 -0700886 if (zoneConfig.empty() || zoneDetailsConfig.empty())
James Feist50fdfe32018-09-24 15:51:09 -0700887 {
James Feist1fe08952019-05-07 09:17:16 -0700888 std::cerr
889 << "No fan zones, application pausing until new configuration\n";
890 return false;
James Feist50fdfe32018-09-24 15:51:09 -0700891 }
James Feist1fe08952019-05-07 09:17:16 -0700892 return true;
James Feist7136a5a2018-07-19 09:52:05 -0700893}
Patrick Venturea0764872020-08-08 07:48:43 -0700894
James Feist7136a5a2018-07-19 09:52:05 -0700895} // namespace dbus_configuration
Patrick Venturea0764872020-08-08 07:48:43 -0700896} // namespace pid_control