blob: 4d353d55b0af681f21d78085ecf09c299fc63d7f [file] [log] [blame]
/**
* Copyright © 2020 IBM Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "config.h"
#include "zone.hpp"
#include "fan.hpp"
#include <cereal/archives/json.hpp>
#include <cereal/cereal.hpp>
#include <nlohmann/json.hpp>
#include <phosphor-logging/log.hpp>
#include <sdbusplus/bus.hpp>
#include <sdeventplus/event.hpp>
#include <algorithm>
#include <chrono>
#include <filesystem>
#include <fstream>
#include <iterator>
#include <map>
#include <numeric>
#include <utility>
#include <vector>
namespace phosphor::fan::control::json
{
using json = nlohmann::json;
using namespace phosphor::logging;
namespace fs = std::filesystem;
const std::map<std::string,
std::map<std::string, std::function<std::function<void(Zone*)>(
const json&, bool)>>>
Zone::_intfPropHandlers = {{thermModeIntf,
{{supportedProp, zone::property::supported},
{currentProp, zone::property::current}}}};
Zone::Zone(const json& jsonObj, sdbusplus::bus::bus& bus,
const sdeventplus::Event& event, Manager* mgr) :
ConfigBase(jsonObj),
ThermalObject(bus, (fs::path{CONTROL_OBJPATH} /= getName()).c_str(), true),
_manager(mgr), _incDelay(0), _floor(0), _target(0), _incDelta(0),
_decDelta(0), _requestTargetBase(0), _isActive(true),
_incTimer(event, std::bind(&Zone::incTimerExpired, this)),
_decTimer(event, std::bind(&Zone::decTimerExpired, this))
{
// Increase delay is optional, defaults to 0
if (jsonObj.contains("increase_delay"))
{
_incDelay =
std::chrono::seconds(jsonObj["increase_delay"].get<uint64_t>());
}
setDefaultCeiling(jsonObj);
setDefaultFloor(jsonObj);
setDecInterval(jsonObj);
// Setting properties on interfaces to be served are optional
if (jsonObj.contains("interfaces"))
{
setInterfaces(jsonObj);
}
// Restore thermal control current mode state
restoreCurrentMode();
// Emit object added for this zone dbus object
this->emit_object_added();
// Start timer for fan target decreases
_decTimer.restart(_decInterval);
}
void Zone::addFan(std::unique_ptr<Fan> fan)
{
_fans.emplace_back(std::move(fan));
}
void Zone::setTarget(uint64_t target)
{
if (_isActive && _target != target)
{
_target = target;
for (auto& fan : _fans)
{
fan->setTarget(_target);
}
}
}
void Zone::setActiveAllow(const std::string& ident, bool isActiveAllow)
{
_active[ident] = isActiveAllow;
if (!isActiveAllow)
{
_isActive = false;
}
else
{
// Check all entries are set to allow active fan control
auto actPred = [](const auto& entry) { return entry.second; };
_isActive = std::all_of(_active.begin(), _active.end(), actPred);
}
}
void Zone::setFloor(uint64_t target)
{
// Check all entries are set to allow floor to be set
auto pred = [](const auto& entry) { return entry.second; };
if (std::all_of(_floorChange.begin(), _floorChange.end(), pred))
{
_floor = target;
// Floor above target, update target to floor
if (_target < _floor)
{
requestIncrease(_floor - _target);
}
}
}
void Zone::requestIncrease(uint64_t targetDelta)
{
// Only increase when delta is higher than the current increase delta for
// the zone and currently under ceiling
if (targetDelta > _incDelta && _target < _ceiling)
{
auto requestTarget = getRequestTargetBase();
requestTarget = (targetDelta - _incDelta) + requestTarget;
_incDelta = targetDelta;
// Target can not go above a current ceiling
if (requestTarget > _ceiling)
{
requestTarget = _ceiling;
}
setTarget(requestTarget);
// Restart timer countdown for fan target increase
_incTimer.restartOnce(_incDelay);
}
}
void Zone::incTimerExpired()
{
// Clear increase delta when timer expires allowing additional target
// increase requests or target decreases to occur
_incDelta = 0;
}
void Zone::requestDecrease(uint64_t targetDelta)
{
// Only decrease the lowest target delta requested
if (_decDelta == 0 || targetDelta < _decDelta)
{
_decDelta = targetDelta;
}
}
void Zone::decTimerExpired()
{
// Check all entries are set to allow a decrease
auto pred = [](auto const& entry) { return entry.second; };
auto decAllowed = std::all_of(_decAllowed.begin(), _decAllowed.end(), pred);
// Only decrease targets when allowed, a requested decrease target delta
// exists, where no requested increases exist and the increase timer is not
// running (i.e. not in the middle of increasing)
if (decAllowed && _decDelta != 0 && _incDelta == 0 &&
!_incTimer.isEnabled())
{
auto requestTarget = getRequestTargetBase();
// Request target should not start above ceiling
if (requestTarget > _ceiling)
{
requestTarget = _ceiling;
}
// Target can not go below the defined floor
if ((requestTarget < _decDelta) || (requestTarget - _decDelta < _floor))
{
requestTarget = _floor;
}
else
{
requestTarget = requestTarget - _decDelta;
}
setTarget(requestTarget);
}
// Clear decrease delta when timer expires
_decDelta = 0;
// Decrease timer is restarted since its repeating
}
void Zone::setPersisted(const std::string& intf, const std::string& prop)
{
if (std::find_if(_propsPersisted[intf].begin(), _propsPersisted[intf].end(),
[&prop](const auto& p) { return prop == p; }) !=
_propsPersisted[intf].end())
{
_propsPersisted[intf].emplace_back(prop);
}
}
std::string Zone::current(std::string value)
{
auto current = ThermalObject::current();
std::transform(value.begin(), value.end(), value.begin(), toupper);
auto supported = ThermalObject::supported();
auto isSupported =
std::any_of(supported.begin(), supported.end(), [&value](auto& s) {
std::transform(s.begin(), s.end(), s.begin(), toupper);
return value == s;
});
if (value != current && isSupported)
{
current = ThermalObject::current(value);
if (isPersisted("xyz.openbmc_project.Control.ThermalMode", "Current"))
{
saveCurrentMode();
}
// TODO Trigger event(s) for current mode property change
// auto eData =
// _objects[_path]["xyz.openbmc_project.Control.ThermalMode"]
// ["Current"];
// if (eData != nullptr)
// {
// sdbusplus::message::message nullMsg{nullptr};
// handleEvent(nullMsg, eData);
// }
}
return current;
}
void Zone::setDefaultCeiling(const json& jsonObj)
{
if (!jsonObj.contains("full_speed"))
{
log<level::ERR>("Missing required zone's full speed",
entry("JSON=%s", jsonObj.dump().c_str()));
throw std::runtime_error("Missing required zone's full speed");
}
_defaultCeiling = jsonObj["full_speed"].get<uint64_t>();
// Start with the current target set as the default
_target = _defaultCeiling;
// Start with the current ceiling set as the default
_ceiling = _defaultCeiling;
}
void Zone::setDefaultFloor(const json& jsonObj)
{
if (!jsonObj.contains("default_floor"))
{
log<level::ERR>("Missing required zone's default floor",
entry("JSON=%s", jsonObj.dump().c_str()));
throw std::runtime_error("Missing required zone's default floor");
}
_defaultFloor = jsonObj["default_floor"].get<uint64_t>();
// Start with the current floor set as the default
_floor = _defaultFloor;
}
void Zone::setDecInterval(const json& jsonObj)
{
if (!jsonObj.contains("decrease_interval"))
{
log<level::ERR>("Missing required zone's decrease interval",
entry("JSON=%s", jsonObj.dump().c_str()));
throw std::runtime_error("Missing required zone's decrease interval");
}
_decInterval =
std::chrono::seconds(jsonObj["decrease_interval"].get<uint64_t>());
}
void Zone::setInterfaces(const json& jsonObj)
{
for (const auto& interface : jsonObj["interfaces"])
{
if (!interface.contains("name") || !interface.contains("properties"))
{
log<level::ERR>("Missing required zone interface attributes",
entry("JSON=%s", interface.dump().c_str()));
throw std::runtime_error(
"Missing required zone interface attributes");
}
auto propFuncs =
_intfPropHandlers.find(interface["name"].get<std::string>());
if (propFuncs == _intfPropHandlers.end())
{
// Construct list of available configurable interfaces
auto intfs = std::accumulate(
std::next(_intfPropHandlers.begin()), _intfPropHandlers.end(),
_intfPropHandlers.begin()->first, [](auto list, auto intf) {
return std::move(list) + ", " + intf.first;
});
log<level::ERR>("Configured interface not available",
entry("JSON=%s", interface.dump().c_str()),
entry("AVAILABLE_INTFS=%s", intfs.c_str()));
throw std::runtime_error("Configured interface not available");
}
for (const auto& property : interface["properties"])
{
if (!property.contains("name"))
{
log<level::ERR>(
"Missing required interface property attributes",
entry("JSON=%s", property.dump().c_str()));
throw std::runtime_error(
"Missing required interface property attributes");
}
// Attribute "persist" is optional, defaults to `false`
auto persist = false;
if (property.contains("persist"))
{
persist = property["persist"].get<bool>();
}
// Property name from JSON must exactly match supported
// index names to functions in property namespace
auto propFunc =
propFuncs->second.find(property["name"].get<std::string>());
if (propFunc == propFuncs->second.end())
{
// Construct list of available configurable properties
auto props = std::accumulate(
std::next(propFuncs->second.begin()),
propFuncs->second.end(), propFuncs->second.begin()->first,
[](auto list, auto prop) {
return std::move(list) + ", " + prop.first;
});
log<level::ERR>("Configured property not available",
entry("JSON=%s", property.dump().c_str()),
entry("AVAILABLE_PROPS=%s", props.c_str()));
throw std::runtime_error(
"Configured property function not available");
}
auto propHandler = propFunc->second(property, persist);
// Only call non-null set property handler functions
if (propHandler)
{
propHandler(this);
}
}
}
}
bool Zone::isPersisted(const std::string& intf, const std::string& prop)
{
auto it = _propsPersisted.find(intf);
if (it == _propsPersisted.end())
{
return false;
}
return std::any_of(it->second.begin(), it->second.end(),
[&prop](const auto& p) { return prop == p; });
}
void Zone::saveCurrentMode()
{
fs::path path{CONTROL_PERSIST_ROOT_PATH};
// Append zone name and property description
path /= getName();
path /= "CurrentMode";
std::ofstream ofs(path.c_str(), std::ios::binary);
cereal::JSONOutputArchive oArch(ofs);
oArch(ThermalObject::current());
}
void Zone::restoreCurrentMode()
{
auto current = ThermalObject::current();
fs::path path{CONTROL_PERSIST_ROOT_PATH};
path /= getName();
path /= "CurrentMode";
fs::create_directories(path.parent_path());
try
{
if (fs::exists(path))
{
std::ifstream ifs(path.c_str(), std::ios::in | std::ios::binary);
cereal::JSONInputArchive iArch(ifs);
iArch(current);
}
}
catch (std::exception& e)
{
log<level::ERR>(e.what());
fs::remove(path);
current = ThermalObject::current();
}
this->current(current);
}
/**
* Properties of interfaces supported by the zone configuration that return
* a handler function that sets the zone's property value(s) and persist state.
*/
namespace zone::property
{
// Get a set property handler function for the configured values of the
// "Supported" property
std::function<void(Zone*)> supported(const json& jsonObj, bool persist)
{
std::vector<std::string> values;
if (!jsonObj.contains("values"))
{
log<level::ERR>(
"No 'values' found for \"Supported\" property, using an empty list",
entry("JSON=%s", jsonObj.dump().c_str()));
}
else
{
for (const auto& value : jsonObj["values"])
{
if (!value.contains("value"))
{
log<level::ERR>("No 'value' found for \"Supported\" property "
"entry, skipping",
entry("JSON=%s", value.dump().c_str()));
}
else
{
values.emplace_back(value["value"].get<std::string>());
}
}
}
return Zone::setProperty<std::vector<std::string>>(
Zone::thermModeIntf, Zone::supportedProp, &Zone::supported,
std::move(values), persist);
}
// Get a set property handler function for a configured value of the "Current"
// property
std::function<void(Zone*)> current(const json& jsonObj, bool persist)
{
// Use default value for "Current" property if no "value" entry given
if (!jsonObj.contains("value"))
{
log<level::INFO>("No 'value' found for \"Current\" property, "
"using default",
entry("JSON=%s", jsonObj.dump().c_str()));
// Set persist state of property
return Zone::setPropertyPersist(Zone::thermModeIntf, Zone::currentProp,
persist);
}
return Zone::setProperty<std::string>(
Zone::thermModeIntf, Zone::currentProp, &Zone::current,
jsonObj["value"].get<std::string>(), persist);
}
} // namespace zone::property
} // namespace phosphor::fan::control::json