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