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> 24168e20c1SEd Tanous #include <dbus_utility.hpp> 25ed398213SEd Tanous #include <registries/privilege_registry.hpp> 26*1e1e598dSJonathan Doman #include <sdbusplus/asio/property.hpp> 27413961deSRichard Marian Thomaiyar #include <utils/json_utils.hpp> 281214b7e7SGunnar Mills 291214b7e7SGunnar Mills #include <cmath> 30b5a76932SEd Tanous #include <utility> 31abf2add6SEd Tanous #include <variant> 3208777fb0SLewanczyk, Dawid 331abe55efSEd Tanous namespace redfish 341abe55efSEd Tanous { 3508777fb0SLewanczyk, Dawid 3608777fb0SLewanczyk, Dawid using GetSubTreeType = std::vector< 3708777fb0SLewanczyk, Dawid std::pair<std::string, 3808777fb0SLewanczyk, Dawid std::vector<std::pair<std::string, std::vector<std::string>>>>>; 3908777fb0SLewanczyk, Dawid 4008777fb0SLewanczyk, Dawid using ManagedObjectsVectorType = std::vector<std::pair< 41aa2e59c1SEd Tanous sdbusplus::message::object_path, 4208777fb0SLewanczyk, Dawid boost::container::flat_map< 43168e20c1SEd Tanous std::string, boost::container::flat_map< 44168e20c1SEd Tanous std::string, dbus::utility::DbusVariantType>>>>; 4508777fb0SLewanczyk, Dawid 46a0ec28b6SAdrian Ambrożewicz namespace sensors 47a0ec28b6SAdrian Ambrożewicz { 48a0ec28b6SAdrian Ambrożewicz namespace node 49a0ec28b6SAdrian Ambrożewicz { 50a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view power = "Power"; 51a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view sensors = "Sensors"; 52a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view thermal = "Thermal"; 53a0ec28b6SAdrian Ambrożewicz } // namespace node 54a0ec28b6SAdrian Ambrożewicz 55a0ec28b6SAdrian Ambrożewicz namespace dbus 56a0ec28b6SAdrian Ambrożewicz { 57c2bf7f99SWludzik, Jozef 58a0ec28b6SAdrian Ambrożewicz static const boost::container::flat_map<std::string_view, 59a0ec28b6SAdrian Ambrożewicz std::vector<const char*>> 60c2bf7f99SWludzik, Jozef paths = {{node::power, 61a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/voltage", 62a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/power"}}, 63a0ec28b6SAdrian Ambrożewicz {node::sensors, 64a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/power", 65a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/current", 667088690cSBasheer Ahmed Muddebihal "/xyz/openbmc_project/sensors/airflow", 67e8204933SGeorge Liu #ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM 68e8204933SGeorge Liu "/xyz/openbmc_project/sensors/voltage", 69e8204933SGeorge Liu "/xyz/openbmc_project/sensors/fan_tach", 70e8204933SGeorge Liu "/xyz/openbmc_project/sensors/temperature", 71e8204933SGeorge Liu "/xyz/openbmc_project/sensors/fan_pwm", 72e8204933SGeorge Liu "/xyz/openbmc_project/sensors/altitude", 73e8204933SGeorge Liu "/xyz/openbmc_project/sensors/energy", 74e8204933SGeorge Liu #endif 75a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/utilization"}}, 76a0ec28b6SAdrian Ambrożewicz {node::thermal, 77a0ec28b6SAdrian Ambrożewicz {"/xyz/openbmc_project/sensors/fan_tach", 78a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/temperature", 79a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/fan_pwm"}}}; 80c2bf7f99SWludzik, Jozef } // namespace dbus 81c2bf7f99SWludzik, Jozef 82c2bf7f99SWludzik, Jozef inline const char* toReadingType(const std::string& sensorType) 83c2bf7f99SWludzik, Jozef { 84c2bf7f99SWludzik, Jozef if (sensorType == "voltage") 85c2bf7f99SWludzik, Jozef { 86c2bf7f99SWludzik, Jozef return "Voltage"; 87c2bf7f99SWludzik, Jozef } 88c2bf7f99SWludzik, Jozef if (sensorType == "power") 89c2bf7f99SWludzik, Jozef { 90c2bf7f99SWludzik, Jozef return "Power"; 91c2bf7f99SWludzik, Jozef } 92c2bf7f99SWludzik, Jozef if (sensorType == "current") 93c2bf7f99SWludzik, Jozef { 94c2bf7f99SWludzik, Jozef return "Current"; 95c2bf7f99SWludzik, Jozef } 96c2bf7f99SWludzik, Jozef if (sensorType == "fan_tach") 97c2bf7f99SWludzik, Jozef { 98c2bf7f99SWludzik, Jozef return "Rotational"; 99c2bf7f99SWludzik, Jozef } 100c2bf7f99SWludzik, Jozef if (sensorType == "temperature") 101c2bf7f99SWludzik, Jozef { 102c2bf7f99SWludzik, Jozef return "Temperature"; 103c2bf7f99SWludzik, Jozef } 104c2bf7f99SWludzik, Jozef if (sensorType == "fan_pwm" || sensorType == "utilization") 105c2bf7f99SWludzik, Jozef { 106c2bf7f99SWludzik, Jozef return "Percent"; 107c2bf7f99SWludzik, Jozef } 108c2bf7f99SWludzik, Jozef if (sensorType == "altitude") 109c2bf7f99SWludzik, Jozef { 110c2bf7f99SWludzik, Jozef return "Altitude"; 111c2bf7f99SWludzik, Jozef } 112c2bf7f99SWludzik, Jozef if (sensorType == "airflow") 113c2bf7f99SWludzik, Jozef { 114c2bf7f99SWludzik, Jozef return "AirFlow"; 115c2bf7f99SWludzik, Jozef } 116c2bf7f99SWludzik, Jozef if (sensorType == "energy") 117c2bf7f99SWludzik, Jozef { 118c2bf7f99SWludzik, Jozef return "EnergyJoules"; 119c2bf7f99SWludzik, Jozef } 120c2bf7f99SWludzik, Jozef return ""; 121c2bf7f99SWludzik, Jozef } 122c2bf7f99SWludzik, Jozef 123c2bf7f99SWludzik, Jozef inline const char* toReadingUnits(const std::string& sensorType) 124c2bf7f99SWludzik, Jozef { 125c2bf7f99SWludzik, Jozef if (sensorType == "voltage") 126c2bf7f99SWludzik, Jozef { 127c2bf7f99SWludzik, Jozef return "V"; 128c2bf7f99SWludzik, Jozef } 129c2bf7f99SWludzik, Jozef if (sensorType == "power") 130c2bf7f99SWludzik, Jozef { 131c2bf7f99SWludzik, Jozef return "W"; 132c2bf7f99SWludzik, Jozef } 133c2bf7f99SWludzik, Jozef if (sensorType == "current") 134c2bf7f99SWludzik, Jozef { 135c2bf7f99SWludzik, Jozef return "A"; 136c2bf7f99SWludzik, Jozef } 137c2bf7f99SWludzik, Jozef if (sensorType == "fan_tach") 138c2bf7f99SWludzik, Jozef { 139c2bf7f99SWludzik, Jozef return "RPM"; 140c2bf7f99SWludzik, Jozef } 141c2bf7f99SWludzik, Jozef if (sensorType == "temperature") 142c2bf7f99SWludzik, Jozef { 143c2bf7f99SWludzik, Jozef return "Cel"; 144c2bf7f99SWludzik, Jozef } 145c2bf7f99SWludzik, Jozef if (sensorType == "fan_pwm" || sensorType == "utilization") 146c2bf7f99SWludzik, Jozef { 147c2bf7f99SWludzik, Jozef return "%"; 148c2bf7f99SWludzik, Jozef } 149c2bf7f99SWludzik, Jozef if (sensorType == "altitude") 150c2bf7f99SWludzik, Jozef { 151c2bf7f99SWludzik, Jozef return "m"; 152c2bf7f99SWludzik, Jozef } 153c2bf7f99SWludzik, Jozef if (sensorType == "airflow") 154c2bf7f99SWludzik, Jozef { 155c2bf7f99SWludzik, Jozef return "cft_i/min"; 156c2bf7f99SWludzik, Jozef } 157c2bf7f99SWludzik, Jozef if (sensorType == "energy") 158c2bf7f99SWludzik, Jozef { 159c2bf7f99SWludzik, Jozef return "J"; 160c2bf7f99SWludzik, Jozef } 161c2bf7f99SWludzik, Jozef return ""; 162a0ec28b6SAdrian Ambrożewicz } 163a0ec28b6SAdrian Ambrożewicz } // namespace sensors 164a0ec28b6SAdrian Ambrożewicz 16508777fb0SLewanczyk, Dawid /** 166588c3f0dSKowalski, Kamil * SensorsAsyncResp 16708777fb0SLewanczyk, Dawid * Gathers data needed for response processing after async calls are done 16808777fb0SLewanczyk, Dawid */ 1691abe55efSEd Tanous class SensorsAsyncResp 1701abe55efSEd Tanous { 17108777fb0SLewanczyk, Dawid public: 172a0ec28b6SAdrian Ambrożewicz using DataCompleteCb = std::function<void( 173a0ec28b6SAdrian Ambrożewicz const boost::beast::http::status status, 174a0ec28b6SAdrian Ambrożewicz const boost::container::flat_map<std::string, std::string>& uriToDbus)>; 175a0ec28b6SAdrian Ambrożewicz 176a0ec28b6SAdrian Ambrożewicz struct SensorData 177a0ec28b6SAdrian Ambrożewicz { 178a0ec28b6SAdrian Ambrożewicz const std::string name; 179a0ec28b6SAdrian Ambrożewicz std::string uri; 180a0ec28b6SAdrian Ambrożewicz const std::string valueKey; 181a0ec28b6SAdrian Ambrożewicz const std::string dbusPath; 182a0ec28b6SAdrian Ambrożewicz }; 183a0ec28b6SAdrian Ambrożewicz 1848d1b46d7Szhanghch05 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1858d1b46d7Szhanghch05 const std::string& chassisIdIn, 186b5a76932SEd Tanous const std::vector<const char*>& typesIn, 187a0ec28b6SAdrian Ambrożewicz const std::string_view& subNode) : 1888d1b46d7Szhanghch05 asyncResp(asyncResp), 189271584abSEd Tanous chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode) 1901214b7e7SGunnar Mills {} 19108777fb0SLewanczyk, Dawid 192a0ec28b6SAdrian Ambrożewicz // Store extra data about sensor mapping and return it in callback 1938d1b46d7Szhanghch05 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, 1948d1b46d7Szhanghch05 const std::string& chassisIdIn, 195b5a76932SEd Tanous const std::vector<const char*>& typesIn, 196a0ec28b6SAdrian Ambrożewicz const std::string_view& subNode, 197a0ec28b6SAdrian Ambrożewicz DataCompleteCb&& creationComplete) : 1988d1b46d7Szhanghch05 asyncResp(asyncResp), 199a0ec28b6SAdrian Ambrożewicz chassisId(chassisIdIn), types(typesIn), 200a0ec28b6SAdrian Ambrożewicz chassisSubNode(subNode), metadata{std::vector<SensorData>()}, 201a0ec28b6SAdrian Ambrożewicz dataComplete{std::move(creationComplete)} 202a0ec28b6SAdrian Ambrożewicz {} 203a0ec28b6SAdrian Ambrożewicz 2041abe55efSEd Tanous ~SensorsAsyncResp() 2051abe55efSEd Tanous { 2068d1b46d7Szhanghch05 if (asyncResp->res.result() == 2078d1b46d7Szhanghch05 boost::beast::http::status::internal_server_error) 2081abe55efSEd Tanous { 2091abe55efSEd Tanous // Reset the json object to clear out any data that made it in 2101abe55efSEd Tanous // before the error happened todo(ed) handle error condition with 2111abe55efSEd Tanous // proper code 2128d1b46d7Szhanghch05 asyncResp->res.jsonValue = nlohmann::json::object(); 21308777fb0SLewanczyk, Dawid } 214a0ec28b6SAdrian Ambrożewicz 215a0ec28b6SAdrian Ambrożewicz if (dataComplete && metadata) 216a0ec28b6SAdrian Ambrożewicz { 217a0ec28b6SAdrian Ambrożewicz boost::container::flat_map<std::string, std::string> map; 2188d1b46d7Szhanghch05 if (asyncResp->res.result() == boost::beast::http::status::ok) 219a0ec28b6SAdrian Ambrożewicz { 220a0ec28b6SAdrian Ambrożewicz for (auto& sensor : *metadata) 221a0ec28b6SAdrian Ambrożewicz { 222a0ec28b6SAdrian Ambrożewicz map.insert(std::make_pair(sensor.uri + sensor.valueKey, 223a0ec28b6SAdrian Ambrożewicz sensor.dbusPath)); 224a0ec28b6SAdrian Ambrożewicz } 225a0ec28b6SAdrian Ambrożewicz } 2268d1b46d7Szhanghch05 dataComplete(asyncResp->res.result(), map); 227a0ec28b6SAdrian Ambrożewicz } 22808777fb0SLewanczyk, Dawid } 229588c3f0dSKowalski, Kamil 230a0ec28b6SAdrian Ambrożewicz void addMetadata(const nlohmann::json& sensorObject, 231a0ec28b6SAdrian Ambrożewicz const std::string& valueKey, const std::string& dbusPath) 232a0ec28b6SAdrian Ambrożewicz { 233a0ec28b6SAdrian Ambrożewicz if (metadata) 234a0ec28b6SAdrian Ambrożewicz { 235a0ec28b6SAdrian Ambrożewicz metadata->emplace_back(SensorData{sensorObject["Name"], 236a0ec28b6SAdrian Ambrożewicz sensorObject["@odata.id"], 237a0ec28b6SAdrian Ambrożewicz valueKey, dbusPath}); 238a0ec28b6SAdrian Ambrożewicz } 239a0ec28b6SAdrian Ambrożewicz } 240a0ec28b6SAdrian Ambrożewicz 241a0ec28b6SAdrian Ambrożewicz void updateUri(const std::string& name, const std::string& uri) 242a0ec28b6SAdrian Ambrożewicz { 243a0ec28b6SAdrian Ambrożewicz if (metadata) 244a0ec28b6SAdrian Ambrożewicz { 245a0ec28b6SAdrian Ambrożewicz for (auto& sensor : *metadata) 246a0ec28b6SAdrian Ambrożewicz { 247a0ec28b6SAdrian Ambrożewicz if (sensor.name == name) 248a0ec28b6SAdrian Ambrożewicz { 249a0ec28b6SAdrian Ambrożewicz sensor.uri = uri; 250a0ec28b6SAdrian Ambrożewicz } 251a0ec28b6SAdrian Ambrożewicz } 252a0ec28b6SAdrian Ambrożewicz } 253a0ec28b6SAdrian Ambrożewicz } 254a0ec28b6SAdrian Ambrożewicz 2558d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp> asyncResp; 256a0ec28b6SAdrian Ambrożewicz const std::string chassisId; 25708777fb0SLewanczyk, Dawid const std::vector<const char*> types; 258a0ec28b6SAdrian Ambrożewicz const std::string chassisSubNode; 259a0ec28b6SAdrian Ambrożewicz 260a0ec28b6SAdrian Ambrożewicz private: 261a0ec28b6SAdrian Ambrożewicz std::optional<std::vector<SensorData>> metadata; 262a0ec28b6SAdrian Ambrożewicz DataCompleteCb dataComplete; 26308777fb0SLewanczyk, Dawid }; 26408777fb0SLewanczyk, Dawid 26508777fb0SLewanczyk, Dawid /** 266d500549bSAnthony Wilson * Possible states for physical inventory leds 267d500549bSAnthony Wilson */ 268d500549bSAnthony Wilson enum class LedState 269d500549bSAnthony Wilson { 270d500549bSAnthony Wilson OFF, 271d500549bSAnthony Wilson ON, 272d500549bSAnthony Wilson BLINK, 273d500549bSAnthony Wilson UNKNOWN 274d500549bSAnthony Wilson }; 275d500549bSAnthony Wilson 276d500549bSAnthony Wilson /** 277adc4f0dbSShawn McCarney * D-Bus inventory item associated with one or more sensors. 278adc4f0dbSShawn McCarney */ 279adc4f0dbSShawn McCarney class InventoryItem 280adc4f0dbSShawn McCarney { 281adc4f0dbSShawn McCarney public: 282adc4f0dbSShawn McCarney InventoryItem(const std::string& objPath) : 283adc4f0dbSShawn McCarney objectPath(objPath), name(), isPresent(true), isFunctional(true), 28442cbe538SGunnar Mills isPowerSupply(false), powerSupplyEfficiencyPercent(-1), manufacturer(), 28542cbe538SGunnar Mills model(), partNumber(), serialNumber(), sensors(), ledObjectPath(""), 286d500549bSAnthony Wilson ledState(LedState::UNKNOWN) 287adc4f0dbSShawn McCarney { 288adc4f0dbSShawn McCarney // Set inventory item name to last node of object path 28928aa8de5SGeorge Liu sdbusplus::message::object_path path(objectPath); 29028aa8de5SGeorge Liu name = path.filename(); 29128aa8de5SGeorge Liu if (name.empty()) 292adc4f0dbSShawn McCarney { 29328aa8de5SGeorge Liu BMCWEB_LOG_ERROR << "Failed to find '/' in " << objectPath; 294adc4f0dbSShawn McCarney } 295adc4f0dbSShawn McCarney } 296adc4f0dbSShawn McCarney 297adc4f0dbSShawn McCarney std::string objectPath; 298adc4f0dbSShawn McCarney std::string name; 299adc4f0dbSShawn McCarney bool isPresent; 300adc4f0dbSShawn McCarney bool isFunctional; 301adc4f0dbSShawn McCarney bool isPowerSupply; 30242cbe538SGunnar Mills int powerSupplyEfficiencyPercent; 303adc4f0dbSShawn McCarney std::string manufacturer; 304adc4f0dbSShawn McCarney std::string model; 305adc4f0dbSShawn McCarney std::string partNumber; 306adc4f0dbSShawn McCarney std::string serialNumber; 307adc4f0dbSShawn McCarney std::set<std::string> sensors; 308d500549bSAnthony Wilson std::string ledObjectPath; 309d500549bSAnthony Wilson LedState ledState; 310adc4f0dbSShawn McCarney }; 311adc4f0dbSShawn McCarney 312adc4f0dbSShawn McCarney /** 313413961deSRichard Marian Thomaiyar * @brief Get objects with connection necessary for sensors 314588c3f0dSKowalski, Kamil * @param SensorsAsyncResp Pointer to object holding response data 31508777fb0SLewanczyk, Dawid * @param sensorNames Sensors retrieved from chassis 31608777fb0SLewanczyk, Dawid * @param callback Callback for processing gathered connections 31708777fb0SLewanczyk, Dawid */ 31808777fb0SLewanczyk, Dawid template <typename Callback> 319413961deSRichard Marian Thomaiyar void getObjectsWithConnection( 32081ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 321b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 3221abe55efSEd Tanous Callback&& callback) 3231abe55efSEd Tanous { 324413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection enter"; 32503b5bae3SJames Feist const std::string path = "/xyz/openbmc_project/sensors"; 32608777fb0SLewanczyk, Dawid const std::array<std::string, 1> interfaces = { 32708777fb0SLewanczyk, Dawid "xyz.openbmc_project.Sensor.Value"}; 32808777fb0SLewanczyk, Dawid 32908777fb0SLewanczyk, Dawid // Response handler for parsing objects subtree 33081ce609eSEd Tanous auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 3311abe55efSEd Tanous sensorNames](const boost::system::error_code ec, 3321abe55efSEd Tanous const GetSubTreeType& subtree) { 333413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler enter"; 3341abe55efSEd Tanous if (ec) 3351abe55efSEd Tanous { 3368d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 337413961deSRichard Marian Thomaiyar BMCWEB_LOG_ERROR 338413961deSRichard Marian Thomaiyar << "getObjectsWithConnection resp_handler: Dbus error " << ec; 33908777fb0SLewanczyk, Dawid return; 34008777fb0SLewanczyk, Dawid } 34108777fb0SLewanczyk, Dawid 34255c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Found " << subtree.size() << " subtrees"; 34308777fb0SLewanczyk, Dawid 34408777fb0SLewanczyk, Dawid // Make unique list of connections only for requested sensor types and 34508777fb0SLewanczyk, Dawid // found in the chassis 34608777fb0SLewanczyk, Dawid boost::container::flat_set<std::string> connections; 347413961deSRichard Marian Thomaiyar std::set<std::pair<std::string, std::string>> objectsWithConnection; 3481abe55efSEd Tanous // Intrinsic to avoid malloc. Most systems will have < 8 sensor 3491abe55efSEd Tanous // producers 35008777fb0SLewanczyk, Dawid connections.reserve(8); 35108777fb0SLewanczyk, Dawid 35249c53ac9SJohnathan Mantey BMCWEB_LOG_DEBUG << "sensorNames list count: " << sensorNames->size(); 35349c53ac9SJohnathan Mantey for (const std::string& tsensor : *sensorNames) 3541abe55efSEd Tanous { 35555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Sensor to find: " << tsensor; 35608777fb0SLewanczyk, Dawid } 35708777fb0SLewanczyk, Dawid 35808777fb0SLewanczyk, Dawid for (const std::pair< 35908777fb0SLewanczyk, Dawid std::string, 36008777fb0SLewanczyk, Dawid std::vector<std::pair<std::string, std::vector<std::string>>>>& 3611abe55efSEd Tanous object : subtree) 3621abe55efSEd Tanous { 36349c53ac9SJohnathan Mantey if (sensorNames->find(object.first) != sensorNames->end()) 3641abe55efSEd Tanous { 36549c53ac9SJohnathan Mantey for (const std::pair<std::string, std::vector<std::string>>& 3661abe55efSEd Tanous objData : object.second) 3671abe55efSEd Tanous { 36849c53ac9SJohnathan Mantey BMCWEB_LOG_DEBUG << "Adding connection: " << objData.first; 36908777fb0SLewanczyk, Dawid connections.insert(objData.first); 370de629b6eSShawn McCarney objectsWithConnection.insert( 371de629b6eSShawn McCarney std::make_pair(object.first, objData.first)); 37208777fb0SLewanczyk, Dawid } 37308777fb0SLewanczyk, Dawid } 37408777fb0SLewanczyk, Dawid } 37555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Found " << connections.size() << " connections"; 376413961deSRichard Marian Thomaiyar callback(std::move(connections), std::move(objectsWithConnection)); 377413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler exit"; 37808777fb0SLewanczyk, Dawid }; 37908777fb0SLewanczyk, Dawid // Make call to ObjectMapper to find all sensors objects 38055c7b7a2SEd Tanous crow::connections::systemBus->async_method_call( 38155c7b7a2SEd Tanous std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 3821abe55efSEd Tanous "/xyz/openbmc_project/object_mapper", 3831abe55efSEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 2, interfaces); 384413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection exit"; 385413961deSRichard Marian Thomaiyar } 386413961deSRichard Marian Thomaiyar 387413961deSRichard Marian Thomaiyar /** 388413961deSRichard Marian Thomaiyar * @brief Create connections necessary for sensors 389413961deSRichard Marian Thomaiyar * @param SensorsAsyncResp Pointer to object holding response data 390413961deSRichard Marian Thomaiyar * @param sensorNames Sensors retrieved from chassis 391413961deSRichard Marian Thomaiyar * @param callback Callback for processing gathered connections 392413961deSRichard Marian Thomaiyar */ 393413961deSRichard Marian Thomaiyar template <typename Callback> 39449c53ac9SJohnathan Mantey void getConnections( 39581ce609eSEd Tanous std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 39649c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> sensorNames, 397413961deSRichard Marian Thomaiyar Callback&& callback) 398413961deSRichard Marian Thomaiyar { 399413961deSRichard Marian Thomaiyar auto objectsWithConnectionCb = 400413961deSRichard Marian Thomaiyar [callback](const boost::container::flat_set<std::string>& connections, 401413961deSRichard Marian Thomaiyar const std::set<std::pair<std::string, std::string>>& 4023174e4dfSEd Tanous /*objectsWithConnection*/) { callback(connections); }; 40381ce609eSEd Tanous getObjectsWithConnection(sensorsAsyncResp, sensorNames, 404413961deSRichard Marian Thomaiyar std::move(objectsWithConnectionCb)); 40508777fb0SLewanczyk, Dawid } 40608777fb0SLewanczyk, Dawid 40708777fb0SLewanczyk, Dawid /** 40849c53ac9SJohnathan Mantey * @brief Shrinks the list of sensors for processing 40949c53ac9SJohnathan Mantey * @param SensorsAysncResp The class holding the Redfish response 41049c53ac9SJohnathan Mantey * @param allSensors A list of all the sensors associated to the 41149c53ac9SJohnathan Mantey * chassis element (i.e. baseboard, front panel, etc...) 41249c53ac9SJohnathan Mantey * @param activeSensors A list that is a reduction of the incoming 41349c53ac9SJohnathan Mantey * allSensors list. Eliminate Thermal sensors when a Power request is 41449c53ac9SJohnathan Mantey * made, and eliminate Power sensors when a Thermal request is made. 41549c53ac9SJohnathan Mantey */ 41623a21a1cSEd Tanous inline void reduceSensorList( 41781ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 41849c53ac9SJohnathan Mantey const std::vector<std::string>* allSensors, 419b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& 420b5a76932SEd Tanous activeSensors) 42149c53ac9SJohnathan Mantey { 42281ce609eSEd Tanous if (sensorsAsyncResp == nullptr) 42349c53ac9SJohnathan Mantey { 42449c53ac9SJohnathan Mantey return; 42549c53ac9SJohnathan Mantey } 42649c53ac9SJohnathan Mantey if ((allSensors == nullptr) || (activeSensors == nullptr)) 42749c53ac9SJohnathan Mantey { 42849c53ac9SJohnathan Mantey messages::resourceNotFound( 4298d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res, sensorsAsyncResp->chassisSubNode, 43081ce609eSEd Tanous sensorsAsyncResp->chassisSubNode == sensors::node::thermal 431a0ec28b6SAdrian Ambrożewicz ? "Temperatures" 43249c53ac9SJohnathan Mantey : "Voltages"); 43349c53ac9SJohnathan Mantey 43449c53ac9SJohnathan Mantey return; 43549c53ac9SJohnathan Mantey } 43649c53ac9SJohnathan Mantey if (allSensors->empty()) 43749c53ac9SJohnathan Mantey { 43849c53ac9SJohnathan Mantey // Nothing to do, the activeSensors object is also empty 43949c53ac9SJohnathan Mantey return; 44049c53ac9SJohnathan Mantey } 44149c53ac9SJohnathan Mantey 44281ce609eSEd Tanous for (const char* type : sensorsAsyncResp->types) 44349c53ac9SJohnathan Mantey { 44449c53ac9SJohnathan Mantey for (const std::string& sensor : *allSensors) 44549c53ac9SJohnathan Mantey { 44649c53ac9SJohnathan Mantey if (boost::starts_with(sensor, type)) 44749c53ac9SJohnathan Mantey { 44849c53ac9SJohnathan Mantey activeSensors->emplace(sensor); 44949c53ac9SJohnathan Mantey } 45049c53ac9SJohnathan Mantey } 45149c53ac9SJohnathan Mantey } 45249c53ac9SJohnathan Mantey } 45349c53ac9SJohnathan Mantey 45449c53ac9SJohnathan Mantey /** 4554bb3dc34SCarol Wang * @brief Retrieves valid chassis path 4564bb3dc34SCarol Wang * @param asyncResp Pointer to object holding response data 4574bb3dc34SCarol Wang * @param callback Callback for next step to get valid chassis path 4584bb3dc34SCarol Wang */ 4594bb3dc34SCarol Wang template <typename Callback> 460b5a76932SEd Tanous void getValidChassisPath(const std::shared_ptr<SensorsAsyncResp>& asyncResp, 4614bb3dc34SCarol Wang Callback&& callback) 4624bb3dc34SCarol Wang { 4634bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "checkChassisId enter"; 4644bb3dc34SCarol Wang const std::array<const char*, 2> interfaces = { 4654bb3dc34SCarol Wang "xyz.openbmc_project.Inventory.Item.Board", 4664bb3dc34SCarol Wang "xyz.openbmc_project.Inventory.Item.Chassis"}; 4674bb3dc34SCarol Wang 4684bb3dc34SCarol Wang auto respHandler = 4694bb3dc34SCarol Wang [callback{std::move(callback)}, 4704bb3dc34SCarol Wang asyncResp](const boost::system::error_code ec, 4714bb3dc34SCarol Wang const std::vector<std::string>& chassisPaths) mutable { 4724bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "getValidChassisPath respHandler enter"; 4734bb3dc34SCarol Wang if (ec) 4744bb3dc34SCarol Wang { 4754bb3dc34SCarol Wang BMCWEB_LOG_ERROR 4764bb3dc34SCarol Wang << "getValidChassisPath respHandler DBUS error: " << ec; 4778d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 4784bb3dc34SCarol Wang return; 4794bb3dc34SCarol Wang } 4804bb3dc34SCarol Wang 4814bb3dc34SCarol Wang std::optional<std::string> chassisPath; 4824bb3dc34SCarol Wang std::string chassisName; 4834bb3dc34SCarol Wang for (const std::string& chassis : chassisPaths) 4844bb3dc34SCarol Wang { 48528aa8de5SGeorge Liu sdbusplus::message::object_path path(chassis); 48628aa8de5SGeorge Liu chassisName = path.filename(); 48728aa8de5SGeorge Liu if (chassisName.empty()) 4884bb3dc34SCarol Wang { 4894bb3dc34SCarol Wang BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis; 4904bb3dc34SCarol Wang continue; 4914bb3dc34SCarol Wang } 4924bb3dc34SCarol Wang if (chassisName == asyncResp->chassisId) 4934bb3dc34SCarol Wang { 4944bb3dc34SCarol Wang chassisPath = chassis; 4954bb3dc34SCarol Wang break; 4964bb3dc34SCarol Wang } 4974bb3dc34SCarol Wang } 4984bb3dc34SCarol Wang callback(chassisPath); 4994bb3dc34SCarol Wang }; 5004bb3dc34SCarol Wang 5014bb3dc34SCarol Wang // Get the Chassis Collection 5024bb3dc34SCarol Wang crow::connections::systemBus->async_method_call( 5034bb3dc34SCarol Wang respHandler, "xyz.openbmc_project.ObjectMapper", 5044bb3dc34SCarol Wang "/xyz/openbmc_project/object_mapper", 5054bb3dc34SCarol Wang "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 5064bb3dc34SCarol Wang "/xyz/openbmc_project/inventory", 0, interfaces); 5074bb3dc34SCarol Wang BMCWEB_LOG_DEBUG << "checkChassisId exit"; 5084bb3dc34SCarol Wang } 5094bb3dc34SCarol Wang 5104bb3dc34SCarol Wang /** 51108777fb0SLewanczyk, Dawid * @brief Retrieves requested chassis sensors and redundancy data from DBus . 512588c3f0dSKowalski, Kamil * @param SensorsAsyncResp Pointer to object holding response data 51308777fb0SLewanczyk, Dawid * @param callback Callback for next step in gathered sensor processing 51408777fb0SLewanczyk, Dawid */ 51508777fb0SLewanczyk, Dawid template <typename Callback> 516b5a76932SEd Tanous void getChassis(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 5171abe55efSEd Tanous Callback&& callback) 5181abe55efSEd Tanous { 51955c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis enter"; 520adc4f0dbSShawn McCarney const std::array<const char*, 2> interfaces = { 52149c53ac9SJohnathan Mantey "xyz.openbmc_project.Inventory.Item.Board", 522adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Item.Chassis"}; 52349c53ac9SJohnathan Mantey auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp]( 52449c53ac9SJohnathan Mantey const boost::system::error_code ec, 52549c53ac9SJohnathan Mantey const std::vector<std::string>& chassisPaths) { 52655c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis respHandler enter"; 5271abe55efSEd Tanous if (ec) 5281abe55efSEd Tanous { 52955c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "getChassis respHandler DBUS error: " << ec; 5308d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 53108777fb0SLewanczyk, Dawid return; 53208777fb0SLewanczyk, Dawid } 53308777fb0SLewanczyk, Dawid 53449c53ac9SJohnathan Mantey const std::string* chassisPath = nullptr; 53549c53ac9SJohnathan Mantey std::string chassisName; 53649c53ac9SJohnathan Mantey for (const std::string& chassis : chassisPaths) 5371abe55efSEd Tanous { 53828aa8de5SGeorge Liu sdbusplus::message::object_path path(chassis); 53928aa8de5SGeorge Liu chassisName = path.filename(); 54028aa8de5SGeorge Liu if (chassisName.empty()) 5411abe55efSEd Tanous { 54249c53ac9SJohnathan Mantey BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis; 543daf36e2eSEd Tanous continue; 544daf36e2eSEd Tanous } 54549c53ac9SJohnathan Mantey if (chassisName == sensorsAsyncResp->chassisId) 5461abe55efSEd Tanous { 54749c53ac9SJohnathan Mantey chassisPath = &chassis; 54849c53ac9SJohnathan Mantey break; 549daf36e2eSEd Tanous } 55049c53ac9SJohnathan Mantey } 55149c53ac9SJohnathan Mantey if (chassisPath == nullptr) 5521abe55efSEd Tanous { 5538d1b46d7Szhanghch05 messages::resourceNotFound(sensorsAsyncResp->asyncResp->res, 5548d1b46d7Szhanghch05 "Chassis", sensorsAsyncResp->chassisId); 55549c53ac9SJohnathan Mantey return; 5561abe55efSEd Tanous } 55708777fb0SLewanczyk, Dawid 55849c53ac9SJohnathan Mantey const std::string& chassisSubNode = sensorsAsyncResp->chassisSubNode; 559a0ec28b6SAdrian Ambrożewicz if (chassisSubNode == sensors::node::power) 56049c53ac9SJohnathan Mantey { 5618d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 56249c53ac9SJohnathan Mantey "#Power.v1_5_2.Power"; 56349c53ac9SJohnathan Mantey } 564a0ec28b6SAdrian Ambrożewicz else if (chassisSubNode == sensors::node::thermal) 56549c53ac9SJohnathan Mantey { 5668d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 56749c53ac9SJohnathan Mantey "#Thermal.v1_4_0.Thermal"; 5688d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Fans"] = 5698d1b46d7Szhanghch05 nlohmann::json::array(); 5708d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Temperatures"] = 5714f9a2130SJennifer Lee nlohmann::json::array(); 57249c53ac9SJohnathan Mantey } 573a0ec28b6SAdrian Ambrożewicz else if (chassisSubNode == sensors::node::sensors) 57495a3ecadSAnthony Wilson { 5758d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 57695a3ecadSAnthony Wilson "#SensorCollection.SensorCollection"; 5778d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Description"] = 57895a3ecadSAnthony Wilson "Collection of Sensors for this Chassis"; 5798d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Members"] = 58095a3ecadSAnthony Wilson nlohmann::json::array(); 5818d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Members@odata.count"] = 5828d1b46d7Szhanghch05 0; 58395a3ecadSAnthony Wilson } 58495a3ecadSAnthony Wilson 585a0ec28b6SAdrian Ambrożewicz if (chassisSubNode != sensors::node::sensors) 58695a3ecadSAnthony Wilson { 5878d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Id"] = chassisSubNode; 58895a3ecadSAnthony Wilson } 58995a3ecadSAnthony Wilson 5908d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] = 59149c53ac9SJohnathan Mantey "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + "/" + 59249c53ac9SJohnathan Mantey chassisSubNode; 5938d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Name"] = chassisSubNode; 5948fb49dd6SShawn McCarney // Get the list of all sensors for this Chassis element 5958fb49dd6SShawn McCarney std::string sensorPath = *chassisPath + "/all_sensors"; 596*1e1e598dSJonathan Doman sdbusplus::asio::getProperty<std::vector<std::string>>( 597*1e1e598dSJonathan Doman *crow::connections::systemBus, "xyz.openbmc_project.ObjectMapper", 598*1e1e598dSJonathan Doman sensorPath, "xyz.openbmc_project.Association", "endpoints", 59949c53ac9SJohnathan Mantey [sensorsAsyncResp, callback{std::move(callback)}]( 600271584abSEd Tanous const boost::system::error_code& e, 601*1e1e598dSJonathan Doman const std::vector<std::string>& nodeSensorList) { 602271584abSEd Tanous if (e) 60349c53ac9SJohnathan Mantey { 604271584abSEd Tanous if (e.value() != EBADR) 60549c53ac9SJohnathan Mantey { 6068d1b46d7Szhanghch05 messages::internalError( 6078d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 60849c53ac9SJohnathan Mantey return; 60949c53ac9SJohnathan Mantey } 61049c53ac9SJohnathan Mantey } 61149c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> 61249c53ac9SJohnathan Mantey culledSensorList = std::make_shared< 61349c53ac9SJohnathan Mantey boost::container::flat_set<std::string>>(); 614*1e1e598dSJonathan Doman reduceSensorList(sensorsAsyncResp, &nodeSensorList, 61549c53ac9SJohnathan Mantey culledSensorList); 61649c53ac9SJohnathan Mantey callback(culledSensorList); 617*1e1e598dSJonathan Doman }); 61849c53ac9SJohnathan Mantey }; 61949c53ac9SJohnathan Mantey 62049c53ac9SJohnathan Mantey // Get the Chassis Collection 62149c53ac9SJohnathan Mantey crow::connections::systemBus->async_method_call( 62249c53ac9SJohnathan Mantey respHandler, "xyz.openbmc_project.ObjectMapper", 62349c53ac9SJohnathan Mantey "/xyz/openbmc_project/object_mapper", 62449c53ac9SJohnathan Mantey "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 625271584abSEd Tanous "/xyz/openbmc_project/inventory", 0, interfaces); 62655c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis exit"; 62708777fb0SLewanczyk, Dawid } 62808777fb0SLewanczyk, Dawid 62908777fb0SLewanczyk, Dawid /** 630de629b6eSShawn McCarney * @brief Finds all DBus object paths that implement ObjectManager. 631de629b6eSShawn McCarney * 632de629b6eSShawn McCarney * Creates a mapping from the associated connection name to the object path. 633de629b6eSShawn McCarney * 634de629b6eSShawn McCarney * Finds the object paths asynchronously. Invokes callback when information has 635de629b6eSShawn McCarney * been obtained. 636de629b6eSShawn McCarney * 637de629b6eSShawn McCarney * The callback must have the following signature: 638de629b6eSShawn McCarney * @code 6398fb49dd6SShawn McCarney * callback(std::shared_ptr<boost::container::flat_map<std::string, 6408fb49dd6SShawn McCarney * std::string>> objectMgrPaths) 641de629b6eSShawn McCarney * @endcode 642de629b6eSShawn McCarney * 64349c53ac9SJohnathan Mantey * @param sensorsAsyncResp Pointer to object holding response data. 644de629b6eSShawn McCarney * @param callback Callback to invoke when object paths obtained. 645de629b6eSShawn McCarney */ 646de629b6eSShawn McCarney template <typename Callback> 647b5a76932SEd Tanous void getObjectManagerPaths( 64881ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 649de629b6eSShawn McCarney Callback&& callback) 650de629b6eSShawn McCarney { 651de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths enter"; 652de629b6eSShawn McCarney const std::array<std::string, 1> interfaces = { 653de629b6eSShawn McCarney "org.freedesktop.DBus.ObjectManager"}; 654de629b6eSShawn McCarney 655de629b6eSShawn McCarney // Response handler for GetSubTree DBus method 656de629b6eSShawn McCarney auto respHandler = [callback{std::move(callback)}, 65781ce609eSEd Tanous sensorsAsyncResp](const boost::system::error_code ec, 658de629b6eSShawn McCarney const GetSubTreeType& subtree) { 659de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler enter"; 660de629b6eSShawn McCarney if (ec) 661de629b6eSShawn McCarney { 6628d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 663de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "getObjectManagerPaths respHandler: DBus error " 664de629b6eSShawn McCarney << ec; 665de629b6eSShawn McCarney return; 666de629b6eSShawn McCarney } 667de629b6eSShawn McCarney 668de629b6eSShawn McCarney // Loop over returned object paths 6698fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 6708fb49dd6SShawn McCarney objectMgrPaths = std::make_shared< 6718fb49dd6SShawn McCarney boost::container::flat_map<std::string, std::string>>(); 672de629b6eSShawn McCarney for (const std::pair< 673de629b6eSShawn McCarney std::string, 674de629b6eSShawn McCarney std::vector<std::pair<std::string, std::vector<std::string>>>>& 675de629b6eSShawn McCarney object : subtree) 676de629b6eSShawn McCarney { 677de629b6eSShawn McCarney // Loop over connections for current object path 678de629b6eSShawn McCarney const std::string& objectPath = object.first; 679de629b6eSShawn McCarney for (const std::pair<std::string, std::vector<std::string>>& 680de629b6eSShawn McCarney objData : object.second) 681de629b6eSShawn McCarney { 682de629b6eSShawn McCarney // Add mapping from connection to object path 683de629b6eSShawn McCarney const std::string& connection = objData.first; 6848fb49dd6SShawn McCarney (*objectMgrPaths)[connection] = objectPath; 685de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "Added mapping " << connection << " -> " 686de629b6eSShawn McCarney << objectPath; 687de629b6eSShawn McCarney } 688de629b6eSShawn McCarney } 6898fb49dd6SShawn McCarney callback(objectMgrPaths); 690de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler exit"; 691de629b6eSShawn McCarney }; 692de629b6eSShawn McCarney 693de629b6eSShawn McCarney // Query mapper for all DBus object paths that implement ObjectManager 694de629b6eSShawn McCarney crow::connections::systemBus->async_method_call( 695de629b6eSShawn McCarney std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 696de629b6eSShawn McCarney "/xyz/openbmc_project/object_mapper", 697271584abSEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", 0, interfaces); 698de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths exit"; 699de629b6eSShawn McCarney } 700de629b6eSShawn McCarney 701de629b6eSShawn McCarney /** 702adc4f0dbSShawn McCarney * @brief Returns the Redfish State value for the specified inventory item. 703adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with a sensor. 704adc4f0dbSShawn McCarney * @return State value for inventory item. 70534dd179eSJames Feist */ 70623a21a1cSEd Tanous inline std::string getState(const InventoryItem* inventoryItem) 707adc4f0dbSShawn McCarney { 708adc4f0dbSShawn McCarney if ((inventoryItem != nullptr) && !(inventoryItem->isPresent)) 709adc4f0dbSShawn McCarney { 710adc4f0dbSShawn McCarney return "Absent"; 711adc4f0dbSShawn McCarney } 71234dd179eSJames Feist 713adc4f0dbSShawn McCarney return "Enabled"; 714adc4f0dbSShawn McCarney } 715adc4f0dbSShawn McCarney 716adc4f0dbSShawn McCarney /** 717adc4f0dbSShawn McCarney * @brief Returns the Redfish Health value for the specified sensor. 718adc4f0dbSShawn McCarney * @param sensorJson Sensor JSON object. 719adc4f0dbSShawn McCarney * @param interfacesDict Map of all sensor interfaces. 720adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with the sensor. Will 721adc4f0dbSShawn McCarney * be nullptr if no associated inventory item was found. 722adc4f0dbSShawn McCarney * @return Health value for sensor. 723adc4f0dbSShawn McCarney */ 72423a21a1cSEd Tanous inline std::string getHealth( 725adc4f0dbSShawn McCarney nlohmann::json& sensorJson, 72634dd179eSJames Feist const boost::container::flat_map< 727168e20c1SEd Tanous std::string, boost::container::flat_map< 728168e20c1SEd Tanous std::string, dbus::utility::DbusVariantType>>& 729adc4f0dbSShawn McCarney interfacesDict, 730adc4f0dbSShawn McCarney const InventoryItem* inventoryItem) 73134dd179eSJames Feist { 732adc4f0dbSShawn McCarney // Get current health value (if any) in the sensor JSON object. Some JSON 733adc4f0dbSShawn McCarney // objects contain multiple sensors (such as PowerSupplies). We want to set 734adc4f0dbSShawn McCarney // the overall health to be the most severe of any of the sensors. 735adc4f0dbSShawn McCarney std::string currentHealth; 736adc4f0dbSShawn McCarney auto statusIt = sensorJson.find("Status"); 737adc4f0dbSShawn McCarney if (statusIt != sensorJson.end()) 738adc4f0dbSShawn McCarney { 739adc4f0dbSShawn McCarney auto healthIt = statusIt->find("Health"); 740adc4f0dbSShawn McCarney if (healthIt != statusIt->end()) 741adc4f0dbSShawn McCarney { 742adc4f0dbSShawn McCarney std::string* health = healthIt->get_ptr<std::string*>(); 743adc4f0dbSShawn McCarney if (health != nullptr) 744adc4f0dbSShawn McCarney { 745adc4f0dbSShawn McCarney currentHealth = *health; 746adc4f0dbSShawn McCarney } 747adc4f0dbSShawn McCarney } 748adc4f0dbSShawn McCarney } 749adc4f0dbSShawn McCarney 750adc4f0dbSShawn McCarney // If current health in JSON object is already Critical, return that. This 751adc4f0dbSShawn McCarney // should override the sensor health, which might be less severe. 752adc4f0dbSShawn McCarney if (currentHealth == "Critical") 753adc4f0dbSShawn McCarney { 754adc4f0dbSShawn McCarney return "Critical"; 755adc4f0dbSShawn McCarney } 756adc4f0dbSShawn McCarney 757adc4f0dbSShawn McCarney // Check if sensor has critical threshold alarm 75834dd179eSJames Feist auto criticalThresholdIt = 75934dd179eSJames Feist interfacesDict.find("xyz.openbmc_project.Sensor.Threshold.Critical"); 76034dd179eSJames Feist if (criticalThresholdIt != interfacesDict.end()) 76134dd179eSJames Feist { 76234dd179eSJames Feist auto thresholdHighIt = 76334dd179eSJames Feist criticalThresholdIt->second.find("CriticalAlarmHigh"); 76434dd179eSJames Feist auto thresholdLowIt = 76534dd179eSJames Feist criticalThresholdIt->second.find("CriticalAlarmLow"); 76634dd179eSJames Feist if (thresholdHighIt != criticalThresholdIt->second.end()) 76734dd179eSJames Feist { 76834dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdHighIt->second); 76934dd179eSJames Feist if (asserted == nullptr) 77034dd179eSJames Feist { 77134dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 77234dd179eSJames Feist } 77334dd179eSJames Feist else if (*asserted) 77434dd179eSJames Feist { 77534dd179eSJames Feist return "Critical"; 77634dd179eSJames Feist } 77734dd179eSJames Feist } 77834dd179eSJames Feist if (thresholdLowIt != criticalThresholdIt->second.end()) 77934dd179eSJames Feist { 78034dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdLowIt->second); 78134dd179eSJames Feist if (asserted == nullptr) 78234dd179eSJames Feist { 78334dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 78434dd179eSJames Feist } 78534dd179eSJames Feist else if (*asserted) 78634dd179eSJames Feist { 78734dd179eSJames Feist return "Critical"; 78834dd179eSJames Feist } 78934dd179eSJames Feist } 79034dd179eSJames Feist } 79134dd179eSJames Feist 792adc4f0dbSShawn McCarney // Check if associated inventory item is not functional 793adc4f0dbSShawn McCarney if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional)) 794adc4f0dbSShawn McCarney { 795adc4f0dbSShawn McCarney return "Critical"; 796adc4f0dbSShawn McCarney } 797adc4f0dbSShawn McCarney 798adc4f0dbSShawn McCarney // If current health in JSON object is already Warning, return that. This 799adc4f0dbSShawn McCarney // should override the sensor status, which might be less severe. 800adc4f0dbSShawn McCarney if (currentHealth == "Warning") 801adc4f0dbSShawn McCarney { 802adc4f0dbSShawn McCarney return "Warning"; 803adc4f0dbSShawn McCarney } 804adc4f0dbSShawn McCarney 805adc4f0dbSShawn McCarney // Check if sensor has warning threshold alarm 80634dd179eSJames Feist auto warningThresholdIt = 80734dd179eSJames Feist interfacesDict.find("xyz.openbmc_project.Sensor.Threshold.Warning"); 80834dd179eSJames Feist if (warningThresholdIt != interfacesDict.end()) 80934dd179eSJames Feist { 81034dd179eSJames Feist auto thresholdHighIt = 81134dd179eSJames Feist warningThresholdIt->second.find("WarningAlarmHigh"); 81234dd179eSJames Feist auto thresholdLowIt = 81334dd179eSJames Feist warningThresholdIt->second.find("WarningAlarmLow"); 81434dd179eSJames Feist if (thresholdHighIt != warningThresholdIt->second.end()) 81534dd179eSJames Feist { 81634dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdHighIt->second); 81734dd179eSJames Feist if (asserted == nullptr) 81834dd179eSJames Feist { 81934dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 82034dd179eSJames Feist } 82134dd179eSJames Feist else if (*asserted) 82234dd179eSJames Feist { 82334dd179eSJames Feist return "Warning"; 82434dd179eSJames Feist } 82534dd179eSJames Feist } 82634dd179eSJames Feist if (thresholdLowIt != warningThresholdIt->second.end()) 82734dd179eSJames Feist { 82834dd179eSJames Feist const bool* asserted = std::get_if<bool>(&thresholdLowIt->second); 82934dd179eSJames Feist if (asserted == nullptr) 83034dd179eSJames Feist { 83134dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 83234dd179eSJames Feist } 83334dd179eSJames Feist else if (*asserted) 83434dd179eSJames Feist { 83534dd179eSJames Feist return "Warning"; 83634dd179eSJames Feist } 83734dd179eSJames Feist } 83834dd179eSJames Feist } 839adc4f0dbSShawn McCarney 84034dd179eSJames Feist return "OK"; 84134dd179eSJames Feist } 84234dd179eSJames Feist 84323a21a1cSEd Tanous inline void setLedState(nlohmann::json& sensorJson, 844d500549bSAnthony Wilson const InventoryItem* inventoryItem) 845d500549bSAnthony Wilson { 846d500549bSAnthony Wilson if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty()) 847d500549bSAnthony Wilson { 848d500549bSAnthony Wilson switch (inventoryItem->ledState) 849d500549bSAnthony Wilson { 850d500549bSAnthony Wilson case LedState::OFF: 851d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Off"; 852d500549bSAnthony Wilson break; 853d500549bSAnthony Wilson case LedState::ON: 854d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Lit"; 855d500549bSAnthony Wilson break; 856d500549bSAnthony Wilson case LedState::BLINK: 857d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Blinking"; 858d500549bSAnthony Wilson break; 85923a21a1cSEd Tanous case LedState::UNKNOWN: 860d500549bSAnthony Wilson break; 861d500549bSAnthony Wilson } 862d500549bSAnthony Wilson } 863d500549bSAnthony Wilson } 864d500549bSAnthony Wilson 86534dd179eSJames Feist /** 86608777fb0SLewanczyk, Dawid * @brief Builds a json sensor representation of a sensor. 86708777fb0SLewanczyk, Dawid * @param sensorName The name of the sensor to be built 868274fad5aSGunnar Mills * @param sensorType The type (temperature, fan_tach, etc) of the sensor to 86908777fb0SLewanczyk, Dawid * build 870a0ec28b6SAdrian Ambrożewicz * @param sensorsAsyncResp Sensor metadata 87108777fb0SLewanczyk, Dawid * @param interfacesDict A dictionary of the interfaces and properties of said 87208777fb0SLewanczyk, Dawid * interfaces to be built from 87308777fb0SLewanczyk, Dawid * @param sensor_json The json object to fill 874adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with the sensor. Will 875adc4f0dbSShawn McCarney * be nullptr if no associated inventory item was found. 87608777fb0SLewanczyk, Dawid */ 87723a21a1cSEd Tanous inline void objectInterfacesToJson( 87808777fb0SLewanczyk, Dawid const std::string& sensorName, const std::string& sensorType, 879b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 88008777fb0SLewanczyk, Dawid const boost::container::flat_map< 881168e20c1SEd Tanous std::string, boost::container::flat_map< 882168e20c1SEd Tanous std::string, dbus::utility::DbusVariantType>>& 88308777fb0SLewanczyk, Dawid interfacesDict, 88481ce609eSEd Tanous nlohmann::json& sensorJson, InventoryItem* inventoryItem) 8851abe55efSEd Tanous { 88608777fb0SLewanczyk, Dawid // We need a value interface before we can do anything with it 88755c7b7a2SEd Tanous auto valueIt = interfacesDict.find("xyz.openbmc_project.Sensor.Value"); 8881abe55efSEd Tanous if (valueIt == interfacesDict.end()) 8891abe55efSEd Tanous { 89055c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "Sensor doesn't have a value interface"; 89108777fb0SLewanczyk, Dawid return; 89208777fb0SLewanczyk, Dawid } 89308777fb0SLewanczyk, Dawid 89408777fb0SLewanczyk, Dawid // Assume values exist as is (10^0 == 1) if no scale exists 89508777fb0SLewanczyk, Dawid int64_t scaleMultiplier = 0; 89608777fb0SLewanczyk, Dawid 89755c7b7a2SEd Tanous auto scaleIt = valueIt->second.find("Scale"); 89808777fb0SLewanczyk, Dawid // If a scale exists, pull value as int64, and use the scaling. 8991abe55efSEd Tanous if (scaleIt != valueIt->second.end()) 9001abe55efSEd Tanous { 901abf2add6SEd Tanous const int64_t* int64Value = std::get_if<int64_t>(&scaleIt->second); 9021abe55efSEd Tanous if (int64Value != nullptr) 9031abe55efSEd Tanous { 90408777fb0SLewanczyk, Dawid scaleMultiplier = *int64Value; 90508777fb0SLewanczyk, Dawid } 90608777fb0SLewanczyk, Dawid } 90708777fb0SLewanczyk, Dawid 908a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 909adc4f0dbSShawn McCarney { 91095a3ecadSAnthony Wilson // For sensors in SensorCollection we set Id instead of MemberId, 91195a3ecadSAnthony Wilson // including power sensors. 91281ce609eSEd Tanous sensorJson["Id"] = sensorName; 91381ce609eSEd Tanous sensorJson["Name"] = boost::replace_all_copy(sensorName, "_", " "); 91495a3ecadSAnthony Wilson } 91595a3ecadSAnthony Wilson else if (sensorType != "power") 91695a3ecadSAnthony Wilson { 91795a3ecadSAnthony Wilson // Set MemberId and Name for non-power sensors. For PowerSupplies and 91895a3ecadSAnthony Wilson // PowerControl, those properties have more general values because 91995a3ecadSAnthony Wilson // multiple sensors can be stored in the same JSON object. 92081ce609eSEd Tanous sensorJson["MemberId"] = sensorName; 92181ce609eSEd Tanous sensorJson["Name"] = boost::replace_all_copy(sensorName, "_", " "); 922adc4f0dbSShawn McCarney } 923e742b6ccSEd Tanous 92481ce609eSEd Tanous sensorJson["Status"]["State"] = getState(inventoryItem); 92581ce609eSEd Tanous sensorJson["Status"]["Health"] = 92681ce609eSEd Tanous getHealth(sensorJson, interfacesDict, inventoryItem); 92708777fb0SLewanczyk, Dawid 92808777fb0SLewanczyk, Dawid // Parameter to set to override the type we get from dbus, and force it to 92908777fb0SLewanczyk, Dawid // int, regardless of what is available. This is used for schemas like fan, 93008777fb0SLewanczyk, Dawid // that require integers, not floats. 93108777fb0SLewanczyk, Dawid bool forceToInt = false; 93208777fb0SLewanczyk, Dawid 9333929aca1SAnthony Wilson nlohmann::json::json_pointer unit("/Reading"); 934a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 93595a3ecadSAnthony Wilson { 93681ce609eSEd Tanous sensorJson["@odata.type"] = "#Sensor.v1_0_0.Sensor"; 937c2bf7f99SWludzik, Jozef 938c2bf7f99SWludzik, Jozef const std::string& readingType = sensors::toReadingType(sensorType); 939c2bf7f99SWludzik, Jozef if (readingType.empty()) 94095a3ecadSAnthony Wilson { 941c2bf7f99SWludzik, Jozef BMCWEB_LOG_ERROR << "Redfish cannot map reading type for " 942c2bf7f99SWludzik, Jozef << sensorType; 94395a3ecadSAnthony Wilson } 944c2bf7f99SWludzik, Jozef else 94595a3ecadSAnthony Wilson { 946c2bf7f99SWludzik, Jozef sensorJson["ReadingType"] = readingType; 94795a3ecadSAnthony Wilson } 948c2bf7f99SWludzik, Jozef 949c2bf7f99SWludzik, Jozef const std::string& readingUnits = sensors::toReadingUnits(sensorType); 950c2bf7f99SWludzik, Jozef if (readingUnits.empty()) 951f8ede15eSAdrian Ambrożewicz { 952c2bf7f99SWludzik, Jozef BMCWEB_LOG_ERROR << "Redfish cannot map reading unit for " 953c2bf7f99SWludzik, Jozef << sensorType; 954c2bf7f99SWludzik, Jozef } 955c2bf7f99SWludzik, Jozef else 956c2bf7f99SWludzik, Jozef { 957c2bf7f99SWludzik, Jozef sensorJson["ReadingUnits"] = readingUnits; 958f8ede15eSAdrian Ambrożewicz } 95995a3ecadSAnthony Wilson } 96095a3ecadSAnthony Wilson else if (sensorType == "temperature") 9611abe55efSEd Tanous { 9623929aca1SAnthony Wilson unit = "/ReadingCelsius"_json_pointer; 96381ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature"; 96408777fb0SLewanczyk, Dawid // TODO(ed) Documentation says that path should be type fan_tach, 96508777fb0SLewanczyk, Dawid // implementation seems to implement fan 9661abe55efSEd Tanous } 9671abe55efSEd Tanous else if (sensorType == "fan" || sensorType == "fan_tach") 9681abe55efSEd Tanous { 9693929aca1SAnthony Wilson unit = "/Reading"_json_pointer; 97081ce609eSEd Tanous sensorJson["ReadingUnits"] = "RPM"; 97181ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan"; 97281ce609eSEd Tanous setLedState(sensorJson, inventoryItem); 97308777fb0SLewanczyk, Dawid forceToInt = true; 9741abe55efSEd Tanous } 9756f6d0d32SEd Tanous else if (sensorType == "fan_pwm") 9766f6d0d32SEd Tanous { 9773929aca1SAnthony Wilson unit = "/Reading"_json_pointer; 97881ce609eSEd Tanous sensorJson["ReadingUnits"] = "Percent"; 97981ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan"; 98081ce609eSEd Tanous setLedState(sensorJson, inventoryItem); 9816f6d0d32SEd Tanous forceToInt = true; 9826f6d0d32SEd Tanous } 9831abe55efSEd Tanous else if (sensorType == "voltage") 9841abe55efSEd Tanous { 9853929aca1SAnthony Wilson unit = "/ReadingVolts"_json_pointer; 98681ce609eSEd Tanous sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage"; 9871abe55efSEd Tanous } 9882474adfaSEd Tanous else if (sensorType == "power") 9892474adfaSEd Tanous { 99049c53ac9SJohnathan Mantey std::string sensorNameLower = 99149c53ac9SJohnathan Mantey boost::algorithm::to_lower_copy(sensorName); 99249c53ac9SJohnathan Mantey 993028f7ebcSEddie James if (!sensorName.compare("total_power")) 994028f7ebcSEddie James { 99581ce609eSEd Tanous sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl"; 9967ab06f49SGunnar Mills // Put multiple "sensors" into a single PowerControl, so have 9977ab06f49SGunnar Mills // generic names for MemberId and Name. Follows Redfish mockup. 99881ce609eSEd Tanous sensorJson["MemberId"] = "0"; 99981ce609eSEd Tanous sensorJson["Name"] = "Chassis Power Control"; 10003929aca1SAnthony Wilson unit = "/PowerConsumedWatts"_json_pointer; 1001028f7ebcSEddie James } 1002028f7ebcSEddie James else if (sensorNameLower.find("input") != std::string::npos) 100349c53ac9SJohnathan Mantey { 10043929aca1SAnthony Wilson unit = "/PowerInputWatts"_json_pointer; 100549c53ac9SJohnathan Mantey } 100649c53ac9SJohnathan Mantey else 100749c53ac9SJohnathan Mantey { 10083929aca1SAnthony Wilson unit = "/PowerOutputWatts"_json_pointer; 100949c53ac9SJohnathan Mantey } 10102474adfaSEd Tanous } 10111abe55efSEd Tanous else 10121abe55efSEd Tanous { 101355c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "Redfish cannot map object type for " << sensorName; 101408777fb0SLewanczyk, Dawid return; 101508777fb0SLewanczyk, Dawid } 101608777fb0SLewanczyk, Dawid // Map of dbus interface name, dbus property name and redfish property_name 10173929aca1SAnthony Wilson std::vector< 10183929aca1SAnthony Wilson std::tuple<const char*, const char*, nlohmann::json::json_pointer>> 10193929aca1SAnthony Wilson properties; 102008777fb0SLewanczyk, Dawid properties.reserve(7); 102108777fb0SLewanczyk, Dawid 102208777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit); 1023de629b6eSShawn McCarney 1024a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 10253929aca1SAnthony Wilson { 10263929aca1SAnthony Wilson properties.emplace_back( 10273929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh", 10283929aca1SAnthony Wilson "/Thresholds/UpperCaution/Reading"_json_pointer); 10293929aca1SAnthony Wilson properties.emplace_back( 10303929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow", 10313929aca1SAnthony Wilson "/Thresholds/LowerCaution/Reading"_json_pointer); 10323929aca1SAnthony Wilson properties.emplace_back( 10333929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh", 10343929aca1SAnthony Wilson "/Thresholds/UpperCritical/Reading"_json_pointer); 10353929aca1SAnthony Wilson properties.emplace_back( 10363929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow", 10373929aca1SAnthony Wilson "/Thresholds/LowerCritical/Reading"_json_pointer); 10383929aca1SAnthony Wilson } 10393929aca1SAnthony Wilson else if (sensorType != "power") 1040de629b6eSShawn McCarney { 104108777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning", 10423929aca1SAnthony Wilson "WarningHigh", 10433929aca1SAnthony Wilson "/UpperThresholdNonCritical"_json_pointer); 104408777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning", 10453929aca1SAnthony Wilson "WarningLow", 10463929aca1SAnthony Wilson "/LowerThresholdNonCritical"_json_pointer); 104708777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical", 10483929aca1SAnthony Wilson "CriticalHigh", 10493929aca1SAnthony Wilson "/UpperThresholdCritical"_json_pointer); 105008777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical", 10513929aca1SAnthony Wilson "CriticalLow", 10523929aca1SAnthony Wilson "/LowerThresholdCritical"_json_pointer); 1053de629b6eSShawn McCarney } 105408777fb0SLewanczyk, Dawid 10552474adfaSEd Tanous // TODO Need to get UpperThresholdFatal and LowerThresholdFatal 10562474adfaSEd Tanous 1057a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors) 105895a3ecadSAnthony Wilson { 105995a3ecadSAnthony Wilson properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10603929aca1SAnthony Wilson "/ReadingRangeMin"_json_pointer); 106195a3ecadSAnthony Wilson properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10623929aca1SAnthony Wilson "/ReadingRangeMax"_json_pointer); 106395a3ecadSAnthony Wilson } 106495a3ecadSAnthony Wilson else if (sensorType == "temperature") 10651abe55efSEd Tanous { 106608777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10673929aca1SAnthony Wilson "/MinReadingRangeTemp"_json_pointer); 106808777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10693929aca1SAnthony Wilson "/MaxReadingRangeTemp"_json_pointer); 10701abe55efSEd Tanous } 1071adc4f0dbSShawn McCarney else if (sensorType != "power") 10721abe55efSEd Tanous { 107308777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 10743929aca1SAnthony Wilson "/MinReadingRange"_json_pointer); 107508777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 10763929aca1SAnthony Wilson "/MaxReadingRange"_json_pointer); 107708777fb0SLewanczyk, Dawid } 107808777fb0SLewanczyk, Dawid 10793929aca1SAnthony Wilson for (const std::tuple<const char*, const char*, 10803929aca1SAnthony Wilson nlohmann::json::json_pointer>& p : properties) 10811abe55efSEd Tanous { 108208777fb0SLewanczyk, Dawid auto interfaceProperties = interfacesDict.find(std::get<0>(p)); 10831abe55efSEd Tanous if (interfaceProperties != interfacesDict.end()) 10841abe55efSEd Tanous { 1085271584abSEd Tanous auto thisValueIt = interfaceProperties->second.find(std::get<1>(p)); 1086271584abSEd Tanous if (thisValueIt != interfaceProperties->second.end()) 10871abe55efSEd Tanous { 1088168e20c1SEd Tanous const dbus::utility::DbusVariantType& valueVariant = 1089168e20c1SEd Tanous thisValueIt->second; 10903929aca1SAnthony Wilson 10913929aca1SAnthony Wilson // The property we want to set may be nested json, so use 10923929aca1SAnthony Wilson // a json_pointer for easy indexing into the json structure. 10933929aca1SAnthony Wilson const nlohmann::json::json_pointer& key = std::get<2>(p); 10943929aca1SAnthony Wilson 109508777fb0SLewanczyk, Dawid // Attempt to pull the int64 directly 1096abf2add6SEd Tanous const int64_t* int64Value = std::get_if<int64_t>(&valueVariant); 109708777fb0SLewanczyk, Dawid 1098abf2add6SEd Tanous const double* doubleValue = std::get_if<double>(&valueVariant); 1099028f7ebcSEddie James const uint32_t* uValue = std::get_if<uint32_t>(&valueVariant); 11006f6d0d32SEd Tanous double temp = 0.0; 11016f6d0d32SEd Tanous if (int64Value != nullptr) 11021abe55efSEd Tanous { 1103271584abSEd Tanous temp = static_cast<double>(*int64Value); 11046f6d0d32SEd Tanous } 11056f6d0d32SEd Tanous else if (doubleValue != nullptr) 11061abe55efSEd Tanous { 11076f6d0d32SEd Tanous temp = *doubleValue; 11081abe55efSEd Tanous } 1109028f7ebcSEddie James else if (uValue != nullptr) 1110028f7ebcSEddie James { 1111028f7ebcSEddie James temp = *uValue; 1112028f7ebcSEddie James } 11131abe55efSEd Tanous else 11141abe55efSEd Tanous { 11156f6d0d32SEd Tanous BMCWEB_LOG_ERROR 11166f6d0d32SEd Tanous << "Got value interface that wasn't int or double"; 11176f6d0d32SEd Tanous continue; 111808777fb0SLewanczyk, Dawid } 11196f6d0d32SEd Tanous temp = temp * std::pow(10, scaleMultiplier); 11206f6d0d32SEd Tanous if (forceToInt) 11216f6d0d32SEd Tanous { 112281ce609eSEd Tanous sensorJson[key] = static_cast<int64_t>(temp); 11236f6d0d32SEd Tanous } 11246f6d0d32SEd Tanous else 11256f6d0d32SEd Tanous { 112681ce609eSEd Tanous sensorJson[key] = temp; 112708777fb0SLewanczyk, Dawid } 112808777fb0SLewanczyk, Dawid } 112908777fb0SLewanczyk, Dawid } 113008777fb0SLewanczyk, Dawid } 1131a0ec28b6SAdrian Ambrożewicz 113281ce609eSEd Tanous sensorsAsyncResp->addMetadata(sensorJson, unit.to_string(), 1133a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/" + sensorType + 1134a0ec28b6SAdrian Ambrożewicz "/" + sensorName); 1135a0ec28b6SAdrian Ambrożewicz 113655c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Added sensor " << sensorName; 113708777fb0SLewanczyk, Dawid } 113808777fb0SLewanczyk, Dawid 1139b5a76932SEd Tanous inline void populateFanRedundancy( 1140b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 11418bd25ccdSJames Feist { 11428bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 11438bd25ccdSJames Feist [sensorsAsyncResp](const boost::system::error_code ec, 11448bd25ccdSJames Feist const GetSubTreeType& resp) { 11458bd25ccdSJames Feist if (ec) 11468bd25ccdSJames Feist { 11478bd25ccdSJames Feist return; // don't have to have this interface 11488bd25ccdSJames Feist } 1149e278c18fSEd Tanous for (const std::pair<std::string, 1150e278c18fSEd Tanous std::vector<std::pair< 1151e278c18fSEd Tanous std::string, std::vector<std::string>>>>& 1152e278c18fSEd Tanous pathPair : resp) 11538bd25ccdSJames Feist { 1154e278c18fSEd Tanous const std::string& path = pathPair.first; 1155e278c18fSEd Tanous const std::vector< 1156e278c18fSEd Tanous std::pair<std::string, std::vector<std::string>>>& objDict = 1157e278c18fSEd Tanous pathPair.second; 11588bd25ccdSJames Feist if (objDict.empty()) 11598bd25ccdSJames Feist { 11608bd25ccdSJames Feist continue; // this should be impossible 11618bd25ccdSJames Feist } 11628bd25ccdSJames Feist 11638bd25ccdSJames Feist const std::string& owner = objDict.begin()->first; 1164*1e1e598dSJonathan Doman sdbusplus::asio::getProperty<std::vector<std::string>>( 1165*1e1e598dSJonathan Doman *crow::connections::systemBus, 1166*1e1e598dSJonathan Doman "xyz.openbmc_project.ObjectMapper", path + "/chassis", 1167*1e1e598dSJonathan Doman "xyz.openbmc_project.Association", "endpoints", 1168*1e1e598dSJonathan Doman [path, owner, sensorsAsyncResp]( 1169*1e1e598dSJonathan Doman const boost::system::error_code e, 1170*1e1e598dSJonathan Doman const std::vector<std::string>& endpoints) { 1171271584abSEd Tanous if (e) 11728bd25ccdSJames Feist { 11738bd25ccdSJames Feist return; // if they don't have an association we 11748bd25ccdSJames Feist // can't tell what chassis is 11758bd25ccdSJames Feist } 11768bd25ccdSJames Feist auto found = std::find_if( 1177*1e1e598dSJonathan Doman endpoints.begin(), endpoints.end(), 11788bd25ccdSJames Feist [sensorsAsyncResp](const std::string& entry) { 11798bd25ccdSJames Feist return entry.find( 11808bd25ccdSJames Feist sensorsAsyncResp->chassisId) != 11818bd25ccdSJames Feist std::string::npos; 11828bd25ccdSJames Feist }); 11838bd25ccdSJames Feist 1184*1e1e598dSJonathan Doman if (found == endpoints.end()) 11858bd25ccdSJames Feist { 11868bd25ccdSJames Feist return; 11878bd25ccdSJames Feist } 11888bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 11898bd25ccdSJames Feist [path, sensorsAsyncResp]( 1190271584abSEd Tanous const boost::system::error_code& err, 11918bd25ccdSJames Feist const boost::container::flat_map< 11928bd25ccdSJames Feist std::string, 1193168e20c1SEd Tanous dbus::utility::DbusVariantType>& ret) { 1194271584abSEd Tanous if (err) 11958bd25ccdSJames Feist { 11968bd25ccdSJames Feist return; // don't have to have this 11978bd25ccdSJames Feist // interface 11988bd25ccdSJames Feist } 11998bd25ccdSJames Feist auto findFailures = ret.find("AllowedFailures"); 12008bd25ccdSJames Feist auto findCollection = ret.find("Collection"); 12018bd25ccdSJames Feist auto findStatus = ret.find("Status"); 12028bd25ccdSJames Feist 12038bd25ccdSJames Feist if (findFailures == ret.end() || 12048bd25ccdSJames Feist findCollection == ret.end() || 12058bd25ccdSJames Feist findStatus == ret.end()) 12068bd25ccdSJames Feist { 12078bd25ccdSJames Feist BMCWEB_LOG_ERROR 12088bd25ccdSJames Feist << "Invalid redundancy interface"; 12098bd25ccdSJames Feist messages::internalError( 12108d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12118bd25ccdSJames Feist return; 12128bd25ccdSJames Feist } 12138bd25ccdSJames Feist 12148bd25ccdSJames Feist auto allowedFailures = std::get_if<uint8_t>( 12158bd25ccdSJames Feist &(findFailures->second)); 12168bd25ccdSJames Feist auto collection = 12178bd25ccdSJames Feist std::get_if<std::vector<std::string>>( 12188bd25ccdSJames Feist &(findCollection->second)); 12198bd25ccdSJames Feist auto status = std::get_if<std::string>( 12208bd25ccdSJames Feist &(findStatus->second)); 12218bd25ccdSJames Feist 12228bd25ccdSJames Feist if (allowedFailures == nullptr || 12238bd25ccdSJames Feist collection == nullptr || status == nullptr) 12248bd25ccdSJames Feist { 12258bd25ccdSJames Feist 12268bd25ccdSJames Feist BMCWEB_LOG_ERROR 12270fda0f12SGeorge Liu << "Invalid redundancy interface types"; 12288bd25ccdSJames Feist messages::internalError( 12298d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12308bd25ccdSJames Feist return; 12318bd25ccdSJames Feist } 123228aa8de5SGeorge Liu sdbusplus::message::object_path objectPath( 123328aa8de5SGeorge Liu path); 123428aa8de5SGeorge Liu std::string name = objectPath.filename(); 123528aa8de5SGeorge Liu if (name.empty()) 12368bd25ccdSJames Feist { 12378bd25ccdSJames Feist // this should be impossible 12388bd25ccdSJames Feist messages::internalError( 12398d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12408bd25ccdSJames Feist return; 12418bd25ccdSJames Feist } 12428bd25ccdSJames Feist std::replace(name.begin(), name.end(), '_', 12438bd25ccdSJames Feist ' '); 12448bd25ccdSJames Feist 12458bd25ccdSJames Feist std::string health; 12468bd25ccdSJames Feist 12478bd25ccdSJames Feist if (boost::ends_with(*status, "Full")) 12488bd25ccdSJames Feist { 12498bd25ccdSJames Feist health = "OK"; 12508bd25ccdSJames Feist } 12518bd25ccdSJames Feist else if (boost::ends_with(*status, "Degraded")) 12528bd25ccdSJames Feist { 12538bd25ccdSJames Feist health = "Warning"; 12548bd25ccdSJames Feist } 12558bd25ccdSJames Feist else 12568bd25ccdSJames Feist { 12578bd25ccdSJames Feist health = "Critical"; 12588bd25ccdSJames Feist } 12598bd25ccdSJames Feist std::vector<nlohmann::json> redfishCollection; 12608bd25ccdSJames Feist const auto& fanRedfish = 12618d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res 12628d1b46d7Szhanghch05 .jsonValue["Fans"]; 12638bd25ccdSJames Feist for (const std::string& item : *collection) 12648bd25ccdSJames Feist { 126528aa8de5SGeorge Liu sdbusplus::message::object_path path(item); 126628aa8de5SGeorge Liu std::string itemName = path.filename(); 126728aa8de5SGeorge Liu if (itemName.empty()) 126828aa8de5SGeorge Liu { 126928aa8de5SGeorge Liu continue; 127028aa8de5SGeorge Liu } 12718bd25ccdSJames Feist /* 12728bd25ccdSJames Feist todo(ed): merge patch that fixes the names 12738bd25ccdSJames Feist std::replace(itemName.begin(), 12748bd25ccdSJames Feist itemName.end(), '_', ' ');*/ 12758bd25ccdSJames Feist auto schemaItem = std::find_if( 12768bd25ccdSJames Feist fanRedfish.begin(), fanRedfish.end(), 12778bd25ccdSJames Feist [itemName](const nlohmann::json& fan) { 12788bd25ccdSJames Feist return fan["MemberId"] == itemName; 12798bd25ccdSJames Feist }); 12808bd25ccdSJames Feist if (schemaItem != fanRedfish.end()) 12818bd25ccdSJames Feist { 12828bd25ccdSJames Feist redfishCollection.push_back( 12838bd25ccdSJames Feist {{"@odata.id", 12848bd25ccdSJames Feist (*schemaItem)["@odata.id"]}}); 12858bd25ccdSJames Feist } 12868bd25ccdSJames Feist else 12878bd25ccdSJames Feist { 12888bd25ccdSJames Feist BMCWEB_LOG_ERROR 12898bd25ccdSJames Feist << "failed to find fan in schema"; 12908bd25ccdSJames Feist messages::internalError( 12918d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12928bd25ccdSJames Feist return; 12938bd25ccdSJames Feist } 12948bd25ccdSJames Feist } 12958bd25ccdSJames Feist 12963e9e72ebSKuiying Wang size_t minNumNeeded = 12973e9e72ebSKuiying Wang collection->size() > 0 12983e9e72ebSKuiying Wang ? collection->size() - *allowedFailures 12993e9e72ebSKuiying Wang : 0; 1300271584abSEd Tanous nlohmann::json& jResp = 13018d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res 13028bd25ccdSJames Feist .jsonValue["Redundancy"]; 1303271584abSEd Tanous jResp.push_back( 13048bd25ccdSJames Feist {{"@odata.id", 1305717794d5SAppaRao Puli "/redfish/v1/Chassis/" + 13068bd25ccdSJames Feist sensorsAsyncResp->chassisId + "/" + 13078bd25ccdSJames Feist sensorsAsyncResp->chassisSubNode + 13088bd25ccdSJames Feist "#/Redundancy/" + 1309271584abSEd Tanous std::to_string(jResp.size())}, 13108bd25ccdSJames Feist {"@odata.type", 13118bd25ccdSJames Feist "#Redundancy.v1_3_2.Redundancy"}, 13123e9e72ebSKuiying Wang {"MinNumNeeded", minNumNeeded}, 13138bd25ccdSJames Feist {"MemberId", name}, 13148bd25ccdSJames Feist {"Mode", "N+m"}, 13158bd25ccdSJames Feist {"Name", name}, 13168bd25ccdSJames Feist {"RedundancySet", redfishCollection}, 13178bd25ccdSJames Feist {"Status", 13188bd25ccdSJames Feist {{"Health", health}, 13198bd25ccdSJames Feist {"State", "Enabled"}}}}); 13208bd25ccdSJames Feist }, 13218bd25ccdSJames Feist owner, path, "org.freedesktop.DBus.Properties", 13228bd25ccdSJames Feist "GetAll", 13238bd25ccdSJames Feist "xyz.openbmc_project.Control.FanRedundancy"); 1324*1e1e598dSJonathan Doman }); 13258bd25ccdSJames Feist } 13268bd25ccdSJames Feist }, 13278bd25ccdSJames Feist "xyz.openbmc_project.ObjectMapper", 13288bd25ccdSJames Feist "/xyz/openbmc_project/object_mapper", 13298bd25ccdSJames Feist "xyz.openbmc_project.ObjectMapper", "GetSubTree", 13308bd25ccdSJames Feist "/xyz/openbmc_project/control", 2, 13318bd25ccdSJames Feist std::array<const char*, 1>{ 13328bd25ccdSJames Feist "xyz.openbmc_project.Control.FanRedundancy"}); 13338bd25ccdSJames Feist } 13348bd25ccdSJames Feist 1335b5a76932SEd Tanous inline void 133681ce609eSEd Tanous sortJSONResponse(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 133749c53ac9SJohnathan Mantey { 13388d1b46d7Szhanghch05 nlohmann::json& response = sensorsAsyncResp->asyncResp->res.jsonValue; 133949c53ac9SJohnathan Mantey std::array<std::string, 2> sensorHeaders{"Temperatures", "Fans"}; 134081ce609eSEd Tanous if (sensorsAsyncResp->chassisSubNode == sensors::node::power) 134149c53ac9SJohnathan Mantey { 134249c53ac9SJohnathan Mantey sensorHeaders = {"Voltages", "PowerSupplies"}; 134349c53ac9SJohnathan Mantey } 134449c53ac9SJohnathan Mantey for (const std::string& sensorGroup : sensorHeaders) 134549c53ac9SJohnathan Mantey { 134649c53ac9SJohnathan Mantey nlohmann::json::iterator entry = response.find(sensorGroup); 134749c53ac9SJohnathan Mantey if (entry != response.end()) 134849c53ac9SJohnathan Mantey { 134949c53ac9SJohnathan Mantey std::sort(entry->begin(), entry->end(), 135049c53ac9SJohnathan Mantey [](nlohmann::json& c1, nlohmann::json& c2) { 135149c53ac9SJohnathan Mantey return c1["Name"] < c2["Name"]; 135249c53ac9SJohnathan Mantey }); 135349c53ac9SJohnathan Mantey 135449c53ac9SJohnathan Mantey // add the index counts to the end of each entry 135549c53ac9SJohnathan Mantey size_t count = 0; 135649c53ac9SJohnathan Mantey for (nlohmann::json& sensorJson : *entry) 135749c53ac9SJohnathan Mantey { 135849c53ac9SJohnathan Mantey nlohmann::json::iterator odata = sensorJson.find("@odata.id"); 135949c53ac9SJohnathan Mantey if (odata == sensorJson.end()) 136049c53ac9SJohnathan Mantey { 136149c53ac9SJohnathan Mantey continue; 136249c53ac9SJohnathan Mantey } 136349c53ac9SJohnathan Mantey std::string* value = odata->get_ptr<std::string*>(); 136449c53ac9SJohnathan Mantey if (value != nullptr) 136549c53ac9SJohnathan Mantey { 136649c53ac9SJohnathan Mantey *value += std::to_string(count); 136749c53ac9SJohnathan Mantey count++; 136881ce609eSEd Tanous sensorsAsyncResp->updateUri(sensorJson["Name"], *value); 136949c53ac9SJohnathan Mantey } 137049c53ac9SJohnathan Mantey } 137149c53ac9SJohnathan Mantey } 137249c53ac9SJohnathan Mantey } 137349c53ac9SJohnathan Mantey } 137449c53ac9SJohnathan Mantey 137508777fb0SLewanczyk, Dawid /** 1376adc4f0dbSShawn McCarney * @brief Finds the inventory item with the specified object path. 1377adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1378adc4f0dbSShawn McCarney * @param invItemObjPath D-Bus object path of inventory item. 1379adc4f0dbSShawn McCarney * @return Inventory item within vector, or nullptr if no match found. 13808fb49dd6SShawn McCarney */ 138123a21a1cSEd Tanous inline InventoryItem* findInventoryItem( 1382b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1383adc4f0dbSShawn McCarney const std::string& invItemObjPath) 13848fb49dd6SShawn McCarney { 1385adc4f0dbSShawn McCarney for (InventoryItem& inventoryItem : *inventoryItems) 13868fb49dd6SShawn McCarney { 1387adc4f0dbSShawn McCarney if (inventoryItem.objectPath == invItemObjPath) 13888fb49dd6SShawn McCarney { 1389adc4f0dbSShawn McCarney return &inventoryItem; 13908fb49dd6SShawn McCarney } 13918fb49dd6SShawn McCarney } 13928fb49dd6SShawn McCarney return nullptr; 13938fb49dd6SShawn McCarney } 13948fb49dd6SShawn McCarney 13958fb49dd6SShawn McCarney /** 1396adc4f0dbSShawn McCarney * @brief Finds the inventory item associated with the specified sensor. 1397adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1398adc4f0dbSShawn McCarney * @param sensorObjPath D-Bus object path of sensor. 1399adc4f0dbSShawn McCarney * @return Inventory item within vector, or nullptr if no match found. 14008fb49dd6SShawn McCarney */ 140123a21a1cSEd Tanous inline InventoryItem* findInventoryItemForSensor( 1402b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1403adc4f0dbSShawn McCarney const std::string& sensorObjPath) 1404adc4f0dbSShawn McCarney { 1405adc4f0dbSShawn McCarney for (InventoryItem& inventoryItem : *inventoryItems) 1406adc4f0dbSShawn McCarney { 1407adc4f0dbSShawn McCarney if (inventoryItem.sensors.count(sensorObjPath) > 0) 1408adc4f0dbSShawn McCarney { 1409adc4f0dbSShawn McCarney return &inventoryItem; 1410adc4f0dbSShawn McCarney } 1411adc4f0dbSShawn McCarney } 1412adc4f0dbSShawn McCarney return nullptr; 1413adc4f0dbSShawn McCarney } 1414adc4f0dbSShawn McCarney 1415adc4f0dbSShawn McCarney /** 1416d500549bSAnthony Wilson * @brief Finds the inventory item associated with the specified led path. 1417d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1418d500549bSAnthony Wilson * @param ledObjPath D-Bus object path of led. 1419d500549bSAnthony Wilson * @return Inventory item within vector, or nullptr if no match found. 1420d500549bSAnthony Wilson */ 1421d500549bSAnthony Wilson inline InventoryItem* 1422d500549bSAnthony Wilson findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems, 1423d500549bSAnthony Wilson const std::string& ledObjPath) 1424d500549bSAnthony Wilson { 1425d500549bSAnthony Wilson for (InventoryItem& inventoryItem : inventoryItems) 1426d500549bSAnthony Wilson { 1427d500549bSAnthony Wilson if (inventoryItem.ledObjectPath == ledObjPath) 1428d500549bSAnthony Wilson { 1429d500549bSAnthony Wilson return &inventoryItem; 1430d500549bSAnthony Wilson } 1431d500549bSAnthony Wilson } 1432d500549bSAnthony Wilson return nullptr; 1433d500549bSAnthony Wilson } 1434d500549bSAnthony Wilson 1435d500549bSAnthony Wilson /** 1436adc4f0dbSShawn McCarney * @brief Adds inventory item and associated sensor to specified vector. 1437adc4f0dbSShawn McCarney * 1438adc4f0dbSShawn McCarney * Adds a new InventoryItem to the vector if necessary. Searches for an 1439adc4f0dbSShawn McCarney * existing InventoryItem with the specified object path. If not found, one is 1440adc4f0dbSShawn McCarney * added to the vector. 1441adc4f0dbSShawn McCarney * 1442adc4f0dbSShawn McCarney * Next, the specified sensor is added to the set of sensors associated with the 1443adc4f0dbSShawn McCarney * InventoryItem. 1444adc4f0dbSShawn McCarney * 1445adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1446adc4f0dbSShawn McCarney * @param invItemObjPath D-Bus object path of inventory item. 1447adc4f0dbSShawn McCarney * @param sensorObjPath D-Bus object path of sensor 1448adc4f0dbSShawn McCarney */ 1449b5a76932SEd Tanous inline void addInventoryItem( 1450b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1451b5a76932SEd Tanous const std::string& invItemObjPath, const std::string& sensorObjPath) 1452adc4f0dbSShawn McCarney { 1453adc4f0dbSShawn McCarney // Look for inventory item in vector 1454adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 1455adc4f0dbSShawn McCarney findInventoryItem(inventoryItems, invItemObjPath); 1456adc4f0dbSShawn McCarney 1457adc4f0dbSShawn McCarney // If inventory item doesn't exist in vector, add it 1458adc4f0dbSShawn McCarney if (inventoryItem == nullptr) 1459adc4f0dbSShawn McCarney { 1460adc4f0dbSShawn McCarney inventoryItems->emplace_back(invItemObjPath); 1461adc4f0dbSShawn McCarney inventoryItem = &(inventoryItems->back()); 1462adc4f0dbSShawn McCarney } 1463adc4f0dbSShawn McCarney 1464adc4f0dbSShawn McCarney // Add sensor to set of sensors associated with inventory item 1465adc4f0dbSShawn McCarney inventoryItem->sensors.emplace(sensorObjPath); 1466adc4f0dbSShawn McCarney } 1467adc4f0dbSShawn McCarney 1468adc4f0dbSShawn McCarney /** 1469adc4f0dbSShawn McCarney * @brief Stores D-Bus data in the specified inventory item. 1470adc4f0dbSShawn McCarney * 1471adc4f0dbSShawn McCarney * Finds D-Bus data in the specified map of interfaces. Stores the data in the 1472adc4f0dbSShawn McCarney * specified InventoryItem. 1473adc4f0dbSShawn McCarney * 1474adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 1475adc4f0dbSShawn McCarney * response. 1476adc4f0dbSShawn McCarney * 1477adc4f0dbSShawn McCarney * @param inventoryItem Inventory item where data will be stored. 1478adc4f0dbSShawn McCarney * @param interfacesDict Map containing D-Bus interfaces and their properties 1479adc4f0dbSShawn McCarney * for the specified inventory item. 1480adc4f0dbSShawn McCarney */ 148123a21a1cSEd Tanous inline void storeInventoryItemData( 1482adc4f0dbSShawn McCarney InventoryItem& inventoryItem, 14838fb49dd6SShawn McCarney const boost::container::flat_map< 1484168e20c1SEd Tanous std::string, boost::container::flat_map< 1485168e20c1SEd Tanous std::string, dbus::utility::DbusVariantType>>& 14868fb49dd6SShawn McCarney interfacesDict) 14878fb49dd6SShawn McCarney { 1488adc4f0dbSShawn McCarney // Get properties from Inventory.Item interface 1489adc4f0dbSShawn McCarney auto interfaceIt = 1490adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Item"); 1491adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 14928fb49dd6SShawn McCarney { 1493adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Present"); 1494adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 14958fb49dd6SShawn McCarney { 1496adc4f0dbSShawn McCarney const bool* value = std::get_if<bool>(&propertyIt->second); 1497adc4f0dbSShawn McCarney if (value != nullptr) 14988fb49dd6SShawn McCarney { 1499adc4f0dbSShawn McCarney inventoryItem.isPresent = *value; 15008fb49dd6SShawn McCarney } 15018fb49dd6SShawn McCarney } 15028fb49dd6SShawn McCarney } 15038fb49dd6SShawn McCarney 1504adc4f0dbSShawn McCarney // Check if Inventory.Item.PowerSupply interface is present 1505adc4f0dbSShawn McCarney interfaceIt = 1506adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Item.PowerSupply"); 1507adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 15088fb49dd6SShawn McCarney { 1509adc4f0dbSShawn McCarney inventoryItem.isPowerSupply = true; 15108fb49dd6SShawn McCarney } 1511adc4f0dbSShawn McCarney 1512adc4f0dbSShawn McCarney // Get properties from Inventory.Decorator.Asset interface 1513adc4f0dbSShawn McCarney interfaceIt = 1514adc4f0dbSShawn McCarney interfacesDict.find("xyz.openbmc_project.Inventory.Decorator.Asset"); 1515adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 1516adc4f0dbSShawn McCarney { 1517adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Manufacturer"); 1518adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1519adc4f0dbSShawn McCarney { 1520adc4f0dbSShawn McCarney const std::string* value = 1521adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1522adc4f0dbSShawn McCarney if (value != nullptr) 1523adc4f0dbSShawn McCarney { 1524adc4f0dbSShawn McCarney inventoryItem.manufacturer = *value; 1525adc4f0dbSShawn McCarney } 1526adc4f0dbSShawn McCarney } 1527adc4f0dbSShawn McCarney 1528adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("Model"); 1529adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1530adc4f0dbSShawn McCarney { 1531adc4f0dbSShawn McCarney const std::string* value = 1532adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1533adc4f0dbSShawn McCarney if (value != nullptr) 1534adc4f0dbSShawn McCarney { 1535adc4f0dbSShawn McCarney inventoryItem.model = *value; 1536adc4f0dbSShawn McCarney } 1537adc4f0dbSShawn McCarney } 1538adc4f0dbSShawn McCarney 1539adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("PartNumber"); 1540adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1541adc4f0dbSShawn McCarney { 1542adc4f0dbSShawn McCarney const std::string* value = 1543adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1544adc4f0dbSShawn McCarney if (value != nullptr) 1545adc4f0dbSShawn McCarney { 1546adc4f0dbSShawn McCarney inventoryItem.partNumber = *value; 1547adc4f0dbSShawn McCarney } 1548adc4f0dbSShawn McCarney } 1549adc4f0dbSShawn McCarney 1550adc4f0dbSShawn McCarney propertyIt = interfaceIt->second.find("SerialNumber"); 1551adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1552adc4f0dbSShawn McCarney { 1553adc4f0dbSShawn McCarney const std::string* value = 1554adc4f0dbSShawn McCarney std::get_if<std::string>(&propertyIt->second); 1555adc4f0dbSShawn McCarney if (value != nullptr) 1556adc4f0dbSShawn McCarney { 1557adc4f0dbSShawn McCarney inventoryItem.serialNumber = *value; 1558adc4f0dbSShawn McCarney } 1559adc4f0dbSShawn McCarney } 1560adc4f0dbSShawn McCarney } 1561adc4f0dbSShawn McCarney 1562adc4f0dbSShawn McCarney // Get properties from State.Decorator.OperationalStatus interface 1563adc4f0dbSShawn McCarney interfaceIt = interfacesDict.find( 1564adc4f0dbSShawn McCarney "xyz.openbmc_project.State.Decorator.OperationalStatus"); 1565adc4f0dbSShawn McCarney if (interfaceIt != interfacesDict.end()) 1566adc4f0dbSShawn McCarney { 1567adc4f0dbSShawn McCarney auto propertyIt = interfaceIt->second.find("Functional"); 1568adc4f0dbSShawn McCarney if (propertyIt != interfaceIt->second.end()) 1569adc4f0dbSShawn McCarney { 1570adc4f0dbSShawn McCarney const bool* value = std::get_if<bool>(&propertyIt->second); 1571adc4f0dbSShawn McCarney if (value != nullptr) 1572adc4f0dbSShawn McCarney { 1573adc4f0dbSShawn McCarney inventoryItem.isFunctional = *value; 15748fb49dd6SShawn McCarney } 15758fb49dd6SShawn McCarney } 15768fb49dd6SShawn McCarney } 15778fb49dd6SShawn McCarney } 15788fb49dd6SShawn McCarney 15798fb49dd6SShawn McCarney /** 1580adc4f0dbSShawn McCarney * @brief Gets D-Bus data for inventory items associated with sensors. 15818fb49dd6SShawn McCarney * 1582adc4f0dbSShawn McCarney * Uses the specified connections (services) to obtain D-Bus data for inventory 1583adc4f0dbSShawn McCarney * items associated with sensors. Stores the resulting data in the 1584adc4f0dbSShawn McCarney * inventoryItems vector. 15858fb49dd6SShawn McCarney * 1586adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 1587adc4f0dbSShawn McCarney * response. 1588adc4f0dbSShawn McCarney * 1589adc4f0dbSShawn McCarney * Finds the inventory item data asynchronously. Invokes callback when data has 1590adc4f0dbSShawn McCarney * been obtained. 1591adc4f0dbSShawn McCarney * 1592adc4f0dbSShawn McCarney * The callback must have the following signature: 1593adc4f0dbSShawn McCarney * @code 1594d500549bSAnthony Wilson * callback(void) 1595adc4f0dbSShawn McCarney * @endcode 1596adc4f0dbSShawn McCarney * 1597adc4f0dbSShawn McCarney * This function is called recursively, obtaining data asynchronously from one 1598adc4f0dbSShawn McCarney * connection in each call. This ensures the callback is not invoked until the 1599adc4f0dbSShawn McCarney * last asynchronous function has completed. 16008fb49dd6SShawn McCarney * 16018fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 1602adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1603adc4f0dbSShawn McCarney * @param invConnections Connections that provide data for the inventory items. 16048fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 16058fb49dd6SShawn McCarney * implements ObjectManager. 1606adc4f0dbSShawn McCarney * @param callback Callback to invoke when inventory data has been obtained. 1607adc4f0dbSShawn McCarney * @param invConnectionsIndex Current index in invConnections. Only specified 1608adc4f0dbSShawn McCarney * in recursive calls to this function. 16098fb49dd6SShawn McCarney */ 1610adc4f0dbSShawn McCarney template <typename Callback> 1611adc4f0dbSShawn McCarney static void getInventoryItemsData( 16128fb49dd6SShawn McCarney std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1613adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 16148fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> invConnections, 16158fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 1616adc4f0dbSShawn McCarney objectMgrPaths, 1617271584abSEd Tanous Callback&& callback, size_t invConnectionsIndex = 0) 16188fb49dd6SShawn McCarney { 1619adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData enter"; 16208fb49dd6SShawn McCarney 1621adc4f0dbSShawn McCarney // If no more connections left, call callback 1622adc4f0dbSShawn McCarney if (invConnectionsIndex >= invConnections->size()) 16238fb49dd6SShawn McCarney { 1624d500549bSAnthony Wilson callback(); 1625adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData exit"; 1626adc4f0dbSShawn McCarney return; 1627adc4f0dbSShawn McCarney } 1628adc4f0dbSShawn McCarney 1629adc4f0dbSShawn McCarney // Get inventory item data from current connection 1630adc4f0dbSShawn McCarney auto it = invConnections->nth(invConnectionsIndex); 1631adc4f0dbSShawn McCarney if (it != invConnections->end()) 1632adc4f0dbSShawn McCarney { 1633adc4f0dbSShawn McCarney const std::string& invConnection = *it; 1634adc4f0dbSShawn McCarney 16358fb49dd6SShawn McCarney // Response handler for GetManagedObjects 1636adc4f0dbSShawn McCarney auto respHandler = [sensorsAsyncResp, inventoryItems, invConnections, 1637adc4f0dbSShawn McCarney objectMgrPaths, callback{std::move(callback)}, 1638adc4f0dbSShawn McCarney invConnectionsIndex]( 1639adc4f0dbSShawn McCarney const boost::system::error_code ec, 16408fb49dd6SShawn McCarney ManagedObjectsVectorType& resp) { 1641adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler enter"; 16428fb49dd6SShawn McCarney if (ec) 16438fb49dd6SShawn McCarney { 16448fb49dd6SShawn McCarney BMCWEB_LOG_ERROR 1645adc4f0dbSShawn McCarney << "getInventoryItemsData respHandler DBus error " << ec; 16468d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 16478fb49dd6SShawn McCarney return; 16488fb49dd6SShawn McCarney } 16498fb49dd6SShawn McCarney 16508fb49dd6SShawn McCarney // Loop through returned object paths 16518fb49dd6SShawn McCarney for (const auto& objDictEntry : resp) 16528fb49dd6SShawn McCarney { 16538fb49dd6SShawn McCarney const std::string& objPath = 16548fb49dd6SShawn McCarney static_cast<const std::string&>(objDictEntry.first); 16558fb49dd6SShawn McCarney 1656adc4f0dbSShawn McCarney // If this object path is one of the specified inventory items 1657adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 1658adc4f0dbSShawn McCarney findInventoryItem(inventoryItems, objPath); 1659adc4f0dbSShawn McCarney if (inventoryItem != nullptr) 16608fb49dd6SShawn McCarney { 1661adc4f0dbSShawn McCarney // Store inventory data in InventoryItem 1662adc4f0dbSShawn McCarney storeInventoryItemData(*inventoryItem, objDictEntry.second); 16638fb49dd6SShawn McCarney } 16648fb49dd6SShawn McCarney } 16658fb49dd6SShawn McCarney 1666adc4f0dbSShawn McCarney // Recurse to get inventory item data from next connection 1667adc4f0dbSShawn McCarney getInventoryItemsData(sensorsAsyncResp, inventoryItems, 1668adc4f0dbSShawn McCarney invConnections, objectMgrPaths, 1669adc4f0dbSShawn McCarney std::move(callback), invConnectionsIndex + 1); 1670adc4f0dbSShawn McCarney 1671adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler exit"; 16728fb49dd6SShawn McCarney }; 16738fb49dd6SShawn McCarney 16748fb49dd6SShawn McCarney // Find DBus object path that implements ObjectManager for the current 16758fb49dd6SShawn McCarney // connection. If no mapping found, default to "/". 16768fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(invConnection); 16778fb49dd6SShawn McCarney const std::string& objectMgrPath = 16788fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 16798fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << invConnection << " is " 16808fb49dd6SShawn McCarney << objectMgrPath; 16818fb49dd6SShawn McCarney 16828fb49dd6SShawn McCarney // Get all object paths and their interfaces for current connection 16838fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 16848fb49dd6SShawn McCarney std::move(respHandler), invConnection, objectMgrPath, 16858fb49dd6SShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 16868fb49dd6SShawn McCarney } 16878fb49dd6SShawn McCarney 1688adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData exit"; 16898fb49dd6SShawn McCarney } 16908fb49dd6SShawn McCarney 16918fb49dd6SShawn McCarney /** 1692adc4f0dbSShawn McCarney * @brief Gets connections that provide D-Bus data for inventory items. 16938fb49dd6SShawn McCarney * 1694adc4f0dbSShawn McCarney * Gets the D-Bus connections (services) that provide data for the inventory 1695adc4f0dbSShawn McCarney * items that are associated with sensors. 16968fb49dd6SShawn McCarney * 16978fb49dd6SShawn McCarney * Finds the connections asynchronously. Invokes callback when information has 16988fb49dd6SShawn McCarney * been obtained. 16998fb49dd6SShawn McCarney * 17008fb49dd6SShawn McCarney * The callback must have the following signature: 17018fb49dd6SShawn McCarney * @code 17028fb49dd6SShawn McCarney * callback(std::shared_ptr<boost::container::flat_set<std::string>> 17038fb49dd6SShawn McCarney * invConnections) 17048fb49dd6SShawn McCarney * @endcode 17058fb49dd6SShawn McCarney * 17068fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 1707adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 17088fb49dd6SShawn McCarney * @param callback Callback to invoke when connections have been obtained. 17098fb49dd6SShawn McCarney */ 17108fb49dd6SShawn McCarney template <typename Callback> 17118fb49dd6SShawn McCarney static void getInventoryItemsConnections( 1712b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 1713b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 17148fb49dd6SShawn McCarney Callback&& callback) 17158fb49dd6SShawn McCarney { 17168fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections enter"; 17178fb49dd6SShawn McCarney 17188fb49dd6SShawn McCarney const std::string path = "/xyz/openbmc_project/inventory"; 1719adc4f0dbSShawn McCarney const std::array<std::string, 4> interfaces = { 17208fb49dd6SShawn McCarney "xyz.openbmc_project.Inventory.Item", 1721adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Item.PowerSupply", 1722adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Decorator.Asset", 17238fb49dd6SShawn McCarney "xyz.openbmc_project.State.Decorator.OperationalStatus"}; 17248fb49dd6SShawn McCarney 17258fb49dd6SShawn McCarney // Response handler for parsing output from GetSubTree 17268fb49dd6SShawn McCarney auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 1727adc4f0dbSShawn McCarney inventoryItems](const boost::system::error_code ec, 17288fb49dd6SShawn McCarney const GetSubTreeType& subtree) { 17298fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler enter"; 17308fb49dd6SShawn McCarney if (ec) 17318fb49dd6SShawn McCarney { 17328d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 17338fb49dd6SShawn McCarney BMCWEB_LOG_ERROR 17348fb49dd6SShawn McCarney << "getInventoryItemsConnections respHandler DBus error " << ec; 17358fb49dd6SShawn McCarney return; 17368fb49dd6SShawn McCarney } 17378fb49dd6SShawn McCarney 17388fb49dd6SShawn McCarney // Make unique list of connections for desired inventory items 17398fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> 17408fb49dd6SShawn McCarney invConnections = 17418fb49dd6SShawn McCarney std::make_shared<boost::container::flat_set<std::string>>(); 17428fb49dd6SShawn McCarney invConnections->reserve(8); 17438fb49dd6SShawn McCarney 17448fb49dd6SShawn McCarney // Loop through objects from GetSubTree 17458fb49dd6SShawn McCarney for (const std::pair< 17468fb49dd6SShawn McCarney std::string, 17478fb49dd6SShawn McCarney std::vector<std::pair<std::string, std::vector<std::string>>>>& 17488fb49dd6SShawn McCarney object : subtree) 17498fb49dd6SShawn McCarney { 1750adc4f0dbSShawn McCarney // Check if object path is one of the specified inventory items 17518fb49dd6SShawn McCarney const std::string& objPath = object.first; 1752adc4f0dbSShawn McCarney if (findInventoryItem(inventoryItems, objPath) != nullptr) 17538fb49dd6SShawn McCarney { 17548fb49dd6SShawn McCarney // Store all connections to inventory item 17558fb49dd6SShawn McCarney for (const std::pair<std::string, std::vector<std::string>>& 17568fb49dd6SShawn McCarney objData : object.second) 17578fb49dd6SShawn McCarney { 17588fb49dd6SShawn McCarney const std::string& invConnection = objData.first; 17598fb49dd6SShawn McCarney invConnections->insert(invConnection); 17608fb49dd6SShawn McCarney } 17618fb49dd6SShawn McCarney } 17628fb49dd6SShawn McCarney } 1763d500549bSAnthony Wilson 17648fb49dd6SShawn McCarney callback(invConnections); 17658fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler exit"; 17668fb49dd6SShawn McCarney }; 17678fb49dd6SShawn McCarney 17688fb49dd6SShawn McCarney // Make call to ObjectMapper to find all inventory items 17698fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 17708fb49dd6SShawn McCarney std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 17718fb49dd6SShawn McCarney "/xyz/openbmc_project/object_mapper", 17728fb49dd6SShawn McCarney "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces); 17738fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections exit"; 17748fb49dd6SShawn McCarney } 17758fb49dd6SShawn McCarney 17768fb49dd6SShawn McCarney /** 1777adc4f0dbSShawn McCarney * @brief Gets associations from sensors to inventory items. 17788fb49dd6SShawn McCarney * 17798fb49dd6SShawn McCarney * Looks for ObjectMapper associations from the specified sensors to related 1780d500549bSAnthony Wilson * inventory items. Then finds the associations from those inventory items to 1781d500549bSAnthony Wilson * their LEDs, if any. 17828fb49dd6SShawn McCarney * 17838fb49dd6SShawn McCarney * Finds the inventory items asynchronously. Invokes callback when information 17848fb49dd6SShawn McCarney * has been obtained. 17858fb49dd6SShawn McCarney * 17868fb49dd6SShawn McCarney * The callback must have the following signature: 17878fb49dd6SShawn McCarney * @code 1788adc4f0dbSShawn McCarney * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 17898fb49dd6SShawn McCarney * @endcode 17908fb49dd6SShawn McCarney * 17918fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 17928fb49dd6SShawn McCarney * @param sensorNames All sensors within the current chassis. 17938fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 17948fb49dd6SShawn McCarney * implements ObjectManager. 17958fb49dd6SShawn McCarney * @param callback Callback to invoke when inventory items have been obtained. 17968fb49dd6SShawn McCarney */ 17978fb49dd6SShawn McCarney template <typename Callback> 1798adc4f0dbSShawn McCarney static void getInventoryItemAssociations( 1799b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 1800b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 1801b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_map<std::string, std::string>>& 18028fb49dd6SShawn McCarney objectMgrPaths, 18038fb49dd6SShawn McCarney Callback&& callback) 18048fb49dd6SShawn McCarney { 1805adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations enter"; 18068fb49dd6SShawn McCarney 18078fb49dd6SShawn McCarney // Response handler for GetManagedObjects 18088fb49dd6SShawn McCarney auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 18098fb49dd6SShawn McCarney sensorNames](const boost::system::error_code ec, 18108fb49dd6SShawn McCarney dbus::utility::ManagedObjectType& resp) { 1811adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler enter"; 18128fb49dd6SShawn McCarney if (ec) 18138fb49dd6SShawn McCarney { 1814adc4f0dbSShawn McCarney BMCWEB_LOG_ERROR 1815adc4f0dbSShawn McCarney << "getInventoryItemAssociations respHandler DBus error " << ec; 18168d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 18178fb49dd6SShawn McCarney return; 18188fb49dd6SShawn McCarney } 18198fb49dd6SShawn McCarney 1820adc4f0dbSShawn McCarney // Create vector to hold list of inventory items 1821adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems = 1822adc4f0dbSShawn McCarney std::make_shared<std::vector<InventoryItem>>(); 1823adc4f0dbSShawn McCarney 18248fb49dd6SShawn McCarney // Loop through returned object paths 18258fb49dd6SShawn McCarney std::string sensorAssocPath; 18268fb49dd6SShawn McCarney sensorAssocPath.reserve(128); // avoid memory allocations 18278fb49dd6SShawn McCarney for (const auto& objDictEntry : resp) 18288fb49dd6SShawn McCarney { 18298fb49dd6SShawn McCarney const std::string& objPath = 18308fb49dd6SShawn McCarney static_cast<const std::string&>(objDictEntry.first); 18318fb49dd6SShawn McCarney const boost::container::flat_map< 18328fb49dd6SShawn McCarney std::string, boost::container::flat_map< 18338fb49dd6SShawn McCarney std::string, dbus::utility::DbusVariantType>>& 18348fb49dd6SShawn McCarney interfacesDict = objDictEntry.second; 18358fb49dd6SShawn McCarney 18368fb49dd6SShawn McCarney // If path is inventory association for one of the specified sensors 18378fb49dd6SShawn McCarney for (const std::string& sensorName : *sensorNames) 18388fb49dd6SShawn McCarney { 18398fb49dd6SShawn McCarney sensorAssocPath = sensorName; 18408fb49dd6SShawn McCarney sensorAssocPath += "/inventory"; 18418fb49dd6SShawn McCarney if (objPath == sensorAssocPath) 18428fb49dd6SShawn McCarney { 18438fb49dd6SShawn McCarney // Get Association interface for object path 18448fb49dd6SShawn McCarney auto assocIt = 18458fb49dd6SShawn McCarney interfacesDict.find("xyz.openbmc_project.Association"); 18468fb49dd6SShawn McCarney if (assocIt != interfacesDict.end()) 18478fb49dd6SShawn McCarney { 18488fb49dd6SShawn McCarney // Get inventory item from end point 18498fb49dd6SShawn McCarney auto endpointsIt = assocIt->second.find("endpoints"); 18508fb49dd6SShawn McCarney if (endpointsIt != assocIt->second.end()) 18518fb49dd6SShawn McCarney { 18528fb49dd6SShawn McCarney const std::vector<std::string>* endpoints = 18538fb49dd6SShawn McCarney std::get_if<std::vector<std::string>>( 18548fb49dd6SShawn McCarney &endpointsIt->second); 18558fb49dd6SShawn McCarney if ((endpoints != nullptr) && !endpoints->empty()) 18568fb49dd6SShawn McCarney { 1857adc4f0dbSShawn McCarney // Add inventory item to vector 1858adc4f0dbSShawn McCarney const std::string& invItemPath = 1859adc4f0dbSShawn McCarney endpoints->front(); 1860adc4f0dbSShawn McCarney addInventoryItem(inventoryItems, invItemPath, 1861adc4f0dbSShawn McCarney sensorName); 18628fb49dd6SShawn McCarney } 18638fb49dd6SShawn McCarney } 18648fb49dd6SShawn McCarney } 18658fb49dd6SShawn McCarney break; 18668fb49dd6SShawn McCarney } 18678fb49dd6SShawn McCarney } 18688fb49dd6SShawn McCarney } 18698fb49dd6SShawn McCarney 1870d500549bSAnthony Wilson // Now loop through the returned object paths again, this time to 1871d500549bSAnthony Wilson // find the leds associated with the inventory items we just found 1872d500549bSAnthony Wilson std::string inventoryAssocPath; 1873d500549bSAnthony Wilson inventoryAssocPath.reserve(128); // avoid memory allocations 1874d500549bSAnthony Wilson for (const auto& objDictEntry : resp) 1875d500549bSAnthony Wilson { 1876d500549bSAnthony Wilson const std::string& objPath = 1877d500549bSAnthony Wilson static_cast<const std::string&>(objDictEntry.first); 1878d500549bSAnthony Wilson const boost::container::flat_map< 1879d500549bSAnthony Wilson std::string, boost::container::flat_map< 1880d500549bSAnthony Wilson std::string, dbus::utility::DbusVariantType>>& 1881d500549bSAnthony Wilson interfacesDict = objDictEntry.second; 1882d500549bSAnthony Wilson 1883d500549bSAnthony Wilson for (InventoryItem& inventoryItem : *inventoryItems) 1884d500549bSAnthony Wilson { 1885d500549bSAnthony Wilson inventoryAssocPath = inventoryItem.objectPath; 1886d500549bSAnthony Wilson inventoryAssocPath += "/leds"; 1887d500549bSAnthony Wilson if (objPath == inventoryAssocPath) 1888d500549bSAnthony Wilson { 1889d500549bSAnthony Wilson // Get Association interface for object path 1890d500549bSAnthony Wilson auto assocIt = 1891d500549bSAnthony Wilson interfacesDict.find("xyz.openbmc_project.Association"); 1892d500549bSAnthony Wilson if (assocIt != interfacesDict.end()) 1893d500549bSAnthony Wilson { 1894d500549bSAnthony Wilson // Get inventory item from end point 1895d500549bSAnthony Wilson auto endpointsIt = assocIt->second.find("endpoints"); 1896d500549bSAnthony Wilson if (endpointsIt != assocIt->second.end()) 1897d500549bSAnthony Wilson { 1898d500549bSAnthony Wilson const std::vector<std::string>* endpoints = 1899d500549bSAnthony Wilson std::get_if<std::vector<std::string>>( 1900d500549bSAnthony Wilson &endpointsIt->second); 1901d500549bSAnthony Wilson if ((endpoints != nullptr) && !endpoints->empty()) 1902d500549bSAnthony Wilson { 1903d500549bSAnthony Wilson // Store LED path in inventory item 1904d500549bSAnthony Wilson const std::string& ledPath = endpoints->front(); 1905d500549bSAnthony Wilson inventoryItem.ledObjectPath = ledPath; 1906d500549bSAnthony Wilson } 1907d500549bSAnthony Wilson } 1908d500549bSAnthony Wilson } 1909d500549bSAnthony Wilson break; 1910d500549bSAnthony Wilson } 1911d500549bSAnthony Wilson } 1912d500549bSAnthony Wilson } 1913adc4f0dbSShawn McCarney callback(inventoryItems); 1914adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler exit"; 19158fb49dd6SShawn McCarney }; 19168fb49dd6SShawn McCarney 19178fb49dd6SShawn McCarney // Find DBus object path that implements ObjectManager for ObjectMapper 19188fb49dd6SShawn McCarney std::string connection = "xyz.openbmc_project.ObjectMapper"; 19198fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(connection); 19208fb49dd6SShawn McCarney const std::string& objectMgrPath = 19218fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 19228fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is " 19238fb49dd6SShawn McCarney << objectMgrPath; 19248fb49dd6SShawn McCarney 19258fb49dd6SShawn McCarney // Call GetManagedObjects on the ObjectMapper to get all associations 19268fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 19278fb49dd6SShawn McCarney std::move(respHandler), connection, objectMgrPath, 19288fb49dd6SShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 19298fb49dd6SShawn McCarney 1930adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations exit"; 19318fb49dd6SShawn McCarney } 19328fb49dd6SShawn McCarney 19338fb49dd6SShawn McCarney /** 1934d500549bSAnthony Wilson * @brief Gets D-Bus data for inventory item leds associated with sensors. 1935d500549bSAnthony Wilson * 1936d500549bSAnthony Wilson * Uses the specified connections (services) to obtain D-Bus data for inventory 1937d500549bSAnthony Wilson * item leds associated with sensors. Stores the resulting data in the 1938d500549bSAnthony Wilson * inventoryItems vector. 1939d500549bSAnthony Wilson * 1940d500549bSAnthony Wilson * This data is later used to provide sensor property values in the JSON 1941d500549bSAnthony Wilson * response. 1942d500549bSAnthony Wilson * 1943d500549bSAnthony Wilson * Finds the inventory item led data asynchronously. Invokes callback when data 1944d500549bSAnthony Wilson * has been obtained. 1945d500549bSAnthony Wilson * 1946d500549bSAnthony Wilson * The callback must have the following signature: 1947d500549bSAnthony Wilson * @code 194842cbe538SGunnar Mills * callback() 1949d500549bSAnthony Wilson * @endcode 1950d500549bSAnthony Wilson * 1951d500549bSAnthony Wilson * This function is called recursively, obtaining data asynchronously from one 1952d500549bSAnthony Wilson * connection in each call. This ensures the callback is not invoked until the 1953d500549bSAnthony Wilson * last asynchronous function has completed. 1954d500549bSAnthony Wilson * 1955d500549bSAnthony Wilson * @param sensorsAsyncResp Pointer to object holding response data. 1956d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1957d500549bSAnthony Wilson * @param ledConnections Connections that provide data for the inventory leds. 1958d500549bSAnthony Wilson * @param callback Callback to invoke when inventory data has been obtained. 1959d500549bSAnthony Wilson * @param ledConnectionsIndex Current index in ledConnections. Only specified 1960d500549bSAnthony Wilson * in recursive calls to this function. 1961d500549bSAnthony Wilson */ 1962d500549bSAnthony Wilson template <typename Callback> 1963d500549bSAnthony Wilson void getInventoryLedData( 1964d500549bSAnthony Wilson std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1965d500549bSAnthony Wilson std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 1966d500549bSAnthony Wilson std::shared_ptr<boost::container::flat_map<std::string, std::string>> 1967d500549bSAnthony Wilson ledConnections, 1968d500549bSAnthony Wilson Callback&& callback, size_t ledConnectionsIndex = 0) 1969d500549bSAnthony Wilson { 1970d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData enter"; 1971d500549bSAnthony Wilson 1972d500549bSAnthony Wilson // If no more connections left, call callback 1973d500549bSAnthony Wilson if (ledConnectionsIndex >= ledConnections->size()) 1974d500549bSAnthony Wilson { 197542cbe538SGunnar Mills callback(); 1976d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData exit"; 1977d500549bSAnthony Wilson return; 1978d500549bSAnthony Wilson } 1979d500549bSAnthony Wilson 1980d500549bSAnthony Wilson // Get inventory item data from current connection 1981d500549bSAnthony Wilson auto it = ledConnections->nth(ledConnectionsIndex); 1982d500549bSAnthony Wilson if (it != ledConnections->end()) 1983d500549bSAnthony Wilson { 1984d500549bSAnthony Wilson const std::string& ledPath = (*it).first; 1985d500549bSAnthony Wilson const std::string& ledConnection = (*it).second; 1986d500549bSAnthony Wilson // Response handler for Get State property 1987*1e1e598dSJonathan Doman auto respHandler = 1988*1e1e598dSJonathan Doman [sensorsAsyncResp, inventoryItems, ledConnections, ledPath, 1989*1e1e598dSJonathan Doman callback{std::move(callback)}, ledConnectionsIndex]( 1990*1e1e598dSJonathan Doman const boost::system::error_code ec, const std::string& state) { 1991d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler enter"; 1992d500549bSAnthony Wilson if (ec) 1993d500549bSAnthony Wilson { 1994d500549bSAnthony Wilson BMCWEB_LOG_ERROR 1995d500549bSAnthony Wilson << "getInventoryLedData respHandler DBus error " << ec; 19968d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 1997d500549bSAnthony Wilson return; 1998d500549bSAnthony Wilson } 1999d500549bSAnthony Wilson 2000*1e1e598dSJonathan Doman BMCWEB_LOG_DEBUG << "Led state: " << state; 2001d500549bSAnthony Wilson // Find inventory item with this LED object path 2002d500549bSAnthony Wilson InventoryItem* inventoryItem = 2003d500549bSAnthony Wilson findInventoryItemForLed(*inventoryItems, ledPath); 2004d500549bSAnthony Wilson if (inventoryItem != nullptr) 2005d500549bSAnthony Wilson { 2006d500549bSAnthony Wilson // Store LED state in InventoryItem 2007*1e1e598dSJonathan Doman if (boost::ends_with(state, "On")) 2008d500549bSAnthony Wilson { 2009d500549bSAnthony Wilson inventoryItem->ledState = LedState::ON; 2010d500549bSAnthony Wilson } 2011*1e1e598dSJonathan Doman else if (boost::ends_with(state, "Blink")) 2012d500549bSAnthony Wilson { 2013d500549bSAnthony Wilson inventoryItem->ledState = LedState::BLINK; 2014d500549bSAnthony Wilson } 2015*1e1e598dSJonathan Doman else if (boost::ends_with(state, "Off")) 2016d500549bSAnthony Wilson { 2017d500549bSAnthony Wilson inventoryItem->ledState = LedState::OFF; 2018d500549bSAnthony Wilson } 2019d500549bSAnthony Wilson else 2020d500549bSAnthony Wilson { 2021d500549bSAnthony Wilson inventoryItem->ledState = LedState::UNKNOWN; 2022d500549bSAnthony Wilson } 2023d500549bSAnthony Wilson } 2024d500549bSAnthony Wilson 2025d500549bSAnthony Wilson // Recurse to get LED data from next connection 2026d500549bSAnthony Wilson getInventoryLedData(sensorsAsyncResp, inventoryItems, 2027d500549bSAnthony Wilson ledConnections, std::move(callback), 2028d500549bSAnthony Wilson ledConnectionsIndex + 1); 2029d500549bSAnthony Wilson 2030d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler exit"; 2031d500549bSAnthony Wilson }; 2032d500549bSAnthony Wilson 2033d500549bSAnthony Wilson // Get the State property for the current LED 2034*1e1e598dSJonathan Doman sdbusplus::asio::getProperty<std::string>( 2035*1e1e598dSJonathan Doman *crow::connections::systemBus, ledConnection, ledPath, 2036*1e1e598dSJonathan Doman "xyz.openbmc_project.Led.Physical", "State", 2037*1e1e598dSJonathan Doman std::move(respHandler)); 2038d500549bSAnthony Wilson } 2039d500549bSAnthony Wilson 2040d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData exit"; 2041d500549bSAnthony Wilson } 2042d500549bSAnthony Wilson 2043d500549bSAnthony Wilson /** 2044d500549bSAnthony Wilson * @brief Gets LED data for LEDs associated with given inventory items. 2045d500549bSAnthony Wilson * 2046d500549bSAnthony Wilson * Gets the D-Bus connections (services) that provide LED data for the LEDs 2047d500549bSAnthony Wilson * associated with the specified inventory items. Then gets the LED data from 2048d500549bSAnthony Wilson * each connection and stores it in the inventory item. 2049d500549bSAnthony Wilson * 2050d500549bSAnthony Wilson * This data is later used to provide sensor property values in the JSON 2051d500549bSAnthony Wilson * response. 2052d500549bSAnthony Wilson * 2053d500549bSAnthony Wilson * Finds the LED data asynchronously. Invokes callback when information has 2054d500549bSAnthony Wilson * been obtained. 2055d500549bSAnthony Wilson * 2056d500549bSAnthony Wilson * The callback must have the following signature: 2057d500549bSAnthony Wilson * @code 205842cbe538SGunnar Mills * callback() 2059d500549bSAnthony Wilson * @endcode 2060d500549bSAnthony Wilson * 2061d500549bSAnthony Wilson * @param sensorsAsyncResp Pointer to object holding response data. 2062d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 2063d500549bSAnthony Wilson * @param callback Callback to invoke when inventory items have been obtained. 2064d500549bSAnthony Wilson */ 2065d500549bSAnthony Wilson template <typename Callback> 2066d500549bSAnthony Wilson void getInventoryLeds( 2067d500549bSAnthony Wilson std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 2068d500549bSAnthony Wilson std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 2069d500549bSAnthony Wilson Callback&& callback) 2070d500549bSAnthony Wilson { 2071d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds enter"; 2072d500549bSAnthony Wilson 2073d500549bSAnthony Wilson const std::string path = "/xyz/openbmc_project"; 2074d500549bSAnthony Wilson const std::array<std::string, 1> interfaces = { 2075d500549bSAnthony Wilson "xyz.openbmc_project.Led.Physical"}; 2076d500549bSAnthony Wilson 2077d500549bSAnthony Wilson // Response handler for parsing output from GetSubTree 2078d500549bSAnthony Wilson auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 2079d500549bSAnthony Wilson inventoryItems](const boost::system::error_code ec, 2080d500549bSAnthony Wilson const GetSubTreeType& subtree) { 2081d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler enter"; 2082d500549bSAnthony Wilson if (ec) 2083d500549bSAnthony Wilson { 20848d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2085d500549bSAnthony Wilson BMCWEB_LOG_ERROR << "getInventoryLeds respHandler DBus error " 2086d500549bSAnthony Wilson << ec; 2087d500549bSAnthony Wilson return; 2088d500549bSAnthony Wilson } 2089d500549bSAnthony Wilson 2090d500549bSAnthony Wilson // Build map of LED object paths to connections 2091d500549bSAnthony Wilson std::shared_ptr<boost::container::flat_map<std::string, std::string>> 2092d500549bSAnthony Wilson ledConnections = std::make_shared< 2093d500549bSAnthony Wilson boost::container::flat_map<std::string, std::string>>(); 2094d500549bSAnthony Wilson 2095d500549bSAnthony Wilson // Loop through objects from GetSubTree 2096d500549bSAnthony Wilson for (const std::pair< 2097d500549bSAnthony Wilson std::string, 2098d500549bSAnthony Wilson std::vector<std::pair<std::string, std::vector<std::string>>>>& 2099d500549bSAnthony Wilson object : subtree) 2100d500549bSAnthony Wilson { 2101d500549bSAnthony Wilson // Check if object path is LED for one of the specified inventory 2102d500549bSAnthony Wilson // items 2103d500549bSAnthony Wilson const std::string& ledPath = object.first; 2104d500549bSAnthony Wilson if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr) 2105d500549bSAnthony Wilson { 2106d500549bSAnthony Wilson // Add mapping from ledPath to connection 2107d500549bSAnthony Wilson const std::string& connection = object.second.begin()->first; 2108d500549bSAnthony Wilson (*ledConnections)[ledPath] = connection; 2109d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "Added mapping " << ledPath << " -> " 2110d500549bSAnthony Wilson << connection; 2111d500549bSAnthony Wilson } 2112d500549bSAnthony Wilson } 2113d500549bSAnthony Wilson 2114d500549bSAnthony Wilson getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections, 2115d500549bSAnthony Wilson std::move(callback)); 2116d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler exit"; 2117d500549bSAnthony Wilson }; 2118d500549bSAnthony Wilson // Make call to ObjectMapper to find all inventory items 2119d500549bSAnthony Wilson crow::connections::systemBus->async_method_call( 2120d500549bSAnthony Wilson std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 2121d500549bSAnthony Wilson "/xyz/openbmc_project/object_mapper", 2122d500549bSAnthony Wilson "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces); 2123d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds exit"; 2124d500549bSAnthony Wilson } 2125d500549bSAnthony Wilson 2126d500549bSAnthony Wilson /** 212742cbe538SGunnar Mills * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent 212842cbe538SGunnar Mills * 212942cbe538SGunnar Mills * Uses the specified connections (services) (currently assumes just one) to 213042cbe538SGunnar Mills * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in 213142cbe538SGunnar Mills * the inventoryItems vector. Only stores data in Power Supply inventoryItems. 213242cbe538SGunnar Mills * 213342cbe538SGunnar Mills * This data is later used to provide sensor property values in the JSON 213442cbe538SGunnar Mills * response. 213542cbe538SGunnar Mills * 213642cbe538SGunnar Mills * Finds the Power Supply Attributes data asynchronously. Invokes callback 213742cbe538SGunnar Mills * when data has been obtained. 213842cbe538SGunnar Mills * 213942cbe538SGunnar Mills * The callback must have the following signature: 214042cbe538SGunnar Mills * @code 214142cbe538SGunnar Mills * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 214242cbe538SGunnar Mills * @endcode 214342cbe538SGunnar Mills * 214442cbe538SGunnar Mills * @param sensorsAsyncResp Pointer to object holding response data. 214542cbe538SGunnar Mills * @param inventoryItems D-Bus inventory items associated with sensors. 214642cbe538SGunnar Mills * @param psAttributesConnections Connections that provide data for the Power 214742cbe538SGunnar Mills * Supply Attributes 214842cbe538SGunnar Mills * @param callback Callback to invoke when data has been obtained. 214942cbe538SGunnar Mills */ 215042cbe538SGunnar Mills template <typename Callback> 215142cbe538SGunnar Mills void getPowerSupplyAttributesData( 2152b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 215342cbe538SGunnar Mills std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 215442cbe538SGunnar Mills const boost::container::flat_map<std::string, std::string>& 215542cbe538SGunnar Mills psAttributesConnections, 215642cbe538SGunnar Mills Callback&& callback) 215742cbe538SGunnar Mills { 215842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData enter"; 215942cbe538SGunnar Mills 216042cbe538SGunnar Mills if (psAttributesConnections.empty()) 216142cbe538SGunnar Mills { 216242cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Can't find PowerSupplyAttributes, no connections!"; 216342cbe538SGunnar Mills callback(inventoryItems); 216442cbe538SGunnar Mills return; 216542cbe538SGunnar Mills } 216642cbe538SGunnar Mills 216742cbe538SGunnar Mills // Assuming just one connection (service) for now 216842cbe538SGunnar Mills auto it = psAttributesConnections.nth(0); 216942cbe538SGunnar Mills 217042cbe538SGunnar Mills const std::string& psAttributesPath = (*it).first; 217142cbe538SGunnar Mills const std::string& psAttributesConnection = (*it).second; 217242cbe538SGunnar Mills 217342cbe538SGunnar Mills // Response handler for Get DeratingFactor property 217442cbe538SGunnar Mills auto respHandler = [sensorsAsyncResp, inventoryItems, 217542cbe538SGunnar Mills callback{std::move(callback)}]( 217642cbe538SGunnar Mills const boost::system::error_code ec, 2177*1e1e598dSJonathan Doman const uint32_t value) { 217842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler enter"; 217942cbe538SGunnar Mills if (ec) 218042cbe538SGunnar Mills { 218142cbe538SGunnar Mills BMCWEB_LOG_ERROR 218242cbe538SGunnar Mills << "getPowerSupplyAttributesData respHandler DBus error " << ec; 21838d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 218442cbe538SGunnar Mills return; 218542cbe538SGunnar Mills } 218642cbe538SGunnar Mills 2187*1e1e598dSJonathan Doman BMCWEB_LOG_DEBUG << "PS EfficiencyPercent value: " << value; 218842cbe538SGunnar Mills // Store value in Power Supply Inventory Items 218942cbe538SGunnar Mills for (InventoryItem& inventoryItem : *inventoryItems) 219042cbe538SGunnar Mills { 219142cbe538SGunnar Mills if (inventoryItem.isPowerSupply == true) 219242cbe538SGunnar Mills { 219342cbe538SGunnar Mills inventoryItem.powerSupplyEfficiencyPercent = 2194*1e1e598dSJonathan Doman static_cast<int>(value); 219542cbe538SGunnar Mills } 219642cbe538SGunnar Mills } 219742cbe538SGunnar Mills 219842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler exit"; 219942cbe538SGunnar Mills callback(inventoryItems); 220042cbe538SGunnar Mills }; 220142cbe538SGunnar Mills 220242cbe538SGunnar Mills // Get the DeratingFactor property for the PowerSupplyAttributes 220342cbe538SGunnar Mills // Currently only property on the interface/only one we care about 2204*1e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint32_t>( 2205*1e1e598dSJonathan Doman *crow::connections::systemBus, psAttributesConnection, psAttributesPath, 2206*1e1e598dSJonathan Doman "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor", 2207*1e1e598dSJonathan Doman std::move(respHandler)); 220842cbe538SGunnar Mills 220942cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData exit"; 221042cbe538SGunnar Mills } 221142cbe538SGunnar Mills 221242cbe538SGunnar Mills /** 221342cbe538SGunnar Mills * @brief Gets the Power Supply Attributes such as EfficiencyPercent 221442cbe538SGunnar Mills * 221542cbe538SGunnar Mills * Gets the D-Bus connection (service) that provides Power Supply Attributes 221642cbe538SGunnar Mills * data. Then gets the Power Supply Attributes data from the connection 221742cbe538SGunnar Mills * (currently just assumes 1 connection) and stores the data in the inventory 221842cbe538SGunnar Mills * item. 221942cbe538SGunnar Mills * 222042cbe538SGunnar Mills * This data is later used to provide sensor property values in the JSON 222142cbe538SGunnar Mills * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish. 222242cbe538SGunnar Mills * 222342cbe538SGunnar Mills * Finds the Power Supply Attributes data asynchronously. Invokes callback 222442cbe538SGunnar Mills * when information has been obtained. 222542cbe538SGunnar Mills * 222642cbe538SGunnar Mills * The callback must have the following signature: 222742cbe538SGunnar Mills * @code 222842cbe538SGunnar Mills * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 222942cbe538SGunnar Mills * @endcode 223042cbe538SGunnar Mills * 223142cbe538SGunnar Mills * @param sensorsAsyncResp Pointer to object holding response data. 223242cbe538SGunnar Mills * @param inventoryItems D-Bus inventory items associated with sensors. 223342cbe538SGunnar Mills * @param callback Callback to invoke when data has been obtained. 223442cbe538SGunnar Mills */ 223542cbe538SGunnar Mills template <typename Callback> 223642cbe538SGunnar Mills void getPowerSupplyAttributes( 223742cbe538SGunnar Mills std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 223842cbe538SGunnar Mills std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 223942cbe538SGunnar Mills Callback&& callback) 224042cbe538SGunnar Mills { 224142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes enter"; 224242cbe538SGunnar Mills 224342cbe538SGunnar Mills // Only need the power supply attributes when the Power Schema 2244a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode != sensors::node::power) 224542cbe538SGunnar Mills { 224642cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit since not Power"; 224742cbe538SGunnar Mills callback(inventoryItems); 224842cbe538SGunnar Mills return; 224942cbe538SGunnar Mills } 225042cbe538SGunnar Mills 225142cbe538SGunnar Mills const std::array<std::string, 1> interfaces = { 225242cbe538SGunnar Mills "xyz.openbmc_project.Control.PowerSupplyAttributes"}; 225342cbe538SGunnar Mills 225442cbe538SGunnar Mills // Response handler for parsing output from GetSubTree 225542cbe538SGunnar Mills auto respHandler = [callback{std::move(callback)}, sensorsAsyncResp, 225642cbe538SGunnar Mills inventoryItems](const boost::system::error_code ec, 225742cbe538SGunnar Mills const GetSubTreeType& subtree) { 225842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler enter"; 225942cbe538SGunnar Mills if (ec) 226042cbe538SGunnar Mills { 22618d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 226242cbe538SGunnar Mills BMCWEB_LOG_ERROR 226342cbe538SGunnar Mills << "getPowerSupplyAttributes respHandler DBus error " << ec; 226442cbe538SGunnar Mills return; 226542cbe538SGunnar Mills } 226642cbe538SGunnar Mills if (subtree.size() == 0) 226742cbe538SGunnar Mills { 226842cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Can't find Power Supply Attributes!"; 226942cbe538SGunnar Mills callback(inventoryItems); 227042cbe538SGunnar Mills return; 227142cbe538SGunnar Mills } 227242cbe538SGunnar Mills 227342cbe538SGunnar Mills // Currently we only support 1 power supply attribute, use this for 227442cbe538SGunnar Mills // all the power supplies. Build map of object path to connection. 227542cbe538SGunnar Mills // Assume just 1 connection and 1 path for now. 227642cbe538SGunnar Mills boost::container::flat_map<std::string, std::string> 227742cbe538SGunnar Mills psAttributesConnections; 227842cbe538SGunnar Mills 227942cbe538SGunnar Mills if (subtree[0].first.empty() || subtree[0].second.empty()) 228042cbe538SGunnar Mills { 228142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!"; 228242cbe538SGunnar Mills callback(inventoryItems); 228342cbe538SGunnar Mills return; 228442cbe538SGunnar Mills } 228542cbe538SGunnar Mills 228642cbe538SGunnar Mills const std::string& psAttributesPath = subtree[0].first; 228742cbe538SGunnar Mills const std::string& connection = subtree[0].second.begin()->first; 228842cbe538SGunnar Mills 228942cbe538SGunnar Mills if (connection.empty()) 229042cbe538SGunnar Mills { 229142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!"; 229242cbe538SGunnar Mills callback(inventoryItems); 229342cbe538SGunnar Mills return; 229442cbe538SGunnar Mills } 229542cbe538SGunnar Mills 229642cbe538SGunnar Mills psAttributesConnections[psAttributesPath] = connection; 229742cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Added mapping " << psAttributesPath << " -> " 229842cbe538SGunnar Mills << connection; 229942cbe538SGunnar Mills 230042cbe538SGunnar Mills getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems, 230142cbe538SGunnar Mills psAttributesConnections, 230242cbe538SGunnar Mills std::move(callback)); 230342cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler exit"; 230442cbe538SGunnar Mills }; 230542cbe538SGunnar Mills // Make call to ObjectMapper to find the PowerSupplyAttributes service 230642cbe538SGunnar Mills crow::connections::systemBus->async_method_call( 230742cbe538SGunnar Mills std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 230842cbe538SGunnar Mills "/xyz/openbmc_project/object_mapper", 230942cbe538SGunnar Mills "xyz.openbmc_project.ObjectMapper", "GetSubTree", 231042cbe538SGunnar Mills "/xyz/openbmc_project", 0, interfaces); 231142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit"; 231242cbe538SGunnar Mills } 231342cbe538SGunnar Mills 231442cbe538SGunnar Mills /** 2315adc4f0dbSShawn McCarney * @brief Gets inventory items associated with sensors. 23168fb49dd6SShawn McCarney * 23178fb49dd6SShawn McCarney * Finds the inventory items that are associated with the specified sensors. 2318adc4f0dbSShawn McCarney * Then gets D-Bus data for the inventory items, such as presence and VPD. 23198fb49dd6SShawn McCarney * 2320adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 2321adc4f0dbSShawn McCarney * response. 23228fb49dd6SShawn McCarney * 2323adc4f0dbSShawn McCarney * Finds the inventory items asynchronously. Invokes callback when the 2324adc4f0dbSShawn McCarney * inventory items have been obtained. 2325adc4f0dbSShawn McCarney * 2326adc4f0dbSShawn McCarney * The callback must have the following signature: 2327adc4f0dbSShawn McCarney * @code 2328adc4f0dbSShawn McCarney * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 2329adc4f0dbSShawn McCarney * @endcode 23308fb49dd6SShawn McCarney * 23318fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 23328fb49dd6SShawn McCarney * @param sensorNames All sensors within the current chassis. 23338fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 23348fb49dd6SShawn McCarney * implements ObjectManager. 2335adc4f0dbSShawn McCarney * @param callback Callback to invoke when inventory items have been obtained. 23368fb49dd6SShawn McCarney */ 2337adc4f0dbSShawn McCarney template <typename Callback> 2338adc4f0dbSShawn McCarney static void getInventoryItems( 23398fb49dd6SShawn McCarney std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 23408fb49dd6SShawn McCarney const std::shared_ptr<boost::container::flat_set<std::string>> sensorNames, 23418fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_map<std::string, std::string>> 2342adc4f0dbSShawn McCarney objectMgrPaths, 2343adc4f0dbSShawn McCarney Callback&& callback) 23448fb49dd6SShawn McCarney { 2345adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItems enter"; 2346adc4f0dbSShawn McCarney auto getInventoryItemAssociationsCb = 2347adc4f0dbSShawn McCarney [sensorsAsyncResp, objectMgrPaths, callback{std::move(callback)}]( 2348adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems) { 2349adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb enter"; 23508fb49dd6SShawn McCarney auto getInventoryItemsConnectionsCb = 2351adc4f0dbSShawn McCarney [sensorsAsyncResp, inventoryItems, objectMgrPaths, 2352adc4f0dbSShawn McCarney callback{std::move(callback)}]( 23538fb49dd6SShawn McCarney std::shared_ptr<boost::container::flat_set<std::string>> 23548fb49dd6SShawn McCarney invConnections) { 23558fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb enter"; 2356d500549bSAnthony Wilson auto getInventoryItemsDataCb = 2357d500549bSAnthony Wilson [sensorsAsyncResp, inventoryItems, 2358d500549bSAnthony Wilson callback{std::move(callback)}]() { 2359d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb enter"; 236042cbe538SGunnar Mills 236142cbe538SGunnar Mills auto getInventoryLedsCb = [sensorsAsyncResp, 236242cbe538SGunnar Mills inventoryItems, 236342cbe538SGunnar Mills callback{std::move( 236442cbe538SGunnar Mills callback)}]() { 236542cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getInventoryLedsCb enter"; 236642cbe538SGunnar Mills // Find Power Supply Attributes and get the data 236742cbe538SGunnar Mills getPowerSupplyAttributes(sensorsAsyncResp, 236842cbe538SGunnar Mills inventoryItems, 236942cbe538SGunnar Mills std::move(callback)); 237042cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getInventoryLedsCb exit"; 237142cbe538SGunnar Mills }; 237242cbe538SGunnar Mills 2373d500549bSAnthony Wilson // Find led connections and get the data 2374d500549bSAnthony Wilson getInventoryLeds(sensorsAsyncResp, inventoryItems, 237542cbe538SGunnar Mills std::move(getInventoryLedsCb)); 2376d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb exit"; 2377d500549bSAnthony Wilson }; 23788fb49dd6SShawn McCarney 2379adc4f0dbSShawn McCarney // Get inventory item data from connections 2380adc4f0dbSShawn McCarney getInventoryItemsData(sensorsAsyncResp, inventoryItems, 2381adc4f0dbSShawn McCarney invConnections, objectMgrPaths, 2382d500549bSAnthony Wilson std::move(getInventoryItemsDataCb)); 23838fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb exit"; 23848fb49dd6SShawn McCarney }; 23858fb49dd6SShawn McCarney 2386adc4f0dbSShawn McCarney // Get connections that provide inventory item data 23878fb49dd6SShawn McCarney getInventoryItemsConnections( 2388adc4f0dbSShawn McCarney sensorsAsyncResp, inventoryItems, 23898fb49dd6SShawn McCarney std::move(getInventoryItemsConnectionsCb)); 2390adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb exit"; 23918fb49dd6SShawn McCarney }; 23928fb49dd6SShawn McCarney 2393adc4f0dbSShawn McCarney // Get associations from sensors to inventory items 2394adc4f0dbSShawn McCarney getInventoryItemAssociations(sensorsAsyncResp, sensorNames, objectMgrPaths, 2395adc4f0dbSShawn McCarney std::move(getInventoryItemAssociationsCb)); 2396adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItems exit"; 2397adc4f0dbSShawn McCarney } 2398adc4f0dbSShawn McCarney 2399adc4f0dbSShawn McCarney /** 2400adc4f0dbSShawn McCarney * @brief Returns JSON PowerSupply object for the specified inventory item. 2401adc4f0dbSShawn McCarney * 2402adc4f0dbSShawn McCarney * Searches for a JSON PowerSupply object that matches the specified inventory 2403adc4f0dbSShawn McCarney * item. If one is not found, a new PowerSupply object is added to the JSON 2404adc4f0dbSShawn McCarney * array. 2405adc4f0dbSShawn McCarney * 2406adc4f0dbSShawn McCarney * Multiple sensors are often associated with one power supply inventory item. 2407adc4f0dbSShawn McCarney * As a result, multiple sensor values are stored in one JSON PowerSupply 2408adc4f0dbSShawn McCarney * object. 2409adc4f0dbSShawn McCarney * 2410adc4f0dbSShawn McCarney * @param powerSupplyArray JSON array containing Redfish PowerSupply objects. 2411adc4f0dbSShawn McCarney * @param inventoryItem Inventory item for the power supply. 2412adc4f0dbSShawn McCarney * @param chassisId Chassis that contains the power supply. 2413adc4f0dbSShawn McCarney * @return JSON PowerSupply object for the specified inventory item. 2414adc4f0dbSShawn McCarney */ 241523a21a1cSEd Tanous inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray, 2416adc4f0dbSShawn McCarney const InventoryItem& inventoryItem, 2417adc4f0dbSShawn McCarney const std::string& chassisId) 2418adc4f0dbSShawn McCarney { 2419adc4f0dbSShawn McCarney // Check if matching PowerSupply object already exists in JSON array 2420adc4f0dbSShawn McCarney for (nlohmann::json& powerSupply : powerSupplyArray) 2421adc4f0dbSShawn McCarney { 2422adc4f0dbSShawn McCarney if (powerSupply["MemberId"] == inventoryItem.name) 2423adc4f0dbSShawn McCarney { 2424adc4f0dbSShawn McCarney return powerSupply; 2425adc4f0dbSShawn McCarney } 2426adc4f0dbSShawn McCarney } 2427adc4f0dbSShawn McCarney 2428adc4f0dbSShawn McCarney // Add new PowerSupply object to JSON array 2429adc4f0dbSShawn McCarney powerSupplyArray.push_back({}); 2430adc4f0dbSShawn McCarney nlohmann::json& powerSupply = powerSupplyArray.back(); 2431adc4f0dbSShawn McCarney powerSupply["@odata.id"] = 2432adc4f0dbSShawn McCarney "/redfish/v1/Chassis/" + chassisId + "/Power#/PowerSupplies/"; 2433adc4f0dbSShawn McCarney powerSupply["MemberId"] = inventoryItem.name; 2434adc4f0dbSShawn McCarney powerSupply["Name"] = boost::replace_all_copy(inventoryItem.name, "_", " "); 2435adc4f0dbSShawn McCarney powerSupply["Manufacturer"] = inventoryItem.manufacturer; 2436adc4f0dbSShawn McCarney powerSupply["Model"] = inventoryItem.model; 2437adc4f0dbSShawn McCarney powerSupply["PartNumber"] = inventoryItem.partNumber; 2438adc4f0dbSShawn McCarney powerSupply["SerialNumber"] = inventoryItem.serialNumber; 2439d500549bSAnthony Wilson setLedState(powerSupply, &inventoryItem); 2440adc4f0dbSShawn McCarney 244142cbe538SGunnar Mills if (inventoryItem.powerSupplyEfficiencyPercent >= 0) 244242cbe538SGunnar Mills { 244342cbe538SGunnar Mills powerSupply["EfficiencyPercent"] = 244442cbe538SGunnar Mills inventoryItem.powerSupplyEfficiencyPercent; 244542cbe538SGunnar Mills } 244642cbe538SGunnar Mills 244742cbe538SGunnar Mills powerSupply["Status"]["State"] = getState(&inventoryItem); 2448adc4f0dbSShawn McCarney const char* health = inventoryItem.isFunctional ? "OK" : "Critical"; 2449adc4f0dbSShawn McCarney powerSupply["Status"]["Health"] = health; 2450adc4f0dbSShawn McCarney 2451adc4f0dbSShawn McCarney return powerSupply; 24528fb49dd6SShawn McCarney } 24538fb49dd6SShawn McCarney 24548fb49dd6SShawn McCarney /** 2455de629b6eSShawn McCarney * @brief Gets the values of the specified sensors. 2456de629b6eSShawn McCarney * 2457de629b6eSShawn McCarney * Stores the results as JSON in the SensorsAsyncResp. 2458de629b6eSShawn McCarney * 2459de629b6eSShawn McCarney * Gets the sensor values asynchronously. Stores the results later when the 2460de629b6eSShawn McCarney * information has been obtained. 2461de629b6eSShawn McCarney * 2462adc4f0dbSShawn McCarney * The sensorNames set contains all requested sensors for the current chassis. 2463de629b6eSShawn McCarney * 2464de629b6eSShawn McCarney * To minimize the number of DBus calls, the DBus method 2465de629b6eSShawn McCarney * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the 2466de629b6eSShawn McCarney * values of all sensors provided by a connection (service). 2467de629b6eSShawn McCarney * 2468de629b6eSShawn McCarney * The connections set contains all the connections that provide sensor values. 2469de629b6eSShawn McCarney * 2470de629b6eSShawn McCarney * The objectMgrPaths map contains mappings from a connection name to the 2471de629b6eSShawn McCarney * corresponding DBus object path that implements ObjectManager. 2472de629b6eSShawn McCarney * 2473adc4f0dbSShawn McCarney * The InventoryItem vector contains D-Bus inventory items associated with the 2474adc4f0dbSShawn McCarney * sensors. Inventory item data is needed for some Redfish sensor properties. 2475adc4f0dbSShawn McCarney * 2476de629b6eSShawn McCarney * @param SensorsAsyncResp Pointer to object holding response data. 2477adc4f0dbSShawn McCarney * @param sensorNames All requested sensors within the current chassis. 2478de629b6eSShawn McCarney * @param connections Connections that provide sensor values. 2479de629b6eSShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 2480de629b6eSShawn McCarney * implements ObjectManager. 2481adc4f0dbSShawn McCarney * @param inventoryItems Inventory items associated with the sensors. 2482de629b6eSShawn McCarney */ 248323a21a1cSEd Tanous inline void getSensorData( 248481ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 2485b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames, 2486de629b6eSShawn McCarney const boost::container::flat_set<std::string>& connections, 2487b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_map<std::string, std::string>>& 2488adc4f0dbSShawn McCarney objectMgrPaths, 2489b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems) 2490de629b6eSShawn McCarney { 2491de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getSensorData enter"; 2492de629b6eSShawn McCarney // Get managed objects from all services exposing sensors 2493de629b6eSShawn McCarney for (const std::string& connection : connections) 2494de629b6eSShawn McCarney { 2495de629b6eSShawn McCarney // Response handler to process managed objects 249681ce609eSEd Tanous auto getManagedObjectsCb = [sensorsAsyncResp, sensorNames, 2497adc4f0dbSShawn McCarney inventoryItems]( 2498de629b6eSShawn McCarney const boost::system::error_code ec, 2499de629b6eSShawn McCarney ManagedObjectsVectorType& resp) { 2500de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb enter"; 2501de629b6eSShawn McCarney if (ec) 2502de629b6eSShawn McCarney { 2503de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "getManagedObjectsCb DBUS error: " << ec; 25048d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2505de629b6eSShawn McCarney return; 2506de629b6eSShawn McCarney } 2507de629b6eSShawn McCarney // Go through all objects and update response with sensor data 2508de629b6eSShawn McCarney for (const auto& objDictEntry : resp) 2509de629b6eSShawn McCarney { 2510de629b6eSShawn McCarney const std::string& objPath = 2511de629b6eSShawn McCarney static_cast<const std::string&>(objDictEntry.first); 2512de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb parsing object " 2513de629b6eSShawn McCarney << objPath; 2514de629b6eSShawn McCarney 2515de629b6eSShawn McCarney std::vector<std::string> split; 2516de629b6eSShawn McCarney // Reserve space for 2517de629b6eSShawn McCarney // /xyz/openbmc_project/sensors/<name>/<subname> 2518de629b6eSShawn McCarney split.reserve(6); 2519de629b6eSShawn McCarney boost::algorithm::split(split, objPath, boost::is_any_of("/")); 2520de629b6eSShawn McCarney if (split.size() < 6) 2521de629b6eSShawn McCarney { 2522de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "Got path that isn't long enough " 2523de629b6eSShawn McCarney << objPath; 2524de629b6eSShawn McCarney continue; 2525de629b6eSShawn McCarney } 2526de629b6eSShawn McCarney // These indexes aren't intuitive, as boost::split puts an empty 2527de629b6eSShawn McCarney // string at the beginning 2528de629b6eSShawn McCarney const std::string& sensorType = split[4]; 2529de629b6eSShawn McCarney const std::string& sensorName = split[5]; 2530de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "sensorName " << sensorName 2531de629b6eSShawn McCarney << " sensorType " << sensorType; 253249c53ac9SJohnathan Mantey if (sensorNames->find(objPath) == sensorNames->end()) 2533de629b6eSShawn McCarney { 2534accdbb2cSAndrew Geissler BMCWEB_LOG_DEBUG << sensorName << " not in sensor list "; 2535de629b6eSShawn McCarney continue; 2536de629b6eSShawn McCarney } 2537de629b6eSShawn McCarney 2538adc4f0dbSShawn McCarney // Find inventory item (if any) associated with sensor 2539adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 2540adc4f0dbSShawn McCarney findInventoryItemForSensor(inventoryItems, objPath); 2541adc4f0dbSShawn McCarney 254295a3ecadSAnthony Wilson const std::string& sensorSchema = 254381ce609eSEd Tanous sensorsAsyncResp->chassisSubNode; 254495a3ecadSAnthony Wilson 254595a3ecadSAnthony Wilson nlohmann::json* sensorJson = nullptr; 254695a3ecadSAnthony Wilson 2547a0ec28b6SAdrian Ambrożewicz if (sensorSchema == sensors::node::sensors) 254895a3ecadSAnthony Wilson { 25498d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] = 255081ce609eSEd Tanous "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + 255181ce609eSEd Tanous "/" + sensorsAsyncResp->chassisSubNode + "/" + 255295a3ecadSAnthony Wilson sensorName; 25538d1b46d7Szhanghch05 sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue); 255495a3ecadSAnthony Wilson } 255595a3ecadSAnthony Wilson else 255695a3ecadSAnthony Wilson { 2557271584abSEd Tanous std::string fieldName; 2558de629b6eSShawn McCarney if (sensorType == "temperature") 2559de629b6eSShawn McCarney { 2560de629b6eSShawn McCarney fieldName = "Temperatures"; 2561de629b6eSShawn McCarney } 2562de629b6eSShawn McCarney else if (sensorType == "fan" || sensorType == "fan_tach" || 2563de629b6eSShawn McCarney sensorType == "fan_pwm") 2564de629b6eSShawn McCarney { 2565de629b6eSShawn McCarney fieldName = "Fans"; 2566de629b6eSShawn McCarney } 2567de629b6eSShawn McCarney else if (sensorType == "voltage") 2568de629b6eSShawn McCarney { 2569de629b6eSShawn McCarney fieldName = "Voltages"; 2570de629b6eSShawn McCarney } 2571de629b6eSShawn McCarney else if (sensorType == "power") 2572de629b6eSShawn McCarney { 2573028f7ebcSEddie James if (!sensorName.compare("total_power")) 2574028f7ebcSEddie James { 2575028f7ebcSEddie James fieldName = "PowerControl"; 2576028f7ebcSEddie James } 2577adc4f0dbSShawn McCarney else if ((inventoryItem != nullptr) && 2578adc4f0dbSShawn McCarney (inventoryItem->isPowerSupply)) 2579028f7ebcSEddie James { 2580de629b6eSShawn McCarney fieldName = "PowerSupplies"; 2581de629b6eSShawn McCarney } 2582adc4f0dbSShawn McCarney else 2583adc4f0dbSShawn McCarney { 2584adc4f0dbSShawn McCarney // Other power sensors are in SensorCollection 2585adc4f0dbSShawn McCarney continue; 2586adc4f0dbSShawn McCarney } 2587028f7ebcSEddie James } 2588de629b6eSShawn McCarney else 2589de629b6eSShawn McCarney { 2590de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "Unsure how to handle sensorType " 2591de629b6eSShawn McCarney << sensorType; 2592de629b6eSShawn McCarney continue; 2593de629b6eSShawn McCarney } 2594de629b6eSShawn McCarney 2595de629b6eSShawn McCarney nlohmann::json& tempArray = 25968d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue[fieldName]; 2597adc4f0dbSShawn McCarney if (fieldName == "PowerControl") 259849c53ac9SJohnathan Mantey { 2599adc4f0dbSShawn McCarney if (tempArray.empty()) 26007ab06f49SGunnar Mills { 260195a3ecadSAnthony Wilson // Put multiple "sensors" into a single 260295a3ecadSAnthony Wilson // PowerControl. Follows MemberId naming and 260395a3ecadSAnthony Wilson // naming in power.hpp. 26047ab06f49SGunnar Mills tempArray.push_back( 2605adc4f0dbSShawn McCarney {{"@odata.id", 2606adc4f0dbSShawn McCarney "/redfish/v1/Chassis/" + 260781ce609eSEd Tanous sensorsAsyncResp->chassisId + "/" + 260881ce609eSEd Tanous sensorsAsyncResp->chassisSubNode + "#/" + 2609adc4f0dbSShawn McCarney fieldName + "/0"}}); 2610adc4f0dbSShawn McCarney } 2611adc4f0dbSShawn McCarney sensorJson = &(tempArray.back()); 2612adc4f0dbSShawn McCarney } 2613adc4f0dbSShawn McCarney else if (fieldName == "PowerSupplies") 2614adc4f0dbSShawn McCarney { 2615adc4f0dbSShawn McCarney if (inventoryItem != nullptr) 2616adc4f0dbSShawn McCarney { 2617adc4f0dbSShawn McCarney sensorJson = 2618adc4f0dbSShawn McCarney &(getPowerSupply(tempArray, *inventoryItem, 261981ce609eSEd Tanous sensorsAsyncResp->chassisId)); 2620adc4f0dbSShawn McCarney } 262149c53ac9SJohnathan Mantey } 262249c53ac9SJohnathan Mantey else 262349c53ac9SJohnathan Mantey { 2624de629b6eSShawn McCarney tempArray.push_back( 262595a3ecadSAnthony Wilson {{"@odata.id", 262695a3ecadSAnthony Wilson "/redfish/v1/Chassis/" + 262781ce609eSEd Tanous sensorsAsyncResp->chassisId + "/" + 262881ce609eSEd Tanous sensorsAsyncResp->chassisSubNode + "#/" + 262995a3ecadSAnthony Wilson fieldName + "/"}}); 2630adc4f0dbSShawn McCarney sensorJson = &(tempArray.back()); 263149c53ac9SJohnathan Mantey } 263295a3ecadSAnthony Wilson } 2633de629b6eSShawn McCarney 2634adc4f0dbSShawn McCarney if (sensorJson != nullptr) 2635adc4f0dbSShawn McCarney { 2636a0ec28b6SAdrian Ambrożewicz objectInterfacesToJson( 263781ce609eSEd Tanous sensorName, sensorType, sensorsAsyncResp, 2638a0ec28b6SAdrian Ambrożewicz objDictEntry.second, *sensorJson, inventoryItem); 2639adc4f0dbSShawn McCarney } 2640de629b6eSShawn McCarney } 264181ce609eSEd Tanous if (sensorsAsyncResp.use_count() == 1) 264249c53ac9SJohnathan Mantey { 264381ce609eSEd Tanous sortJSONResponse(sensorsAsyncResp); 264481ce609eSEd Tanous if (sensorsAsyncResp->chassisSubNode == sensors::node::thermal) 26458bd25ccdSJames Feist { 264681ce609eSEd Tanous populateFanRedundancy(sensorsAsyncResp); 26478bd25ccdSJames Feist } 264849c53ac9SJohnathan Mantey } 2649de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb exit"; 2650de629b6eSShawn McCarney }; 2651de629b6eSShawn McCarney 2652de629b6eSShawn McCarney // Find DBus object path that implements ObjectManager for the current 2653de629b6eSShawn McCarney // connection. If no mapping found, default to "/". 26548fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(connection); 2655de629b6eSShawn McCarney const std::string& objectMgrPath = 26568fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 2657de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is " 2658de629b6eSShawn McCarney << objectMgrPath; 2659de629b6eSShawn McCarney 2660de629b6eSShawn McCarney crow::connections::systemBus->async_method_call( 2661de629b6eSShawn McCarney getManagedObjectsCb, connection, objectMgrPath, 2662de629b6eSShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 266323a21a1cSEd Tanous } 2664de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getSensorData exit"; 2665de629b6eSShawn McCarney } 2666de629b6eSShawn McCarney 266723a21a1cSEd Tanous inline void processSensorList( 266881ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 2669b5a76932SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames) 26701abe55efSEd Tanous { 267195a3ecadSAnthony Wilson auto getConnectionCb = 267281ce609eSEd Tanous [sensorsAsyncResp, sensorNames]( 267395a3ecadSAnthony Wilson const boost::container::flat_set<std::string>& connections) { 267455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getConnectionCb enter"; 2675de629b6eSShawn McCarney auto getObjectManagerPathsCb = 267681ce609eSEd Tanous [sensorsAsyncResp, sensorNames, 2677b5a76932SEd Tanous connections](const std::shared_ptr<boost::container::flat_map< 2678b5a76932SEd Tanous std::string, std::string>>& objectMgrPaths) { 2679de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb enter"; 2680adc4f0dbSShawn McCarney auto getInventoryItemsCb = 268181ce609eSEd Tanous [sensorsAsyncResp, sensorNames, connections, 2682adc4f0dbSShawn McCarney objectMgrPaths]( 2683f23b7296SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& 2684adc4f0dbSShawn McCarney inventoryItems) { 2685adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsCb enter"; 268649c53ac9SJohnathan Mantey // Get sensor data and store results in JSON 268781ce609eSEd Tanous getSensorData(sensorsAsyncResp, sensorNames, 2688adc4f0dbSShawn McCarney connections, objectMgrPaths, 2689f23b7296SEd Tanous inventoryItems); 2690adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsCb exit"; 2691adc4f0dbSShawn McCarney }; 2692adc4f0dbSShawn McCarney 2693adc4f0dbSShawn McCarney // Get inventory items associated with sensors 269481ce609eSEd Tanous getInventoryItems(sensorsAsyncResp, sensorNames, 2695adc4f0dbSShawn McCarney objectMgrPaths, 2696adc4f0dbSShawn McCarney std::move(getInventoryItemsCb)); 2697adc4f0dbSShawn McCarney 2698de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb exit"; 269908777fb0SLewanczyk, Dawid }; 2700de629b6eSShawn McCarney 270149c53ac9SJohnathan Mantey // Get mapping from connection names to the DBus object 270249c53ac9SJohnathan Mantey // paths that implement the ObjectManager interface 270381ce609eSEd Tanous getObjectManagerPaths(sensorsAsyncResp, 2704de629b6eSShawn McCarney std::move(getObjectManagerPathsCb)); 270555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getConnectionCb exit"; 270608777fb0SLewanczyk, Dawid }; 2707de629b6eSShawn McCarney 2708de629b6eSShawn McCarney // Get set of connections that provide sensor values 270981ce609eSEd Tanous getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb)); 271095a3ecadSAnthony Wilson } 271195a3ecadSAnthony Wilson 271295a3ecadSAnthony Wilson /** 271395a3ecadSAnthony Wilson * @brief Entry point for retrieving sensors data related to requested 271495a3ecadSAnthony Wilson * chassis. 271595a3ecadSAnthony Wilson * @param SensorsAsyncResp Pointer to object holding response data 271695a3ecadSAnthony Wilson */ 2717b5a76932SEd Tanous inline void 271881ce609eSEd Tanous getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 271995a3ecadSAnthony Wilson { 272095a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisData enter"; 272195a3ecadSAnthony Wilson auto getChassisCb = 272281ce609eSEd Tanous [sensorsAsyncResp]( 2723f23b7296SEd Tanous const std::shared_ptr<boost::container::flat_set<std::string>>& 272495a3ecadSAnthony Wilson sensorNames) { 272595a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb enter"; 272681ce609eSEd Tanous processSensorList(sensorsAsyncResp, sensorNames); 272755c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassisCb exit"; 272808777fb0SLewanczyk, Dawid }; 27298d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] = 27308d1b46d7Szhanghch05 nlohmann::json::array(); 273108777fb0SLewanczyk, Dawid 273226f03899SShawn McCarney // Get set of sensors in chassis 273381ce609eSEd Tanous getChassis(sensorsAsyncResp, std::move(getChassisCb)); 273455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassisData exit"; 2735271584abSEd Tanous } 273608777fb0SLewanczyk, Dawid 2737413961deSRichard Marian Thomaiyar /** 273849c53ac9SJohnathan Mantey * @brief Find the requested sensorName in the list of all sensors supplied by 273949c53ac9SJohnathan Mantey * the chassis node 274049c53ac9SJohnathan Mantey * 274149c53ac9SJohnathan Mantey * @param sensorName The sensor name supplied in the PATCH request 274249c53ac9SJohnathan Mantey * @param sensorsList The list of sensors managed by the chassis node 274349c53ac9SJohnathan Mantey * @param sensorsModified The list of sensors that were found as a result of 274449c53ac9SJohnathan Mantey * repeated calls to this function 274549c53ac9SJohnathan Mantey */ 274623a21a1cSEd Tanous inline bool findSensorNameUsingSensorPath( 27470a86febdSRichard Marian Thomaiyar std::string_view sensorName, 274849c53ac9SJohnathan Mantey boost::container::flat_set<std::string>& sensorsList, 274949c53ac9SJohnathan Mantey boost::container::flat_set<std::string>& sensorsModified) 275049c53ac9SJohnathan Mantey { 275128aa8de5SGeorge Liu for (auto& chassisSensor : sensorsList) 275249c53ac9SJohnathan Mantey { 275328aa8de5SGeorge Liu sdbusplus::message::object_path path(chassisSensor); 2754b00dcc27SEd Tanous std::string thisSensorName = path.filename(); 275528aa8de5SGeorge Liu if (thisSensorName.empty()) 275649c53ac9SJohnathan Mantey { 275749c53ac9SJohnathan Mantey continue; 275849c53ac9SJohnathan Mantey } 275949c53ac9SJohnathan Mantey if (thisSensorName == sensorName) 276049c53ac9SJohnathan Mantey { 276149c53ac9SJohnathan Mantey sensorsModified.emplace(chassisSensor); 276249c53ac9SJohnathan Mantey return true; 276349c53ac9SJohnathan Mantey } 276449c53ac9SJohnathan Mantey } 276549c53ac9SJohnathan Mantey return false; 276649c53ac9SJohnathan Mantey } 276749c53ac9SJohnathan Mantey 276849c53ac9SJohnathan Mantey /** 2769413961deSRichard Marian Thomaiyar * @brief Entry point for overriding sensor values of given sensor 2770413961deSRichard Marian Thomaiyar * 27718d1b46d7Szhanghch05 * @param sensorAsyncResp response object 27724bb3dc34SCarol Wang * @param allCollections Collections extract from sensors' request patch info 2773413961deSRichard Marian Thomaiyar * @param chassisSubNode Chassis Node for which the query has to happen 2774413961deSRichard Marian Thomaiyar */ 277523a21a1cSEd Tanous inline void setSensorsOverride( 2776b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp, 27774bb3dc34SCarol Wang std::unordered_map<std::string, std::vector<nlohmann::json>>& 2778397fd61fSjayaprakash Mutyala allCollections) 2779413961deSRichard Marian Thomaiyar { 278070d1d0aaSjayaprakash Mutyala BMCWEB_LOG_INFO << "setSensorsOverride for subNode" 27814bb3dc34SCarol Wang << sensorAsyncResp->chassisSubNode << "\n"; 2782413961deSRichard Marian Thomaiyar 2783f65af9e8SRichard Marian Thomaiyar const char* propertyValueName; 2784f65af9e8SRichard Marian Thomaiyar std::unordered_map<std::string, std::pair<double, std::string>> overrideMap; 2785413961deSRichard Marian Thomaiyar std::string memberId; 2786413961deSRichard Marian Thomaiyar double value; 2787f65af9e8SRichard Marian Thomaiyar for (auto& collectionItems : allCollections) 2788f65af9e8SRichard Marian Thomaiyar { 2789f65af9e8SRichard Marian Thomaiyar if (collectionItems.first == "Temperatures") 2790f65af9e8SRichard Marian Thomaiyar { 2791f65af9e8SRichard Marian Thomaiyar propertyValueName = "ReadingCelsius"; 2792f65af9e8SRichard Marian Thomaiyar } 2793f65af9e8SRichard Marian Thomaiyar else if (collectionItems.first == "Fans") 2794f65af9e8SRichard Marian Thomaiyar { 2795f65af9e8SRichard Marian Thomaiyar propertyValueName = "Reading"; 2796f65af9e8SRichard Marian Thomaiyar } 2797f65af9e8SRichard Marian Thomaiyar else 2798f65af9e8SRichard Marian Thomaiyar { 2799f65af9e8SRichard Marian Thomaiyar propertyValueName = "ReadingVolts"; 2800f65af9e8SRichard Marian Thomaiyar } 2801f65af9e8SRichard Marian Thomaiyar for (auto& item : collectionItems.second) 2802f65af9e8SRichard Marian Thomaiyar { 28038d1b46d7Szhanghch05 if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res, 28048d1b46d7Szhanghch05 "MemberId", memberId, propertyValueName, 28058d1b46d7Szhanghch05 value)) 2806413961deSRichard Marian Thomaiyar { 2807413961deSRichard Marian Thomaiyar return; 2808413961deSRichard Marian Thomaiyar } 2809f65af9e8SRichard Marian Thomaiyar overrideMap.emplace(memberId, 2810f65af9e8SRichard Marian Thomaiyar std::make_pair(value, collectionItems.first)); 2811f65af9e8SRichard Marian Thomaiyar } 2812f65af9e8SRichard Marian Thomaiyar } 28134bb3dc34SCarol Wang 2814b5a76932SEd Tanous auto getChassisSensorListCb = [sensorAsyncResp, overrideMap]( 2815b5a76932SEd Tanous const std::shared_ptr< 281649c53ac9SJohnathan Mantey boost::container::flat_set< 2817b5a76932SEd Tanous std::string>>& sensorsList) { 281849c53ac9SJohnathan Mantey // Match sensor names in the PATCH request to those managed by the 281949c53ac9SJohnathan Mantey // chassis node 282049c53ac9SJohnathan Mantey const std::shared_ptr<boost::container::flat_set<std::string>> 282149c53ac9SJohnathan Mantey sensorNames = 282249c53ac9SJohnathan Mantey std::make_shared<boost::container::flat_set<std::string>>(); 2823f65af9e8SRichard Marian Thomaiyar for (const auto& item : overrideMap) 2824413961deSRichard Marian Thomaiyar { 2825f65af9e8SRichard Marian Thomaiyar const auto& sensor = item.first; 282649c53ac9SJohnathan Mantey if (!findSensorNameUsingSensorPath(sensor, *sensorsList, 282749c53ac9SJohnathan Mantey *sensorNames)) 2828f65af9e8SRichard Marian Thomaiyar { 2829f65af9e8SRichard Marian Thomaiyar BMCWEB_LOG_INFO << "Unable to find memberId " << item.first; 28308d1b46d7Szhanghch05 messages::resourceNotFound(sensorAsyncResp->asyncResp->res, 2831f65af9e8SRichard Marian Thomaiyar item.second.second, item.first); 2832413961deSRichard Marian Thomaiyar return; 2833413961deSRichard Marian Thomaiyar } 2834f65af9e8SRichard Marian Thomaiyar } 2835413961deSRichard Marian Thomaiyar // Get the connection to which the memberId belongs 28364f277b54SJayaprakash Mutyala auto getObjectsWithConnectionCb = [sensorAsyncResp, overrideMap]( 28374f277b54SJayaprakash Mutyala const boost::container::flat_set< 28384f277b54SJayaprakash Mutyala std::string>& /*connections*/, 28394f277b54SJayaprakash Mutyala const std::set<std::pair< 28404f277b54SJayaprakash Mutyala std::string, std::string>>& 2841413961deSRichard Marian Thomaiyar objectsWithConnection) { 2842f65af9e8SRichard Marian Thomaiyar if (objectsWithConnection.size() != overrideMap.size()) 2843413961deSRichard Marian Thomaiyar { 2844413961deSRichard Marian Thomaiyar BMCWEB_LOG_INFO 2845f65af9e8SRichard Marian Thomaiyar << "Unable to find all objects with proper connection " 2846f65af9e8SRichard Marian Thomaiyar << objectsWithConnection.size() << " requested " 2847f65af9e8SRichard Marian Thomaiyar << overrideMap.size() << "\n"; 28484f277b54SJayaprakash Mutyala messages::resourceNotFound(sensorAsyncResp->asyncResp->res, 2849a0ec28b6SAdrian Ambrożewicz sensorAsyncResp->chassisSubNode == 2850a0ec28b6SAdrian Ambrożewicz sensors::node::thermal 2851413961deSRichard Marian Thomaiyar ? "Temperatures" 2852413961deSRichard Marian Thomaiyar : "Voltages", 2853f65af9e8SRichard Marian Thomaiyar "Count"); 2854f65af9e8SRichard Marian Thomaiyar return; 2855f65af9e8SRichard Marian Thomaiyar } 2856f65af9e8SRichard Marian Thomaiyar for (const auto& item : objectsWithConnection) 2857f65af9e8SRichard Marian Thomaiyar { 285828aa8de5SGeorge Liu sdbusplus::message::object_path path(item.first); 285928aa8de5SGeorge Liu std::string sensorName = path.filename(); 286028aa8de5SGeorge Liu if (sensorName.empty()) 2861f65af9e8SRichard Marian Thomaiyar { 28624f277b54SJayaprakash Mutyala messages::internalError(sensorAsyncResp->asyncResp->res); 2863f65af9e8SRichard Marian Thomaiyar return; 2864f65af9e8SRichard Marian Thomaiyar } 2865f65af9e8SRichard Marian Thomaiyar 2866f65af9e8SRichard Marian Thomaiyar const auto& iterator = overrideMap.find(sensorName); 2867f65af9e8SRichard Marian Thomaiyar if (iterator == overrideMap.end()) 2868f65af9e8SRichard Marian Thomaiyar { 2869f65af9e8SRichard Marian Thomaiyar BMCWEB_LOG_INFO << "Unable to find sensor object" 2870f65af9e8SRichard Marian Thomaiyar << item.first << "\n"; 28714f277b54SJayaprakash Mutyala messages::internalError(sensorAsyncResp->asyncResp->res); 2872413961deSRichard Marian Thomaiyar return; 2873413961deSRichard Marian Thomaiyar } 2874413961deSRichard Marian Thomaiyar crow::connections::systemBus->async_method_call( 2875f65af9e8SRichard Marian Thomaiyar [sensorAsyncResp](const boost::system::error_code ec) { 2876413961deSRichard Marian Thomaiyar if (ec) 2877413961deSRichard Marian Thomaiyar { 28784f277b54SJayaprakash Mutyala if (ec.value() == 28794f277b54SJayaprakash Mutyala boost::system::errc::permission_denied) 28804f277b54SJayaprakash Mutyala { 28814f277b54SJayaprakash Mutyala BMCWEB_LOG_WARNING 28824f277b54SJayaprakash Mutyala << "Manufacturing mode is not Enabled...can't " 28834f277b54SJayaprakash Mutyala "Override the sensor value. "; 28844f277b54SJayaprakash Mutyala 28854f277b54SJayaprakash Mutyala messages::insufficientPrivilege( 28868d1b46d7Szhanghch05 sensorAsyncResp->asyncResp->res); 2887413961deSRichard Marian Thomaiyar return; 2888413961deSRichard Marian Thomaiyar } 28894f277b54SJayaprakash Mutyala BMCWEB_LOG_DEBUG 28904f277b54SJayaprakash Mutyala << "setOverrideValueStatus DBUS error: " << ec; 28914f277b54SJayaprakash Mutyala messages::internalError( 28924f277b54SJayaprakash Mutyala sensorAsyncResp->asyncResp->res); 28934f277b54SJayaprakash Mutyala } 2894413961deSRichard Marian Thomaiyar }, 28954f277b54SJayaprakash Mutyala item.second, item.first, "org.freedesktop.DBus.Properties", 28964f277b54SJayaprakash Mutyala "Set", "xyz.openbmc_project.Sensor.Value", "Value", 2897168e20c1SEd Tanous dbus::utility::DbusVariantType(iterator->second.first)); 2898f65af9e8SRichard Marian Thomaiyar } 2899413961deSRichard Marian Thomaiyar }; 2900413961deSRichard Marian Thomaiyar // Get object with connection for the given sensor name 2901413961deSRichard Marian Thomaiyar getObjectsWithConnection(sensorAsyncResp, sensorNames, 2902413961deSRichard Marian Thomaiyar std::move(getObjectsWithConnectionCb)); 2903413961deSRichard Marian Thomaiyar }; 2904413961deSRichard Marian Thomaiyar // get full sensor list for the given chassisId and cross verify the sensor. 2905413961deSRichard Marian Thomaiyar getChassis(sensorAsyncResp, std::move(getChassisSensorListCb)); 2906413961deSRichard Marian Thomaiyar } 2907413961deSRichard Marian Thomaiyar 2908a0ec28b6SAdrian Ambrożewicz /** 2909a0ec28b6SAdrian Ambrożewicz * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus 2910a0ec28b6SAdrian Ambrożewicz * path of the sensor. 2911a0ec28b6SAdrian Ambrożewicz * 2912a0ec28b6SAdrian Ambrożewicz * Function builds valid Redfish response for sensor query of given chassis and 2913a0ec28b6SAdrian Ambrożewicz * node. It then builds metadata about Redfish<->D-Bus correlations and provides 2914a0ec28b6SAdrian Ambrożewicz * it to caller in a callback. 2915a0ec28b6SAdrian Ambrożewicz * 2916a0ec28b6SAdrian Ambrożewicz * @param chassis Chassis for which retrieval should be performed 2917a0ec28b6SAdrian Ambrożewicz * @param node Node (group) of sensors. See sensors::node for supported values 2918a0ec28b6SAdrian Ambrożewicz * @param mapComplete Callback to be called with retrieval result 2919a0ec28b6SAdrian Ambrożewicz */ 2920021d32cfSKrzysztof Grobelny inline void retrieveUriToDbusMap(const std::string& chassis, 2921021d32cfSKrzysztof Grobelny const std::string& node, 2922a0ec28b6SAdrian Ambrożewicz SensorsAsyncResp::DataCompleteCb&& mapComplete) 2923a0ec28b6SAdrian Ambrożewicz { 2924c2bf7f99SWludzik, Jozef auto pathIt = sensors::dbus::paths.find(node); 2925c2bf7f99SWludzik, Jozef if (pathIt == sensors::dbus::paths.end()) 2926a0ec28b6SAdrian Ambrożewicz { 2927a0ec28b6SAdrian Ambrożewicz BMCWEB_LOG_ERROR << "Wrong node provided : " << node; 2928a0ec28b6SAdrian Ambrożewicz mapComplete(boost::beast::http::status::bad_request, {}); 2929a0ec28b6SAdrian Ambrożewicz return; 2930a0ec28b6SAdrian Ambrożewicz } 2931d51e072fSKrzysztof Grobelny 29329062d478SGunnar Mills auto res = std::make_shared<crow::Response>(); 29339062d478SGunnar Mills auto asyncResp = std::make_shared<bmcweb::AsyncResp>(*res); 2934a0ec28b6SAdrian Ambrożewicz auto callback = 29359062d478SGunnar Mills [res, asyncResp, mapCompleteCb{std::move(mapComplete)}]( 2936a0ec28b6SAdrian Ambrożewicz const boost::beast::http::status status, 2937a0ec28b6SAdrian Ambrożewicz const boost::container::flat_map<std::string, std::string>& 2938a0ec28b6SAdrian Ambrożewicz uriToDbus) { mapCompleteCb(status, uriToDbus); }; 2939a0ec28b6SAdrian Ambrożewicz 2940a0ec28b6SAdrian Ambrożewicz auto resp = std::make_shared<SensorsAsyncResp>( 2941d51e072fSKrzysztof Grobelny asyncResp, chassis, pathIt->second, node, std::move(callback)); 2942a0ec28b6SAdrian Ambrożewicz getChassisData(resp); 2943a0ec28b6SAdrian Ambrożewicz } 2944a0ec28b6SAdrian Ambrożewicz 29457e860f15SJohn Edward Broadbent inline void requestRoutesSensorCollection(App& app) 294695a3ecadSAnthony Wilson { 29477e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/") 2948ed398213SEd Tanous .privileges(redfish::privileges::getSensorCollection) 29497e860f15SJohn Edward Broadbent .methods( 29507e860f15SJohn Edward Broadbent boost::beast::http::verb::get)([](const crow::Request&, 29517e860f15SJohn Edward Broadbent const std::shared_ptr< 29527e860f15SJohn Edward Broadbent bmcweb::AsyncResp>& aResp, 29537e860f15SJohn Edward Broadbent const std::string& chassisId) { 295495a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "SensorCollection doGet enter"; 29558d1b46d7Szhanghch05 295695a3ecadSAnthony Wilson std::shared_ptr<SensorsAsyncResp> asyncResp = 2957a0ec28b6SAdrian Ambrożewicz std::make_shared<SensorsAsyncResp>( 29588d1b46d7Szhanghch05 aResp, chassisId, 29598d1b46d7Szhanghch05 sensors::dbus::paths.at(sensors::node::sensors), 2960a0ec28b6SAdrian Ambrożewicz sensors::node::sensors); 296195a3ecadSAnthony Wilson 296295a3ecadSAnthony Wilson auto getChassisCb = 2963b5a76932SEd Tanous [asyncResp]( 29647e860f15SJohn Edward Broadbent const std::shared_ptr< 29657e860f15SJohn Edward Broadbent boost::container::flat_set<std::string>>& sensorNames) { 296695a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb enter"; 296795a3ecadSAnthony Wilson 296895a3ecadSAnthony Wilson nlohmann::json& entriesArray = 29698d1b46d7Szhanghch05 asyncResp->asyncResp->res.jsonValue["Members"]; 297095a3ecadSAnthony Wilson for (auto& sensor : *sensorNames) 297195a3ecadSAnthony Wilson { 297295a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Adding sensor: " << sensor; 297395a3ecadSAnthony Wilson 297428aa8de5SGeorge Liu sdbusplus::message::object_path path(sensor); 297528aa8de5SGeorge Liu std::string sensorName = path.filename(); 297628aa8de5SGeorge Liu if (sensorName.empty()) 297795a3ecadSAnthony Wilson { 29787e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR << "Invalid sensor path: " 29797e860f15SJohn Edward Broadbent << sensor; 29808d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 298195a3ecadSAnthony Wilson return; 298295a3ecadSAnthony Wilson } 298395a3ecadSAnthony Wilson entriesArray.push_back( 29847e860f15SJohn Edward Broadbent {{"@odata.id", "/redfish/v1/Chassis/" + 29857e860f15SJohn Edward Broadbent asyncResp->chassisId + "/" + 29867e860f15SJohn Edward Broadbent asyncResp->chassisSubNode + "/" + 29877e860f15SJohn Edward Broadbent sensorName}}); 298895a3ecadSAnthony Wilson } 298995a3ecadSAnthony Wilson 29908d1b46d7Szhanghch05 asyncResp->asyncResp->res.jsonValue["Members@odata.count"] = 299195a3ecadSAnthony Wilson entriesArray.size(); 299295a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb exit"; 299395a3ecadSAnthony Wilson }; 299495a3ecadSAnthony Wilson 299595a3ecadSAnthony Wilson // Get set of sensors in chassis 299695a3ecadSAnthony Wilson getChassis(asyncResp, std::move(getChassisCb)); 299795a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "SensorCollection doGet exit"; 29987e860f15SJohn Edward Broadbent }); 299995a3ecadSAnthony Wilson } 300095a3ecadSAnthony Wilson 30017e860f15SJohn Edward Broadbent inline void requestRoutesSensor(App& app) 300295a3ecadSAnthony Wilson { 30037e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/") 3004ed398213SEd Tanous .privileges(redfish::privileges::getSensor) 30057e860f15SJohn Edward Broadbent .methods( 30067e860f15SJohn Edward Broadbent boost::beast::http::verb::get)([](const crow::Request&, 30077e860f15SJohn Edward Broadbent const std::shared_ptr< 30087e860f15SJohn Edward Broadbent bmcweb::AsyncResp>& aResp, 30097e860f15SJohn Edward Broadbent const std::string& chassisId, 30107e860f15SJohn Edward Broadbent const std::string& sensorName) { 301195a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Sensor doGet enter"; 301295a3ecadSAnthony Wilson std::shared_ptr<SensorsAsyncResp> asyncResp = 30138d1b46d7Szhanghch05 std::make_shared<SensorsAsyncResp>(aResp, chassisId, 3014a0ec28b6SAdrian Ambrożewicz std::vector<const char*>(), 3015a0ec28b6SAdrian Ambrożewicz sensors::node::sensors); 301695a3ecadSAnthony Wilson 301795a3ecadSAnthony Wilson const std::array<const char*, 1> interfaces = { 301895a3ecadSAnthony Wilson "xyz.openbmc_project.Sensor.Value"}; 301995a3ecadSAnthony Wilson 302095a3ecadSAnthony Wilson // Get a list of all of the sensors that implement Sensor.Value 302195a3ecadSAnthony Wilson // and get the path and service name associated with the sensor 302295a3ecadSAnthony Wilson crow::connections::systemBus->async_method_call( 302395a3ecadSAnthony Wilson [asyncResp, sensorName](const boost::system::error_code ec, 302495a3ecadSAnthony Wilson const GetSubTreeType& subtree) { 302595a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "respHandler1 enter"; 302695a3ecadSAnthony Wilson if (ec) 302795a3ecadSAnthony Wilson { 30288d1b46d7Szhanghch05 messages::internalError(asyncResp->asyncResp->res); 30297e860f15SJohn Edward Broadbent BMCWEB_LOG_ERROR 30307e860f15SJohn Edward Broadbent << "Sensor getSensorPaths resp_handler: " 303195a3ecadSAnthony Wilson << "Dbus error " << ec; 303295a3ecadSAnthony Wilson return; 303395a3ecadSAnthony Wilson } 303495a3ecadSAnthony Wilson 303595a3ecadSAnthony Wilson GetSubTreeType::const_iterator it = std::find_if( 303695a3ecadSAnthony Wilson subtree.begin(), subtree.end(), 303795a3ecadSAnthony Wilson [sensorName]( 303895a3ecadSAnthony Wilson const std::pair< 303995a3ecadSAnthony Wilson std::string, 30407e860f15SJohn Edward Broadbent std::vector<std::pair< 30417e860f15SJohn Edward Broadbent std::string, std::vector<std::string>>>>& 304295a3ecadSAnthony Wilson object) { 304328aa8de5SGeorge Liu sdbusplus::message::object_path path(object.first); 304428aa8de5SGeorge Liu std::string name = path.filename(); 304528aa8de5SGeorge Liu if (name.empty()) 304695a3ecadSAnthony Wilson { 304795a3ecadSAnthony Wilson BMCWEB_LOG_ERROR << "Invalid sensor path: " 304828aa8de5SGeorge Liu << object.first; 304995a3ecadSAnthony Wilson return false; 305095a3ecadSAnthony Wilson } 305195a3ecadSAnthony Wilson 305295a3ecadSAnthony Wilson return name == sensorName; 305395a3ecadSAnthony Wilson }); 305495a3ecadSAnthony Wilson 305595a3ecadSAnthony Wilson if (it == subtree.end()) 305695a3ecadSAnthony Wilson { 305795a3ecadSAnthony Wilson BMCWEB_LOG_ERROR << "Could not find path for sensor: " 305895a3ecadSAnthony Wilson << sensorName; 30598d1b46d7Szhanghch05 messages::resourceNotFound(asyncResp->asyncResp->res, 30608d1b46d7Szhanghch05 "Sensor", sensorName); 306195a3ecadSAnthony Wilson return; 306295a3ecadSAnthony Wilson } 306395a3ecadSAnthony Wilson std::string_view sensorPath = (*it).first; 306495a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "Found sensor path for sensor '" 306595a3ecadSAnthony Wilson << sensorName << "': " << sensorPath; 306695a3ecadSAnthony Wilson 30677e860f15SJohn Edward Broadbent const std::shared_ptr< 30687e860f15SJohn Edward Broadbent boost::container::flat_set<std::string>> 306995a3ecadSAnthony Wilson sensorList = std::make_shared< 307095a3ecadSAnthony Wilson boost::container::flat_set<std::string>>(); 307195a3ecadSAnthony Wilson 307295a3ecadSAnthony Wilson sensorList->emplace(sensorPath); 307395a3ecadSAnthony Wilson processSensorList(asyncResp, sensorList); 307495a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "respHandler1 exit"; 307595a3ecadSAnthony Wilson }, 307695a3ecadSAnthony Wilson "xyz.openbmc_project.ObjectMapper", 307795a3ecadSAnthony Wilson "/xyz/openbmc_project/object_mapper", 307895a3ecadSAnthony Wilson "xyz.openbmc_project.ObjectMapper", "GetSubTree", 307995a3ecadSAnthony Wilson "/xyz/openbmc_project/sensors", 2, interfaces); 30807e860f15SJohn Edward Broadbent }); 308195a3ecadSAnthony Wilson } 308295a3ecadSAnthony Wilson 308308777fb0SLewanczyk, Dawid } // namespace redfish 3084