#pragma once #include "types.hpp" #include "utility.hpp" #include "zone.hpp" #include #include namespace phosphor { namespace fan { namespace control { namespace action { /** * @brief An action that wraps a list of actions with a timer * @details Sets up a list of actions to be invoked when the defined timer * expires (or for each expiration of a repeating timer). * * @param[in] tConf - Timer configuration parameters * @param[in] action - List of actions to be called when the timer expires * * @return Action lambda function * An Action function that creates a timer */ Action call_actions_based_on_timer(TimerConf&& tConf, std::vector&& actions); /** * @brief An action that sets the floor to the default fan floor speed * @details Sets the fan floor to the defined default fan floor speed when a * service associated to the given group has terminated. Once all services * are functional and providing the sensors again, the fan floor is allowed * to be set normally. * * @param[in] zone - Zone containing fans * @param[in] group - Group of sensors to determine services' states */ void default_floor_on_missing_owner(Zone& zone, const Group& group); /** * @brief An action to set a speed when a service owner is missing * @details Sets the fans to the given speed when any service owner associated * to the group is missing. Once all services are functional and providing * the event data again, active fan speed changes are allowed. * * @param[in] speed - Speed to set the zone to * * @return Action lambda function * An Action function that sets the zone to the given speed if any service * owners are missing. */ Action set_speed_on_missing_owner(uint64_t speed); /** * @brief An action to set the request speed base * @details A new target speed is determined using a speed delta being added * or subtracted, for increases or decrease respectively, from a base speed. * This base speed defaults to be the current target speed or is set to a * different base speed(i.e. the fans' tach feedback speed) to request a new * target from. * * @param[in] zone - Zone containing fans * @param[in] group - Group of sensors to determine base from */ void set_request_speed_base_with_max(Zone& zone, const Group& group); /** * @brief An action to set the speed on a zone * @details The zone is held at the given speed when a defined number of * properties in the group are set to the given state * * @param[in] count - Number of properties * @param[in] state - Value the property(s) needed to be set at * @param[in] speed - Speed to set the zone to * * @return Lambda function * A lambda function to set the zone speed when the number of properties * within the group are at a certain value */ template auto count_state_before_speed(size_t count, T&& state, uint64_t speed) { return [count, speed, state = std::forward(state)](auto& zone, auto& group) { size_t numAtState = 0; for (auto& entry : group) { try { if (zone.template getPropertyValue( std::get(entry), std::get(entry), std::get(entry)) == state) { numAtState++; } } catch (const std::out_of_range& oore) { // Default to property not equal when not found } if (numAtState >= count) { zone.setSpeed(speed); break; } } // Update group's fan control active allowed based on action results zone.setActiveAllow(&group, !(numAtState >= count)); }; } /** * @brief An action to set the floor speed on a zone * @details Based on the average of the defined sensor group values, the floor * speed is selected from the first map key entry that the average sensor value * is less than. * * @param[in] val_to_speed - Ordered map of sensor value-to-speed * * @return Action lambda function * An Action function to set the zone's floor speed when the average of * property values within the group is below the lowest sensor value given */ template Action set_floor_from_average_sensor_value(std::map&& val_to_speed) { return [val_to_speed = std::move(val_to_speed)](control::Zone& zone, const Group& group) { auto speed = zone.getDefFloor(); if (group.size() != 0) { auto count = 0; auto sumValue = std::accumulate( group.begin(), group.end(), 0, [&zone, &count](T sum, const auto& entry) { try { return sum + zone.template getPropertyValue( std::get(entry), std::get(entry), std::get(entry)); } catch (const std::out_of_range& oore) { count++; return sum; } }); if ((group.size() - count) > 0) { auto groupSize = static_cast(group.size()); auto avgValue = sumValue / (groupSize - count); auto it = std::find_if(val_to_speed.begin(), val_to_speed.end(), [&avgValue](const auto& entry) { return avgValue < entry.first; }); if (it != std::end(val_to_speed)) { speed = (*it).second; } } } zone.setFloor(speed); }; } /** * @brief An action to set the ceiling speed on a zone * @details Based on the average of the defined sensor group values, the * ceiling speed is selected from the map key transition point that the average * sensor value falls within depending on the key values direction from what * was previously read. * * @param[in] val_to_speed - Ordered map of sensor value-to-speed transitions * * @return Action lambda function * An Action function to set the zone's ceiling speed when the average of * property values within the group is above(increasing) or * below(decreasing) the key transition point */ template Action set_ceiling_from_average_sensor_value(std::map&& val_to_speed) { return [val_to_speed = std::move(val_to_speed)](Zone& zone, const Group& group) { auto speed = zone.getCeiling(); if (group.size() != 0) { auto count = 0; auto sumValue = std::accumulate( group.begin(), group.end(), 0, [&zone, &count](T sum, const auto& entry) { try { return sum + zone.template getPropertyValue( std::get(entry), std::get(entry), std::get(entry)); } catch (const std::out_of_range& oore) { count++; return sum; } }); if ((group.size() - count) > 0) { auto groupSize = static_cast(group.size()); auto avgValue = sumValue / (groupSize - count); auto prevValue = zone.swapCeilingKeyValue(avgValue); if (avgValue != prevValue) { // Only check if previous and new values differ if (avgValue < prevValue) { // Value is decreasing from previous for (auto it = val_to_speed.rbegin(); it != val_to_speed.rend(); ++it) { if (it == val_to_speed.rbegin() && avgValue >= it->first) { // Value is at/above last map key, set // ceiling speed to the last map key's value speed = it->second; break; } else if (std::next(it, 1) == val_to_speed.rend() && avgValue <= it->first) { // Value is at/below first map key, set // ceiling speed to the first map key's value speed = it->second; break; } if (avgValue < it->first && it->first <= prevValue) { // Value decreased & transitioned across // a map key, update ceiling speed to this // map key's value when new value is below // map's key and the key is at/below the // previous value speed = it->second; } } } else { // Value is increasing from previous for (auto it = val_to_speed.begin(); it != val_to_speed.end(); ++it) { if (it == val_to_speed.begin() && avgValue <= it->first) { // Value is at/below first map key, set // ceiling speed to the first map key's value speed = it->second; break; } else if (std::next(it, 1) == val_to_speed.end() && avgValue >= it->first) { // Value is at/above last map key, set // ceiling speed to the last map key's value speed = it->second; break; } if (avgValue > it->first && it->first >= prevValue) { // Value increased & transitioned across // a map key, update ceiling speed to this // map key's value when new value is above // map's key and the key is at/above the // previous value speed = it->second; } } } } } } zone.setCeiling(speed); }; } /** * @brief An action to set the speed increase delta and request speed change * @details Provides the ability to determine what the net increase delta the * zone's fan speeds should be updated by from their current target speed and * request that new target speed. * * @param[in] state - State to compare the group's property value to * @param[in] factor - Factor to apply to the calculated net delta * @param[in] speedDelta - Speed delta of the group * * @return Lambda function * A lambda function that determines the net increase delta and requests * a new target speed with that increase for the zone. */ template auto set_net_increase_speed(T&& state, T&& factor, uint64_t speedDelta) { return [speedDelta, factor = std::forward(factor), state = std::forward(state)](auto& zone, auto& group) { auto netDelta = zone.getIncSpeedDelta(); std::for_each( group.begin(), group.end(), [&zone, &state, &factor, &speedDelta, &netDelta](const auto& entry) { try { T value = zone.template getPropertyValue( std::get(entry), std::get(entry), std::get(entry)); // TODO openbmc/phosphor-fan-presence#7 - Support possible // state types for comparison if (value >= state) { // Increase by at least a single delta(factor) // to attempt bringing under 'state' auto delta = std::max((value - state), factor); // Increase is the factor applied to the // difference times the given speed delta netDelta = std::max(netDelta, static_cast( (delta / factor) * speedDelta)); } } catch (const std::out_of_range& oore) { // Property value not found, netDelta unchanged } }); // Request speed change for target speed update zone.requestSpeedIncrease(netDelta); }; } /** * @brief An action to set the speed decrease delta and request speed change * @details Provides the ability to determine what the net decrease delta each * zone's fan speeds should be updated by from their current target speed, and * request that speed change occur on the next decrease interval. * * @param[in] state - State to compare the group's property value to * @param[in] factor - Factor to apply to the calculated net delta * @param[in] speedDelta - Speed delta of the group * * @return Lambda function * A lambda function that determines the net decrease delta and requests * a new target speed with that decrease for the zone. */ template auto set_net_decrease_speed(T&& state, T&& factor, uint64_t speedDelta) { return [speedDelta, factor = std::forward(factor), state = std::forward(state)](auto& zone, auto& group) { auto netDelta = zone.getDecSpeedDelta(); for (auto& entry : group) { try { T value = zone.template getPropertyValue( std::get(entry), std::get(entry), std::get(entry)); // TODO openbmc/phosphor-fan-presence#7 - Support possible // state types for comparison if (value < state) { if (netDelta == 0) { netDelta = ((state - value) / factor) * speedDelta; } else { // Decrease is the factor applied to the // difference times the given speed delta netDelta = std::min( netDelta, static_cast( ((state - value) / factor) * speedDelta)); } } else { // No decrease allowed for this group netDelta = 0; break; } } catch (const std::out_of_range& oore) { // Property value not found, netDelta unchanged } } // Update group's decrease allowed state zone.setDecreaseAllow(&group, !(netDelta == 0)); // Request speed decrease to occur on decrease interval zone.requestSpeedDecrease(netDelta); }; } /** * @brief An action to use an alternate set of events * @details Provides the ability to replace a default set of events with an * alternate set of events based on all members of a group being at a specified * state. When any member of the group no longer matches the provided state, * the alternate set of events are replaced with the defaults. * * @param[in] state - State to compare the group's property value to * @param[in] defEvents - The default set of events * @param[in] altEvents - The alternate set of events * * @return Lambda function * A lambda function that checks all group members are at a specified state * and replacing the default set of events with an alternate set of events. */ template auto use_alternate_events_on_state(T&& state, std::vector&& defEvents, std::vector&& altEvents) { return [state = std::forward(state), defEvents = std::move(defEvents), altEvents = std::move(altEvents)](auto& zone, auto& group) { // Compare all group entries to the state auto useAlt = std::all_of( group.begin(), group.end(), [&zone, &state](const auto& entry) { try { return zone.template getPropertyValue( std::get(entry), std::get(entry), std::get(entry)) == state; } catch (const std::out_of_range& oore) { // Default to property not equal when not found return false; } }); const std::vector* rmEvents = &altEvents; const std::vector* initEvents = &defEvents; if (useAlt) { rmEvents = &defEvents; initEvents = &altEvents; } // Remove events std::for_each(rmEvents->begin(), rmEvents->end(), [&zone](const auto& entry) { zone.removeEvent(entry); }); // Init events std::for_each(initEvents->begin(), initEvents->end(), [&zone](const auto& entry) { zone.initEvent(entry); }); }; } /** * @brief An action to set the floor speed on a zone * @details Using sensor group values that are within a defined range, the * floor speed is selected from the first map key entry that the median * sensor value is less than where 3 or more sensor group values are valid. * In the case where less than 3 sensor values are valid, use the highest * sensor group value and default the floor speed when 0 sensor group values * are valid. * * @param[in] lowerBound - Lowest allowed sensor value to be valid * @param[in] upperBound - Highest allowed sensor value to be valid * @param[in] valueToSpeed - Ordered map of sensor value-to-speed * * @return Action lambda function * An Action function to set the zone's floor speed from a resulting group * of valid sensor values based on their highest value or median. */ template Action set_floor_from_median_sensor_value(T&& lowerBound, T&& upperBound, std::map&& valueToSpeed) { return [lowerBound = std::forward(lowerBound), upperBound = std::forward(upperBound), valueToSpeed = std::move(valueToSpeed)](control::Zone& zone, const Group& group) { auto speed = zone.getDefFloor(); if (group.size() != 0) { std::vector validValues; for (const auto& member : group) { try { auto value = zone.template getPropertyValue( std::get(member), std::get(member), std::get(member)); if (value == std::clamp(value, lowerBound, upperBound)) { // Sensor value is valid validValues.emplace_back(value); } } catch (const std::out_of_range& oore) { continue; } } if (!validValues.empty()) { auto median = validValues.front(); // Get the determined median value if (validValues.size() == 2) { // For 2 values, use the highest instead of the average // for a thermally safe floor median = *std::max_element(validValues.begin(), validValues.end()); } else if (validValues.size() > 2) { median = utility::getMedian(validValues); } // Use determined median sensor value to find floor speed auto it = std::find_if(valueToSpeed.begin(), valueToSpeed.end(), [&median](const auto& entry) { return median < entry.first; }); if (it != std::end(valueToSpeed)) { speed = (*it).second; } } } zone.setFloor(speed); }; } /** * @brief An action to update the default floor speed * @details Provides the ability to update the default fan floor speed when * all of the group members property values match the value given * * @param[in] state - State to compare the group's property value to * @param[in] speed - Speed to set the default fan floor to * * @return Lambda function * A lambda function that checks all group members are at a specified state * and updates the default fan floor speed. */ template auto update_default_floor(T&& state, uint64_t speed) { return [speed, state = std::forward(state)](auto& zone, auto& group) { auto updateDefFloor = std::all_of( group.begin(), group.end(), [&zone, &state](const auto& entry) { try { return zone.template getPropertyValue( std::get(entry), std::get(entry), std::get(entry)) == state; } catch (const std::out_of_range& oore) { // Default to property not equal when not found return false; } }); if (!updateDefFloor) { // Do not update the default floor return; } // Set/update the default floor of the zone zone.setDefFloor(speed); }; } /** * @brief An action to use a set of events * @details Provides the ability to use a set of events when all members of * a group are at a specified state. When any member of the group no longer * matches the provided state the set of events are removed. * * @param[in] state - State to compare the group's property value to * @param[in] events - The set of events * * @return Lambda function * A lambda function that checks all group members are at a specified state * and initializes the set of events, otherwise removes them. */ template auto use_events_on_state(T&& state, std::vector&& events) { return [state = std::forward(state), events = std::move(events)](auto& zone, auto& group) { // Compare all group entries to the state auto useEvents = std::all_of( group.begin(), group.end(), [&zone, &state](const auto& entry) { try { return zone.template getPropertyValue( std::get(entry), std::get(entry), std::get(entry)) == state; } catch (const std::out_of_range& oore) { // Default to property not equal when not found return false; } }); if (useEvents) { // Init events std::for_each(events.begin(), events.end(), [&zone](const auto& entry) { zone.initEvent(entry); }); } else { // Remove events std::for_each(events.begin(), events.end(), [&zone](const auto& entry) { zone.removeEvent(entry); }); } }; } } // namespace action } // namespace control } // namespace fan } // namespace phosphor