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 17 #include "manager.hpp" 18 19 #include "chassis.hpp" 20 #include "config_file_parser.hpp" 21 #include "exception_utils.hpp" 22 #include "rule.hpp" 23 #include "utility.hpp" 24 25 #include <algorithm> 26 #include <chrono> 27 #include <exception> 28 #include <functional> 29 #include <map> 30 #include <tuple> 31 #include <utility> 32 #include <variant> 33 34 namespace phosphor::power::regulators 35 { 36 37 namespace fs = std::filesystem; 38 39 constexpr auto busName = "xyz.openbmc_project.Power.Regulators"; 40 constexpr auto managerObjPath = "/xyz/openbmc_project/power/regulators/manager"; 41 constexpr auto compatibleIntf = 42 "xyz.openbmc_project.Configuration.IBMCompatibleSystem"; 43 constexpr auto compatibleNamesProp = "Names"; 44 45 /** 46 * Default configuration file name. This is used when the system does not 47 * implement the D-Bus compatible interface. 48 */ 49 constexpr auto defaultConfigFileName = "config.json"; 50 51 /** 52 * Standard configuration file directory. This directory is part of the 53 * firmware install image. It contains the standard version of the config file. 54 */ 55 const fs::path standardConfigFileDir{"/usr/share/phosphor-regulators"}; 56 57 /** 58 * Test configuration file directory. This directory can contain a test version 59 * of the config file. The test version will override the standard version. 60 */ 61 const fs::path testConfigFileDir{"/etc/phosphor-regulators"}; 62 63 Manager::Manager(sdbusplus::bus::bus& bus, const sdeventplus::Event& event) : 64 ManagerObject{bus, managerObjPath, true}, bus{bus}, eventLoop{event}, 65 services{bus} 66 { 67 // Subscribe to D-Bus interfacesAdded signal from Entity Manager. This 68 // notifies us if the compatible interface becomes available later. 69 std::string matchStr = sdbusplus::bus::match::rules::interfacesAdded() + 70 sdbusplus::bus::match::rules::sender( 71 "xyz.openbmc_project.EntityManager"); 72 std::unique_ptr<sdbusplus::server::match::match> matchPtr = 73 std::make_unique<sdbusplus::server::match::match>( 74 bus, matchStr, 75 std::bind(&Manager::interfacesAddedHandler, this, 76 std::placeholders::_1)); 77 signals.emplace_back(std::move(matchPtr)); 78 79 // Try to find compatible system types using D-Bus compatible interface. 80 // Note that it might not be supported on this system, or the service that 81 // provides the interface might not be running yet. 82 findCompatibleSystemTypes(); 83 84 // Try to find and load the JSON configuration file 85 loadConfigFile(); 86 87 // Obtain dbus service name 88 bus.request_name(busName); 89 } 90 91 void Manager::configure() 92 { 93 // Clear any cached data or error history related to hardware devices 94 clearHardwareData(); 95 96 // Verify System object exists; this means config file has been loaded 97 if (system) 98 { 99 // Configure the regulator devices in the system 100 system->configure(services); 101 } 102 else 103 { 104 services.getJournal().logError("Unable to configure regulator devices: " 105 "Configuration file not loaded"); 106 // TODO: Log error 107 } 108 109 // TODO Configuration errors that should halt poweron, 110 // throw InternalFailure exception (or similar) to 111 // fail the call(busctl) to this method 112 } 113 114 void Manager::interfacesAddedHandler(sdbusplus::message::message& msg) 115 { 116 // Verify message is valid 117 if (!msg) 118 { 119 return; 120 } 121 122 try 123 { 124 // Read object path for object that was created or had interface added 125 sdbusplus::message::object_path objPath; 126 msg.read(objPath); 127 128 // Read the dictionary whose keys are interface names and whose values 129 // are dictionaries containing the interface property names and values 130 std::map<std::string, 131 std::map<std::string, std::variant<std::vector<std::string>>>> 132 intfProp; 133 msg.read(intfProp); 134 135 // Find the compatible interface, if present 136 auto itIntf = intfProp.find(compatibleIntf); 137 if (itIntf != intfProp.cend()) 138 { 139 // Find the Names property of the compatible interface, if present 140 auto itProp = itIntf->second.find(compatibleNamesProp); 141 if (itProp != itIntf->second.cend()) 142 { 143 // Get value of Names property 144 auto propValue = std::get<0>(itProp->second); 145 if (!propValue.empty()) 146 { 147 // Store list of compatible system types 148 compatibleSystemTypes = propValue; 149 150 // Find and load JSON config file based on system types 151 loadConfigFile(); 152 } 153 } 154 } 155 } 156 catch (const std::exception&) 157 { 158 // Error trying to read interfacesAdded message. One possible cause 159 // could be a property whose value is not a std::vector<std::string>. 160 } 161 } 162 163 void Manager::monitor(bool enable) 164 { 165 if (enable) 166 { 167 /* Temporarily comment out until monitoring is supported. 168 Timer timer(eventLoop, std::bind(&Manager::timerExpired, this)); 169 // Set timer as a repeating 1sec timer 170 timer.restart(std::chrono::milliseconds(1000)); 171 timers.emplace_back(std::move(timer)); 172 */ 173 } 174 else 175 { 176 /* Temporarily comment out until monitoring is supported. 177 // Delete all timers to disable monitoring 178 timers.clear(); 179 */ 180 181 // Verify System object exists; this means config file has been loaded 182 if (system) 183 { 184 // Close the regulator devices in the system. Monitoring is 185 // normally disabled because the system is being powered off. The 186 // devices should be closed in case hardware is removed or replaced 187 // while the system is powered off. 188 system->closeDevices(services); 189 } 190 } 191 } 192 193 void Manager::sighupHandler(sdeventplus::source::Signal& /*sigSrc*/, 194 const struct signalfd_siginfo* /*sigInfo*/) 195 { 196 // Reload the JSON configuration file 197 loadConfigFile(); 198 } 199 200 void Manager::timerExpired() 201 { 202 // TODO Analyze, refresh sensor status, and 203 // collect/update telemetry for each regulator 204 } 205 206 void Manager::clearHardwareData() 207 { 208 // Clear any cached hardware presence data and VPD values 209 services.getPresenceService().clearCache(); 210 services.getVPD().clearCache(); 211 212 // Verify System object exists; this means config file has been loaded 213 if (system) 214 { 215 // Clear any cached hardware data in the System object 216 system->clearCache(); 217 } 218 219 // TODO: Clear error history related to hardware devices 220 } 221 222 void Manager::findCompatibleSystemTypes() 223 { 224 using namespace phosphor::power::util; 225 226 try 227 { 228 // Query object mapper for object paths that implement the compatible 229 // interface. Returns a map of object paths to a map of services names 230 // to their interfaces. 231 DbusSubtree subTree = getSubTree(bus, "/xyz/openbmc_project/inventory", 232 compatibleIntf, 0); 233 234 // Get the first object path 235 auto objectIt = subTree.cbegin(); 236 if (objectIt != subTree.cend()) 237 { 238 std::string objPath = objectIt->first; 239 240 // Get the first service name 241 auto serviceIt = objectIt->second.cbegin(); 242 if (serviceIt != objectIt->second.cend()) 243 { 244 std::string service = serviceIt->first; 245 if (!service.empty()) 246 { 247 // Get compatible system types property value 248 getProperty(compatibleIntf, compatibleNamesProp, objPath, 249 service, bus, compatibleSystemTypes); 250 } 251 } 252 } 253 } 254 catch (const std::exception&) 255 { 256 // Compatible system types information is not available. The current 257 // system might not support the interface, or the service that 258 // implements the interface might not be running yet. 259 } 260 } 261 262 fs::path Manager::findConfigFile() 263 { 264 // Build list of possible base file names 265 std::vector<std::string> fileNames{}; 266 267 // Add possible file names based on compatible system types (if any) 268 for (const std::string& systemType : compatibleSystemTypes) 269 { 270 // Replace all spaces and commas in system type name with underscores 271 std::string fileName{systemType}; 272 std::replace(fileName.begin(), fileName.end(), ' ', '_'); 273 std::replace(fileName.begin(), fileName.end(), ',', '_'); 274 275 // Append .json suffix and add to list 276 fileName.append(".json"); 277 fileNames.emplace_back(fileName); 278 } 279 280 // Add default file name for systems that don't use compatible interface 281 fileNames.emplace_back(defaultConfigFileName); 282 283 // Look for a config file with one of the possible base names 284 for (const std::string& fileName : fileNames) 285 { 286 // Check if file exists in test directory 287 fs::path pathName{testConfigFileDir / fileName}; 288 if (fs::exists(pathName)) 289 { 290 return pathName; 291 } 292 293 // Check if file exists in standard directory 294 pathName = standardConfigFileDir / fileName; 295 if (fs::exists(pathName)) 296 { 297 return pathName; 298 } 299 } 300 301 // No config file found; return empty path 302 return fs::path{}; 303 } 304 305 void Manager::loadConfigFile() 306 { 307 try 308 { 309 // Find the absolute path to the config file 310 fs::path pathName = findConfigFile(); 311 if (!pathName.empty()) 312 { 313 // Log info message in journal; config file path is important 314 services.getJournal().logInfo("Loading configuration file " + 315 pathName.string()); 316 317 // Parse the config file 318 std::vector<std::unique_ptr<Rule>> rules{}; 319 std::vector<std::unique_ptr<Chassis>> chassis{}; 320 std::tie(rules, chassis) = config_file_parser::parse(pathName); 321 322 // Store config file information in a new System object. The old 323 // System object, if any, is automatically deleted. 324 system = 325 std::make_unique<System>(std::move(rules), std::move(chassis)); 326 } 327 } 328 catch (const std::exception& e) 329 { 330 // Log error messages in journal 331 services.getJournal().logError(exception_utils::getMessages(e)); 332 services.getJournal().logError("Unable to load configuration file"); 333 334 // TODO: Create error log entry 335 } 336 } 337 338 } // namespace phosphor::power::regulators 339