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 #pragma once 17 18 #include "power_state.hpp" 19 20 #include <sdbusplus/bus.hpp> 21 #include <sdbusplus/bus/match.hpp> 22 #include <sdeventplus/event.hpp> 23 24 namespace sensor::monitor 25 { 26 27 using InterfaceName = std::string; 28 using PropertyName = std::string; 29 using ErrorName = std::string; 30 using ErrorStatus = std::string; 31 using ObjectPath = std::string; 32 using InterfaceKey = std::tuple<ObjectPath, InterfaceName>; 33 34 /** 35 * @class ThresholdAlarmLogger 36 * 37 * This class watches the threshold interfaces 38 * openbmc_project.Sensor.Threshold.Warning 39 * openbmc_project.Sensor.Threshold.Critical 40 * openbmc_project.Sensor.Threshold.PerformanceLoss 41 * 42 * and creates event logs when their high and low alarm 43 * properties set and clear. The error names of the 44 * event logs are based on the sensor type and look like: 45 * 46 * xyz.openbmc_project.Sensor.Threshold.Error.TemperatureWarningHigh 47 * xyz.openbmc_project.Sensor.Threshold.Error.TemperatureWarningHighClear 48 * 49 * Event logs are only created when the power is on. 50 */ 51 class ThresholdAlarmLogger 52 { 53 public: 54 ThresholdAlarmLogger() = delete; 55 ~ThresholdAlarmLogger() = default; 56 ThresholdAlarmLogger(const ThresholdAlarmLogger&) = delete; 57 ThresholdAlarmLogger& operator=(const ThresholdAlarmLogger&) = delete; 58 ThresholdAlarmLogger(ThresholdAlarmLogger&&) = delete; 59 ThresholdAlarmLogger& operator=(ThresholdAlarmLogger&&) = delete; 60 61 /** 62 * @brief Constructor 63 * 64 * Looks for existing active threshold alarms. 65 * 66 * @param[in] bus - The sdbusplus bus object 67 * @param[in] powerState - The PowerState object 68 */ 69 ThresholdAlarmLogger(sdbusplus::bus_t& bus, 70 std::shared_ptr<phosphor::fan::PowerState> powerState); 71 72 private: 73 /** 74 * @brief The propertiesChanged handler for all of the thresholds 75 * interfaces. 76 * 77 * Creates event logs for high/low alarm sets and clears. 78 * 79 * @param[in] msg - The signal message payload. 80 */ 81 void propertiesChanged(sdbusplus::message_t& msg); 82 83 /** 84 * @brief The interfacesRemoved removed handler for the threshold 85 * interfaces. 86 * 87 * Removes that threshold from the alarms map 88 * 89 * @param[in] msg - The signal message payload. 90 */ 91 void interfacesRemoved(sdbusplus::message_t& msg); 92 93 /** 94 * @brief The interfacesAdded handler for the threshold 95 * interfaces. 96 * 97 * Checks the alarm when it shows up on D-Bus. 98 * 99 * @param[in] msg - The signal message payload. 100 */ 101 void interfacesAdded(sdbusplus::message_t& msg); 102 103 /** 104 * @brief Checks for alarms in the D-Bus data passed in, 105 * and creates an event log if necessary. 106 * 107 * @param[in] sensorPath - D-Bus path of the sensor 108 * @param[in] interface - The threshold interface name 109 * @param[in] properties - The map of property values on the interface 110 */ 111 void checkProperties( 112 const std::string& sensorPath, const std::string& interface, 113 const std::map<std::string, std::variant<bool>>& properties); 114 115 /** 116 * @brief Checks for active alarms on the path and threshold interface 117 * passed in and creates event logs if necessary. 118 * 119 * @param[in] interface - The threshold interface 120 * @param[in] sensorPath - The sensor D-Bus path 121 * @param[in] service - The D-Bus service that owns the interface 122 */ 123 void checkThresholds(const std::string& interface, 124 const std::string& sensorPath, 125 const std::string& service); 126 127 /** 128 * @brief Checks for all active alarms on all existing 129 * threshold interfaces and creates event logs 130 * if necessary. 131 */ 132 void checkThresholds(); 133 134 /** 135 * @brief Creates an event log for the alarm set/clear 136 * 137 * @param[in] sensorPath - The sensor object path 138 * @param[in] interface - The threshold interface 139 * @param[in] alarmProperty - The alarm property name 140 * @param[in] alarmValue - The alarm value 141 */ 142 void createEventLog(const std::string& sensorPath, 143 const std::string& interface, 144 const std::string& alarmProperty, bool alarmValue); 145 146 /** 147 * @brief Returns the type of the sensor using the path segment 148 * that precedes the sensor name. 149 * 150 * /xyz/openbmc_project/sensors/voltage/vout -> type == voltage 151 * 152 * @param[in] sensorPath - The sensor object path name 153 * 154 * @return std::string The type segment 155 */ 156 std::string getSensorType(std::string sensorPath); 157 158 /** 159 * @brief Returns the name of the sensor using the path segment 160 * 161 * /xyz/openbmc_project/sensors/voltage/vout -> name == vout 162 * 163 * @param[in] sensorPath - The sensor object path name 164 * 165 * @return std::string The name segment 166 */ 167 std::string getSensorName(const std::string& sensorPath); 168 169 /** 170 * @brief Allows for skipping event logs based on the sensor type. 171 * 172 * Specifically for the 'utilization' type because its provider 173 * doesn't support configurable thresholds yet. 174 * 175 * @param[in] type - The sensor type, like 'temperature'. 176 * @return bool - If it can be skipped or not. 177 */ 178 bool skipSensorType(const std::string& type); 179 180 /** 181 * @brief Returns the inventory path to use for a FRU callout 182 * for the alarm exceeded errors. 183 * 184 * It finds the path by looking for 'inventory' or 'chassis' 185 * association objects on the sensor that point to a FRU. 186 * 187 * @param[in] std::string - The sensor object path 188 * @return std::string - The inventory path for the FRU callout. 189 * May be empty if none found. 190 */ 191 std::string getCallout(const std::string& sensorPath); 192 193 /** 194 * @brief The power state changed handler. 195 * 196 * Checks alarms when power is turned on. 197 * 198 * @param[in] powerStateOn - If the power is now on or off. 199 */ 200 void powerStateChanged(bool powerStateOn); 201 202 /** 203 * @brief The sdbusplus bus object 204 */ 205 sdbusplus::bus_t& bus; 206 207 /** 208 * @brief The PowerState object to track power state changes. 209 */ 210 std::shared_ptr<phosphor::fan::PowerState> _powerState; 211 212 /** 213 * @brief The Warning interface match object 214 */ 215 sdbusplus::bus::match_t warningMatch; 216 217 /** 218 * @brief The Critical interface match object 219 */ 220 sdbusplus::bus::match_t criticalMatch; 221 222 /** 223 * @brief The PerformanceLoss interface match object 224 */ 225 sdbusplus::bus::match_t perfLossMatch; 226 227 /** 228 * @brief The InterfacesRemoved match object 229 */ 230 sdbusplus::bus::match_t ifacesRemovedMatch; 231 232 /** 233 * @brief The InterfacesAdded match object 234 */ 235 sdbusplus::bus::match_t ifacesAddedMatch; 236 237 /** 238 * @brief The current alarm values 239 */ 240 std::map<InterfaceKey, std::map<PropertyName, bool>> alarms; 241 }; 242 243 } // namespace sensor::monitor 244