1 /**
2 * Copyright © 2021 IBM 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 */
16 #include "net_target_increase.hpp"
17
18 #include "../manager.hpp"
19 #include "../zone.hpp"
20 #include "action.hpp"
21 #include "group.hpp"
22
23 #include <nlohmann/json.hpp>
24 #include <phosphor-logging/lg2.hpp>
25
26 #include <algorithm>
27 #include <variant>
28
29 namespace phosphor::fan::control::json
30 {
31
32 using json = nlohmann::json;
33
NetTargetIncrease(const json & jsonObj,const std::vector<Group> & groups)34 NetTargetIncrease::NetTargetIncrease(const json& jsonObj,
35 const std::vector<Group>& groups) :
36 ActionBase(jsonObj, groups)
37 {
38 setState(jsonObj);
39 setDelta(jsonObj);
40 }
41
run(Zone & zone)42 void NetTargetIncrease::run(Zone& zone)
43 {
44 if (!_stateParameter.empty())
45 {
46 auto s = Manager::getParameter(_stateParameter);
47 if (!s)
48 {
49 return;
50 }
51 _state = *s;
52 }
53
54 auto netDelta = zone.getIncDelta();
55 for (const auto& group : _groups)
56 {
57 const auto& members = group.getMembers();
58 std::for_each(
59 members.begin(), members.end(),
60 [this, &zone, &group, &netDelta](const auto& member) {
61 try
62 {
63 auto value = Manager::getObjValueVariant(
64 member, group.getInterface(), group.getProperty());
65 if (std::holds_alternative<int64_t>(value) ||
66 std::holds_alternative<double>(value))
67 {
68 // Where a group of int/doubles are greater than or
69 // equal to the state(some value) provided, request an
70 // increase of the configured delta times the difference
71 // between the group member's value and configured state
72 // value.
73 if (value >= _state)
74 {
75 uint64_t incDelta = 0;
76 if (auto dblPtr = std::get_if<double>(&value))
77 {
78 incDelta = static_cast<uint64_t>(
79 (*dblPtr - std::get<double>(_state)) *
80 _delta);
81 }
82 else
83 {
84 // Increase by at least a single delta
85 // to attempt bringing under provided 'state'
86 auto deltaFactor =
87 std::max((std::get<int64_t>(value) -
88 std::get<int64_t>(_state)),
89 int64_t(1));
90 incDelta =
91 static_cast<uint64_t>(deltaFactor * _delta);
92 }
93 netDelta = std::max(netDelta, incDelta);
94 }
95 }
96 else if (std::holds_alternative<bool>(value))
97 {
98 // Where a group of booleans equal the state(`true` or
99 // `false`) provided, request an increase of the
100 // configured delta
101 if (_state == value)
102 {
103 netDelta = std::max(netDelta, _delta);
104 }
105 }
106 else if (std::holds_alternative<std::string>(value))
107 {
108 // Where a group of strings equal the state(some string)
109 // provided, request an increase of the configured delta
110 if (_state == value)
111 {
112 netDelta = std::max(netDelta, _delta);
113 }
114 }
115 else
116 {
117 // Unsupported group member type for this action
118 lg2::error(
119 "Action {ACTION_NAME}: Unsupported group member type "
120 "given. [object = {MEMBER} : {GROUP_INTERFACE} : {GROUP_PROPERTY}]",
121 "ACTION_NAME", ActionBase::getName(), "MEMBER",
122 member, "GROUP_INTERFACE", group.getInterface(),
123 "GROUP_PROPERTY", group.getProperty());
124 }
125 }
126 catch (const std::out_of_range& oore)
127 {
128 // Property value not found, netDelta unchanged
129 }
130 });
131 }
132 // Request increase to target
133 zone.requestIncrease(netDelta);
134 }
135
setState(const json & jsonObj)136 void NetTargetIncrease::setState(const json& jsonObj)
137 {
138 if (jsonObj.contains("state"))
139 {
140 _state = getJsonValue(jsonObj["state"]);
141 }
142 else if (jsonObj.contains("state_parameter_name"))
143 {
144 _stateParameter = jsonObj["state_parameter_name"].get<std::string>();
145 }
146 else
147 {
148 throw ActionParseError{
149 ActionBase::getName(),
150 "Missing required state or state_parameter_name value"};
151 }
152 }
153
setDelta(const json & jsonObj)154 void NetTargetIncrease::setDelta(const json& jsonObj)
155 {
156 if (!jsonObj.contains("delta"))
157 {
158 throw ActionParseError{ActionBase::getName(),
159 "Missing required delta value"};
160 }
161 _delta = jsonObj["delta"].get<uint64_t>();
162 }
163
164 } // namespace phosphor::fan::control::json
165