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*168e20c1SEd Tanous #include <dbus_utility.hpp> 25ed398213SEd Tanous #include <registries/privilege_registry.hpp> 26413961deSRichard Marian Thomaiyar #include <utils/json_utils.hpp> 271214b7e7SGunnar Mills 281214b7e7SGunnar Mills #include <cmath> 29b5a76932SEd Tanous #include <utility> 30abf2add6SEd Tanous #include <variant> 3108777fb0SLewanczyk, Dawid 321abe55efSEd Tanous namespace redfish 331abe55efSEd Tanous { 3408777fb0SLewanczyk, Dawid 3508777fb0SLewanczyk, Dawid using GetSubTreeType = std::vector< 3608777fb0SLewanczyk, Dawid std::pair<std::string, 3708777fb0SLewanczyk, Dawid std::vector<std::pair<std::string, std::vector<std::string>>>>>; 3808777fb0SLewanczyk, Dawid 3908777fb0SLewanczyk, Dawid using ManagedObjectsVectorType = std::vector<std::pair< 40aa2e59c1SEd Tanous sdbusplus::message::object_path, 4108777fb0SLewanczyk, Dawid boost::container::flat_map< 42*168e20c1SEd Tanous std::string, boost::container::flat_map< 43*168e20c1SEd Tanous std::string, dbus::utility::DbusVariantType>>>>; 4408777fb0SLewanczyk, Dawid 45a0ec28b6SAdrian Ambrożewicz namespace sensors 46a0ec28b6SAdrian Ambrożewicz { 47a0ec28b6SAdrian Ambrożewicz namespace node 48a0ec28b6SAdrian Ambrożewicz { 49a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view power = "Power"; 50a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view sensors = "Sensors"; 51a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view thermal = "Thermal"; 52a0ec28b6SAdrian Ambrożewicz } // namespace node 53a0ec28b6SAdrian Ambrożewicz 54a0ec28b6SAdrian Ambrożewicz namespace dbus 55a0ec28b6SAdrian Ambrożewicz { 56c2bf7f99SWludzik, Jozef 57a0ec28b6SAdrian Ambrożewicz static const boost::container::flat_map<std::string_view, 58a0ec28b6SAdrian Ambrożewicz std::vector<const char*>> 59c2bf7f99SWludzik, Jozef paths = {{node::power, 60a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/voltage", 61a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/power"}}, 62a0ec28b6SAdrian Ambrożewicz {node::sensors, 63a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/power", 64a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/current", 657088690cSBasheer Ahmed Muddebihal "/xyz/openbmc_project/sensors/airflow", 66e8204933SGeorge Liu #ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM 67e8204933SGeorge Liu "/xyz/openbmc_project/sensors/voltage", 68e8204933SGeorge Liu "/xyz/openbmc_project/sensors/fan_tach", 69e8204933SGeorge Liu "/xyz/openbmc_project/sensors/temperature", 70e8204933SGeorge Liu "/xyz/openbmc_project/sensors/fan_pwm", 71e8204933SGeorge Liu "/xyz/openbmc_project/sensors/altitude", 72e8204933SGeorge Liu "/xyz/openbmc_project/sensors/energy", 73e8204933SGeorge Liu #endif 74a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/utilization"}}, 75a0ec28b6SAdrian Ambrożewicz {node::thermal, 76a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/fan_tach", 77a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/temperature", 78a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/fan_pwm"}}}; 79c2bf7f99SWludzik, Jozef } // namespace dbus 80c2bf7f99SWludzik, Jozef 81c2bf7f99SWludzik, Jozef inline const char* toReadingType(const std::string& sensorType) 82c2bf7f99SWludzik, Jozef { 83c2bf7f99SWludzik, Jozef if (sensorType == "voltage") 84c2bf7f99SWludzik, Jozef { 85c2bf7f99SWludzik, Jozef return "Voltage"; 86c2bf7f99SWludzik, Jozef } 87c2bf7f99SWludzik, Jozef if (sensorType == "power") 88c2bf7f99SWludzik, Jozef { 89c2bf7f99SWludzik, Jozef return "Power"; 90c2bf7f99SWludzik, Jozef } 91c2bf7f99SWludzik, Jozef if (sensorType == "current") 92c2bf7f99SWludzik, Jozef { 93c2bf7f99SWludzik, Jozef return "Current"; 94c2bf7f99SWludzik, Jozef } 95c2bf7f99SWludzik, Jozef if (sensorType == "fan_tach") 96c2bf7f99SWludzik, Jozef { 97c2bf7f99SWludzik, Jozef return "Rotational"; 98c2bf7f99SWludzik, Jozef } 99c2bf7f99SWludzik, Jozef if (sensorType == "temperature") 100c2bf7f99SWludzik, Jozef { 101c2bf7f99SWludzik, Jozef return "Temperature"; 102c2bf7f99SWludzik, Jozef } 103c2bf7f99SWludzik, Jozef if (sensorType == "fan_pwm" || sensorType == "utilization") 104c2bf7f99SWludzik, Jozef { 105c2bf7f99SWludzik, Jozef return "Percent"; 106c2bf7f99SWludzik, Jozef } 107c2bf7f99SWludzik, Jozef if (sensorType == "altitude") 108c2bf7f99SWludzik, Jozef { 109c2bf7f99SWludzik, Jozef return "Altitude"; 110c2bf7f99SWludzik, Jozef } 111c2bf7f99SWludzik, Jozef if (sensorType == "airflow") 112c2bf7f99SWludzik, Jozef { 113c2bf7f99SWludzik, Jozef return "AirFlow"; 114c2bf7f99SWludzik, Jozef } 115c2bf7f99SWludzik, Jozef if (sensorType == "energy") 116c2bf7f99SWludzik, Jozef { 117c2bf7f99SWludzik, Jozef return "EnergyJoules"; 118c2bf7f99SWludzik, Jozef } 119c2bf7f99SWludzik, Jozef return ""; 120c2bf7f99SWludzik, Jozef } 121c2bf7f99SWludzik, Jozef 122c2bf7f99SWludzik, Jozef inline const char* toReadingUnits(const std::string& sensorType) 123c2bf7f99SWludzik, Jozef { 124c2bf7f99SWludzik, Jozef if (sensorType == "voltage") 125c2bf7f99SWludzik, Jozef { 126c2bf7f99SWludzik, Jozef return "V"; 127c2bf7f99SWludzik, Jozef } 128c2bf7f99SWludzik, Jozef if (sensorType == "power") 129c2bf7f99SWludzik, Jozef { 130c2bf7f99SWludzik, Jozef return "W"; 131c2bf7f99SWludzik, Jozef } 132c2bf7f99SWludzik, Jozef if (sensorType == "current") 133c2bf7f99SWludzik, Jozef { 134c2bf7f99SWludzik, Jozef return "A"; 135c2bf7f99SWludzik, Jozef } 136c2bf7f99SWludzik, Jozef if (sensorType == "fan_tach") 137c2bf7f99SWludzik, Jozef { 138c2bf7f99SWludzik, Jozef return "RPM"; 139c2bf7f99SWludzik, Jozef } 140c2bf7f99SWludzik, Jozef if (sensorType == "temperature") 141c2bf7f99SWludzik, Jozef { 142c2bf7f99SWludzik, Jozef return "Cel"; 143c2bf7f99SWludzik, Jozef } 144c2bf7f99SWludzik, Jozef if (sensorType == "fan_pwm" || sensorType == "utilization") 145c2bf7f99SWludzik, Jozef { 146c2bf7f99SWludzik, Jozef return "%"; 147c2bf7f99SWludzik, Jozef } 148c2bf7f99SWludzik, Jozef if (sensorType == "altitude") 149c2bf7f99SWludzik, Jozef { 150c2bf7f99SWludzik, Jozef return "m"; 151c2bf7f99SWludzik, Jozef } 152c2bf7f99SWludzik, Jozef if (sensorType == "airflow") 153c2bf7f99SWludzik, Jozef { 154c2bf7f99SWludzik, Jozef return "cft_i/min"; 155c2bf7f99SWludzik, Jozef } 156c2bf7f99SWludzik, Jozef if (sensorType == "energy") 157c2bf7f99SWludzik, Jozef { 158c2bf7f99SWludzik, Jozef return "J"; 159c2bf7f99SWludzik, Jozef } 160c2bf7f99SWludzik, Jozef return ""; 161a0ec28b6SAdrian Ambrożewicz } 162a0ec28b6SAdrian Ambrożewicz } // namespace sensors 163a0ec28b6SAdrian Ambrożewicz 16408777fb0SLewanczyk, Dawid /** 165588c3f0dSKowalski, Kamil * SensorsAsyncResp 16608777fb0SLewanczyk, Dawid * Gathers data needed for response processing after async calls are done 16708777fb0SLewanczyk, Dawid */ 1681abe55efSEd Tanous class SensorsAsyncResp 1691abe55efSEd Tanous { 17008777fb0SLewanczyk, Dawid public: 171a0ec28b6SAdrian Ambrożewicz using DataCompleteCb = std::function<void( 172a0ec28b6SAdrian Ambrożewicz const boost::beast::http::status status, 173a0ec28b6SAdrian Ambrożewicz const boost::container::flat_map<std::string, std::string>& uriToDbus)>; 174a0ec28b6SAdrian Ambrożewicz 175a0ec28b6SAdrian Ambrożewicz struct SensorData 176a0ec28b6SAdrian Ambrożewicz { 177a0ec28b6SAdrian Ambrożewicz const std::string name; 178a0ec28b6SAdrian Ambrożewicz std::string uri; 179a0ec28b6SAdrian Ambrożewicz const std::string valueKey; 180a0ec28b6SAdrian Ambrożewicz const std::string dbusPath; 181a0ec28b6SAdrian Ambrożewicz }; 182a0ec28b6SAdrian Ambrożewicz 1838d1b46d7Szhanghch05 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1848d1b46d7Szhanghch05 const std::string& chassisIdIn, 185b5a76932SEd Tanous const std::vector<const char*>& typesIn, 186a0ec28b6SAdrian Ambrożewicz const std::string_view& subNode) : 1878d1b46d7Szhanghch05 asyncResp(asyncResp), 188271584abSEd Tanous chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode) 1891214b7e7SGunnar Mills {} 19008777fb0SLewanczyk, Dawid 191a0ec28b6SAdrian Ambrożewicz // Store extra data about sensor mapping and return it in callback 1928d1b46d7Szhanghch05 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1938d1b46d7Szhanghch05 const std::string& chassisIdIn, 194b5a76932SEd Tanous const std::vector<const char*>& typesIn, 195a0ec28b6SAdrian Ambrożewicz const std::string_view& subNode, 196a0ec28b6SAdrian Ambrożewicz DataCompleteCb&& creationComplete) : 1978d1b46d7Szhanghch05 asyncResp(asyncResp), 198a0ec28b6SAdrian Ambrożewicz chassisId(chassisIdIn), types(typesIn), 199a0ec28b6SAdrian Ambrożewicz chassisSubNode(subNode), metadata{std::vector<SensorData>()}, 200a0ec28b6SAdrian Ambrożewicz dataComplete{std::move(creationComplete)} 201a0ec28b6SAdrian Ambrożewicz {} 202a0ec28b6SAdrian Ambrożewicz 2031abe55efSEd Tanous ~SensorsAsyncResp() 2041abe55efSEd Tanous { 2058d1b46d7Szhanghch05 if (asyncResp->res.result() == 2068d1b46d7Szhanghch05 boost::beast::http::status::internal_server_error) 2071abe55efSEd Tanous { 2081abe55efSEd Tanous // Reset the json object to clear out any data that made it in 2091abe55efSEd Tanous // before the error happened todo(ed) handle error condition with 2101abe55efSEd Tanous // proper code 2118d1b46d7Szhanghch05 asyncResp->res.jsonValue = nlohmann::json::object(); 21208777fb0SLewanczyk, Dawid } 213a0ec28b6SAdrian Ambrożewicz 214a0ec28b6SAdrian Ambrożewicz if (dataComplete && metadata) 215a0ec28b6SAdrian Ambrożewicz { 216a0ec28b6SAdrian Ambrożewicz boost::container::flat_map<std::string, std::string> map; 2178d1b46d7Szhanghch05 if (asyncResp->res.result() == boost::beast::http::status::ok) 218a0ec28b6SAdrian Ambrożewicz { 219a0ec28b6SAdrian Ambrożewicz for (auto& sensor : *metadata) 220a0ec28b6SAdrian Ambrożewicz { 221a0ec28b6SAdrian Ambrożewicz map.insert(std::make_pair(sensor.uri + sensor.valueKey, 222a0ec28b6SAdrian Ambrożewicz sensor.dbusPath)); 223a0ec28b6SAdrian Ambrożewicz } 224a0ec28b6SAdrian Ambrożewicz } 2258d1b46d7Szhanghch05 dataComplete(asyncResp->res.result(), map); 226a0ec28b6SAdrian Ambrożewicz } 22708777fb0SLewanczyk, Dawid } 228588c3f0dSKowalski, Kamil 229a0ec28b6SAdrian Ambrożewicz void addMetadata(const nlohmann::json& sensorObject, 230a0ec28b6SAdrian Ambrożewicz const std::string& valueKey, const std::string& dbusPath) 231a0ec28b6SAdrian Ambrożewicz { 232a0ec28b6SAdrian Ambrożewicz if (metadata) 233a0ec28b6SAdrian Ambrożewicz { 234a0ec28b6SAdrian Ambrożewicz metadata->emplace_back(SensorData{sensorObject["Name"], 235a0ec28b6SAdrian Ambrożewicz sensorObject["@odata.id"], 236a0ec28b6SAdrian Ambrożewicz valueKey, dbusPath}); 237a0ec28b6SAdrian Ambrożewicz } 238a0ec28b6SAdrian Ambrożewicz } 239a0ec28b6SAdrian Ambrożewicz 240a0ec28b6SAdrian Ambrożewicz void updateUri(const std::string& name, const std::string& uri) 241a0ec28b6SAdrian Ambrożewicz { 242a0ec28b6SAdrian Ambrożewicz if (metadata) 243a0ec28b6SAdrian Ambrożewicz { 244a0ec28b6SAdrian Ambrożewicz for (auto& sensor : *metadata) 245a0ec28b6SAdrian Ambrożewicz { 246a0ec28b6SAdrian Ambrożewicz if (sensor.name == name) 247a0ec28b6SAdrian Ambrożewicz { 248a0ec28b6SAdrian Ambrożewicz sensor.uri = uri; 249a0ec28b6SAdrian Ambrożewicz } 250a0ec28b6SAdrian Ambrożewicz } 251a0ec28b6SAdrian Ambrożewicz } 252a0ec28b6SAdrian Ambrożewicz } 253a0ec28b6SAdrian Ambrożewicz 2548d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp> asyncResp; 255a0ec28b6SAdrian Ambrożewicz const std::string chassisId; 25608777fb0SLewanczyk, Dawid const std::vector<const char*> types; 257a0ec28b6SAdrian Ambrożewicz const std::string chassisSubNode; 258a0ec28b6SAdrian Ambrożewicz 259a0ec28b6SAdrian Ambrożewicz private: 260a0ec28b6SAdrian Ambrożewicz std::optional<std::vector<SensorData>> metadata; 261a0ec28b6SAdrian Ambrożewicz DataCompleteCb dataComplete; 26208777fb0SLewanczyk, Dawid }; 26308777fb0SLewanczyk, Dawid 26408777fb0SLewanczyk, Dawid /** 265d500549bSAnthony Wilson * Possible states for physical inventory leds 266d500549bSAnthony Wilson */ 267d500549bSAnthony Wilson enum class LedState 268d500549bSAnthony Wilson { 269d500549bSAnthony Wilson OFF, 270d500549bSAnthony Wilson ON, 271d500549bSAnthony Wilson BLINK, 272d500549bSAnthony Wilson UNKNOWN 273d500549bSAnthony Wilson }; 274d500549bSAnthony Wilson 275d500549bSAnthony Wilson /** 276adc4f0dbSShawn McCarney * D-Bus inventory item associated with one or more sensors. 277adc4f0dbSShawn McCarney */ 278adc4f0dbSShawn McCarney class InventoryItem 279adc4f0dbSShawn McCarney { 280adc4f0dbSShawn McCarney public: 281adc4f0dbSShawn McCarney InventoryItem(const std::string& objPath) : 282adc4f0dbSShawn McCarney objectPath(objPath), name(), isPresent(true), isFunctional(true), 28342cbe538SGunnar Mills isPowerSupply(false), powerSupplyEfficiencyPercent(-1), manufacturer(), 28442cbe538SGunnar Mills model(), partNumber(), serialNumber(), sensors(), ledObjectPath(""), 285d500549bSAnthony Wilson ledState(LedState::UNKNOWN) 286adc4f0dbSShawn McCarney { 287adc4f0dbSShawn McCarney // Set inventory item name to last node of object path 28828aa8de5SGeorge Liu sdbusplus::message::object_path path(objectPath); 28928aa8de5SGeorge Liu name = path.filename(); 29028aa8de5SGeorge Liu if (name.empty()) 291adc4f0dbSShawn McCarney { 29228aa8de5SGeorge Liu BMCWEB_LOG_ERROR << "Failed to find '/' in " << objectPath; 293adc4f0dbSShawn McCarney } 294adc4f0dbSShawn McCarney } 295adc4f0dbSShawn McCarney 296adc4f0dbSShawn McCarney std::string objectPath; 297adc4f0dbSShawn McCarney std::string name; 298adc4f0dbSShawn McCarney bool isPresent; 299adc4f0dbSShawn McCarney bool isFunctional; 300adc4f0dbSShawn McCarney bool isPowerSupply; 30142cbe538SGunnar Mills int powerSupplyEfficiencyPercent; 302adc4f0dbSShawn McCarney std::string manufacturer; 303adc4f0dbSShawn McCarney std::string model; 304adc4f0dbSShawn McCarney std::string partNumber; 305adc4f0dbSShawn McCarney std::string serialNumber; 306adc4f0dbSShawn McCarney std::set<std::string> sensors; 307d500549bSAnthony Wilson std::string ledObjectPath; 308d500549bSAnthony Wilson LedState ledState; 309adc4f0dbSShawn McCarney }; 310adc4f0dbSShawn McCarney 311adc4f0dbSShawn McCarney /** 312413961deSRichard Marian Thomaiyar * @brief Get objects with connection necessary for sensors 313588c3f0dSKowalski, Kamil * @param SensorsAsyncResp Pointer to object holding response data 31408777fb0SLewanczyk, Dawid * @param sensorNames Sensors retrieved from chassis 31508777fb0SLewanczyk, Dawid * @param callback Callback for processing gathered connections 31608777fb0SLewanczyk, Dawid */ 31708777fb0SLewanczyk, Dawid template <typename Callback> 318413961deSRichard Marian Thomaiyar void getObjectsWithConnection( 31981ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 320b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 3211abe55efSEd Tanous Callback&& callback) 3221abe55efSEd Tanous { 323413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection enter"; 32403b5bae3SJames Feist const std::string path = "/xyz/openbmc_project/sensors"; 32508777fb0SLewanczyk, Dawid const std::array<std::string, 1> interfaces = { 32608777fb0SLewanczyk, Dawid "xyz.openbmc_project.Sensor.Value"}; 32708777fb0SLewanczyk, Dawid 32808777fb0SLewanczyk, Dawid // Response handler for parsing objects subtree 32981ce609eSEd Tanous auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 3301abe55efSEd Tanous sensorNames](const boost::system::error_code ec, 3311abe55efSEd Tanous const GetSubTreeType& subtree) { 332413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler enter"; 3331abe55efSEd Tanous if (ec) 3341abe55efSEd Tanous { 3358d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 336413961deSRichard Marian Thomaiyar BMCWEB_LOG_ERROR 337413961deSRichard Marian Thomaiyar << "getObjectsWithConnection resp_handler: Dbus error " << ec; 33808777fb0SLewanczyk, Dawid return; 33908777fb0SLewanczyk, Dawid } 34008777fb0SLewanczyk, Dawid 34155c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Found " << subtree.size() << " subtrees"; 34208777fb0SLewanczyk, Dawid 34308777fb0SLewanczyk, Dawid // Make unique list of connections only for requested sensor types and 34408777fb0SLewanczyk, Dawid // found in the chassis 34508777fb0SLewanczyk, Dawid boost::container::flat_set<std::string> connections; 346413961deSRichard Marian Thomaiyar std::set<std::pair<std::string, std::string>> objectsWithConnection; 3471abe55efSEd Tanous // Intrinsic to avoid malloc. Most systems will have < 8 sensor 3481abe55efSEd Tanous // producers 34908777fb0SLewanczyk, Dawid connections.reserve(8); 35008777fb0SLewanczyk, Dawid 35149c53ac9SJohnathan Mantey BMCWEB_LOG_DEBUG << "sensorNames list count: " << sensorNames->size(); 35249c53ac9SJohnathan Mantey for (const std::string& tsensor : *sensorNames) 3531abe55efSEd Tanous { 35455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Sensor to find: " << tsensor; 35508777fb0SLewanczyk, Dawid } 35608777fb0SLewanczyk, Dawid 35708777fb0SLewanczyk, Dawid for (const std::pair< 35808777fb0SLewanczyk, Dawid std::string, 35908777fb0SLewanczyk, Dawid std::vector<std::pair<std::string, std::vector<std::string>>>>& 3601abe55efSEd Tanous object : subtree) 3611abe55efSEd Tanous { 36249c53ac9SJohnathan Mantey if (sensorNames->find(object.first) != sensorNames->end()) 3631abe55efSEd Tanous { 36449c53ac9SJohnathan Mantey for (const std::pair<std::string, std::vector<std::string>>& 3651abe55efSEd Tanous objData : object.second) 3661abe55efSEd Tanous { 36749c53ac9SJohnathan Mantey BMCWEB_LOG_DEBUG << "Adding connection: " << objData.first; 36808777fb0SLewanczyk, Dawid connections.insert(objData.first); 369de629b6eSShawn McCarney objectsWithConnection.insert( 370de629b6eSShawn McCarney std::make_pair(object.first, objData.first)); 37108777fb0SLewanczyk, Dawid } 37208777fb0SLewanczyk, Dawid } 37308777fb0SLewanczyk, Dawid } 37455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Found " << connections.size() << " connections"; 375413961deSRichard Marian Thomaiyar callback(std::move(connections), std::move(objectsWithConnection)); 376413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler exit"; 37708777fb0SLewanczyk, Dawid }; 37808777fb0SLewanczyk, Dawid // Make call to ObjectMapper to find all sensors objects 37955c7b7a2SEd Tanous crow::connections::systemBus->async_method_call( 38055c7b7a2SEd Tanous std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 3811abe55efSEd Tanous "/xyz/openbmc_project/object_mapper", 3821abe55efSEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 2, interfaces); 383413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection exit"; 384413961deSRichard Marian Thomaiyar } 385413961deSRichard Marian Thomaiyar 386413961deSRichard Marian Thomaiyar /** 387413961deSRichard Marian Thomaiyar * @brief Create connections necessary for sensors 388413961deSRichard Marian Thomaiyar * @param SensorsAsyncResp Pointer to object holding response data 389413961deSRichard Marian Thomaiyar * @param sensorNames Sensors retrieved from chassis 390413961deSRichard Marian Thomaiyar * @param callback Callback for processing gathered connections 391413961deSRichard Marian Thomaiyar */ 392413961deSRichard Marian Thomaiyar template <typename Callback> 39349c53ac9SJohnathan Mantey void getConnections( 39481ce609eSEd Tanous std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 39549c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> sensorNames, 396413961deSRichard Marian Thomaiyar Callback&& callback) 397413961deSRichard Marian Thomaiyar { 398413961deSRichard Marian Thomaiyar auto objectsWithConnectionCb = 399413961deSRichard Marian Thomaiyar [callback](const boost::container::flat_set<std::string>& connections, 400413961deSRichard Marian Thomaiyar const std::set<std::pair<std::string, std::string>>& 4013174e4dfSEd Tanous /*objectsWithConnection*/) { callback(connections); }; 40281ce609eSEd Tanous getObjectsWithConnection(sensorsAsyncResp, sensorNames, 403413961deSRichard Marian Thomaiyar std::move(objectsWithConnectionCb)); 40408777fb0SLewanczyk, Dawid } 40508777fb0SLewanczyk, Dawid 40608777fb0SLewanczyk, Dawid /** 40749c53ac9SJohnathan Mantey * @brief Shrinks the list of sensors for processing 40849c53ac9SJohnathan Mantey * @param SensorsAysncResp The class holding the Redfish response 40949c53ac9SJohnathan Mantey * @param allSensors A list of all the sensors associated to the 41049c53ac9SJohnathan Mantey * chassis element (i.e. baseboard, front panel, etc...) 41149c53ac9SJohnathan Mantey * @param activeSensors A list that is a reduction of the incoming 41249c53ac9SJohnathan Mantey * allSensors list. Eliminate Thermal sensors when a Power request is 41349c53ac9SJohnathan Mantey * made, and eliminate Power sensors when a Thermal request is made. 41449c53ac9SJohnathan Mantey */ 41523a21a1cSEd Tanous inline void reduceSensorList( 41681ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 41749c53ac9SJohnathan Mantey const std::vector<std::string>* allSensors, 418b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& 419b5a76932SEd Tanous activeSensors) 42049c53ac9SJohnathan Mantey { 42181ce609eSEd Tanous if (sensorsAsyncResp == nullptr) 42249c53ac9SJohnathan Mantey { 42349c53ac9SJohnathan Mantey return; 42449c53ac9SJohnathan Mantey } 42549c53ac9SJohnathan Mantey if ((allSensors == nullptr) || (activeSensors == nullptr)) 42649c53ac9SJohnathan Mantey { 42749c53ac9SJohnathan Mantey messages::resourceNotFound( 4288d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res, sensorsAsyncResp->chassisSubNode, 42981ce609eSEd Tanous sensorsAsyncResp->chassisSubNode == sensors::node::thermal 430a0ec28b6SAdrian Ambrożewicz ? "Temperatures" 43149c53ac9SJohnathan Mantey : "Voltages"); 43249c53ac9SJohnathan Mantey 43349c53ac9SJohnathan Mantey return; 43449c53ac9SJohnathan Mantey } 43549c53ac9SJohnathan Mantey if (allSensors->empty()) 43649c53ac9SJohnathan Mantey { 43749c53ac9SJohnathan Mantey // Nothing to do, the activeSensors object is also empty 43849c53ac9SJohnathan Mantey return; 43949c53ac9SJohnathan Mantey } 44049c53ac9SJohnathan Mantey 44181ce609eSEd Tanous for (const char* type : sensorsAsyncResp->types) 44249c53ac9SJohnathan Mantey { 44349c53ac9SJohnathan Mantey for (const std::string& sensor : *allSensors) 44449c53ac9SJohnathan Mantey { 44549c53ac9SJohnathan Mantey if (boost::starts_with(sensor, type)) 44649c53ac9SJohnathan Mantey { 44749c53ac9SJohnathan Mantey activeSensors->emplace(sensor); 44849c53ac9SJohnathan Mantey } 44949c53ac9SJohnathan Mantey } 45049c53ac9SJohnathan Mantey } 45149c53ac9SJohnathan Mantey } 45249c53ac9SJohnathan Mantey 45349c53ac9SJohnathan Mantey /** 4544bb3dc34SCarol Wang * @brief Retrieves valid chassis path 4554bb3dc34SCarol Wang * @param asyncResp Pointer to object holding response data 4564bb3dc34SCarol Wang * @param callback Callback for next step to get valid chassis path 4574bb3dc34SCarol Wang */ 4584bb3dc34SCarol Wang template <typename Callback> 459b5a76932SEd Tanous void getValidChassisPath(const std::shared_ptr<SensorsAsyncResp>& asyncResp, 4604bb3dc34SCarol Wang Callback&& callback) 4614bb3dc34SCarol Wang { 4624bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "checkChassisId enter"; 4634bb3dc34SCarol Wang const std::array<const char*, 2> interfaces = { 4644bb3dc34SCarol Wang "xyz.openbmc_project.Inventory.Item.Board", 4654bb3dc34SCarol Wang "xyz.openbmc_project.Inventory.Item.Chassis"}; 4664bb3dc34SCarol Wang 4674bb3dc34SCarol Wang auto respHandler = 4684bb3dc34SCarol Wang [callback{std::move(callback)}, 4694bb3dc34SCarol Wang asyncResp](const boost::system::error_code ec, 4704bb3dc34SCarol Wang const std::vector<std::string>& chassisPaths) mutable { 4714bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "getValidChassisPath respHandler enter"; 4724bb3dc34SCarol Wang if (ec) 4734bb3dc34SCarol Wang { 4744bb3dc34SCarol Wang BMCWEB_LOG_ERROR 4754bb3dc34SCarol Wang << "getValidChassisPath respHandler DBUS error: " << ec; 4768d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 4774bb3dc34SCarol Wang return; 4784bb3dc34SCarol Wang } 4794bb3dc34SCarol Wang 4804bb3dc34SCarol Wang std::optional<std::string> chassisPath; 4814bb3dc34SCarol Wang std::string chassisName; 4824bb3dc34SCarol Wang for (const std::string& chassis : chassisPaths) 4834bb3dc34SCarol Wang { 48428aa8de5SGeorge Liu sdbusplus::message::object_path path(chassis); 48528aa8de5SGeorge Liu chassisName = path.filename(); 48628aa8de5SGeorge Liu if (chassisName.empty()) 4874bb3dc34SCarol Wang { 4884bb3dc34SCarol Wang BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis; 4894bb3dc34SCarol Wang continue; 4904bb3dc34SCarol Wang } 4914bb3dc34SCarol Wang if (chassisName == asyncResp->chassisId) 4924bb3dc34SCarol Wang { 4934bb3dc34SCarol Wang chassisPath = chassis; 4944bb3dc34SCarol Wang break; 4954bb3dc34SCarol Wang } 4964bb3dc34SCarol Wang } 4974bb3dc34SCarol Wang callback(chassisPath); 4984bb3dc34SCarol Wang }; 4994bb3dc34SCarol Wang 5004bb3dc34SCarol Wang // Get the Chassis Collection 5014bb3dc34SCarol Wang crow::connections::systemBus->async_method_call( 5024bb3dc34SCarol Wang respHandler, "xyz.openbmc_project.ObjectMapper", 5034bb3dc34SCarol Wang "/xyz/openbmc_project/object_mapper", 5044bb3dc34SCarol Wang "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 5054bb3dc34SCarol Wang "/xyz/openbmc_project/inventory", 0, interfaces); 5064bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "checkChassisId exit"; 5074bb3dc34SCarol Wang } 5084bb3dc34SCarol Wang 5094bb3dc34SCarol Wang /** 51008777fb0SLewanczyk, Dawid * @brief Retrieves requested chassis sensors and redundancy data from DBus . 511588c3f0dSKowalski, Kamil * @param SensorsAsyncResp Pointer to object holding response data 51208777fb0SLewanczyk, Dawid * @param callback Callback for next step in gathered sensor processing 51308777fb0SLewanczyk, Dawid */ 51408777fb0SLewanczyk, Dawid template <typename Callback> 515b5a76932SEd Tanous void getChassis(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 5161abe55efSEd Tanous Callback&& callback) 5171abe55efSEd Tanous { 51855c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis enter"; 519adc4f0dbSShawn McCarney const std::array<const char*, 2> interfaces = { 52049c53ac9SJohnathan Mantey "xyz.openbmc_project.Inventory.Item.Board", 521adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Item.Chassis"}; 52249c53ac9SJohnathan Mantey auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp]( 52349c53ac9SJohnathan Mantey const boost::system::error_code ec, 52449c53ac9SJohnathan Mantey const std::vector<std::string>& chassisPaths) { 52555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis respHandler enter"; 5261abe55efSEd Tanous if (ec) 5271abe55efSEd Tanous { 52855c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "getChassis respHandler DBUS error: " << ec; 5298d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 53008777fb0SLewanczyk, Dawid return; 53108777fb0SLewanczyk, Dawid } 53208777fb0SLewanczyk, Dawid 53349c53ac9SJohnathan Mantey const std::string* chassisPath = nullptr; 53449c53ac9SJohnathan Mantey std::string chassisName; 53549c53ac9SJohnathan Mantey for (const std::string& chassis : chassisPaths) 5361abe55efSEd Tanous { 53728aa8de5SGeorge Liu sdbusplus::message::object_path path(chassis); 53828aa8de5SGeorge Liu chassisName = path.filename(); 53928aa8de5SGeorge Liu if (chassisName.empty()) 5401abe55efSEd Tanous { 54149c53ac9SJohnathan Mantey BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis; 542daf36e2eSEd Tanous continue; 543daf36e2eSEd Tanous } 54449c53ac9SJohnathan Mantey if (chassisName == sensorsAsyncResp->chassisId) 5451abe55efSEd Tanous { 54649c53ac9SJohnathan Mantey chassisPath = &chassis; 54749c53ac9SJohnathan Mantey break; 548daf36e2eSEd Tanous } 54949c53ac9SJohnathan Mantey } 55049c53ac9SJohnathan Mantey if (chassisPath == nullptr) 5511abe55efSEd Tanous { 5528d1b46d7Szhanghch05 messages::resourceNotFound(sensorsAsyncResp->asyncResp->res, 5538d1b46d7Szhanghch05 "Chassis", sensorsAsyncResp->chassisId); 55449c53ac9SJohnathan Mantey return; 5551abe55efSEd Tanous } 55608777fb0SLewanczyk, Dawid 55749c53ac9SJohnathan Mantey const std::string& chassisSubNode = sensorsAsyncResp->chassisSubNode; 558a0ec28b6SAdrian Ambrożewicz if (chassisSubNode == sensors::node::power) 55949c53ac9SJohnathan Mantey { 5608d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 56149c53ac9SJohnathan Mantey "#Power.v1_5_2.Power"; 56249c53ac9SJohnathan Mantey } 563a0ec28b6SAdrian Ambrożewicz else if (chassisSubNode == sensors::node::thermal) 56449c53ac9SJohnathan Mantey { 5658d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 56649c53ac9SJohnathan Mantey "#Thermal.v1_4_0.Thermal"; 5678d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Fans"] = 5688d1b46d7Szhanghch05 nlohmann::json::array(); 5698d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Temperatures"] = 5704f9a2130SJennifer Lee nlohmann::json::array(); 57149c53ac9SJohnathan Mantey } 572a0ec28b6SAdrian Ambrożewicz else if (chassisSubNode == sensors::node::sensors) 57395a3ecadSAnthony Wilson { 5748d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 57595a3ecadSAnthony Wilson "#SensorCollection.SensorCollection"; 5768d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Description"] = 57795a3ecadSAnthony Wilson "Collection of Sensors for this Chassis"; 5788d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Members"] = 57995a3ecadSAnthony Wilson nlohmann::json::array(); 5808d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Members@odata.count"] = 5818d1b46d7Szhanghch05 0; 58295a3ecadSAnthony Wilson } 58395a3ecadSAnthony Wilson 584a0ec28b6SAdrian Ambrożewicz if (chassisSubNode != sensors::node::sensors) 58595a3ecadSAnthony Wilson { 5868d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Id"] = chassisSubNode; 58795a3ecadSAnthony Wilson } 58895a3ecadSAnthony Wilson 5898d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] = 59049c53ac9SJohnathan Mantey "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + "/" + 59149c53ac9SJohnathan Mantey chassisSubNode; 5928d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Name"] = chassisSubNode; 5938fb49dd6SShawn McCarney // Get the list of all sensors for this Chassis element 5948fb49dd6SShawn McCarney std::string sensorPath = *chassisPath + "/all_sensors"; 59555c7b7a2SEd Tanous crow::connections::systemBus->async_method_call( 59649c53ac9SJohnathan Mantey [sensorsAsyncResp, callback{std::move(callback)}]( 597271584abSEd Tanous const boost::system::error_code& e, 598*168e20c1SEd Tanous const dbus::utility::DbusVariantType& variantEndpoints) { 599271584abSEd Tanous if (e) 60049c53ac9SJohnathan Mantey { 601271584abSEd Tanous if (e.value() != EBADR) 60249c53ac9SJohnathan Mantey { 6038d1b46d7Szhanghch05 messages::internalError( 6048d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 60549c53ac9SJohnathan Mantey return; 60649c53ac9SJohnathan Mantey } 60749c53ac9SJohnathan Mantey } 60849c53ac9SJohnathan Mantey const std::vector<std::string>* nodeSensorList = 60949c53ac9SJohnathan Mantey std::get_if<std::vector<std::string>>(&(variantEndpoints)); 61049c53ac9SJohnathan Mantey if (nodeSensorList == nullptr) 61149c53ac9SJohnathan Mantey { 61249c53ac9SJohnathan Mantey messages::resourceNotFound( 6138d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res, 6148d1b46d7Szhanghch05 sensorsAsyncResp->chassisSubNode, 615a0ec28b6SAdrian Ambrożewicz sensorsAsyncResp->chassisSubNode == 616a0ec28b6SAdrian Ambrożewicz sensors::node::thermal 61749c53ac9SJohnathan Mantey ? "Temperatures" 618a0ec28b6SAdrian Ambrożewicz : sensorsAsyncResp->chassisSubNode == 619a0ec28b6SAdrian Ambrożewicz sensors::node::power 62095a3ecadSAnthony Wilson ? "Voltages" 62195a3ecadSAnthony Wilson : "Sensors"); 62249c53ac9SJohnathan Mantey return; 62349c53ac9SJohnathan Mantey } 62449c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> 62549c53ac9SJohnathan Mantey culledSensorList = std::make_shared< 62649c53ac9SJohnathan Mantey boost::container::flat_set<std::string>>(); 62749c53ac9SJohnathan Mantey reduceSensorList(sensorsAsyncResp, nodeSensorList, 62849c53ac9SJohnathan Mantey culledSensorList); 62949c53ac9SJohnathan Mantey callback(culledSensorList); 63049c53ac9SJohnathan Mantey }, 63149c53ac9SJohnathan Mantey "xyz.openbmc_project.ObjectMapper", sensorPath, 63249c53ac9SJohnathan Mantey "org.freedesktop.DBus.Properties", "Get", 63349c53ac9SJohnathan Mantey "xyz.openbmc_project.Association", "endpoints"); 63449c53ac9SJohnathan Mantey }; 63549c53ac9SJohnathan Mantey 63649c53ac9SJohnathan Mantey // Get the Chassis Collection 63749c53ac9SJohnathan Mantey crow::connections::systemBus->async_method_call( 63849c53ac9SJohnathan Mantey respHandler, "xyz.openbmc_project.ObjectMapper", 63949c53ac9SJohnathan Mantey "/xyz/openbmc_project/object_mapper", 64049c53ac9SJohnathan Mantey "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 641271584abSEd Tanous "/xyz/openbmc_project/inventory", 0, interfaces); 64255c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis exit"; 64308777fb0SLewanczyk, Dawid } 64408777fb0SLewanczyk, Dawid 64508777fb0SLewanczyk, Dawid /** 646de629b6eSShawn McCarney * @brief Finds all DBus object paths that implement ObjectManager. 647de629b6eSShawn McCarney * 648de629b6eSShawn McCarney * Creates a mapping from the associated connection name to the object path. 649de629b6eSShawn McCarney * 650de629b6eSShawn McCarney * Finds the object paths asynchronously. Invokes callback when information has 651de629b6eSShawn McCarney * been obtained. 652de629b6eSShawn McCarney * 653de629b6eSShawn McCarney * The callback must have the following signature: 654de629b6eSShawn McCarney * @code 6558fb49dd6SShawn McCarney * callback(std::shared_ptr<boost::container::flat_map<std::string, 6568fb49dd6SShawn McCarney * std::string>> objectMgrPaths) 657de629b6eSShawn McCarney * @endcode 658de629b6eSShawn McCarney * 65949c53ac9SJohnathan Mantey * @param sensorsAsyncResp Pointer to object holding response data. 660de629b6eSShawn McCarney * @param callback Callback to invoke when object paths obtained. 661de629b6eSShawn McCarney */ 662de629b6eSShawn McCarney template <typename Callback> 663b5a76932SEd Tanous void getObjectManagerPaths( 66481ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 665de629b6eSShawn McCarney Callback&& callback) 666de629b6eSShawn McCarney { 667de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths enter"; 668de629b6eSShawn McCarney const std::array<std::string, 1> interfaces = { 669de629b6eSShawn McCarney "org.freedesktop.DBus.ObjectManager"}; 670de629b6eSShawn McCarney 671de629b6eSShawn McCarney // Response handler for GetSubTree DBus method 672de629b6eSShawn McCarney auto respHandler = [callback{std::move(callback)}, 67381ce609eSEd Tanous sensorsAsyncResp](const boost::system::error_code ec, 674de629b6eSShawn McCarney const GetSubTreeType& subtree) { 675de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler enter"; 676de629b6eSShawn McCarney if (ec) 677de629b6eSShawn McCarney { 6788d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 679de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "getObjectManagerPaths respHandler: DBus error " 680de629b6eSShawn McCarney << ec; 681de629b6eSShawn McCarney return; 682de629b6eSShawn McCarney } 683de629b6eSShawn McCarney 684de629b6eSShawn McCarney // Loop over returned object paths 6858fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 6868fb49dd6SShawn McCarney objectMgrPaths = std::make_shared< 6878fb49dd6SShawn McCarney boost::container::flat_map<std::string, std::string>>(); 688de629b6eSShawn McCarney for (const std::pair< 689de629b6eSShawn McCarney std::string, 690de629b6eSShawn McCarney std::vector<std::pair<std::string, std::vector<std::string>>>>& 691de629b6eSShawn McCarney object : subtree) 692de629b6eSShawn McCarney { 693de629b6eSShawn McCarney // Loop over connections for current object path 694de629b6eSShawn McCarney const std::string& objectPath = object.first; 695de629b6eSShawn McCarney for (const std::pair<std::string, std::vector<std::string>>& 696de629b6eSShawn McCarney objData : object.second) 697de629b6eSShawn McCarney { 698de629b6eSShawn McCarney // Add mapping from connection to object path 699de629b6eSShawn McCarney const std::string& connection = objData.first; 7008fb49dd6SShawn McCarney (*objectMgrPaths)[connection] = objectPath; 701de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "Added mapping " << connection << " -> " 702de629b6eSShawn McCarney << objectPath; 703de629b6eSShawn McCarney } 704de629b6eSShawn McCarney } 7058fb49dd6SShawn McCarney callback(objectMgrPaths); 706de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler exit"; 707de629b6eSShawn McCarney }; 708de629b6eSShawn McCarney 709de629b6eSShawn McCarney // Query mapper for all DBus object paths that implement ObjectManager 710de629b6eSShawn McCarney crow::connections::systemBus->async_method_call( 711de629b6eSShawn McCarney std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 712de629b6eSShawn McCarney "/xyz/openbmc_project/object_mapper", 713271584abSEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", 0, interfaces); 714de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths exit"; 715de629b6eSShawn McCarney } 716de629b6eSShawn McCarney 717de629b6eSShawn McCarney /** 718adc4f0dbSShawn McCarney * @brief Returns the Redfish State value for the specified inventory item. 719adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with a sensor. 720adc4f0dbSShawn McCarney * @return State value for inventory item. 72134dd179eSJames Feist */ 72223a21a1cSEd Tanous inline std::string getState(const InventoryItem* inventoryItem) 723adc4f0dbSShawn McCarney { 724adc4f0dbSShawn McCarney if ((inventoryItem != nullptr) && !(inventoryItem->isPresent)) 725adc4f0dbSShawn McCarney { 726adc4f0dbSShawn McCarney return "Absent"; 727adc4f0dbSShawn McCarney } 72834dd179eSJames Feist 729adc4f0dbSShawn McCarney return "Enabled"; 730adc4f0dbSShawn McCarney } 731adc4f0dbSShawn McCarney 732adc4f0dbSShawn McCarney /** 733adc4f0dbSShawn McCarney * @brief Returns the Redfish Health value for the specified sensor. 734adc4f0dbSShawn McCarney * @param sensorJson Sensor JSON object. 735adc4f0dbSShawn McCarney * @param interfacesDict Map of all sensor interfaces. 736adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with the sensor. Will 737adc4f0dbSShawn McCarney * be nullptr if no associated inventory item was found. 738adc4f0dbSShawn McCarney * @return Health value for sensor. 739adc4f0dbSShawn McCarney */ 74023a21a1cSEd Tanous inline std::string getHealth( 741adc4f0dbSShawn McCarney nlohmann::json& sensorJson, 74234dd179eSJames Feist const boost::container::flat_map< 743*168e20c1SEd Tanous std::string, boost::container::flat_map< 744*168e20c1SEd Tanous std::string, dbus::utility::DbusVariantType>>& 745adc4f0dbSShawn McCarney interfacesDict, 746adc4f0dbSShawn McCarney const InventoryItem* inventoryItem) 74734dd179eSJames Feist { 748adc4f0dbSShawn McCarney // Get current health value (if any) in the sensor JSON object. Some JSON 749adc4f0dbSShawn McCarney // objects contain multiple sensors (such as PowerSupplies). We want to set 750adc4f0dbSShawn McCarney // the overall health to be the most severe of any of the sensors. 751adc4f0dbSShawn McCarney std::string currentHealth; 752adc4f0dbSShawn McCarney auto statusIt = sensorJson.find("Status"); 753adc4f0dbSShawn McCarney if (statusIt != sensorJson.end()) 754adc4f0dbSShawn McCarney { 755adc4f0dbSShawn McCarney auto healthIt = statusIt->find("Health"); 756adc4f0dbSShawn McCarney if (healthIt != statusIt->end()) 757adc4f0dbSShawn McCarney { 758adc4f0dbSShawn McCarney std::string* health = healthIt->get_ptr<std::string*>(); 759adc4f0dbSShawn McCarney if (health != nullptr) 760adc4f0dbSShawn McCarney { 761adc4f0dbSShawn McCarney currentHealth = *health; 762adc4f0dbSShawn McCarney } 763adc4f0dbSShawn McCarney } 764adc4f0dbSShawn McCarney } 765adc4f0dbSShawn McCarney 766adc4f0dbSShawn McCarney // If current health in JSON object is already Critical, return that. This 767adc4f0dbSShawn McCarney // should override the sensor health, which might be less severe. 768adc4f0dbSShawn McCarney if (currentHealth == "Critical") 769adc4f0dbSShawn McCarney { 770adc4f0dbSShawn McCarney return "Critical"; 771adc4f0dbSShawn McCarney } 772adc4f0dbSShawn McCarney 773adc4f0dbSShawn McCarney // Check if sensor has critical threshold alarm 77434dd179eSJames Feist auto criticalThresholdIt = 77534dd179eSJames Feist interfacesDict.find("xyz.openbmc_project.Sensor.Threshold.Critical"); 77634dd179eSJames Feist if (criticalThresholdIt != interfacesDict.end()) 77734dd179eSJames Feist { 77834dd179eSJames Feist auto thresholdHighIt = 77934dd179eSJames Feist criticalThresholdIt->second.find("CriticalAlarmHigh"); 78034dd179eSJames Feist auto thresholdLowIt = 78134dd179eSJames Feist criticalThresholdIt->second.find("CriticalAlarmLow"); 78234dd179eSJames Feist if (thresholdHighIt != criticalThresholdIt->second.end()) 78334dd179eSJames Feist { 78434dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdHighIt->second); 78534dd179eSJames Feist if (asserted == nullptr) 78634dd179eSJames Feist { 78734dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 78834dd179eSJames Feist } 78934dd179eSJames Feist else if (*asserted) 79034dd179eSJames Feist { 79134dd179eSJames Feist return "Critical"; 79234dd179eSJames Feist } 79334dd179eSJames Feist } 79434dd179eSJames Feist if (thresholdLowIt != criticalThresholdIt->second.end()) 79534dd179eSJames Feist { 79634dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdLowIt->second); 79734dd179eSJames Feist if (asserted == nullptr) 79834dd179eSJames Feist { 79934dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 80034dd179eSJames Feist } 80134dd179eSJames Feist else if (*asserted) 80234dd179eSJames Feist { 80334dd179eSJames Feist return "Critical"; 80434dd179eSJames Feist } 80534dd179eSJames Feist } 80634dd179eSJames Feist } 80734dd179eSJames Feist 808adc4f0dbSShawn McCarney // Check if associated inventory item is not functional 809adc4f0dbSShawn McCarney if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional)) 810adc4f0dbSShawn McCarney { 811adc4f0dbSShawn McCarney return "Critical"; 812adc4f0dbSShawn McCarney } 813adc4f0dbSShawn McCarney 814adc4f0dbSShawn McCarney // If current health in JSON object is already Warning, return that. This 815adc4f0dbSShawn McCarney // should override the sensor status, which might be less severe. 816adc4f0dbSShawn McCarney if (currentHealth == "Warning") 817adc4f0dbSShawn McCarney { 818adc4f0dbSShawn McCarney return "Warning"; 819adc4f0dbSShawn McCarney } 820adc4f0dbSShawn McCarney 821adc4f0dbSShawn McCarney // Check if sensor has warning threshold alarm 82234dd179eSJames Feist auto warningThresholdIt = 82334dd179eSJames Feist interfacesDict.find("xyz.openbmc_project.Sensor.Threshold.Warning"); 82434dd179eSJames Feist if (warningThresholdIt != interfacesDict.end()) 82534dd179eSJames Feist { 82634dd179eSJames Feist auto thresholdHighIt = 82734dd179eSJames Feist warningThresholdIt->second.find("WarningAlarmHigh"); 82834dd179eSJames Feist auto thresholdLowIt = 82934dd179eSJames Feist warningThresholdIt->second.find("WarningAlarmLow"); 83034dd179eSJames Feist if (thresholdHighIt != warningThresholdIt->second.end()) 83134dd179eSJames Feist { 83234dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdHighIt->second); 83334dd179eSJames Feist if (asserted == nullptr) 83434dd179eSJames Feist { 83534dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 83634dd179eSJames Feist } 83734dd179eSJames Feist else if (*asserted) 83834dd179eSJames Feist { 83934dd179eSJames Feist return "Warning"; 84034dd179eSJames Feist } 84134dd179eSJames Feist } 84234dd179eSJames Feist if (thresholdLowIt != warningThresholdIt->second.end()) 84334dd179eSJames Feist { 84434dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdLowIt->second); 84534dd179eSJames Feist if (asserted == nullptr) 84634dd179eSJames Feist { 84734dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 84834dd179eSJames Feist } 84934dd179eSJames Feist else if (*asserted) 85034dd179eSJames Feist { 85134dd179eSJames Feist return "Warning"; 85234dd179eSJames Feist } 85334dd179eSJames Feist } 85434dd179eSJames Feist } 855adc4f0dbSShawn McCarney 85634dd179eSJames Feist return "OK"; 85734dd179eSJames Feist } 85834dd179eSJames Feist 85923a21a1cSEd Tanous inline void setLedState(nlohmann::json& sensorJson, 860d500549bSAnthony Wilson const InventoryItem* inventoryItem) 861d500549bSAnthony Wilson { 862d500549bSAnthony Wilson if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty()) 863d500549bSAnthony Wilson { 864d500549bSAnthony Wilson switch (inventoryItem->ledState) 865d500549bSAnthony Wilson { 866d500549bSAnthony Wilson case LedState::OFF: 867d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Off"; 868d500549bSAnthony Wilson break; 869d500549bSAnthony Wilson case LedState::ON: 870d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Lit"; 871d500549bSAnthony Wilson break; 872d500549bSAnthony Wilson case LedState::BLINK: 873d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Blinking"; 874d500549bSAnthony Wilson break; 87523a21a1cSEd Tanous case LedState::UNKNOWN: 876d500549bSAnthony Wilson break; 877d500549bSAnthony Wilson } 878d500549bSAnthony Wilson } 879d500549bSAnthony Wilson } 880d500549bSAnthony Wilson 88134dd179eSJames Feist /** 88208777fb0SLewanczyk, Dawid * @brief Builds a json sensor representation of a sensor. 88308777fb0SLewanczyk, Dawid * @param sensorName The name of the sensor to be built 884274fad5aSGunnar Mills * @param sensorType The type (temperature, fan_tach, etc) of the sensor to 88508777fb0SLewanczyk, Dawid * build 886a0ec28b6SAdrian Ambrożewicz * @param sensorsAsyncResp Sensor metadata 88708777fb0SLewanczyk, Dawid * @param interfacesDict A dictionary of the interfaces and properties of said 88808777fb0SLewanczyk, Dawid * interfaces to be built from 88908777fb0SLewanczyk, Dawid * @param sensor_json The json object to fill 890adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with the sensor. Will 891adc4f0dbSShawn McCarney * be nullptr if no associated inventory item was found. 89208777fb0SLewanczyk, Dawid */ 89323a21a1cSEd Tanous inline void objectInterfacesToJson( 89408777fb0SLewanczyk, Dawid const std::string& sensorName, const std::string& sensorType, 895b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 89608777fb0SLewanczyk, Dawid const boost::container::flat_map< 897*168e20c1SEd Tanous std::string, boost::container::flat_map< 898*168e20c1SEd Tanous std::string, dbus::utility::DbusVariantType>>& 89908777fb0SLewanczyk, Dawid interfacesDict, 90081ce609eSEd Tanous nlohmann::json& sensorJson, InventoryItem* inventoryItem) 9011abe55efSEd Tanous { 90208777fb0SLewanczyk, Dawid // We need a value interface before we can do anything with it 90355c7b7a2SEd Tanous auto valueIt = interfacesDict.find("xyz.openbmc_project.Sensor.Value"); 9041abe55efSEd Tanous if (valueIt == interfacesDict.end()) 9051abe55efSEd Tanous { 90655c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "Sensor doesn't have a value interface"; 90708777fb0SLewanczyk, Dawid return; 90808777fb0SLewanczyk, Dawid } 90908777fb0SLewanczyk, Dawid 91008777fb0SLewanczyk, Dawid // Assume values exist as is (10^0 == 1) if no scale exists 91108777fb0SLewanczyk, Dawid int64_t scaleMultiplier = 0; 91208777fb0SLewanczyk, Dawid 91355c7b7a2SEd Tanous auto scaleIt = valueIt->second.find("Scale"); 91408777fb0SLewanczyk, Dawid // If a scale exists, pull value as int64, and use the scaling. 9151abe55efSEd Tanous if (scaleIt != valueIt->second.end()) 9161abe55efSEd Tanous { 917abf2add6SEd Tanous const int64_t* int64Value = std::get_if<int64_t>(&scaleIt->second); 9181abe55efSEd Tanous if (int64Value != nullptr) 9191abe55efSEd Tanous { 92008777fb0SLewanczyk, Dawid scaleMultiplier = *int64Value; 92108777fb0SLewanczyk, Dawid } 92208777fb0SLewanczyk, Dawid } 92308777fb0SLewanczyk, Dawid 924a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 925adc4f0dbSShawn McCarney { 92695a3ecadSAnthony Wilson // For sensors in SensorCollection we set Id instead of MemberId, 92795a3ecadSAnthony Wilson // including power sensors. 92881ce609eSEd Tanous sensorJson["Id"] = sensorName; 92981ce609eSEd Tanous sensorJson["Name"] = boost::replace_all_copy(sensorName, "_", " "); 93095a3ecadSAnthony Wilson } 93195a3ecadSAnthony Wilson else if (sensorType != "power") 93295a3ecadSAnthony Wilson { 93395a3ecadSAnthony Wilson // Set MemberId and Name for non-power sensors. For PowerSupplies and 93495a3ecadSAnthony Wilson // PowerControl, those properties have more general values because 93595a3ecadSAnthony Wilson // multiple sensors can be stored in the same JSON object. 93681ce609eSEd Tanous sensorJson["MemberId"] = sensorName; 93781ce609eSEd Tanous sensorJson["Name"] = boost::replace_all_copy(sensorName, "_", " "); 938adc4f0dbSShawn McCarney } 939e742b6ccSEd Tanous 94081ce609eSEd Tanous sensorJson["Status"]["State"] = getState(inventoryItem); 94181ce609eSEd Tanous sensorJson["Status"]["Health"] = 94281ce609eSEd Tanous getHealth(sensorJson, interfacesDict, inventoryItem); 94308777fb0SLewanczyk, Dawid 94408777fb0SLewanczyk, Dawid // Parameter to set to override the type we get from dbus, and force it to 94508777fb0SLewanczyk, Dawid // int, regardless of what is available. This is used for schemas like fan, 94608777fb0SLewanczyk, Dawid // that require integers, not floats. 94708777fb0SLewanczyk, Dawid bool forceToInt = false; 94808777fb0SLewanczyk, Dawid 9493929aca1SAnthony Wilson nlohmann::json::json_pointer unit("/Reading"); 950a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 95195a3ecadSAnthony Wilson { 95281ce609eSEd Tanous sensorJson["@odata.type"] = "#Sensor.v1_0_0.Sensor"; 953c2bf7f99SWludzik, Jozef 954c2bf7f99SWludzik, Jozef const std::string& readingType = sensors::toReadingType(sensorType); 955c2bf7f99SWludzik, Jozef if (readingType.empty()) 95695a3ecadSAnthony Wilson { 957c2bf7f99SWludzik, Jozef BMCWEB_LOG_ERROR << "Redfish cannot map reading type for " 958c2bf7f99SWludzik, Jozef << sensorType; 95995a3ecadSAnthony Wilson } 960c2bf7f99SWludzik, Jozef else 96195a3ecadSAnthony Wilson { 962c2bf7f99SWludzik, Jozef sensorJson["ReadingType"] = readingType; 96395a3ecadSAnthony Wilson } 964c2bf7f99SWludzik, Jozef 965c2bf7f99SWludzik, Jozef const std::string& readingUnits = sensors::toReadingUnits(sensorType); 966c2bf7f99SWludzik, Jozef if (readingUnits.empty()) 967f8ede15eSAdrian Ambrożewicz { 968c2bf7f99SWludzik, Jozef BMCWEB_LOG_ERROR << "Redfish cannot map reading unit for " 969c2bf7f99SWludzik, Jozef << sensorType; 970c2bf7f99SWludzik, Jozef } 971c2bf7f99SWludzik, Jozef else 972c2bf7f99SWludzik, Jozef { 973c2bf7f99SWludzik, Jozef sensorJson["ReadingUnits"] = readingUnits; 974f8ede15eSAdrian Ambrożewicz } 97595a3ecadSAnthony Wilson } 97695a3ecadSAnthony Wilson else if (sensorType == "temperature") 9771abe55efSEd Tanous { 9783929aca1SAnthony Wilson unit = "/ReadingCelsius"_json_pointer; 97981ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature"; 98008777fb0SLewanczyk, Dawid // TODO(ed) Documentation says that path should be type fan_tach, 98108777fb0SLewanczyk, Dawid // implementation seems to implement fan 9821abe55efSEd Tanous } 9831abe55efSEd Tanous else if (sensorType == "fan" || sensorType == "fan_tach") 9841abe55efSEd Tanous { 9853929aca1SAnthony Wilson unit = "/Reading"_json_pointer; 98681ce609eSEd Tanous sensorJson["ReadingUnits"] = "RPM"; 98781ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan"; 98881ce609eSEd Tanous setLedState(sensorJson, inventoryItem); 98908777fb0SLewanczyk, Dawid forceToInt = true; 9901abe55efSEd Tanous } 9916f6d0d32SEd Tanous else if (sensorType == "fan_pwm") 9926f6d0d32SEd Tanous { 9933929aca1SAnthony Wilson unit = "/Reading"_json_pointer; 99481ce609eSEd Tanous sensorJson["ReadingUnits"] = "Percent"; 99581ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan"; 99681ce609eSEd Tanous setLedState(sensorJson, inventoryItem); 9976f6d0d32SEd Tanous forceToInt = true; 9986f6d0d32SEd Tanous } 9991abe55efSEd Tanous else if (sensorType == "voltage") 10001abe55efSEd Tanous { 10013929aca1SAnthony Wilson unit = "/ReadingVolts"_json_pointer; 100281ce609eSEd Tanous sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage"; 10031abe55efSEd Tanous } 10042474adfaSEd Tanous else if (sensorType == "power") 10052474adfaSEd Tanous { 100649c53ac9SJohnathan Mantey std::string sensorNameLower = 100749c53ac9SJohnathan Mantey boost::algorithm::to_lower_copy(sensorName); 100849c53ac9SJohnathan Mantey 1009028f7ebcSEddie James if (!sensorName.compare("total_power")) 1010028f7ebcSEddie James { 101181ce609eSEd Tanous sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl"; 10127ab06f49SGunnar Mills // Put multiple "sensors" into a single PowerControl, so have 10137ab06f49SGunnar Mills // generic names for MemberId and Name. Follows Redfish mockup. 101481ce609eSEd Tanous sensorJson["MemberId"] = "0"; 101581ce609eSEd Tanous sensorJson["Name"] = "Chassis Power Control"; 10163929aca1SAnthony Wilson unit = "/PowerConsumedWatts"_json_pointer; 1017028f7ebcSEddie James } 1018028f7ebcSEddie James else if (sensorNameLower.find("input") != std::string::npos) 101949c53ac9SJohnathan Mantey { 10203929aca1SAnthony Wilson unit = "/PowerInputWatts"_json_pointer; 102149c53ac9SJohnathan Mantey } 102249c53ac9SJohnathan Mantey else 102349c53ac9SJohnathan Mantey { 10243929aca1SAnthony Wilson unit = "/PowerOutputWatts"_json_pointer; 102549c53ac9SJohnathan Mantey } 10262474adfaSEd Tanous } 10271abe55efSEd Tanous else 10281abe55efSEd Tanous { 102955c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "Redfish cannot map object type for " << sensorName; 103008777fb0SLewanczyk, Dawid return; 103108777fb0SLewanczyk, Dawid } 103208777fb0SLewanczyk, Dawid // Map of dbus interface name, dbus property name and redfish property_name 10333929aca1SAnthony Wilson std::vector< 10343929aca1SAnthony Wilson std::tuple<const char*, const char*, nlohmann::json::json_pointer>> 10353929aca1SAnthony Wilson properties; 103608777fb0SLewanczyk, Dawid properties.reserve(7); 103708777fb0SLewanczyk, Dawid 103808777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit); 1039de629b6eSShawn McCarney 1040a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 10413929aca1SAnthony Wilson { 10423929aca1SAnthony Wilson properties.emplace_back( 10433929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh", 10443929aca1SAnthony Wilson "/Thresholds/UpperCaution/Reading"_json_pointer); 10453929aca1SAnthony Wilson properties.emplace_back( 10463929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow", 10473929aca1SAnthony Wilson "/Thresholds/LowerCaution/Reading"_json_pointer); 10483929aca1SAnthony Wilson properties.emplace_back( 10493929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh", 10503929aca1SAnthony Wilson "/Thresholds/UpperCritical/Reading"_json_pointer); 10513929aca1SAnthony Wilson properties.emplace_back( 10523929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow", 10533929aca1SAnthony Wilson "/Thresholds/LowerCritical/Reading"_json_pointer); 10543929aca1SAnthony Wilson } 10553929aca1SAnthony Wilson else if (sensorType != "power") 1056de629b6eSShawn McCarney { 105708777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning", 10583929aca1SAnthony Wilson "WarningHigh", 10593929aca1SAnthony Wilson "/UpperThresholdNonCritical"_json_pointer); 106008777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning", 10613929aca1SAnthony Wilson "WarningLow", 10623929aca1SAnthony Wilson "/LowerThresholdNonCritical"_json_pointer); 106308777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical", 10643929aca1SAnthony Wilson "CriticalHigh", 10653929aca1SAnthony Wilson "/UpperThresholdCritical"_json_pointer); 106608777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical", 10673929aca1SAnthony Wilson "CriticalLow", 10683929aca1SAnthony Wilson "/LowerThresholdCritical"_json_pointer); 1069de629b6eSShawn McCarney } 107008777fb0SLewanczyk, Dawid 10712474adfaSEd Tanous // TODO Need to get UpperThresholdFatal and LowerThresholdFatal 10722474adfaSEd Tanous 1073a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 107495a3ecadSAnthony Wilson { 107595a3ecadSAnthony Wilson properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10763929aca1SAnthony Wilson "/ReadingRangeMin"_json_pointer); 107795a3ecadSAnthony Wilson properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10783929aca1SAnthony Wilson "/ReadingRangeMax"_json_pointer); 107995a3ecadSAnthony Wilson } 108095a3ecadSAnthony Wilson else if (sensorType == "temperature") 10811abe55efSEd Tanous { 108208777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10833929aca1SAnthony Wilson "/MinReadingRangeTemp"_json_pointer); 108408777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10853929aca1SAnthony Wilson "/MaxReadingRangeTemp"_json_pointer); 10861abe55efSEd Tanous } 1087adc4f0dbSShawn McCarney else if (sensorType != "power") 10881abe55efSEd Tanous { 108908777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10903929aca1SAnthony Wilson "/MinReadingRange"_json_pointer); 109108777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10923929aca1SAnthony Wilson "/MaxReadingRange"_json_pointer); 109308777fb0SLewanczyk, Dawid } 109408777fb0SLewanczyk, Dawid 10953929aca1SAnthony Wilson for (const std::tuple<const char*, const char*, 10963929aca1SAnthony Wilson nlohmann::json::json_pointer>& p : properties) 10971abe55efSEd Tanous { 109808777fb0SLewanczyk, Dawid auto interfaceProperties = interfacesDict.find(std::get<0>(p)); 10991abe55efSEd Tanous if (interfaceProperties != interfacesDict.end()) 11001abe55efSEd Tanous { 1101271584abSEd Tanous auto thisValueIt = interfaceProperties->second.find(std::get<1>(p)); 1102271584abSEd Tanous if (thisValueIt != interfaceProperties->second.end()) 11031abe55efSEd Tanous { 1104*168e20c1SEd Tanous const dbus::utility::DbusVariantType& valueVariant = 1105*168e20c1SEd Tanous thisValueIt->second; 11063929aca1SAnthony Wilson 11073929aca1SAnthony Wilson // The property we want to set may be nested json, so use 11083929aca1SAnthony Wilson // a json_pointer for easy indexing into the json structure. 11093929aca1SAnthony Wilson const nlohmann::json::json_pointer& key = std::get<2>(p); 11103929aca1SAnthony Wilson 111108777fb0SLewanczyk, Dawid // Attempt to pull the int64 directly 1112abf2add6SEd Tanous const int64_t* int64Value = std::get_if<int64_t>(&valueVariant); 111308777fb0SLewanczyk, Dawid 1114abf2add6SEd Tanous const double* doubleValue = std::get_if<double>(&valueVariant); 1115028f7ebcSEddie James const uint32_t* uValue = std::get_if<uint32_t>(&valueVariant); 11166f6d0d32SEd Tanous double temp = 0.0; 11176f6d0d32SEd Tanous if (int64Value != nullptr) 11181abe55efSEd Tanous { 1119271584abSEd Tanous temp = static_cast<double>(*int64Value); 11206f6d0d32SEd Tanous } 11216f6d0d32SEd Tanous else if (doubleValue != nullptr) 11221abe55efSEd Tanous { 11236f6d0d32SEd Tanous temp = *doubleValue; 11241abe55efSEd Tanous } 1125028f7ebcSEddie James else if (uValue != nullptr) 1126028f7ebcSEddie James { 1127028f7ebcSEddie James temp = *uValue; 1128028f7ebcSEddie James } 11291abe55efSEd Tanous else 11301abe55efSEd Tanous { 11316f6d0d32SEd Tanous BMCWEB_LOG_ERROR 11326f6d0d32SEd Tanous << "Got value interface that wasn't int or double"; 11336f6d0d32SEd Tanous continue; 113408777fb0SLewanczyk, Dawid } 11356f6d0d32SEd Tanous temp = temp * std::pow(10, scaleMultiplier); 11366f6d0d32SEd Tanous if (forceToInt) 11376f6d0d32SEd Tanous { 113881ce609eSEd Tanous sensorJson[key] = static_cast<int64_t>(temp); 11396f6d0d32SEd Tanous } 11406f6d0d32SEd Tanous else 11416f6d0d32SEd Tanous { 114281ce609eSEd Tanous sensorJson[key] = temp; 114308777fb0SLewanczyk, Dawid } 114408777fb0SLewanczyk, Dawid } 114508777fb0SLewanczyk, Dawid } 114608777fb0SLewanczyk, Dawid } 1147a0ec28b6SAdrian Ambrożewicz 114881ce609eSEd Tanous sensorsAsyncResp->addMetadata(sensorJson, unit.to_string(), 1149a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/" + sensorType + 1150a0ec28b6SAdrian Ambrożewicz "/" + sensorName); 1151a0ec28b6SAdrian Ambrożewicz 115255c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Added sensor " << sensorName; 115308777fb0SLewanczyk, Dawid } 115408777fb0SLewanczyk, Dawid 1155b5a76932SEd Tanous inline void populateFanRedundancy( 1156b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 11578bd25ccdSJames Feist { 11588bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 11598bd25ccdSJames Feist [sensorsAsyncResp](const boost::system::error_code ec, 11608bd25ccdSJames Feist const GetSubTreeType& resp) { 11618bd25ccdSJames Feist if (ec) 11628bd25ccdSJames Feist { 11638bd25ccdSJames Feist return; // don't have to have this interface 11648bd25ccdSJames Feist } 1165e278c18fSEd Tanous for (const std::pair<std::string, 1166e278c18fSEd Tanous std::vector<std::pair< 1167e278c18fSEd Tanous std::string, std::vector<std::string>>>>& 1168e278c18fSEd Tanous pathPair : resp) 11698bd25ccdSJames Feist { 1170e278c18fSEd Tanous const std::string& path = pathPair.first; 1171e278c18fSEd Tanous const std::vector< 1172e278c18fSEd Tanous std::pair<std::string, std::vector<std::string>>>& objDict = 1173e278c18fSEd Tanous pathPair.second; 11748bd25ccdSJames Feist if (objDict.empty()) 11758bd25ccdSJames Feist { 11768bd25ccdSJames Feist continue; // this should be impossible 11778bd25ccdSJames Feist } 11788bd25ccdSJames Feist 11798bd25ccdSJames Feist const std::string& owner = objDict.begin()->first; 11808bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 11818bd25ccdSJames Feist [path, owner, 1182271584abSEd Tanous sensorsAsyncResp](const boost::system::error_code e, 1183*168e20c1SEd Tanous const dbus::utility::DbusVariantType& 11848bd25ccdSJames Feist variantEndpoints) { 1185271584abSEd Tanous if (e) 11868bd25ccdSJames Feist { 11878bd25ccdSJames Feist return; // if they don't have an association we 11888bd25ccdSJames Feist // can't tell what chassis is 11898bd25ccdSJames Feist } 11908bd25ccdSJames Feist // verify part of the right chassis 11918bd25ccdSJames Feist auto endpoints = std::get_if<std::vector<std::string>>( 11928bd25ccdSJames Feist &variantEndpoints); 11938bd25ccdSJames Feist 11948bd25ccdSJames Feist if (endpoints == nullptr) 11958bd25ccdSJames Feist { 11968bd25ccdSJames Feist BMCWEB_LOG_ERROR << "Invalid association interface"; 11978d1b46d7Szhanghch05 messages::internalError( 11988d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 11998bd25ccdSJames Feist return; 12008bd25ccdSJames Feist } 12018bd25ccdSJames Feist 12028bd25ccdSJames Feist auto found = std::find_if( 12038bd25ccdSJames Feist endpoints->begin(), endpoints->end(), 12048bd25ccdSJames Feist [sensorsAsyncResp](const std::string& entry) { 12058bd25ccdSJames Feist return entry.find( 12068bd25ccdSJames Feist sensorsAsyncResp->chassisId) != 12078bd25ccdSJames Feist std::string::npos; 12088bd25ccdSJames Feist }); 12098bd25ccdSJames Feist 12108bd25ccdSJames Feist if (found == endpoints->end()) 12118bd25ccdSJames Feist { 12128bd25ccdSJames Feist return; 12138bd25ccdSJames Feist } 12148bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 12158bd25ccdSJames Feist [path, sensorsAsyncResp]( 1216271584abSEd Tanous const boost::system::error_code& err, 12178bd25ccdSJames Feist const boost::container::flat_map< 12188bd25ccdSJames Feist std::string, 1219*168e20c1SEd Tanous dbus::utility::DbusVariantType>& ret) { 1220271584abSEd Tanous if (err) 12218bd25ccdSJames Feist { 12228bd25ccdSJames Feist return; // don't have to have this 12238bd25ccdSJames Feist // interface 12248bd25ccdSJames Feist } 12258bd25ccdSJames Feist auto findFailures = ret.find("AllowedFailures"); 12268bd25ccdSJames Feist auto findCollection = ret.find("Collection"); 12278bd25ccdSJames Feist auto findStatus = ret.find("Status"); 12288bd25ccdSJames Feist 12298bd25ccdSJames Feist if (findFailures == ret.end() || 12308bd25ccdSJames Feist findCollection == ret.end() || 12318bd25ccdSJames Feist findStatus == ret.end()) 12328bd25ccdSJames Feist { 12338bd25ccdSJames Feist BMCWEB_LOG_ERROR 12348bd25ccdSJames Feist << "Invalid redundancy interface"; 12358bd25ccdSJames Feist messages::internalError( 12368d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12378bd25ccdSJames Feist return; 12388bd25ccdSJames Feist } 12398bd25ccdSJames Feist 12408bd25ccdSJames Feist auto allowedFailures = std::get_if<uint8_t>( 12418bd25ccdSJames Feist &(findFailures->second)); 12428bd25ccdSJames Feist auto collection = 12438bd25ccdSJames Feist std::get_if<std::vector<std::string>>( 12448bd25ccdSJames Feist &(findCollection->second)); 12458bd25ccdSJames Feist auto status = std::get_if<std::string>( 12468bd25ccdSJames Feist &(findStatus->second)); 12478bd25ccdSJames Feist 12488bd25ccdSJames Feist if (allowedFailures == nullptr || 12498bd25ccdSJames Feist collection == nullptr || status == nullptr) 12508bd25ccdSJames Feist { 12518bd25ccdSJames Feist 12528bd25ccdSJames Feist BMCWEB_LOG_ERROR 12530fda0f12SGeorge Liu << "Invalid redundancy interface types"; 12548bd25ccdSJames Feist messages::internalError( 12558d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12568bd25ccdSJames Feist return; 12578bd25ccdSJames Feist } 125828aa8de5SGeorge Liu sdbusplus::message::object_path objectPath( 125928aa8de5SGeorge Liu path); 126028aa8de5SGeorge Liu std::string name = objectPath.filename(); 126128aa8de5SGeorge Liu if (name.empty()) 12628bd25ccdSJames Feist { 12638bd25ccdSJames Feist // this should be impossible 12648bd25ccdSJames Feist messages::internalError( 12658d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12668bd25ccdSJames Feist return; 12678bd25ccdSJames Feist } 12688bd25ccdSJames Feist std::replace(name.begin(), name.end(), '_', 12698bd25ccdSJames Feist ' '); 12708bd25ccdSJames Feist 12718bd25ccdSJames Feist std::string health; 12728bd25ccdSJames Feist 12738bd25ccdSJames Feist if (boost::ends_with(*status, "Full")) 12748bd25ccdSJames Feist { 12758bd25ccdSJames Feist health = "OK"; 12768bd25ccdSJames Feist } 12778bd25ccdSJames Feist else if (boost::ends_with(*status, "Degraded")) 12788bd25ccdSJames Feist { 12798bd25ccdSJames Feist health = "Warning"; 12808bd25ccdSJames Feist } 12818bd25ccdSJames Feist else 12828bd25ccdSJames Feist { 12838bd25ccdSJames Feist health = "Critical"; 12848bd25ccdSJames Feist } 12858bd25ccdSJames Feist std::vector<nlohmann::json> redfishCollection; 12868bd25ccdSJames Feist const auto& fanRedfish = 12878d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res 12888d1b46d7Szhanghch05 .jsonValue["Fans"]; 12898bd25ccdSJames Feist for (const std::string& item : *collection) 12908bd25ccdSJames Feist { 129128aa8de5SGeorge Liu sdbusplus::message::object_path path(item); 129228aa8de5SGeorge Liu std::string itemName = path.filename(); 129328aa8de5SGeorge Liu if (itemName.empty()) 129428aa8de5SGeorge Liu { 129528aa8de5SGeorge Liu continue; 129628aa8de5SGeorge Liu } 12978bd25ccdSJames Feist /* 12988bd25ccdSJames Feist todo(ed): merge patch that fixes the names 12998bd25ccdSJames Feist std::replace(itemName.begin(), 13008bd25ccdSJames Feist itemName.end(), '_', ' ');*/ 13018bd25ccdSJames Feist auto schemaItem = std::find_if( 13028bd25ccdSJames Feist fanRedfish.begin(), fanRedfish.end(), 13038bd25ccdSJames Feist [itemName](const nlohmann::json& fan) { 13048bd25ccdSJames Feist return fan["MemberId"] == itemName; 13058bd25ccdSJames Feist }); 13068bd25ccdSJames Feist if (schemaItem != fanRedfish.end()) 13078bd25ccdSJames Feist { 13088bd25ccdSJames Feist redfishCollection.push_back( 13098bd25ccdSJames Feist {{"@odata.id", 13108bd25ccdSJames Feist (*schemaItem)["@odata.id"]}}); 13118bd25ccdSJames Feist } 13128bd25ccdSJames Feist else 13138bd25ccdSJames Feist { 13148bd25ccdSJames Feist BMCWEB_LOG_ERROR 13158bd25ccdSJames Feist << "failed to find fan in schema"; 13168bd25ccdSJames Feist messages::internalError( 13178d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 13188bd25ccdSJames Feist return; 13198bd25ccdSJames Feist } 13208bd25ccdSJames Feist } 13218bd25ccdSJames Feist 13223e9e72ebSKuiying Wang size_t minNumNeeded = 13233e9e72ebSKuiying Wang collection->size() > 0 13243e9e72ebSKuiying Wang ? collection->size() - *allowedFailures 13253e9e72ebSKuiying Wang : 0; 1326271584abSEd Tanous nlohmann::json& jResp = 13278d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res 13288bd25ccdSJames Feist .jsonValue["Redundancy"]; 1329271584abSEd Tanous jResp.push_back( 13308bd25ccdSJames Feist {{"@odata.id", 1331717794d5SAppaRao Puli "/redfish/v1/Chassis/" + 13328bd25ccdSJames Feist sensorsAsyncResp->chassisId + "/" + 13338bd25ccdSJames Feist sensorsAsyncResp->chassisSubNode + 13348bd25ccdSJames Feist "#/Redundancy/" + 1335271584abSEd Tanous std::to_string(jResp.size())}, 13368bd25ccdSJames Feist {"@odata.type", 13378bd25ccdSJames Feist "#Redundancy.v1_3_2.Redundancy"}, 13383e9e72ebSKuiying Wang {"MinNumNeeded", minNumNeeded}, 13398bd25ccdSJames Feist {"MemberId", name}, 13408bd25ccdSJames Feist {"Mode", "N+m"}, 13418bd25ccdSJames Feist {"Name", name}, 13428bd25ccdSJames Feist {"RedundancySet", redfishCollection}, 13438bd25ccdSJames Feist {"Status", 13448bd25ccdSJames Feist {{"Health", health}, 13458bd25ccdSJames Feist {"State", "Enabled"}}}}); 13468bd25ccdSJames Feist }, 13478bd25ccdSJames Feist owner, path, "org.freedesktop.DBus.Properties", 13488bd25ccdSJames Feist "GetAll", 13498bd25ccdSJames Feist "xyz.openbmc_project.Control.FanRedundancy"); 13508bd25ccdSJames Feist }, 135102e92e32SJames Feist "xyz.openbmc_project.ObjectMapper", path + "/chassis", 13528bd25ccdSJames Feist "org.freedesktop.DBus.Properties", "Get", 13538bd25ccdSJames Feist "xyz.openbmc_project.Association", "endpoints"); 13548bd25ccdSJames Feist } 13558bd25ccdSJames Feist }, 13568bd25ccdSJames Feist "xyz.openbmc_project.ObjectMapper", 13578bd25ccdSJames Feist "/xyz/openbmc_project/object_mapper", 13588bd25ccdSJames Feist "xyz.openbmc_project.ObjectMapper", "GetSubTree", 13598bd25ccdSJames Feist "/xyz/openbmc_project/control", 2, 13608bd25ccdSJames Feist std::array<const char*, 1>{ 13618bd25ccdSJames Feist "xyz.openbmc_project.Control.FanRedundancy"}); 13628bd25ccdSJames Feist } 13638bd25ccdSJames Feist 1364b5a76932SEd Tanous inline void 136581ce609eSEd Tanous sortJSONResponse(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 136649c53ac9SJohnathan Mantey { 13678d1b46d7Szhanghch05 nlohmann::json& response = sensorsAsyncResp->asyncResp->res.jsonValue; 136849c53ac9SJohnathan Mantey std::array<std::string, 2> sensorHeaders{"Temperatures", "Fans"}; 136981ce609eSEd Tanous if (sensorsAsyncResp->chassisSubNode == sensors::node::power) 137049c53ac9SJohnathan Mantey { 137149c53ac9SJohnathan Mantey sensorHeaders = {"Voltages", "PowerSupplies"}; 137249c53ac9SJohnathan Mantey } 137349c53ac9SJohnathan Mantey for (const std::string& sensorGroup : sensorHeaders) 137449c53ac9SJohnathan Mantey { 137549c53ac9SJohnathan Mantey nlohmann::json::iterator entry = response.find(sensorGroup); 137649c53ac9SJohnathan Mantey if (entry != response.end()) 137749c53ac9SJohnathan Mantey { 137849c53ac9SJohnathan Mantey std::sort(entry->begin(), entry->end(), 137949c53ac9SJohnathan Mantey [](nlohmann::json& c1, nlohmann::json& c2) { 138049c53ac9SJohnathan Mantey return c1["Name"] < c2["Name"]; 138149c53ac9SJohnathan Mantey }); 138249c53ac9SJohnathan Mantey 138349c53ac9SJohnathan Mantey // add the index counts to the end of each entry 138449c53ac9SJohnathan Mantey size_t count = 0; 138549c53ac9SJohnathan Mantey for (nlohmann::json& sensorJson : *entry) 138649c53ac9SJohnathan Mantey { 138749c53ac9SJohnathan Mantey nlohmann::json::iterator odata = sensorJson.find("@odata.id"); 138849c53ac9SJohnathan Mantey if (odata == sensorJson.end()) 138949c53ac9SJohnathan Mantey { 139049c53ac9SJohnathan Mantey continue; 139149c53ac9SJohnathan Mantey } 139249c53ac9SJohnathan Mantey std::string* value = odata->get_ptr<std::string*>(); 139349c53ac9SJohnathan Mantey if (value != nullptr) 139449c53ac9SJohnathan Mantey { 139549c53ac9SJohnathan Mantey *value += std::to_string(count); 139649c53ac9SJohnathan Mantey count++; 139781ce609eSEd Tanous sensorsAsyncResp->updateUri(sensorJson["Name"], *value); 139849c53ac9SJohnathan Mantey } 139949c53ac9SJohnathan Mantey } 140049c53ac9SJohnathan Mantey } 140149c53ac9SJohnathan Mantey } 140249c53ac9SJohnathan Mantey } 140349c53ac9SJohnathan Mantey 140408777fb0SLewanczyk, Dawid /** 1405adc4f0dbSShawn McCarney * @brief Finds the inventory item with the specified object path. 1406adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1407adc4f0dbSShawn McCarney * @param invItemObjPath D-Bus object path of inventory item. 1408adc4f0dbSShawn McCarney * @return Inventory item within vector, or nullptr if no match found. 14098fb49dd6SShawn McCarney */ 141023a21a1cSEd Tanous inline InventoryItem* findInventoryItem( 1411b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1412adc4f0dbSShawn McCarney const std::string& invItemObjPath) 14138fb49dd6SShawn McCarney { 1414adc4f0dbSShawn McCarney for (InventoryItem& inventoryItem : *inventoryItems) 14158fb49dd6SShawn McCarney { 1416adc4f0dbSShawn McCarney if (inventoryItem.objectPath == invItemObjPath) 14178fb49dd6SShawn McCarney { 1418adc4f0dbSShawn McCarney return &inventoryItem; 14198fb49dd6SShawn McCarney } 14208fb49dd6SShawn McCarney } 14218fb49dd6SShawn McCarney return nullptr; 14228fb49dd6SShawn McCarney } 14238fb49dd6SShawn McCarney 14248fb49dd6SShawn McCarney /** 1425adc4f0dbSShawn McCarney * @brief Finds the inventory item associated with the specified sensor. 1426adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1427adc4f0dbSShawn McCarney * @param sensorObjPath D-Bus object path of sensor. 1428adc4f0dbSShawn McCarney * @return Inventory item within vector, or nullptr if no match found. 14298fb49dd6SShawn McCarney */ 143023a21a1cSEd Tanous inline InventoryItem* findInventoryItemForSensor( 1431b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1432adc4f0dbSShawn McCarney const std::string& sensorObjPath) 1433adc4f0dbSShawn McCarney { 1434adc4f0dbSShawn McCarney for (InventoryItem& inventoryItem : *inventoryItems) 1435adc4f0dbSShawn McCarney { 1436adc4f0dbSShawn McCarney if (inventoryItem.sensors.count(sensorObjPath) > 0) 1437adc4f0dbSShawn McCarney { 1438adc4f0dbSShawn McCarney return &inventoryItem; 1439adc4f0dbSShawn McCarney } 1440adc4f0dbSShawn McCarney } 1441adc4f0dbSShawn McCarney return nullptr; 1442adc4f0dbSShawn McCarney } 1443adc4f0dbSShawn McCarney 1444adc4f0dbSShawn McCarney /** 1445d500549bSAnthony Wilson * @brief Finds the inventory item associated with the specified led path. 1446d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1447d500549bSAnthony Wilson * @param ledObjPath D-Bus object path of led. 1448d500549bSAnthony Wilson * @return Inventory item within vector, or nullptr if no match found. 1449d500549bSAnthony Wilson */ 1450d500549bSAnthony Wilson inline InventoryItem* 1451d500549bSAnthony Wilson findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems, 1452d500549bSAnthony Wilson const std::string& ledObjPath) 1453d500549bSAnthony Wilson { 1454d500549bSAnthony Wilson for (InventoryItem& inventoryItem : inventoryItems) 1455d500549bSAnthony Wilson { 1456d500549bSAnthony Wilson if (inventoryItem.ledObjectPath == ledObjPath) 1457d500549bSAnthony Wilson { 1458d500549bSAnthony Wilson return &inventoryItem; 1459d500549bSAnthony Wilson } 1460d500549bSAnthony Wilson } 1461d500549bSAnthony Wilson return nullptr; 1462d500549bSAnthony Wilson } 1463d500549bSAnthony Wilson 1464d500549bSAnthony Wilson /** 1465adc4f0dbSShawn McCarney * @brief Adds inventory item and associated sensor to specified vector. 1466adc4f0dbSShawn McCarney * 1467adc4f0dbSShawn McCarney * Adds a new InventoryItem to the vector if necessary. Searches for an 1468adc4f0dbSShawn McCarney * existing InventoryItem with the specified object path. If not found, one is 1469adc4f0dbSShawn McCarney * added to the vector. 1470adc4f0dbSShawn McCarney * 1471adc4f0dbSShawn McCarney * Next, the specified sensor is added to the set of sensors associated with the 1472adc4f0dbSShawn McCarney * InventoryItem. 1473adc4f0dbSShawn McCarney * 1474adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1475adc4f0dbSShawn McCarney * @param invItemObjPath D-Bus object path of inventory item. 1476adc4f0dbSShawn McCarney * @param sensorObjPath D-Bus object path of sensor 1477adc4f0dbSShawn McCarney */ 1478b5a76932SEd Tanous inline void addInventoryItem( 1479b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1480b5a76932SEd Tanous const std::string& invItemObjPath, const std::string& sensorObjPath) 1481adc4f0dbSShawn McCarney { 1482adc4f0dbSShawn McCarney // Look for inventory item in vector 1483adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 1484adc4f0dbSShawn McCarney findInventoryItem(inventoryItems, invItemObjPath); 1485adc4f0dbSShawn McCarney 1486adc4f0dbSShawn McCarney // If inventory item doesn't exist in vector, add it 1487adc4f0dbSShawn McCarney if (inventoryItem == nullptr) 1488adc4f0dbSShawn McCarney { 1489adc4f0dbSShawn McCarney inventoryItems->emplace_back(invItemObjPath); 1490adc4f0dbSShawn McCarney inventoryItem = &(inventoryItems->back()); 1491adc4f0dbSShawn McCarney } 1492adc4f0dbSShawn McCarney 1493adc4f0dbSShawn McCarney // Add sensor to set of sensors associated with inventory item 1494adc4f0dbSShawn McCarney inventoryItem->sensors.emplace(sensorObjPath); 1495adc4f0dbSShawn McCarney } 1496adc4f0dbSShawn McCarney 1497adc4f0dbSShawn McCarney /** 1498adc4f0dbSShawn McCarney * @brief Stores D-Bus data in the specified inventory item. 1499adc4f0dbSShawn McCarney * 1500adc4f0dbSShawn McCarney * Finds D-Bus data in the specified map of interfaces. Stores the data in the 1501adc4f0dbSShawn McCarney * specified InventoryItem. 1502adc4f0dbSShawn McCarney * 1503adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 1504adc4f0dbSShawn McCarney * response. 1505adc4f0dbSShawn McCarney * 1506adc4f0dbSShawn McCarney * @param inventoryItem Inventory item where data will be stored. 1507adc4f0dbSShawn McCarney * @param interfacesDict Map containing D-Bus interfaces and their properties 1508adc4f0dbSShawn McCarney * for the specified inventory item. 1509adc4f0dbSShawn McCarney */ 151023a21a1cSEd Tanous inline void storeInventoryItemData( 1511adc4f0dbSShawn McCarney InventoryItem& inventoryItem, 15128fb49dd6SShawn McCarney const boost::container::flat_map< 1513*168e20c1SEd Tanous std::string, boost::container::flat_map< 1514*168e20c1SEd Tanous std::string, dbus::utility::DbusVariantType>>& 15158fb49dd6SShawn McCarney interfacesDict) 15168fb49dd6SShawn McCarney { 1517adc4f0dbSShawn McCarney // Get properties from Inventory.Item interface 1518adc4f0dbSShawn McCarney auto interfaceIt = 1519adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Item"); 1520adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 15218fb49dd6SShawn McCarney { 1522adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Present"); 1523adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 15248fb49dd6SShawn McCarney { 1525adc4f0dbSShawn McCarney const bool* value = std::get_if<bool>(&propertyIt->second); 1526adc4f0dbSShawn McCarney if (value != nullptr) 15278fb49dd6SShawn McCarney { 1528adc4f0dbSShawn McCarney inventoryItem.isPresent = *value; 15298fb49dd6SShawn McCarney } 15308fb49dd6SShawn McCarney } 15318fb49dd6SShawn McCarney } 15328fb49dd6SShawn McCarney 1533adc4f0dbSShawn McCarney // Check if Inventory.Item.PowerSupply interface is present 1534adc4f0dbSShawn McCarney interfaceIt = 1535adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Item.PowerSupply"); 1536adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 15378fb49dd6SShawn McCarney { 1538adc4f0dbSShawn McCarney inventoryItem.isPowerSupply = true; 15398fb49dd6SShawn McCarney } 1540adc4f0dbSShawn McCarney 1541adc4f0dbSShawn McCarney // Get properties from Inventory.Decorator.Asset interface 1542adc4f0dbSShawn McCarney interfaceIt = 1543adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Decorator.Asset"); 1544adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 1545adc4f0dbSShawn McCarney { 1546adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Manufacturer"); 1547adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1548adc4f0dbSShawn McCarney { 1549adc4f0dbSShawn McCarney const std::string* value = 1550adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1551adc4f0dbSShawn McCarney if (value != nullptr) 1552adc4f0dbSShawn McCarney { 1553adc4f0dbSShawn McCarney inventoryItem.manufacturer = *value; 1554adc4f0dbSShawn McCarney } 1555adc4f0dbSShawn McCarney } 1556adc4f0dbSShawn McCarney 1557adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("Model"); 1558adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1559adc4f0dbSShawn McCarney { 1560adc4f0dbSShawn McCarney const std::string* value = 1561adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1562adc4f0dbSShawn McCarney if (value != nullptr) 1563adc4f0dbSShawn McCarney { 1564adc4f0dbSShawn McCarney inventoryItem.model = *value; 1565adc4f0dbSShawn McCarney } 1566adc4f0dbSShawn McCarney } 1567adc4f0dbSShawn McCarney 1568adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("PartNumber"); 1569adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1570adc4f0dbSShawn McCarney { 1571adc4f0dbSShawn McCarney const std::string* value = 1572adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1573adc4f0dbSShawn McCarney if (value != nullptr) 1574adc4f0dbSShawn McCarney { 1575adc4f0dbSShawn McCarney inventoryItem.partNumber = *value; 1576adc4f0dbSShawn McCarney } 1577adc4f0dbSShawn McCarney } 1578adc4f0dbSShawn McCarney 1579adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("SerialNumber"); 1580adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1581adc4f0dbSShawn McCarney { 1582adc4f0dbSShawn McCarney const std::string* value = 1583adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1584adc4f0dbSShawn McCarney if (value != nullptr) 1585adc4f0dbSShawn McCarney { 1586adc4f0dbSShawn McCarney inventoryItem.serialNumber = *value; 1587adc4f0dbSShawn McCarney } 1588adc4f0dbSShawn McCarney } 1589adc4f0dbSShawn McCarney } 1590adc4f0dbSShawn McCarney 1591adc4f0dbSShawn McCarney // Get properties from State.Decorator.OperationalStatus interface 1592adc4f0dbSShawn McCarney interfaceIt = interfacesDict.find( 1593adc4f0dbSShawn McCarney "xyz.openbmc_project.State.Decorator.OperationalStatus"); 1594adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 1595adc4f0dbSShawn McCarney { 1596adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Functional"); 1597adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1598adc4f0dbSShawn McCarney { 1599adc4f0dbSShawn McCarney const bool* value = std::get_if<bool>(&propertyIt->second); 1600adc4f0dbSShawn McCarney if (value != nullptr) 1601adc4f0dbSShawn McCarney { 1602adc4f0dbSShawn McCarney inventoryItem.isFunctional = *value; 16038fb49dd6SShawn McCarney } 16048fb49dd6SShawn McCarney } 16058fb49dd6SShawn McCarney } 16068fb49dd6SShawn McCarney } 16078fb49dd6SShawn McCarney 16088fb49dd6SShawn McCarney /** 1609adc4f0dbSShawn McCarney * @brief Gets D-Bus data for inventory items associated with sensors. 16108fb49dd6SShawn McCarney * 1611adc4f0dbSShawn McCarney * Uses the specified connections (services) to obtain D-Bus data for inventory 1612adc4f0dbSShawn McCarney * items associated with sensors. Stores the resulting data in the 1613adc4f0dbSShawn McCarney * inventoryItems vector. 16148fb49dd6SShawn McCarney * 1615adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 1616adc4f0dbSShawn McCarney * response. 1617adc4f0dbSShawn McCarney * 1618adc4f0dbSShawn McCarney * Finds the inventory item data asynchronously. Invokes callback when data has 1619adc4f0dbSShawn McCarney * been obtained. 1620adc4f0dbSShawn McCarney * 1621adc4f0dbSShawn McCarney * The callback must have the following signature: 1622adc4f0dbSShawn McCarney * @code 1623d500549bSAnthony Wilson * callback(void) 1624adc4f0dbSShawn McCarney * @endcode 1625adc4f0dbSShawn McCarney * 1626adc4f0dbSShawn McCarney * This function is called recursively, obtaining data asynchronously from one 1627adc4f0dbSShawn McCarney * connection in each call. This ensures the callback is not invoked until the 1628adc4f0dbSShawn McCarney * last asynchronous function has completed. 16298fb49dd6SShawn McCarney * 16308fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 1631adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1632adc4f0dbSShawn McCarney * @param invConnections Connections that provide data for the inventory items. 16338fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 16348fb49dd6SShawn McCarney * implements ObjectManager. 1635adc4f0dbSShawn McCarney * @param callback Callback to invoke when inventory data has been obtained. 1636adc4f0dbSShawn McCarney * @param invConnectionsIndex Current index in invConnections. Only specified 1637adc4f0dbSShawn McCarney * in recursive calls to this function. 16388fb49dd6SShawn McCarney */ 1639adc4f0dbSShawn McCarney template <typename Callback> 1640adc4f0dbSShawn McCarney static void getInventoryItemsData( 16418fb49dd6SShawn McCarney std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1642adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 16438fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> invConnections, 16448fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 1645adc4f0dbSShawn McCarney objectMgrPaths, 1646271584abSEd Tanous Callback&& callback, size_t invConnectionsIndex = 0) 16478fb49dd6SShawn McCarney { 1648adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData enter"; 16498fb49dd6SShawn McCarney 1650adc4f0dbSShawn McCarney // If no more connections left, call callback 1651adc4f0dbSShawn McCarney if (invConnectionsIndex >= invConnections->size()) 16528fb49dd6SShawn McCarney { 1653d500549bSAnthony Wilson callback(); 1654adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData exit"; 1655adc4f0dbSShawn McCarney return; 1656adc4f0dbSShawn McCarney } 1657adc4f0dbSShawn McCarney 1658adc4f0dbSShawn McCarney // Get inventory item data from current connection 1659adc4f0dbSShawn McCarney auto it = invConnections->nth(invConnectionsIndex); 1660adc4f0dbSShawn McCarney if (it != invConnections->end()) 1661adc4f0dbSShawn McCarney { 1662adc4f0dbSShawn McCarney const std::string& invConnection = *it; 1663adc4f0dbSShawn McCarney 16648fb49dd6SShawn McCarney // Response handler for GetManagedObjects 1665adc4f0dbSShawn McCarney auto respHandler = [sensorsAsyncResp, inventoryItems, invConnections, 1666adc4f0dbSShawn McCarney objectMgrPaths, callback{std::move(callback)}, 1667adc4f0dbSShawn McCarney invConnectionsIndex]( 1668adc4f0dbSShawn McCarney const boost::system::error_code ec, 16698fb49dd6SShawn McCarney ManagedObjectsVectorType& resp) { 1670adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler enter"; 16718fb49dd6SShawn McCarney if (ec) 16728fb49dd6SShawn McCarney { 16738fb49dd6SShawn McCarney BMCWEB_LOG_ERROR 1674adc4f0dbSShawn McCarney << "getInventoryItemsData respHandler DBus error " << ec; 16758d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 16768fb49dd6SShawn McCarney return; 16778fb49dd6SShawn McCarney } 16788fb49dd6SShawn McCarney 16798fb49dd6SShawn McCarney // Loop through returned object paths 16808fb49dd6SShawn McCarney for (const auto& objDictEntry : resp) 16818fb49dd6SShawn McCarney { 16828fb49dd6SShawn McCarney const std::string& objPath = 16838fb49dd6SShawn McCarney static_cast<const std::string&>(objDictEntry.first); 16848fb49dd6SShawn McCarney 1685adc4f0dbSShawn McCarney // If this object path is one of the specified inventory items 1686adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 1687adc4f0dbSShawn McCarney findInventoryItem(inventoryItems, objPath); 1688adc4f0dbSShawn McCarney if (inventoryItem != nullptr) 16898fb49dd6SShawn McCarney { 1690adc4f0dbSShawn McCarney // Store inventory data in InventoryItem 1691adc4f0dbSShawn McCarney storeInventoryItemData(*inventoryItem, objDictEntry.second); 16928fb49dd6SShawn McCarney } 16938fb49dd6SShawn McCarney } 16948fb49dd6SShawn McCarney 1695adc4f0dbSShawn McCarney // Recurse to get inventory item data from next connection 1696adc4f0dbSShawn McCarney getInventoryItemsData(sensorsAsyncResp, inventoryItems, 1697adc4f0dbSShawn McCarney invConnections, objectMgrPaths, 1698adc4f0dbSShawn McCarney std::move(callback), invConnectionsIndex + 1); 1699adc4f0dbSShawn McCarney 1700adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler exit"; 17018fb49dd6SShawn McCarney }; 17028fb49dd6SShawn McCarney 17038fb49dd6SShawn McCarney // Find DBus object path that implements ObjectManager for the current 17048fb49dd6SShawn McCarney // connection. If no mapping found, default to "/". 17058fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(invConnection); 17068fb49dd6SShawn McCarney const std::string& objectMgrPath = 17078fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 17088fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << invConnection << " is " 17098fb49dd6SShawn McCarney << objectMgrPath; 17108fb49dd6SShawn McCarney 17118fb49dd6SShawn McCarney // Get all object paths and their interfaces for current connection 17128fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 17138fb49dd6SShawn McCarney std::move(respHandler), invConnection, objectMgrPath, 17148fb49dd6SShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 17158fb49dd6SShawn McCarney } 17168fb49dd6SShawn McCarney 1717adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData exit"; 17188fb49dd6SShawn McCarney } 17198fb49dd6SShawn McCarney 17208fb49dd6SShawn McCarney /** 1721adc4f0dbSShawn McCarney * @brief Gets connections that provide D-Bus data for inventory items. 17228fb49dd6SShawn McCarney * 1723adc4f0dbSShawn McCarney * Gets the D-Bus connections (services) that provide data for the inventory 1724adc4f0dbSShawn McCarney * items that are associated with sensors. 17258fb49dd6SShawn McCarney * 17268fb49dd6SShawn McCarney * Finds the connections asynchronously. Invokes callback when information has 17278fb49dd6SShawn McCarney * been obtained. 17288fb49dd6SShawn McCarney * 17298fb49dd6SShawn McCarney * The callback must have the following signature: 17308fb49dd6SShawn McCarney * @code 17318fb49dd6SShawn McCarney * callback(std::shared_ptr<boost::container::flat_set<std::string>> 17328fb49dd6SShawn McCarney * invConnections) 17338fb49dd6SShawn McCarney * @endcode 17348fb49dd6SShawn McCarney * 17358fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 1736adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 17378fb49dd6SShawn McCarney * @param callback Callback to invoke when connections have been obtained. 17388fb49dd6SShawn McCarney */ 17398fb49dd6SShawn McCarney template <typename Callback> 17408fb49dd6SShawn McCarney static void getInventoryItemsConnections( 1741b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 1742b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 17438fb49dd6SShawn McCarney Callback&& callback) 17448fb49dd6SShawn McCarney { 17458fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections enter"; 17468fb49dd6SShawn McCarney 17478fb49dd6SShawn McCarney const std::string path = "/xyz/openbmc_project/inventory"; 1748adc4f0dbSShawn McCarney const std::array<std::string, 4> interfaces = { 17498fb49dd6SShawn McCarney "xyz.openbmc_project.Inventory.Item", 1750adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Item.PowerSupply", 1751adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Decorator.Asset", 17528fb49dd6SShawn McCarney "xyz.openbmc_project.State.Decorator.OperationalStatus"}; 17538fb49dd6SShawn McCarney 17548fb49dd6SShawn McCarney // Response handler for parsing output from GetSubTree 17558fb49dd6SShawn McCarney auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 1756adc4f0dbSShawn McCarney inventoryItems](const boost::system::error_code ec, 17578fb49dd6SShawn McCarney const GetSubTreeType& subtree) { 17588fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler enter"; 17598fb49dd6SShawn McCarney if (ec) 17608fb49dd6SShawn McCarney { 17618d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 17628fb49dd6SShawn McCarney BMCWEB_LOG_ERROR 17638fb49dd6SShawn McCarney << "getInventoryItemsConnections respHandler DBus error " << ec; 17648fb49dd6SShawn McCarney return; 17658fb49dd6SShawn McCarney } 17668fb49dd6SShawn McCarney 17678fb49dd6SShawn McCarney // Make unique list of connections for desired inventory items 17688fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> 17698fb49dd6SShawn McCarney invConnections = 17708fb49dd6SShawn McCarney std::make_shared<boost::container::flat_set<std::string>>(); 17718fb49dd6SShawn McCarney invConnections->reserve(8); 17728fb49dd6SShawn McCarney 17738fb49dd6SShawn McCarney // Loop through objects from GetSubTree 17748fb49dd6SShawn McCarney for (const std::pair< 17758fb49dd6SShawn McCarney std::string, 17768fb49dd6SShawn McCarney std::vector<std::pair<std::string, std::vector<std::string>>>>& 17778fb49dd6SShawn McCarney object : subtree) 17788fb49dd6SShawn McCarney { 1779adc4f0dbSShawn McCarney // Check if object path is one of the specified inventory items 17808fb49dd6SShawn McCarney const std::string& objPath = object.first; 1781adc4f0dbSShawn McCarney if (findInventoryItem(inventoryItems, objPath) != nullptr) 17828fb49dd6SShawn McCarney { 17838fb49dd6SShawn McCarney // Store all connections to inventory item 17848fb49dd6SShawn McCarney for (const std::pair<std::string, std::vector<std::string>>& 17858fb49dd6SShawn McCarney objData : object.second) 17868fb49dd6SShawn McCarney { 17878fb49dd6SShawn McCarney const std::string& invConnection = objData.first; 17888fb49dd6SShawn McCarney invConnections->insert(invConnection); 17898fb49dd6SShawn McCarney } 17908fb49dd6SShawn McCarney } 17918fb49dd6SShawn McCarney } 1792d500549bSAnthony Wilson 17938fb49dd6SShawn McCarney callback(invConnections); 17948fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler exit"; 17958fb49dd6SShawn McCarney }; 17968fb49dd6SShawn McCarney 17978fb49dd6SShawn McCarney // Make call to ObjectMapper to find all inventory items 17988fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 17998fb49dd6SShawn McCarney std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 18008fb49dd6SShawn McCarney "/xyz/openbmc_project/object_mapper", 18018fb49dd6SShawn McCarney "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces); 18028fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections exit"; 18038fb49dd6SShawn McCarney } 18048fb49dd6SShawn McCarney 18058fb49dd6SShawn McCarney /** 1806adc4f0dbSShawn McCarney * @brief Gets associations from sensors to inventory items. 18078fb49dd6SShawn McCarney * 18088fb49dd6SShawn McCarney * Looks for ObjectMapper associations from the specified sensors to related 1809d500549bSAnthony Wilson * inventory items. Then finds the associations from those inventory items to 1810d500549bSAnthony Wilson * their LEDs, if any. 18118fb49dd6SShawn McCarney * 18128fb49dd6SShawn McCarney * Finds the inventory items asynchronously. Invokes callback when information 18138fb49dd6SShawn McCarney * has been obtained. 18148fb49dd6SShawn McCarney * 18158fb49dd6SShawn McCarney * The callback must have the following signature: 18168fb49dd6SShawn McCarney * @code 1817adc4f0dbSShawn McCarney * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 18188fb49dd6SShawn McCarney * @endcode 18198fb49dd6SShawn McCarney * 18208fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 18218fb49dd6SShawn McCarney * @param sensorNames All sensors within the current chassis. 18228fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 18238fb49dd6SShawn McCarney * implements ObjectManager. 18248fb49dd6SShawn McCarney * @param callback Callback to invoke when inventory items have been obtained. 18258fb49dd6SShawn McCarney */ 18268fb49dd6SShawn McCarney template <typename Callback> 1827adc4f0dbSShawn McCarney static void getInventoryItemAssociations( 1828b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 1829b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 1830b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_map<std::string, std::string>>& 18318fb49dd6SShawn McCarney objectMgrPaths, 18328fb49dd6SShawn McCarney Callback&& callback) 18338fb49dd6SShawn McCarney { 1834adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations enter"; 18358fb49dd6SShawn McCarney 18368fb49dd6SShawn McCarney // Response handler for GetManagedObjects 18378fb49dd6SShawn McCarney auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 18388fb49dd6SShawn McCarney sensorNames](const boost::system::error_code ec, 18398fb49dd6SShawn McCarney dbus::utility::ManagedObjectType& resp) { 1840adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler enter"; 18418fb49dd6SShawn McCarney if (ec) 18428fb49dd6SShawn McCarney { 1843adc4f0dbSShawn McCarney BMCWEB_LOG_ERROR 1844adc4f0dbSShawn McCarney << "getInventoryItemAssociations respHandler DBus error " << ec; 18458d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 18468fb49dd6SShawn McCarney return; 18478fb49dd6SShawn McCarney } 18488fb49dd6SShawn McCarney 1849adc4f0dbSShawn McCarney // Create vector to hold list of inventory items 1850adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems = 1851adc4f0dbSShawn McCarney std::make_shared<std::vector<InventoryItem>>(); 1852adc4f0dbSShawn McCarney 18538fb49dd6SShawn McCarney // Loop through returned object paths 18548fb49dd6SShawn McCarney std::string sensorAssocPath; 18558fb49dd6SShawn McCarney sensorAssocPath.reserve(128); // avoid memory allocations 18568fb49dd6SShawn McCarney for (const auto& objDictEntry : resp) 18578fb49dd6SShawn McCarney { 18588fb49dd6SShawn McCarney const std::string& objPath = 18598fb49dd6SShawn McCarney static_cast<const std::string&>(objDictEntry.first); 18608fb49dd6SShawn McCarney const boost::container::flat_map< 18618fb49dd6SShawn McCarney std::string, boost::container::flat_map< 18628fb49dd6SShawn McCarney std::string, dbus::utility::DbusVariantType>>& 18638fb49dd6SShawn McCarney interfacesDict = objDictEntry.second; 18648fb49dd6SShawn McCarney 18658fb49dd6SShawn McCarney // If path is inventory association for one of the specified sensors 18668fb49dd6SShawn McCarney for (const std::string& sensorName : *sensorNames) 18678fb49dd6SShawn McCarney { 18688fb49dd6SShawn McCarney sensorAssocPath = sensorName; 18698fb49dd6SShawn McCarney sensorAssocPath += "/inventory"; 18708fb49dd6SShawn McCarney if (objPath == sensorAssocPath) 18718fb49dd6SShawn McCarney { 18728fb49dd6SShawn McCarney // Get Association interface for object path 18738fb49dd6SShawn McCarney auto assocIt = 18748fb49dd6SShawn McCarney interfacesDict.find("xyz.openbmc_project.Association"); 18758fb49dd6SShawn McCarney if (assocIt != interfacesDict.end()) 18768fb49dd6SShawn McCarney { 18778fb49dd6SShawn McCarney // Get inventory item from end point 18788fb49dd6SShawn McCarney auto endpointsIt = assocIt->second.find("endpoints"); 18798fb49dd6SShawn McCarney if (endpointsIt != assocIt->second.end()) 18808fb49dd6SShawn McCarney { 18818fb49dd6SShawn McCarney const std::vector<std::string>* endpoints = 18828fb49dd6SShawn McCarney std::get_if<std::vector<std::string>>( 18838fb49dd6SShawn McCarney &endpointsIt->second); 18848fb49dd6SShawn McCarney if ((endpoints != nullptr) && !endpoints->empty()) 18858fb49dd6SShawn McCarney { 1886adc4f0dbSShawn McCarney // Add inventory item to vector 1887adc4f0dbSShawn McCarney const std::string& invItemPath = 1888adc4f0dbSShawn McCarney endpoints->front(); 1889adc4f0dbSShawn McCarney addInventoryItem(inventoryItems, invItemPath, 1890adc4f0dbSShawn McCarney sensorName); 18918fb49dd6SShawn McCarney } 18928fb49dd6SShawn McCarney } 18938fb49dd6SShawn McCarney } 18948fb49dd6SShawn McCarney break; 18958fb49dd6SShawn McCarney } 18968fb49dd6SShawn McCarney } 18978fb49dd6SShawn McCarney } 18988fb49dd6SShawn McCarney 1899d500549bSAnthony Wilson // Now loop through the returned object paths again, this time to 1900d500549bSAnthony Wilson // find the leds associated with the inventory items we just found 1901d500549bSAnthony Wilson std::string inventoryAssocPath; 1902d500549bSAnthony Wilson inventoryAssocPath.reserve(128); // avoid memory allocations 1903d500549bSAnthony Wilson for (const auto& objDictEntry : resp) 1904d500549bSAnthony Wilson { 1905d500549bSAnthony Wilson const std::string& objPath = 1906d500549bSAnthony Wilson static_cast<const std::string&>(objDictEntry.first); 1907d500549bSAnthony Wilson const boost::container::flat_map< 1908d500549bSAnthony Wilson std::string, boost::container::flat_map< 1909d500549bSAnthony Wilson std::string, dbus::utility::DbusVariantType>>& 1910d500549bSAnthony Wilson interfacesDict = objDictEntry.second; 1911d500549bSAnthony Wilson 1912d500549bSAnthony Wilson for (InventoryItem& inventoryItem : *inventoryItems) 1913d500549bSAnthony Wilson { 1914d500549bSAnthony Wilson inventoryAssocPath = inventoryItem.objectPath; 1915d500549bSAnthony Wilson inventoryAssocPath += "/leds"; 1916d500549bSAnthony Wilson if (objPath == inventoryAssocPath) 1917d500549bSAnthony Wilson { 1918d500549bSAnthony Wilson // Get Association interface for object path 1919d500549bSAnthony Wilson auto assocIt = 1920d500549bSAnthony Wilson interfacesDict.find("xyz.openbmc_project.Association"); 1921d500549bSAnthony Wilson if (assocIt != interfacesDict.end()) 1922d500549bSAnthony Wilson { 1923d500549bSAnthony Wilson // Get inventory item from end point 1924d500549bSAnthony Wilson auto endpointsIt = assocIt->second.find("endpoints"); 1925d500549bSAnthony Wilson if (endpointsIt != assocIt->second.end()) 1926d500549bSAnthony Wilson { 1927d500549bSAnthony Wilson const std::vector<std::string>* endpoints = 1928d500549bSAnthony Wilson std::get_if<std::vector<std::string>>( 1929d500549bSAnthony Wilson &endpointsIt->second); 1930d500549bSAnthony Wilson if ((endpoints != nullptr) && !endpoints->empty()) 1931d500549bSAnthony Wilson { 1932d500549bSAnthony Wilson // Store LED path in inventory item 1933d500549bSAnthony Wilson const std::string& ledPath = endpoints->front(); 1934d500549bSAnthony Wilson inventoryItem.ledObjectPath = ledPath; 1935d500549bSAnthony Wilson } 1936d500549bSAnthony Wilson } 1937d500549bSAnthony Wilson } 1938d500549bSAnthony Wilson break; 1939d500549bSAnthony Wilson } 1940d500549bSAnthony Wilson } 1941d500549bSAnthony Wilson } 1942adc4f0dbSShawn McCarney callback(inventoryItems); 1943adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler exit"; 19448fb49dd6SShawn McCarney }; 19458fb49dd6SShawn McCarney 19468fb49dd6SShawn McCarney // Find DBus object path that implements ObjectManager for ObjectMapper 19478fb49dd6SShawn McCarney std::string connection = "xyz.openbmc_project.ObjectMapper"; 19488fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(connection); 19498fb49dd6SShawn McCarney const std::string& objectMgrPath = 19508fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 19518fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is " 19528fb49dd6SShawn McCarney << objectMgrPath; 19538fb49dd6SShawn McCarney 19548fb49dd6SShawn McCarney // Call GetManagedObjects on the ObjectMapper to get all associations 19558fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 19568fb49dd6SShawn McCarney std::move(respHandler), connection, objectMgrPath, 19578fb49dd6SShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 19588fb49dd6SShawn McCarney 1959adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations exit"; 19608fb49dd6SShawn McCarney } 19618fb49dd6SShawn McCarney 19628fb49dd6SShawn McCarney /** 1963d500549bSAnthony Wilson * @brief Gets D-Bus data for inventory item leds associated with sensors. 1964d500549bSAnthony Wilson * 1965d500549bSAnthony Wilson * Uses the specified connections (services) to obtain D-Bus data for inventory 1966d500549bSAnthony Wilson * item leds associated with sensors. Stores the resulting data in the 1967d500549bSAnthony Wilson * inventoryItems vector. 1968d500549bSAnthony Wilson * 1969d500549bSAnthony Wilson * This data is later used to provide sensor property values in the JSON 1970d500549bSAnthony Wilson * response. 1971d500549bSAnthony Wilson * 1972d500549bSAnthony Wilson * Finds the inventory item led data asynchronously. Invokes callback when data 1973d500549bSAnthony Wilson * has been obtained. 1974d500549bSAnthony Wilson * 1975d500549bSAnthony Wilson * The callback must have the following signature: 1976d500549bSAnthony Wilson * @code 197742cbe538SGunnar Mills * callback() 1978d500549bSAnthony Wilson * @endcode 1979d500549bSAnthony Wilson * 1980d500549bSAnthony Wilson * This function is called recursively, obtaining data asynchronously from one 1981d500549bSAnthony Wilson * connection in each call. This ensures the callback is not invoked until the 1982d500549bSAnthony Wilson * last asynchronous function has completed. 1983d500549bSAnthony Wilson * 1984d500549bSAnthony Wilson * @param sensorsAsyncResp Pointer to object holding response data. 1985d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1986d500549bSAnthony Wilson * @param ledConnections Connections that provide data for the inventory leds. 1987d500549bSAnthony Wilson * @param callback Callback to invoke when inventory data has been obtained. 1988d500549bSAnthony Wilson * @param ledConnectionsIndex Current index in ledConnections. Only specified 1989d500549bSAnthony Wilson * in recursive calls to this function. 1990d500549bSAnthony Wilson */ 1991d500549bSAnthony Wilson template <typename Callback> 1992d500549bSAnthony Wilson void getInventoryLedData( 1993d500549bSAnthony Wilson std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1994d500549bSAnthony Wilson std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 1995d500549bSAnthony Wilson std::shared_ptr<boost::container::flat_map<std::string, std::string>> 1996d500549bSAnthony Wilson ledConnections, 1997d500549bSAnthony Wilson Callback&& callback, size_t ledConnectionsIndex = 0) 1998d500549bSAnthony Wilson { 1999d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData enter"; 2000d500549bSAnthony Wilson 2001d500549bSAnthony Wilson // If no more connections left, call callback 2002d500549bSAnthony Wilson if (ledConnectionsIndex >= ledConnections->size()) 2003d500549bSAnthony Wilson { 200442cbe538SGunnar Mills callback(); 2005d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData exit"; 2006d500549bSAnthony Wilson return; 2007d500549bSAnthony Wilson } 2008d500549bSAnthony Wilson 2009d500549bSAnthony Wilson // Get inventory item data from current connection 2010d500549bSAnthony Wilson auto it = ledConnections->nth(ledConnectionsIndex); 2011d500549bSAnthony Wilson if (it != ledConnections->end()) 2012d500549bSAnthony Wilson { 2013d500549bSAnthony Wilson const std::string& ledPath = (*it).first; 2014d500549bSAnthony Wilson const std::string& ledConnection = (*it).second; 2015d500549bSAnthony Wilson // Response handler for Get State property 2016*168e20c1SEd Tanous auto respHandler = [sensorsAsyncResp, inventoryItems, ledConnections, 2017*168e20c1SEd Tanous ledPath, callback{std::move(callback)}, 2018*168e20c1SEd Tanous ledConnectionsIndex]( 2019*168e20c1SEd Tanous const boost::system::error_code ec, 2020*168e20c1SEd Tanous const dbus::utility::DbusVariantType& ledState) { 2021d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler enter"; 2022d500549bSAnthony Wilson if (ec) 2023d500549bSAnthony Wilson { 2024d500549bSAnthony Wilson BMCWEB_LOG_ERROR 2025d500549bSAnthony Wilson << "getInventoryLedData respHandler DBus error " << ec; 20268d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2027d500549bSAnthony Wilson return; 2028d500549bSAnthony Wilson } 2029d500549bSAnthony Wilson 2030d500549bSAnthony Wilson const std::string* state = std::get_if<std::string>(&ledState); 2031d500549bSAnthony Wilson if (state != nullptr) 2032d500549bSAnthony Wilson { 2033d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "Led state: " << *state; 2034d500549bSAnthony Wilson // Find inventory item with this LED object path 2035d500549bSAnthony Wilson InventoryItem* inventoryItem = 2036d500549bSAnthony Wilson findInventoryItemForLed(*inventoryItems, ledPath); 2037d500549bSAnthony Wilson if (inventoryItem != nullptr) 2038d500549bSAnthony Wilson { 2039d500549bSAnthony Wilson // Store LED state in InventoryItem 2040d500549bSAnthony Wilson if (boost::ends_with(*state, "On")) 2041d500549bSAnthony Wilson { 2042d500549bSAnthony Wilson inventoryItem->ledState = LedState::ON; 2043d500549bSAnthony Wilson } 2044d500549bSAnthony Wilson else if (boost::ends_with(*state, "Blink")) 2045d500549bSAnthony Wilson { 2046d500549bSAnthony Wilson inventoryItem->ledState = LedState::BLINK; 2047d500549bSAnthony Wilson } 2048d500549bSAnthony Wilson else if (boost::ends_with(*state, "Off")) 2049d500549bSAnthony Wilson { 2050d500549bSAnthony Wilson inventoryItem->ledState = LedState::OFF; 2051d500549bSAnthony Wilson } 2052d500549bSAnthony Wilson else 2053d500549bSAnthony Wilson { 2054d500549bSAnthony Wilson inventoryItem->ledState = LedState::UNKNOWN; 2055d500549bSAnthony Wilson } 2056d500549bSAnthony Wilson } 2057d500549bSAnthony Wilson } 2058d500549bSAnthony Wilson else 2059d500549bSAnthony Wilson { 2060d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "Failed to find State data for LED: " 2061d500549bSAnthony Wilson << ledPath; 2062d500549bSAnthony Wilson } 2063d500549bSAnthony Wilson 2064d500549bSAnthony Wilson // Recurse to get LED data from next connection 2065d500549bSAnthony Wilson getInventoryLedData(sensorsAsyncResp, inventoryItems, 2066d500549bSAnthony Wilson ledConnections, std::move(callback), 2067d500549bSAnthony Wilson ledConnectionsIndex + 1); 2068d500549bSAnthony Wilson 2069d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler exit"; 2070d500549bSAnthony Wilson }; 2071d500549bSAnthony Wilson 2072d500549bSAnthony Wilson // Get the State property for the current LED 2073d500549bSAnthony Wilson crow::connections::systemBus->async_method_call( 2074d500549bSAnthony Wilson std::move(respHandler), ledConnection, ledPath, 2075d500549bSAnthony Wilson "org.freedesktop.DBus.Properties", "Get", 2076d500549bSAnthony Wilson "xyz.openbmc_project.Led.Physical", "State"); 2077d500549bSAnthony Wilson } 2078d500549bSAnthony Wilson 2079d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData exit"; 2080d500549bSAnthony Wilson } 2081d500549bSAnthony Wilson 2082d500549bSAnthony Wilson /** 2083d500549bSAnthony Wilson * @brief Gets LED data for LEDs associated with given inventory items. 2084d500549bSAnthony Wilson * 2085d500549bSAnthony Wilson * Gets the D-Bus connections (services) that provide LED data for the LEDs 2086d500549bSAnthony Wilson * associated with the specified inventory items. Then gets the LED data from 2087d500549bSAnthony Wilson * each connection and stores it in the inventory item. 2088d500549bSAnthony Wilson * 2089d500549bSAnthony Wilson * This data is later used to provide sensor property values in the JSON 2090d500549bSAnthony Wilson * response. 2091d500549bSAnthony Wilson * 2092d500549bSAnthony Wilson * Finds the LED data asynchronously. Invokes callback when information has 2093d500549bSAnthony Wilson * been obtained. 2094d500549bSAnthony Wilson * 2095d500549bSAnthony Wilson * The callback must have the following signature: 2096d500549bSAnthony Wilson * @code 209742cbe538SGunnar Mills * callback() 2098d500549bSAnthony Wilson * @endcode 2099d500549bSAnthony Wilson * 2100d500549bSAnthony Wilson * @param sensorsAsyncResp Pointer to object holding response data. 2101d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 2102d500549bSAnthony Wilson * @param callback Callback to invoke when inventory items have been obtained. 2103d500549bSAnthony Wilson */ 2104d500549bSAnthony Wilson template <typename Callback> 2105d500549bSAnthony Wilson void getInventoryLeds( 2106d500549bSAnthony Wilson std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 2107d500549bSAnthony Wilson std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 2108d500549bSAnthony Wilson Callback&& callback) 2109d500549bSAnthony Wilson { 2110d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds enter"; 2111d500549bSAnthony Wilson 2112d500549bSAnthony Wilson const std::string path = "/xyz/openbmc_project"; 2113d500549bSAnthony Wilson const std::array<std::string, 1> interfaces = { 2114d500549bSAnthony Wilson "xyz.openbmc_project.Led.Physical"}; 2115d500549bSAnthony Wilson 2116d500549bSAnthony Wilson // Response handler for parsing output from GetSubTree 2117d500549bSAnthony Wilson auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 2118d500549bSAnthony Wilson inventoryItems](const boost::system::error_code ec, 2119d500549bSAnthony Wilson const GetSubTreeType& subtree) { 2120d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler enter"; 2121d500549bSAnthony Wilson if (ec) 2122d500549bSAnthony Wilson { 21238d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2124d500549bSAnthony Wilson BMCWEB_LOG_ERROR << "getInventoryLeds respHandler DBus error " 2125d500549bSAnthony Wilson << ec; 2126d500549bSAnthony Wilson return; 2127d500549bSAnthony Wilson } 2128d500549bSAnthony Wilson 2129d500549bSAnthony Wilson // Build map of LED object paths to connections 2130d500549bSAnthony Wilson std::shared_ptr<boost::container::flat_map<std::string, std::string>> 2131d500549bSAnthony Wilson ledConnections = std::make_shared< 2132d500549bSAnthony Wilson boost::container::flat_map<std::string, std::string>>(); 2133d500549bSAnthony Wilson 2134d500549bSAnthony Wilson // Loop through objects from GetSubTree 2135d500549bSAnthony Wilson for (const std::pair< 2136d500549bSAnthony Wilson std::string, 2137d500549bSAnthony Wilson std::vector<std::pair<std::string, std::vector<std::string>>>>& 2138d500549bSAnthony Wilson object : subtree) 2139d500549bSAnthony Wilson { 2140d500549bSAnthony Wilson // Check if object path is LED for one of the specified inventory 2141d500549bSAnthony Wilson // items 2142d500549bSAnthony Wilson const std::string& ledPath = object.first; 2143d500549bSAnthony Wilson if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr) 2144d500549bSAnthony Wilson { 2145d500549bSAnthony Wilson // Add mapping from ledPath to connection 2146d500549bSAnthony Wilson const std::string& connection = object.second.begin()->first; 2147d500549bSAnthony Wilson (*ledConnections)[ledPath] = connection; 2148d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "Added mapping " << ledPath << " -> " 2149d500549bSAnthony Wilson << connection; 2150d500549bSAnthony Wilson } 2151d500549bSAnthony Wilson } 2152d500549bSAnthony Wilson 2153d500549bSAnthony Wilson getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections, 2154d500549bSAnthony Wilson std::move(callback)); 2155d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler exit"; 2156d500549bSAnthony Wilson }; 2157d500549bSAnthony Wilson // Make call to ObjectMapper to find all inventory items 2158d500549bSAnthony Wilson crow::connections::systemBus->async_method_call( 2159d500549bSAnthony Wilson std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 2160d500549bSAnthony Wilson "/xyz/openbmc_project/object_mapper", 2161d500549bSAnthony Wilson "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces); 2162d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds exit"; 2163d500549bSAnthony Wilson } 2164d500549bSAnthony Wilson 2165d500549bSAnthony Wilson /** 216642cbe538SGunnar Mills * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent 216742cbe538SGunnar Mills * 216842cbe538SGunnar Mills * Uses the specified connections (services) (currently assumes just one) to 216942cbe538SGunnar Mills * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in 217042cbe538SGunnar Mills * the inventoryItems vector. Only stores data in Power Supply inventoryItems. 217142cbe538SGunnar Mills * 217242cbe538SGunnar Mills * This data is later used to provide sensor property values in the JSON 217342cbe538SGunnar Mills * response. 217442cbe538SGunnar Mills * 217542cbe538SGunnar Mills * Finds the Power Supply Attributes data asynchronously. Invokes callback 217642cbe538SGunnar Mills * when data has been obtained. 217742cbe538SGunnar Mills * 217842cbe538SGunnar Mills * The callback must have the following signature: 217942cbe538SGunnar Mills * @code 218042cbe538SGunnar Mills * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 218142cbe538SGunnar Mills * @endcode 218242cbe538SGunnar Mills * 218342cbe538SGunnar Mills * @param sensorsAsyncResp Pointer to object holding response data. 218442cbe538SGunnar Mills * @param inventoryItems D-Bus inventory items associated with sensors. 218542cbe538SGunnar Mills * @param psAttributesConnections Connections that provide data for the Power 218642cbe538SGunnar Mills * Supply Attributes 218742cbe538SGunnar Mills * @param callback Callback to invoke when data has been obtained. 218842cbe538SGunnar Mills */ 218942cbe538SGunnar Mills template <typename Callback> 219042cbe538SGunnar Mills void getPowerSupplyAttributesData( 2191b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 219242cbe538SGunnar Mills std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 219342cbe538SGunnar Mills const boost::container::flat_map<std::string, std::string>& 219442cbe538SGunnar Mills psAttributesConnections, 219542cbe538SGunnar Mills Callback&& callback) 219642cbe538SGunnar Mills { 219742cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData enter"; 219842cbe538SGunnar Mills 219942cbe538SGunnar Mills if (psAttributesConnections.empty()) 220042cbe538SGunnar Mills { 220142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Can't find PowerSupplyAttributes, no connections!"; 220242cbe538SGunnar Mills callback(inventoryItems); 220342cbe538SGunnar Mills return; 220442cbe538SGunnar Mills } 220542cbe538SGunnar Mills 220642cbe538SGunnar Mills // Assuming just one connection (service) for now 220742cbe538SGunnar Mills auto it = psAttributesConnections.nth(0); 220842cbe538SGunnar Mills 220942cbe538SGunnar Mills const std::string& psAttributesPath = (*it).first; 221042cbe538SGunnar Mills const std::string& psAttributesConnection = (*it).second; 221142cbe538SGunnar Mills 221242cbe538SGunnar Mills // Response handler for Get DeratingFactor property 221342cbe538SGunnar Mills auto respHandler = [sensorsAsyncResp, inventoryItems, 221442cbe538SGunnar Mills callback{std::move(callback)}]( 221542cbe538SGunnar Mills const boost::system::error_code ec, 2216*168e20c1SEd Tanous const dbus::utility::DbusVariantType& 2217*168e20c1SEd Tanous deratingFactor) { 221842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler enter"; 221942cbe538SGunnar Mills if (ec) 222042cbe538SGunnar Mills { 222142cbe538SGunnar Mills BMCWEB_LOG_ERROR 222242cbe538SGunnar Mills << "getPowerSupplyAttributesData respHandler DBus error " << ec; 22238d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 222442cbe538SGunnar Mills return; 222542cbe538SGunnar Mills } 222642cbe538SGunnar Mills 222742cbe538SGunnar Mills const uint32_t* value = std::get_if<uint32_t>(&deratingFactor); 222842cbe538SGunnar Mills if (value != nullptr) 222942cbe538SGunnar Mills { 223042cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "PS EfficiencyPercent value: " << *value; 223142cbe538SGunnar Mills // Store value in Power Supply Inventory Items 223242cbe538SGunnar Mills for (InventoryItem& inventoryItem : *inventoryItems) 223342cbe538SGunnar Mills { 223442cbe538SGunnar Mills if (inventoryItem.isPowerSupply == true) 223542cbe538SGunnar Mills { 223642cbe538SGunnar Mills inventoryItem.powerSupplyEfficiencyPercent = 223742cbe538SGunnar Mills static_cast<int>(*value); 223842cbe538SGunnar Mills } 223942cbe538SGunnar Mills } 224042cbe538SGunnar Mills } 224142cbe538SGunnar Mills else 224242cbe538SGunnar Mills { 224342cbe538SGunnar Mills BMCWEB_LOG_DEBUG 224442cbe538SGunnar Mills << "Failed to find EfficiencyPercent value for PowerSupplies"; 224542cbe538SGunnar Mills } 224642cbe538SGunnar Mills 224742cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler exit"; 224842cbe538SGunnar Mills callback(inventoryItems); 224942cbe538SGunnar Mills }; 225042cbe538SGunnar Mills 225142cbe538SGunnar Mills // Get the DeratingFactor property for the PowerSupplyAttributes 225242cbe538SGunnar Mills // Currently only property on the interface/only one we care about 225342cbe538SGunnar Mills crow::connections::systemBus->async_method_call( 225442cbe538SGunnar Mills std::move(respHandler), psAttributesConnection, psAttributesPath, 225542cbe538SGunnar Mills "org.freedesktop.DBus.Properties", "Get", 225642cbe538SGunnar Mills "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor"); 225742cbe538SGunnar Mills 225842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData exit"; 225942cbe538SGunnar Mills } 226042cbe538SGunnar Mills 226142cbe538SGunnar Mills /** 226242cbe538SGunnar Mills * @brief Gets the Power Supply Attributes such as EfficiencyPercent 226342cbe538SGunnar Mills * 226442cbe538SGunnar Mills * Gets the D-Bus connection (service) that provides Power Supply Attributes 226542cbe538SGunnar Mills * data. Then gets the Power Supply Attributes data from the connection 226642cbe538SGunnar Mills * (currently just assumes 1 connection) and stores the data in the inventory 226742cbe538SGunnar Mills * item. 226842cbe538SGunnar Mills * 226942cbe538SGunnar Mills * This data is later used to provide sensor property values in the JSON 227042cbe538SGunnar Mills * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish. 227142cbe538SGunnar Mills * 227242cbe538SGunnar Mills * Finds the Power Supply Attributes data asynchronously. Invokes callback 227342cbe538SGunnar Mills * when information has been obtained. 227442cbe538SGunnar Mills * 227542cbe538SGunnar Mills * The callback must have the following signature: 227642cbe538SGunnar Mills * @code 227742cbe538SGunnar Mills * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 227842cbe538SGunnar Mills * @endcode 227942cbe538SGunnar Mills * 228042cbe538SGunnar Mills * @param sensorsAsyncResp Pointer to object holding response data. 228142cbe538SGunnar Mills * @param inventoryItems D-Bus inventory items associated with sensors. 228242cbe538SGunnar Mills * @param callback Callback to invoke when data has been obtained. 228342cbe538SGunnar Mills */ 228442cbe538SGunnar Mills template <typename Callback> 228542cbe538SGunnar Mills void getPowerSupplyAttributes( 228642cbe538SGunnar Mills std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 228742cbe538SGunnar Mills std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 228842cbe538SGunnar Mills Callback&& callback) 228942cbe538SGunnar Mills { 229042cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes enter"; 229142cbe538SGunnar Mills 229242cbe538SGunnar Mills // Only need the power supply attributes when the Power Schema 2293a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode != sensors::node::power) 229442cbe538SGunnar Mills { 229542cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit since not Power"; 229642cbe538SGunnar Mills callback(inventoryItems); 229742cbe538SGunnar Mills return; 229842cbe538SGunnar Mills } 229942cbe538SGunnar Mills 230042cbe538SGunnar Mills const std::array<std::string, 1> interfaces = { 230142cbe538SGunnar Mills "xyz.openbmc_project.Control.PowerSupplyAttributes"}; 230242cbe538SGunnar Mills 230342cbe538SGunnar Mills // Response handler for parsing output from GetSubTree 230442cbe538SGunnar Mills auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 230542cbe538SGunnar Mills inventoryItems](const boost::system::error_code ec, 230642cbe538SGunnar Mills const GetSubTreeType& subtree) { 230742cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler enter"; 230842cbe538SGunnar Mills if (ec) 230942cbe538SGunnar Mills { 23108d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 231142cbe538SGunnar Mills BMCWEB_LOG_ERROR 231242cbe538SGunnar Mills << "getPowerSupplyAttributes respHandler DBus error " << ec; 231342cbe538SGunnar Mills return; 231442cbe538SGunnar Mills } 231542cbe538SGunnar Mills if (subtree.size() == 0) 231642cbe538SGunnar Mills { 231742cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Can't find Power Supply Attributes!"; 231842cbe538SGunnar Mills callback(inventoryItems); 231942cbe538SGunnar Mills return; 232042cbe538SGunnar Mills } 232142cbe538SGunnar Mills 232242cbe538SGunnar Mills // Currently we only support 1 power supply attribute, use this for 232342cbe538SGunnar Mills // all the power supplies. Build map of object path to connection. 232442cbe538SGunnar Mills // Assume just 1 connection and 1 path for now. 232542cbe538SGunnar Mills boost::container::flat_map<std::string, std::string> 232642cbe538SGunnar Mills psAttributesConnections; 232742cbe538SGunnar Mills 232842cbe538SGunnar Mills if (subtree[0].first.empty() || subtree[0].second.empty()) 232942cbe538SGunnar Mills { 233042cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!"; 233142cbe538SGunnar Mills callback(inventoryItems); 233242cbe538SGunnar Mills return; 233342cbe538SGunnar Mills } 233442cbe538SGunnar Mills 233542cbe538SGunnar Mills const std::string& psAttributesPath = subtree[0].first; 233642cbe538SGunnar Mills const std::string& connection = subtree[0].second.begin()->first; 233742cbe538SGunnar Mills 233842cbe538SGunnar Mills if (connection.empty()) 233942cbe538SGunnar Mills { 234042cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!"; 234142cbe538SGunnar Mills callback(inventoryItems); 234242cbe538SGunnar Mills return; 234342cbe538SGunnar Mills } 234442cbe538SGunnar Mills 234542cbe538SGunnar Mills psAttributesConnections[psAttributesPath] = connection; 234642cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Added mapping " << psAttributesPath << " -> " 234742cbe538SGunnar Mills << connection; 234842cbe538SGunnar Mills 234942cbe538SGunnar Mills getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems, 235042cbe538SGunnar Mills psAttributesConnections, 235142cbe538SGunnar Mills std::move(callback)); 235242cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler exit"; 235342cbe538SGunnar Mills }; 235442cbe538SGunnar Mills // Make call to ObjectMapper to find the PowerSupplyAttributes service 235542cbe538SGunnar Mills crow::connections::systemBus->async_method_call( 235642cbe538SGunnar Mills std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 235742cbe538SGunnar Mills "/xyz/openbmc_project/object_mapper", 235842cbe538SGunnar Mills "xyz.openbmc_project.ObjectMapper", "GetSubTree", 235942cbe538SGunnar Mills "/xyz/openbmc_project", 0, interfaces); 236042cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit"; 236142cbe538SGunnar Mills } 236242cbe538SGunnar Mills 236342cbe538SGunnar Mills /** 2364adc4f0dbSShawn McCarney * @brief Gets inventory items associated with sensors. 23658fb49dd6SShawn McCarney * 23668fb49dd6SShawn McCarney * Finds the inventory items that are associated with the specified sensors. 2367adc4f0dbSShawn McCarney * Then gets D-Bus data for the inventory items, such as presence and VPD. 23688fb49dd6SShawn McCarney * 2369adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 2370adc4f0dbSShawn McCarney * response. 23718fb49dd6SShawn McCarney * 2372adc4f0dbSShawn McCarney * Finds the inventory items asynchronously. Invokes callback when the 2373adc4f0dbSShawn McCarney * inventory items have been obtained. 2374adc4f0dbSShawn McCarney * 2375adc4f0dbSShawn McCarney * The callback must have the following signature: 2376adc4f0dbSShawn McCarney * @code 2377adc4f0dbSShawn McCarney * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 2378adc4f0dbSShawn McCarney * @endcode 23798fb49dd6SShawn McCarney * 23808fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 23818fb49dd6SShawn McCarney * @param sensorNames All sensors within the current chassis. 23828fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 23838fb49dd6SShawn McCarney * implements ObjectManager. 2384adc4f0dbSShawn McCarney * @param callback Callback to invoke when inventory items have been obtained. 23858fb49dd6SShawn McCarney */ 2386adc4f0dbSShawn McCarney template <typename Callback> 2387adc4f0dbSShawn McCarney static void getInventoryItems( 23888fb49dd6SShawn McCarney std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 23898fb49dd6SShawn McCarney const std::shared_ptr<boost::container::flat_set<std::string>> sensorNames, 23908fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 2391adc4f0dbSShawn McCarney objectMgrPaths, 2392adc4f0dbSShawn McCarney Callback&& callback) 23938fb49dd6SShawn McCarney { 2394adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItems enter"; 2395adc4f0dbSShawn McCarney auto getInventoryItemAssociationsCb = 2396adc4f0dbSShawn McCarney [sensorsAsyncResp, objectMgrPaths, callback{std::move(callback)}]( 2397adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems) { 2398adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb enter"; 23998fb49dd6SShawn McCarney auto getInventoryItemsConnectionsCb = 2400adc4f0dbSShawn McCarney [sensorsAsyncResp, inventoryItems, objectMgrPaths, 2401adc4f0dbSShawn McCarney callback{std::move(callback)}]( 24028fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> 24038fb49dd6SShawn McCarney invConnections) { 24048fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb enter"; 2405d500549bSAnthony Wilson auto getInventoryItemsDataCb = 2406d500549bSAnthony Wilson [sensorsAsyncResp, inventoryItems, 2407d500549bSAnthony Wilson callback{std::move(callback)}]() { 2408d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb enter"; 240942cbe538SGunnar Mills 241042cbe538SGunnar Mills auto getInventoryLedsCb = [sensorsAsyncResp, 241142cbe538SGunnar Mills inventoryItems, 241242cbe538SGunnar Mills callback{std::move( 241342cbe538SGunnar Mills callback)}]() { 241442cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getInventoryLedsCb enter"; 241542cbe538SGunnar Mills // Find Power Supply Attributes and get the data 241642cbe538SGunnar Mills getPowerSupplyAttributes(sensorsAsyncResp, 241742cbe538SGunnar Mills inventoryItems, 241842cbe538SGunnar Mills std::move(callback)); 241942cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getInventoryLedsCb exit"; 242042cbe538SGunnar Mills }; 242142cbe538SGunnar Mills 2422d500549bSAnthony Wilson // Find led connections and get the data 2423d500549bSAnthony Wilson getInventoryLeds(sensorsAsyncResp, inventoryItems, 242442cbe538SGunnar Mills std::move(getInventoryLedsCb)); 2425d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb exit"; 2426d500549bSAnthony Wilson }; 24278fb49dd6SShawn McCarney 2428adc4f0dbSShawn McCarney // Get inventory item data from connections 2429adc4f0dbSShawn McCarney getInventoryItemsData(sensorsAsyncResp, inventoryItems, 2430adc4f0dbSShawn McCarney invConnections, objectMgrPaths, 2431d500549bSAnthony Wilson std::move(getInventoryItemsDataCb)); 24328fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb exit"; 24338fb49dd6SShawn McCarney }; 24348fb49dd6SShawn McCarney 2435adc4f0dbSShawn McCarney // Get connections that provide inventory item data 24368fb49dd6SShawn McCarney getInventoryItemsConnections( 2437adc4f0dbSShawn McCarney sensorsAsyncResp, inventoryItems, 24388fb49dd6SShawn McCarney std::move(getInventoryItemsConnectionsCb)); 2439adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb exit"; 24408fb49dd6SShawn McCarney }; 24418fb49dd6SShawn McCarney 2442adc4f0dbSShawn McCarney // Get associations from sensors to inventory items 2443adc4f0dbSShawn McCarney getInventoryItemAssociations(sensorsAsyncResp, sensorNames, objectMgrPaths, 2444adc4f0dbSShawn McCarney std::move(getInventoryItemAssociationsCb)); 2445adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItems exit"; 2446adc4f0dbSShawn McCarney } 2447adc4f0dbSShawn McCarney 2448adc4f0dbSShawn McCarney /** 2449adc4f0dbSShawn McCarney * @brief Returns JSON PowerSupply object for the specified inventory item. 2450adc4f0dbSShawn McCarney * 2451adc4f0dbSShawn McCarney * Searches for a JSON PowerSupply object that matches the specified inventory 2452adc4f0dbSShawn McCarney * item. If one is not found, a new PowerSupply object is added to the JSON 2453adc4f0dbSShawn McCarney * array. 2454adc4f0dbSShawn McCarney * 2455adc4f0dbSShawn McCarney * Multiple sensors are often associated with one power supply inventory item. 2456adc4f0dbSShawn McCarney * As a result, multiple sensor values are stored in one JSON PowerSupply 2457adc4f0dbSShawn McCarney * object. 2458adc4f0dbSShawn McCarney * 2459adc4f0dbSShawn McCarney * @param powerSupplyArray JSON array containing Redfish PowerSupply objects. 2460adc4f0dbSShawn McCarney * @param inventoryItem Inventory item for the power supply. 2461adc4f0dbSShawn McCarney * @param chassisId Chassis that contains the power supply. 2462adc4f0dbSShawn McCarney * @return JSON PowerSupply object for the specified inventory item. 2463adc4f0dbSShawn McCarney */ 246423a21a1cSEd Tanous inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray, 2465adc4f0dbSShawn McCarney const InventoryItem& inventoryItem, 2466adc4f0dbSShawn McCarney const std::string& chassisId) 2467adc4f0dbSShawn McCarney { 2468adc4f0dbSShawn McCarney // Check if matching PowerSupply object already exists in JSON array 2469adc4f0dbSShawn McCarney for (nlohmann::json& powerSupply : powerSupplyArray) 2470adc4f0dbSShawn McCarney { 2471adc4f0dbSShawn McCarney if (powerSupply["MemberId"] == inventoryItem.name) 2472adc4f0dbSShawn McCarney { 2473adc4f0dbSShawn McCarney return powerSupply; 2474adc4f0dbSShawn McCarney } 2475adc4f0dbSShawn McCarney } 2476adc4f0dbSShawn McCarney 2477adc4f0dbSShawn McCarney // Add new PowerSupply object to JSON array 2478adc4f0dbSShawn McCarney powerSupplyArray.push_back({}); 2479adc4f0dbSShawn McCarney nlohmann::json& powerSupply = powerSupplyArray.back(); 2480adc4f0dbSShawn McCarney powerSupply["@odata.id"] = 2481adc4f0dbSShawn McCarney "/redfish/v1/Chassis/" + chassisId + "/Power#/PowerSupplies/"; 2482adc4f0dbSShawn McCarney powerSupply["MemberId"] = inventoryItem.name; 2483adc4f0dbSShawn McCarney powerSupply["Name"] = boost::replace_all_copy(inventoryItem.name, "_", " "); 2484adc4f0dbSShawn McCarney powerSupply["Manufacturer"] = inventoryItem.manufacturer; 2485adc4f0dbSShawn McCarney powerSupply["Model"] = inventoryItem.model; 2486adc4f0dbSShawn McCarney powerSupply["PartNumber"] = inventoryItem.partNumber; 2487adc4f0dbSShawn McCarney powerSupply["SerialNumber"] = inventoryItem.serialNumber; 2488d500549bSAnthony Wilson setLedState(powerSupply, &inventoryItem); 2489adc4f0dbSShawn McCarney 249042cbe538SGunnar Mills if (inventoryItem.powerSupplyEfficiencyPercent >= 0) 249142cbe538SGunnar Mills { 249242cbe538SGunnar Mills powerSupply["EfficiencyPercent"] = 249342cbe538SGunnar Mills inventoryItem.powerSupplyEfficiencyPercent; 249442cbe538SGunnar Mills } 249542cbe538SGunnar Mills 249642cbe538SGunnar Mills powerSupply["Status"]["State"] = getState(&inventoryItem); 2497adc4f0dbSShawn McCarney const char* health = inventoryItem.isFunctional ? "OK" : "Critical"; 2498adc4f0dbSShawn McCarney powerSupply["Status"]["Health"] = health; 2499adc4f0dbSShawn McCarney 2500adc4f0dbSShawn McCarney return powerSupply; 25018fb49dd6SShawn McCarney } 25028fb49dd6SShawn McCarney 25038fb49dd6SShawn McCarney /** 2504de629b6eSShawn McCarney * @brief Gets the values of the specified sensors. 2505de629b6eSShawn McCarney * 2506de629b6eSShawn McCarney * Stores the results as JSON in the SensorsAsyncResp. 2507de629b6eSShawn McCarney * 2508de629b6eSShawn McCarney * Gets the sensor values asynchronously. Stores the results later when the 2509de629b6eSShawn McCarney * information has been obtained. 2510de629b6eSShawn McCarney * 2511adc4f0dbSShawn McCarney * The sensorNames set contains all requested sensors for the current chassis. 2512de629b6eSShawn McCarney * 2513de629b6eSShawn McCarney * To minimize the number of DBus calls, the DBus method 2514de629b6eSShawn McCarney * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the 2515de629b6eSShawn McCarney * values of all sensors provided by a connection (service). 2516de629b6eSShawn McCarney * 2517de629b6eSShawn McCarney * The connections set contains all the connections that provide sensor values. 2518de629b6eSShawn McCarney * 2519de629b6eSShawn McCarney * The objectMgrPaths map contains mappings from a connection name to the 2520de629b6eSShawn McCarney * corresponding DBus object path that implements ObjectManager. 2521de629b6eSShawn McCarney * 2522adc4f0dbSShawn McCarney * The InventoryItem vector contains D-Bus inventory items associated with the 2523adc4f0dbSShawn McCarney * sensors. Inventory item data is needed for some Redfish sensor properties. 2524adc4f0dbSShawn McCarney * 2525de629b6eSShawn McCarney * @param SensorsAsyncResp Pointer to object holding response data. 2526adc4f0dbSShawn McCarney * @param sensorNames All requested sensors within the current chassis. 2527de629b6eSShawn McCarney * @param connections Connections that provide sensor values. 2528de629b6eSShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 2529de629b6eSShawn McCarney * implements ObjectManager. 2530adc4f0dbSShawn McCarney * @param inventoryItems Inventory items associated with the sensors. 2531de629b6eSShawn McCarney */ 253223a21a1cSEd Tanous inline void getSensorData( 253381ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 2534b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 2535de629b6eSShawn McCarney const boost::container::flat_set<std::string>& connections, 2536b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_map<std::string, std::string>>& 2537adc4f0dbSShawn McCarney objectMgrPaths, 2538b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems) 2539de629b6eSShawn McCarney { 2540de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getSensorData enter"; 2541de629b6eSShawn McCarney // Get managed objects from all services exposing sensors 2542de629b6eSShawn McCarney for (const std::string& connection : connections) 2543de629b6eSShawn McCarney { 2544de629b6eSShawn McCarney // Response handler to process managed objects 254581ce609eSEd Tanous auto getManagedObjectsCb = [sensorsAsyncResp, sensorNames, 2546adc4f0dbSShawn McCarney inventoryItems]( 2547de629b6eSShawn McCarney const boost::system::error_code ec, 2548de629b6eSShawn McCarney ManagedObjectsVectorType& resp) { 2549de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb enter"; 2550de629b6eSShawn McCarney if (ec) 2551de629b6eSShawn McCarney { 2552de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "getManagedObjectsCb DBUS error: " << ec; 25538d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2554de629b6eSShawn McCarney return; 2555de629b6eSShawn McCarney } 2556de629b6eSShawn McCarney // Go through all objects and update response with sensor data 2557de629b6eSShawn McCarney for (const auto& objDictEntry : resp) 2558de629b6eSShawn McCarney { 2559de629b6eSShawn McCarney const std::string& objPath = 2560de629b6eSShawn McCarney static_cast<const std::string&>(objDictEntry.first); 2561de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb parsing object " 2562de629b6eSShawn McCarney << objPath; 2563de629b6eSShawn McCarney 2564de629b6eSShawn McCarney std::vector<std::string> split; 2565de629b6eSShawn McCarney // Reserve space for 2566de629b6eSShawn McCarney // /xyz/openbmc_project/sensors/<name>/<subname> 2567de629b6eSShawn McCarney split.reserve(6); 2568de629b6eSShawn McCarney boost::algorithm::split(split, objPath, boost::is_any_of("/")); 2569de629b6eSShawn McCarney if (split.size() < 6) 2570de629b6eSShawn McCarney { 2571de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "Got path that isn't long enough " 2572de629b6eSShawn McCarney << objPath; 2573de629b6eSShawn McCarney continue; 2574de629b6eSShawn McCarney } 2575de629b6eSShawn McCarney // These indexes aren't intuitive, as boost::split puts an empty 2576de629b6eSShawn McCarney // string at the beginning 2577de629b6eSShawn McCarney const std::string& sensorType = split[4]; 2578de629b6eSShawn McCarney const std::string& sensorName = split[5]; 2579de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "sensorName " << sensorName 2580de629b6eSShawn McCarney << " sensorType " << sensorType; 258149c53ac9SJohnathan Mantey if (sensorNames->find(objPath) == sensorNames->end()) 2582de629b6eSShawn McCarney { 2583accdbb2cSAndrew Geissler BMCWEB_LOG_DEBUG << sensorName << " not in sensor list "; 2584de629b6eSShawn McCarney continue; 2585de629b6eSShawn McCarney } 2586de629b6eSShawn McCarney 2587adc4f0dbSShawn McCarney // Find inventory item (if any) associated with sensor 2588adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 2589adc4f0dbSShawn McCarney findInventoryItemForSensor(inventoryItems, objPath); 2590adc4f0dbSShawn McCarney 259195a3ecadSAnthony Wilson const std::string& sensorSchema = 259281ce609eSEd Tanous sensorsAsyncResp->chassisSubNode; 259395a3ecadSAnthony Wilson 259495a3ecadSAnthony Wilson nlohmann::json* sensorJson = nullptr; 259595a3ecadSAnthony Wilson 2596a0ec28b6SAdrian Ambrożewicz if (sensorSchema == sensors::node::sensors) 259795a3ecadSAnthony Wilson { 25988d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] = 259981ce609eSEd Tanous "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + 260081ce609eSEd Tanous "/" + sensorsAsyncResp->chassisSubNode + "/" + 260195a3ecadSAnthony Wilson sensorName; 26028d1b46d7Szhanghch05 sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue); 260395a3ecadSAnthony Wilson } 260495a3ecadSAnthony Wilson else 260595a3ecadSAnthony Wilson { 2606271584abSEd Tanous std::string fieldName; 2607de629b6eSShawn McCarney if (sensorType == "temperature") 2608de629b6eSShawn McCarney { 2609de629b6eSShawn McCarney fieldName = "Temperatures"; 2610de629b6eSShawn McCarney } 2611de629b6eSShawn McCarney else if (sensorType == "fan" || sensorType == "fan_tach" || 2612de629b6eSShawn McCarney sensorType == "fan_pwm") 2613de629b6eSShawn McCarney { 2614de629b6eSShawn McCarney fieldName = "Fans"; 2615de629b6eSShawn McCarney } 2616de629b6eSShawn McCarney else if (sensorType == "voltage") 2617de629b6eSShawn McCarney { 2618de629b6eSShawn McCarney fieldName = "Voltages"; 2619de629b6eSShawn McCarney } 2620de629b6eSShawn McCarney else if (sensorType == "power") 2621de629b6eSShawn McCarney { 2622028f7ebcSEddie James if (!sensorName.compare("total_power")) 2623028f7ebcSEddie James { 2624028f7ebcSEddie James fieldName = "PowerControl"; 2625028f7ebcSEddie James } 2626adc4f0dbSShawn McCarney else if ((inventoryItem != nullptr) && 2627adc4f0dbSShawn McCarney (inventoryItem->isPowerSupply)) 2628028f7ebcSEddie James { 2629de629b6eSShawn McCarney fieldName = "PowerSupplies"; 2630de629b6eSShawn McCarney } 2631adc4f0dbSShawn McCarney else 2632adc4f0dbSShawn McCarney { 2633adc4f0dbSShawn McCarney // Other power sensors are in SensorCollection 2634adc4f0dbSShawn McCarney continue; 2635adc4f0dbSShawn McCarney } 2636028f7ebcSEddie James } 2637de629b6eSShawn McCarney else 2638de629b6eSShawn McCarney { 2639de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "Unsure how to handle sensorType " 2640de629b6eSShawn McCarney << sensorType; 2641de629b6eSShawn McCarney continue; 2642de629b6eSShawn McCarney } 2643de629b6eSShawn McCarney 2644de629b6eSShawn McCarney nlohmann::json& tempArray = 26458d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue[fieldName]; 2646adc4f0dbSShawn McCarney if (fieldName == "PowerControl") 264749c53ac9SJohnathan Mantey { 2648adc4f0dbSShawn McCarney if (tempArray.empty()) 26497ab06f49SGunnar Mills { 265095a3ecadSAnthony Wilson // Put multiple "sensors" into a single 265195a3ecadSAnthony Wilson // PowerControl. Follows MemberId naming and 265295a3ecadSAnthony Wilson // naming in power.hpp. 26537ab06f49SGunnar Mills tempArray.push_back( 2654adc4f0dbSShawn McCarney {{"@odata.id", 2655adc4f0dbSShawn McCarney "/redfish/v1/Chassis/" + 265681ce609eSEd Tanous sensorsAsyncResp->chassisId + "/" + 265781ce609eSEd Tanous sensorsAsyncResp->chassisSubNode + "#/" + 2658adc4f0dbSShawn McCarney fieldName + "/0"}}); 2659adc4f0dbSShawn McCarney } 2660adc4f0dbSShawn McCarney sensorJson = &(tempArray.back()); 2661adc4f0dbSShawn McCarney } 2662adc4f0dbSShawn McCarney else if (fieldName == "PowerSupplies") 2663adc4f0dbSShawn McCarney { 2664adc4f0dbSShawn McCarney if (inventoryItem != nullptr) 2665adc4f0dbSShawn McCarney { 2666adc4f0dbSShawn McCarney sensorJson = 2667adc4f0dbSShawn McCarney &(getPowerSupply(tempArray, *inventoryItem, 266881ce609eSEd Tanous sensorsAsyncResp->chassisId)); 2669adc4f0dbSShawn McCarney } 267049c53ac9SJohnathan Mantey } 267149c53ac9SJohnathan Mantey else 267249c53ac9SJohnathan Mantey { 2673de629b6eSShawn McCarney tempArray.push_back( 267495a3ecadSAnthony Wilson {{"@odata.id", 267595a3ecadSAnthony Wilson "/redfish/v1/Chassis/" + 267681ce609eSEd Tanous sensorsAsyncResp->chassisId + "/" + 267781ce609eSEd Tanous sensorsAsyncResp->chassisSubNode + "#/" + 267895a3ecadSAnthony Wilson fieldName + "/"}}); 2679adc4f0dbSShawn McCarney sensorJson = &(tempArray.back()); 268049c53ac9SJohnathan Mantey } 268195a3ecadSAnthony Wilson } 2682de629b6eSShawn McCarney 2683adc4f0dbSShawn McCarney if (sensorJson != nullptr) 2684adc4f0dbSShawn McCarney { 2685a0ec28b6SAdrian Ambrożewicz objectInterfacesToJson( 268681ce609eSEd Tanous sensorName, sensorType, sensorsAsyncResp, 2687a0ec28b6SAdrian Ambrożewicz objDictEntry.second, *sensorJson, inventoryItem); 2688adc4f0dbSShawn McCarney } 2689de629b6eSShawn McCarney } 269081ce609eSEd Tanous if (sensorsAsyncResp.use_count() == 1) 269149c53ac9SJohnathan Mantey { 269281ce609eSEd Tanous sortJSONResponse(sensorsAsyncResp); 269381ce609eSEd Tanous if (sensorsAsyncResp->chassisSubNode == sensors::node::thermal) 26948bd25ccdSJames Feist { 269581ce609eSEd Tanous populateFanRedundancy(sensorsAsyncResp); 26968bd25ccdSJames Feist } 269749c53ac9SJohnathan Mantey } 2698de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb exit"; 2699de629b6eSShawn McCarney }; 2700de629b6eSShawn McCarney 2701de629b6eSShawn McCarney // Find DBus object path that implements ObjectManager for the current 2702de629b6eSShawn McCarney // connection. If no mapping found, default to "/". 27038fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(connection); 2704de629b6eSShawn McCarney const std::string& objectMgrPath = 27058fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 2706de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is " 2707de629b6eSShawn McCarney << objectMgrPath; 2708de629b6eSShawn McCarney 2709de629b6eSShawn McCarney crow::connections::systemBus->async_method_call( 2710de629b6eSShawn McCarney getManagedObjectsCb, connection, objectMgrPath, 2711de629b6eSShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 271223a21a1cSEd Tanous } 2713de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getSensorData exit"; 2714de629b6eSShawn McCarney } 2715de629b6eSShawn McCarney 271623a21a1cSEd Tanous inline void processSensorList( 271781ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 2718b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames) 27191abe55efSEd Tanous { 272095a3ecadSAnthony Wilson auto getConnectionCb = 272181ce609eSEd Tanous [sensorsAsyncResp, sensorNames]( 272295a3ecadSAnthony Wilson const boost::container::flat_set<std::string>& connections) { 272355c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getConnectionCb enter"; 2724de629b6eSShawn McCarney auto getObjectManagerPathsCb = 272581ce609eSEd Tanous [sensorsAsyncResp, sensorNames, 2726b5a76932SEd Tanous connections](const std::shared_ptr<boost::container::flat_map< 2727b5a76932SEd Tanous std::string, std::string>>& objectMgrPaths) { 2728de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb enter"; 2729adc4f0dbSShawn McCarney auto getInventoryItemsCb = 273081ce609eSEd Tanous [sensorsAsyncResp, sensorNames, connections, 2731adc4f0dbSShawn McCarney objectMgrPaths]( 2732f23b7296SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& 2733adc4f0dbSShawn McCarney inventoryItems) { 2734adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsCb enter"; 273549c53ac9SJohnathan Mantey // Get sensor data and store results in JSON 273681ce609eSEd Tanous getSensorData(sensorsAsyncResp, sensorNames, 2737adc4f0dbSShawn McCarney connections, objectMgrPaths, 2738f23b7296SEd Tanous inventoryItems); 2739adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsCb exit"; 2740adc4f0dbSShawn McCarney }; 2741adc4f0dbSShawn McCarney 2742adc4f0dbSShawn McCarney // Get inventory items associated with sensors 274381ce609eSEd Tanous getInventoryItems(sensorsAsyncResp, sensorNames, 2744adc4f0dbSShawn McCarney objectMgrPaths, 2745adc4f0dbSShawn McCarney std::move(getInventoryItemsCb)); 2746adc4f0dbSShawn McCarney 2747de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb exit"; 274808777fb0SLewanczyk, Dawid }; 2749de629b6eSShawn McCarney 275049c53ac9SJohnathan Mantey // Get mapping from connection names to the DBus object 275149c53ac9SJohnathan Mantey // paths that implement the ObjectManager interface 275281ce609eSEd Tanous getObjectManagerPaths(sensorsAsyncResp, 2753de629b6eSShawn McCarney std::move(getObjectManagerPathsCb)); 275455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getConnectionCb exit"; 275508777fb0SLewanczyk, Dawid }; 2756de629b6eSShawn McCarney 2757de629b6eSShawn McCarney // Get set of connections that provide sensor values 275881ce609eSEd Tanous getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb)); 275995a3ecadSAnthony Wilson } 276095a3ecadSAnthony Wilson 276195a3ecadSAnthony Wilson /** 276295a3ecadSAnthony Wilson * @brief Entry point for retrieving sensors data related to requested 276395a3ecadSAnthony Wilson * chassis. 276495a3ecadSAnthony Wilson * @param SensorsAsyncResp Pointer to object holding response data 276595a3ecadSAnthony Wilson */ 2766b5a76932SEd Tanous inline void 276781ce609eSEd Tanous getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 276895a3ecadSAnthony Wilson { 276995a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisData enter"; 277095a3ecadSAnthony Wilson auto getChassisCb = 277181ce609eSEd Tanous [sensorsAsyncResp]( 2772f23b7296SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& 277395a3ecadSAnthony Wilson sensorNames) { 277495a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb enter"; 277581ce609eSEd Tanous processSensorList(sensorsAsyncResp, sensorNames); 277655c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassisCb exit"; 277708777fb0SLewanczyk, Dawid }; 27788d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] = 27798d1b46d7Szhanghch05 nlohmann::json::array(); 278008777fb0SLewanczyk, Dawid 278126f03899SShawn McCarney // Get set of sensors in chassis 278281ce609eSEd Tanous getChassis(sensorsAsyncResp, std::move(getChassisCb)); 278355c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassisData exit"; 2784271584abSEd Tanous } 278508777fb0SLewanczyk, Dawid 2786413961deSRichard Marian Thomaiyar /** 278749c53ac9SJohnathan Mantey * @brief Find the requested sensorName in the list of all sensors supplied by 278849c53ac9SJohnathan Mantey * the chassis node 278949c53ac9SJohnathan Mantey * 279049c53ac9SJohnathan Mantey * @param sensorName The sensor name supplied in the PATCH request 279149c53ac9SJohnathan Mantey * @param sensorsList The list of sensors managed by the chassis node 279249c53ac9SJohnathan Mantey * @param sensorsModified The list of sensors that were found as a result of 279349c53ac9SJohnathan Mantey * repeated calls to this function 279449c53ac9SJohnathan Mantey */ 279523a21a1cSEd Tanous inline bool findSensorNameUsingSensorPath( 27960a86febdSRichard Marian Thomaiyar std::string_view sensorName, 279749c53ac9SJohnathan Mantey boost::container::flat_set<std::string>& sensorsList, 279849c53ac9SJohnathan Mantey boost::container::flat_set<std::string>& sensorsModified) 279949c53ac9SJohnathan Mantey { 280028aa8de5SGeorge Liu for (auto& chassisSensor : sensorsList) 280149c53ac9SJohnathan Mantey { 280228aa8de5SGeorge Liu sdbusplus::message::object_path path(chassisSensor); 2803b00dcc27SEd Tanous std::string thisSensorName = path.filename(); 280428aa8de5SGeorge Liu if (thisSensorName.empty()) 280549c53ac9SJohnathan Mantey { 280649c53ac9SJohnathan Mantey continue; 280749c53ac9SJohnathan Mantey } 280849c53ac9SJohnathan Mantey if (thisSensorName == sensorName) 280949c53ac9SJohnathan Mantey { 281049c53ac9SJohnathan Mantey sensorsModified.emplace(chassisSensor); 281149c53ac9SJohnathan Mantey return true; 281249c53ac9SJohnathan Mantey } 281349c53ac9SJohnathan Mantey } 281449c53ac9SJohnathan Mantey return false; 281549c53ac9SJohnathan Mantey } 281649c53ac9SJohnathan Mantey 281749c53ac9SJohnathan Mantey /** 2818413961deSRichard Marian Thomaiyar * @brief Entry point for overriding sensor values of given sensor 2819413961deSRichard Marian Thomaiyar * 28208d1b46d7Szhanghch05 * @param sensorAsyncResp response object 28214bb3dc34SCarol Wang * @param allCollections Collections extract from sensors' request patch info 2822413961deSRichard Marian Thomaiyar * @param chassisSubNode Chassis Node for which the query has to happen 2823413961deSRichard Marian Thomaiyar */ 282423a21a1cSEd Tanous inline void setSensorsOverride( 2825b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp, 28264bb3dc34SCarol Wang std::unordered_map<std::string, std::vector<nlohmann::json>>& 2827397fd61fSjayaprakash Mutyala allCollections) 2828413961deSRichard Marian Thomaiyar { 282970d1d0aaSjayaprakash Mutyala BMCWEB_LOG_INFO << "setSensorsOverride for subNode" 28304bb3dc34SCarol Wang << sensorAsyncResp->chassisSubNode << "\n"; 2831413961deSRichard Marian Thomaiyar 2832f65af9e8SRichard Marian Thomaiyar const char* propertyValueName; 2833f65af9e8SRichard Marian Thomaiyar std::unordered_map<std::string, std::pair<double, std::string>> overrideMap; 2834413961deSRichard Marian Thomaiyar std::string memberId; 2835413961deSRichard Marian Thomaiyar double value; 2836f65af9e8SRichard Marian Thomaiyar for (auto& collectionItems : allCollections) 2837f65af9e8SRichard Marian Thomaiyar { 2838f65af9e8SRichard Marian Thomaiyar if (collectionItems.first == "Temperatures") 2839f65af9e8SRichard Marian Thomaiyar { 2840f65af9e8SRichard Marian Thomaiyar propertyValueName = "ReadingCelsius"; 2841f65af9e8SRichard Marian Thomaiyar } 2842f65af9e8SRichard Marian Thomaiyar else if (collectionItems.first == "Fans") 2843f65af9e8SRichard Marian Thomaiyar { 2844f65af9e8SRichard Marian Thomaiyar propertyValueName = "Reading"; 2845f65af9e8SRichard Marian Thomaiyar } 2846f65af9e8SRichard Marian Thomaiyar else 2847f65af9e8SRichard Marian Thomaiyar { 2848f65af9e8SRichard Marian Thomaiyar propertyValueName = "ReadingVolts"; 2849f65af9e8SRichard Marian Thomaiyar } 2850f65af9e8SRichard Marian Thomaiyar for (auto& item : collectionItems.second) 2851f65af9e8SRichard Marian Thomaiyar { 28528d1b46d7Szhanghch05 if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res, 28538d1b46d7Szhanghch05 "MemberId", memberId, propertyValueName, 28548d1b46d7Szhanghch05 value)) 2855413961deSRichard Marian Thomaiyar { 2856413961deSRichard Marian Thomaiyar return; 2857413961deSRichard Marian Thomaiyar } 2858f65af9e8SRichard Marian Thomaiyar overrideMap.emplace(memberId, 2859f65af9e8SRichard Marian Thomaiyar std::make_pair(value, collectionItems.first)); 2860f65af9e8SRichard Marian Thomaiyar } 2861f65af9e8SRichard Marian Thomaiyar } 28624bb3dc34SCarol Wang 2863b5a76932SEd Tanous auto getChassisSensorListCb = [sensorAsyncResp, overrideMap]( 2864b5a76932SEd Tanous const std::shared_ptr< 286549c53ac9SJohnathan Mantey boost::container::flat_set< 2866b5a76932SEd Tanous std::string>>& sensorsList) { 286749c53ac9SJohnathan Mantey // Match sensor names in the PATCH request to those managed by the 286849c53ac9SJohnathan Mantey // chassis node 286949c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> 287049c53ac9SJohnathan Mantey sensorNames = 287149c53ac9SJohnathan Mantey std::make_shared<boost::container::flat_set<std::string>>(); 2872f65af9e8SRichard Marian Thomaiyar for (const auto& item : overrideMap) 2873413961deSRichard Marian Thomaiyar { 2874f65af9e8SRichard Marian Thomaiyar const auto& sensor = item.first; 287549c53ac9SJohnathan Mantey if (!findSensorNameUsingSensorPath(sensor, *sensorsList, 287649c53ac9SJohnathan Mantey *sensorNames)) 2877f65af9e8SRichard Marian Thomaiyar { 2878f65af9e8SRichard Marian Thomaiyar BMCWEB_LOG_INFO << "Unable to find memberId " << item.first; 28798d1b46d7Szhanghch05 messages::resourceNotFound(sensorAsyncResp->asyncResp->res, 2880f65af9e8SRichard Marian Thomaiyar item.second.second, item.first); 2881413961deSRichard Marian Thomaiyar return; 2882413961deSRichard Marian Thomaiyar } 2883f65af9e8SRichard Marian Thomaiyar } 2884413961deSRichard Marian Thomaiyar // Get the connection to which the memberId belongs 28854f277b54SJayaprakash Mutyala auto getObjectsWithConnectionCb = [sensorAsyncResp, overrideMap]( 28864f277b54SJayaprakash Mutyala const boost::container::flat_set< 28874f277b54SJayaprakash Mutyala std::string>& /*connections*/, 28884f277b54SJayaprakash Mutyala const std::set<std::pair< 28894f277b54SJayaprakash Mutyala std::string, std::string>>& 2890413961deSRichard Marian Thomaiyar objectsWithConnection) { 2891f65af9e8SRichard Marian Thomaiyar if (objectsWithConnection.size() != overrideMap.size()) 2892413961deSRichard Marian Thomaiyar { 2893413961deSRichard Marian Thomaiyar BMCWEB_LOG_INFO 2894f65af9e8SRichard Marian Thomaiyar << "Unable to find all objects with proper connection " 2895f65af9e8SRichard Marian Thomaiyar << objectsWithConnection.size() << " requested " 2896f65af9e8SRichard Marian Thomaiyar << overrideMap.size() << "\n"; 28974f277b54SJayaprakash Mutyala messages::resourceNotFound(sensorAsyncResp->asyncResp->res, 2898a0ec28b6SAdrian Ambrożewicz sensorAsyncResp->chassisSubNode == 2899a0ec28b6SAdrian Ambrożewicz sensors::node::thermal 2900413961deSRichard Marian Thomaiyar ? "Temperatures" 2901413961deSRichard Marian Thomaiyar : "Voltages", 2902f65af9e8SRichard Marian Thomaiyar "Count"); 2903f65af9e8SRichard Marian Thomaiyar return; 2904f65af9e8SRichard Marian Thomaiyar } 2905f65af9e8SRichard Marian Thomaiyar for (const auto& item : objectsWithConnection) 2906f65af9e8SRichard Marian Thomaiyar { 290728aa8de5SGeorge Liu sdbusplus::message::object_path path(item.first); 290828aa8de5SGeorge Liu std::string sensorName = path.filename(); 290928aa8de5SGeorge Liu if (sensorName.empty()) 2910f65af9e8SRichard Marian Thomaiyar { 29114f277b54SJayaprakash Mutyala messages::internalError(sensorAsyncResp->asyncResp->res); 2912f65af9e8SRichard Marian Thomaiyar return; 2913f65af9e8SRichard Marian Thomaiyar } 2914f65af9e8SRichard Marian Thomaiyar 2915f65af9e8SRichard Marian Thomaiyar const auto& iterator = overrideMap.find(sensorName); 2916f65af9e8SRichard Marian Thomaiyar if (iterator == overrideMap.end()) 2917f65af9e8SRichard Marian Thomaiyar { 2918f65af9e8SRichard Marian Thomaiyar BMCWEB_LOG_INFO << "Unable to find sensor object" 2919f65af9e8SRichard Marian Thomaiyar << item.first << "\n"; 29204f277b54SJayaprakash Mutyala messages::internalError(sensorAsyncResp->asyncResp->res); 2921413961deSRichard Marian Thomaiyar return; 2922413961deSRichard Marian Thomaiyar } 2923413961deSRichard Marian Thomaiyar crow::connections::systemBus->async_method_call( 2924f65af9e8SRichard Marian Thomaiyar [sensorAsyncResp](const boost::system::error_code ec) { 2925413961deSRichard Marian Thomaiyar if (ec) 2926413961deSRichard Marian Thomaiyar { 29274f277b54SJayaprakash Mutyala if (ec.value() == 29284f277b54SJayaprakash Mutyala boost::system::errc::permission_denied) 29294f277b54SJayaprakash Mutyala { 29304f277b54SJayaprakash Mutyala BMCWEB_LOG_WARNING 29314f277b54SJayaprakash Mutyala << "Manufacturing mode is not Enabled...can't " 29324f277b54SJayaprakash Mutyala "Override the sensor value. "; 29334f277b54SJayaprakash Mutyala 29344f277b54SJayaprakash Mutyala messages::insufficientPrivilege( 29358d1b46d7Szhanghch05 sensorAsyncResp->asyncResp->res); 2936413961deSRichard Marian Thomaiyar return; 2937413961deSRichard Marian Thomaiyar } 29384f277b54SJayaprakash Mutyala BMCWEB_LOG_DEBUG 29394f277b54SJayaprakash Mutyala << "setOverrideValueStatus DBUS error: " << ec; 29404f277b54SJayaprakash Mutyala messages::internalError( 29414f277b54SJayaprakash Mutyala sensorAsyncResp->asyncResp->res); 29424f277b54SJayaprakash Mutyala } 2943413961deSRichard Marian Thomaiyar }, 29444f277b54SJayaprakash Mutyala item.second, item.first, "org.freedesktop.DBus.Properties", 29454f277b54SJayaprakash Mutyala "Set", "xyz.openbmc_project.Sensor.Value", "Value", 2946*168e20c1SEd Tanous dbus::utility::DbusVariantType(iterator->second.first)); 2947f65af9e8SRichard Marian Thomaiyar } 2948413961deSRichard Marian Thomaiyar }; 2949413961deSRichard Marian Thomaiyar // Get object with connection for the given sensor name 2950413961deSRichard Marian Thomaiyar getObjectsWithConnection(sensorAsyncResp, sensorNames, 2951413961deSRichard Marian Thomaiyar std::move(getObjectsWithConnectionCb)); 2952413961deSRichard Marian Thomaiyar }; 2953413961deSRichard Marian Thomaiyar // get full sensor list for the given chassisId and cross verify the sensor. 2954413961deSRichard Marian Thomaiyar getChassis(sensorAsyncResp, std::move(getChassisSensorListCb)); 2955413961deSRichard Marian Thomaiyar } 2956413961deSRichard Marian Thomaiyar 2957a0ec28b6SAdrian Ambrożewicz /** 2958a0ec28b6SAdrian Ambrożewicz * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus 2959a0ec28b6SAdrian Ambrożewicz * path of the sensor. 2960a0ec28b6SAdrian Ambrożewicz * 2961a0ec28b6SAdrian Ambrożewicz * Function builds valid Redfish response for sensor query of given chassis and 2962a0ec28b6SAdrian Ambrożewicz * node. It then builds metadata about Redfish<->D-Bus correlations and provides 2963a0ec28b6SAdrian Ambrożewicz * it to caller in a callback. 2964a0ec28b6SAdrian Ambrożewicz * 2965a0ec28b6SAdrian Ambrożewicz * @param chassis Chassis for which retrieval should be performed 2966a0ec28b6SAdrian Ambrożewicz * @param node Node (group) of sensors. See sensors::node for supported values 2967a0ec28b6SAdrian Ambrożewicz * @param mapComplete Callback to be called with retrieval result 2968a0ec28b6SAdrian Ambrożewicz */ 2969021d32cfSKrzysztof Grobelny inline void retrieveUriToDbusMap(const std::string& chassis, 2970021d32cfSKrzysztof Grobelny const std::string& node, 2971a0ec28b6SAdrian Ambrożewicz SensorsAsyncResp::DataCompleteCb&& mapComplete) 2972a0ec28b6SAdrian Ambrożewicz { 2973c2bf7f99SWludzik, Jozef auto pathIt = sensors::dbus::paths.find(node); 2974c2bf7f99SWludzik, Jozef if (pathIt == sensors::dbus::paths.end()) 2975a0ec28b6SAdrian Ambrożewicz { 2976a0ec28b6SAdrian Ambrożewicz BMCWEB_LOG_ERROR << "Wrong node provided : " << node; 2977a0ec28b6SAdrian Ambrożewicz mapComplete(boost::beast::http::status::bad_request, {}); 2978a0ec28b6SAdrian Ambrożewicz return; 2979a0ec28b6SAdrian Ambrożewicz } 2980d51e072fSKrzysztof Grobelny 29819062d478SGunnar Mills auto res = std::make_shared<crow::Response>(); 29829062d478SGunnar Mills auto asyncResp = std::make_shared<bmcweb::AsyncResp>(*res); 2983a0ec28b6SAdrian Ambrożewicz auto callback = 29849062d478SGunnar Mills [res, asyncResp, mapCompleteCb{std::move(mapComplete)}]( 2985a0ec28b6SAdrian Ambrożewicz const boost::beast::http::status status, 2986a0ec28b6SAdrian Ambrożewicz const boost::container::flat_map<std::string, std::string>& 2987a0ec28b6SAdrian Ambrożewicz uriToDbus) { mapCompleteCb(status, uriToDbus); }; 2988a0ec28b6SAdrian Ambrożewicz 2989a0ec28b6SAdrian Ambrożewicz auto resp = std::make_shared<SensorsAsyncResp>( 2990d51e072fSKrzysztof Grobelny asyncResp, chassis, pathIt->second, node, std::move(callback)); 2991a0ec28b6SAdrian Ambrożewicz getChassisData(resp); 2992a0ec28b6SAdrian Ambrożewicz } 2993a0ec28b6SAdrian Ambrożewicz 29947e860f15SJohn Edward Broadbent inline void requestRoutesSensorCollection(App& app) 299595a3ecadSAnthony Wilson { 29967e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/") 2997ed398213SEd Tanous .privileges(redfish::privileges::getSensorCollection) 29987e860f15SJohn Edward Broadbent .methods( 29997e860f15SJohn Edward Broadbent boost::beast::http::verb::get)([](const crow::Request&, 30007e860f15SJohn Edward Broadbent const std::shared_ptr< 30017e860f15SJohn Edward Broadbent bmcweb::AsyncResp>& aResp, 30027e860f15SJohn Edward Broadbent const std::string& chassisId) { 300395a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "SensorCollection doGet enter"; 30048d1b46d7Szhanghch05 300595a3ecadSAnthony Wilson std::shared_ptr<SensorsAsyncResp> asyncResp = 3006a0ec28b6SAdrian Ambrożewicz std::make_shared<SensorsAsyncResp>( 30078d1b46d7Szhanghch05 aResp, chassisId, 30088d1b46d7Szhanghch05 sensors::dbus::paths.at(sensors::node::sensors), 3009a0ec28b6SAdrian Ambrożewicz sensors::node::sensors); 301095a3ecadSAnthony Wilson 301195a3ecadSAnthony Wilson auto getChassisCb = 3012b5a76932SEd Tanous [asyncResp]( 30137e860f15SJohn Edward Broadbent const std::shared_ptr< 30147e860f15SJohn Edward Broadbent boost::container::flat_set<std::string>>& sensorNames) { 301595a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb enter"; 301695a3ecadSAnthony Wilson 301795a3ecadSAnthony Wilson nlohmann::json& entriesArray = 30188d1b46d7Szhanghch05 asyncResp->asyncResp->res.jsonValue["Members"]; 301995a3ecadSAnthony Wilson for (auto& sensor : *sensorNames) 302095a3ecadSAnthony Wilson { 302195a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Adding sensor: " << sensor; 302295a3ecadSAnthony Wilson 302328aa8de5SGeorge Liu sdbusplus::message::object_path path(sensor); 302428aa8de5SGeorge Liu std::string sensorName = path.filename(); 302528aa8de5SGeorge Liu if (sensorName.empty()) 302695a3ecadSAnthony Wilson { 30277e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "Invalid sensor path: " 30287e860f15SJohn Edward Broadbent << sensor; 30298d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 303095a3ecadSAnthony Wilson return; 303195a3ecadSAnthony Wilson } 303295a3ecadSAnthony Wilson entriesArray.push_back( 30337e860f15SJohn Edward Broadbent {{"@odata.id", "/redfish/v1/Chassis/" + 30347e860f15SJohn Edward Broadbent asyncResp->chassisId + "/" + 30357e860f15SJohn Edward Broadbent asyncResp->chassisSubNode + "/" + 30367e860f15SJohn Edward Broadbent sensorName}}); 303795a3ecadSAnthony Wilson } 303895a3ecadSAnthony Wilson 30398d1b46d7Szhanghch05 asyncResp->asyncResp->res.jsonValue["Members@odata.count"] = 304095a3ecadSAnthony Wilson entriesArray.size(); 304195a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb exit"; 304295a3ecadSAnthony Wilson }; 304395a3ecadSAnthony Wilson 304495a3ecadSAnthony Wilson // Get set of sensors in chassis 304595a3ecadSAnthony Wilson getChassis(asyncResp, std::move(getChassisCb)); 304695a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "SensorCollection doGet exit"; 30477e860f15SJohn Edward Broadbent }); 304895a3ecadSAnthony Wilson } 304995a3ecadSAnthony Wilson 30507e860f15SJohn Edward Broadbent inline void requestRoutesSensor(App& app) 305195a3ecadSAnthony Wilson { 30527e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/") 3053ed398213SEd Tanous .privileges(redfish::privileges::getSensor) 30547e860f15SJohn Edward Broadbent .methods( 30557e860f15SJohn Edward Broadbent boost::beast::http::verb::get)([](const crow::Request&, 30567e860f15SJohn Edward Broadbent const std::shared_ptr< 30577e860f15SJohn Edward Broadbent bmcweb::AsyncResp>& aResp, 30587e860f15SJohn Edward Broadbent const std::string& chassisId, 30597e860f15SJohn Edward Broadbent const std::string& sensorName) { 306095a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Sensor doGet enter"; 306195a3ecadSAnthony Wilson std::shared_ptr<SensorsAsyncResp> asyncResp = 30628d1b46d7Szhanghch05 std::make_shared<SensorsAsyncResp>(aResp, chassisId, 3063a0ec28b6SAdrian Ambrożewicz std::vector<const char*>(), 3064a0ec28b6SAdrian Ambrożewicz sensors::node::sensors); 306595a3ecadSAnthony Wilson 306695a3ecadSAnthony Wilson const std::array<const char*, 1> interfaces = { 306795a3ecadSAnthony Wilson "xyz.openbmc_project.Sensor.Value"}; 306895a3ecadSAnthony Wilson 306995a3ecadSAnthony Wilson // Get a list of all of the sensors that implement Sensor.Value 307095a3ecadSAnthony Wilson // and get the path and service name associated with the sensor 307195a3ecadSAnthony Wilson crow::connections::systemBus->async_method_call( 307295a3ecadSAnthony Wilson [asyncResp, sensorName](const boost::system::error_code ec, 307395a3ecadSAnthony Wilson const GetSubTreeType& subtree) { 307495a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "respHandler1 enter"; 307595a3ecadSAnthony Wilson if (ec) 307695a3ecadSAnthony Wilson { 30778d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 30787e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR 30797e860f15SJohn Edward Broadbent << "Sensor getSensorPaths resp_handler: " 308095a3ecadSAnthony Wilson << "Dbus error " << ec; 308195a3ecadSAnthony Wilson return; 308295a3ecadSAnthony Wilson } 308395a3ecadSAnthony Wilson 308495a3ecadSAnthony Wilson GetSubTreeType::const_iterator it = std::find_if( 308595a3ecadSAnthony Wilson subtree.begin(), subtree.end(), 308695a3ecadSAnthony Wilson [sensorName]( 308795a3ecadSAnthony Wilson const std::pair< 308895a3ecadSAnthony Wilson std::string, 30897e860f15SJohn Edward Broadbent std::vector<std::pair< 30907e860f15SJohn Edward Broadbent std::string, std::vector<std::string>>>>& 309195a3ecadSAnthony Wilson object) { 309228aa8de5SGeorge Liu sdbusplus::message::object_path path(object.first); 309328aa8de5SGeorge Liu std::string name = path.filename(); 309428aa8de5SGeorge Liu if (name.empty()) 309595a3ecadSAnthony Wilson { 309695a3ecadSAnthony Wilson BMCWEB_LOG_ERROR << "Invalid sensor path: " 309728aa8de5SGeorge Liu << object.first; 309895a3ecadSAnthony Wilson return false; 309995a3ecadSAnthony Wilson } 310095a3ecadSAnthony Wilson 310195a3ecadSAnthony Wilson return name == sensorName; 310295a3ecadSAnthony Wilson }); 310395a3ecadSAnthony Wilson 310495a3ecadSAnthony Wilson if (it == subtree.end()) 310595a3ecadSAnthony Wilson { 310695a3ecadSAnthony Wilson BMCWEB_LOG_ERROR << "Could not find path for sensor: " 310795a3ecadSAnthony Wilson << sensorName; 31088d1b46d7Szhanghch05 messages::resourceNotFound(asyncResp->asyncResp->res, 31098d1b46d7Szhanghch05 "Sensor", sensorName); 311095a3ecadSAnthony Wilson return; 311195a3ecadSAnthony Wilson } 311295a3ecadSAnthony Wilson std::string_view sensorPath = (*it).first; 311395a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Found sensor path for sensor '" 311495a3ecadSAnthony Wilson << sensorName << "': " << sensorPath; 311595a3ecadSAnthony Wilson 31167e860f15SJohn Edward Broadbent const std::shared_ptr< 31177e860f15SJohn Edward Broadbent boost::container::flat_set<std::string>> 311895a3ecadSAnthony Wilson sensorList = std::make_shared< 311995a3ecadSAnthony Wilson boost::container::flat_set<std::string>>(); 312095a3ecadSAnthony Wilson 312195a3ecadSAnthony Wilson sensorList->emplace(sensorPath); 312295a3ecadSAnthony Wilson processSensorList(asyncResp, sensorList); 312395a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "respHandler1 exit"; 312495a3ecadSAnthony Wilson }, 312595a3ecadSAnthony Wilson "xyz.openbmc_project.ObjectMapper", 312695a3ecadSAnthony Wilson "/xyz/openbmc_project/object_mapper", 312795a3ecadSAnthony Wilson "xyz.openbmc_project.ObjectMapper", "GetSubTree", 312895a3ecadSAnthony Wilson "/xyz/openbmc_project/sensors", 2, interfaces); 31297e860f15SJohn Edward Broadbent }); 313095a3ecadSAnthony Wilson } 313195a3ecadSAnthony Wilson 313208777fb0SLewanczyk, Dawid } // namespace redfish 3133