108777fb0SLewanczyk, Dawid /* 208777fb0SLewanczyk, Dawid // Copyright (c) 2018 Intel Corporation 308777fb0SLewanczyk, Dawid // 408777fb0SLewanczyk, Dawid // Licensed under the Apache License, Version 2.0 (the "License"); 508777fb0SLewanczyk, Dawid // you may not use this file except in compliance with the License. 608777fb0SLewanczyk, Dawid // You may obtain a copy of the License at 708777fb0SLewanczyk, Dawid // 808777fb0SLewanczyk, Dawid // http://www.apache.org/licenses/LICENSE-2.0 908777fb0SLewanczyk, Dawid // 1008777fb0SLewanczyk, Dawid // Unless required by applicable law or agreed to in writing, software 1108777fb0SLewanczyk, Dawid // distributed under the License is distributed on an "AS IS" BASIS, 1208777fb0SLewanczyk, Dawid // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1308777fb0SLewanczyk, Dawid // See the License for the specific language governing permissions and 1408777fb0SLewanczyk, Dawid // limitations under the License. 1508777fb0SLewanczyk, Dawid */ 1608777fb0SLewanczyk, Dawid #pragma once 1708777fb0SLewanczyk, Dawid 187e860f15SJohn Edward Broadbent #include <app.hpp> 1908777fb0SLewanczyk, Dawid #include <boost/algorithm/string/predicate.hpp> 2008777fb0SLewanczyk, Dawid #include <boost/algorithm/string/split.hpp> 2108777fb0SLewanczyk, Dawid #include <boost/container/flat_map.hpp> 2208777fb0SLewanczyk, Dawid #include <boost/range/algorithm/replace_copy_if.hpp> 231abe55efSEd Tanous #include <dbus_singleton.hpp> 24*ed398213SEd Tanous #include <registries/privilege_registry.hpp> 25413961deSRichard Marian Thomaiyar #include <utils/json_utils.hpp> 261214b7e7SGunnar Mills 271214b7e7SGunnar Mills #include <cmath> 28b5a76932SEd Tanous #include <utility> 29abf2add6SEd Tanous #include <variant> 3008777fb0SLewanczyk, Dawid 311abe55efSEd Tanous namespace redfish 321abe55efSEd Tanous { 3308777fb0SLewanczyk, Dawid 3408777fb0SLewanczyk, Dawid using GetSubTreeType = std::vector< 3508777fb0SLewanczyk, Dawid std::pair<std::string, 3608777fb0SLewanczyk, Dawid std::vector<std::pair<std::string, std::vector<std::string>>>>>; 3708777fb0SLewanczyk, Dawid 38adc4f0dbSShawn McCarney using SensorVariant = 39adc4f0dbSShawn McCarney std::variant<int64_t, double, uint32_t, bool, std::string>; 40aa2e59c1SEd Tanous 4108777fb0SLewanczyk, Dawid using ManagedObjectsVectorType = std::vector<std::pair< 42aa2e59c1SEd Tanous sdbusplus::message::object_path, 4308777fb0SLewanczyk, Dawid boost::container::flat_map< 44aa2e59c1SEd Tanous std::string, boost::container::flat_map<std::string, SensorVariant>>>>; 4508777fb0SLewanczyk, Dawid 46a0ec28b6SAdrian Ambrożewicz namespace sensors 47a0ec28b6SAdrian Ambrożewicz { 48a0ec28b6SAdrian Ambrożewicz namespace node 49a0ec28b6SAdrian Ambrożewicz { 50a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view power = "Power"; 51a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view sensors = "Sensors"; 52a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view thermal = "Thermal"; 53a0ec28b6SAdrian Ambrożewicz } // namespace node 54a0ec28b6SAdrian Ambrożewicz 55a0ec28b6SAdrian Ambrożewicz namespace dbus 56a0ec28b6SAdrian Ambrożewicz { 57c2bf7f99SWludzik, Jozef 58a0ec28b6SAdrian Ambrożewicz static const boost::container::flat_map<std::string_view, 59a0ec28b6SAdrian Ambrożewicz std::vector<const char*>> 60c2bf7f99SWludzik, Jozef paths = {{node::power, 61a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/voltage", 62a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/power"}}, 63a0ec28b6SAdrian Ambrożewicz {node::sensors, 64a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/power", 65a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/current", 66a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/utilization"}}, 67a0ec28b6SAdrian Ambrożewicz {node::thermal, 68a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/fan_tach", 69a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/temperature", 70a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/fan_pwm"}}}; 71c2bf7f99SWludzik, Jozef } // namespace dbus 72c2bf7f99SWludzik, Jozef 73c2bf7f99SWludzik, Jozef inline const char* toReadingType(const std::string& sensorType) 74c2bf7f99SWludzik, Jozef { 75c2bf7f99SWludzik, Jozef if (sensorType == "voltage") 76c2bf7f99SWludzik, Jozef { 77c2bf7f99SWludzik, Jozef return "Voltage"; 78c2bf7f99SWludzik, Jozef } 79c2bf7f99SWludzik, Jozef if (sensorType == "power") 80c2bf7f99SWludzik, Jozef { 81c2bf7f99SWludzik, Jozef return "Power"; 82c2bf7f99SWludzik, Jozef } 83c2bf7f99SWludzik, Jozef if (sensorType == "current") 84c2bf7f99SWludzik, Jozef { 85c2bf7f99SWludzik, Jozef return "Current"; 86c2bf7f99SWludzik, Jozef } 87c2bf7f99SWludzik, Jozef if (sensorType == "fan_tach") 88c2bf7f99SWludzik, Jozef { 89c2bf7f99SWludzik, Jozef return "Rotational"; 90c2bf7f99SWludzik, Jozef } 91c2bf7f99SWludzik, Jozef if (sensorType == "temperature") 92c2bf7f99SWludzik, Jozef { 93c2bf7f99SWludzik, Jozef return "Temperature"; 94c2bf7f99SWludzik, Jozef } 95c2bf7f99SWludzik, Jozef if (sensorType == "fan_pwm" || sensorType == "utilization") 96c2bf7f99SWludzik, Jozef { 97c2bf7f99SWludzik, Jozef return "Percent"; 98c2bf7f99SWludzik, Jozef } 99c2bf7f99SWludzik, Jozef if (sensorType == "altitude") 100c2bf7f99SWludzik, Jozef { 101c2bf7f99SWludzik, Jozef return "Altitude"; 102c2bf7f99SWludzik, Jozef } 103c2bf7f99SWludzik, Jozef if (sensorType == "airflow") 104c2bf7f99SWludzik, Jozef { 105c2bf7f99SWludzik, Jozef return "AirFlow"; 106c2bf7f99SWludzik, Jozef } 107c2bf7f99SWludzik, Jozef if (sensorType == "energy") 108c2bf7f99SWludzik, Jozef { 109c2bf7f99SWludzik, Jozef return "EnergyJoules"; 110c2bf7f99SWludzik, Jozef } 111c2bf7f99SWludzik, Jozef return ""; 112c2bf7f99SWludzik, Jozef } 113c2bf7f99SWludzik, Jozef 114c2bf7f99SWludzik, Jozef inline const char* toReadingUnits(const std::string& sensorType) 115c2bf7f99SWludzik, Jozef { 116c2bf7f99SWludzik, Jozef if (sensorType == "voltage") 117c2bf7f99SWludzik, Jozef { 118c2bf7f99SWludzik, Jozef return "V"; 119c2bf7f99SWludzik, Jozef } 120c2bf7f99SWludzik, Jozef if (sensorType == "power") 121c2bf7f99SWludzik, Jozef { 122c2bf7f99SWludzik, Jozef return "W"; 123c2bf7f99SWludzik, Jozef } 124c2bf7f99SWludzik, Jozef if (sensorType == "current") 125c2bf7f99SWludzik, Jozef { 126c2bf7f99SWludzik, Jozef return "A"; 127c2bf7f99SWludzik, Jozef } 128c2bf7f99SWludzik, Jozef if (sensorType == "fan_tach") 129c2bf7f99SWludzik, Jozef { 130c2bf7f99SWludzik, Jozef return "RPM"; 131c2bf7f99SWludzik, Jozef } 132c2bf7f99SWludzik, Jozef if (sensorType == "temperature") 133c2bf7f99SWludzik, Jozef { 134c2bf7f99SWludzik, Jozef return "Cel"; 135c2bf7f99SWludzik, Jozef } 136c2bf7f99SWludzik, Jozef if (sensorType == "fan_pwm" || sensorType == "utilization") 137c2bf7f99SWludzik, Jozef { 138c2bf7f99SWludzik, Jozef return "%"; 139c2bf7f99SWludzik, Jozef } 140c2bf7f99SWludzik, Jozef if (sensorType == "altitude") 141c2bf7f99SWludzik, Jozef { 142c2bf7f99SWludzik, Jozef return "m"; 143c2bf7f99SWludzik, Jozef } 144c2bf7f99SWludzik, Jozef if (sensorType == "airflow") 145c2bf7f99SWludzik, Jozef { 146c2bf7f99SWludzik, Jozef return "cft_i/min"; 147c2bf7f99SWludzik, Jozef } 148c2bf7f99SWludzik, Jozef if (sensorType == "energy") 149c2bf7f99SWludzik, Jozef { 150c2bf7f99SWludzik, Jozef return "J"; 151c2bf7f99SWludzik, Jozef } 152c2bf7f99SWludzik, Jozef return ""; 153a0ec28b6SAdrian Ambrożewicz } 154a0ec28b6SAdrian Ambrożewicz } // namespace sensors 155a0ec28b6SAdrian Ambrożewicz 15608777fb0SLewanczyk, Dawid /** 157588c3f0dSKowalski, Kamil * SensorsAsyncResp 15808777fb0SLewanczyk, Dawid * Gathers data needed for response processing after async calls are done 15908777fb0SLewanczyk, Dawid */ 1601abe55efSEd Tanous class SensorsAsyncResp 1611abe55efSEd Tanous { 16208777fb0SLewanczyk, Dawid public: 163a0ec28b6SAdrian Ambrożewicz using DataCompleteCb = std::function<void( 164a0ec28b6SAdrian Ambrożewicz const boost::beast::http::status status, 165a0ec28b6SAdrian Ambrożewicz const boost::container::flat_map<std::string, std::string>& uriToDbus)>; 166a0ec28b6SAdrian Ambrożewicz 167a0ec28b6SAdrian Ambrożewicz struct SensorData 168a0ec28b6SAdrian Ambrożewicz { 169a0ec28b6SAdrian Ambrożewicz const std::string name; 170a0ec28b6SAdrian Ambrożewicz std::string uri; 171a0ec28b6SAdrian Ambrożewicz const std::string valueKey; 172a0ec28b6SAdrian Ambrożewicz const std::string dbusPath; 173a0ec28b6SAdrian Ambrożewicz }; 174a0ec28b6SAdrian Ambrożewicz 1758d1b46d7Szhanghch05 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1768d1b46d7Szhanghch05 const std::string& chassisIdIn, 177b5a76932SEd Tanous const std::vector<const char*>& typesIn, 178a0ec28b6SAdrian Ambrożewicz const std::string_view& subNode) : 1798d1b46d7Szhanghch05 asyncResp(asyncResp), 180271584abSEd Tanous chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode) 1811214b7e7SGunnar Mills {} 18208777fb0SLewanczyk, Dawid 183a0ec28b6SAdrian Ambrożewicz // Store extra data about sensor mapping and return it in callback 1848d1b46d7Szhanghch05 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1858d1b46d7Szhanghch05 const std::string& chassisIdIn, 186b5a76932SEd Tanous const std::vector<const char*>& typesIn, 187a0ec28b6SAdrian Ambrożewicz const std::string_view& subNode, 188a0ec28b6SAdrian Ambrożewicz DataCompleteCb&& creationComplete) : 1898d1b46d7Szhanghch05 asyncResp(asyncResp), 190a0ec28b6SAdrian Ambrożewicz chassisId(chassisIdIn), types(typesIn), 191a0ec28b6SAdrian Ambrożewicz chassisSubNode(subNode), metadata{std::vector<SensorData>()}, 192a0ec28b6SAdrian Ambrożewicz dataComplete{std::move(creationComplete)} 193a0ec28b6SAdrian Ambrożewicz {} 194a0ec28b6SAdrian Ambrożewicz 1951abe55efSEd Tanous ~SensorsAsyncResp() 1961abe55efSEd Tanous { 1978d1b46d7Szhanghch05 if (asyncResp->res.result() == 1988d1b46d7Szhanghch05 boost::beast::http::status::internal_server_error) 1991abe55efSEd Tanous { 2001abe55efSEd Tanous // Reset the json object to clear out any data that made it in 2011abe55efSEd Tanous // before the error happened todo(ed) handle error condition with 2021abe55efSEd Tanous // proper code 2038d1b46d7Szhanghch05 asyncResp->res.jsonValue = nlohmann::json::object(); 20408777fb0SLewanczyk, Dawid } 205a0ec28b6SAdrian Ambrożewicz 206a0ec28b6SAdrian Ambrożewicz if (dataComplete && metadata) 207a0ec28b6SAdrian Ambrożewicz { 208a0ec28b6SAdrian Ambrożewicz boost::container::flat_map<std::string, std::string> map; 2098d1b46d7Szhanghch05 if (asyncResp->res.result() == boost::beast::http::status::ok) 210a0ec28b6SAdrian Ambrożewicz { 211a0ec28b6SAdrian Ambrożewicz for (auto& sensor : *metadata) 212a0ec28b6SAdrian Ambrożewicz { 213a0ec28b6SAdrian Ambrożewicz map.insert(std::make_pair(sensor.uri + sensor.valueKey, 214a0ec28b6SAdrian Ambrożewicz sensor.dbusPath)); 215a0ec28b6SAdrian Ambrożewicz } 216a0ec28b6SAdrian Ambrożewicz } 2178d1b46d7Szhanghch05 dataComplete(asyncResp->res.result(), map); 218a0ec28b6SAdrian Ambrożewicz } 21908777fb0SLewanczyk, Dawid } 220588c3f0dSKowalski, Kamil 221a0ec28b6SAdrian Ambrożewicz void addMetadata(const nlohmann::json& sensorObject, 222a0ec28b6SAdrian Ambrożewicz const std::string& valueKey, const std::string& dbusPath) 223a0ec28b6SAdrian Ambrożewicz { 224a0ec28b6SAdrian Ambrożewicz if (metadata) 225a0ec28b6SAdrian Ambrożewicz { 226a0ec28b6SAdrian Ambrożewicz metadata->emplace_back(SensorData{sensorObject["Name"], 227a0ec28b6SAdrian Ambrożewicz sensorObject["@odata.id"], 228a0ec28b6SAdrian Ambrożewicz valueKey, dbusPath}); 229a0ec28b6SAdrian Ambrożewicz } 230a0ec28b6SAdrian Ambrożewicz } 231a0ec28b6SAdrian Ambrożewicz 232a0ec28b6SAdrian Ambrożewicz void updateUri(const std::string& name, const std::string& uri) 233a0ec28b6SAdrian Ambrożewicz { 234a0ec28b6SAdrian Ambrożewicz if (metadata) 235a0ec28b6SAdrian Ambrożewicz { 236a0ec28b6SAdrian Ambrożewicz for (auto& sensor : *metadata) 237a0ec28b6SAdrian Ambrożewicz { 238a0ec28b6SAdrian Ambrożewicz if (sensor.name == name) 239a0ec28b6SAdrian Ambrożewicz { 240a0ec28b6SAdrian Ambrożewicz sensor.uri = uri; 241a0ec28b6SAdrian Ambrożewicz } 242a0ec28b6SAdrian Ambrożewicz } 243a0ec28b6SAdrian Ambrożewicz } 244a0ec28b6SAdrian Ambrożewicz } 245a0ec28b6SAdrian Ambrożewicz 2468d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp> asyncResp; 247a0ec28b6SAdrian Ambrożewicz const std::string chassisId; 24808777fb0SLewanczyk, Dawid const std::vector<const char*> types; 249a0ec28b6SAdrian Ambrożewicz const std::string chassisSubNode; 250a0ec28b6SAdrian Ambrożewicz 251a0ec28b6SAdrian Ambrożewicz private: 252a0ec28b6SAdrian Ambrożewicz std::optional<std::vector<SensorData>> metadata; 253a0ec28b6SAdrian Ambrożewicz DataCompleteCb dataComplete; 25408777fb0SLewanczyk, Dawid }; 25508777fb0SLewanczyk, Dawid 25608777fb0SLewanczyk, Dawid /** 257d500549bSAnthony Wilson * Possible states for physical inventory leds 258d500549bSAnthony Wilson */ 259d500549bSAnthony Wilson enum class LedState 260d500549bSAnthony Wilson { 261d500549bSAnthony Wilson OFF, 262d500549bSAnthony Wilson ON, 263d500549bSAnthony Wilson BLINK, 264d500549bSAnthony Wilson UNKNOWN 265d500549bSAnthony Wilson }; 266d500549bSAnthony Wilson 267d500549bSAnthony Wilson /** 268adc4f0dbSShawn McCarney * D-Bus inventory item associated with one or more sensors. 269adc4f0dbSShawn McCarney */ 270adc4f0dbSShawn McCarney class InventoryItem 271adc4f0dbSShawn McCarney { 272adc4f0dbSShawn McCarney public: 273adc4f0dbSShawn McCarney InventoryItem(const std::string& objPath) : 274adc4f0dbSShawn McCarney objectPath(objPath), name(), isPresent(true), isFunctional(true), 27542cbe538SGunnar Mills isPowerSupply(false), powerSupplyEfficiencyPercent(-1), manufacturer(), 27642cbe538SGunnar Mills model(), partNumber(), serialNumber(), sensors(), ledObjectPath(""), 277d500549bSAnthony Wilson ledState(LedState::UNKNOWN) 278adc4f0dbSShawn McCarney { 279adc4f0dbSShawn McCarney // Set inventory item name to last node of object path 28028aa8de5SGeorge Liu sdbusplus::message::object_path path(objectPath); 28128aa8de5SGeorge Liu name = path.filename(); 28228aa8de5SGeorge Liu if (name.empty()) 283adc4f0dbSShawn McCarney { 28428aa8de5SGeorge Liu BMCWEB_LOG_ERROR << "Failed to find '/' in " << objectPath; 285adc4f0dbSShawn McCarney } 286adc4f0dbSShawn McCarney } 287adc4f0dbSShawn McCarney 288adc4f0dbSShawn McCarney std::string objectPath; 289adc4f0dbSShawn McCarney std::string name; 290adc4f0dbSShawn McCarney bool isPresent; 291adc4f0dbSShawn McCarney bool isFunctional; 292adc4f0dbSShawn McCarney bool isPowerSupply; 29342cbe538SGunnar Mills int powerSupplyEfficiencyPercent; 294adc4f0dbSShawn McCarney std::string manufacturer; 295adc4f0dbSShawn McCarney std::string model; 296adc4f0dbSShawn McCarney std::string partNumber; 297adc4f0dbSShawn McCarney std::string serialNumber; 298adc4f0dbSShawn McCarney std::set<std::string> sensors; 299d500549bSAnthony Wilson std::string ledObjectPath; 300d500549bSAnthony Wilson LedState ledState; 301adc4f0dbSShawn McCarney }; 302adc4f0dbSShawn McCarney 303adc4f0dbSShawn McCarney /** 304413961deSRichard Marian Thomaiyar * @brief Get objects with connection necessary for sensors 305588c3f0dSKowalski, Kamil * @param SensorsAsyncResp Pointer to object holding response data 30608777fb0SLewanczyk, Dawid * @param sensorNames Sensors retrieved from chassis 30708777fb0SLewanczyk, Dawid * @param callback Callback for processing gathered connections 30808777fb0SLewanczyk, Dawid */ 30908777fb0SLewanczyk, Dawid template <typename Callback> 310413961deSRichard Marian Thomaiyar void getObjectsWithConnection( 31181ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 312b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 3131abe55efSEd Tanous Callback&& callback) 3141abe55efSEd Tanous { 315413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection enter"; 31603b5bae3SJames Feist const std::string path = "/xyz/openbmc_project/sensors"; 31708777fb0SLewanczyk, Dawid const std::array<std::string, 1> interfaces = { 31808777fb0SLewanczyk, Dawid "xyz.openbmc_project.Sensor.Value"}; 31908777fb0SLewanczyk, Dawid 32008777fb0SLewanczyk, Dawid // Response handler for parsing objects subtree 32181ce609eSEd Tanous auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 3221abe55efSEd Tanous sensorNames](const boost::system::error_code ec, 3231abe55efSEd Tanous const GetSubTreeType& subtree) { 324413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler enter"; 3251abe55efSEd Tanous if (ec) 3261abe55efSEd Tanous { 3278d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 328413961deSRichard Marian Thomaiyar BMCWEB_LOG_ERROR 329413961deSRichard Marian Thomaiyar << "getObjectsWithConnection resp_handler: Dbus error " << ec; 33008777fb0SLewanczyk, Dawid return; 33108777fb0SLewanczyk, Dawid } 33208777fb0SLewanczyk, Dawid 33355c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Found " << subtree.size() << " subtrees"; 33408777fb0SLewanczyk, Dawid 33508777fb0SLewanczyk, Dawid // Make unique list of connections only for requested sensor types and 33608777fb0SLewanczyk, Dawid // found in the chassis 33708777fb0SLewanczyk, Dawid boost::container::flat_set<std::string> connections; 338413961deSRichard Marian Thomaiyar std::set<std::pair<std::string, std::string>> objectsWithConnection; 3391abe55efSEd Tanous // Intrinsic to avoid malloc. Most systems will have < 8 sensor 3401abe55efSEd Tanous // producers 34108777fb0SLewanczyk, Dawid connections.reserve(8); 34208777fb0SLewanczyk, Dawid 34349c53ac9SJohnathan Mantey BMCWEB_LOG_DEBUG << "sensorNames list count: " << sensorNames->size(); 34449c53ac9SJohnathan Mantey for (const std::string& tsensor : *sensorNames) 3451abe55efSEd Tanous { 34655c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Sensor to find: " << tsensor; 34708777fb0SLewanczyk, Dawid } 34808777fb0SLewanczyk, Dawid 34908777fb0SLewanczyk, Dawid for (const std::pair< 35008777fb0SLewanczyk, Dawid std::string, 35108777fb0SLewanczyk, Dawid std::vector<std::pair<std::string, std::vector<std::string>>>>& 3521abe55efSEd Tanous object : subtree) 3531abe55efSEd Tanous { 35449c53ac9SJohnathan Mantey if (sensorNames->find(object.first) != sensorNames->end()) 3551abe55efSEd Tanous { 35649c53ac9SJohnathan Mantey for (const std::pair<std::string, std::vector<std::string>>& 3571abe55efSEd Tanous objData : object.second) 3581abe55efSEd Tanous { 35949c53ac9SJohnathan Mantey BMCWEB_LOG_DEBUG << "Adding connection: " << objData.first; 36008777fb0SLewanczyk, Dawid connections.insert(objData.first); 361de629b6eSShawn McCarney objectsWithConnection.insert( 362de629b6eSShawn McCarney std::make_pair(object.first, objData.first)); 36308777fb0SLewanczyk, Dawid } 36408777fb0SLewanczyk, Dawid } 36508777fb0SLewanczyk, Dawid } 36655c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Found " << connections.size() << " connections"; 367413961deSRichard Marian Thomaiyar callback(std::move(connections), std::move(objectsWithConnection)); 368413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler exit"; 36908777fb0SLewanczyk, Dawid }; 37008777fb0SLewanczyk, Dawid // Make call to ObjectMapper to find all sensors objects 37155c7b7a2SEd Tanous crow::connections::systemBus->async_method_call( 37255c7b7a2SEd Tanous std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 3731abe55efSEd Tanous "/xyz/openbmc_project/object_mapper", 3741abe55efSEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 2, interfaces); 375413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection exit"; 376413961deSRichard Marian Thomaiyar } 377413961deSRichard Marian Thomaiyar 378413961deSRichard Marian Thomaiyar /** 379413961deSRichard Marian Thomaiyar * @brief Create connections necessary for sensors 380413961deSRichard Marian Thomaiyar * @param SensorsAsyncResp Pointer to object holding response data 381413961deSRichard Marian Thomaiyar * @param sensorNames Sensors retrieved from chassis 382413961deSRichard Marian Thomaiyar * @param callback Callback for processing gathered connections 383413961deSRichard Marian Thomaiyar */ 384413961deSRichard Marian Thomaiyar template <typename Callback> 38549c53ac9SJohnathan Mantey void getConnections( 38681ce609eSEd Tanous std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 38749c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> sensorNames, 388413961deSRichard Marian Thomaiyar Callback&& callback) 389413961deSRichard Marian Thomaiyar { 390413961deSRichard Marian Thomaiyar auto objectsWithConnectionCb = 391413961deSRichard Marian Thomaiyar [callback](const boost::container::flat_set<std::string>& connections, 392413961deSRichard Marian Thomaiyar const std::set<std::pair<std::string, std::string>>& 3933174e4dfSEd Tanous /*objectsWithConnection*/) { callback(connections); }; 39481ce609eSEd Tanous getObjectsWithConnection(sensorsAsyncResp, sensorNames, 395413961deSRichard Marian Thomaiyar std::move(objectsWithConnectionCb)); 39608777fb0SLewanczyk, Dawid } 39708777fb0SLewanczyk, Dawid 39808777fb0SLewanczyk, Dawid /** 39949c53ac9SJohnathan Mantey * @brief Shrinks the list of sensors for processing 40049c53ac9SJohnathan Mantey * @param SensorsAysncResp The class holding the Redfish response 40149c53ac9SJohnathan Mantey * @param allSensors A list of all the sensors associated to the 40249c53ac9SJohnathan Mantey * chassis element (i.e. baseboard, front panel, etc...) 40349c53ac9SJohnathan Mantey * @param activeSensors A list that is a reduction of the incoming 40449c53ac9SJohnathan Mantey * allSensors list. Eliminate Thermal sensors when a Power request is 40549c53ac9SJohnathan Mantey * made, and eliminate Power sensors when a Thermal request is made. 40649c53ac9SJohnathan Mantey */ 40723a21a1cSEd Tanous inline void reduceSensorList( 40881ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 40949c53ac9SJohnathan Mantey const std::vector<std::string>* allSensors, 410b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& 411b5a76932SEd Tanous activeSensors) 41249c53ac9SJohnathan Mantey { 41381ce609eSEd Tanous if (sensorsAsyncResp == nullptr) 41449c53ac9SJohnathan Mantey { 41549c53ac9SJohnathan Mantey return; 41649c53ac9SJohnathan Mantey } 41749c53ac9SJohnathan Mantey if ((allSensors == nullptr) || (activeSensors == nullptr)) 41849c53ac9SJohnathan Mantey { 41949c53ac9SJohnathan Mantey messages::resourceNotFound( 4208d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res, sensorsAsyncResp->chassisSubNode, 42181ce609eSEd Tanous sensorsAsyncResp->chassisSubNode == sensors::node::thermal 422a0ec28b6SAdrian Ambrożewicz ? "Temperatures" 42349c53ac9SJohnathan Mantey : "Voltages"); 42449c53ac9SJohnathan Mantey 42549c53ac9SJohnathan Mantey return; 42649c53ac9SJohnathan Mantey } 42749c53ac9SJohnathan Mantey if (allSensors->empty()) 42849c53ac9SJohnathan Mantey { 42949c53ac9SJohnathan Mantey // Nothing to do, the activeSensors object is also empty 43049c53ac9SJohnathan Mantey return; 43149c53ac9SJohnathan Mantey } 43249c53ac9SJohnathan Mantey 43381ce609eSEd Tanous for (const char* type : sensorsAsyncResp->types) 43449c53ac9SJohnathan Mantey { 43549c53ac9SJohnathan Mantey for (const std::string& sensor : *allSensors) 43649c53ac9SJohnathan Mantey { 43749c53ac9SJohnathan Mantey if (boost::starts_with(sensor, type)) 43849c53ac9SJohnathan Mantey { 43949c53ac9SJohnathan Mantey activeSensors->emplace(sensor); 44049c53ac9SJohnathan Mantey } 44149c53ac9SJohnathan Mantey } 44249c53ac9SJohnathan Mantey } 44349c53ac9SJohnathan Mantey } 44449c53ac9SJohnathan Mantey 44549c53ac9SJohnathan Mantey /** 4464bb3dc34SCarol Wang * @brief Retrieves valid chassis path 4474bb3dc34SCarol Wang * @param asyncResp Pointer to object holding response data 4484bb3dc34SCarol Wang * @param callback Callback for next step to get valid chassis path 4494bb3dc34SCarol Wang */ 4504bb3dc34SCarol Wang template <typename Callback> 451b5a76932SEd Tanous void getValidChassisPath(const std::shared_ptr<SensorsAsyncResp>& asyncResp, 4524bb3dc34SCarol Wang Callback&& callback) 4534bb3dc34SCarol Wang { 4544bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "checkChassisId enter"; 4554bb3dc34SCarol Wang const std::array<const char*, 2> interfaces = { 4564bb3dc34SCarol Wang "xyz.openbmc_project.Inventory.Item.Board", 4574bb3dc34SCarol Wang "xyz.openbmc_project.Inventory.Item.Chassis"}; 4584bb3dc34SCarol Wang 4594bb3dc34SCarol Wang auto respHandler = 4604bb3dc34SCarol Wang [callback{std::move(callback)}, 4614bb3dc34SCarol Wang asyncResp](const boost::system::error_code ec, 4624bb3dc34SCarol Wang const std::vector<std::string>& chassisPaths) mutable { 4634bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "getValidChassisPath respHandler enter"; 4644bb3dc34SCarol Wang if (ec) 4654bb3dc34SCarol Wang { 4664bb3dc34SCarol Wang BMCWEB_LOG_ERROR 4674bb3dc34SCarol Wang << "getValidChassisPath respHandler DBUS error: " << ec; 4688d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 4694bb3dc34SCarol Wang return; 4704bb3dc34SCarol Wang } 4714bb3dc34SCarol Wang 4724bb3dc34SCarol Wang std::optional<std::string> chassisPath; 4734bb3dc34SCarol Wang std::string chassisName; 4744bb3dc34SCarol Wang for (const std::string& chassis : chassisPaths) 4754bb3dc34SCarol Wang { 47628aa8de5SGeorge Liu sdbusplus::message::object_path path(chassis); 47728aa8de5SGeorge Liu chassisName = path.filename(); 47828aa8de5SGeorge Liu if (chassisName.empty()) 4794bb3dc34SCarol Wang { 4804bb3dc34SCarol Wang BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis; 4814bb3dc34SCarol Wang continue; 4824bb3dc34SCarol Wang } 4834bb3dc34SCarol Wang if (chassisName == asyncResp->chassisId) 4844bb3dc34SCarol Wang { 4854bb3dc34SCarol Wang chassisPath = chassis; 4864bb3dc34SCarol Wang break; 4874bb3dc34SCarol Wang } 4884bb3dc34SCarol Wang } 4894bb3dc34SCarol Wang callback(chassisPath); 4904bb3dc34SCarol Wang }; 4914bb3dc34SCarol Wang 4924bb3dc34SCarol Wang // Get the Chassis Collection 4934bb3dc34SCarol Wang crow::connections::systemBus->async_method_call( 4944bb3dc34SCarol Wang respHandler, "xyz.openbmc_project.ObjectMapper", 4954bb3dc34SCarol Wang "/xyz/openbmc_project/object_mapper", 4964bb3dc34SCarol Wang "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 4974bb3dc34SCarol Wang "/xyz/openbmc_project/inventory", 0, interfaces); 4984bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "checkChassisId exit"; 4994bb3dc34SCarol Wang } 5004bb3dc34SCarol Wang 5014bb3dc34SCarol Wang /** 50208777fb0SLewanczyk, Dawid * @brief Retrieves requested chassis sensors and redundancy data from DBus . 503588c3f0dSKowalski, Kamil * @param SensorsAsyncResp Pointer to object holding response data 50408777fb0SLewanczyk, Dawid * @param callback Callback for next step in gathered sensor processing 50508777fb0SLewanczyk, Dawid */ 50608777fb0SLewanczyk, Dawid template <typename Callback> 507b5a76932SEd Tanous void getChassis(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 5081abe55efSEd Tanous Callback&& callback) 5091abe55efSEd Tanous { 51055c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis enter"; 511adc4f0dbSShawn McCarney const std::array<const char*, 2> interfaces = { 51249c53ac9SJohnathan Mantey "xyz.openbmc_project.Inventory.Item.Board", 513adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Item.Chassis"}; 51449c53ac9SJohnathan Mantey auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp]( 51549c53ac9SJohnathan Mantey const boost::system::error_code ec, 51649c53ac9SJohnathan Mantey const std::vector<std::string>& chassisPaths) { 51755c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis respHandler enter"; 5181abe55efSEd Tanous if (ec) 5191abe55efSEd Tanous { 52055c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "getChassis respHandler DBUS error: " << ec; 5218d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 52208777fb0SLewanczyk, Dawid return; 52308777fb0SLewanczyk, Dawid } 52408777fb0SLewanczyk, Dawid 52549c53ac9SJohnathan Mantey const std::string* chassisPath = nullptr; 52649c53ac9SJohnathan Mantey std::string chassisName; 52749c53ac9SJohnathan Mantey for (const std::string& chassis : chassisPaths) 5281abe55efSEd Tanous { 52928aa8de5SGeorge Liu sdbusplus::message::object_path path(chassis); 53028aa8de5SGeorge Liu chassisName = path.filename(); 53128aa8de5SGeorge Liu if (chassisName.empty()) 5321abe55efSEd Tanous { 53349c53ac9SJohnathan Mantey BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis; 534daf36e2eSEd Tanous continue; 535daf36e2eSEd Tanous } 53649c53ac9SJohnathan Mantey if (chassisName == sensorsAsyncResp->chassisId) 5371abe55efSEd Tanous { 53849c53ac9SJohnathan Mantey chassisPath = &chassis; 53949c53ac9SJohnathan Mantey break; 540daf36e2eSEd Tanous } 54149c53ac9SJohnathan Mantey } 54249c53ac9SJohnathan Mantey if (chassisPath == nullptr) 5431abe55efSEd Tanous { 5448d1b46d7Szhanghch05 messages::resourceNotFound(sensorsAsyncResp->asyncResp->res, 5458d1b46d7Szhanghch05 "Chassis", sensorsAsyncResp->chassisId); 54649c53ac9SJohnathan Mantey return; 5471abe55efSEd Tanous } 54808777fb0SLewanczyk, Dawid 54949c53ac9SJohnathan Mantey const std::string& chassisSubNode = sensorsAsyncResp->chassisSubNode; 550a0ec28b6SAdrian Ambrożewicz if (chassisSubNode == sensors::node::power) 55149c53ac9SJohnathan Mantey { 5528d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 55349c53ac9SJohnathan Mantey "#Power.v1_5_2.Power"; 55449c53ac9SJohnathan Mantey } 555a0ec28b6SAdrian Ambrożewicz else if (chassisSubNode == sensors::node::thermal) 55649c53ac9SJohnathan Mantey { 5578d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 55849c53ac9SJohnathan Mantey "#Thermal.v1_4_0.Thermal"; 5598d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Fans"] = 5608d1b46d7Szhanghch05 nlohmann::json::array(); 5618d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Temperatures"] = 5624f9a2130SJennifer Lee nlohmann::json::array(); 56349c53ac9SJohnathan Mantey } 564a0ec28b6SAdrian Ambrożewicz else if (chassisSubNode == sensors::node::sensors) 56595a3ecadSAnthony Wilson { 5668d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 56795a3ecadSAnthony Wilson "#SensorCollection.SensorCollection"; 5688d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Description"] = 56995a3ecadSAnthony Wilson "Collection of Sensors for this Chassis"; 5708d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Members"] = 57195a3ecadSAnthony Wilson nlohmann::json::array(); 5728d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Members@odata.count"] = 5738d1b46d7Szhanghch05 0; 57495a3ecadSAnthony Wilson } 57595a3ecadSAnthony Wilson 576a0ec28b6SAdrian Ambrożewicz if (chassisSubNode != sensors::node::sensors) 57795a3ecadSAnthony Wilson { 5788d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Id"] = chassisSubNode; 57995a3ecadSAnthony Wilson } 58095a3ecadSAnthony Wilson 5818d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] = 58249c53ac9SJohnathan Mantey "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + "/" + 58349c53ac9SJohnathan Mantey chassisSubNode; 5848d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Name"] = chassisSubNode; 5858fb49dd6SShawn McCarney // Get the list of all sensors for this Chassis element 5868fb49dd6SShawn McCarney std::string sensorPath = *chassisPath + "/all_sensors"; 58755c7b7a2SEd Tanous crow::connections::systemBus->async_method_call( 58849c53ac9SJohnathan Mantey [sensorsAsyncResp, callback{std::move(callback)}]( 589271584abSEd Tanous const boost::system::error_code& e, 59049c53ac9SJohnathan Mantey const std::variant<std::vector<std::string>>& 59149c53ac9SJohnathan Mantey variantEndpoints) { 592271584abSEd Tanous if (e) 59349c53ac9SJohnathan Mantey { 594271584abSEd Tanous if (e.value() != EBADR) 59549c53ac9SJohnathan Mantey { 5968d1b46d7Szhanghch05 messages::internalError( 5978d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 59849c53ac9SJohnathan Mantey return; 59949c53ac9SJohnathan Mantey } 60049c53ac9SJohnathan Mantey } 60149c53ac9SJohnathan Mantey const std::vector<std::string>* nodeSensorList = 60249c53ac9SJohnathan Mantey std::get_if<std::vector<std::string>>(&(variantEndpoints)); 60349c53ac9SJohnathan Mantey if (nodeSensorList == nullptr) 60449c53ac9SJohnathan Mantey { 60549c53ac9SJohnathan Mantey messages::resourceNotFound( 6068d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res, 6078d1b46d7Szhanghch05 sensorsAsyncResp->chassisSubNode, 608a0ec28b6SAdrian Ambrożewicz sensorsAsyncResp->chassisSubNode == 609a0ec28b6SAdrian Ambrożewicz sensors::node::thermal 61049c53ac9SJohnathan Mantey ? "Temperatures" 611a0ec28b6SAdrian Ambrożewicz : sensorsAsyncResp->chassisSubNode == 612a0ec28b6SAdrian Ambrożewicz sensors::node::power 61395a3ecadSAnthony Wilson ? "Voltages" 61495a3ecadSAnthony Wilson : "Sensors"); 61549c53ac9SJohnathan Mantey return; 61649c53ac9SJohnathan Mantey } 61749c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> 61849c53ac9SJohnathan Mantey culledSensorList = std::make_shared< 61949c53ac9SJohnathan Mantey boost::container::flat_set<std::string>>(); 62049c53ac9SJohnathan Mantey reduceSensorList(sensorsAsyncResp, nodeSensorList, 62149c53ac9SJohnathan Mantey culledSensorList); 62249c53ac9SJohnathan Mantey callback(culledSensorList); 62349c53ac9SJohnathan Mantey }, 62449c53ac9SJohnathan Mantey "xyz.openbmc_project.ObjectMapper", sensorPath, 62549c53ac9SJohnathan Mantey "org.freedesktop.DBus.Properties", "Get", 62649c53ac9SJohnathan Mantey "xyz.openbmc_project.Association", "endpoints"); 62749c53ac9SJohnathan Mantey }; 62849c53ac9SJohnathan Mantey 62949c53ac9SJohnathan Mantey // Get the Chassis Collection 63049c53ac9SJohnathan Mantey crow::connections::systemBus->async_method_call( 63149c53ac9SJohnathan Mantey respHandler, "xyz.openbmc_project.ObjectMapper", 63249c53ac9SJohnathan Mantey "/xyz/openbmc_project/object_mapper", 63349c53ac9SJohnathan Mantey "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 634271584abSEd Tanous "/xyz/openbmc_project/inventory", 0, interfaces); 63555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis exit"; 63608777fb0SLewanczyk, Dawid } 63708777fb0SLewanczyk, Dawid 63808777fb0SLewanczyk, Dawid /** 639de629b6eSShawn McCarney * @brief Finds all DBus object paths that implement ObjectManager. 640de629b6eSShawn McCarney * 641de629b6eSShawn McCarney * Creates a mapping from the associated connection name to the object path. 642de629b6eSShawn McCarney * 643de629b6eSShawn McCarney * Finds the object paths asynchronously. Invokes callback when information has 644de629b6eSShawn McCarney * been obtained. 645de629b6eSShawn McCarney * 646de629b6eSShawn McCarney * The callback must have the following signature: 647de629b6eSShawn McCarney * @code 6488fb49dd6SShawn McCarney * callback(std::shared_ptr<boost::container::flat_map<std::string, 6498fb49dd6SShawn McCarney * std::string>> objectMgrPaths) 650de629b6eSShawn McCarney * @endcode 651de629b6eSShawn McCarney * 65249c53ac9SJohnathan Mantey * @param sensorsAsyncResp Pointer to object holding response data. 653de629b6eSShawn McCarney * @param callback Callback to invoke when object paths obtained. 654de629b6eSShawn McCarney */ 655de629b6eSShawn McCarney template <typename Callback> 656b5a76932SEd Tanous void getObjectManagerPaths( 65781ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 658de629b6eSShawn McCarney Callback&& callback) 659de629b6eSShawn McCarney { 660de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths enter"; 661de629b6eSShawn McCarney const std::array<std::string, 1> interfaces = { 662de629b6eSShawn McCarney "org.freedesktop.DBus.ObjectManager"}; 663de629b6eSShawn McCarney 664de629b6eSShawn McCarney // Response handler for GetSubTree DBus method 665de629b6eSShawn McCarney auto respHandler = [callback{std::move(callback)}, 66681ce609eSEd Tanous sensorsAsyncResp](const boost::system::error_code ec, 667de629b6eSShawn McCarney const GetSubTreeType& subtree) { 668de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler enter"; 669de629b6eSShawn McCarney if (ec) 670de629b6eSShawn McCarney { 6718d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 672de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "getObjectManagerPaths respHandler: DBus error " 673de629b6eSShawn McCarney << ec; 674de629b6eSShawn McCarney return; 675de629b6eSShawn McCarney } 676de629b6eSShawn McCarney 677de629b6eSShawn McCarney // Loop over returned object paths 6788fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 6798fb49dd6SShawn McCarney objectMgrPaths = std::make_shared< 6808fb49dd6SShawn McCarney boost::container::flat_map<std::string, std::string>>(); 681de629b6eSShawn McCarney for (const std::pair< 682de629b6eSShawn McCarney std::string, 683de629b6eSShawn McCarney std::vector<std::pair<std::string, std::vector<std::string>>>>& 684de629b6eSShawn McCarney object : subtree) 685de629b6eSShawn McCarney { 686de629b6eSShawn McCarney // Loop over connections for current object path 687de629b6eSShawn McCarney const std::string& objectPath = object.first; 688de629b6eSShawn McCarney for (const std::pair<std::string, std::vector<std::string>>& 689de629b6eSShawn McCarney objData : object.second) 690de629b6eSShawn McCarney { 691de629b6eSShawn McCarney // Add mapping from connection to object path 692de629b6eSShawn McCarney const std::string& connection = objData.first; 6938fb49dd6SShawn McCarney (*objectMgrPaths)[connection] = objectPath; 694de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "Added mapping " << connection << " -> " 695de629b6eSShawn McCarney << objectPath; 696de629b6eSShawn McCarney } 697de629b6eSShawn McCarney } 6988fb49dd6SShawn McCarney callback(objectMgrPaths); 699de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler exit"; 700de629b6eSShawn McCarney }; 701de629b6eSShawn McCarney 702de629b6eSShawn McCarney // Query mapper for all DBus object paths that implement ObjectManager 703de629b6eSShawn McCarney crow::connections::systemBus->async_method_call( 704de629b6eSShawn McCarney std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 705de629b6eSShawn McCarney "/xyz/openbmc_project/object_mapper", 706271584abSEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", 0, interfaces); 707de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths exit"; 708de629b6eSShawn McCarney } 709de629b6eSShawn McCarney 710de629b6eSShawn McCarney /** 711adc4f0dbSShawn McCarney * @brief Returns the Redfish State value for the specified inventory item. 712adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with a sensor. 713adc4f0dbSShawn McCarney * @return State value for inventory item. 71434dd179eSJames Feist */ 71523a21a1cSEd Tanous inline std::string getState(const InventoryItem* inventoryItem) 716adc4f0dbSShawn McCarney { 717adc4f0dbSShawn McCarney if ((inventoryItem != nullptr) && !(inventoryItem->isPresent)) 718adc4f0dbSShawn McCarney { 719adc4f0dbSShawn McCarney return "Absent"; 720adc4f0dbSShawn McCarney } 72134dd179eSJames Feist 722adc4f0dbSShawn McCarney return "Enabled"; 723adc4f0dbSShawn McCarney } 724adc4f0dbSShawn McCarney 725adc4f0dbSShawn McCarney /** 726adc4f0dbSShawn McCarney * @brief Returns the Redfish Health value for the specified sensor. 727adc4f0dbSShawn McCarney * @param sensorJson Sensor JSON object. 728adc4f0dbSShawn McCarney * @param interfacesDict Map of all sensor interfaces. 729adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with the sensor. Will 730adc4f0dbSShawn McCarney * be nullptr if no associated inventory item was found. 731adc4f0dbSShawn McCarney * @return Health value for sensor. 732adc4f0dbSShawn McCarney */ 73323a21a1cSEd Tanous inline std::string getHealth( 734adc4f0dbSShawn McCarney nlohmann::json& sensorJson, 73534dd179eSJames Feist const boost::container::flat_map< 73634dd179eSJames Feist std::string, boost::container::flat_map<std::string, SensorVariant>>& 737adc4f0dbSShawn McCarney interfacesDict, 738adc4f0dbSShawn McCarney const InventoryItem* inventoryItem) 73934dd179eSJames Feist { 740adc4f0dbSShawn McCarney // Get current health value (if any) in the sensor JSON object. Some JSON 741adc4f0dbSShawn McCarney // objects contain multiple sensors (such as PowerSupplies). We want to set 742adc4f0dbSShawn McCarney // the overall health to be the most severe of any of the sensors. 743adc4f0dbSShawn McCarney std::string currentHealth; 744adc4f0dbSShawn McCarney auto statusIt = sensorJson.find("Status"); 745adc4f0dbSShawn McCarney if (statusIt != sensorJson.end()) 746adc4f0dbSShawn McCarney { 747adc4f0dbSShawn McCarney auto healthIt = statusIt->find("Health"); 748adc4f0dbSShawn McCarney if (healthIt != statusIt->end()) 749adc4f0dbSShawn McCarney { 750adc4f0dbSShawn McCarney std::string* health = healthIt->get_ptr<std::string*>(); 751adc4f0dbSShawn McCarney if (health != nullptr) 752adc4f0dbSShawn McCarney { 753adc4f0dbSShawn McCarney currentHealth = *health; 754adc4f0dbSShawn McCarney } 755adc4f0dbSShawn McCarney } 756adc4f0dbSShawn McCarney } 757adc4f0dbSShawn McCarney 758adc4f0dbSShawn McCarney // If current health in JSON object is already Critical, return that. This 759adc4f0dbSShawn McCarney // should override the sensor health, which might be less severe. 760adc4f0dbSShawn McCarney if (currentHealth == "Critical") 761adc4f0dbSShawn McCarney { 762adc4f0dbSShawn McCarney return "Critical"; 763adc4f0dbSShawn McCarney } 764adc4f0dbSShawn McCarney 765adc4f0dbSShawn McCarney // Check if sensor has critical threshold alarm 76634dd179eSJames Feist auto criticalThresholdIt = 76734dd179eSJames Feist interfacesDict.find("xyz.openbmc_project.Sensor.Threshold.Critical"); 76834dd179eSJames Feist if (criticalThresholdIt != interfacesDict.end()) 76934dd179eSJames Feist { 77034dd179eSJames Feist auto thresholdHighIt = 77134dd179eSJames Feist criticalThresholdIt->second.find("CriticalAlarmHigh"); 77234dd179eSJames Feist auto thresholdLowIt = 77334dd179eSJames Feist criticalThresholdIt->second.find("CriticalAlarmLow"); 77434dd179eSJames Feist if (thresholdHighIt != criticalThresholdIt->second.end()) 77534dd179eSJames Feist { 77634dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdHighIt->second); 77734dd179eSJames Feist if (asserted == nullptr) 77834dd179eSJames Feist { 77934dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 78034dd179eSJames Feist } 78134dd179eSJames Feist else if (*asserted) 78234dd179eSJames Feist { 78334dd179eSJames Feist return "Critical"; 78434dd179eSJames Feist } 78534dd179eSJames Feist } 78634dd179eSJames Feist if (thresholdLowIt != criticalThresholdIt->second.end()) 78734dd179eSJames Feist { 78834dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdLowIt->second); 78934dd179eSJames Feist if (asserted == nullptr) 79034dd179eSJames Feist { 79134dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 79234dd179eSJames Feist } 79334dd179eSJames Feist else if (*asserted) 79434dd179eSJames Feist { 79534dd179eSJames Feist return "Critical"; 79634dd179eSJames Feist } 79734dd179eSJames Feist } 79834dd179eSJames Feist } 79934dd179eSJames Feist 800adc4f0dbSShawn McCarney // Check if associated inventory item is not functional 801adc4f0dbSShawn McCarney if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional)) 802adc4f0dbSShawn McCarney { 803adc4f0dbSShawn McCarney return "Critical"; 804adc4f0dbSShawn McCarney } 805adc4f0dbSShawn McCarney 806adc4f0dbSShawn McCarney // If current health in JSON object is already Warning, return that. This 807adc4f0dbSShawn McCarney // should override the sensor status, which might be less severe. 808adc4f0dbSShawn McCarney if (currentHealth == "Warning") 809adc4f0dbSShawn McCarney { 810adc4f0dbSShawn McCarney return "Warning"; 811adc4f0dbSShawn McCarney } 812adc4f0dbSShawn McCarney 813adc4f0dbSShawn McCarney // Check if sensor has warning threshold alarm 81434dd179eSJames Feist auto warningThresholdIt = 81534dd179eSJames Feist interfacesDict.find("xyz.openbmc_project.Sensor.Threshold.Warning"); 81634dd179eSJames Feist if (warningThresholdIt != interfacesDict.end()) 81734dd179eSJames Feist { 81834dd179eSJames Feist auto thresholdHighIt = 81934dd179eSJames Feist warningThresholdIt->second.find("WarningAlarmHigh"); 82034dd179eSJames Feist auto thresholdLowIt = 82134dd179eSJames Feist warningThresholdIt->second.find("WarningAlarmLow"); 82234dd179eSJames Feist if (thresholdHighIt != warningThresholdIt->second.end()) 82334dd179eSJames Feist { 82434dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdHighIt->second); 82534dd179eSJames Feist if (asserted == nullptr) 82634dd179eSJames Feist { 82734dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 82834dd179eSJames Feist } 82934dd179eSJames Feist else if (*asserted) 83034dd179eSJames Feist { 83134dd179eSJames Feist return "Warning"; 83234dd179eSJames Feist } 83334dd179eSJames Feist } 83434dd179eSJames Feist if (thresholdLowIt != warningThresholdIt->second.end()) 83534dd179eSJames Feist { 83634dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdLowIt->second); 83734dd179eSJames Feist if (asserted == nullptr) 83834dd179eSJames Feist { 83934dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 84034dd179eSJames Feist } 84134dd179eSJames Feist else if (*asserted) 84234dd179eSJames Feist { 84334dd179eSJames Feist return "Warning"; 84434dd179eSJames Feist } 84534dd179eSJames Feist } 84634dd179eSJames Feist } 847adc4f0dbSShawn McCarney 84834dd179eSJames Feist return "OK"; 84934dd179eSJames Feist } 85034dd179eSJames Feist 85123a21a1cSEd Tanous inline void setLedState(nlohmann::json& sensorJson, 852d500549bSAnthony Wilson const InventoryItem* inventoryItem) 853d500549bSAnthony Wilson { 854d500549bSAnthony Wilson if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty()) 855d500549bSAnthony Wilson { 856d500549bSAnthony Wilson switch (inventoryItem->ledState) 857d500549bSAnthony Wilson { 858d500549bSAnthony Wilson case LedState::OFF: 859d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Off"; 860d500549bSAnthony Wilson break; 861d500549bSAnthony Wilson case LedState::ON: 862d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Lit"; 863d500549bSAnthony Wilson break; 864d500549bSAnthony Wilson case LedState::BLINK: 865d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Blinking"; 866d500549bSAnthony Wilson break; 86723a21a1cSEd Tanous case LedState::UNKNOWN: 868d500549bSAnthony Wilson break; 869d500549bSAnthony Wilson } 870d500549bSAnthony Wilson } 871d500549bSAnthony Wilson } 872d500549bSAnthony Wilson 87334dd179eSJames Feist /** 87408777fb0SLewanczyk, Dawid * @brief Builds a json sensor representation of a sensor. 87508777fb0SLewanczyk, Dawid * @param sensorName The name of the sensor to be built 876274fad5aSGunnar Mills * @param sensorType The type (temperature, fan_tach, etc) of the sensor to 87708777fb0SLewanczyk, Dawid * build 878a0ec28b6SAdrian Ambrożewicz * @param sensorsAsyncResp Sensor metadata 87908777fb0SLewanczyk, Dawid * @param interfacesDict A dictionary of the interfaces and properties of said 88008777fb0SLewanczyk, Dawid * interfaces to be built from 88108777fb0SLewanczyk, Dawid * @param sensor_json The json object to fill 882adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with the sensor. Will 883adc4f0dbSShawn McCarney * be nullptr if no associated inventory item was found. 88408777fb0SLewanczyk, Dawid */ 88523a21a1cSEd Tanous inline void objectInterfacesToJson( 88608777fb0SLewanczyk, Dawid const std::string& sensorName, const std::string& sensorType, 887b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 88808777fb0SLewanczyk, Dawid const boost::container::flat_map< 889aa2e59c1SEd Tanous std::string, boost::container::flat_map<std::string, SensorVariant>>& 89008777fb0SLewanczyk, Dawid interfacesDict, 89181ce609eSEd Tanous nlohmann::json& sensorJson, InventoryItem* inventoryItem) 8921abe55efSEd Tanous { 89308777fb0SLewanczyk, Dawid // We need a value interface before we can do anything with it 89455c7b7a2SEd Tanous auto valueIt = interfacesDict.find("xyz.openbmc_project.Sensor.Value"); 8951abe55efSEd Tanous if (valueIt == interfacesDict.end()) 8961abe55efSEd Tanous { 89755c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "Sensor doesn't have a value interface"; 89808777fb0SLewanczyk, Dawid return; 89908777fb0SLewanczyk, Dawid } 90008777fb0SLewanczyk, Dawid 90108777fb0SLewanczyk, Dawid // Assume values exist as is (10^0 == 1) if no scale exists 90208777fb0SLewanczyk, Dawid int64_t scaleMultiplier = 0; 90308777fb0SLewanczyk, Dawid 90455c7b7a2SEd Tanous auto scaleIt = valueIt->second.find("Scale"); 90508777fb0SLewanczyk, Dawid // If a scale exists, pull value as int64, and use the scaling. 9061abe55efSEd Tanous if (scaleIt != valueIt->second.end()) 9071abe55efSEd Tanous { 908abf2add6SEd Tanous const int64_t* int64Value = std::get_if<int64_t>(&scaleIt->second); 9091abe55efSEd Tanous if (int64Value != nullptr) 9101abe55efSEd Tanous { 91108777fb0SLewanczyk, Dawid scaleMultiplier = *int64Value; 91208777fb0SLewanczyk, Dawid } 91308777fb0SLewanczyk, Dawid } 91408777fb0SLewanczyk, Dawid 915a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 916adc4f0dbSShawn McCarney { 91795a3ecadSAnthony Wilson // For sensors in SensorCollection we set Id instead of MemberId, 91895a3ecadSAnthony Wilson // including power sensors. 91981ce609eSEd Tanous sensorJson["Id"] = sensorName; 92081ce609eSEd Tanous sensorJson["Name"] = boost::replace_all_copy(sensorName, "_", " "); 92195a3ecadSAnthony Wilson } 92295a3ecadSAnthony Wilson else if (sensorType != "power") 92395a3ecadSAnthony Wilson { 92495a3ecadSAnthony Wilson // Set MemberId and Name for non-power sensors. For PowerSupplies and 92595a3ecadSAnthony Wilson // PowerControl, those properties have more general values because 92695a3ecadSAnthony Wilson // multiple sensors can be stored in the same JSON object. 92781ce609eSEd Tanous sensorJson["MemberId"] = sensorName; 92881ce609eSEd Tanous sensorJson["Name"] = boost::replace_all_copy(sensorName, "_", " "); 929adc4f0dbSShawn McCarney } 930e742b6ccSEd Tanous 93181ce609eSEd Tanous sensorJson["Status"]["State"] = getState(inventoryItem); 93281ce609eSEd Tanous sensorJson["Status"]["Health"] = 93381ce609eSEd Tanous getHealth(sensorJson, interfacesDict, inventoryItem); 93408777fb0SLewanczyk, Dawid 93508777fb0SLewanczyk, Dawid // Parameter to set to override the type we get from dbus, and force it to 93608777fb0SLewanczyk, Dawid // int, regardless of what is available. This is used for schemas like fan, 93708777fb0SLewanczyk, Dawid // that require integers, not floats. 93808777fb0SLewanczyk, Dawid bool forceToInt = false; 93908777fb0SLewanczyk, Dawid 9403929aca1SAnthony Wilson nlohmann::json::json_pointer unit("/Reading"); 941a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 94295a3ecadSAnthony Wilson { 94381ce609eSEd Tanous sensorJson["@odata.type"] = "#Sensor.v1_0_0.Sensor"; 944c2bf7f99SWludzik, Jozef 945c2bf7f99SWludzik, Jozef const std::string& readingType = sensors::toReadingType(sensorType); 946c2bf7f99SWludzik, Jozef if (readingType.empty()) 94795a3ecadSAnthony Wilson { 948c2bf7f99SWludzik, Jozef BMCWEB_LOG_ERROR << "Redfish cannot map reading type for " 949c2bf7f99SWludzik, Jozef << sensorType; 95095a3ecadSAnthony Wilson } 951c2bf7f99SWludzik, Jozef else 95295a3ecadSAnthony Wilson { 953c2bf7f99SWludzik, Jozef sensorJson["ReadingType"] = readingType; 95495a3ecadSAnthony Wilson } 955c2bf7f99SWludzik, Jozef 956c2bf7f99SWludzik, Jozef const std::string& readingUnits = sensors::toReadingUnits(sensorType); 957c2bf7f99SWludzik, Jozef if (readingUnits.empty()) 958f8ede15eSAdrian Ambrożewicz { 959c2bf7f99SWludzik, Jozef BMCWEB_LOG_ERROR << "Redfish cannot map reading unit for " 960c2bf7f99SWludzik, Jozef << sensorType; 961c2bf7f99SWludzik, Jozef } 962c2bf7f99SWludzik, Jozef else 963c2bf7f99SWludzik, Jozef { 964c2bf7f99SWludzik, Jozef sensorJson["ReadingUnits"] = readingUnits; 965f8ede15eSAdrian Ambrożewicz } 96695a3ecadSAnthony Wilson } 96795a3ecadSAnthony Wilson else if (sensorType == "temperature") 9681abe55efSEd Tanous { 9693929aca1SAnthony Wilson unit = "/ReadingCelsius"_json_pointer; 97081ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature"; 97108777fb0SLewanczyk, Dawid // TODO(ed) Documentation says that path should be type fan_tach, 97208777fb0SLewanczyk, Dawid // implementation seems to implement fan 9731abe55efSEd Tanous } 9741abe55efSEd Tanous else if (sensorType == "fan" || sensorType == "fan_tach") 9751abe55efSEd Tanous { 9763929aca1SAnthony Wilson unit = "/Reading"_json_pointer; 97781ce609eSEd Tanous sensorJson["ReadingUnits"] = "RPM"; 97881ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan"; 97981ce609eSEd Tanous setLedState(sensorJson, inventoryItem); 98008777fb0SLewanczyk, Dawid forceToInt = true; 9811abe55efSEd Tanous } 9826f6d0d32SEd Tanous else if (sensorType == "fan_pwm") 9836f6d0d32SEd Tanous { 9843929aca1SAnthony Wilson unit = "/Reading"_json_pointer; 98581ce609eSEd Tanous sensorJson["ReadingUnits"] = "Percent"; 98681ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan"; 98781ce609eSEd Tanous setLedState(sensorJson, inventoryItem); 9886f6d0d32SEd Tanous forceToInt = true; 9896f6d0d32SEd Tanous } 9901abe55efSEd Tanous else if (sensorType == "voltage") 9911abe55efSEd Tanous { 9923929aca1SAnthony Wilson unit = "/ReadingVolts"_json_pointer; 99381ce609eSEd Tanous sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage"; 9941abe55efSEd Tanous } 9952474adfaSEd Tanous else if (sensorType == "power") 9962474adfaSEd Tanous { 99749c53ac9SJohnathan Mantey std::string sensorNameLower = 99849c53ac9SJohnathan Mantey boost::algorithm::to_lower_copy(sensorName); 99949c53ac9SJohnathan Mantey 1000028f7ebcSEddie James if (!sensorName.compare("total_power")) 1001028f7ebcSEddie James { 100281ce609eSEd Tanous sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl"; 10037ab06f49SGunnar Mills // Put multiple "sensors" into a single PowerControl, so have 10047ab06f49SGunnar Mills // generic names for MemberId and Name. Follows Redfish mockup. 100581ce609eSEd Tanous sensorJson["MemberId"] = "0"; 100681ce609eSEd Tanous sensorJson["Name"] = "Chassis Power Control"; 10073929aca1SAnthony Wilson unit = "/PowerConsumedWatts"_json_pointer; 1008028f7ebcSEddie James } 1009028f7ebcSEddie James else if (sensorNameLower.find("input") != std::string::npos) 101049c53ac9SJohnathan Mantey { 10113929aca1SAnthony Wilson unit = "/PowerInputWatts"_json_pointer; 101249c53ac9SJohnathan Mantey } 101349c53ac9SJohnathan Mantey else 101449c53ac9SJohnathan Mantey { 10153929aca1SAnthony Wilson unit = "/PowerOutputWatts"_json_pointer; 101649c53ac9SJohnathan Mantey } 10172474adfaSEd Tanous } 10181abe55efSEd Tanous else 10191abe55efSEd Tanous { 102055c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "Redfish cannot map object type for " << sensorName; 102108777fb0SLewanczyk, Dawid return; 102208777fb0SLewanczyk, Dawid } 102308777fb0SLewanczyk, Dawid // Map of dbus interface name, dbus property name and redfish property_name 10243929aca1SAnthony Wilson std::vector< 10253929aca1SAnthony Wilson std::tuple<const char*, const char*, nlohmann::json::json_pointer>> 10263929aca1SAnthony Wilson properties; 102708777fb0SLewanczyk, Dawid properties.reserve(7); 102808777fb0SLewanczyk, Dawid 102908777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit); 1030de629b6eSShawn McCarney 1031a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 10323929aca1SAnthony Wilson { 10333929aca1SAnthony Wilson properties.emplace_back( 10343929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh", 10353929aca1SAnthony Wilson "/Thresholds/UpperCaution/Reading"_json_pointer); 10363929aca1SAnthony Wilson properties.emplace_back( 10373929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow", 10383929aca1SAnthony Wilson "/Thresholds/LowerCaution/Reading"_json_pointer); 10393929aca1SAnthony Wilson properties.emplace_back( 10403929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh", 10413929aca1SAnthony Wilson "/Thresholds/UpperCritical/Reading"_json_pointer); 10423929aca1SAnthony Wilson properties.emplace_back( 10433929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow", 10443929aca1SAnthony Wilson "/Thresholds/LowerCritical/Reading"_json_pointer); 10453929aca1SAnthony Wilson } 10463929aca1SAnthony Wilson else if (sensorType != "power") 1047de629b6eSShawn McCarney { 104808777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning", 10493929aca1SAnthony Wilson "WarningHigh", 10503929aca1SAnthony Wilson "/UpperThresholdNonCritical"_json_pointer); 105108777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning", 10523929aca1SAnthony Wilson "WarningLow", 10533929aca1SAnthony Wilson "/LowerThresholdNonCritical"_json_pointer); 105408777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical", 10553929aca1SAnthony Wilson "CriticalHigh", 10563929aca1SAnthony Wilson "/UpperThresholdCritical"_json_pointer); 105708777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical", 10583929aca1SAnthony Wilson "CriticalLow", 10593929aca1SAnthony Wilson "/LowerThresholdCritical"_json_pointer); 1060de629b6eSShawn McCarney } 106108777fb0SLewanczyk, Dawid 10622474adfaSEd Tanous // TODO Need to get UpperThresholdFatal and LowerThresholdFatal 10632474adfaSEd Tanous 1064a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 106595a3ecadSAnthony Wilson { 106695a3ecadSAnthony Wilson properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10673929aca1SAnthony Wilson "/ReadingRangeMin"_json_pointer); 106895a3ecadSAnthony Wilson properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10693929aca1SAnthony Wilson "/ReadingRangeMax"_json_pointer); 107095a3ecadSAnthony Wilson } 107195a3ecadSAnthony Wilson else if (sensorType == "temperature") 10721abe55efSEd Tanous { 107308777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10743929aca1SAnthony Wilson "/MinReadingRangeTemp"_json_pointer); 107508777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10763929aca1SAnthony Wilson "/MaxReadingRangeTemp"_json_pointer); 10771abe55efSEd Tanous } 1078adc4f0dbSShawn McCarney else if (sensorType != "power") 10791abe55efSEd Tanous { 108008777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10813929aca1SAnthony Wilson "/MinReadingRange"_json_pointer); 108208777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10833929aca1SAnthony Wilson "/MaxReadingRange"_json_pointer); 108408777fb0SLewanczyk, Dawid } 108508777fb0SLewanczyk, Dawid 10863929aca1SAnthony Wilson for (const std::tuple<const char*, const char*, 10873929aca1SAnthony Wilson nlohmann::json::json_pointer>& p : properties) 10881abe55efSEd Tanous { 108908777fb0SLewanczyk, Dawid auto interfaceProperties = interfacesDict.find(std::get<0>(p)); 10901abe55efSEd Tanous if (interfaceProperties != interfacesDict.end()) 10911abe55efSEd Tanous { 1092271584abSEd Tanous auto thisValueIt = interfaceProperties->second.find(std::get<1>(p)); 1093271584abSEd Tanous if (thisValueIt != interfaceProperties->second.end()) 10941abe55efSEd Tanous { 1095271584abSEd Tanous const SensorVariant& valueVariant = thisValueIt->second; 10963929aca1SAnthony Wilson 10973929aca1SAnthony Wilson // The property we want to set may be nested json, so use 10983929aca1SAnthony Wilson // a json_pointer for easy indexing into the json structure. 10993929aca1SAnthony Wilson const nlohmann::json::json_pointer& key = std::get<2>(p); 11003929aca1SAnthony Wilson 110108777fb0SLewanczyk, Dawid // Attempt to pull the int64 directly 1102abf2add6SEd Tanous const int64_t* int64Value = std::get_if<int64_t>(&valueVariant); 110308777fb0SLewanczyk, Dawid 1104abf2add6SEd Tanous const double* doubleValue = std::get_if<double>(&valueVariant); 1105028f7ebcSEddie James const uint32_t* uValue = std::get_if<uint32_t>(&valueVariant); 11066f6d0d32SEd Tanous double temp = 0.0; 11076f6d0d32SEd Tanous if (int64Value != nullptr) 11081abe55efSEd Tanous { 1109271584abSEd Tanous temp = static_cast<double>(*int64Value); 11106f6d0d32SEd Tanous } 11116f6d0d32SEd Tanous else if (doubleValue != nullptr) 11121abe55efSEd Tanous { 11136f6d0d32SEd Tanous temp = *doubleValue; 11141abe55efSEd Tanous } 1115028f7ebcSEddie James else if (uValue != nullptr) 1116028f7ebcSEddie James { 1117028f7ebcSEddie James temp = *uValue; 1118028f7ebcSEddie James } 11191abe55efSEd Tanous else 11201abe55efSEd Tanous { 11216f6d0d32SEd Tanous BMCWEB_LOG_ERROR 11226f6d0d32SEd Tanous << "Got value interface that wasn't int or double"; 11236f6d0d32SEd Tanous continue; 112408777fb0SLewanczyk, Dawid } 11256f6d0d32SEd Tanous temp = temp * std::pow(10, scaleMultiplier); 11266f6d0d32SEd Tanous if (forceToInt) 11276f6d0d32SEd Tanous { 112881ce609eSEd Tanous sensorJson[key] = static_cast<int64_t>(temp); 11296f6d0d32SEd Tanous } 11306f6d0d32SEd Tanous else 11316f6d0d32SEd Tanous { 113281ce609eSEd Tanous sensorJson[key] = temp; 113308777fb0SLewanczyk, Dawid } 113408777fb0SLewanczyk, Dawid } 113508777fb0SLewanczyk, Dawid } 113608777fb0SLewanczyk, Dawid } 1137a0ec28b6SAdrian Ambrożewicz 113881ce609eSEd Tanous sensorsAsyncResp->addMetadata(sensorJson, unit.to_string(), 1139a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/" + sensorType + 1140a0ec28b6SAdrian Ambrożewicz "/" + sensorName); 1141a0ec28b6SAdrian Ambrożewicz 114255c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Added sensor " << sensorName; 114308777fb0SLewanczyk, Dawid } 114408777fb0SLewanczyk, Dawid 1145b5a76932SEd Tanous inline void populateFanRedundancy( 1146b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 11478bd25ccdSJames Feist { 11488bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 11498bd25ccdSJames Feist [sensorsAsyncResp](const boost::system::error_code ec, 11508bd25ccdSJames Feist const GetSubTreeType& resp) { 11518bd25ccdSJames Feist if (ec) 11528bd25ccdSJames Feist { 11538bd25ccdSJames Feist return; // don't have to have this interface 11548bd25ccdSJames Feist } 1155e278c18fSEd Tanous for (const std::pair<std::string, 1156e278c18fSEd Tanous std::vector<std::pair< 1157e278c18fSEd Tanous std::string, std::vector<std::string>>>>& 1158e278c18fSEd Tanous pathPair : resp) 11598bd25ccdSJames Feist { 1160e278c18fSEd Tanous const std::string& path = pathPair.first; 1161e278c18fSEd Tanous const std::vector< 1162e278c18fSEd Tanous std::pair<std::string, std::vector<std::string>>>& objDict = 1163e278c18fSEd Tanous pathPair.second; 11648bd25ccdSJames Feist if (objDict.empty()) 11658bd25ccdSJames Feist { 11668bd25ccdSJames Feist continue; // this should be impossible 11678bd25ccdSJames Feist } 11688bd25ccdSJames Feist 11698bd25ccdSJames Feist const std::string& owner = objDict.begin()->first; 11708bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 11718bd25ccdSJames Feist [path, owner, 1172271584abSEd Tanous sensorsAsyncResp](const boost::system::error_code e, 11738bd25ccdSJames Feist std::variant<std::vector<std::string>> 11748bd25ccdSJames Feist variantEndpoints) { 1175271584abSEd Tanous if (e) 11768bd25ccdSJames Feist { 11778bd25ccdSJames Feist return; // if they don't have an association we 11788bd25ccdSJames Feist // can't tell what chassis is 11798bd25ccdSJames Feist } 11808bd25ccdSJames Feist // verify part of the right chassis 11818bd25ccdSJames Feist auto endpoints = std::get_if<std::vector<std::string>>( 11828bd25ccdSJames Feist &variantEndpoints); 11838bd25ccdSJames Feist 11848bd25ccdSJames Feist if (endpoints == nullptr) 11858bd25ccdSJames Feist { 11868bd25ccdSJames Feist BMCWEB_LOG_ERROR << "Invalid association interface"; 11878d1b46d7Szhanghch05 messages::internalError( 11888d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 11898bd25ccdSJames Feist return; 11908bd25ccdSJames Feist } 11918bd25ccdSJames Feist 11928bd25ccdSJames Feist auto found = std::find_if( 11938bd25ccdSJames Feist endpoints->begin(), endpoints->end(), 11948bd25ccdSJames Feist [sensorsAsyncResp](const std::string& entry) { 11958bd25ccdSJames Feist return entry.find( 11968bd25ccdSJames Feist sensorsAsyncResp->chassisId) != 11978bd25ccdSJames Feist std::string::npos; 11988bd25ccdSJames Feist }); 11998bd25ccdSJames Feist 12008bd25ccdSJames Feist if (found == endpoints->end()) 12018bd25ccdSJames Feist { 12028bd25ccdSJames Feist return; 12038bd25ccdSJames Feist } 12048bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 12058bd25ccdSJames Feist [path, sensorsAsyncResp]( 1206271584abSEd Tanous const boost::system::error_code& err, 12078bd25ccdSJames Feist const boost::container::flat_map< 12088bd25ccdSJames Feist std::string, 12098bd25ccdSJames Feist std::variant<uint8_t, 12108bd25ccdSJames Feist std::vector<std::string>, 12118bd25ccdSJames Feist std::string>>& ret) { 1212271584abSEd Tanous if (err) 12138bd25ccdSJames Feist { 12148bd25ccdSJames Feist return; // don't have to have this 12158bd25ccdSJames Feist // interface 12168bd25ccdSJames Feist } 12178bd25ccdSJames Feist auto findFailures = ret.find("AllowedFailures"); 12188bd25ccdSJames Feist auto findCollection = ret.find("Collection"); 12198bd25ccdSJames Feist auto findStatus = ret.find("Status"); 12208bd25ccdSJames Feist 12218bd25ccdSJames Feist if (findFailures == ret.end() || 12228bd25ccdSJames Feist findCollection == ret.end() || 12238bd25ccdSJames Feist findStatus == ret.end()) 12248bd25ccdSJames Feist { 12258bd25ccdSJames Feist BMCWEB_LOG_ERROR 12268bd25ccdSJames Feist << "Invalid redundancy interface"; 12278bd25ccdSJames Feist messages::internalError( 12288d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12298bd25ccdSJames Feist return; 12308bd25ccdSJames Feist } 12318bd25ccdSJames Feist 12328bd25ccdSJames Feist auto allowedFailures = std::get_if<uint8_t>( 12338bd25ccdSJames Feist &(findFailures->second)); 12348bd25ccdSJames Feist auto collection = 12358bd25ccdSJames Feist std::get_if<std::vector<std::string>>( 12368bd25ccdSJames Feist &(findCollection->second)); 12378bd25ccdSJames Feist auto status = std::get_if<std::string>( 12388bd25ccdSJames Feist &(findStatus->second)); 12398bd25ccdSJames Feist 12408bd25ccdSJames Feist if (allowedFailures == nullptr || 12418bd25ccdSJames Feist collection == nullptr || status == nullptr) 12428bd25ccdSJames Feist { 12438bd25ccdSJames Feist 12448bd25ccdSJames Feist BMCWEB_LOG_ERROR 12458bd25ccdSJames Feist << "Invalid redundancy interface " 12468bd25ccdSJames Feist "types"; 12478bd25ccdSJames Feist messages::internalError( 12488d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12498bd25ccdSJames Feist return; 12508bd25ccdSJames Feist } 125128aa8de5SGeorge Liu sdbusplus::message::object_path objectPath( 125228aa8de5SGeorge Liu path); 125328aa8de5SGeorge Liu std::string name = objectPath.filename(); 125428aa8de5SGeorge Liu if (name.empty()) 12558bd25ccdSJames Feist { 12568bd25ccdSJames Feist // this should be impossible 12578bd25ccdSJames Feist messages::internalError( 12588d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12598bd25ccdSJames Feist return; 12608bd25ccdSJames Feist } 12618bd25ccdSJames Feist std::replace(name.begin(), name.end(), '_', 12628bd25ccdSJames Feist ' '); 12638bd25ccdSJames Feist 12648bd25ccdSJames Feist std::string health; 12658bd25ccdSJames Feist 12668bd25ccdSJames Feist if (boost::ends_with(*status, "Full")) 12678bd25ccdSJames Feist { 12688bd25ccdSJames Feist health = "OK"; 12698bd25ccdSJames Feist } 12708bd25ccdSJames Feist else if (boost::ends_with(*status, "Degraded")) 12718bd25ccdSJames Feist { 12728bd25ccdSJames Feist health = "Warning"; 12738bd25ccdSJames Feist } 12748bd25ccdSJames Feist else 12758bd25ccdSJames Feist { 12768bd25ccdSJames Feist health = "Critical"; 12778bd25ccdSJames Feist } 12788bd25ccdSJames Feist std::vector<nlohmann::json> redfishCollection; 12798bd25ccdSJames Feist const auto& fanRedfish = 12808d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res 12818d1b46d7Szhanghch05 .jsonValue["Fans"]; 12828bd25ccdSJames Feist for (const std::string& item : *collection) 12838bd25ccdSJames Feist { 128428aa8de5SGeorge Liu sdbusplus::message::object_path path(item); 128528aa8de5SGeorge Liu std::string itemName = path.filename(); 128628aa8de5SGeorge Liu if (itemName.empty()) 128728aa8de5SGeorge Liu { 128828aa8de5SGeorge Liu continue; 128928aa8de5SGeorge Liu } 12908bd25ccdSJames Feist /* 12918bd25ccdSJames Feist todo(ed): merge patch that fixes the names 12928bd25ccdSJames Feist std::replace(itemName.begin(), 12938bd25ccdSJames Feist itemName.end(), '_', ' ');*/ 12948bd25ccdSJames Feist auto schemaItem = std::find_if( 12958bd25ccdSJames Feist fanRedfish.begin(), fanRedfish.end(), 12968bd25ccdSJames Feist [itemName](const nlohmann::json& fan) { 12978bd25ccdSJames Feist return fan["MemberId"] == itemName; 12988bd25ccdSJames Feist }); 12998bd25ccdSJames Feist if (schemaItem != fanRedfish.end()) 13008bd25ccdSJames Feist { 13018bd25ccdSJames Feist redfishCollection.push_back( 13028bd25ccdSJames Feist {{"@odata.id", 13038bd25ccdSJames Feist (*schemaItem)["@odata.id"]}}); 13048bd25ccdSJames Feist } 13058bd25ccdSJames Feist else 13068bd25ccdSJames Feist { 13078bd25ccdSJames Feist BMCWEB_LOG_ERROR 13088bd25ccdSJames Feist << "failed to find fan in schema"; 13098bd25ccdSJames Feist messages::internalError( 13108d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 13118bd25ccdSJames Feist return; 13128bd25ccdSJames Feist } 13138bd25ccdSJames Feist } 13148bd25ccdSJames Feist 13153e9e72ebSKuiying Wang size_t minNumNeeded = 13163e9e72ebSKuiying Wang collection->size() > 0 13173e9e72ebSKuiying Wang ? collection->size() - *allowedFailures 13183e9e72ebSKuiying Wang : 0; 1319271584abSEd Tanous nlohmann::json& jResp = 13208d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res 13218bd25ccdSJames Feist .jsonValue["Redundancy"]; 1322271584abSEd Tanous jResp.push_back( 13238bd25ccdSJames Feist {{"@odata.id", 1324717794d5SAppaRao Puli "/redfish/v1/Chassis/" + 13258bd25ccdSJames Feist sensorsAsyncResp->chassisId + "/" + 13268bd25ccdSJames Feist sensorsAsyncResp->chassisSubNode + 13278bd25ccdSJames Feist "#/Redundancy/" + 1328271584abSEd Tanous std::to_string(jResp.size())}, 13298bd25ccdSJames Feist {"@odata.type", 13308bd25ccdSJames Feist "#Redundancy.v1_3_2.Redundancy"}, 13313e9e72ebSKuiying Wang {"MinNumNeeded", minNumNeeded}, 13328bd25ccdSJames Feist {"MemberId", name}, 13338bd25ccdSJames Feist {"Mode", "N+m"}, 13348bd25ccdSJames Feist {"Name", name}, 13358bd25ccdSJames Feist {"RedundancySet", redfishCollection}, 13368bd25ccdSJames Feist {"Status", 13378bd25ccdSJames Feist {{"Health", health}, 13388bd25ccdSJames Feist {"State", "Enabled"}}}}); 13398bd25ccdSJames Feist }, 13408bd25ccdSJames Feist owner, path, "org.freedesktop.DBus.Properties", 13418bd25ccdSJames Feist "GetAll", 13428bd25ccdSJames Feist "xyz.openbmc_project.Control.FanRedundancy"); 13438bd25ccdSJames Feist }, 134402e92e32SJames Feist "xyz.openbmc_project.ObjectMapper", path + "/chassis", 13458bd25ccdSJames Feist "org.freedesktop.DBus.Properties", "Get", 13468bd25ccdSJames Feist "xyz.openbmc_project.Association", "endpoints"); 13478bd25ccdSJames Feist } 13488bd25ccdSJames Feist }, 13498bd25ccdSJames Feist "xyz.openbmc_project.ObjectMapper", 13508bd25ccdSJames Feist "/xyz/openbmc_project/object_mapper", 13518bd25ccdSJames Feist "xyz.openbmc_project.ObjectMapper", "GetSubTree", 13528bd25ccdSJames Feist "/xyz/openbmc_project/control", 2, 13538bd25ccdSJames Feist std::array<const char*, 1>{ 13548bd25ccdSJames Feist "xyz.openbmc_project.Control.FanRedundancy"}); 13558bd25ccdSJames Feist } 13568bd25ccdSJames Feist 1357b5a76932SEd Tanous inline void 135881ce609eSEd Tanous sortJSONResponse(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 135949c53ac9SJohnathan Mantey { 13608d1b46d7Szhanghch05 nlohmann::json& response = sensorsAsyncResp->asyncResp->res.jsonValue; 136149c53ac9SJohnathan Mantey std::array<std::string, 2> sensorHeaders{"Temperatures", "Fans"}; 136281ce609eSEd Tanous if (sensorsAsyncResp->chassisSubNode == sensors::node::power) 136349c53ac9SJohnathan Mantey { 136449c53ac9SJohnathan Mantey sensorHeaders = {"Voltages", "PowerSupplies"}; 136549c53ac9SJohnathan Mantey } 136649c53ac9SJohnathan Mantey for (const std::string& sensorGroup : sensorHeaders) 136749c53ac9SJohnathan Mantey { 136849c53ac9SJohnathan Mantey nlohmann::json::iterator entry = response.find(sensorGroup); 136949c53ac9SJohnathan Mantey if (entry != response.end()) 137049c53ac9SJohnathan Mantey { 137149c53ac9SJohnathan Mantey std::sort(entry->begin(), entry->end(), 137249c53ac9SJohnathan Mantey [](nlohmann::json& c1, nlohmann::json& c2) { 137349c53ac9SJohnathan Mantey return c1["Name"] < c2["Name"]; 137449c53ac9SJohnathan Mantey }); 137549c53ac9SJohnathan Mantey 137649c53ac9SJohnathan Mantey // add the index counts to the end of each entry 137749c53ac9SJohnathan Mantey size_t count = 0; 137849c53ac9SJohnathan Mantey for (nlohmann::json& sensorJson : *entry) 137949c53ac9SJohnathan Mantey { 138049c53ac9SJohnathan Mantey nlohmann::json::iterator odata = sensorJson.find("@odata.id"); 138149c53ac9SJohnathan Mantey if (odata == sensorJson.end()) 138249c53ac9SJohnathan Mantey { 138349c53ac9SJohnathan Mantey continue; 138449c53ac9SJohnathan Mantey } 138549c53ac9SJohnathan Mantey std::string* value = odata->get_ptr<std::string*>(); 138649c53ac9SJohnathan Mantey if (value != nullptr) 138749c53ac9SJohnathan Mantey { 138849c53ac9SJohnathan Mantey *value += std::to_string(count); 138949c53ac9SJohnathan Mantey count++; 139081ce609eSEd Tanous sensorsAsyncResp->updateUri(sensorJson["Name"], *value); 139149c53ac9SJohnathan Mantey } 139249c53ac9SJohnathan Mantey } 139349c53ac9SJohnathan Mantey } 139449c53ac9SJohnathan Mantey } 139549c53ac9SJohnathan Mantey } 139649c53ac9SJohnathan Mantey 139708777fb0SLewanczyk, Dawid /** 1398adc4f0dbSShawn McCarney * @brief Finds the inventory item with the specified object path. 1399adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1400adc4f0dbSShawn McCarney * @param invItemObjPath D-Bus object path of inventory item. 1401adc4f0dbSShawn McCarney * @return Inventory item within vector, or nullptr if no match found. 14028fb49dd6SShawn McCarney */ 140323a21a1cSEd Tanous inline InventoryItem* findInventoryItem( 1404b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1405adc4f0dbSShawn McCarney const std::string& invItemObjPath) 14068fb49dd6SShawn McCarney { 1407adc4f0dbSShawn McCarney for (InventoryItem& inventoryItem : *inventoryItems) 14088fb49dd6SShawn McCarney { 1409adc4f0dbSShawn McCarney if (inventoryItem.objectPath == invItemObjPath) 14108fb49dd6SShawn McCarney { 1411adc4f0dbSShawn McCarney return &inventoryItem; 14128fb49dd6SShawn McCarney } 14138fb49dd6SShawn McCarney } 14148fb49dd6SShawn McCarney return nullptr; 14158fb49dd6SShawn McCarney } 14168fb49dd6SShawn McCarney 14178fb49dd6SShawn McCarney /** 1418adc4f0dbSShawn McCarney * @brief Finds the inventory item associated with the specified sensor. 1419adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1420adc4f0dbSShawn McCarney * @param sensorObjPath D-Bus object path of sensor. 1421adc4f0dbSShawn McCarney * @return Inventory item within vector, or nullptr if no match found. 14228fb49dd6SShawn McCarney */ 142323a21a1cSEd Tanous inline InventoryItem* findInventoryItemForSensor( 1424b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1425adc4f0dbSShawn McCarney const std::string& sensorObjPath) 1426adc4f0dbSShawn McCarney { 1427adc4f0dbSShawn McCarney for (InventoryItem& inventoryItem : *inventoryItems) 1428adc4f0dbSShawn McCarney { 1429adc4f0dbSShawn McCarney if (inventoryItem.sensors.count(sensorObjPath) > 0) 1430adc4f0dbSShawn McCarney { 1431adc4f0dbSShawn McCarney return &inventoryItem; 1432adc4f0dbSShawn McCarney } 1433adc4f0dbSShawn McCarney } 1434adc4f0dbSShawn McCarney return nullptr; 1435adc4f0dbSShawn McCarney } 1436adc4f0dbSShawn McCarney 1437adc4f0dbSShawn McCarney /** 1438d500549bSAnthony Wilson * @brief Finds the inventory item associated with the specified led path. 1439d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1440d500549bSAnthony Wilson * @param ledObjPath D-Bus object path of led. 1441d500549bSAnthony Wilson * @return Inventory item within vector, or nullptr if no match found. 1442d500549bSAnthony Wilson */ 1443d500549bSAnthony Wilson inline InventoryItem* 1444d500549bSAnthony Wilson findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems, 1445d500549bSAnthony Wilson const std::string& ledObjPath) 1446d500549bSAnthony Wilson { 1447d500549bSAnthony Wilson for (InventoryItem& inventoryItem : inventoryItems) 1448d500549bSAnthony Wilson { 1449d500549bSAnthony Wilson if (inventoryItem.ledObjectPath == ledObjPath) 1450d500549bSAnthony Wilson { 1451d500549bSAnthony Wilson return &inventoryItem; 1452d500549bSAnthony Wilson } 1453d500549bSAnthony Wilson } 1454d500549bSAnthony Wilson return nullptr; 1455d500549bSAnthony Wilson } 1456d500549bSAnthony Wilson 1457d500549bSAnthony Wilson /** 1458adc4f0dbSShawn McCarney * @brief Adds inventory item and associated sensor to specified vector. 1459adc4f0dbSShawn McCarney * 1460adc4f0dbSShawn McCarney * Adds a new InventoryItem to the vector if necessary. Searches for an 1461adc4f0dbSShawn McCarney * existing InventoryItem with the specified object path. If not found, one is 1462adc4f0dbSShawn McCarney * added to the vector. 1463adc4f0dbSShawn McCarney * 1464adc4f0dbSShawn McCarney * Next, the specified sensor is added to the set of sensors associated with the 1465adc4f0dbSShawn McCarney * InventoryItem. 1466adc4f0dbSShawn McCarney * 1467adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1468adc4f0dbSShawn McCarney * @param invItemObjPath D-Bus object path of inventory item. 1469adc4f0dbSShawn McCarney * @param sensorObjPath D-Bus object path of sensor 1470adc4f0dbSShawn McCarney */ 1471b5a76932SEd Tanous inline void addInventoryItem( 1472b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1473b5a76932SEd Tanous const std::string& invItemObjPath, const std::string& sensorObjPath) 1474adc4f0dbSShawn McCarney { 1475adc4f0dbSShawn McCarney // Look for inventory item in vector 1476adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 1477adc4f0dbSShawn McCarney findInventoryItem(inventoryItems, invItemObjPath); 1478adc4f0dbSShawn McCarney 1479adc4f0dbSShawn McCarney // If inventory item doesn't exist in vector, add it 1480adc4f0dbSShawn McCarney if (inventoryItem == nullptr) 1481adc4f0dbSShawn McCarney { 1482adc4f0dbSShawn McCarney inventoryItems->emplace_back(invItemObjPath); 1483adc4f0dbSShawn McCarney inventoryItem = &(inventoryItems->back()); 1484adc4f0dbSShawn McCarney } 1485adc4f0dbSShawn McCarney 1486adc4f0dbSShawn McCarney // Add sensor to set of sensors associated with inventory item 1487adc4f0dbSShawn McCarney inventoryItem->sensors.emplace(sensorObjPath); 1488adc4f0dbSShawn McCarney } 1489adc4f0dbSShawn McCarney 1490adc4f0dbSShawn McCarney /** 1491adc4f0dbSShawn McCarney * @brief Stores D-Bus data in the specified inventory item. 1492adc4f0dbSShawn McCarney * 1493adc4f0dbSShawn McCarney * Finds D-Bus data in the specified map of interfaces. Stores the data in the 1494adc4f0dbSShawn McCarney * specified InventoryItem. 1495adc4f0dbSShawn McCarney * 1496adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 1497adc4f0dbSShawn McCarney * response. 1498adc4f0dbSShawn McCarney * 1499adc4f0dbSShawn McCarney * @param inventoryItem Inventory item where data will be stored. 1500adc4f0dbSShawn McCarney * @param interfacesDict Map containing D-Bus interfaces and their properties 1501adc4f0dbSShawn McCarney * for the specified inventory item. 1502adc4f0dbSShawn McCarney */ 150323a21a1cSEd Tanous inline void storeInventoryItemData( 1504adc4f0dbSShawn McCarney InventoryItem& inventoryItem, 15058fb49dd6SShawn McCarney const boost::container::flat_map< 15068fb49dd6SShawn McCarney std::string, boost::container::flat_map<std::string, SensorVariant>>& 15078fb49dd6SShawn McCarney interfacesDict) 15088fb49dd6SShawn McCarney { 1509adc4f0dbSShawn McCarney // Get properties from Inventory.Item interface 1510adc4f0dbSShawn McCarney auto interfaceIt = 1511adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Item"); 1512adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 15138fb49dd6SShawn McCarney { 1514adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Present"); 1515adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 15168fb49dd6SShawn McCarney { 1517adc4f0dbSShawn McCarney const bool* value = std::get_if<bool>(&propertyIt->second); 1518adc4f0dbSShawn McCarney if (value != nullptr) 15198fb49dd6SShawn McCarney { 1520adc4f0dbSShawn McCarney inventoryItem.isPresent = *value; 15218fb49dd6SShawn McCarney } 15228fb49dd6SShawn McCarney } 15238fb49dd6SShawn McCarney } 15248fb49dd6SShawn McCarney 1525adc4f0dbSShawn McCarney // Check if Inventory.Item.PowerSupply interface is present 1526adc4f0dbSShawn McCarney interfaceIt = 1527adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Item.PowerSupply"); 1528adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 15298fb49dd6SShawn McCarney { 1530adc4f0dbSShawn McCarney inventoryItem.isPowerSupply = true; 15318fb49dd6SShawn McCarney } 1532adc4f0dbSShawn McCarney 1533adc4f0dbSShawn McCarney // Get properties from Inventory.Decorator.Asset interface 1534adc4f0dbSShawn McCarney interfaceIt = 1535adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Decorator.Asset"); 1536adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 1537adc4f0dbSShawn McCarney { 1538adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Manufacturer"); 1539adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1540adc4f0dbSShawn McCarney { 1541adc4f0dbSShawn McCarney const std::string* value = 1542adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1543adc4f0dbSShawn McCarney if (value != nullptr) 1544adc4f0dbSShawn McCarney { 1545adc4f0dbSShawn McCarney inventoryItem.manufacturer = *value; 1546adc4f0dbSShawn McCarney } 1547adc4f0dbSShawn McCarney } 1548adc4f0dbSShawn McCarney 1549adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("Model"); 1550adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1551adc4f0dbSShawn McCarney { 1552adc4f0dbSShawn McCarney const std::string* value = 1553adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1554adc4f0dbSShawn McCarney if (value != nullptr) 1555adc4f0dbSShawn McCarney { 1556adc4f0dbSShawn McCarney inventoryItem.model = *value; 1557adc4f0dbSShawn McCarney } 1558adc4f0dbSShawn McCarney } 1559adc4f0dbSShawn McCarney 1560adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("PartNumber"); 1561adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1562adc4f0dbSShawn McCarney { 1563adc4f0dbSShawn McCarney const std::string* value = 1564adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1565adc4f0dbSShawn McCarney if (value != nullptr) 1566adc4f0dbSShawn McCarney { 1567adc4f0dbSShawn McCarney inventoryItem.partNumber = *value; 1568adc4f0dbSShawn McCarney } 1569adc4f0dbSShawn McCarney } 1570adc4f0dbSShawn McCarney 1571adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("SerialNumber"); 1572adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1573adc4f0dbSShawn McCarney { 1574adc4f0dbSShawn McCarney const std::string* value = 1575adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1576adc4f0dbSShawn McCarney if (value != nullptr) 1577adc4f0dbSShawn McCarney { 1578adc4f0dbSShawn McCarney inventoryItem.serialNumber = *value; 1579adc4f0dbSShawn McCarney } 1580adc4f0dbSShawn McCarney } 1581adc4f0dbSShawn McCarney } 1582adc4f0dbSShawn McCarney 1583adc4f0dbSShawn McCarney // Get properties from State.Decorator.OperationalStatus interface 1584adc4f0dbSShawn McCarney interfaceIt = interfacesDict.find( 1585adc4f0dbSShawn McCarney "xyz.openbmc_project.State.Decorator.OperationalStatus"); 1586adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 1587adc4f0dbSShawn McCarney { 1588adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Functional"); 1589adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1590adc4f0dbSShawn McCarney { 1591adc4f0dbSShawn McCarney const bool* value = std::get_if<bool>(&propertyIt->second); 1592adc4f0dbSShawn McCarney if (value != nullptr) 1593adc4f0dbSShawn McCarney { 1594adc4f0dbSShawn McCarney inventoryItem.isFunctional = *value; 15958fb49dd6SShawn McCarney } 15968fb49dd6SShawn McCarney } 15978fb49dd6SShawn McCarney } 15988fb49dd6SShawn McCarney } 15998fb49dd6SShawn McCarney 16008fb49dd6SShawn McCarney /** 1601adc4f0dbSShawn McCarney * @brief Gets D-Bus data for inventory items associated with sensors. 16028fb49dd6SShawn McCarney * 1603adc4f0dbSShawn McCarney * Uses the specified connections (services) to obtain D-Bus data for inventory 1604adc4f0dbSShawn McCarney * items associated with sensors. Stores the resulting data in the 1605adc4f0dbSShawn McCarney * inventoryItems vector. 16068fb49dd6SShawn McCarney * 1607adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 1608adc4f0dbSShawn McCarney * response. 1609adc4f0dbSShawn McCarney * 1610adc4f0dbSShawn McCarney * Finds the inventory item data asynchronously. Invokes callback when data has 1611adc4f0dbSShawn McCarney * been obtained. 1612adc4f0dbSShawn McCarney * 1613adc4f0dbSShawn McCarney * The callback must have the following signature: 1614adc4f0dbSShawn McCarney * @code 1615d500549bSAnthony Wilson * callback(void) 1616adc4f0dbSShawn McCarney * @endcode 1617adc4f0dbSShawn McCarney * 1618adc4f0dbSShawn McCarney * This function is called recursively, obtaining data asynchronously from one 1619adc4f0dbSShawn McCarney * connection in each call. This ensures the callback is not invoked until the 1620adc4f0dbSShawn McCarney * last asynchronous function has completed. 16218fb49dd6SShawn McCarney * 16228fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 1623adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1624adc4f0dbSShawn McCarney * @param invConnections Connections that provide data for the inventory items. 16258fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 16268fb49dd6SShawn McCarney * implements ObjectManager. 1627adc4f0dbSShawn McCarney * @param callback Callback to invoke when inventory data has been obtained. 1628adc4f0dbSShawn McCarney * @param invConnectionsIndex Current index in invConnections. Only specified 1629adc4f0dbSShawn McCarney * in recursive calls to this function. 16308fb49dd6SShawn McCarney */ 1631adc4f0dbSShawn McCarney template <typename Callback> 1632adc4f0dbSShawn McCarney static void getInventoryItemsData( 16338fb49dd6SShawn McCarney std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1634adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 16358fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> invConnections, 16368fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 1637adc4f0dbSShawn McCarney objectMgrPaths, 1638271584abSEd Tanous Callback&& callback, size_t invConnectionsIndex = 0) 16398fb49dd6SShawn McCarney { 1640adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData enter"; 16418fb49dd6SShawn McCarney 1642adc4f0dbSShawn McCarney // If no more connections left, call callback 1643adc4f0dbSShawn McCarney if (invConnectionsIndex >= invConnections->size()) 16448fb49dd6SShawn McCarney { 1645d500549bSAnthony Wilson callback(); 1646adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData exit"; 1647adc4f0dbSShawn McCarney return; 1648adc4f0dbSShawn McCarney } 1649adc4f0dbSShawn McCarney 1650adc4f0dbSShawn McCarney // Get inventory item data from current connection 1651adc4f0dbSShawn McCarney auto it = invConnections->nth(invConnectionsIndex); 1652adc4f0dbSShawn McCarney if (it != invConnections->end()) 1653adc4f0dbSShawn McCarney { 1654adc4f0dbSShawn McCarney const std::string& invConnection = *it; 1655adc4f0dbSShawn McCarney 16568fb49dd6SShawn McCarney // Response handler for GetManagedObjects 1657adc4f0dbSShawn McCarney auto respHandler = [sensorsAsyncResp, inventoryItems, invConnections, 1658adc4f0dbSShawn McCarney objectMgrPaths, callback{std::move(callback)}, 1659adc4f0dbSShawn McCarney invConnectionsIndex]( 1660adc4f0dbSShawn McCarney const boost::system::error_code ec, 16618fb49dd6SShawn McCarney ManagedObjectsVectorType& resp) { 1662adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler enter"; 16638fb49dd6SShawn McCarney if (ec) 16648fb49dd6SShawn McCarney { 16658fb49dd6SShawn McCarney BMCWEB_LOG_ERROR 1666adc4f0dbSShawn McCarney << "getInventoryItemsData respHandler DBus error " << ec; 16678d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 16688fb49dd6SShawn McCarney return; 16698fb49dd6SShawn McCarney } 16708fb49dd6SShawn McCarney 16718fb49dd6SShawn McCarney // Loop through returned object paths 16728fb49dd6SShawn McCarney for (const auto& objDictEntry : resp) 16738fb49dd6SShawn McCarney { 16748fb49dd6SShawn McCarney const std::string& objPath = 16758fb49dd6SShawn McCarney static_cast<const std::string&>(objDictEntry.first); 16768fb49dd6SShawn McCarney 1677adc4f0dbSShawn McCarney // If this object path is one of the specified inventory items 1678adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 1679adc4f0dbSShawn McCarney findInventoryItem(inventoryItems, objPath); 1680adc4f0dbSShawn McCarney if (inventoryItem != nullptr) 16818fb49dd6SShawn McCarney { 1682adc4f0dbSShawn McCarney // Store inventory data in InventoryItem 1683adc4f0dbSShawn McCarney storeInventoryItemData(*inventoryItem, objDictEntry.second); 16848fb49dd6SShawn McCarney } 16858fb49dd6SShawn McCarney } 16868fb49dd6SShawn McCarney 1687adc4f0dbSShawn McCarney // Recurse to get inventory item data from next connection 1688adc4f0dbSShawn McCarney getInventoryItemsData(sensorsAsyncResp, inventoryItems, 1689adc4f0dbSShawn McCarney invConnections, objectMgrPaths, 1690adc4f0dbSShawn McCarney std::move(callback), invConnectionsIndex + 1); 1691adc4f0dbSShawn McCarney 1692adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler exit"; 16938fb49dd6SShawn McCarney }; 16948fb49dd6SShawn McCarney 16958fb49dd6SShawn McCarney // Find DBus object path that implements ObjectManager for the current 16968fb49dd6SShawn McCarney // connection. If no mapping found, default to "/". 16978fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(invConnection); 16988fb49dd6SShawn McCarney const std::string& objectMgrPath = 16998fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 17008fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << invConnection << " is " 17018fb49dd6SShawn McCarney << objectMgrPath; 17028fb49dd6SShawn McCarney 17038fb49dd6SShawn McCarney // Get all object paths and their interfaces for current connection 17048fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 17058fb49dd6SShawn McCarney std::move(respHandler), invConnection, objectMgrPath, 17068fb49dd6SShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 17078fb49dd6SShawn McCarney } 17088fb49dd6SShawn McCarney 1709adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData exit"; 17108fb49dd6SShawn McCarney } 17118fb49dd6SShawn McCarney 17128fb49dd6SShawn McCarney /** 1713adc4f0dbSShawn McCarney * @brief Gets connections that provide D-Bus data for inventory items. 17148fb49dd6SShawn McCarney * 1715adc4f0dbSShawn McCarney * Gets the D-Bus connections (services) that provide data for the inventory 1716adc4f0dbSShawn McCarney * items that are associated with sensors. 17178fb49dd6SShawn McCarney * 17188fb49dd6SShawn McCarney * Finds the connections asynchronously. Invokes callback when information has 17198fb49dd6SShawn McCarney * been obtained. 17208fb49dd6SShawn McCarney * 17218fb49dd6SShawn McCarney * The callback must have the following signature: 17228fb49dd6SShawn McCarney * @code 17238fb49dd6SShawn McCarney * callback(std::shared_ptr<boost::container::flat_set<std::string>> 17248fb49dd6SShawn McCarney * invConnections) 17258fb49dd6SShawn McCarney * @endcode 17268fb49dd6SShawn McCarney * 17278fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 1728adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 17298fb49dd6SShawn McCarney * @param callback Callback to invoke when connections have been obtained. 17308fb49dd6SShawn McCarney */ 17318fb49dd6SShawn McCarney template <typename Callback> 17328fb49dd6SShawn McCarney static void getInventoryItemsConnections( 1733b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 1734b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 17358fb49dd6SShawn McCarney Callback&& callback) 17368fb49dd6SShawn McCarney { 17378fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections enter"; 17388fb49dd6SShawn McCarney 17398fb49dd6SShawn McCarney const std::string path = "/xyz/openbmc_project/inventory"; 1740adc4f0dbSShawn McCarney const std::array<std::string, 4> interfaces = { 17418fb49dd6SShawn McCarney "xyz.openbmc_project.Inventory.Item", 1742adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Item.PowerSupply", 1743adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Decorator.Asset", 17448fb49dd6SShawn McCarney "xyz.openbmc_project.State.Decorator.OperationalStatus"}; 17458fb49dd6SShawn McCarney 17468fb49dd6SShawn McCarney // Response handler for parsing output from GetSubTree 17478fb49dd6SShawn McCarney auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 1748adc4f0dbSShawn McCarney inventoryItems](const boost::system::error_code ec, 17498fb49dd6SShawn McCarney const GetSubTreeType& subtree) { 17508fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler enter"; 17518fb49dd6SShawn McCarney if (ec) 17528fb49dd6SShawn McCarney { 17538d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 17548fb49dd6SShawn McCarney BMCWEB_LOG_ERROR 17558fb49dd6SShawn McCarney << "getInventoryItemsConnections respHandler DBus error " << ec; 17568fb49dd6SShawn McCarney return; 17578fb49dd6SShawn McCarney } 17588fb49dd6SShawn McCarney 17598fb49dd6SShawn McCarney // Make unique list of connections for desired inventory items 17608fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> 17618fb49dd6SShawn McCarney invConnections = 17628fb49dd6SShawn McCarney std::make_shared<boost::container::flat_set<std::string>>(); 17638fb49dd6SShawn McCarney invConnections->reserve(8); 17648fb49dd6SShawn McCarney 17658fb49dd6SShawn McCarney // Loop through objects from GetSubTree 17668fb49dd6SShawn McCarney for (const std::pair< 17678fb49dd6SShawn McCarney std::string, 17688fb49dd6SShawn McCarney std::vector<std::pair<std::string, std::vector<std::string>>>>& 17698fb49dd6SShawn McCarney object : subtree) 17708fb49dd6SShawn McCarney { 1771adc4f0dbSShawn McCarney // Check if object path is one of the specified inventory items 17728fb49dd6SShawn McCarney const std::string& objPath = object.first; 1773adc4f0dbSShawn McCarney if (findInventoryItem(inventoryItems, objPath) != nullptr) 17748fb49dd6SShawn McCarney { 17758fb49dd6SShawn McCarney // Store all connections to inventory item 17768fb49dd6SShawn McCarney for (const std::pair<std::string, std::vector<std::string>>& 17778fb49dd6SShawn McCarney objData : object.second) 17788fb49dd6SShawn McCarney { 17798fb49dd6SShawn McCarney const std::string& invConnection = objData.first; 17808fb49dd6SShawn McCarney invConnections->insert(invConnection); 17818fb49dd6SShawn McCarney } 17828fb49dd6SShawn McCarney } 17838fb49dd6SShawn McCarney } 1784d500549bSAnthony Wilson 17858fb49dd6SShawn McCarney callback(invConnections); 17868fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler exit"; 17878fb49dd6SShawn McCarney }; 17888fb49dd6SShawn McCarney 17898fb49dd6SShawn McCarney // Make call to ObjectMapper to find all inventory items 17908fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 17918fb49dd6SShawn McCarney std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 17928fb49dd6SShawn McCarney "/xyz/openbmc_project/object_mapper", 17938fb49dd6SShawn McCarney "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces); 17948fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections exit"; 17958fb49dd6SShawn McCarney } 17968fb49dd6SShawn McCarney 17978fb49dd6SShawn McCarney /** 1798adc4f0dbSShawn McCarney * @brief Gets associations from sensors to inventory items. 17998fb49dd6SShawn McCarney * 18008fb49dd6SShawn McCarney * Looks for ObjectMapper associations from the specified sensors to related 1801d500549bSAnthony Wilson * inventory items. Then finds the associations from those inventory items to 1802d500549bSAnthony Wilson * their LEDs, if any. 18038fb49dd6SShawn McCarney * 18048fb49dd6SShawn McCarney * Finds the inventory items asynchronously. Invokes callback when information 18058fb49dd6SShawn McCarney * has been obtained. 18068fb49dd6SShawn McCarney * 18078fb49dd6SShawn McCarney * The callback must have the following signature: 18088fb49dd6SShawn McCarney * @code 1809adc4f0dbSShawn McCarney * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 18108fb49dd6SShawn McCarney * @endcode 18118fb49dd6SShawn McCarney * 18128fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 18138fb49dd6SShawn McCarney * @param sensorNames All sensors within the current chassis. 18148fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 18158fb49dd6SShawn McCarney * implements ObjectManager. 18168fb49dd6SShawn McCarney * @param callback Callback to invoke when inventory items have been obtained. 18178fb49dd6SShawn McCarney */ 18188fb49dd6SShawn McCarney template <typename Callback> 1819adc4f0dbSShawn McCarney static void getInventoryItemAssociations( 1820b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 1821b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 1822b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_map<std::string, std::string>>& 18238fb49dd6SShawn McCarney objectMgrPaths, 18248fb49dd6SShawn McCarney Callback&& callback) 18258fb49dd6SShawn McCarney { 1826adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations enter"; 18278fb49dd6SShawn McCarney 18288fb49dd6SShawn McCarney // Response handler for GetManagedObjects 18298fb49dd6SShawn McCarney auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 18308fb49dd6SShawn McCarney sensorNames](const boost::system::error_code ec, 18318fb49dd6SShawn McCarney dbus::utility::ManagedObjectType& resp) { 1832adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler enter"; 18338fb49dd6SShawn McCarney if (ec) 18348fb49dd6SShawn McCarney { 1835adc4f0dbSShawn McCarney BMCWEB_LOG_ERROR 1836adc4f0dbSShawn McCarney << "getInventoryItemAssociations respHandler DBus error " << ec; 18378d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 18388fb49dd6SShawn McCarney return; 18398fb49dd6SShawn McCarney } 18408fb49dd6SShawn McCarney 1841adc4f0dbSShawn McCarney // Create vector to hold list of inventory items 1842adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems = 1843adc4f0dbSShawn McCarney std::make_shared<std::vector<InventoryItem>>(); 1844adc4f0dbSShawn McCarney 18458fb49dd6SShawn McCarney // Loop through returned object paths 18468fb49dd6SShawn McCarney std::string sensorAssocPath; 18478fb49dd6SShawn McCarney sensorAssocPath.reserve(128); // avoid memory allocations 18488fb49dd6SShawn McCarney for (const auto& objDictEntry : resp) 18498fb49dd6SShawn McCarney { 18508fb49dd6SShawn McCarney const std::string& objPath = 18518fb49dd6SShawn McCarney static_cast<const std::string&>(objDictEntry.first); 18528fb49dd6SShawn McCarney const boost::container::flat_map< 18538fb49dd6SShawn McCarney std::string, boost::container::flat_map< 18548fb49dd6SShawn McCarney std::string, dbus::utility::DbusVariantType>>& 18558fb49dd6SShawn McCarney interfacesDict = objDictEntry.second; 18568fb49dd6SShawn McCarney 18578fb49dd6SShawn McCarney // If path is inventory association for one of the specified sensors 18588fb49dd6SShawn McCarney for (const std::string& sensorName : *sensorNames) 18598fb49dd6SShawn McCarney { 18608fb49dd6SShawn McCarney sensorAssocPath = sensorName; 18618fb49dd6SShawn McCarney sensorAssocPath += "/inventory"; 18628fb49dd6SShawn McCarney if (objPath == sensorAssocPath) 18638fb49dd6SShawn McCarney { 18648fb49dd6SShawn McCarney // Get Association interface for object path 18658fb49dd6SShawn McCarney auto assocIt = 18668fb49dd6SShawn McCarney interfacesDict.find("xyz.openbmc_project.Association"); 18678fb49dd6SShawn McCarney if (assocIt != interfacesDict.end()) 18688fb49dd6SShawn McCarney { 18698fb49dd6SShawn McCarney // Get inventory item from end point 18708fb49dd6SShawn McCarney auto endpointsIt = assocIt->second.find("endpoints"); 18718fb49dd6SShawn McCarney if (endpointsIt != assocIt->second.end()) 18728fb49dd6SShawn McCarney { 18738fb49dd6SShawn McCarney const std::vector<std::string>* endpoints = 18748fb49dd6SShawn McCarney std::get_if<std::vector<std::string>>( 18758fb49dd6SShawn McCarney &endpointsIt->second); 18768fb49dd6SShawn McCarney if ((endpoints != nullptr) && !endpoints->empty()) 18778fb49dd6SShawn McCarney { 1878adc4f0dbSShawn McCarney // Add inventory item to vector 1879adc4f0dbSShawn McCarney const std::string& invItemPath = 1880adc4f0dbSShawn McCarney endpoints->front(); 1881adc4f0dbSShawn McCarney addInventoryItem(inventoryItems, invItemPath, 1882adc4f0dbSShawn McCarney sensorName); 18838fb49dd6SShawn McCarney } 18848fb49dd6SShawn McCarney } 18858fb49dd6SShawn McCarney } 18868fb49dd6SShawn McCarney break; 18878fb49dd6SShawn McCarney } 18888fb49dd6SShawn McCarney } 18898fb49dd6SShawn McCarney } 18908fb49dd6SShawn McCarney 1891d500549bSAnthony Wilson // Now loop through the returned object paths again, this time to 1892d500549bSAnthony Wilson // find the leds associated with the inventory items we just found 1893d500549bSAnthony Wilson std::string inventoryAssocPath; 1894d500549bSAnthony Wilson inventoryAssocPath.reserve(128); // avoid memory allocations 1895d500549bSAnthony Wilson for (const auto& objDictEntry : resp) 1896d500549bSAnthony Wilson { 1897d500549bSAnthony Wilson const std::string& objPath = 1898d500549bSAnthony Wilson static_cast<const std::string&>(objDictEntry.first); 1899d500549bSAnthony Wilson const boost::container::flat_map< 1900d500549bSAnthony Wilson std::string, boost::container::flat_map< 1901d500549bSAnthony Wilson std::string, dbus::utility::DbusVariantType>>& 1902d500549bSAnthony Wilson interfacesDict = objDictEntry.second; 1903d500549bSAnthony Wilson 1904d500549bSAnthony Wilson for (InventoryItem& inventoryItem : *inventoryItems) 1905d500549bSAnthony Wilson { 1906d500549bSAnthony Wilson inventoryAssocPath = inventoryItem.objectPath; 1907d500549bSAnthony Wilson inventoryAssocPath += "/leds"; 1908d500549bSAnthony Wilson if (objPath == inventoryAssocPath) 1909d500549bSAnthony Wilson { 1910d500549bSAnthony Wilson // Get Association interface for object path 1911d500549bSAnthony Wilson auto assocIt = 1912d500549bSAnthony Wilson interfacesDict.find("xyz.openbmc_project.Association"); 1913d500549bSAnthony Wilson if (assocIt != interfacesDict.end()) 1914d500549bSAnthony Wilson { 1915d500549bSAnthony Wilson // Get inventory item from end point 1916d500549bSAnthony Wilson auto endpointsIt = assocIt->second.find("endpoints"); 1917d500549bSAnthony Wilson if (endpointsIt != assocIt->second.end()) 1918d500549bSAnthony Wilson { 1919d500549bSAnthony Wilson const std::vector<std::string>* endpoints = 1920d500549bSAnthony Wilson std::get_if<std::vector<std::string>>( 1921d500549bSAnthony Wilson &endpointsIt->second); 1922d500549bSAnthony Wilson if ((endpoints != nullptr) && !endpoints->empty()) 1923d500549bSAnthony Wilson { 1924d500549bSAnthony Wilson // Store LED path in inventory item 1925d500549bSAnthony Wilson const std::string& ledPath = endpoints->front(); 1926d500549bSAnthony Wilson inventoryItem.ledObjectPath = ledPath; 1927d500549bSAnthony Wilson } 1928d500549bSAnthony Wilson } 1929d500549bSAnthony Wilson } 1930d500549bSAnthony Wilson break; 1931d500549bSAnthony Wilson } 1932d500549bSAnthony Wilson } 1933d500549bSAnthony Wilson } 1934adc4f0dbSShawn McCarney callback(inventoryItems); 1935adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler exit"; 19368fb49dd6SShawn McCarney }; 19378fb49dd6SShawn McCarney 19388fb49dd6SShawn McCarney // Find DBus object path that implements ObjectManager for ObjectMapper 19398fb49dd6SShawn McCarney std::string connection = "xyz.openbmc_project.ObjectMapper"; 19408fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(connection); 19418fb49dd6SShawn McCarney const std::string& objectMgrPath = 19428fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 19438fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is " 19448fb49dd6SShawn McCarney << objectMgrPath; 19458fb49dd6SShawn McCarney 19468fb49dd6SShawn McCarney // Call GetManagedObjects on the ObjectMapper to get all associations 19478fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 19488fb49dd6SShawn McCarney std::move(respHandler), connection, objectMgrPath, 19498fb49dd6SShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 19508fb49dd6SShawn McCarney 1951adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations exit"; 19528fb49dd6SShawn McCarney } 19538fb49dd6SShawn McCarney 19548fb49dd6SShawn McCarney /** 1955d500549bSAnthony Wilson * @brief Gets D-Bus data for inventory item leds associated with sensors. 1956d500549bSAnthony Wilson * 1957d500549bSAnthony Wilson * Uses the specified connections (services) to obtain D-Bus data for inventory 1958d500549bSAnthony Wilson * item leds associated with sensors. Stores the resulting data in the 1959d500549bSAnthony Wilson * inventoryItems vector. 1960d500549bSAnthony Wilson * 1961d500549bSAnthony Wilson * This data is later used to provide sensor property values in the JSON 1962d500549bSAnthony Wilson * response. 1963d500549bSAnthony Wilson * 1964d500549bSAnthony Wilson * Finds the inventory item led data asynchronously. Invokes callback when data 1965d500549bSAnthony Wilson * has been obtained. 1966d500549bSAnthony Wilson * 1967d500549bSAnthony Wilson * The callback must have the following signature: 1968d500549bSAnthony Wilson * @code 196942cbe538SGunnar Mills * callback() 1970d500549bSAnthony Wilson * @endcode 1971d500549bSAnthony Wilson * 1972d500549bSAnthony Wilson * This function is called recursively, obtaining data asynchronously from one 1973d500549bSAnthony Wilson * connection in each call. This ensures the callback is not invoked until the 1974d500549bSAnthony Wilson * last asynchronous function has completed. 1975d500549bSAnthony Wilson * 1976d500549bSAnthony Wilson * @param sensorsAsyncResp Pointer to object holding response data. 1977d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1978d500549bSAnthony Wilson * @param ledConnections Connections that provide data for the inventory leds. 1979d500549bSAnthony Wilson * @param callback Callback to invoke when inventory data has been obtained. 1980d500549bSAnthony Wilson * @param ledConnectionsIndex Current index in ledConnections. Only specified 1981d500549bSAnthony Wilson * in recursive calls to this function. 1982d500549bSAnthony Wilson */ 1983d500549bSAnthony Wilson template <typename Callback> 1984d500549bSAnthony Wilson void getInventoryLedData( 1985d500549bSAnthony Wilson std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1986d500549bSAnthony Wilson std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 1987d500549bSAnthony Wilson std::shared_ptr<boost::container::flat_map<std::string, std::string>> 1988d500549bSAnthony Wilson ledConnections, 1989d500549bSAnthony Wilson Callback&& callback, size_t ledConnectionsIndex = 0) 1990d500549bSAnthony Wilson { 1991d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData enter"; 1992d500549bSAnthony Wilson 1993d500549bSAnthony Wilson // If no more connections left, call callback 1994d500549bSAnthony Wilson if (ledConnectionsIndex >= ledConnections->size()) 1995d500549bSAnthony Wilson { 199642cbe538SGunnar Mills callback(); 1997d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData exit"; 1998d500549bSAnthony Wilson return; 1999d500549bSAnthony Wilson } 2000d500549bSAnthony Wilson 2001d500549bSAnthony Wilson // Get inventory item data from current connection 2002d500549bSAnthony Wilson auto it = ledConnections->nth(ledConnectionsIndex); 2003d500549bSAnthony Wilson if (it != ledConnections->end()) 2004d500549bSAnthony Wilson { 2005d500549bSAnthony Wilson const std::string& ledPath = (*it).first; 2006d500549bSAnthony Wilson const std::string& ledConnection = (*it).second; 2007d500549bSAnthony Wilson // Response handler for Get State property 2008d500549bSAnthony Wilson auto respHandler = 2009d500549bSAnthony Wilson [sensorsAsyncResp, inventoryItems, ledConnections, ledPath, 2010d500549bSAnthony Wilson callback{std::move(callback)}, 2011d500549bSAnthony Wilson ledConnectionsIndex](const boost::system::error_code ec, 2012d500549bSAnthony Wilson const std::variant<std::string>& ledState) { 2013d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler enter"; 2014d500549bSAnthony Wilson if (ec) 2015d500549bSAnthony Wilson { 2016d500549bSAnthony Wilson BMCWEB_LOG_ERROR 2017d500549bSAnthony Wilson << "getInventoryLedData respHandler DBus error " << ec; 20188d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2019d500549bSAnthony Wilson return; 2020d500549bSAnthony Wilson } 2021d500549bSAnthony Wilson 2022d500549bSAnthony Wilson const std::string* state = std::get_if<std::string>(&ledState); 2023d500549bSAnthony Wilson if (state != nullptr) 2024d500549bSAnthony Wilson { 2025d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "Led state: " << *state; 2026d500549bSAnthony Wilson // Find inventory item with this LED object path 2027d500549bSAnthony Wilson InventoryItem* inventoryItem = 2028d500549bSAnthony Wilson findInventoryItemForLed(*inventoryItems, ledPath); 2029d500549bSAnthony Wilson if (inventoryItem != nullptr) 2030d500549bSAnthony Wilson { 2031d500549bSAnthony Wilson // Store LED state in InventoryItem 2032d500549bSAnthony Wilson if (boost::ends_with(*state, "On")) 2033d500549bSAnthony Wilson { 2034d500549bSAnthony Wilson inventoryItem->ledState = LedState::ON; 2035d500549bSAnthony Wilson } 2036d500549bSAnthony Wilson else if (boost::ends_with(*state, "Blink")) 2037d500549bSAnthony Wilson { 2038d500549bSAnthony Wilson inventoryItem->ledState = LedState::BLINK; 2039d500549bSAnthony Wilson } 2040d500549bSAnthony Wilson else if (boost::ends_with(*state, "Off")) 2041d500549bSAnthony Wilson { 2042d500549bSAnthony Wilson inventoryItem->ledState = LedState::OFF; 2043d500549bSAnthony Wilson } 2044d500549bSAnthony Wilson else 2045d500549bSAnthony Wilson { 2046d500549bSAnthony Wilson inventoryItem->ledState = LedState::UNKNOWN; 2047d500549bSAnthony Wilson } 2048d500549bSAnthony Wilson } 2049d500549bSAnthony Wilson } 2050d500549bSAnthony Wilson else 2051d500549bSAnthony Wilson { 2052d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "Failed to find State data for LED: " 2053d500549bSAnthony Wilson << ledPath; 2054d500549bSAnthony Wilson } 2055d500549bSAnthony Wilson 2056d500549bSAnthony Wilson // Recurse to get LED data from next connection 2057d500549bSAnthony Wilson getInventoryLedData(sensorsAsyncResp, inventoryItems, 2058d500549bSAnthony Wilson ledConnections, std::move(callback), 2059d500549bSAnthony Wilson ledConnectionsIndex + 1); 2060d500549bSAnthony Wilson 2061d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler exit"; 2062d500549bSAnthony Wilson }; 2063d500549bSAnthony Wilson 2064d500549bSAnthony Wilson // Get the State property for the current LED 2065d500549bSAnthony Wilson crow::connections::systemBus->async_method_call( 2066d500549bSAnthony Wilson std::move(respHandler), ledConnection, ledPath, 2067d500549bSAnthony Wilson "org.freedesktop.DBus.Properties", "Get", 2068d500549bSAnthony Wilson "xyz.openbmc_project.Led.Physical", "State"); 2069d500549bSAnthony Wilson } 2070d500549bSAnthony Wilson 2071d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData exit"; 2072d500549bSAnthony Wilson } 2073d500549bSAnthony Wilson 2074d500549bSAnthony Wilson /** 2075d500549bSAnthony Wilson * @brief Gets LED data for LEDs associated with given inventory items. 2076d500549bSAnthony Wilson * 2077d500549bSAnthony Wilson * Gets the D-Bus connections (services) that provide LED data for the LEDs 2078d500549bSAnthony Wilson * associated with the specified inventory items. Then gets the LED data from 2079d500549bSAnthony Wilson * each connection and stores it in the inventory item. 2080d500549bSAnthony Wilson * 2081d500549bSAnthony Wilson * This data is later used to provide sensor property values in the JSON 2082d500549bSAnthony Wilson * response. 2083d500549bSAnthony Wilson * 2084d500549bSAnthony Wilson * Finds the LED data asynchronously. Invokes callback when information has 2085d500549bSAnthony Wilson * been obtained. 2086d500549bSAnthony Wilson * 2087d500549bSAnthony Wilson * The callback must have the following signature: 2088d500549bSAnthony Wilson * @code 208942cbe538SGunnar Mills * callback() 2090d500549bSAnthony Wilson * @endcode 2091d500549bSAnthony Wilson * 2092d500549bSAnthony Wilson * @param sensorsAsyncResp Pointer to object holding response data. 2093d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 2094d500549bSAnthony Wilson * @param callback Callback to invoke when inventory items have been obtained. 2095d500549bSAnthony Wilson */ 2096d500549bSAnthony Wilson template <typename Callback> 2097d500549bSAnthony Wilson void getInventoryLeds( 2098d500549bSAnthony Wilson std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 2099d500549bSAnthony Wilson std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 2100d500549bSAnthony Wilson Callback&& callback) 2101d500549bSAnthony Wilson { 2102d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds enter"; 2103d500549bSAnthony Wilson 2104d500549bSAnthony Wilson const std::string path = "/xyz/openbmc_project"; 2105d500549bSAnthony Wilson const std::array<std::string, 1> interfaces = { 2106d500549bSAnthony Wilson "xyz.openbmc_project.Led.Physical"}; 2107d500549bSAnthony Wilson 2108d500549bSAnthony Wilson // Response handler for parsing output from GetSubTree 2109d500549bSAnthony Wilson auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 2110d500549bSAnthony Wilson inventoryItems](const boost::system::error_code ec, 2111d500549bSAnthony Wilson const GetSubTreeType& subtree) { 2112d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler enter"; 2113d500549bSAnthony Wilson if (ec) 2114d500549bSAnthony Wilson { 21158d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2116d500549bSAnthony Wilson BMCWEB_LOG_ERROR << "getInventoryLeds respHandler DBus error " 2117d500549bSAnthony Wilson << ec; 2118d500549bSAnthony Wilson return; 2119d500549bSAnthony Wilson } 2120d500549bSAnthony Wilson 2121d500549bSAnthony Wilson // Build map of LED object paths to connections 2122d500549bSAnthony Wilson std::shared_ptr<boost::container::flat_map<std::string, std::string>> 2123d500549bSAnthony Wilson ledConnections = std::make_shared< 2124d500549bSAnthony Wilson boost::container::flat_map<std::string, std::string>>(); 2125d500549bSAnthony Wilson 2126d500549bSAnthony Wilson // Loop through objects from GetSubTree 2127d500549bSAnthony Wilson for (const std::pair< 2128d500549bSAnthony Wilson std::string, 2129d500549bSAnthony Wilson std::vector<std::pair<std::string, std::vector<std::string>>>>& 2130d500549bSAnthony Wilson object : subtree) 2131d500549bSAnthony Wilson { 2132d500549bSAnthony Wilson // Check if object path is LED for one of the specified inventory 2133d500549bSAnthony Wilson // items 2134d500549bSAnthony Wilson const std::string& ledPath = object.first; 2135d500549bSAnthony Wilson if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr) 2136d500549bSAnthony Wilson { 2137d500549bSAnthony Wilson // Add mapping from ledPath to connection 2138d500549bSAnthony Wilson const std::string& connection = object.second.begin()->first; 2139d500549bSAnthony Wilson (*ledConnections)[ledPath] = connection; 2140d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "Added mapping " << ledPath << " -> " 2141d500549bSAnthony Wilson << connection; 2142d500549bSAnthony Wilson } 2143d500549bSAnthony Wilson } 2144d500549bSAnthony Wilson 2145d500549bSAnthony Wilson getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections, 2146d500549bSAnthony Wilson std::move(callback)); 2147d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler exit"; 2148d500549bSAnthony Wilson }; 2149d500549bSAnthony Wilson // Make call to ObjectMapper to find all inventory items 2150d500549bSAnthony Wilson crow::connections::systemBus->async_method_call( 2151d500549bSAnthony Wilson std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 2152d500549bSAnthony Wilson "/xyz/openbmc_project/object_mapper", 2153d500549bSAnthony Wilson "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces); 2154d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds exit"; 2155d500549bSAnthony Wilson } 2156d500549bSAnthony Wilson 2157d500549bSAnthony Wilson /** 215842cbe538SGunnar Mills * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent 215942cbe538SGunnar Mills * 216042cbe538SGunnar Mills * Uses the specified connections (services) (currently assumes just one) to 216142cbe538SGunnar Mills * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in 216242cbe538SGunnar Mills * the inventoryItems vector. Only stores data in Power Supply inventoryItems. 216342cbe538SGunnar Mills * 216442cbe538SGunnar Mills * This data is later used to provide sensor property values in the JSON 216542cbe538SGunnar Mills * response. 216642cbe538SGunnar Mills * 216742cbe538SGunnar Mills * Finds the Power Supply Attributes data asynchronously. Invokes callback 216842cbe538SGunnar Mills * when data has been obtained. 216942cbe538SGunnar Mills * 217042cbe538SGunnar Mills * The callback must have the following signature: 217142cbe538SGunnar Mills * @code 217242cbe538SGunnar Mills * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 217342cbe538SGunnar Mills * @endcode 217442cbe538SGunnar Mills * 217542cbe538SGunnar Mills * @param sensorsAsyncResp Pointer to object holding response data. 217642cbe538SGunnar Mills * @param inventoryItems D-Bus inventory items associated with sensors. 217742cbe538SGunnar Mills * @param psAttributesConnections Connections that provide data for the Power 217842cbe538SGunnar Mills * Supply Attributes 217942cbe538SGunnar Mills * @param callback Callback to invoke when data has been obtained. 218042cbe538SGunnar Mills */ 218142cbe538SGunnar Mills template <typename Callback> 218242cbe538SGunnar Mills void getPowerSupplyAttributesData( 2183b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 218442cbe538SGunnar Mills std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 218542cbe538SGunnar Mills const boost::container::flat_map<std::string, std::string>& 218642cbe538SGunnar Mills psAttributesConnections, 218742cbe538SGunnar Mills Callback&& callback) 218842cbe538SGunnar Mills { 218942cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData enter"; 219042cbe538SGunnar Mills 219142cbe538SGunnar Mills if (psAttributesConnections.empty()) 219242cbe538SGunnar Mills { 219342cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Can't find PowerSupplyAttributes, no connections!"; 219442cbe538SGunnar Mills callback(inventoryItems); 219542cbe538SGunnar Mills return; 219642cbe538SGunnar Mills } 219742cbe538SGunnar Mills 219842cbe538SGunnar Mills // Assuming just one connection (service) for now 219942cbe538SGunnar Mills auto it = psAttributesConnections.nth(0); 220042cbe538SGunnar Mills 220142cbe538SGunnar Mills const std::string& psAttributesPath = (*it).first; 220242cbe538SGunnar Mills const std::string& psAttributesConnection = (*it).second; 220342cbe538SGunnar Mills 220442cbe538SGunnar Mills // Response handler for Get DeratingFactor property 220542cbe538SGunnar Mills auto respHandler = [sensorsAsyncResp, inventoryItems, 220642cbe538SGunnar Mills callback{std::move(callback)}]( 220742cbe538SGunnar Mills const boost::system::error_code ec, 220842cbe538SGunnar Mills const std::variant<uint32_t>& deratingFactor) { 220942cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler enter"; 221042cbe538SGunnar Mills if (ec) 221142cbe538SGunnar Mills { 221242cbe538SGunnar Mills BMCWEB_LOG_ERROR 221342cbe538SGunnar Mills << "getPowerSupplyAttributesData respHandler DBus error " << ec; 22148d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 221542cbe538SGunnar Mills return; 221642cbe538SGunnar Mills } 221742cbe538SGunnar Mills 221842cbe538SGunnar Mills const uint32_t* value = std::get_if<uint32_t>(&deratingFactor); 221942cbe538SGunnar Mills if (value != nullptr) 222042cbe538SGunnar Mills { 222142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "PS EfficiencyPercent value: " << *value; 222242cbe538SGunnar Mills // Store value in Power Supply Inventory Items 222342cbe538SGunnar Mills for (InventoryItem& inventoryItem : *inventoryItems) 222442cbe538SGunnar Mills { 222542cbe538SGunnar Mills if (inventoryItem.isPowerSupply == true) 222642cbe538SGunnar Mills { 222742cbe538SGunnar Mills inventoryItem.powerSupplyEfficiencyPercent = 222842cbe538SGunnar Mills static_cast<int>(*value); 222942cbe538SGunnar Mills } 223042cbe538SGunnar Mills } 223142cbe538SGunnar Mills } 223242cbe538SGunnar Mills else 223342cbe538SGunnar Mills { 223442cbe538SGunnar Mills BMCWEB_LOG_DEBUG 223542cbe538SGunnar Mills << "Failed to find EfficiencyPercent value for PowerSupplies"; 223642cbe538SGunnar Mills } 223742cbe538SGunnar Mills 223842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler exit"; 223942cbe538SGunnar Mills callback(inventoryItems); 224042cbe538SGunnar Mills }; 224142cbe538SGunnar Mills 224242cbe538SGunnar Mills // Get the DeratingFactor property for the PowerSupplyAttributes 224342cbe538SGunnar Mills // Currently only property on the interface/only one we care about 224442cbe538SGunnar Mills crow::connections::systemBus->async_method_call( 224542cbe538SGunnar Mills std::move(respHandler), psAttributesConnection, psAttributesPath, 224642cbe538SGunnar Mills "org.freedesktop.DBus.Properties", "Get", 224742cbe538SGunnar Mills "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor"); 224842cbe538SGunnar Mills 224942cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData exit"; 225042cbe538SGunnar Mills } 225142cbe538SGunnar Mills 225242cbe538SGunnar Mills /** 225342cbe538SGunnar Mills * @brief Gets the Power Supply Attributes such as EfficiencyPercent 225442cbe538SGunnar Mills * 225542cbe538SGunnar Mills * Gets the D-Bus connection (service) that provides Power Supply Attributes 225642cbe538SGunnar Mills * data. Then gets the Power Supply Attributes data from the connection 225742cbe538SGunnar Mills * (currently just assumes 1 connection) and stores the data in the inventory 225842cbe538SGunnar Mills * item. 225942cbe538SGunnar Mills * 226042cbe538SGunnar Mills * This data is later used to provide sensor property values in the JSON 226142cbe538SGunnar Mills * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish. 226242cbe538SGunnar Mills * 226342cbe538SGunnar Mills * Finds the Power Supply Attributes data asynchronously. Invokes callback 226442cbe538SGunnar Mills * when information has been obtained. 226542cbe538SGunnar Mills * 226642cbe538SGunnar Mills * The callback must have the following signature: 226742cbe538SGunnar Mills * @code 226842cbe538SGunnar Mills * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 226942cbe538SGunnar Mills * @endcode 227042cbe538SGunnar Mills * 227142cbe538SGunnar Mills * @param sensorsAsyncResp Pointer to object holding response data. 227242cbe538SGunnar Mills * @param inventoryItems D-Bus inventory items associated with sensors. 227342cbe538SGunnar Mills * @param callback Callback to invoke when data has been obtained. 227442cbe538SGunnar Mills */ 227542cbe538SGunnar Mills template <typename Callback> 227642cbe538SGunnar Mills void getPowerSupplyAttributes( 227742cbe538SGunnar Mills std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 227842cbe538SGunnar Mills std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 227942cbe538SGunnar Mills Callback&& callback) 228042cbe538SGunnar Mills { 228142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes enter"; 228242cbe538SGunnar Mills 228342cbe538SGunnar Mills // Only need the power supply attributes when the Power Schema 2284a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode != sensors::node::power) 228542cbe538SGunnar Mills { 228642cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit since not Power"; 228742cbe538SGunnar Mills callback(inventoryItems); 228842cbe538SGunnar Mills return; 228942cbe538SGunnar Mills } 229042cbe538SGunnar Mills 229142cbe538SGunnar Mills const std::array<std::string, 1> interfaces = { 229242cbe538SGunnar Mills "xyz.openbmc_project.Control.PowerSupplyAttributes"}; 229342cbe538SGunnar Mills 229442cbe538SGunnar Mills // Response handler for parsing output from GetSubTree 229542cbe538SGunnar Mills auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 229642cbe538SGunnar Mills inventoryItems](const boost::system::error_code ec, 229742cbe538SGunnar Mills const GetSubTreeType& subtree) { 229842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler enter"; 229942cbe538SGunnar Mills if (ec) 230042cbe538SGunnar Mills { 23018d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 230242cbe538SGunnar Mills BMCWEB_LOG_ERROR 230342cbe538SGunnar Mills << "getPowerSupplyAttributes respHandler DBus error " << ec; 230442cbe538SGunnar Mills return; 230542cbe538SGunnar Mills } 230642cbe538SGunnar Mills if (subtree.size() == 0) 230742cbe538SGunnar Mills { 230842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Can't find Power Supply Attributes!"; 230942cbe538SGunnar Mills callback(inventoryItems); 231042cbe538SGunnar Mills return; 231142cbe538SGunnar Mills } 231242cbe538SGunnar Mills 231342cbe538SGunnar Mills // Currently we only support 1 power supply attribute, use this for 231442cbe538SGunnar Mills // all the power supplies. Build map of object path to connection. 231542cbe538SGunnar Mills // Assume just 1 connection and 1 path for now. 231642cbe538SGunnar Mills boost::container::flat_map<std::string, std::string> 231742cbe538SGunnar Mills psAttributesConnections; 231842cbe538SGunnar Mills 231942cbe538SGunnar Mills if (subtree[0].first.empty() || subtree[0].second.empty()) 232042cbe538SGunnar Mills { 232142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!"; 232242cbe538SGunnar Mills callback(inventoryItems); 232342cbe538SGunnar Mills return; 232442cbe538SGunnar Mills } 232542cbe538SGunnar Mills 232642cbe538SGunnar Mills const std::string& psAttributesPath = subtree[0].first; 232742cbe538SGunnar Mills const std::string& connection = subtree[0].second.begin()->first; 232842cbe538SGunnar Mills 232942cbe538SGunnar Mills if (connection.empty()) 233042cbe538SGunnar Mills { 233142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!"; 233242cbe538SGunnar Mills callback(inventoryItems); 233342cbe538SGunnar Mills return; 233442cbe538SGunnar Mills } 233542cbe538SGunnar Mills 233642cbe538SGunnar Mills psAttributesConnections[psAttributesPath] = connection; 233742cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Added mapping " << psAttributesPath << " -> " 233842cbe538SGunnar Mills << connection; 233942cbe538SGunnar Mills 234042cbe538SGunnar Mills getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems, 234142cbe538SGunnar Mills psAttributesConnections, 234242cbe538SGunnar Mills std::move(callback)); 234342cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler exit"; 234442cbe538SGunnar Mills }; 234542cbe538SGunnar Mills // Make call to ObjectMapper to find the PowerSupplyAttributes service 234642cbe538SGunnar Mills crow::connections::systemBus->async_method_call( 234742cbe538SGunnar Mills std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 234842cbe538SGunnar Mills "/xyz/openbmc_project/object_mapper", 234942cbe538SGunnar Mills "xyz.openbmc_project.ObjectMapper", "GetSubTree", 235042cbe538SGunnar Mills "/xyz/openbmc_project", 0, interfaces); 235142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit"; 235242cbe538SGunnar Mills } 235342cbe538SGunnar Mills 235442cbe538SGunnar Mills /** 2355adc4f0dbSShawn McCarney * @brief Gets inventory items associated with sensors. 23568fb49dd6SShawn McCarney * 23578fb49dd6SShawn McCarney * Finds the inventory items that are associated with the specified sensors. 2358adc4f0dbSShawn McCarney * Then gets D-Bus data for the inventory items, such as presence and VPD. 23598fb49dd6SShawn McCarney * 2360adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 2361adc4f0dbSShawn McCarney * response. 23628fb49dd6SShawn McCarney * 2363adc4f0dbSShawn McCarney * Finds the inventory items asynchronously. Invokes callback when the 2364adc4f0dbSShawn McCarney * inventory items have been obtained. 2365adc4f0dbSShawn McCarney * 2366adc4f0dbSShawn McCarney * The callback must have the following signature: 2367adc4f0dbSShawn McCarney * @code 2368adc4f0dbSShawn McCarney * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 2369adc4f0dbSShawn McCarney * @endcode 23708fb49dd6SShawn McCarney * 23718fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 23728fb49dd6SShawn McCarney * @param sensorNames All sensors within the current chassis. 23738fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 23748fb49dd6SShawn McCarney * implements ObjectManager. 2375adc4f0dbSShawn McCarney * @param callback Callback to invoke when inventory items have been obtained. 23768fb49dd6SShawn McCarney */ 2377adc4f0dbSShawn McCarney template <typename Callback> 2378adc4f0dbSShawn McCarney static void getInventoryItems( 23798fb49dd6SShawn McCarney std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 23808fb49dd6SShawn McCarney const std::shared_ptr<boost::container::flat_set<std::string>> sensorNames, 23818fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 2382adc4f0dbSShawn McCarney objectMgrPaths, 2383adc4f0dbSShawn McCarney Callback&& callback) 23848fb49dd6SShawn McCarney { 2385adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItems enter"; 2386adc4f0dbSShawn McCarney auto getInventoryItemAssociationsCb = 2387adc4f0dbSShawn McCarney [sensorsAsyncResp, objectMgrPaths, callback{std::move(callback)}]( 2388adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems) { 2389adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb enter"; 23908fb49dd6SShawn McCarney auto getInventoryItemsConnectionsCb = 2391adc4f0dbSShawn McCarney [sensorsAsyncResp, inventoryItems, objectMgrPaths, 2392adc4f0dbSShawn McCarney callback{std::move(callback)}]( 23938fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> 23948fb49dd6SShawn McCarney invConnections) { 23958fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb enter"; 2396d500549bSAnthony Wilson auto getInventoryItemsDataCb = 2397d500549bSAnthony Wilson [sensorsAsyncResp, inventoryItems, 2398d500549bSAnthony Wilson callback{std::move(callback)}]() { 2399d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb enter"; 240042cbe538SGunnar Mills 240142cbe538SGunnar Mills auto getInventoryLedsCb = [sensorsAsyncResp, 240242cbe538SGunnar Mills inventoryItems, 240342cbe538SGunnar Mills callback{std::move( 240442cbe538SGunnar Mills callback)}]() { 240542cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getInventoryLedsCb enter"; 240642cbe538SGunnar Mills // Find Power Supply Attributes and get the data 240742cbe538SGunnar Mills getPowerSupplyAttributes(sensorsAsyncResp, 240842cbe538SGunnar Mills inventoryItems, 240942cbe538SGunnar Mills std::move(callback)); 241042cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getInventoryLedsCb exit"; 241142cbe538SGunnar Mills }; 241242cbe538SGunnar Mills 2413d500549bSAnthony Wilson // Find led connections and get the data 2414d500549bSAnthony Wilson getInventoryLeds(sensorsAsyncResp, inventoryItems, 241542cbe538SGunnar Mills std::move(getInventoryLedsCb)); 2416d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb exit"; 2417d500549bSAnthony Wilson }; 24188fb49dd6SShawn McCarney 2419adc4f0dbSShawn McCarney // Get inventory item data from connections 2420adc4f0dbSShawn McCarney getInventoryItemsData(sensorsAsyncResp, inventoryItems, 2421adc4f0dbSShawn McCarney invConnections, objectMgrPaths, 2422d500549bSAnthony Wilson std::move(getInventoryItemsDataCb)); 24238fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb exit"; 24248fb49dd6SShawn McCarney }; 24258fb49dd6SShawn McCarney 2426adc4f0dbSShawn McCarney // Get connections that provide inventory item data 24278fb49dd6SShawn McCarney getInventoryItemsConnections( 2428adc4f0dbSShawn McCarney sensorsAsyncResp, inventoryItems, 24298fb49dd6SShawn McCarney std::move(getInventoryItemsConnectionsCb)); 2430adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb exit"; 24318fb49dd6SShawn McCarney }; 24328fb49dd6SShawn McCarney 2433adc4f0dbSShawn McCarney // Get associations from sensors to inventory items 2434adc4f0dbSShawn McCarney getInventoryItemAssociations(sensorsAsyncResp, sensorNames, objectMgrPaths, 2435adc4f0dbSShawn McCarney std::move(getInventoryItemAssociationsCb)); 2436adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItems exit"; 2437adc4f0dbSShawn McCarney } 2438adc4f0dbSShawn McCarney 2439adc4f0dbSShawn McCarney /** 2440adc4f0dbSShawn McCarney * @brief Returns JSON PowerSupply object for the specified inventory item. 2441adc4f0dbSShawn McCarney * 2442adc4f0dbSShawn McCarney * Searches for a JSON PowerSupply object that matches the specified inventory 2443adc4f0dbSShawn McCarney * item. If one is not found, a new PowerSupply object is added to the JSON 2444adc4f0dbSShawn McCarney * array. 2445adc4f0dbSShawn McCarney * 2446adc4f0dbSShawn McCarney * Multiple sensors are often associated with one power supply inventory item. 2447adc4f0dbSShawn McCarney * As a result, multiple sensor values are stored in one JSON PowerSupply 2448adc4f0dbSShawn McCarney * object. 2449adc4f0dbSShawn McCarney * 2450adc4f0dbSShawn McCarney * @param powerSupplyArray JSON array containing Redfish PowerSupply objects. 2451adc4f0dbSShawn McCarney * @param inventoryItem Inventory item for the power supply. 2452adc4f0dbSShawn McCarney * @param chassisId Chassis that contains the power supply. 2453adc4f0dbSShawn McCarney * @return JSON PowerSupply object for the specified inventory item. 2454adc4f0dbSShawn McCarney */ 245523a21a1cSEd Tanous inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray, 2456adc4f0dbSShawn McCarney const InventoryItem& inventoryItem, 2457adc4f0dbSShawn McCarney const std::string& chassisId) 2458adc4f0dbSShawn McCarney { 2459adc4f0dbSShawn McCarney // Check if matching PowerSupply object already exists in JSON array 2460adc4f0dbSShawn McCarney for (nlohmann::json& powerSupply : powerSupplyArray) 2461adc4f0dbSShawn McCarney { 2462adc4f0dbSShawn McCarney if (powerSupply["MemberId"] == inventoryItem.name) 2463adc4f0dbSShawn McCarney { 2464adc4f0dbSShawn McCarney return powerSupply; 2465adc4f0dbSShawn McCarney } 2466adc4f0dbSShawn McCarney } 2467adc4f0dbSShawn McCarney 2468adc4f0dbSShawn McCarney // Add new PowerSupply object to JSON array 2469adc4f0dbSShawn McCarney powerSupplyArray.push_back({}); 2470adc4f0dbSShawn McCarney nlohmann::json& powerSupply = powerSupplyArray.back(); 2471adc4f0dbSShawn McCarney powerSupply["@odata.id"] = 2472adc4f0dbSShawn McCarney "/redfish/v1/Chassis/" + chassisId + "/Power#/PowerSupplies/"; 2473adc4f0dbSShawn McCarney powerSupply["MemberId"] = inventoryItem.name; 2474adc4f0dbSShawn McCarney powerSupply["Name"] = boost::replace_all_copy(inventoryItem.name, "_", " "); 2475adc4f0dbSShawn McCarney powerSupply["Manufacturer"] = inventoryItem.manufacturer; 2476adc4f0dbSShawn McCarney powerSupply["Model"] = inventoryItem.model; 2477adc4f0dbSShawn McCarney powerSupply["PartNumber"] = inventoryItem.partNumber; 2478adc4f0dbSShawn McCarney powerSupply["SerialNumber"] = inventoryItem.serialNumber; 2479d500549bSAnthony Wilson setLedState(powerSupply, &inventoryItem); 2480adc4f0dbSShawn McCarney 248142cbe538SGunnar Mills if (inventoryItem.powerSupplyEfficiencyPercent >= 0) 248242cbe538SGunnar Mills { 248342cbe538SGunnar Mills powerSupply["EfficiencyPercent"] = 248442cbe538SGunnar Mills inventoryItem.powerSupplyEfficiencyPercent; 248542cbe538SGunnar Mills } 248642cbe538SGunnar Mills 248742cbe538SGunnar Mills powerSupply["Status"]["State"] = getState(&inventoryItem); 2488adc4f0dbSShawn McCarney const char* health = inventoryItem.isFunctional ? "OK" : "Critical"; 2489adc4f0dbSShawn McCarney powerSupply["Status"]["Health"] = health; 2490adc4f0dbSShawn McCarney 2491adc4f0dbSShawn McCarney return powerSupply; 24928fb49dd6SShawn McCarney } 24938fb49dd6SShawn McCarney 24948fb49dd6SShawn McCarney /** 2495de629b6eSShawn McCarney * @brief Gets the values of the specified sensors. 2496de629b6eSShawn McCarney * 2497de629b6eSShawn McCarney * Stores the results as JSON in the SensorsAsyncResp. 2498de629b6eSShawn McCarney * 2499de629b6eSShawn McCarney * Gets the sensor values asynchronously. Stores the results later when the 2500de629b6eSShawn McCarney * information has been obtained. 2501de629b6eSShawn McCarney * 2502adc4f0dbSShawn McCarney * The sensorNames set contains all requested sensors for the current chassis. 2503de629b6eSShawn McCarney * 2504de629b6eSShawn McCarney * To minimize the number of DBus calls, the DBus method 2505de629b6eSShawn McCarney * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the 2506de629b6eSShawn McCarney * values of all sensors provided by a connection (service). 2507de629b6eSShawn McCarney * 2508de629b6eSShawn McCarney * The connections set contains all the connections that provide sensor values. 2509de629b6eSShawn McCarney * 2510de629b6eSShawn McCarney * The objectMgrPaths map contains mappings from a connection name to the 2511de629b6eSShawn McCarney * corresponding DBus object path that implements ObjectManager. 2512de629b6eSShawn McCarney * 2513adc4f0dbSShawn McCarney * The InventoryItem vector contains D-Bus inventory items associated with the 2514adc4f0dbSShawn McCarney * sensors. Inventory item data is needed for some Redfish sensor properties. 2515adc4f0dbSShawn McCarney * 2516de629b6eSShawn McCarney * @param SensorsAsyncResp Pointer to object holding response data. 2517adc4f0dbSShawn McCarney * @param sensorNames All requested sensors within the current chassis. 2518de629b6eSShawn McCarney * @param connections Connections that provide sensor values. 2519de629b6eSShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 2520de629b6eSShawn McCarney * implements ObjectManager. 2521adc4f0dbSShawn McCarney * @param inventoryItems Inventory items associated with the sensors. 2522de629b6eSShawn McCarney */ 252323a21a1cSEd Tanous inline void getSensorData( 252481ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 2525b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 2526de629b6eSShawn McCarney const boost::container::flat_set<std::string>& connections, 2527b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_map<std::string, std::string>>& 2528adc4f0dbSShawn McCarney objectMgrPaths, 2529b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems) 2530de629b6eSShawn McCarney { 2531de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getSensorData enter"; 2532de629b6eSShawn McCarney // Get managed objects from all services exposing sensors 2533de629b6eSShawn McCarney for (const std::string& connection : connections) 2534de629b6eSShawn McCarney { 2535de629b6eSShawn McCarney // Response handler to process managed objects 253681ce609eSEd Tanous auto getManagedObjectsCb = [sensorsAsyncResp, sensorNames, 2537adc4f0dbSShawn McCarney inventoryItems]( 2538de629b6eSShawn McCarney const boost::system::error_code ec, 2539de629b6eSShawn McCarney ManagedObjectsVectorType& resp) { 2540de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb enter"; 2541de629b6eSShawn McCarney if (ec) 2542de629b6eSShawn McCarney { 2543de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "getManagedObjectsCb DBUS error: " << ec; 25448d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2545de629b6eSShawn McCarney return; 2546de629b6eSShawn McCarney } 2547de629b6eSShawn McCarney // Go through all objects and update response with sensor data 2548de629b6eSShawn McCarney for (const auto& objDictEntry : resp) 2549de629b6eSShawn McCarney { 2550de629b6eSShawn McCarney const std::string& objPath = 2551de629b6eSShawn McCarney static_cast<const std::string&>(objDictEntry.first); 2552de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb parsing object " 2553de629b6eSShawn McCarney << objPath; 2554de629b6eSShawn McCarney 2555de629b6eSShawn McCarney std::vector<std::string> split; 2556de629b6eSShawn McCarney // Reserve space for 2557de629b6eSShawn McCarney // /xyz/openbmc_project/sensors/<name>/<subname> 2558de629b6eSShawn McCarney split.reserve(6); 2559de629b6eSShawn McCarney boost::algorithm::split(split, objPath, boost::is_any_of("/")); 2560de629b6eSShawn McCarney if (split.size() < 6) 2561de629b6eSShawn McCarney { 2562de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "Got path that isn't long enough " 2563de629b6eSShawn McCarney << objPath; 2564de629b6eSShawn McCarney continue; 2565de629b6eSShawn McCarney } 2566de629b6eSShawn McCarney // These indexes aren't intuitive, as boost::split puts an empty 2567de629b6eSShawn McCarney // string at the beginning 2568de629b6eSShawn McCarney const std::string& sensorType = split[4]; 2569de629b6eSShawn McCarney const std::string& sensorName = split[5]; 2570de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "sensorName " << sensorName 2571de629b6eSShawn McCarney << " sensorType " << sensorType; 257249c53ac9SJohnathan Mantey if (sensorNames->find(objPath) == sensorNames->end()) 2573de629b6eSShawn McCarney { 2574de629b6eSShawn McCarney BMCWEB_LOG_ERROR << sensorName << " not in sensor list "; 2575de629b6eSShawn McCarney continue; 2576de629b6eSShawn McCarney } 2577de629b6eSShawn McCarney 2578adc4f0dbSShawn McCarney // Find inventory item (if any) associated with sensor 2579adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 2580adc4f0dbSShawn McCarney findInventoryItemForSensor(inventoryItems, objPath); 2581adc4f0dbSShawn McCarney 258295a3ecadSAnthony Wilson const std::string& sensorSchema = 258381ce609eSEd Tanous sensorsAsyncResp->chassisSubNode; 258495a3ecadSAnthony Wilson 258595a3ecadSAnthony Wilson nlohmann::json* sensorJson = nullptr; 258695a3ecadSAnthony Wilson 2587a0ec28b6SAdrian Ambrożewicz if (sensorSchema == sensors::node::sensors) 258895a3ecadSAnthony Wilson { 25898d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] = 259081ce609eSEd Tanous "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + 259181ce609eSEd Tanous "/" + sensorsAsyncResp->chassisSubNode + "/" + 259295a3ecadSAnthony Wilson sensorName; 25938d1b46d7Szhanghch05 sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue); 259495a3ecadSAnthony Wilson } 259595a3ecadSAnthony Wilson else 259695a3ecadSAnthony Wilson { 2597271584abSEd Tanous std::string fieldName; 2598de629b6eSShawn McCarney if (sensorType == "temperature") 2599de629b6eSShawn McCarney { 2600de629b6eSShawn McCarney fieldName = "Temperatures"; 2601de629b6eSShawn McCarney } 2602de629b6eSShawn McCarney else if (sensorType == "fan" || sensorType == "fan_tach" || 2603de629b6eSShawn McCarney sensorType == "fan_pwm") 2604de629b6eSShawn McCarney { 2605de629b6eSShawn McCarney fieldName = "Fans"; 2606de629b6eSShawn McCarney } 2607de629b6eSShawn McCarney else if (sensorType == "voltage") 2608de629b6eSShawn McCarney { 2609de629b6eSShawn McCarney fieldName = "Voltages"; 2610de629b6eSShawn McCarney } 2611de629b6eSShawn McCarney else if (sensorType == "power") 2612de629b6eSShawn McCarney { 2613028f7ebcSEddie James if (!sensorName.compare("total_power")) 2614028f7ebcSEddie James { 2615028f7ebcSEddie James fieldName = "PowerControl"; 2616028f7ebcSEddie James } 2617adc4f0dbSShawn McCarney else if ((inventoryItem != nullptr) && 2618adc4f0dbSShawn McCarney (inventoryItem->isPowerSupply)) 2619028f7ebcSEddie James { 2620de629b6eSShawn McCarney fieldName = "PowerSupplies"; 2621de629b6eSShawn McCarney } 2622adc4f0dbSShawn McCarney else 2623adc4f0dbSShawn McCarney { 2624adc4f0dbSShawn McCarney // Other power sensors are in SensorCollection 2625adc4f0dbSShawn McCarney continue; 2626adc4f0dbSShawn McCarney } 2627028f7ebcSEddie James } 2628de629b6eSShawn McCarney else 2629de629b6eSShawn McCarney { 2630de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "Unsure how to handle sensorType " 2631de629b6eSShawn McCarney << sensorType; 2632de629b6eSShawn McCarney continue; 2633de629b6eSShawn McCarney } 2634de629b6eSShawn McCarney 2635de629b6eSShawn McCarney nlohmann::json& tempArray = 26368d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue[fieldName]; 2637adc4f0dbSShawn McCarney if (fieldName == "PowerControl") 263849c53ac9SJohnathan Mantey { 2639adc4f0dbSShawn McCarney if (tempArray.empty()) 26407ab06f49SGunnar Mills { 264195a3ecadSAnthony Wilson // Put multiple "sensors" into a single 264295a3ecadSAnthony Wilson // PowerControl. Follows MemberId naming and 264395a3ecadSAnthony Wilson // naming in power.hpp. 26447ab06f49SGunnar Mills tempArray.push_back( 2645adc4f0dbSShawn McCarney {{"@odata.id", 2646adc4f0dbSShawn McCarney "/redfish/v1/Chassis/" + 264781ce609eSEd Tanous sensorsAsyncResp->chassisId + "/" + 264881ce609eSEd Tanous sensorsAsyncResp->chassisSubNode + "#/" + 2649adc4f0dbSShawn McCarney fieldName + "/0"}}); 2650adc4f0dbSShawn McCarney } 2651adc4f0dbSShawn McCarney sensorJson = &(tempArray.back()); 2652adc4f0dbSShawn McCarney } 2653adc4f0dbSShawn McCarney else if (fieldName == "PowerSupplies") 2654adc4f0dbSShawn McCarney { 2655adc4f0dbSShawn McCarney if (inventoryItem != nullptr) 2656adc4f0dbSShawn McCarney { 2657adc4f0dbSShawn McCarney sensorJson = 2658adc4f0dbSShawn McCarney &(getPowerSupply(tempArray, *inventoryItem, 265981ce609eSEd Tanous sensorsAsyncResp->chassisId)); 2660adc4f0dbSShawn McCarney } 266149c53ac9SJohnathan Mantey } 266249c53ac9SJohnathan Mantey else 266349c53ac9SJohnathan Mantey { 2664de629b6eSShawn McCarney tempArray.push_back( 266595a3ecadSAnthony Wilson {{"@odata.id", 266695a3ecadSAnthony Wilson "/redfish/v1/Chassis/" + 266781ce609eSEd Tanous sensorsAsyncResp->chassisId + "/" + 266881ce609eSEd Tanous sensorsAsyncResp->chassisSubNode + "#/" + 266995a3ecadSAnthony Wilson fieldName + "/"}}); 2670adc4f0dbSShawn McCarney sensorJson = &(tempArray.back()); 267149c53ac9SJohnathan Mantey } 267295a3ecadSAnthony Wilson } 2673de629b6eSShawn McCarney 2674adc4f0dbSShawn McCarney if (sensorJson != nullptr) 2675adc4f0dbSShawn McCarney { 2676a0ec28b6SAdrian Ambrożewicz objectInterfacesToJson( 267781ce609eSEd Tanous sensorName, sensorType, sensorsAsyncResp, 2678a0ec28b6SAdrian Ambrożewicz objDictEntry.second, *sensorJson, inventoryItem); 2679adc4f0dbSShawn McCarney } 2680de629b6eSShawn McCarney } 268181ce609eSEd Tanous if (sensorsAsyncResp.use_count() == 1) 268249c53ac9SJohnathan Mantey { 268381ce609eSEd Tanous sortJSONResponse(sensorsAsyncResp); 268481ce609eSEd Tanous if (sensorsAsyncResp->chassisSubNode == sensors::node::thermal) 26858bd25ccdSJames Feist { 268681ce609eSEd Tanous populateFanRedundancy(sensorsAsyncResp); 26878bd25ccdSJames Feist } 268849c53ac9SJohnathan Mantey } 2689de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb exit"; 2690de629b6eSShawn McCarney }; 2691de629b6eSShawn McCarney 2692de629b6eSShawn McCarney // Find DBus object path that implements ObjectManager for the current 2693de629b6eSShawn McCarney // connection. If no mapping found, default to "/". 26948fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(connection); 2695de629b6eSShawn McCarney const std::string& objectMgrPath = 26968fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 2697de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is " 2698de629b6eSShawn McCarney << objectMgrPath; 2699de629b6eSShawn McCarney 2700de629b6eSShawn McCarney crow::connections::systemBus->async_method_call( 2701de629b6eSShawn McCarney getManagedObjectsCb, connection, objectMgrPath, 2702de629b6eSShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 270323a21a1cSEd Tanous } 2704de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getSensorData exit"; 2705de629b6eSShawn McCarney } 2706de629b6eSShawn McCarney 270723a21a1cSEd Tanous inline void processSensorList( 270881ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 2709b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames) 27101abe55efSEd Tanous { 271195a3ecadSAnthony Wilson auto getConnectionCb = 271281ce609eSEd Tanous [sensorsAsyncResp, sensorNames]( 271395a3ecadSAnthony Wilson const boost::container::flat_set<std::string>& connections) { 271455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getConnectionCb enter"; 2715de629b6eSShawn McCarney auto getObjectManagerPathsCb = 271681ce609eSEd Tanous [sensorsAsyncResp, sensorNames, 2717b5a76932SEd Tanous connections](const std::shared_ptr<boost::container::flat_map< 2718b5a76932SEd Tanous std::string, std::string>>& objectMgrPaths) { 2719de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb enter"; 2720adc4f0dbSShawn McCarney auto getInventoryItemsCb = 272181ce609eSEd Tanous [sensorsAsyncResp, sensorNames, connections, 2722adc4f0dbSShawn McCarney objectMgrPaths]( 2723f23b7296SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& 2724adc4f0dbSShawn McCarney inventoryItems) { 2725adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsCb enter"; 272649c53ac9SJohnathan Mantey // Get sensor data and store results in JSON 272781ce609eSEd Tanous getSensorData(sensorsAsyncResp, sensorNames, 2728adc4f0dbSShawn McCarney connections, objectMgrPaths, 2729f23b7296SEd Tanous inventoryItems); 2730adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsCb exit"; 2731adc4f0dbSShawn McCarney }; 2732adc4f0dbSShawn McCarney 2733adc4f0dbSShawn McCarney // Get inventory items associated with sensors 273481ce609eSEd Tanous getInventoryItems(sensorsAsyncResp, sensorNames, 2735adc4f0dbSShawn McCarney objectMgrPaths, 2736adc4f0dbSShawn McCarney std::move(getInventoryItemsCb)); 2737adc4f0dbSShawn McCarney 2738de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb exit"; 273908777fb0SLewanczyk, Dawid }; 2740de629b6eSShawn McCarney 274149c53ac9SJohnathan Mantey // Get mapping from connection names to the DBus object 274249c53ac9SJohnathan Mantey // paths that implement the ObjectManager interface 274381ce609eSEd Tanous getObjectManagerPaths(sensorsAsyncResp, 2744de629b6eSShawn McCarney std::move(getObjectManagerPathsCb)); 274555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getConnectionCb exit"; 274608777fb0SLewanczyk, Dawid }; 2747de629b6eSShawn McCarney 2748de629b6eSShawn McCarney // Get set of connections that provide sensor values 274981ce609eSEd Tanous getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb)); 275095a3ecadSAnthony Wilson } 275195a3ecadSAnthony Wilson 275295a3ecadSAnthony Wilson /** 275395a3ecadSAnthony Wilson * @brief Entry point for retrieving sensors data related to requested 275495a3ecadSAnthony Wilson * chassis. 275595a3ecadSAnthony Wilson * @param SensorsAsyncResp Pointer to object holding response data 275695a3ecadSAnthony Wilson */ 2757b5a76932SEd Tanous inline void 275881ce609eSEd Tanous getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 275995a3ecadSAnthony Wilson { 276095a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisData enter"; 276195a3ecadSAnthony Wilson auto getChassisCb = 276281ce609eSEd Tanous [sensorsAsyncResp]( 2763f23b7296SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& 276495a3ecadSAnthony Wilson sensorNames) { 276595a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb enter"; 276681ce609eSEd Tanous processSensorList(sensorsAsyncResp, sensorNames); 276755c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassisCb exit"; 276808777fb0SLewanczyk, Dawid }; 27698d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] = 27708d1b46d7Szhanghch05 nlohmann::json::array(); 277108777fb0SLewanczyk, Dawid 277226f03899SShawn McCarney // Get set of sensors in chassis 277381ce609eSEd Tanous getChassis(sensorsAsyncResp, std::move(getChassisCb)); 277455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassisData exit"; 2775271584abSEd Tanous } 277608777fb0SLewanczyk, Dawid 2777413961deSRichard Marian Thomaiyar /** 277849c53ac9SJohnathan Mantey * @brief Find the requested sensorName in the list of all sensors supplied by 277949c53ac9SJohnathan Mantey * the chassis node 278049c53ac9SJohnathan Mantey * 278149c53ac9SJohnathan Mantey * @param sensorName The sensor name supplied in the PATCH request 278249c53ac9SJohnathan Mantey * @param sensorsList The list of sensors managed by the chassis node 278349c53ac9SJohnathan Mantey * @param sensorsModified The list of sensors that were found as a result of 278449c53ac9SJohnathan Mantey * repeated calls to this function 278549c53ac9SJohnathan Mantey */ 278623a21a1cSEd Tanous inline bool findSensorNameUsingSensorPath( 27870a86febdSRichard Marian Thomaiyar std::string_view sensorName, 278849c53ac9SJohnathan Mantey boost::container::flat_set<std::string>& sensorsList, 278949c53ac9SJohnathan Mantey boost::container::flat_set<std::string>& sensorsModified) 279049c53ac9SJohnathan Mantey { 279128aa8de5SGeorge Liu for (auto& chassisSensor : sensorsList) 279249c53ac9SJohnathan Mantey { 279328aa8de5SGeorge Liu sdbusplus::message::object_path path(chassisSensor); 2794b00dcc27SEd Tanous std::string thisSensorName = path.filename(); 279528aa8de5SGeorge Liu if (thisSensorName.empty()) 279649c53ac9SJohnathan Mantey { 279749c53ac9SJohnathan Mantey continue; 279849c53ac9SJohnathan Mantey } 279949c53ac9SJohnathan Mantey if (thisSensorName == sensorName) 280049c53ac9SJohnathan Mantey { 280149c53ac9SJohnathan Mantey sensorsModified.emplace(chassisSensor); 280249c53ac9SJohnathan Mantey return true; 280349c53ac9SJohnathan Mantey } 280449c53ac9SJohnathan Mantey } 280549c53ac9SJohnathan Mantey return false; 280649c53ac9SJohnathan Mantey } 280749c53ac9SJohnathan Mantey 280849c53ac9SJohnathan Mantey /** 2809413961deSRichard Marian Thomaiyar * @brief Entry point for overriding sensor values of given sensor 2810413961deSRichard Marian Thomaiyar * 28118d1b46d7Szhanghch05 * @param sensorAsyncResp response object 28124bb3dc34SCarol Wang * @param allCollections Collections extract from sensors' request patch info 2813413961deSRichard Marian Thomaiyar * @param chassisSubNode Chassis Node for which the query has to happen 2814413961deSRichard Marian Thomaiyar */ 281523a21a1cSEd Tanous inline void setSensorsOverride( 2816b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp, 28174bb3dc34SCarol Wang std::unordered_map<std::string, std::vector<nlohmann::json>>& 2818397fd61fSjayaprakash Mutyala allCollections) 2819413961deSRichard Marian Thomaiyar { 282070d1d0aaSjayaprakash Mutyala BMCWEB_LOG_INFO << "setSensorsOverride for subNode" 28214bb3dc34SCarol Wang << sensorAsyncResp->chassisSubNode << "\n"; 2822413961deSRichard Marian Thomaiyar 2823f65af9e8SRichard Marian Thomaiyar const char* propertyValueName; 2824f65af9e8SRichard Marian Thomaiyar std::unordered_map<std::string, std::pair<double, std::string>> overrideMap; 2825413961deSRichard Marian Thomaiyar std::string memberId; 2826413961deSRichard Marian Thomaiyar double value; 2827f65af9e8SRichard Marian Thomaiyar for (auto& collectionItems : allCollections) 2828f65af9e8SRichard Marian Thomaiyar { 2829f65af9e8SRichard Marian Thomaiyar if (collectionItems.first == "Temperatures") 2830f65af9e8SRichard Marian Thomaiyar { 2831f65af9e8SRichard Marian Thomaiyar propertyValueName = "ReadingCelsius"; 2832f65af9e8SRichard Marian Thomaiyar } 2833f65af9e8SRichard Marian Thomaiyar else if (collectionItems.first == "Fans") 2834f65af9e8SRichard Marian Thomaiyar { 2835f65af9e8SRichard Marian Thomaiyar propertyValueName = "Reading"; 2836f65af9e8SRichard Marian Thomaiyar } 2837f65af9e8SRichard Marian Thomaiyar else 2838f65af9e8SRichard Marian Thomaiyar { 2839f65af9e8SRichard Marian Thomaiyar propertyValueName = "ReadingVolts"; 2840f65af9e8SRichard Marian Thomaiyar } 2841f65af9e8SRichard Marian Thomaiyar for (auto& item : collectionItems.second) 2842f65af9e8SRichard Marian Thomaiyar { 28438d1b46d7Szhanghch05 if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res, 28448d1b46d7Szhanghch05 "MemberId", memberId, propertyValueName, 28458d1b46d7Szhanghch05 value)) 2846413961deSRichard Marian Thomaiyar { 2847413961deSRichard Marian Thomaiyar return; 2848413961deSRichard Marian Thomaiyar } 2849f65af9e8SRichard Marian Thomaiyar overrideMap.emplace(memberId, 2850f65af9e8SRichard Marian Thomaiyar std::make_pair(value, collectionItems.first)); 2851f65af9e8SRichard Marian Thomaiyar } 2852f65af9e8SRichard Marian Thomaiyar } 28534bb3dc34SCarol Wang 2854b5a76932SEd Tanous auto getChassisSensorListCb = [sensorAsyncResp, overrideMap]( 2855b5a76932SEd Tanous const std::shared_ptr< 285649c53ac9SJohnathan Mantey boost::container::flat_set< 2857b5a76932SEd Tanous std::string>>& sensorsList) { 285849c53ac9SJohnathan Mantey // Match sensor names in the PATCH request to those managed by the 285949c53ac9SJohnathan Mantey // chassis node 286049c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> 286149c53ac9SJohnathan Mantey sensorNames = 286249c53ac9SJohnathan Mantey std::make_shared<boost::container::flat_set<std::string>>(); 2863f65af9e8SRichard Marian Thomaiyar for (const auto& item : overrideMap) 2864413961deSRichard Marian Thomaiyar { 2865f65af9e8SRichard Marian Thomaiyar const auto& sensor = item.first; 286649c53ac9SJohnathan Mantey if (!findSensorNameUsingSensorPath(sensor, *sensorsList, 286749c53ac9SJohnathan Mantey *sensorNames)) 2868f65af9e8SRichard Marian Thomaiyar { 2869f65af9e8SRichard Marian Thomaiyar BMCWEB_LOG_INFO << "Unable to find memberId " << item.first; 28708d1b46d7Szhanghch05 messages::resourceNotFound(sensorAsyncResp->asyncResp->res, 2871f65af9e8SRichard Marian Thomaiyar item.second.second, item.first); 2872413961deSRichard Marian Thomaiyar return; 2873413961deSRichard Marian Thomaiyar } 2874f65af9e8SRichard Marian Thomaiyar } 2875413961deSRichard Marian Thomaiyar // Get the connection to which the memberId belongs 2876413961deSRichard Marian Thomaiyar auto getObjectsWithConnectionCb = 2877f65af9e8SRichard Marian Thomaiyar [sensorAsyncResp, overrideMap]( 2878cb13a392SEd Tanous const boost::container::flat_set<std::string>& /*connections*/, 2879413961deSRichard Marian Thomaiyar const std::set<std::pair<std::string, std::string>>& 2880413961deSRichard Marian Thomaiyar objectsWithConnection) { 2881f65af9e8SRichard Marian Thomaiyar if (objectsWithConnection.size() != overrideMap.size()) 2882413961deSRichard Marian Thomaiyar { 2883413961deSRichard Marian Thomaiyar BMCWEB_LOG_INFO 2884f65af9e8SRichard Marian Thomaiyar << "Unable to find all objects with proper connection " 2885f65af9e8SRichard Marian Thomaiyar << objectsWithConnection.size() << " requested " 2886f65af9e8SRichard Marian Thomaiyar << overrideMap.size() << "\n"; 2887413961deSRichard Marian Thomaiyar messages::resourceNotFound( 28888d1b46d7Szhanghch05 sensorAsyncResp->asyncResp->res, 2889a0ec28b6SAdrian Ambrożewicz sensorAsyncResp->chassisSubNode == 2890a0ec28b6SAdrian Ambrożewicz sensors::node::thermal 2891413961deSRichard Marian Thomaiyar ? "Temperatures" 2892413961deSRichard Marian Thomaiyar : "Voltages", 2893f65af9e8SRichard Marian Thomaiyar "Count"); 2894f65af9e8SRichard Marian Thomaiyar return; 2895f65af9e8SRichard Marian Thomaiyar } 2896f65af9e8SRichard Marian Thomaiyar for (const auto& item : objectsWithConnection) 2897f65af9e8SRichard Marian Thomaiyar { 289828aa8de5SGeorge Liu sdbusplus::message::object_path path(item.first); 289928aa8de5SGeorge Liu std::string sensorName = path.filename(); 290028aa8de5SGeorge Liu if (sensorName.empty()) 2901f65af9e8SRichard Marian Thomaiyar { 29028d1b46d7Szhanghch05 messages::internalError( 29038d1b46d7Szhanghch05 sensorAsyncResp->asyncResp->res); 2904f65af9e8SRichard Marian Thomaiyar return; 2905f65af9e8SRichard Marian Thomaiyar } 2906f65af9e8SRichard Marian Thomaiyar 2907f65af9e8SRichard Marian Thomaiyar const auto& iterator = overrideMap.find(sensorName); 2908f65af9e8SRichard Marian Thomaiyar if (iterator == overrideMap.end()) 2909f65af9e8SRichard Marian Thomaiyar { 2910f65af9e8SRichard Marian Thomaiyar BMCWEB_LOG_INFO << "Unable to find sensor object" 2911f65af9e8SRichard Marian Thomaiyar << item.first << "\n"; 29128d1b46d7Szhanghch05 messages::internalError( 29138d1b46d7Szhanghch05 sensorAsyncResp->asyncResp->res); 2914413961deSRichard Marian Thomaiyar return; 2915413961deSRichard Marian Thomaiyar } 2916413961deSRichard Marian Thomaiyar crow::connections::systemBus->async_method_call( 2917f65af9e8SRichard Marian Thomaiyar [sensorAsyncResp](const boost::system::error_code ec) { 2918413961deSRichard Marian Thomaiyar if (ec) 2919413961deSRichard Marian Thomaiyar { 2920413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG 2921f65af9e8SRichard Marian Thomaiyar << "setOverrideValueStatus DBUS error: " 2922413961deSRichard Marian Thomaiyar << ec; 29238d1b46d7Szhanghch05 messages::internalError( 29248d1b46d7Szhanghch05 sensorAsyncResp->asyncResp->res); 2925413961deSRichard Marian Thomaiyar return; 2926413961deSRichard Marian Thomaiyar } 2927413961deSRichard Marian Thomaiyar }, 2928f65af9e8SRichard Marian Thomaiyar item.second, item.first, 2929413961deSRichard Marian Thomaiyar "org.freedesktop.DBus.Properties", "Set", 2930413961deSRichard Marian Thomaiyar "xyz.openbmc_project.Sensor.Value", "Value", 293119bd78d9SPatrick Williams std::variant<double>(iterator->second.first)); 2932f65af9e8SRichard Marian Thomaiyar } 2933413961deSRichard Marian Thomaiyar }; 2934413961deSRichard Marian Thomaiyar // Get object with connection for the given sensor name 2935413961deSRichard Marian Thomaiyar getObjectsWithConnection(sensorAsyncResp, sensorNames, 2936413961deSRichard Marian Thomaiyar std::move(getObjectsWithConnectionCb)); 2937413961deSRichard Marian Thomaiyar }; 2938413961deSRichard Marian Thomaiyar // get full sensor list for the given chassisId and cross verify the sensor. 2939413961deSRichard Marian Thomaiyar getChassis(sensorAsyncResp, std::move(getChassisSensorListCb)); 2940413961deSRichard Marian Thomaiyar } 2941413961deSRichard Marian Thomaiyar 2942a0ec28b6SAdrian Ambrożewicz /** 2943a0ec28b6SAdrian Ambrożewicz * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus 2944a0ec28b6SAdrian Ambrożewicz * path of the sensor. 2945a0ec28b6SAdrian Ambrożewicz * 2946a0ec28b6SAdrian Ambrożewicz * Function builds valid Redfish response for sensor query of given chassis and 2947a0ec28b6SAdrian Ambrożewicz * node. It then builds metadata about Redfish<->D-Bus correlations and provides 2948a0ec28b6SAdrian Ambrożewicz * it to caller in a callback. 2949a0ec28b6SAdrian Ambrożewicz * 2950a0ec28b6SAdrian Ambrożewicz * @param chassis Chassis for which retrieval should be performed 2951a0ec28b6SAdrian Ambrożewicz * @param node Node (group) of sensors. See sensors::node for supported values 2952a0ec28b6SAdrian Ambrożewicz * @param mapComplete Callback to be called with retrieval result 2953a0ec28b6SAdrian Ambrożewicz */ 295423a21a1cSEd Tanous inline void retrieveUriToDbusMap(const std::string& chassis, 295523a21a1cSEd Tanous const std::string& node, 2956a0ec28b6SAdrian Ambrożewicz SensorsAsyncResp::DataCompleteCb&& mapComplete) 2957a0ec28b6SAdrian Ambrożewicz { 2958c2bf7f99SWludzik, Jozef auto pathIt = sensors::dbus::paths.find(node); 2959c2bf7f99SWludzik, Jozef if (pathIt == sensors::dbus::paths.end()) 2960a0ec28b6SAdrian Ambrożewicz { 2961a0ec28b6SAdrian Ambrożewicz BMCWEB_LOG_ERROR << "Wrong node provided : " << node; 2962a0ec28b6SAdrian Ambrożewicz mapComplete(boost::beast::http::status::bad_request, {}); 2963a0ec28b6SAdrian Ambrożewicz return; 2964a0ec28b6SAdrian Ambrożewicz } 2965d51e072fSKrzysztof Grobelny 2966d51e072fSKrzysztof Grobelny auto res = std::make_shared<crow::Response>(); 2967d51e072fSKrzysztof Grobelny auto asyncResp = std::make_shared<bmcweb::AsyncResp>(*res); 2968a0ec28b6SAdrian Ambrożewicz auto callback = 2969d51e072fSKrzysztof Grobelny [res, asyncResp, mapCompleteCb{std::move(mapComplete)}]( 2970a0ec28b6SAdrian Ambrożewicz const boost::beast::http::status status, 2971a0ec28b6SAdrian Ambrożewicz const boost::container::flat_map<std::string, std::string>& 2972a0ec28b6SAdrian Ambrożewicz uriToDbus) { mapCompleteCb(status, uriToDbus); }; 2973a0ec28b6SAdrian Ambrożewicz 2974a0ec28b6SAdrian Ambrożewicz auto resp = std::make_shared<SensorsAsyncResp>( 2975d51e072fSKrzysztof Grobelny asyncResp, chassis, pathIt->second, node, std::move(callback)); 2976a0ec28b6SAdrian Ambrożewicz getChassisData(resp); 2977a0ec28b6SAdrian Ambrożewicz } 2978a0ec28b6SAdrian Ambrożewicz 29797e860f15SJohn Edward Broadbent inline void requestRoutesSensorCollection(App& app) 298095a3ecadSAnthony Wilson { 29817e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/") 2982*ed398213SEd Tanous .privileges(redfish::privileges::getSensorCollection) 29837e860f15SJohn Edward Broadbent .methods( 29847e860f15SJohn Edward Broadbent boost::beast::http::verb::get)([](const crow::Request&, 29857e860f15SJohn Edward Broadbent const std::shared_ptr< 29867e860f15SJohn Edward Broadbent bmcweb::AsyncResp>& aResp, 29877e860f15SJohn Edward Broadbent const std::string& chassisId) { 298895a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "SensorCollection doGet enter"; 29898d1b46d7Szhanghch05 299095a3ecadSAnthony Wilson std::shared_ptr<SensorsAsyncResp> asyncResp = 2991a0ec28b6SAdrian Ambrożewicz std::make_shared<SensorsAsyncResp>( 29928d1b46d7Szhanghch05 aResp, chassisId, 29938d1b46d7Szhanghch05 sensors::dbus::paths.at(sensors::node::sensors), 2994a0ec28b6SAdrian Ambrożewicz sensors::node::sensors); 299595a3ecadSAnthony Wilson 299695a3ecadSAnthony Wilson auto getChassisCb = 2997b5a76932SEd Tanous [asyncResp]( 29987e860f15SJohn Edward Broadbent const std::shared_ptr< 29997e860f15SJohn Edward Broadbent boost::container::flat_set<std::string>>& sensorNames) { 300095a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb enter"; 300195a3ecadSAnthony Wilson 300295a3ecadSAnthony Wilson nlohmann::json& entriesArray = 30038d1b46d7Szhanghch05 asyncResp->asyncResp->res.jsonValue["Members"]; 300495a3ecadSAnthony Wilson for (auto& sensor : *sensorNames) 300595a3ecadSAnthony Wilson { 300695a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Adding sensor: " << sensor; 300795a3ecadSAnthony Wilson 300828aa8de5SGeorge Liu sdbusplus::message::object_path path(sensor); 300928aa8de5SGeorge Liu std::string sensorName = path.filename(); 301028aa8de5SGeorge Liu if (sensorName.empty()) 301195a3ecadSAnthony Wilson { 30127e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "Invalid sensor path: " 30137e860f15SJohn Edward Broadbent << sensor; 30148d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 301595a3ecadSAnthony Wilson return; 301695a3ecadSAnthony Wilson } 301795a3ecadSAnthony Wilson entriesArray.push_back( 30187e860f15SJohn Edward Broadbent {{"@odata.id", "/redfish/v1/Chassis/" + 30197e860f15SJohn Edward Broadbent asyncResp->chassisId + "/" + 30207e860f15SJohn Edward Broadbent asyncResp->chassisSubNode + "/" + 30217e860f15SJohn Edward Broadbent sensorName}}); 302295a3ecadSAnthony Wilson } 302395a3ecadSAnthony Wilson 30248d1b46d7Szhanghch05 asyncResp->asyncResp->res.jsonValue["Members@odata.count"] = 302595a3ecadSAnthony Wilson entriesArray.size(); 302695a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb exit"; 302795a3ecadSAnthony Wilson }; 302895a3ecadSAnthony Wilson 302995a3ecadSAnthony Wilson // Get set of sensors in chassis 303095a3ecadSAnthony Wilson getChassis(asyncResp, std::move(getChassisCb)); 303195a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "SensorCollection doGet exit"; 30327e860f15SJohn Edward Broadbent }); 303395a3ecadSAnthony Wilson } 303495a3ecadSAnthony Wilson 30357e860f15SJohn Edward Broadbent inline void requestRoutesSensor(App& app) 303695a3ecadSAnthony Wilson { 30377e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/") 3038*ed398213SEd Tanous .privileges(redfish::privileges::getSensor) 30397e860f15SJohn Edward Broadbent .methods( 30407e860f15SJohn Edward Broadbent boost::beast::http::verb::get)([](const crow::Request&, 30417e860f15SJohn Edward Broadbent const std::shared_ptr< 30427e860f15SJohn Edward Broadbent bmcweb::AsyncResp>& aResp, 30437e860f15SJohn Edward Broadbent const std::string& chassisId, 30447e860f15SJohn Edward Broadbent const std::string& sensorName) { 304595a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Sensor doGet enter"; 304695a3ecadSAnthony Wilson std::shared_ptr<SensorsAsyncResp> asyncResp = 30478d1b46d7Szhanghch05 std::make_shared<SensorsAsyncResp>(aResp, chassisId, 3048a0ec28b6SAdrian Ambrożewicz std::vector<const char*>(), 3049a0ec28b6SAdrian Ambrożewicz sensors::node::sensors); 305095a3ecadSAnthony Wilson 305195a3ecadSAnthony Wilson const std::array<const char*, 1> interfaces = { 305295a3ecadSAnthony Wilson "xyz.openbmc_project.Sensor.Value"}; 305395a3ecadSAnthony Wilson 305495a3ecadSAnthony Wilson // Get a list of all of the sensors that implement Sensor.Value 305595a3ecadSAnthony Wilson // and get the path and service name associated with the sensor 305695a3ecadSAnthony Wilson crow::connections::systemBus->async_method_call( 305795a3ecadSAnthony Wilson [asyncResp, sensorName](const boost::system::error_code ec, 305895a3ecadSAnthony Wilson const GetSubTreeType& subtree) { 305995a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "respHandler1 enter"; 306095a3ecadSAnthony Wilson if (ec) 306195a3ecadSAnthony Wilson { 30628d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 30637e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR 30647e860f15SJohn Edward Broadbent << "Sensor getSensorPaths resp_handler: " 306595a3ecadSAnthony Wilson << "Dbus error " << ec; 306695a3ecadSAnthony Wilson return; 306795a3ecadSAnthony Wilson } 306895a3ecadSAnthony Wilson 306995a3ecadSAnthony Wilson GetSubTreeType::const_iterator it = std::find_if( 307095a3ecadSAnthony Wilson subtree.begin(), subtree.end(), 307195a3ecadSAnthony Wilson [sensorName]( 307295a3ecadSAnthony Wilson const std::pair< 307395a3ecadSAnthony Wilson std::string, 30747e860f15SJohn Edward Broadbent std::vector<std::pair< 30757e860f15SJohn Edward Broadbent std::string, std::vector<std::string>>>>& 307695a3ecadSAnthony Wilson object) { 307728aa8de5SGeorge Liu sdbusplus::message::object_path path(object.first); 307828aa8de5SGeorge Liu std::string name = path.filename(); 307928aa8de5SGeorge Liu if (name.empty()) 308095a3ecadSAnthony Wilson { 308195a3ecadSAnthony Wilson BMCWEB_LOG_ERROR << "Invalid sensor path: " 308228aa8de5SGeorge Liu << object.first; 308395a3ecadSAnthony Wilson return false; 308495a3ecadSAnthony Wilson } 308595a3ecadSAnthony Wilson 308695a3ecadSAnthony Wilson return name == sensorName; 308795a3ecadSAnthony Wilson }); 308895a3ecadSAnthony Wilson 308995a3ecadSAnthony Wilson if (it == subtree.end()) 309095a3ecadSAnthony Wilson { 309195a3ecadSAnthony Wilson BMCWEB_LOG_ERROR << "Could not find path for sensor: " 309295a3ecadSAnthony Wilson << sensorName; 30938d1b46d7Szhanghch05 messages::resourceNotFound(asyncResp->asyncResp->res, 30948d1b46d7Szhanghch05 "Sensor", sensorName); 309595a3ecadSAnthony Wilson return; 309695a3ecadSAnthony Wilson } 309795a3ecadSAnthony Wilson std::string_view sensorPath = (*it).first; 309895a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Found sensor path for sensor '" 309995a3ecadSAnthony Wilson << sensorName << "': " << sensorPath; 310095a3ecadSAnthony Wilson 31017e860f15SJohn Edward Broadbent const std::shared_ptr< 31027e860f15SJohn Edward Broadbent boost::container::flat_set<std::string>> 310395a3ecadSAnthony Wilson sensorList = std::make_shared< 310495a3ecadSAnthony Wilson boost::container::flat_set<std::string>>(); 310595a3ecadSAnthony Wilson 310695a3ecadSAnthony Wilson sensorList->emplace(sensorPath); 310795a3ecadSAnthony Wilson processSensorList(asyncResp, sensorList); 310895a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "respHandler1 exit"; 310995a3ecadSAnthony Wilson }, 311095a3ecadSAnthony Wilson "xyz.openbmc_project.ObjectMapper", 311195a3ecadSAnthony Wilson "/xyz/openbmc_project/object_mapper", 311295a3ecadSAnthony Wilson "xyz.openbmc_project.ObjectMapper", "GetSubTree", 311395a3ecadSAnthony Wilson "/xyz/openbmc_project/sensors", 2, interfaces); 31147e860f15SJohn Edward Broadbent }); 311595a3ecadSAnthony Wilson } 311695a3ecadSAnthony Wilson 311708777fb0SLewanczyk, Dawid } // namespace redfish 3118