1 /** 2 * Copyright © 2020 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 #pragma once 17 18 #include "json_config.hpp" 19 #include "power_off_action.hpp" 20 #include "trust_group.hpp" 21 #include "types.hpp" 22 23 #include <nlohmann/json.hpp> 24 #include <sdbusplus/bus.hpp> 25 26 namespace phosphor::fan::monitor 27 { 28 29 using json = nlohmann::json; 30 class PowerOffRule; 31 class PowerInterfaceBase; 32 class System; 33 34 constexpr auto confAppName = "monitor"; 35 constexpr auto confFileName = "config.json"; 36 37 // Trust group class handler function 38 using trustHandler = std::function<CreateGroupFunction( 39 const std::vector<trust::GroupDefinition>&)>; 40 // Fan monitoring condition handler function 41 using condHandler = std::function<Condition(const json&)>; 42 43 /** 44 * @brief Get the JSON object 45 * 46 * @return JSON object 47 * A JSON object created after loading the JSON configuration file 48 */ getJsonObj()49inline const json getJsonObj() 50 { 51 return fan::JsonConfig::load( 52 fan::JsonConfig::getConfFile(confAppName, confFileName)); 53 } 54 55 /** 56 * @brief Get any configured trust groups 57 * 58 * @param[in] obj - JSON object to parse from 59 * 60 * @return List of functions applied on trust groups 61 */ 62 const std::vector<CreateGroupFunction> getTrustGrps(const json& obj); 63 64 /** 65 * @brief Get the configured sensor definitions that make up a fan 66 * 67 * @param[in] sensor - JSON object containing a list of sensors 68 * 69 * @return List of sensor definition data that make up a fan being monitored 70 */ 71 const std::vector<SensorDefinition> getSensorDefs(const json& sensors); 72 73 /** 74 * @brief Get the configured fan definitions to be monitored 75 * 76 * @param[in] obj - JSON object to parse from 77 * 78 * @return List of fan definition data on the fans to be monitored 79 */ 80 const std::vector<FanDefinition> getFanDefs(const json& obj); 81 82 /** 83 * @brief Get the configured power off rules 84 * 85 * @param[in] obj - JSON object to parse from 86 * 87 * @param[in] powerInterface - The power interface object to use 88 * 89 * @param[in] func - Optional user defined function that gets called 90 * right before a power off occurs. 91 * 92 * @return std::vector<std::unique_ptr<PowerOffRule>> - 93 * The PowerOffRule objects 94 */ 95 std::vector<std::unique_ptr<PowerOffRule>> 96 getPowerOffRules(const json& obj, 97 std::shared_ptr<PowerInterfaceBase>& powerInterface, 98 PowerOffAction::PrePowerOffFunc& func); 99 100 /** 101 * @brief Returns the 'num_nonfunc_rotors_before_error field 102 * 103 * @param[in] obj - JSON object to parse from 104 * 105 * @return optional<size_t> - The value, or std::nullopt if not present 106 */ 107 std::optional<size_t> getNumNonfuncRotorsBeforeError(const json& obj); 108 109 } // namespace phosphor::fan::monitor 110