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> 1911ba3979SEd Tanous #include <boost/algorithm/string/classification.hpp> 20*1d7c0054SEd Tanous #include <boost/algorithm/string/find.hpp> 21*1d7c0054SEd Tanous #include <boost/algorithm/string/predicate.hpp> 2208777fb0SLewanczyk, Dawid #include <boost/algorithm/string/split.hpp> 2308777fb0SLewanczyk, Dawid #include <boost/range/algorithm/replace_copy_if.hpp> 241abe55efSEd Tanous #include <dbus_singleton.hpp> 25168e20c1SEd Tanous #include <dbus_utility.hpp> 2645ca1b86SEd Tanous #include <query.hpp> 27ed398213SEd Tanous #include <registries/privilege_registry.hpp> 281e1e598dSJonathan Doman #include <sdbusplus/asio/property.hpp> 2986d89ed7SKrzysztof Grobelny #include <sdbusplus/unpack_properties.hpp> 3086d89ed7SKrzysztof Grobelny #include <utils/dbus_utils.hpp> 31413961deSRichard Marian Thomaiyar #include <utils/json_utils.hpp> 32928fefb9SNan Zhou #include <utils/query_param.hpp> 331214b7e7SGunnar Mills 341214b7e7SGunnar Mills #include <cmath> 35fe04d49cSNan Zhou #include <iterator> 36fe04d49cSNan Zhou #include <map> 37fe04d49cSNan Zhou #include <set> 38b5a76932SEd Tanous #include <utility> 39abf2add6SEd Tanous #include <variant> 4008777fb0SLewanczyk, Dawid 411abe55efSEd Tanous namespace redfish 421abe55efSEd Tanous { 4308777fb0SLewanczyk, Dawid 44a0ec28b6SAdrian Ambrożewicz namespace sensors 45a0ec28b6SAdrian Ambrożewicz { 46a0ec28b6SAdrian Ambrożewicz namespace node 47a0ec28b6SAdrian Ambrożewicz { 48a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view power = "Power"; 49a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view sensors = "Sensors"; 50a0ec28b6SAdrian Ambrożewicz static constexpr std::string_view thermal = "Thermal"; 51a0ec28b6SAdrian Ambrożewicz } // namespace node 52a0ec28b6SAdrian Ambrożewicz 5302da7c5aSEd Tanous // clang-format off 54a0ec28b6SAdrian Ambrożewicz namespace dbus 55a0ec28b6SAdrian Ambrożewicz { 564ee8e211SEd Tanous static auto powerPaths = std::to_array<std::string_view>({ 5702da7c5aSEd Tanous "/xyz/openbmc_project/sensors/voltage", 5802da7c5aSEd Tanous "/xyz/openbmc_project/sensors/power" 5902da7c5aSEd Tanous }); 60c2bf7f99SWludzik, Jozef 614ee8e211SEd Tanous static auto sensorPaths = std::to_array<std::string_view>({ 6202da7c5aSEd Tanous "/xyz/openbmc_project/sensors/power", 63a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/current", 647088690cSBasheer Ahmed Muddebihal "/xyz/openbmc_project/sensors/airflow", 655deabed9SGunnar Mills "/xyz/openbmc_project/sensors/humidity", 66e8204933SGeorge Liu #ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM 67e8204933SGeorge Liu "/xyz/openbmc_project/sensors/voltage", 68e8204933SGeorge Liu "/xyz/openbmc_project/sensors/fan_tach", 69e8204933SGeorge Liu "/xyz/openbmc_project/sensors/temperature", 70e8204933SGeorge Liu "/xyz/openbmc_project/sensors/fan_pwm", 71e8204933SGeorge Liu "/xyz/openbmc_project/sensors/altitude", 72e8204933SGeorge Liu "/xyz/openbmc_project/sensors/energy", 73e8204933SGeorge Liu #endif 7402da7c5aSEd Tanous "/xyz/openbmc_project/sensors/utilization" 7502da7c5aSEd Tanous }); 7602da7c5aSEd Tanous 774ee8e211SEd Tanous static auto thermalPaths = std::to_array<std::string_view>({ 7802da7c5aSEd Tanous "/xyz/openbmc_project/sensors/fan_tach", 79a0ec28b6SAdrian Ambrożewicz "/xyz/openbmc_project/sensors/temperature", 8002da7c5aSEd Tanous "/xyz/openbmc_project/sensors/fan_pwm" 8102da7c5aSEd Tanous }); 8202da7c5aSEd Tanous 83c2bf7f99SWludzik, Jozef } // namespace dbus 8402da7c5aSEd Tanous // clang-format on 8502da7c5aSEd Tanous 8602da7c5aSEd Tanous using sensorPair = std::pair<std::string_view, std::span<std::string_view>>; 8702da7c5aSEd Tanous static constexpr std::array<sensorPair, 3> paths = { 8802da7c5aSEd Tanous {{node::power, std::span<std::string_view>(dbus::powerPaths)}, 8902da7c5aSEd Tanous {node::sensors, std::span<std::string_view>(dbus::sensorPaths)}, 9002da7c5aSEd Tanous {node::thermal, std::span<std::string_view>(dbus::thermalPaths)}}}; 91c2bf7f99SWludzik, Jozef 92*1d7c0054SEd Tanous inline std::string_view toReadingType(std::string_view sensorType) 93c2bf7f99SWludzik, Jozef { 94c2bf7f99SWludzik, Jozef if (sensorType == "voltage") 95c2bf7f99SWludzik, Jozef { 96c2bf7f99SWludzik, Jozef return "Voltage"; 97c2bf7f99SWludzik, Jozef } 98c2bf7f99SWludzik, Jozef if (sensorType == "power") 99c2bf7f99SWludzik, Jozef { 100c2bf7f99SWludzik, Jozef return "Power"; 101c2bf7f99SWludzik, Jozef } 102c2bf7f99SWludzik, Jozef if (sensorType == "current") 103c2bf7f99SWludzik, Jozef { 104c2bf7f99SWludzik, Jozef return "Current"; 105c2bf7f99SWludzik, Jozef } 106c2bf7f99SWludzik, Jozef if (sensorType == "fan_tach") 107c2bf7f99SWludzik, Jozef { 108c2bf7f99SWludzik, Jozef return "Rotational"; 109c2bf7f99SWludzik, Jozef } 110c2bf7f99SWludzik, Jozef if (sensorType == "temperature") 111c2bf7f99SWludzik, Jozef { 112c2bf7f99SWludzik, Jozef return "Temperature"; 113c2bf7f99SWludzik, Jozef } 114c2bf7f99SWludzik, Jozef if (sensorType == "fan_pwm" || sensorType == "utilization") 115c2bf7f99SWludzik, Jozef { 116c2bf7f99SWludzik, Jozef return "Percent"; 117c2bf7f99SWludzik, Jozef } 1185deabed9SGunnar Mills if (sensorType == "humidity") 1195deabed9SGunnar Mills { 1205deabed9SGunnar Mills return "Humidity"; 1215deabed9SGunnar Mills } 122c2bf7f99SWludzik, Jozef if (sensorType == "altitude") 123c2bf7f99SWludzik, Jozef { 124c2bf7f99SWludzik, Jozef return "Altitude"; 125c2bf7f99SWludzik, Jozef } 126c2bf7f99SWludzik, Jozef if (sensorType == "airflow") 127c2bf7f99SWludzik, Jozef { 128c2bf7f99SWludzik, Jozef return "AirFlow"; 129c2bf7f99SWludzik, Jozef } 130c2bf7f99SWludzik, Jozef if (sensorType == "energy") 131c2bf7f99SWludzik, Jozef { 132c2bf7f99SWludzik, Jozef return "EnergyJoules"; 133c2bf7f99SWludzik, Jozef } 134c2bf7f99SWludzik, Jozef return ""; 135c2bf7f99SWludzik, Jozef } 136c2bf7f99SWludzik, Jozef 137*1d7c0054SEd Tanous inline std::string_view toReadingUnits(std::string_view sensorType) 138c2bf7f99SWludzik, Jozef { 139c2bf7f99SWludzik, Jozef if (sensorType == "voltage") 140c2bf7f99SWludzik, Jozef { 141c2bf7f99SWludzik, Jozef return "V"; 142c2bf7f99SWludzik, Jozef } 143c2bf7f99SWludzik, Jozef if (sensorType == "power") 144c2bf7f99SWludzik, Jozef { 145c2bf7f99SWludzik, Jozef return "W"; 146c2bf7f99SWludzik, Jozef } 147c2bf7f99SWludzik, Jozef if (sensorType == "current") 148c2bf7f99SWludzik, Jozef { 149c2bf7f99SWludzik, Jozef return "A"; 150c2bf7f99SWludzik, Jozef } 151c2bf7f99SWludzik, Jozef if (sensorType == "fan_tach") 152c2bf7f99SWludzik, Jozef { 153c2bf7f99SWludzik, Jozef return "RPM"; 154c2bf7f99SWludzik, Jozef } 155c2bf7f99SWludzik, Jozef if (sensorType == "temperature") 156c2bf7f99SWludzik, Jozef { 157c2bf7f99SWludzik, Jozef return "Cel"; 158c2bf7f99SWludzik, Jozef } 1595deabed9SGunnar Mills if (sensorType == "fan_pwm" || sensorType == "utilization" || 1605deabed9SGunnar Mills sensorType == "humidity") 161c2bf7f99SWludzik, Jozef { 162c2bf7f99SWludzik, Jozef return "%"; 163c2bf7f99SWludzik, Jozef } 164c2bf7f99SWludzik, Jozef if (sensorType == "altitude") 165c2bf7f99SWludzik, Jozef { 166c2bf7f99SWludzik, Jozef return "m"; 167c2bf7f99SWludzik, Jozef } 168c2bf7f99SWludzik, Jozef if (sensorType == "airflow") 169c2bf7f99SWludzik, Jozef { 170c2bf7f99SWludzik, Jozef return "cft_i/min"; 171c2bf7f99SWludzik, Jozef } 172c2bf7f99SWludzik, Jozef if (sensorType == "energy") 173c2bf7f99SWludzik, Jozef { 174c2bf7f99SWludzik, Jozef return "J"; 175c2bf7f99SWludzik, Jozef } 176c2bf7f99SWludzik, Jozef return ""; 177a0ec28b6SAdrian Ambrożewicz } 178a0ec28b6SAdrian Ambrożewicz } // namespace sensors 179a0ec28b6SAdrian Ambrożewicz 18008777fb0SLewanczyk, Dawid /** 181588c3f0dSKowalski, Kamil * SensorsAsyncResp 18208777fb0SLewanczyk, Dawid * Gathers data needed for response processing after async calls are done 18308777fb0SLewanczyk, Dawid */ 1841abe55efSEd Tanous class SensorsAsyncResp 1851abe55efSEd Tanous { 18608777fb0SLewanczyk, Dawid public: 187a0ec28b6SAdrian Ambrożewicz using DataCompleteCb = std::function<void( 188a0ec28b6SAdrian Ambrożewicz const boost::beast::http::status status, 189fe04d49cSNan Zhou const std::map<std::string, std::string>& uriToDbus)>; 190a0ec28b6SAdrian Ambrożewicz 191a0ec28b6SAdrian Ambrożewicz struct SensorData 192a0ec28b6SAdrian Ambrożewicz { 193a0ec28b6SAdrian Ambrożewicz const std::string name; 194a0ec28b6SAdrian Ambrożewicz std::string uri; 195a0ec28b6SAdrian Ambrożewicz const std::string valueKey; 196a0ec28b6SAdrian Ambrożewicz const std::string dbusPath; 197a0ec28b6SAdrian Ambrożewicz }; 198a0ec28b6SAdrian Ambrożewicz 1998a592810SEd Tanous SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn, 2008d1b46d7Szhanghch05 const std::string& chassisIdIn, 20102da7c5aSEd Tanous std::span<std::string_view> typesIn, 20202da7c5aSEd Tanous std::string_view subNode) : 2038a592810SEd Tanous asyncResp(asyncRespIn), 204928fefb9SNan Zhou chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode), 205928fefb9SNan Zhou efficientExpand(false) 2061214b7e7SGunnar Mills {} 20708777fb0SLewanczyk, Dawid 208a0ec28b6SAdrian Ambrożewicz // Store extra data about sensor mapping and return it in callback 2098a592810SEd Tanous SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn, 2108d1b46d7Szhanghch05 const std::string& chassisIdIn, 21102da7c5aSEd Tanous std::span<std::string_view> typesIn, 21202da7c5aSEd Tanous std::string_view subNode, 213a0ec28b6SAdrian Ambrożewicz DataCompleteCb&& creationComplete) : 2148a592810SEd Tanous asyncResp(asyncRespIn), 215928fefb9SNan Zhou chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode), 216928fefb9SNan Zhou efficientExpand(false), metadata{std::vector<SensorData>()}, 217a0ec28b6SAdrian Ambrożewicz dataComplete{std::move(creationComplete)} 218a0ec28b6SAdrian Ambrożewicz {} 219a0ec28b6SAdrian Ambrożewicz 220928fefb9SNan Zhou // sensor collections expand 2218a592810SEd Tanous SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn, 222928fefb9SNan Zhou const std::string& chassisIdIn, 22302da7c5aSEd Tanous const std::span<std::string_view> typesIn, 2248a592810SEd Tanous const std::string_view& subNode, bool efficientExpandIn) : 2258a592810SEd Tanous asyncResp(asyncRespIn), 226928fefb9SNan Zhou chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode), 2278a592810SEd Tanous efficientExpand(efficientExpandIn) 228928fefb9SNan Zhou {} 229928fefb9SNan Zhou 2301abe55efSEd Tanous ~SensorsAsyncResp() 2311abe55efSEd Tanous { 2328d1b46d7Szhanghch05 if (asyncResp->res.result() == 2338d1b46d7Szhanghch05 boost::beast::http::status::internal_server_error) 2341abe55efSEd Tanous { 2351abe55efSEd Tanous // Reset the json object to clear out any data that made it in 2361abe55efSEd Tanous // before the error happened todo(ed) handle error condition with 2371abe55efSEd Tanous // proper code 2388d1b46d7Szhanghch05 asyncResp->res.jsonValue = nlohmann::json::object(); 23908777fb0SLewanczyk, Dawid } 240a0ec28b6SAdrian Ambrożewicz 241a0ec28b6SAdrian Ambrożewicz if (dataComplete && metadata) 242a0ec28b6SAdrian Ambrożewicz { 243fe04d49cSNan Zhou std::map<std::string, std::string> map; 2448d1b46d7Szhanghch05 if (asyncResp->res.result() == boost::beast::http::status::ok) 245a0ec28b6SAdrian Ambrożewicz { 246a0ec28b6SAdrian Ambrożewicz for (auto& sensor : *metadata) 247a0ec28b6SAdrian Ambrożewicz { 248a0ec28b6SAdrian Ambrożewicz map.insert(std::make_pair(sensor.uri + sensor.valueKey, 249a0ec28b6SAdrian Ambrożewicz sensor.dbusPath)); 250a0ec28b6SAdrian Ambrożewicz } 251a0ec28b6SAdrian Ambrożewicz } 2528d1b46d7Szhanghch05 dataComplete(asyncResp->res.result(), map); 253a0ec28b6SAdrian Ambrożewicz } 25408777fb0SLewanczyk, Dawid } 255588c3f0dSKowalski, Kamil 256ecd6a3a2SEd Tanous SensorsAsyncResp(const SensorsAsyncResp&) = delete; 257ecd6a3a2SEd Tanous SensorsAsyncResp(SensorsAsyncResp&&) = delete; 258ecd6a3a2SEd Tanous SensorsAsyncResp& operator=(const SensorsAsyncResp&) = delete; 259ecd6a3a2SEd Tanous SensorsAsyncResp& operator=(SensorsAsyncResp&&) = delete; 260ecd6a3a2SEd Tanous 261a0ec28b6SAdrian Ambrożewicz void addMetadata(const nlohmann::json& sensorObject, 262a0ec28b6SAdrian Ambrożewicz const std::string& valueKey, const std::string& dbusPath) 263a0ec28b6SAdrian Ambrożewicz { 264a0ec28b6SAdrian Ambrożewicz if (metadata) 265a0ec28b6SAdrian Ambrożewicz { 266a0ec28b6SAdrian Ambrożewicz metadata->emplace_back(SensorData{sensorObject["Name"], 267a0ec28b6SAdrian Ambrożewicz sensorObject["@odata.id"], 268a0ec28b6SAdrian Ambrożewicz valueKey, dbusPath}); 269a0ec28b6SAdrian Ambrożewicz } 270a0ec28b6SAdrian Ambrożewicz } 271a0ec28b6SAdrian Ambrożewicz 272a0ec28b6SAdrian Ambrożewicz void updateUri(const std::string& name, const std::string& uri) 273a0ec28b6SAdrian Ambrożewicz { 274a0ec28b6SAdrian Ambrożewicz if (metadata) 275a0ec28b6SAdrian Ambrożewicz { 276a0ec28b6SAdrian Ambrożewicz for (auto& sensor : *metadata) 277a0ec28b6SAdrian Ambrożewicz { 278a0ec28b6SAdrian Ambrożewicz if (sensor.name == name) 279a0ec28b6SAdrian Ambrożewicz { 280a0ec28b6SAdrian Ambrożewicz sensor.uri = uri; 281a0ec28b6SAdrian Ambrożewicz } 282a0ec28b6SAdrian Ambrożewicz } 283a0ec28b6SAdrian Ambrożewicz } 284a0ec28b6SAdrian Ambrożewicz } 285a0ec28b6SAdrian Ambrożewicz 2868d1b46d7Szhanghch05 const std::shared_ptr<bmcweb::AsyncResp> asyncResp; 287a0ec28b6SAdrian Ambrożewicz const std::string chassisId; 28802da7c5aSEd Tanous const std::span<std::string_view> types; 289a0ec28b6SAdrian Ambrożewicz const std::string chassisSubNode; 290928fefb9SNan Zhou const bool efficientExpand; 291a0ec28b6SAdrian Ambrożewicz 292a0ec28b6SAdrian Ambrożewicz private: 293a0ec28b6SAdrian Ambrożewicz std::optional<std::vector<SensorData>> metadata; 294a0ec28b6SAdrian Ambrożewicz DataCompleteCb dataComplete; 29508777fb0SLewanczyk, Dawid }; 29608777fb0SLewanczyk, Dawid 29708777fb0SLewanczyk, Dawid /** 298d500549bSAnthony Wilson * Possible states for physical inventory leds 299d500549bSAnthony Wilson */ 300d500549bSAnthony Wilson enum class LedState 301d500549bSAnthony Wilson { 302d500549bSAnthony Wilson OFF, 303d500549bSAnthony Wilson ON, 304d500549bSAnthony Wilson BLINK, 305d500549bSAnthony Wilson UNKNOWN 306d500549bSAnthony Wilson }; 307d500549bSAnthony Wilson 308d500549bSAnthony Wilson /** 309adc4f0dbSShawn McCarney * D-Bus inventory item associated with one or more sensors. 310adc4f0dbSShawn McCarney */ 311adc4f0dbSShawn McCarney class InventoryItem 312adc4f0dbSShawn McCarney { 313adc4f0dbSShawn McCarney public: 3144e23a444SEd Tanous explicit InventoryItem(const std::string& objPath) : objectPath(objPath) 315adc4f0dbSShawn McCarney { 316adc4f0dbSShawn McCarney // Set inventory item name to last node of object path 31728aa8de5SGeorge Liu sdbusplus::message::object_path path(objectPath); 31828aa8de5SGeorge Liu name = path.filename(); 31928aa8de5SGeorge Liu if (name.empty()) 320adc4f0dbSShawn McCarney { 32128aa8de5SGeorge Liu BMCWEB_LOG_ERROR << "Failed to find '/' in " << objectPath; 322adc4f0dbSShawn McCarney } 323adc4f0dbSShawn McCarney } 324adc4f0dbSShawn McCarney 325adc4f0dbSShawn McCarney std::string objectPath; 326adc4f0dbSShawn McCarney std::string name; 327e05aec50SEd Tanous bool isPresent = true; 328e05aec50SEd Tanous bool isFunctional = true; 329e05aec50SEd Tanous bool isPowerSupply = false; 330e05aec50SEd Tanous int powerSupplyEfficiencyPercent = -1; 331adc4f0dbSShawn McCarney std::string manufacturer; 332adc4f0dbSShawn McCarney std::string model; 333adc4f0dbSShawn McCarney std::string partNumber; 334adc4f0dbSShawn McCarney std::string serialNumber; 335adc4f0dbSShawn McCarney std::set<std::string> sensors; 336d500549bSAnthony Wilson std::string ledObjectPath; 337e05aec50SEd Tanous LedState ledState = LedState::UNKNOWN; 338adc4f0dbSShawn McCarney }; 339adc4f0dbSShawn McCarney 340adc4f0dbSShawn McCarney /** 341413961deSRichard Marian Thomaiyar * @brief Get objects with connection necessary for sensors 342588c3f0dSKowalski, Kamil * @param SensorsAsyncResp Pointer to object holding response data 34308777fb0SLewanczyk, Dawid * @param sensorNames Sensors retrieved from chassis 34408777fb0SLewanczyk, Dawid * @param callback Callback for processing gathered connections 34508777fb0SLewanczyk, Dawid */ 34608777fb0SLewanczyk, Dawid template <typename Callback> 347413961deSRichard Marian Thomaiyar void getObjectsWithConnection( 34881ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 349fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>>& sensorNames, 3501abe55efSEd Tanous Callback&& callback) 3511abe55efSEd Tanous { 352413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection enter"; 35303b5bae3SJames Feist const std::string path = "/xyz/openbmc_project/sensors"; 35408777fb0SLewanczyk, Dawid const std::array<std::string, 1> interfaces = { 35508777fb0SLewanczyk, Dawid "xyz.openbmc_project.Sensor.Value"}; 35608777fb0SLewanczyk, Dawid 35708777fb0SLewanczyk, Dawid // Response handler for parsing objects subtree 358002d39b4SEd Tanous auto respHandler = 359002d39b4SEd Tanous [callback{std::forward<Callback>(callback)}, sensorsAsyncResp, 360002d39b4SEd Tanous sensorNames](const boost::system::error_code ec, 361002d39b4SEd Tanous const dbus::utility::MapperGetSubTreeResponse& subtree) { 362413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler enter"; 3631abe55efSEd Tanous if (ec) 3641abe55efSEd Tanous { 3658d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 366413961deSRichard Marian Thomaiyar BMCWEB_LOG_ERROR 367413961deSRichard Marian Thomaiyar << "getObjectsWithConnection resp_handler: Dbus error " << ec; 36808777fb0SLewanczyk, Dawid return; 36908777fb0SLewanczyk, Dawid } 37008777fb0SLewanczyk, Dawid 37155c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Found " << subtree.size() << " subtrees"; 37208777fb0SLewanczyk, Dawid 37308777fb0SLewanczyk, Dawid // Make unique list of connections only for requested sensor types and 37408777fb0SLewanczyk, Dawid // found in the chassis 375fe04d49cSNan Zhou std::set<std::string> connections; 376413961deSRichard Marian Thomaiyar std::set<std::pair<std::string, std::string>> objectsWithConnection; 37708777fb0SLewanczyk, Dawid 37849c53ac9SJohnathan Mantey BMCWEB_LOG_DEBUG << "sensorNames list count: " << sensorNames->size(); 37949c53ac9SJohnathan Mantey for (const std::string& tsensor : *sensorNames) 3801abe55efSEd Tanous { 38155c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Sensor to find: " << tsensor; 38208777fb0SLewanczyk, Dawid } 38308777fb0SLewanczyk, Dawid 38408777fb0SLewanczyk, Dawid for (const std::pair< 38508777fb0SLewanczyk, Dawid std::string, 38608777fb0SLewanczyk, Dawid std::vector<std::pair<std::string, std::vector<std::string>>>>& 3871abe55efSEd Tanous object : subtree) 3881abe55efSEd Tanous { 38949c53ac9SJohnathan Mantey if (sensorNames->find(object.first) != sensorNames->end()) 3901abe55efSEd Tanous { 39149c53ac9SJohnathan Mantey for (const std::pair<std::string, std::vector<std::string>>& 3921abe55efSEd Tanous objData : object.second) 3931abe55efSEd Tanous { 39449c53ac9SJohnathan Mantey BMCWEB_LOG_DEBUG << "Adding connection: " << objData.first; 39508777fb0SLewanczyk, Dawid connections.insert(objData.first); 396de629b6eSShawn McCarney objectsWithConnection.insert( 397de629b6eSShawn McCarney std::make_pair(object.first, objData.first)); 39808777fb0SLewanczyk, Dawid } 39908777fb0SLewanczyk, Dawid } 40008777fb0SLewanczyk, Dawid } 40155c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Found " << connections.size() << " connections"; 402413961deSRichard Marian Thomaiyar callback(std::move(connections), std::move(objectsWithConnection)); 403413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler exit"; 40408777fb0SLewanczyk, Dawid }; 40508777fb0SLewanczyk, Dawid // Make call to ObjectMapper to find all sensors objects 40655c7b7a2SEd Tanous crow::connections::systemBus->async_method_call( 40755c7b7a2SEd Tanous std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 4081abe55efSEd Tanous "/xyz/openbmc_project/object_mapper", 4091abe55efSEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 2, interfaces); 410413961deSRichard Marian Thomaiyar BMCWEB_LOG_DEBUG << "getObjectsWithConnection exit"; 411413961deSRichard Marian Thomaiyar } 412413961deSRichard Marian Thomaiyar 413413961deSRichard Marian Thomaiyar /** 414413961deSRichard Marian Thomaiyar * @brief Create connections necessary for sensors 415413961deSRichard Marian Thomaiyar * @param SensorsAsyncResp Pointer to object holding response data 416413961deSRichard Marian Thomaiyar * @param sensorNames Sensors retrieved from chassis 417413961deSRichard Marian Thomaiyar * @param callback Callback for processing gathered connections 418413961deSRichard Marian Thomaiyar */ 419413961deSRichard Marian Thomaiyar template <typename Callback> 420fe04d49cSNan Zhou void getConnections(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 421fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>> sensorNames, 422413961deSRichard Marian Thomaiyar Callback&& callback) 423413961deSRichard Marian Thomaiyar { 424413961deSRichard Marian Thomaiyar auto objectsWithConnectionCb = 425fe04d49cSNan Zhou [callback](const std::set<std::string>& connections, 426413961deSRichard Marian Thomaiyar const std::set<std::pair<std::string, std::string>>& 4273174e4dfSEd Tanous /*objectsWithConnection*/) { callback(connections); }; 42881ce609eSEd Tanous getObjectsWithConnection(sensorsAsyncResp, sensorNames, 429413961deSRichard Marian Thomaiyar std::move(objectsWithConnectionCb)); 43008777fb0SLewanczyk, Dawid } 43108777fb0SLewanczyk, Dawid 43208777fb0SLewanczyk, Dawid /** 43349c53ac9SJohnathan Mantey * @brief Shrinks the list of sensors for processing 43449c53ac9SJohnathan Mantey * @param SensorsAysncResp The class holding the Redfish response 43549c53ac9SJohnathan Mantey * @param allSensors A list of all the sensors associated to the 43649c53ac9SJohnathan Mantey * chassis element (i.e. baseboard, front panel, etc...) 43749c53ac9SJohnathan Mantey * @param activeSensors A list that is a reduction of the incoming 43849c53ac9SJohnathan Mantey * allSensors list. Eliminate Thermal sensors when a Power request is 43949c53ac9SJohnathan Mantey * made, and eliminate Power sensors when a Thermal request is made. 44049c53ac9SJohnathan Mantey */ 44123a21a1cSEd Tanous inline void reduceSensorList( 44281ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 44349c53ac9SJohnathan Mantey const std::vector<std::string>* allSensors, 444fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>>& activeSensors) 44549c53ac9SJohnathan Mantey { 44681ce609eSEd Tanous if (sensorsAsyncResp == nullptr) 44749c53ac9SJohnathan Mantey { 44849c53ac9SJohnathan Mantey return; 44949c53ac9SJohnathan Mantey } 45049c53ac9SJohnathan Mantey if ((allSensors == nullptr) || (activeSensors == nullptr)) 45149c53ac9SJohnathan Mantey { 45249c53ac9SJohnathan Mantey messages::resourceNotFound( 4538d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res, sensorsAsyncResp->chassisSubNode, 45481ce609eSEd Tanous sensorsAsyncResp->chassisSubNode == sensors::node::thermal 455a0ec28b6SAdrian Ambrożewicz ? "Temperatures" 45649c53ac9SJohnathan Mantey : "Voltages"); 45749c53ac9SJohnathan Mantey 45849c53ac9SJohnathan Mantey return; 45949c53ac9SJohnathan Mantey } 46049c53ac9SJohnathan Mantey if (allSensors->empty()) 46149c53ac9SJohnathan Mantey { 46249c53ac9SJohnathan Mantey // Nothing to do, the activeSensors object is also empty 46349c53ac9SJohnathan Mantey return; 46449c53ac9SJohnathan Mantey } 46549c53ac9SJohnathan Mantey 46602da7c5aSEd Tanous for (std::string_view type : sensorsAsyncResp->types) 46749c53ac9SJohnathan Mantey { 46849c53ac9SJohnathan Mantey for (const std::string& sensor : *allSensors) 46949c53ac9SJohnathan Mantey { 47011ba3979SEd Tanous if (sensor.starts_with(type)) 47149c53ac9SJohnathan Mantey { 47249c53ac9SJohnathan Mantey activeSensors->emplace(sensor); 47349c53ac9SJohnathan Mantey } 47449c53ac9SJohnathan Mantey } 47549c53ac9SJohnathan Mantey } 47649c53ac9SJohnathan Mantey } 47749c53ac9SJohnathan Mantey 47849c53ac9SJohnathan Mantey /** 47908777fb0SLewanczyk, Dawid * @brief Retrieves requested chassis sensors and redundancy data from DBus . 480588c3f0dSKowalski, Kamil * @param SensorsAsyncResp Pointer to object holding response data 48108777fb0SLewanczyk, Dawid * @param callback Callback for next step in gathered sensor processing 48208777fb0SLewanczyk, Dawid */ 48308777fb0SLewanczyk, Dawid template <typename Callback> 484b5a76932SEd Tanous void getChassis(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 4851abe55efSEd Tanous Callback&& callback) 4861abe55efSEd Tanous { 48755c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis enter"; 488adc4f0dbSShawn McCarney const std::array<const char*, 2> interfaces = { 48949c53ac9SJohnathan Mantey "xyz.openbmc_project.Inventory.Item.Board", 490adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Item.Chassis"}; 491002d39b4SEd Tanous auto respHandler = 492002d39b4SEd Tanous [callback{std::forward<Callback>(callback)}, sensorsAsyncResp]( 49349c53ac9SJohnathan Mantey const boost::system::error_code ec, 494002d39b4SEd Tanous const dbus::utility::MapperGetSubTreePathsResponse& chassisPaths) { 49555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis respHandler enter"; 4961abe55efSEd Tanous if (ec) 4971abe55efSEd Tanous { 49855c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "getChassis respHandler DBUS error: " << ec; 4998d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 50008777fb0SLewanczyk, Dawid return; 50108777fb0SLewanczyk, Dawid } 50208777fb0SLewanczyk, Dawid 50349c53ac9SJohnathan Mantey const std::string* chassisPath = nullptr; 50449c53ac9SJohnathan Mantey std::string chassisName; 50549c53ac9SJohnathan Mantey for (const std::string& chassis : chassisPaths) 5061abe55efSEd Tanous { 50728aa8de5SGeorge Liu sdbusplus::message::object_path path(chassis); 50828aa8de5SGeorge Liu chassisName = path.filename(); 50928aa8de5SGeorge Liu if (chassisName.empty()) 5101abe55efSEd Tanous { 51149c53ac9SJohnathan Mantey BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis; 512daf36e2eSEd Tanous continue; 513daf36e2eSEd Tanous } 51449c53ac9SJohnathan Mantey if (chassisName == sensorsAsyncResp->chassisId) 5151abe55efSEd Tanous { 51649c53ac9SJohnathan Mantey chassisPath = &chassis; 51749c53ac9SJohnathan Mantey break; 518daf36e2eSEd Tanous } 51949c53ac9SJohnathan Mantey } 52049c53ac9SJohnathan Mantey if (chassisPath == nullptr) 5211abe55efSEd Tanous { 5228d1b46d7Szhanghch05 messages::resourceNotFound(sensorsAsyncResp->asyncResp->res, 5238d1b46d7Szhanghch05 "Chassis", sensorsAsyncResp->chassisId); 52449c53ac9SJohnathan Mantey return; 5251abe55efSEd Tanous } 52608777fb0SLewanczyk, Dawid 52749c53ac9SJohnathan Mantey const std::string& chassisSubNode = sensorsAsyncResp->chassisSubNode; 528a0ec28b6SAdrian Ambrożewicz if (chassisSubNode == sensors::node::power) 52949c53ac9SJohnathan Mantey { 5308d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 53149c53ac9SJohnathan Mantey "#Power.v1_5_2.Power"; 53249c53ac9SJohnathan Mantey } 533a0ec28b6SAdrian Ambrożewicz else if (chassisSubNode == sensors::node::thermal) 53449c53ac9SJohnathan Mantey { 5358d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 53649c53ac9SJohnathan Mantey "#Thermal.v1_4_0.Thermal"; 5378d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Fans"] = 5388d1b46d7Szhanghch05 nlohmann::json::array(); 5398d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Temperatures"] = 5404f9a2130SJennifer Lee nlohmann::json::array(); 54149c53ac9SJohnathan Mantey } 542a0ec28b6SAdrian Ambrożewicz else if (chassisSubNode == sensors::node::sensors) 54395a3ecadSAnthony Wilson { 5448d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] = 54595a3ecadSAnthony Wilson "#SensorCollection.SensorCollection"; 5468d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Description"] = 54795a3ecadSAnthony Wilson "Collection of Sensors for this Chassis"; 5488d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Members"] = 54995a3ecadSAnthony Wilson nlohmann::json::array(); 5508d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Members@odata.count"] = 5518d1b46d7Szhanghch05 0; 55295a3ecadSAnthony Wilson } 55395a3ecadSAnthony Wilson 554a0ec28b6SAdrian Ambrożewicz if (chassisSubNode != sensors::node::sensors) 55595a3ecadSAnthony Wilson { 5568d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Id"] = chassisSubNode; 55795a3ecadSAnthony Wilson } 55895a3ecadSAnthony Wilson 5598d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] = 56049c53ac9SJohnathan Mantey "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + "/" + 56149c53ac9SJohnathan Mantey chassisSubNode; 5628d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Name"] = chassisSubNode; 5638fb49dd6SShawn McCarney // Get the list of all sensors for this Chassis element 5648fb49dd6SShawn McCarney std::string sensorPath = *chassisPath + "/all_sensors"; 5651e1e598dSJonathan Doman sdbusplus::asio::getProperty<std::vector<std::string>>( 5661e1e598dSJonathan Doman *crow::connections::systemBus, "xyz.openbmc_project.ObjectMapper", 5671e1e598dSJonathan Doman sensorPath, "xyz.openbmc_project.Association", "endpoints", 568f94c4ecfSEd Tanous [sensorsAsyncResp, 569f94c4ecfSEd Tanous callback{std::forward<const Callback>(callback)}]( 570271584abSEd Tanous const boost::system::error_code& e, 5711e1e598dSJonathan Doman const std::vector<std::string>& nodeSensorList) { 572271584abSEd Tanous if (e) 57349c53ac9SJohnathan Mantey { 574271584abSEd Tanous if (e.value() != EBADR) 57549c53ac9SJohnathan Mantey { 576002d39b4SEd Tanous messages::internalError(sensorsAsyncResp->asyncResp->res); 57749c53ac9SJohnathan Mantey return; 57849c53ac9SJohnathan Mantey } 57949c53ac9SJohnathan Mantey } 580fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>> culledSensorList = 581fe04d49cSNan Zhou std::make_shared<std::set<std::string>>(); 5821e1e598dSJonathan Doman reduceSensorList(sensorsAsyncResp, &nodeSensorList, 58349c53ac9SJohnathan Mantey culledSensorList); 58449c53ac9SJohnathan Mantey callback(culledSensorList); 5851e1e598dSJonathan Doman }); 58649c53ac9SJohnathan Mantey }; 58749c53ac9SJohnathan Mantey 58849c53ac9SJohnathan Mantey // Get the Chassis Collection 58949c53ac9SJohnathan Mantey crow::connections::systemBus->async_method_call( 59049c53ac9SJohnathan Mantey respHandler, "xyz.openbmc_project.ObjectMapper", 59149c53ac9SJohnathan Mantey "/xyz/openbmc_project/object_mapper", 59249c53ac9SJohnathan Mantey "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", 593271584abSEd Tanous "/xyz/openbmc_project/inventory", 0, interfaces); 59455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassis exit"; 59508777fb0SLewanczyk, Dawid } 59608777fb0SLewanczyk, Dawid 59708777fb0SLewanczyk, Dawid /** 598de629b6eSShawn McCarney * @brief Finds all DBus object paths that implement ObjectManager. 599de629b6eSShawn McCarney * 600de629b6eSShawn McCarney * Creates a mapping from the associated connection name to the object path. 601de629b6eSShawn McCarney * 602de629b6eSShawn McCarney * Finds the object paths asynchronously. Invokes callback when information has 603de629b6eSShawn McCarney * been obtained. 604de629b6eSShawn McCarney * 605de629b6eSShawn McCarney * The callback must have the following signature: 606de629b6eSShawn McCarney * @code 607fe04d49cSNan Zhou * callback(std::shared_ptr<std::map<std::string,std::string>> objectMgrPaths) 608de629b6eSShawn McCarney * @endcode 609de629b6eSShawn McCarney * 61049c53ac9SJohnathan Mantey * @param sensorsAsyncResp Pointer to object holding response data. 611de629b6eSShawn McCarney * @param callback Callback to invoke when object paths obtained. 612de629b6eSShawn McCarney */ 613de629b6eSShawn McCarney template <typename Callback> 614b5a76932SEd Tanous void getObjectManagerPaths( 61581ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 616de629b6eSShawn McCarney Callback&& callback) 617de629b6eSShawn McCarney { 618de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths enter"; 619de629b6eSShawn McCarney const std::array<std::string, 1> interfaces = { 620de629b6eSShawn McCarney "org.freedesktop.DBus.ObjectManager"}; 621de629b6eSShawn McCarney 622de629b6eSShawn McCarney // Response handler for GetSubTree DBus method 623002d39b4SEd Tanous auto respHandler = 624002d39b4SEd Tanous [callback{std::forward<Callback>(callback)}, sensorsAsyncResp]( 625b9d36b47SEd Tanous const boost::system::error_code ec, 626002d39b4SEd Tanous const dbus::utility::MapperGetSubTreeResponse& subtree) { 627de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler enter"; 628de629b6eSShawn McCarney if (ec) 629de629b6eSShawn McCarney { 6308d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 631de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "getObjectManagerPaths respHandler: DBus error " 632de629b6eSShawn McCarney << ec; 633de629b6eSShawn McCarney return; 634de629b6eSShawn McCarney } 635de629b6eSShawn McCarney 636de629b6eSShawn McCarney // Loop over returned object paths 637fe04d49cSNan Zhou std::shared_ptr<std::map<std::string, std::string>> objectMgrPaths = 638fe04d49cSNan Zhou std::make_shared<std::map<std::string, std::string>>(); 639de629b6eSShawn McCarney for (const std::pair< 640de629b6eSShawn McCarney std::string, 641de629b6eSShawn McCarney std::vector<std::pair<std::string, std::vector<std::string>>>>& 642de629b6eSShawn McCarney object : subtree) 643de629b6eSShawn McCarney { 644de629b6eSShawn McCarney // Loop over connections for current object path 645de629b6eSShawn McCarney const std::string& objectPath = object.first; 646de629b6eSShawn McCarney for (const std::pair<std::string, std::vector<std::string>>& 647de629b6eSShawn McCarney objData : object.second) 648de629b6eSShawn McCarney { 649de629b6eSShawn McCarney // Add mapping from connection to object path 650de629b6eSShawn McCarney const std::string& connection = objData.first; 6518fb49dd6SShawn McCarney (*objectMgrPaths)[connection] = objectPath; 652de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "Added mapping " << connection << " -> " 653de629b6eSShawn McCarney << objectPath; 654de629b6eSShawn McCarney } 655de629b6eSShawn McCarney } 6568fb49dd6SShawn McCarney callback(objectMgrPaths); 657de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler exit"; 658de629b6eSShawn McCarney }; 659de629b6eSShawn McCarney 660de629b6eSShawn McCarney // Query mapper for all DBus object paths that implement ObjectManager 661de629b6eSShawn McCarney crow::connections::systemBus->async_method_call( 662de629b6eSShawn McCarney std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 663de629b6eSShawn McCarney "/xyz/openbmc_project/object_mapper", 664271584abSEd Tanous "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", 0, interfaces); 665de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPaths exit"; 666de629b6eSShawn McCarney } 667de629b6eSShawn McCarney 668de629b6eSShawn McCarney /** 669adc4f0dbSShawn McCarney * @brief Returns the Redfish State value for the specified inventory item. 670adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with a sensor. 671adc4f0dbSShawn McCarney * @return State value for inventory item. 67234dd179eSJames Feist */ 67323a21a1cSEd Tanous inline std::string getState(const InventoryItem* inventoryItem) 674adc4f0dbSShawn McCarney { 675adc4f0dbSShawn McCarney if ((inventoryItem != nullptr) && !(inventoryItem->isPresent)) 676adc4f0dbSShawn McCarney { 677adc4f0dbSShawn McCarney return "Absent"; 678adc4f0dbSShawn McCarney } 67934dd179eSJames Feist 680adc4f0dbSShawn McCarney return "Enabled"; 681adc4f0dbSShawn McCarney } 682adc4f0dbSShawn McCarney 683adc4f0dbSShawn McCarney /** 684adc4f0dbSShawn McCarney * @brief Returns the Redfish Health value for the specified sensor. 685adc4f0dbSShawn McCarney * @param sensorJson Sensor JSON object. 686*1d7c0054SEd Tanous * @param valuesDict Map of all sensor DBus values. 687adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with the sensor. Will 688adc4f0dbSShawn McCarney * be nullptr if no associated inventory item was found. 689adc4f0dbSShawn McCarney * @return Health value for sensor. 690adc4f0dbSShawn McCarney */ 691*1d7c0054SEd Tanous inline std::string getHealth(nlohmann::json& sensorJson, 692*1d7c0054SEd Tanous const dbus::utility::DBusPropertiesMap& valuesDict, 693adc4f0dbSShawn McCarney const InventoryItem* inventoryItem) 69434dd179eSJames Feist { 695adc4f0dbSShawn McCarney // Get current health value (if any) in the sensor JSON object. Some JSON 696adc4f0dbSShawn McCarney // objects contain multiple sensors (such as PowerSupplies). We want to set 697adc4f0dbSShawn McCarney // the overall health to be the most severe of any of the sensors. 698adc4f0dbSShawn McCarney std::string currentHealth; 699adc4f0dbSShawn McCarney auto statusIt = sensorJson.find("Status"); 700adc4f0dbSShawn McCarney if (statusIt != sensorJson.end()) 701adc4f0dbSShawn McCarney { 702adc4f0dbSShawn McCarney auto healthIt = statusIt->find("Health"); 703adc4f0dbSShawn McCarney if (healthIt != statusIt->end()) 704adc4f0dbSShawn McCarney { 705adc4f0dbSShawn McCarney std::string* health = healthIt->get_ptr<std::string*>(); 706adc4f0dbSShawn McCarney if (health != nullptr) 707adc4f0dbSShawn McCarney { 708adc4f0dbSShawn McCarney currentHealth = *health; 709adc4f0dbSShawn McCarney } 710adc4f0dbSShawn McCarney } 711adc4f0dbSShawn McCarney } 712adc4f0dbSShawn McCarney 713adc4f0dbSShawn McCarney // If current health in JSON object is already Critical, return that. This 714adc4f0dbSShawn McCarney // should override the sensor health, which might be less severe. 715adc4f0dbSShawn McCarney if (currentHealth == "Critical") 716adc4f0dbSShawn McCarney { 717adc4f0dbSShawn McCarney return "Critical"; 718adc4f0dbSShawn McCarney } 719adc4f0dbSShawn McCarney 720adc4f0dbSShawn McCarney // Check if sensor has critical threshold alarm 721711ac7a9SEd Tanous 722*1d7c0054SEd Tanous for (const auto& [valueName, value] : valuesDict) 72334dd179eSJames Feist { 724*1d7c0054SEd Tanous if (valueName == "CriticalAlarmHigh" || valueName == "CriticalAlarmLow") 725711ac7a9SEd Tanous { 726711ac7a9SEd Tanous const bool* asserted = std::get_if<bool>(&value); 72734dd179eSJames Feist if (asserted == nullptr) 72834dd179eSJames Feist { 72934dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 73034dd179eSJames Feist } 73134dd179eSJames Feist else if (*asserted) 73234dd179eSJames Feist { 73334dd179eSJames Feist return "Critical"; 73434dd179eSJames Feist } 73534dd179eSJames Feist } 73634dd179eSJames Feist } 73734dd179eSJames Feist 738adc4f0dbSShawn McCarney // Check if associated inventory item is not functional 739adc4f0dbSShawn McCarney if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional)) 740adc4f0dbSShawn McCarney { 741adc4f0dbSShawn McCarney return "Critical"; 742adc4f0dbSShawn McCarney } 743adc4f0dbSShawn McCarney 744adc4f0dbSShawn McCarney // If current health in JSON object is already Warning, return that. This 745adc4f0dbSShawn McCarney // should override the sensor status, which might be less severe. 746adc4f0dbSShawn McCarney if (currentHealth == "Warning") 747adc4f0dbSShawn McCarney { 748adc4f0dbSShawn McCarney return "Warning"; 749adc4f0dbSShawn McCarney } 750adc4f0dbSShawn McCarney 751adc4f0dbSShawn McCarney // Check if sensor has warning threshold alarm 752*1d7c0054SEd Tanous for (const auto& [valueName, value] : valuesDict) 75334dd179eSJames Feist { 754*1d7c0054SEd Tanous if (valueName == "WarningAlarmHigh" || valueName == "WarningAlarmLow") 755711ac7a9SEd Tanous { 756711ac7a9SEd Tanous const bool* asserted = std::get_if<bool>(&value); 75734dd179eSJames Feist if (asserted == nullptr) 75834dd179eSJames Feist { 75934dd179eSJames Feist BMCWEB_LOG_ERROR << "Illegal sensor threshold"; 76034dd179eSJames Feist } 76134dd179eSJames Feist else if (*asserted) 76234dd179eSJames Feist { 763ebe4d91eSEd Tanous return "Warning"; 76434dd179eSJames Feist } 76534dd179eSJames Feist } 76634dd179eSJames Feist } 767adc4f0dbSShawn McCarney 76834dd179eSJames Feist return "OK"; 76934dd179eSJames Feist } 77034dd179eSJames Feist 77123a21a1cSEd Tanous inline void setLedState(nlohmann::json& sensorJson, 772d500549bSAnthony Wilson const InventoryItem* inventoryItem) 773d500549bSAnthony Wilson { 774d500549bSAnthony Wilson if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty()) 775d500549bSAnthony Wilson { 776d500549bSAnthony Wilson switch (inventoryItem->ledState) 777d500549bSAnthony Wilson { 778d500549bSAnthony Wilson case LedState::OFF: 779d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Off"; 780d500549bSAnthony Wilson break; 781d500549bSAnthony Wilson case LedState::ON: 782d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Lit"; 783d500549bSAnthony Wilson break; 784d500549bSAnthony Wilson case LedState::BLINK: 785d500549bSAnthony Wilson sensorJson["IndicatorLED"] = "Blinking"; 786d500549bSAnthony Wilson break; 78723a21a1cSEd Tanous case LedState::UNKNOWN: 788d500549bSAnthony Wilson break; 789d500549bSAnthony Wilson } 790d500549bSAnthony Wilson } 791d500549bSAnthony Wilson } 792d500549bSAnthony Wilson 79334dd179eSJames Feist /** 79408777fb0SLewanczyk, Dawid * @brief Builds a json sensor representation of a sensor. 79508777fb0SLewanczyk, Dawid * @param sensorName The name of the sensor to be built 796274fad5aSGunnar Mills * @param sensorType The type (temperature, fan_tach, etc) of the sensor to 79708777fb0SLewanczyk, Dawid * build 798*1d7c0054SEd Tanous * @param chassisSubNode The subnode (thermal, sensor, ect) of the sensor 799*1d7c0054SEd Tanous * @param propertiesDict A dictionary of the properties to build the sensor 800*1d7c0054SEd Tanous * from. 801*1d7c0054SEd Tanous * @param sensorJson The json object to fill 802adc4f0dbSShawn McCarney * @param inventoryItem D-Bus inventory item associated with the sensor. Will 803adc4f0dbSShawn McCarney * be nullptr if no associated inventory item was found. 80408777fb0SLewanczyk, Dawid */ 805*1d7c0054SEd Tanous inline void objectPropertiesToJson( 806*1d7c0054SEd Tanous std::string_view sensorName, std::string_view sensorType, 807*1d7c0054SEd Tanous std::string_view chassisSubNode, 808*1d7c0054SEd Tanous const dbus::utility::DBusPropertiesMap& propertiesDict, 80981ce609eSEd Tanous nlohmann::json& sensorJson, InventoryItem* inventoryItem) 8101abe55efSEd Tanous { 81108777fb0SLewanczyk, Dawid // Assume values exist as is (10^0 == 1) if no scale exists 81208777fb0SLewanczyk, Dawid int64_t scaleMultiplier = 0; 813*1d7c0054SEd Tanous for (const auto& [valueName, value] : propertiesDict) 814711ac7a9SEd Tanous { 815711ac7a9SEd Tanous if (valueName == "Scale") 816711ac7a9SEd Tanous { 817711ac7a9SEd Tanous const int64_t* int64Value = std::get_if<int64_t>(&value); 8181abe55efSEd Tanous if (int64Value != nullptr) 8191abe55efSEd Tanous { 82008777fb0SLewanczyk, Dawid scaleMultiplier = *int64Value; 82108777fb0SLewanczyk, Dawid } 82208777fb0SLewanczyk, Dawid } 823711ac7a9SEd Tanous } 82408777fb0SLewanczyk, Dawid 825*1d7c0054SEd Tanous if (chassisSubNode == sensors::node::sensors) 826adc4f0dbSShawn McCarney { 82781ce609eSEd Tanous sensorJson["Id"] = sensorName; 828*1d7c0054SEd Tanous std::string sensorNameEs(sensorName); 829*1d7c0054SEd Tanous std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' '); 830*1d7c0054SEd Tanous sensorJson["Name"] = std::move(sensorNameEs); 83195a3ecadSAnthony Wilson } 83295a3ecadSAnthony Wilson else if (sensorType != "power") 83395a3ecadSAnthony Wilson { 83495a3ecadSAnthony Wilson // Set MemberId and Name for non-power sensors. For PowerSupplies and 83595a3ecadSAnthony Wilson // PowerControl, those properties have more general values because 83695a3ecadSAnthony Wilson // multiple sensors can be stored in the same JSON object. 83781ce609eSEd Tanous sensorJson["MemberId"] = sensorName; 838*1d7c0054SEd Tanous std::string sensorNameEs(sensorName); 839*1d7c0054SEd Tanous std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' '); 840*1d7c0054SEd Tanous sensorJson["Name"] = std::move(sensorNameEs); 841adc4f0dbSShawn McCarney } 842e742b6ccSEd Tanous 84381ce609eSEd Tanous sensorJson["Status"]["State"] = getState(inventoryItem); 84481ce609eSEd Tanous sensorJson["Status"]["Health"] = 845*1d7c0054SEd Tanous getHealth(sensorJson, propertiesDict, inventoryItem); 84608777fb0SLewanczyk, Dawid 84708777fb0SLewanczyk, Dawid // Parameter to set to override the type we get from dbus, and force it to 84808777fb0SLewanczyk, Dawid // int, regardless of what is available. This is used for schemas like fan, 84908777fb0SLewanczyk, Dawid // that require integers, not floats. 85008777fb0SLewanczyk, Dawid bool forceToInt = false; 85108777fb0SLewanczyk, Dawid 8523929aca1SAnthony Wilson nlohmann::json::json_pointer unit("/Reading"); 853*1d7c0054SEd Tanous if (chassisSubNode == sensors::node::sensors) 85495a3ecadSAnthony Wilson { 8552a4ba195SShounak Mitra sensorJson["@odata.type"] = "#Sensor.v1_2_0.Sensor"; 856c2bf7f99SWludzik, Jozef 857*1d7c0054SEd Tanous std::string_view readingType = sensors::toReadingType(sensorType); 858c2bf7f99SWludzik, Jozef if (readingType.empty()) 85995a3ecadSAnthony Wilson { 860c2bf7f99SWludzik, Jozef BMCWEB_LOG_ERROR << "Redfish cannot map reading type for " 861c2bf7f99SWludzik, Jozef << sensorType; 86295a3ecadSAnthony Wilson } 863c2bf7f99SWludzik, Jozef else 86495a3ecadSAnthony Wilson { 865c2bf7f99SWludzik, Jozef sensorJson["ReadingType"] = readingType; 86695a3ecadSAnthony Wilson } 867c2bf7f99SWludzik, Jozef 868*1d7c0054SEd Tanous std::string_view readingUnits = sensors::toReadingUnits(sensorType); 869c2bf7f99SWludzik, Jozef if (readingUnits.empty()) 870f8ede15eSAdrian Ambrożewicz { 871c2bf7f99SWludzik, Jozef BMCWEB_LOG_ERROR << "Redfish cannot map reading unit for " 872c2bf7f99SWludzik, Jozef << sensorType; 873c2bf7f99SWludzik, Jozef } 874c2bf7f99SWludzik, Jozef else 875c2bf7f99SWludzik, Jozef { 876c2bf7f99SWludzik, Jozef sensorJson["ReadingUnits"] = readingUnits; 877f8ede15eSAdrian Ambrożewicz } 87895a3ecadSAnthony Wilson } 87995a3ecadSAnthony Wilson else if (sensorType == "temperature") 8801abe55efSEd Tanous { 8813929aca1SAnthony Wilson unit = "/ReadingCelsius"_json_pointer; 88281ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature"; 88308777fb0SLewanczyk, Dawid // TODO(ed) Documentation says that path should be type fan_tach, 88408777fb0SLewanczyk, Dawid // implementation seems to implement fan 8851abe55efSEd Tanous } 8861abe55efSEd Tanous else if (sensorType == "fan" || sensorType == "fan_tach") 8871abe55efSEd Tanous { 8883929aca1SAnthony Wilson unit = "/Reading"_json_pointer; 88981ce609eSEd Tanous sensorJson["ReadingUnits"] = "RPM"; 89081ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan"; 89181ce609eSEd Tanous setLedState(sensorJson, inventoryItem); 89208777fb0SLewanczyk, Dawid forceToInt = true; 8931abe55efSEd Tanous } 8946f6d0d32SEd Tanous else if (sensorType == "fan_pwm") 8956f6d0d32SEd Tanous { 8963929aca1SAnthony Wilson unit = "/Reading"_json_pointer; 89781ce609eSEd Tanous sensorJson["ReadingUnits"] = "Percent"; 89881ce609eSEd Tanous sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan"; 89981ce609eSEd Tanous setLedState(sensorJson, inventoryItem); 9006f6d0d32SEd Tanous forceToInt = true; 9016f6d0d32SEd Tanous } 9021abe55efSEd Tanous else if (sensorType == "voltage") 9031abe55efSEd Tanous { 9043929aca1SAnthony Wilson unit = "/ReadingVolts"_json_pointer; 90581ce609eSEd Tanous sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage"; 9061abe55efSEd Tanous } 9072474adfaSEd Tanous else if (sensorType == "power") 9082474adfaSEd Tanous { 909*1d7c0054SEd Tanous if (boost::iequals(sensorName, "total_power")) 910028f7ebcSEddie James { 91181ce609eSEd Tanous sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl"; 9127ab06f49SGunnar Mills // Put multiple "sensors" into a single PowerControl, so have 9137ab06f49SGunnar Mills // generic names for MemberId and Name. Follows Redfish mockup. 91481ce609eSEd Tanous sensorJson["MemberId"] = "0"; 91581ce609eSEd Tanous sensorJson["Name"] = "Chassis Power Control"; 9163929aca1SAnthony Wilson unit = "/PowerConsumedWatts"_json_pointer; 917028f7ebcSEddie James } 918*1d7c0054SEd Tanous else if (boost::ifind_first(sensorName, "input").empty()) 91949c53ac9SJohnathan Mantey { 9203929aca1SAnthony Wilson unit = "/PowerInputWatts"_json_pointer; 92149c53ac9SJohnathan Mantey } 92249c53ac9SJohnathan Mantey else 92349c53ac9SJohnathan Mantey { 9243929aca1SAnthony Wilson unit = "/PowerOutputWatts"_json_pointer; 92549c53ac9SJohnathan Mantey } 9262474adfaSEd Tanous } 9271abe55efSEd Tanous else 9281abe55efSEd Tanous { 92955c7b7a2SEd Tanous BMCWEB_LOG_ERROR << "Redfish cannot map object type for " << sensorName; 93008777fb0SLewanczyk, Dawid return; 93108777fb0SLewanczyk, Dawid } 93208777fb0SLewanczyk, Dawid // Map of dbus interface name, dbus property name and redfish property_name 9333929aca1SAnthony Wilson std::vector< 9343929aca1SAnthony Wilson std::tuple<const char*, const char*, nlohmann::json::json_pointer>> 9353929aca1SAnthony Wilson properties; 93608777fb0SLewanczyk, Dawid properties.reserve(7); 93708777fb0SLewanczyk, Dawid 93808777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit); 939de629b6eSShawn McCarney 940*1d7c0054SEd Tanous if (chassisSubNode == sensors::node::sensors) 9413929aca1SAnthony Wilson { 9423929aca1SAnthony Wilson properties.emplace_back( 9433929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh", 9443929aca1SAnthony Wilson "/Thresholds/UpperCaution/Reading"_json_pointer); 9453929aca1SAnthony Wilson properties.emplace_back( 9463929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow", 9473929aca1SAnthony Wilson "/Thresholds/LowerCaution/Reading"_json_pointer); 9483929aca1SAnthony Wilson properties.emplace_back( 9493929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh", 9503929aca1SAnthony Wilson "/Thresholds/UpperCritical/Reading"_json_pointer); 9513929aca1SAnthony Wilson properties.emplace_back( 9523929aca1SAnthony Wilson "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow", 9533929aca1SAnthony Wilson "/Thresholds/LowerCritical/Reading"_json_pointer); 9543929aca1SAnthony Wilson } 9553929aca1SAnthony Wilson else if (sensorType != "power") 956de629b6eSShawn McCarney { 95708777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning", 9583929aca1SAnthony Wilson "WarningHigh", 9593929aca1SAnthony Wilson "/UpperThresholdNonCritical"_json_pointer); 96008777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning", 9613929aca1SAnthony Wilson "WarningLow", 9623929aca1SAnthony Wilson "/LowerThresholdNonCritical"_json_pointer); 96308777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical", 9643929aca1SAnthony Wilson "CriticalHigh", 9653929aca1SAnthony Wilson "/UpperThresholdCritical"_json_pointer); 96608777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical", 9673929aca1SAnthony Wilson "CriticalLow", 9683929aca1SAnthony Wilson "/LowerThresholdCritical"_json_pointer); 969de629b6eSShawn McCarney } 97008777fb0SLewanczyk, Dawid 9712474adfaSEd Tanous // TODO Need to get UpperThresholdFatal and LowerThresholdFatal 9722474adfaSEd Tanous 973*1d7c0054SEd Tanous if (chassisSubNode == sensors::node::sensors) 97495a3ecadSAnthony Wilson { 97595a3ecadSAnthony Wilson properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 9763929aca1SAnthony Wilson "/ReadingRangeMin"_json_pointer); 97795a3ecadSAnthony Wilson properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 9783929aca1SAnthony Wilson "/ReadingRangeMax"_json_pointer); 97995a3ecadSAnthony Wilson } 98095a3ecadSAnthony Wilson else if (sensorType == "temperature") 9811abe55efSEd Tanous { 98208777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 9833929aca1SAnthony Wilson "/MinReadingRangeTemp"_json_pointer); 98408777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 9853929aca1SAnthony Wilson "/MaxReadingRangeTemp"_json_pointer); 9861abe55efSEd Tanous } 987adc4f0dbSShawn McCarney else if (sensorType != "power") 9881abe55efSEd Tanous { 98908777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue", 9903929aca1SAnthony Wilson "/MinReadingRange"_json_pointer); 99108777fb0SLewanczyk, Dawid properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue", 9923929aca1SAnthony Wilson "/MaxReadingRange"_json_pointer); 99308777fb0SLewanczyk, Dawid } 99408777fb0SLewanczyk, Dawid 9953929aca1SAnthony Wilson for (const std::tuple<const char*, const char*, 9963929aca1SAnthony Wilson nlohmann::json::json_pointer>& p : properties) 9971abe55efSEd Tanous { 998*1d7c0054SEd Tanous for (const auto& [valueName, valueVariant] : propertiesDict) 999711ac7a9SEd Tanous { 1000711ac7a9SEd Tanous if (valueName != std::get<1>(p)) 1001711ac7a9SEd Tanous { 1002711ac7a9SEd Tanous continue; 1003711ac7a9SEd Tanous } 10043929aca1SAnthony Wilson 10053929aca1SAnthony Wilson // The property we want to set may be nested json, so use 10063929aca1SAnthony Wilson // a json_pointer for easy indexing into the json structure. 10073929aca1SAnthony Wilson const nlohmann::json::json_pointer& key = std::get<2>(p); 10083929aca1SAnthony Wilson 100908777fb0SLewanczyk, Dawid // Attempt to pull the int64 directly 1010abf2add6SEd Tanous const int64_t* int64Value = std::get_if<int64_t>(&valueVariant); 101108777fb0SLewanczyk, Dawid 1012abf2add6SEd Tanous const double* doubleValue = std::get_if<double>(&valueVariant); 1013028f7ebcSEddie James const uint32_t* uValue = std::get_if<uint32_t>(&valueVariant); 10146f6d0d32SEd Tanous double temp = 0.0; 10156f6d0d32SEd Tanous if (int64Value != nullptr) 10161abe55efSEd Tanous { 1017271584abSEd Tanous temp = static_cast<double>(*int64Value); 10186f6d0d32SEd Tanous } 10196f6d0d32SEd Tanous else if (doubleValue != nullptr) 10201abe55efSEd Tanous { 10216f6d0d32SEd Tanous temp = *doubleValue; 10221abe55efSEd Tanous } 1023028f7ebcSEddie James else if (uValue != nullptr) 1024028f7ebcSEddie James { 1025028f7ebcSEddie James temp = *uValue; 1026028f7ebcSEddie James } 10271abe55efSEd Tanous else 10281abe55efSEd Tanous { 10296f6d0d32SEd Tanous BMCWEB_LOG_ERROR 10306f6d0d32SEd Tanous << "Got value interface that wasn't int or double"; 10316f6d0d32SEd Tanous continue; 103208777fb0SLewanczyk, Dawid } 10336f6d0d32SEd Tanous temp = temp * std::pow(10, scaleMultiplier); 10346f6d0d32SEd Tanous if (forceToInt) 10356f6d0d32SEd Tanous { 103681ce609eSEd Tanous sensorJson[key] = static_cast<int64_t>(temp); 10376f6d0d32SEd Tanous } 10386f6d0d32SEd Tanous else 10396f6d0d32SEd Tanous { 104081ce609eSEd Tanous sensorJson[key] = temp; 104108777fb0SLewanczyk, Dawid } 104208777fb0SLewanczyk, Dawid } 104308777fb0SLewanczyk, Dawid } 1044a0ec28b6SAdrian Ambrożewicz 104555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "Added sensor " << sensorName; 104608777fb0SLewanczyk, Dawid } 104708777fb0SLewanczyk, Dawid 1048*1d7c0054SEd Tanous /** 1049*1d7c0054SEd Tanous * @brief Builds a json sensor representation of a sensor. 1050*1d7c0054SEd Tanous * @param sensorName The name of the sensor to be built 1051*1d7c0054SEd Tanous * @param sensorType The type (temperature, fan_tach, etc) of the sensor to 1052*1d7c0054SEd Tanous * build 1053*1d7c0054SEd Tanous * @param chassisSubNode The subnode (thermal, sensor, ect) of the sensor 1054*1d7c0054SEd Tanous * @param interfacesDict A dictionary of the interfaces and properties of said 1055*1d7c0054SEd Tanous * interfaces to be built from 1056*1d7c0054SEd Tanous * @param sensorJson The json object to fill 1057*1d7c0054SEd Tanous * @param inventoryItem D-Bus inventory item associated with the sensor. Will 1058*1d7c0054SEd Tanous * be nullptr if no associated inventory item was found. 1059*1d7c0054SEd Tanous */ 1060*1d7c0054SEd Tanous inline void objectInterfacesToJson( 1061*1d7c0054SEd Tanous const std::string& sensorName, const std::string& sensorType, 1062*1d7c0054SEd Tanous const std::string& chassisSubNode, 1063*1d7c0054SEd Tanous const dbus::utility::DBusInteracesMap& interfacesDict, 1064*1d7c0054SEd Tanous nlohmann::json& sensorJson, InventoryItem* inventoryItem) 1065*1d7c0054SEd Tanous { 1066*1d7c0054SEd Tanous 1067*1d7c0054SEd Tanous for (const auto& [interface, valuesDict] : interfacesDict) 1068*1d7c0054SEd Tanous { 1069*1d7c0054SEd Tanous objectPropertiesToJson(sensorName, sensorType, chassisSubNode, 1070*1d7c0054SEd Tanous valuesDict, sensorJson, inventoryItem); 1071*1d7c0054SEd Tanous } 1072*1d7c0054SEd Tanous } 1073*1d7c0054SEd Tanous 1074b5a76932SEd Tanous inline void populateFanRedundancy( 1075b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 10768bd25ccdSJames Feist { 10778bd25ccdSJames Feist crow::connections::systemBus->async_method_call( 1078b9d36b47SEd Tanous [sensorsAsyncResp]( 1079b9d36b47SEd Tanous const boost::system::error_code ec, 1080b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreeResponse& resp) { 10818bd25ccdSJames Feist if (ec) 10828bd25ccdSJames Feist { 10838bd25ccdSJames Feist return; // don't have to have this interface 10848bd25ccdSJames Feist } 1085002d39b4SEd Tanous for (const std::pair< 1086002d39b4SEd Tanous std::string, 1087002d39b4SEd Tanous std::vector<std::pair<std::string, std::vector<std::string>>>>& 1088e278c18fSEd Tanous pathPair : resp) 10898bd25ccdSJames Feist { 1090e278c18fSEd Tanous const std::string& path = pathPair.first; 1091002d39b4SEd Tanous const std::vector<std::pair<std::string, std::vector<std::string>>>& 1092002d39b4SEd Tanous objDict = pathPair.second; 10938bd25ccdSJames Feist if (objDict.empty()) 10948bd25ccdSJames Feist { 10958bd25ccdSJames Feist continue; // this should be impossible 10968bd25ccdSJames Feist } 10978bd25ccdSJames Feist 10988bd25ccdSJames Feist const std::string& owner = objDict.begin()->first; 10991e1e598dSJonathan Doman sdbusplus::asio::getProperty<std::vector<std::string>>( 11001e1e598dSJonathan Doman *crow::connections::systemBus, 11011e1e598dSJonathan Doman "xyz.openbmc_project.ObjectMapper", path + "/chassis", 11021e1e598dSJonathan Doman "xyz.openbmc_project.Association", "endpoints", 1103002d39b4SEd Tanous [path, owner, 1104002d39b4SEd Tanous sensorsAsyncResp](const boost::system::error_code e, 11051e1e598dSJonathan Doman const std::vector<std::string>& endpoints) { 1106271584abSEd Tanous if (e) 11078bd25ccdSJames Feist { 11088bd25ccdSJames Feist return; // if they don't have an association we 11098bd25ccdSJames Feist // can't tell what chassis is 11108bd25ccdSJames Feist } 1111002d39b4SEd Tanous auto found = 1112002d39b4SEd Tanous std::find_if(endpoints.begin(), endpoints.end(), 11138bd25ccdSJames Feist [sensorsAsyncResp](const std::string& entry) { 1114002d39b4SEd Tanous return entry.find(sensorsAsyncResp->chassisId) != 11158bd25ccdSJames Feist std::string::npos; 11168bd25ccdSJames Feist }); 11178bd25ccdSJames Feist 11181e1e598dSJonathan Doman if (found == endpoints.end()) 11198bd25ccdSJames Feist { 11208bd25ccdSJames Feist return; 11218bd25ccdSJames Feist } 112286d89ed7SKrzysztof Grobelny sdbusplus::asio::getAllProperties( 112386d89ed7SKrzysztof Grobelny *crow::connections::systemBus, owner, path, 112486d89ed7SKrzysztof Grobelny "xyz.openbmc_project.Control.FanRedundancy", 11258bd25ccdSJames Feist [path, sensorsAsyncResp]( 1126271584abSEd Tanous const boost::system::error_code& err, 112786d89ed7SKrzysztof Grobelny const dbus::utility::DBusPropertiesMap& ret) { 1128271584abSEd Tanous if (err) 11298bd25ccdSJames Feist { 11308bd25ccdSJames Feist return; // don't have to have this 11318bd25ccdSJames Feist // interface 11328bd25ccdSJames Feist } 11338bd25ccdSJames Feist 113486d89ed7SKrzysztof Grobelny const uint8_t* allowedFailures = nullptr; 113586d89ed7SKrzysztof Grobelny const std::vector<std::string>* collection = nullptr; 113686d89ed7SKrzysztof Grobelny const std::string* status = nullptr; 113786d89ed7SKrzysztof Grobelny 113886d89ed7SKrzysztof Grobelny const bool success = sdbusplus::unpackPropertiesNoThrow( 113986d89ed7SKrzysztof Grobelny dbus_utils::UnpackErrorPrinter(), ret, 114086d89ed7SKrzysztof Grobelny "AllowedFailures", allowedFailures, "Collection", 114186d89ed7SKrzysztof Grobelny collection, "Status", status); 114286d89ed7SKrzysztof Grobelny 114386d89ed7SKrzysztof Grobelny if (!success) 114486d89ed7SKrzysztof Grobelny { 114586d89ed7SKrzysztof Grobelny messages::internalError( 114686d89ed7SKrzysztof Grobelny sensorsAsyncResp->asyncResp->res); 114786d89ed7SKrzysztof Grobelny return; 114886d89ed7SKrzysztof Grobelny } 114986d89ed7SKrzysztof Grobelny 115086d89ed7SKrzysztof Grobelny if (allowedFailures == nullptr || collection == nullptr || 115186d89ed7SKrzysztof Grobelny status == nullptr) 11528bd25ccdSJames Feist { 1153002d39b4SEd Tanous BMCWEB_LOG_ERROR << "Invalid redundancy interface"; 11548bd25ccdSJames Feist messages::internalError( 11558d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 11568bd25ccdSJames Feist return; 11578bd25ccdSJames Feist } 11588bd25ccdSJames Feist 1159002d39b4SEd Tanous sdbusplus::message::object_path objectPath(path); 116028aa8de5SGeorge Liu std::string name = objectPath.filename(); 116128aa8de5SGeorge Liu if (name.empty()) 11628bd25ccdSJames Feist { 11638bd25ccdSJames Feist // this should be impossible 11648bd25ccdSJames Feist messages::internalError( 11658d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 11668bd25ccdSJames Feist return; 11678bd25ccdSJames Feist } 1168002d39b4SEd Tanous std::replace(name.begin(), name.end(), '_', ' '); 11698bd25ccdSJames Feist 11708bd25ccdSJames Feist std::string health; 11718bd25ccdSJames Feist 117211ba3979SEd Tanous if (status->ends_with("Full")) 11738bd25ccdSJames Feist { 11748bd25ccdSJames Feist health = "OK"; 11758bd25ccdSJames Feist } 117611ba3979SEd Tanous else if (status->ends_with("Degraded")) 11778bd25ccdSJames Feist { 11788bd25ccdSJames Feist health = "Warning"; 11798bd25ccdSJames Feist } 11808bd25ccdSJames Feist else 11818bd25ccdSJames Feist { 11828bd25ccdSJames Feist health = "Critical"; 11838bd25ccdSJames Feist } 11841476687dSEd Tanous nlohmann::json::array_t redfishCollection; 11858bd25ccdSJames Feist const auto& fanRedfish = 1186002d39b4SEd Tanous sensorsAsyncResp->asyncResp->res.jsonValue["Fans"]; 11878bd25ccdSJames Feist for (const std::string& item : *collection) 11888bd25ccdSJames Feist { 11898a592810SEd Tanous sdbusplus::message::object_path itemPath(item); 11908a592810SEd Tanous std::string itemName = itemPath.filename(); 119128aa8de5SGeorge Liu if (itemName.empty()) 119228aa8de5SGeorge Liu { 119328aa8de5SGeorge Liu continue; 119428aa8de5SGeorge Liu } 11958bd25ccdSJames Feist /* 11968bd25ccdSJames Feist todo(ed): merge patch that fixes the names 11978bd25ccdSJames Feist std::replace(itemName.begin(), 11988bd25ccdSJames Feist itemName.end(), '_', ' ');*/ 1199002d39b4SEd Tanous auto schemaItem = 1200002d39b4SEd Tanous std::find_if(fanRedfish.begin(), fanRedfish.end(), 12018bd25ccdSJames Feist [itemName](const nlohmann::json& fan) { 12028bd25ccdSJames Feist return fan["MemberId"] == itemName; 12038bd25ccdSJames Feist }); 12048bd25ccdSJames Feist if (schemaItem != fanRedfish.end()) 12058bd25ccdSJames Feist { 12068a592810SEd Tanous nlohmann::json::object_t collectionId; 12078a592810SEd Tanous collectionId["@odata.id"] = 12081476687dSEd Tanous (*schemaItem)["@odata.id"]; 12091476687dSEd Tanous redfishCollection.emplace_back( 12108a592810SEd Tanous std::move(collectionId)); 12118bd25ccdSJames Feist } 12128bd25ccdSJames Feist else 12138bd25ccdSJames Feist { 1214002d39b4SEd Tanous BMCWEB_LOG_ERROR << "failed to find fan in schema"; 12158bd25ccdSJames Feist messages::internalError( 12168d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res); 12178bd25ccdSJames Feist return; 12188bd25ccdSJames Feist } 12198bd25ccdSJames Feist } 12208bd25ccdSJames Feist 12213e9e72ebSKuiying Wang size_t minNumNeeded = 122226f6976fSEd Tanous collection->empty() 122326f6976fSEd Tanous ? 0 122426f6976fSEd Tanous : collection->size() - *allowedFailures; 1225002d39b4SEd Tanous nlohmann::json& jResp = sensorsAsyncResp->asyncResp->res 12268bd25ccdSJames Feist .jsonValue["Redundancy"]; 12271476687dSEd Tanous 12281476687dSEd Tanous nlohmann::json::object_t redundancy; 12291476687dSEd Tanous redundancy["@odata.id"] = 1230002d39b4SEd Tanous "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + 1231002d39b4SEd Tanous "/" + sensorsAsyncResp->chassisSubNode + 1232002d39b4SEd Tanous "#/Redundancy/" + std::to_string(jResp.size()); 1233002d39b4SEd Tanous redundancy["@odata.type"] = "#Redundancy.v1_3_2.Redundancy"; 12341476687dSEd Tanous redundancy["MinNumNeeded"] = minNumNeeded; 12351476687dSEd Tanous redundancy["MemberId"] = name; 12361476687dSEd Tanous redundancy["Mode"] = "N+m"; 12371476687dSEd Tanous redundancy["Name"] = name; 12381476687dSEd Tanous redundancy["RedundancySet"] = redfishCollection; 12391476687dSEd Tanous redundancy["Status"]["Health"] = health; 12401476687dSEd Tanous redundancy["Status"]["State"] = "Enabled"; 12411476687dSEd Tanous 12421476687dSEd Tanous jResp.push_back(std::move(redundancy)); 124386d89ed7SKrzysztof Grobelny }); 12441e1e598dSJonathan Doman }); 12458bd25ccdSJames Feist } 12468bd25ccdSJames Feist }, 12478bd25ccdSJames Feist "xyz.openbmc_project.ObjectMapper", 12488bd25ccdSJames Feist "/xyz/openbmc_project/object_mapper", 12498bd25ccdSJames Feist "xyz.openbmc_project.ObjectMapper", "GetSubTree", 12508bd25ccdSJames Feist "/xyz/openbmc_project/control", 2, 12518bd25ccdSJames Feist std::array<const char*, 1>{ 12528bd25ccdSJames Feist "xyz.openbmc_project.Control.FanRedundancy"}); 12538bd25ccdSJames Feist } 12548bd25ccdSJames Feist 1255b5a76932SEd Tanous inline void 125681ce609eSEd Tanous sortJSONResponse(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 125749c53ac9SJohnathan Mantey { 12588d1b46d7Szhanghch05 nlohmann::json& response = sensorsAsyncResp->asyncResp->res.jsonValue; 125949c53ac9SJohnathan Mantey std::array<std::string, 2> sensorHeaders{"Temperatures", "Fans"}; 126081ce609eSEd Tanous if (sensorsAsyncResp->chassisSubNode == sensors::node::power) 126149c53ac9SJohnathan Mantey { 126249c53ac9SJohnathan Mantey sensorHeaders = {"Voltages", "PowerSupplies"}; 126349c53ac9SJohnathan Mantey } 126449c53ac9SJohnathan Mantey for (const std::string& sensorGroup : sensorHeaders) 126549c53ac9SJohnathan Mantey { 126649c53ac9SJohnathan Mantey nlohmann::json::iterator entry = response.find(sensorGroup); 126749c53ac9SJohnathan Mantey if (entry != response.end()) 126849c53ac9SJohnathan Mantey { 126949c53ac9SJohnathan Mantey std::sort(entry->begin(), entry->end(), 127002cad96eSEd Tanous [](const nlohmann::json& c1, const nlohmann::json& c2) { 127149c53ac9SJohnathan Mantey return c1["Name"] < c2["Name"]; 127249c53ac9SJohnathan Mantey }); 127349c53ac9SJohnathan Mantey 127449c53ac9SJohnathan Mantey // add the index counts to the end of each entry 127549c53ac9SJohnathan Mantey size_t count = 0; 127649c53ac9SJohnathan Mantey for (nlohmann::json& sensorJson : *entry) 127749c53ac9SJohnathan Mantey { 127849c53ac9SJohnathan Mantey nlohmann::json::iterator odata = sensorJson.find("@odata.id"); 127949c53ac9SJohnathan Mantey if (odata == sensorJson.end()) 128049c53ac9SJohnathan Mantey { 128149c53ac9SJohnathan Mantey continue; 128249c53ac9SJohnathan Mantey } 128349c53ac9SJohnathan Mantey std::string* value = odata->get_ptr<std::string*>(); 128449c53ac9SJohnathan Mantey if (value != nullptr) 128549c53ac9SJohnathan Mantey { 128649c53ac9SJohnathan Mantey *value += std::to_string(count); 128749c53ac9SJohnathan Mantey count++; 128881ce609eSEd Tanous sensorsAsyncResp->updateUri(sensorJson["Name"], *value); 128949c53ac9SJohnathan Mantey } 129049c53ac9SJohnathan Mantey } 129149c53ac9SJohnathan Mantey } 129249c53ac9SJohnathan Mantey } 129349c53ac9SJohnathan Mantey } 129449c53ac9SJohnathan Mantey 129508777fb0SLewanczyk, Dawid /** 1296adc4f0dbSShawn McCarney * @brief Finds the inventory item with the specified object path. 1297adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1298adc4f0dbSShawn McCarney * @param invItemObjPath D-Bus object path of inventory item. 1299adc4f0dbSShawn McCarney * @return Inventory item within vector, or nullptr if no match found. 13008fb49dd6SShawn McCarney */ 130123a21a1cSEd Tanous inline InventoryItem* findInventoryItem( 1302b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1303adc4f0dbSShawn McCarney const std::string& invItemObjPath) 13048fb49dd6SShawn McCarney { 1305adc4f0dbSShawn McCarney for (InventoryItem& inventoryItem : *inventoryItems) 13068fb49dd6SShawn McCarney { 1307adc4f0dbSShawn McCarney if (inventoryItem.objectPath == invItemObjPath) 13088fb49dd6SShawn McCarney { 1309adc4f0dbSShawn McCarney return &inventoryItem; 13108fb49dd6SShawn McCarney } 13118fb49dd6SShawn McCarney } 13128fb49dd6SShawn McCarney return nullptr; 13138fb49dd6SShawn McCarney } 13148fb49dd6SShawn McCarney 13158fb49dd6SShawn McCarney /** 1316adc4f0dbSShawn McCarney * @brief Finds the inventory item associated with the specified sensor. 1317adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1318adc4f0dbSShawn McCarney * @param sensorObjPath D-Bus object path of sensor. 1319adc4f0dbSShawn McCarney * @return Inventory item within vector, or nullptr if no match found. 13208fb49dd6SShawn McCarney */ 132123a21a1cSEd Tanous inline InventoryItem* findInventoryItemForSensor( 1322b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1323adc4f0dbSShawn McCarney const std::string& sensorObjPath) 1324adc4f0dbSShawn McCarney { 1325adc4f0dbSShawn McCarney for (InventoryItem& inventoryItem : *inventoryItems) 1326adc4f0dbSShawn McCarney { 1327adc4f0dbSShawn McCarney if (inventoryItem.sensors.count(sensorObjPath) > 0) 1328adc4f0dbSShawn McCarney { 1329adc4f0dbSShawn McCarney return &inventoryItem; 1330adc4f0dbSShawn McCarney } 1331adc4f0dbSShawn McCarney } 1332adc4f0dbSShawn McCarney return nullptr; 1333adc4f0dbSShawn McCarney } 1334adc4f0dbSShawn McCarney 1335adc4f0dbSShawn McCarney /** 1336d500549bSAnthony Wilson * @brief Finds the inventory item associated with the specified led path. 1337d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1338d500549bSAnthony Wilson * @param ledObjPath D-Bus object path of led. 1339d500549bSAnthony Wilson * @return Inventory item within vector, or nullptr if no match found. 1340d500549bSAnthony Wilson */ 1341d500549bSAnthony Wilson inline InventoryItem* 1342d500549bSAnthony Wilson findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems, 1343d500549bSAnthony Wilson const std::string& ledObjPath) 1344d500549bSAnthony Wilson { 1345d500549bSAnthony Wilson for (InventoryItem& inventoryItem : inventoryItems) 1346d500549bSAnthony Wilson { 1347d500549bSAnthony Wilson if (inventoryItem.ledObjectPath == ledObjPath) 1348d500549bSAnthony Wilson { 1349d500549bSAnthony Wilson return &inventoryItem; 1350d500549bSAnthony Wilson } 1351d500549bSAnthony Wilson } 1352d500549bSAnthony Wilson return nullptr; 1353d500549bSAnthony Wilson } 1354d500549bSAnthony Wilson 1355d500549bSAnthony Wilson /** 1356adc4f0dbSShawn McCarney * @brief Adds inventory item and associated sensor to specified vector. 1357adc4f0dbSShawn McCarney * 1358adc4f0dbSShawn McCarney * Adds a new InventoryItem to the vector if necessary. Searches for an 1359adc4f0dbSShawn McCarney * existing InventoryItem with the specified object path. If not found, one is 1360adc4f0dbSShawn McCarney * added to the vector. 1361adc4f0dbSShawn McCarney * 1362adc4f0dbSShawn McCarney * Next, the specified sensor is added to the set of sensors associated with the 1363adc4f0dbSShawn McCarney * InventoryItem. 1364adc4f0dbSShawn McCarney * 1365adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1366adc4f0dbSShawn McCarney * @param invItemObjPath D-Bus object path of inventory item. 1367adc4f0dbSShawn McCarney * @param sensorObjPath D-Bus object path of sensor 1368adc4f0dbSShawn McCarney */ 1369b5a76932SEd Tanous inline void addInventoryItem( 1370b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 1371b5a76932SEd Tanous const std::string& invItemObjPath, const std::string& sensorObjPath) 1372adc4f0dbSShawn McCarney { 1373adc4f0dbSShawn McCarney // Look for inventory item in vector 1374adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 1375adc4f0dbSShawn McCarney findInventoryItem(inventoryItems, invItemObjPath); 1376adc4f0dbSShawn McCarney 1377adc4f0dbSShawn McCarney // If inventory item doesn't exist in vector, add it 1378adc4f0dbSShawn McCarney if (inventoryItem == nullptr) 1379adc4f0dbSShawn McCarney { 1380adc4f0dbSShawn McCarney inventoryItems->emplace_back(invItemObjPath); 1381adc4f0dbSShawn McCarney inventoryItem = &(inventoryItems->back()); 1382adc4f0dbSShawn McCarney } 1383adc4f0dbSShawn McCarney 1384adc4f0dbSShawn McCarney // Add sensor to set of sensors associated with inventory item 1385adc4f0dbSShawn McCarney inventoryItem->sensors.emplace(sensorObjPath); 1386adc4f0dbSShawn McCarney } 1387adc4f0dbSShawn McCarney 1388adc4f0dbSShawn McCarney /** 1389adc4f0dbSShawn McCarney * @brief Stores D-Bus data in the specified inventory item. 1390adc4f0dbSShawn McCarney * 1391adc4f0dbSShawn McCarney * Finds D-Bus data in the specified map of interfaces. Stores the data in the 1392adc4f0dbSShawn McCarney * specified InventoryItem. 1393adc4f0dbSShawn McCarney * 1394adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 1395adc4f0dbSShawn McCarney * response. 1396adc4f0dbSShawn McCarney * 1397adc4f0dbSShawn McCarney * @param inventoryItem Inventory item where data will be stored. 1398adc4f0dbSShawn McCarney * @param interfacesDict Map containing D-Bus interfaces and their properties 1399adc4f0dbSShawn McCarney * for the specified inventory item. 1400adc4f0dbSShawn McCarney */ 140123a21a1cSEd Tanous inline void storeInventoryItemData( 1402adc4f0dbSShawn McCarney InventoryItem& inventoryItem, 1403711ac7a9SEd Tanous const dbus::utility::DBusInteracesMap& interfacesDict) 14048fb49dd6SShawn McCarney { 1405adc4f0dbSShawn McCarney // Get properties from Inventory.Item interface 1406711ac7a9SEd Tanous 14079eb808c1SEd Tanous for (const auto& [interface, values] : interfacesDict) 14088fb49dd6SShawn McCarney { 1409711ac7a9SEd Tanous if (interface == "xyz.openbmc_project.Inventory.Item") 14108fb49dd6SShawn McCarney { 14119eb808c1SEd Tanous for (const auto& [name, dbusValue] : values) 1412711ac7a9SEd Tanous { 1413711ac7a9SEd Tanous if (name == "Present") 1414711ac7a9SEd Tanous { 1415711ac7a9SEd Tanous const bool* value = std::get_if<bool>(&dbusValue); 1416adc4f0dbSShawn McCarney if (value != nullptr) 14178fb49dd6SShawn McCarney { 1418adc4f0dbSShawn McCarney inventoryItem.isPresent = *value; 14198fb49dd6SShawn McCarney } 14208fb49dd6SShawn McCarney } 14218fb49dd6SShawn McCarney } 1422711ac7a9SEd Tanous } 1423adc4f0dbSShawn McCarney // Check if Inventory.Item.PowerSupply interface is present 1424711ac7a9SEd Tanous 1425711ac7a9SEd Tanous if (interface == "xyz.openbmc_project.Inventory.Item.PowerSupply") 14268fb49dd6SShawn McCarney { 1427adc4f0dbSShawn McCarney inventoryItem.isPowerSupply = true; 14288fb49dd6SShawn McCarney } 1429adc4f0dbSShawn McCarney 1430adc4f0dbSShawn McCarney // Get properties from Inventory.Decorator.Asset interface 1431711ac7a9SEd Tanous if (interface == "xyz.openbmc_project.Inventory.Decorator.Asset") 1432adc4f0dbSShawn McCarney { 14339eb808c1SEd Tanous for (const auto& [name, dbusValue] : values) 1434711ac7a9SEd Tanous { 1435711ac7a9SEd Tanous if (name == "Manufacturer") 1436adc4f0dbSShawn McCarney { 1437adc4f0dbSShawn McCarney const std::string* value = 1438711ac7a9SEd Tanous std::get_if<std::string>(&dbusValue); 1439adc4f0dbSShawn McCarney if (value != nullptr) 1440adc4f0dbSShawn McCarney { 1441adc4f0dbSShawn McCarney inventoryItem.manufacturer = *value; 1442adc4f0dbSShawn McCarney } 1443adc4f0dbSShawn McCarney } 1444711ac7a9SEd Tanous if (name == "Model") 1445adc4f0dbSShawn McCarney { 1446adc4f0dbSShawn McCarney const std::string* value = 1447711ac7a9SEd Tanous std::get_if<std::string>(&dbusValue); 1448adc4f0dbSShawn McCarney if (value != nullptr) 1449adc4f0dbSShawn McCarney { 1450adc4f0dbSShawn McCarney inventoryItem.model = *value; 1451adc4f0dbSShawn McCarney } 1452adc4f0dbSShawn McCarney } 1453711ac7a9SEd Tanous if (name == "SerialNumber") 1454adc4f0dbSShawn McCarney { 1455adc4f0dbSShawn McCarney const std::string* value = 1456711ac7a9SEd Tanous std::get_if<std::string>(&dbusValue); 1457adc4f0dbSShawn McCarney if (value != nullptr) 1458adc4f0dbSShawn McCarney { 1459adc4f0dbSShawn McCarney inventoryItem.serialNumber = *value; 1460adc4f0dbSShawn McCarney } 1461adc4f0dbSShawn McCarney } 1462711ac7a9SEd Tanous if (name == "PartNumber") 1463711ac7a9SEd Tanous { 1464711ac7a9SEd Tanous const std::string* value = 1465711ac7a9SEd Tanous std::get_if<std::string>(&dbusValue); 1466711ac7a9SEd Tanous if (value != nullptr) 1467711ac7a9SEd Tanous { 1468711ac7a9SEd Tanous inventoryItem.partNumber = *value; 1469711ac7a9SEd Tanous } 1470711ac7a9SEd Tanous } 1471711ac7a9SEd Tanous } 1472adc4f0dbSShawn McCarney } 1473adc4f0dbSShawn McCarney 1474711ac7a9SEd Tanous if (interface == 1475711ac7a9SEd Tanous "xyz.openbmc_project.State.Decorator.OperationalStatus") 1476adc4f0dbSShawn McCarney { 14779eb808c1SEd Tanous for (const auto& [name, dbusValue] : values) 1478adc4f0dbSShawn McCarney { 1479711ac7a9SEd Tanous if (name == "Functional") 1480711ac7a9SEd Tanous { 1481711ac7a9SEd Tanous const bool* value = std::get_if<bool>(&dbusValue); 1482adc4f0dbSShawn McCarney if (value != nullptr) 1483adc4f0dbSShawn McCarney { 1484adc4f0dbSShawn McCarney inventoryItem.isFunctional = *value; 14858fb49dd6SShawn McCarney } 14868fb49dd6SShawn McCarney } 14878fb49dd6SShawn McCarney } 14888fb49dd6SShawn McCarney } 1489711ac7a9SEd Tanous } 1490711ac7a9SEd Tanous } 14918fb49dd6SShawn McCarney 14928fb49dd6SShawn McCarney /** 1493adc4f0dbSShawn McCarney * @brief Gets D-Bus data for inventory items associated with sensors. 14948fb49dd6SShawn McCarney * 1495adc4f0dbSShawn McCarney * Uses the specified connections (services) to obtain D-Bus data for inventory 1496adc4f0dbSShawn McCarney * items associated with sensors. Stores the resulting data in the 1497adc4f0dbSShawn McCarney * inventoryItems vector. 14988fb49dd6SShawn McCarney * 1499adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 1500adc4f0dbSShawn McCarney * response. 1501adc4f0dbSShawn McCarney * 1502adc4f0dbSShawn McCarney * Finds the inventory item data asynchronously. Invokes callback when data has 1503adc4f0dbSShawn McCarney * been obtained. 1504adc4f0dbSShawn McCarney * 1505adc4f0dbSShawn McCarney * The callback must have the following signature: 1506adc4f0dbSShawn McCarney * @code 1507d500549bSAnthony Wilson * callback(void) 1508adc4f0dbSShawn McCarney * @endcode 1509adc4f0dbSShawn McCarney * 1510adc4f0dbSShawn McCarney * This function is called recursively, obtaining data asynchronously from one 1511adc4f0dbSShawn McCarney * connection in each call. This ensures the callback is not invoked until the 1512adc4f0dbSShawn McCarney * last asynchronous function has completed. 15138fb49dd6SShawn McCarney * 15148fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 1515adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 1516adc4f0dbSShawn McCarney * @param invConnections Connections that provide data for the inventory items. 15178fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 15188fb49dd6SShawn McCarney * implements ObjectManager. 1519adc4f0dbSShawn McCarney * @param callback Callback to invoke when inventory data has been obtained. 1520adc4f0dbSShawn McCarney * @param invConnectionsIndex Current index in invConnections. Only specified 1521adc4f0dbSShawn McCarney * in recursive calls to this function. 15228fb49dd6SShawn McCarney */ 1523adc4f0dbSShawn McCarney template <typename Callback> 1524adc4f0dbSShawn McCarney static void getInventoryItemsData( 15258fb49dd6SShawn McCarney std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1526adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 1527fe04d49cSNan Zhou std::shared_ptr<std::set<std::string>> invConnections, 1528fe04d49cSNan Zhou std::shared_ptr<std::map<std::string, std::string>> objectMgrPaths, 1529271584abSEd Tanous Callback&& callback, size_t invConnectionsIndex = 0) 15308fb49dd6SShawn McCarney { 1531adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData enter"; 15328fb49dd6SShawn McCarney 1533adc4f0dbSShawn McCarney // If no more connections left, call callback 1534adc4f0dbSShawn McCarney if (invConnectionsIndex >= invConnections->size()) 15358fb49dd6SShawn McCarney { 1536d500549bSAnthony Wilson callback(); 1537adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData exit"; 1538adc4f0dbSShawn McCarney return; 1539adc4f0dbSShawn McCarney } 1540adc4f0dbSShawn McCarney 1541adc4f0dbSShawn McCarney // Get inventory item data from current connection 1542fe04d49cSNan Zhou auto it = invConnections->begin(); 1543fe04d49cSNan Zhou std::advance(it, invConnectionsIndex); 1544adc4f0dbSShawn McCarney if (it != invConnections->end()) 1545adc4f0dbSShawn McCarney { 1546adc4f0dbSShawn McCarney const std::string& invConnection = *it; 1547adc4f0dbSShawn McCarney 15488fb49dd6SShawn McCarney // Response handler for GetManagedObjects 1549002d39b4SEd Tanous auto respHandler = 1550002d39b4SEd Tanous [sensorsAsyncResp, inventoryItems, invConnections, objectMgrPaths, 155102cad96eSEd Tanous callback{std::forward<Callback>(callback)}, invConnectionsIndex]( 155202cad96eSEd Tanous const boost::system::error_code ec, 155302cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 1554adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler enter"; 15558fb49dd6SShawn McCarney if (ec) 15568fb49dd6SShawn McCarney { 15578fb49dd6SShawn McCarney BMCWEB_LOG_ERROR 1558adc4f0dbSShawn McCarney << "getInventoryItemsData respHandler DBus error " << ec; 15598d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 15608fb49dd6SShawn McCarney return; 15618fb49dd6SShawn McCarney } 15628fb49dd6SShawn McCarney 15638fb49dd6SShawn McCarney // Loop through returned object paths 15648fb49dd6SShawn McCarney for (const auto& objDictEntry : resp) 15658fb49dd6SShawn McCarney { 15668fb49dd6SShawn McCarney const std::string& objPath = 15678fb49dd6SShawn McCarney static_cast<const std::string&>(objDictEntry.first); 15688fb49dd6SShawn McCarney 1569adc4f0dbSShawn McCarney // If this object path is one of the specified inventory items 1570adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 1571adc4f0dbSShawn McCarney findInventoryItem(inventoryItems, objPath); 1572adc4f0dbSShawn McCarney if (inventoryItem != nullptr) 15738fb49dd6SShawn McCarney { 1574adc4f0dbSShawn McCarney // Store inventory data in InventoryItem 1575adc4f0dbSShawn McCarney storeInventoryItemData(*inventoryItem, objDictEntry.second); 15768fb49dd6SShawn McCarney } 15778fb49dd6SShawn McCarney } 15788fb49dd6SShawn McCarney 1579adc4f0dbSShawn McCarney // Recurse to get inventory item data from next connection 1580adc4f0dbSShawn McCarney getInventoryItemsData(sensorsAsyncResp, inventoryItems, 1581adc4f0dbSShawn McCarney invConnections, objectMgrPaths, 1582adc4f0dbSShawn McCarney std::move(callback), invConnectionsIndex + 1); 1583adc4f0dbSShawn McCarney 1584adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler exit"; 15858fb49dd6SShawn McCarney }; 15868fb49dd6SShawn McCarney 15878fb49dd6SShawn McCarney // Find DBus object path that implements ObjectManager for the current 15888fb49dd6SShawn McCarney // connection. If no mapping found, default to "/". 15898fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(invConnection); 15908fb49dd6SShawn McCarney const std::string& objectMgrPath = 15918fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 15928fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << invConnection << " is " 15938fb49dd6SShawn McCarney << objectMgrPath; 15948fb49dd6SShawn McCarney 15958fb49dd6SShawn McCarney // Get all object paths and their interfaces for current connection 15968fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 15978fb49dd6SShawn McCarney std::move(respHandler), invConnection, objectMgrPath, 15988fb49dd6SShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 15998fb49dd6SShawn McCarney } 16008fb49dd6SShawn McCarney 1601adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsData exit"; 16028fb49dd6SShawn McCarney } 16038fb49dd6SShawn McCarney 16048fb49dd6SShawn McCarney /** 1605adc4f0dbSShawn McCarney * @brief Gets connections that provide D-Bus data for inventory items. 16068fb49dd6SShawn McCarney * 1607adc4f0dbSShawn McCarney * Gets the D-Bus connections (services) that provide data for the inventory 1608adc4f0dbSShawn McCarney * items that are associated with sensors. 16098fb49dd6SShawn McCarney * 16108fb49dd6SShawn McCarney * Finds the connections asynchronously. Invokes callback when information has 16118fb49dd6SShawn McCarney * been obtained. 16128fb49dd6SShawn McCarney * 16138fb49dd6SShawn McCarney * The callback must have the following signature: 16148fb49dd6SShawn McCarney * @code 1615fe04d49cSNan Zhou * callback(std::shared_ptr<std::set<std::string>> invConnections) 16168fb49dd6SShawn McCarney * @endcode 16178fb49dd6SShawn McCarney * 16188fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 1619adc4f0dbSShawn McCarney * @param inventoryItems D-Bus inventory items associated with sensors. 16208fb49dd6SShawn McCarney * @param callback Callback to invoke when connections have been obtained. 16218fb49dd6SShawn McCarney */ 16228fb49dd6SShawn McCarney template <typename Callback> 16238fb49dd6SShawn McCarney static void getInventoryItemsConnections( 1624b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 1625b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems, 16268fb49dd6SShawn McCarney Callback&& callback) 16278fb49dd6SShawn McCarney { 16288fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections enter"; 16298fb49dd6SShawn McCarney 16308fb49dd6SShawn McCarney const std::string path = "/xyz/openbmc_project/inventory"; 1631adc4f0dbSShawn McCarney const std::array<std::string, 4> interfaces = { 16328fb49dd6SShawn McCarney "xyz.openbmc_project.Inventory.Item", 1633adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Item.PowerSupply", 1634adc4f0dbSShawn McCarney "xyz.openbmc_project.Inventory.Decorator.Asset", 16358fb49dd6SShawn McCarney "xyz.openbmc_project.State.Decorator.OperationalStatus"}; 16368fb49dd6SShawn McCarney 16378fb49dd6SShawn McCarney // Response handler for parsing output from GetSubTree 1638002d39b4SEd Tanous auto respHandler = 1639002d39b4SEd Tanous [callback{std::forward<Callback>(callback)}, sensorsAsyncResp, 1640002d39b4SEd Tanous inventoryItems]( 1641b9d36b47SEd Tanous const boost::system::error_code ec, 1642002d39b4SEd Tanous const dbus::utility::MapperGetSubTreeResponse& subtree) { 16438fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler enter"; 16448fb49dd6SShawn McCarney if (ec) 16458fb49dd6SShawn McCarney { 16468d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 16478fb49dd6SShawn McCarney BMCWEB_LOG_ERROR 16488fb49dd6SShawn McCarney << "getInventoryItemsConnections respHandler DBus error " << ec; 16498fb49dd6SShawn McCarney return; 16508fb49dd6SShawn McCarney } 16518fb49dd6SShawn McCarney 16528fb49dd6SShawn McCarney // Make unique list of connections for desired inventory items 1653fe04d49cSNan Zhou std::shared_ptr<std::set<std::string>> invConnections = 1654fe04d49cSNan Zhou std::make_shared<std::set<std::string>>(); 16558fb49dd6SShawn McCarney 16568fb49dd6SShawn McCarney // Loop through objects from GetSubTree 16578fb49dd6SShawn McCarney for (const std::pair< 16588fb49dd6SShawn McCarney std::string, 16598fb49dd6SShawn McCarney std::vector<std::pair<std::string, std::vector<std::string>>>>& 16608fb49dd6SShawn McCarney object : subtree) 16618fb49dd6SShawn McCarney { 1662adc4f0dbSShawn McCarney // Check if object path is one of the specified inventory items 16638fb49dd6SShawn McCarney const std::string& objPath = object.first; 1664adc4f0dbSShawn McCarney if (findInventoryItem(inventoryItems, objPath) != nullptr) 16658fb49dd6SShawn McCarney { 16668fb49dd6SShawn McCarney // Store all connections to inventory item 16678fb49dd6SShawn McCarney for (const std::pair<std::string, std::vector<std::string>>& 16688fb49dd6SShawn McCarney objData : object.second) 16698fb49dd6SShawn McCarney { 16708fb49dd6SShawn McCarney const std::string& invConnection = objData.first; 16718fb49dd6SShawn McCarney invConnections->insert(invConnection); 16728fb49dd6SShawn McCarney } 16738fb49dd6SShawn McCarney } 16748fb49dd6SShawn McCarney } 1675d500549bSAnthony Wilson 16768fb49dd6SShawn McCarney callback(invConnections); 16778fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler exit"; 16788fb49dd6SShawn McCarney }; 16798fb49dd6SShawn McCarney 16808fb49dd6SShawn McCarney // Make call to ObjectMapper to find all inventory items 16818fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 16828fb49dd6SShawn McCarney std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 16838fb49dd6SShawn McCarney "/xyz/openbmc_project/object_mapper", 16848fb49dd6SShawn McCarney "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces); 16858fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnections exit"; 16868fb49dd6SShawn McCarney } 16878fb49dd6SShawn McCarney 16888fb49dd6SShawn McCarney /** 1689adc4f0dbSShawn McCarney * @brief Gets associations from sensors to inventory items. 16908fb49dd6SShawn McCarney * 16918fb49dd6SShawn McCarney * Looks for ObjectMapper associations from the specified sensors to related 1692d500549bSAnthony Wilson * inventory items. Then finds the associations from those inventory items to 1693d500549bSAnthony Wilson * their LEDs, if any. 16948fb49dd6SShawn McCarney * 16958fb49dd6SShawn McCarney * Finds the inventory items asynchronously. Invokes callback when information 16968fb49dd6SShawn McCarney * has been obtained. 16978fb49dd6SShawn McCarney * 16988fb49dd6SShawn McCarney * The callback must have the following signature: 16998fb49dd6SShawn McCarney * @code 1700adc4f0dbSShawn McCarney * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 17018fb49dd6SShawn McCarney * @endcode 17028fb49dd6SShawn McCarney * 17038fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 17048fb49dd6SShawn McCarney * @param sensorNames All sensors within the current chassis. 17058fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 17068fb49dd6SShawn McCarney * implements ObjectManager. 17078fb49dd6SShawn McCarney * @param callback Callback to invoke when inventory items have been obtained. 17088fb49dd6SShawn McCarney */ 17098fb49dd6SShawn McCarney template <typename Callback> 1710adc4f0dbSShawn McCarney static void getInventoryItemAssociations( 1711b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 1712fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>>& sensorNames, 1713fe04d49cSNan Zhou const std::shared_ptr<std::map<std::string, std::string>>& objectMgrPaths, 17148fb49dd6SShawn McCarney Callback&& callback) 17158fb49dd6SShawn McCarney { 1716adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations enter"; 17178fb49dd6SShawn McCarney 17188fb49dd6SShawn McCarney // Response handler for GetManagedObjects 171902cad96eSEd Tanous auto respHandler = 172002cad96eSEd Tanous [callback{std::forward<Callback>(callback)}, sensorsAsyncResp, 17218fb49dd6SShawn McCarney sensorNames](const boost::system::error_code ec, 172202cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 1723adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler enter"; 17248fb49dd6SShawn McCarney if (ec) 17258fb49dd6SShawn McCarney { 1726adc4f0dbSShawn McCarney BMCWEB_LOG_ERROR 1727adc4f0dbSShawn McCarney << "getInventoryItemAssociations respHandler DBus error " << ec; 17288d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 17298fb49dd6SShawn McCarney return; 17308fb49dd6SShawn McCarney } 17318fb49dd6SShawn McCarney 1732adc4f0dbSShawn McCarney // Create vector to hold list of inventory items 1733adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems = 1734adc4f0dbSShawn McCarney std::make_shared<std::vector<InventoryItem>>(); 1735adc4f0dbSShawn McCarney 17368fb49dd6SShawn McCarney // Loop through returned object paths 17378fb49dd6SShawn McCarney std::string sensorAssocPath; 17388fb49dd6SShawn McCarney sensorAssocPath.reserve(128); // avoid memory allocations 17398fb49dd6SShawn McCarney for (const auto& objDictEntry : resp) 17408fb49dd6SShawn McCarney { 17418fb49dd6SShawn McCarney const std::string& objPath = 17428fb49dd6SShawn McCarney static_cast<const std::string&>(objDictEntry.first); 17438fb49dd6SShawn McCarney 17448fb49dd6SShawn McCarney // If path is inventory association for one of the specified sensors 17458fb49dd6SShawn McCarney for (const std::string& sensorName : *sensorNames) 17468fb49dd6SShawn McCarney { 17478fb49dd6SShawn McCarney sensorAssocPath = sensorName; 17488fb49dd6SShawn McCarney sensorAssocPath += "/inventory"; 17498fb49dd6SShawn McCarney if (objPath == sensorAssocPath) 17508fb49dd6SShawn McCarney { 17518fb49dd6SShawn McCarney // Get Association interface for object path 1752711ac7a9SEd Tanous for (const auto& [interface, values] : objDictEntry.second) 17538fb49dd6SShawn McCarney { 1754711ac7a9SEd Tanous if (interface == "xyz.openbmc_project.Association") 1755711ac7a9SEd Tanous { 1756711ac7a9SEd Tanous for (const auto& [valueName, value] : values) 1757711ac7a9SEd Tanous { 1758711ac7a9SEd Tanous if (valueName == "endpoints") 17598fb49dd6SShawn McCarney { 17608fb49dd6SShawn McCarney const std::vector<std::string>* endpoints = 17618fb49dd6SShawn McCarney std::get_if<std::vector<std::string>>( 1762711ac7a9SEd Tanous &value); 1763711ac7a9SEd Tanous if ((endpoints != nullptr) && 1764711ac7a9SEd Tanous !endpoints->empty()) 17658fb49dd6SShawn McCarney { 1766adc4f0dbSShawn McCarney // Add inventory item to vector 1767adc4f0dbSShawn McCarney const std::string& invItemPath = 1768adc4f0dbSShawn McCarney endpoints->front(); 1769711ac7a9SEd Tanous addInventoryItem(inventoryItems, 1770711ac7a9SEd Tanous invItemPath, 1771adc4f0dbSShawn McCarney sensorName); 17728fb49dd6SShawn McCarney } 17738fb49dd6SShawn McCarney } 17748fb49dd6SShawn McCarney } 1775711ac7a9SEd Tanous } 1776711ac7a9SEd Tanous } 17778fb49dd6SShawn McCarney break; 17788fb49dd6SShawn McCarney } 17798fb49dd6SShawn McCarney } 17808fb49dd6SShawn McCarney } 17818fb49dd6SShawn McCarney 1782d500549bSAnthony Wilson // Now loop through the returned object paths again, this time to 1783d500549bSAnthony Wilson // find the leds associated with the inventory items we just found 1784d500549bSAnthony Wilson std::string inventoryAssocPath; 1785d500549bSAnthony Wilson inventoryAssocPath.reserve(128); // avoid memory allocations 1786d500549bSAnthony Wilson for (const auto& objDictEntry : resp) 1787d500549bSAnthony Wilson { 1788d500549bSAnthony Wilson const std::string& objPath = 1789d500549bSAnthony Wilson static_cast<const std::string&>(objDictEntry.first); 1790d500549bSAnthony Wilson 1791d500549bSAnthony Wilson for (InventoryItem& inventoryItem : *inventoryItems) 1792d500549bSAnthony Wilson { 1793d500549bSAnthony Wilson inventoryAssocPath = inventoryItem.objectPath; 1794d500549bSAnthony Wilson inventoryAssocPath += "/leds"; 1795d500549bSAnthony Wilson if (objPath == inventoryAssocPath) 1796d500549bSAnthony Wilson { 1797711ac7a9SEd Tanous for (const auto& [interface, values] : objDictEntry.second) 1798d500549bSAnthony Wilson { 1799711ac7a9SEd Tanous if (interface == "xyz.openbmc_project.Association") 1800711ac7a9SEd Tanous { 1801711ac7a9SEd Tanous for (const auto& [valueName, value] : values) 1802711ac7a9SEd Tanous { 1803711ac7a9SEd Tanous if (valueName == "endpoints") 1804d500549bSAnthony Wilson { 1805d500549bSAnthony Wilson const std::vector<std::string>* endpoints = 1806d500549bSAnthony Wilson std::get_if<std::vector<std::string>>( 1807711ac7a9SEd Tanous &value); 1808711ac7a9SEd Tanous if ((endpoints != nullptr) && 1809711ac7a9SEd Tanous !endpoints->empty()) 1810d500549bSAnthony Wilson { 1811711ac7a9SEd Tanous // Add inventory item to vector 1812d500549bSAnthony Wilson // Store LED path in inventory item 1813711ac7a9SEd Tanous const std::string& ledPath = 1814711ac7a9SEd Tanous endpoints->front(); 1815d500549bSAnthony Wilson inventoryItem.ledObjectPath = ledPath; 1816d500549bSAnthony Wilson } 1817d500549bSAnthony Wilson } 1818d500549bSAnthony Wilson } 1819711ac7a9SEd Tanous } 1820711ac7a9SEd Tanous } 1821711ac7a9SEd Tanous 1822d500549bSAnthony Wilson break; 1823d500549bSAnthony Wilson } 1824d500549bSAnthony Wilson } 1825d500549bSAnthony Wilson } 1826adc4f0dbSShawn McCarney callback(inventoryItems); 1827adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler exit"; 18288fb49dd6SShawn McCarney }; 18298fb49dd6SShawn McCarney 18308fb49dd6SShawn McCarney // Find DBus object path that implements ObjectManager for ObjectMapper 18318fb49dd6SShawn McCarney std::string connection = "xyz.openbmc_project.ObjectMapper"; 18328fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(connection); 18338fb49dd6SShawn McCarney const std::string& objectMgrPath = 18348fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 18358fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is " 18368fb49dd6SShawn McCarney << objectMgrPath; 18378fb49dd6SShawn McCarney 18388fb49dd6SShawn McCarney // Call GetManagedObjects on the ObjectMapper to get all associations 18398fb49dd6SShawn McCarney crow::connections::systemBus->async_method_call( 18408fb49dd6SShawn McCarney std::move(respHandler), connection, objectMgrPath, 18418fb49dd6SShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 18428fb49dd6SShawn McCarney 1843adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociations exit"; 18448fb49dd6SShawn McCarney } 18458fb49dd6SShawn McCarney 18468fb49dd6SShawn McCarney /** 1847d500549bSAnthony Wilson * @brief Gets D-Bus data for inventory item leds associated with sensors. 1848d500549bSAnthony Wilson * 1849d500549bSAnthony Wilson * Uses the specified connections (services) to obtain D-Bus data for inventory 1850d500549bSAnthony Wilson * item leds associated with sensors. Stores the resulting data in the 1851d500549bSAnthony Wilson * inventoryItems vector. 1852d500549bSAnthony Wilson * 1853d500549bSAnthony Wilson * This data is later used to provide sensor property values in the JSON 1854d500549bSAnthony Wilson * response. 1855d500549bSAnthony Wilson * 1856d500549bSAnthony Wilson * Finds the inventory item led data asynchronously. Invokes callback when data 1857d500549bSAnthony Wilson * has been obtained. 1858d500549bSAnthony Wilson * 1859d500549bSAnthony Wilson * The callback must have the following signature: 1860d500549bSAnthony Wilson * @code 186142cbe538SGunnar Mills * callback() 1862d500549bSAnthony Wilson * @endcode 1863d500549bSAnthony Wilson * 1864d500549bSAnthony Wilson * This function is called recursively, obtaining data asynchronously from one 1865d500549bSAnthony Wilson * connection in each call. This ensures the callback is not invoked until the 1866d500549bSAnthony Wilson * last asynchronous function has completed. 1867d500549bSAnthony Wilson * 1868d500549bSAnthony Wilson * @param sensorsAsyncResp Pointer to object holding response data. 1869d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1870d500549bSAnthony Wilson * @param ledConnections Connections that provide data for the inventory leds. 1871d500549bSAnthony Wilson * @param callback Callback to invoke when inventory data has been obtained. 1872d500549bSAnthony Wilson * @param ledConnectionsIndex Current index in ledConnections. Only specified 1873d500549bSAnthony Wilson * in recursive calls to this function. 1874d500549bSAnthony Wilson */ 1875d500549bSAnthony Wilson template <typename Callback> 1876d500549bSAnthony Wilson void getInventoryLedData( 1877d500549bSAnthony Wilson std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1878d500549bSAnthony Wilson std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 1879fe04d49cSNan Zhou std::shared_ptr<std::map<std::string, std::string>> ledConnections, 1880d500549bSAnthony Wilson Callback&& callback, size_t ledConnectionsIndex = 0) 1881d500549bSAnthony Wilson { 1882d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData enter"; 1883d500549bSAnthony Wilson 1884d500549bSAnthony Wilson // If no more connections left, call callback 1885d500549bSAnthony Wilson if (ledConnectionsIndex >= ledConnections->size()) 1886d500549bSAnthony Wilson { 188742cbe538SGunnar Mills callback(); 1888d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData exit"; 1889d500549bSAnthony Wilson return; 1890d500549bSAnthony Wilson } 1891d500549bSAnthony Wilson 1892d500549bSAnthony Wilson // Get inventory item data from current connection 1893fe04d49cSNan Zhou auto it = ledConnections->begin(); 1894fe04d49cSNan Zhou std::advance(it, ledConnectionsIndex); 1895d500549bSAnthony Wilson if (it != ledConnections->end()) 1896d500549bSAnthony Wilson { 1897d500549bSAnthony Wilson const std::string& ledPath = (*it).first; 1898d500549bSAnthony Wilson const std::string& ledConnection = (*it).second; 1899d500549bSAnthony Wilson // Response handler for Get State property 19001e1e598dSJonathan Doman auto respHandler = 19011e1e598dSJonathan Doman [sensorsAsyncResp, inventoryItems, ledConnections, ledPath, 1902f94c4ecfSEd Tanous callback{std::forward<Callback>(callback)}, ledConnectionsIndex]( 19031e1e598dSJonathan Doman const boost::system::error_code ec, const std::string& state) { 1904d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler enter"; 1905d500549bSAnthony Wilson if (ec) 1906d500549bSAnthony Wilson { 1907d500549bSAnthony Wilson BMCWEB_LOG_ERROR 1908d500549bSAnthony Wilson << "getInventoryLedData respHandler DBus error " << ec; 19098d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 1910d500549bSAnthony Wilson return; 1911d500549bSAnthony Wilson } 1912d500549bSAnthony Wilson 19131e1e598dSJonathan Doman BMCWEB_LOG_DEBUG << "Led state: " << state; 1914d500549bSAnthony Wilson // Find inventory item with this LED object path 1915d500549bSAnthony Wilson InventoryItem* inventoryItem = 1916d500549bSAnthony Wilson findInventoryItemForLed(*inventoryItems, ledPath); 1917d500549bSAnthony Wilson if (inventoryItem != nullptr) 1918d500549bSAnthony Wilson { 1919d500549bSAnthony Wilson // Store LED state in InventoryItem 192011ba3979SEd Tanous if (state.ends_with("On")) 1921d500549bSAnthony Wilson { 1922d500549bSAnthony Wilson inventoryItem->ledState = LedState::ON; 1923d500549bSAnthony Wilson } 192411ba3979SEd Tanous else if (state.ends_with("Blink")) 1925d500549bSAnthony Wilson { 1926d500549bSAnthony Wilson inventoryItem->ledState = LedState::BLINK; 1927d500549bSAnthony Wilson } 192811ba3979SEd Tanous else if (state.ends_with("Off")) 1929d500549bSAnthony Wilson { 1930d500549bSAnthony Wilson inventoryItem->ledState = LedState::OFF; 1931d500549bSAnthony Wilson } 1932d500549bSAnthony Wilson else 1933d500549bSAnthony Wilson { 1934d500549bSAnthony Wilson inventoryItem->ledState = LedState::UNKNOWN; 1935d500549bSAnthony Wilson } 1936d500549bSAnthony Wilson } 1937d500549bSAnthony Wilson 1938d500549bSAnthony Wilson // Recurse to get LED data from next connection 1939d500549bSAnthony Wilson getInventoryLedData(sensorsAsyncResp, inventoryItems, 1940d500549bSAnthony Wilson ledConnections, std::move(callback), 1941d500549bSAnthony Wilson ledConnectionsIndex + 1); 1942d500549bSAnthony Wilson 1943d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler exit"; 1944d500549bSAnthony Wilson }; 1945d500549bSAnthony Wilson 1946d500549bSAnthony Wilson // Get the State property for the current LED 19471e1e598dSJonathan Doman sdbusplus::asio::getProperty<std::string>( 19481e1e598dSJonathan Doman *crow::connections::systemBus, ledConnection, ledPath, 19491e1e598dSJonathan Doman "xyz.openbmc_project.Led.Physical", "State", 19501e1e598dSJonathan Doman std::move(respHandler)); 1951d500549bSAnthony Wilson } 1952d500549bSAnthony Wilson 1953d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLedData exit"; 1954d500549bSAnthony Wilson } 1955d500549bSAnthony Wilson 1956d500549bSAnthony Wilson /** 1957d500549bSAnthony Wilson * @brief Gets LED data for LEDs associated with given inventory items. 1958d500549bSAnthony Wilson * 1959d500549bSAnthony Wilson * Gets the D-Bus connections (services) that provide LED data for the LEDs 1960d500549bSAnthony Wilson * associated with the specified inventory items. Then gets the LED data from 1961d500549bSAnthony Wilson * each connection and stores it in the inventory item. 1962d500549bSAnthony Wilson * 1963d500549bSAnthony Wilson * This data is later used to provide sensor property values in the JSON 1964d500549bSAnthony Wilson * response. 1965d500549bSAnthony Wilson * 1966d500549bSAnthony Wilson * Finds the LED data asynchronously. Invokes callback when information has 1967d500549bSAnthony Wilson * been obtained. 1968d500549bSAnthony Wilson * 1969d500549bSAnthony Wilson * The callback must have the following signature: 1970d500549bSAnthony Wilson * @code 197142cbe538SGunnar Mills * callback() 1972d500549bSAnthony Wilson * @endcode 1973d500549bSAnthony Wilson * 1974d500549bSAnthony Wilson * @param sensorsAsyncResp Pointer to object holding response data. 1975d500549bSAnthony Wilson * @param inventoryItems D-Bus inventory items associated with sensors. 1976d500549bSAnthony Wilson * @param callback Callback to invoke when inventory items have been obtained. 1977d500549bSAnthony Wilson */ 1978d500549bSAnthony Wilson template <typename Callback> 1979d500549bSAnthony Wilson void getInventoryLeds( 1980d500549bSAnthony Wilson std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 1981d500549bSAnthony Wilson std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 1982d500549bSAnthony Wilson Callback&& callback) 1983d500549bSAnthony Wilson { 1984d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds enter"; 1985d500549bSAnthony Wilson 1986d500549bSAnthony Wilson const std::string path = "/xyz/openbmc_project"; 1987d500549bSAnthony Wilson const std::array<std::string, 1> interfaces = { 1988d500549bSAnthony Wilson "xyz.openbmc_project.Led.Physical"}; 1989d500549bSAnthony Wilson 1990d500549bSAnthony Wilson // Response handler for parsing output from GetSubTree 1991002d39b4SEd Tanous auto respHandler = 1992002d39b4SEd Tanous [callback{std::forward<Callback>(callback)}, sensorsAsyncResp, 1993002d39b4SEd Tanous inventoryItems]( 1994b9d36b47SEd Tanous const boost::system::error_code ec, 1995002d39b4SEd Tanous const dbus::utility::MapperGetSubTreeResponse& subtree) { 1996d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler enter"; 1997d500549bSAnthony Wilson if (ec) 1998d500549bSAnthony Wilson { 19998d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2000d500549bSAnthony Wilson BMCWEB_LOG_ERROR << "getInventoryLeds respHandler DBus error " 2001d500549bSAnthony Wilson << ec; 2002d500549bSAnthony Wilson return; 2003d500549bSAnthony Wilson } 2004d500549bSAnthony Wilson 2005d500549bSAnthony Wilson // Build map of LED object paths to connections 2006fe04d49cSNan Zhou std::shared_ptr<std::map<std::string, std::string>> ledConnections = 2007fe04d49cSNan Zhou std::make_shared<std::map<std::string, std::string>>(); 2008d500549bSAnthony Wilson 2009d500549bSAnthony Wilson // Loop through objects from GetSubTree 2010d500549bSAnthony Wilson for (const std::pair< 2011d500549bSAnthony Wilson std::string, 2012d500549bSAnthony Wilson std::vector<std::pair<std::string, std::vector<std::string>>>>& 2013d500549bSAnthony Wilson object : subtree) 2014d500549bSAnthony Wilson { 2015d500549bSAnthony Wilson // Check if object path is LED for one of the specified inventory 2016d500549bSAnthony Wilson // items 2017d500549bSAnthony Wilson const std::string& ledPath = object.first; 2018d500549bSAnthony Wilson if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr) 2019d500549bSAnthony Wilson { 2020d500549bSAnthony Wilson // Add mapping from ledPath to connection 2021d500549bSAnthony Wilson const std::string& connection = object.second.begin()->first; 2022d500549bSAnthony Wilson (*ledConnections)[ledPath] = connection; 2023d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "Added mapping " << ledPath << " -> " 2024d500549bSAnthony Wilson << connection; 2025d500549bSAnthony Wilson } 2026d500549bSAnthony Wilson } 2027d500549bSAnthony Wilson 2028d500549bSAnthony Wilson getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections, 2029d500549bSAnthony Wilson std::move(callback)); 2030d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler exit"; 2031d500549bSAnthony Wilson }; 2032d500549bSAnthony Wilson // Make call to ObjectMapper to find all inventory items 2033d500549bSAnthony Wilson crow::connections::systemBus->async_method_call( 2034d500549bSAnthony Wilson std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 2035d500549bSAnthony Wilson "/xyz/openbmc_project/object_mapper", 2036d500549bSAnthony Wilson "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces); 2037d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryLeds exit"; 2038d500549bSAnthony Wilson } 2039d500549bSAnthony Wilson 2040d500549bSAnthony Wilson /** 204142cbe538SGunnar Mills * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent 204242cbe538SGunnar Mills * 204342cbe538SGunnar Mills * Uses the specified connections (services) (currently assumes just one) to 204442cbe538SGunnar Mills * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in 204542cbe538SGunnar Mills * the inventoryItems vector. Only stores data in Power Supply inventoryItems. 204642cbe538SGunnar Mills * 204742cbe538SGunnar Mills * This data is later used to provide sensor property values in the JSON 204842cbe538SGunnar Mills * response. 204942cbe538SGunnar Mills * 205042cbe538SGunnar Mills * Finds the Power Supply Attributes data asynchronously. Invokes callback 205142cbe538SGunnar Mills * when data has been obtained. 205242cbe538SGunnar Mills * 205342cbe538SGunnar Mills * The callback must have the following signature: 205442cbe538SGunnar Mills * @code 205542cbe538SGunnar Mills * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 205642cbe538SGunnar Mills * @endcode 205742cbe538SGunnar Mills * 205842cbe538SGunnar Mills * @param sensorsAsyncResp Pointer to object holding response data. 205942cbe538SGunnar Mills * @param inventoryItems D-Bus inventory items associated with sensors. 206042cbe538SGunnar Mills * @param psAttributesConnections Connections that provide data for the Power 206142cbe538SGunnar Mills * Supply Attributes 206242cbe538SGunnar Mills * @param callback Callback to invoke when data has been obtained. 206342cbe538SGunnar Mills */ 206442cbe538SGunnar Mills template <typename Callback> 206542cbe538SGunnar Mills void getPowerSupplyAttributesData( 2066b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 206742cbe538SGunnar Mills std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 2068fe04d49cSNan Zhou const std::map<std::string, std::string>& psAttributesConnections, 206942cbe538SGunnar Mills Callback&& callback) 207042cbe538SGunnar Mills { 207142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData enter"; 207242cbe538SGunnar Mills 207342cbe538SGunnar Mills if (psAttributesConnections.empty()) 207442cbe538SGunnar Mills { 207542cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Can't find PowerSupplyAttributes, no connections!"; 207642cbe538SGunnar Mills callback(inventoryItems); 207742cbe538SGunnar Mills return; 207842cbe538SGunnar Mills } 207942cbe538SGunnar Mills 208042cbe538SGunnar Mills // Assuming just one connection (service) for now 2081fe04d49cSNan Zhou auto it = psAttributesConnections.begin(); 208242cbe538SGunnar Mills 208342cbe538SGunnar Mills const std::string& psAttributesPath = (*it).first; 208442cbe538SGunnar Mills const std::string& psAttributesConnection = (*it).second; 208542cbe538SGunnar Mills 208642cbe538SGunnar Mills // Response handler for Get DeratingFactor property 2087002d39b4SEd Tanous auto respHandler = 2088002d39b4SEd Tanous [sensorsAsyncResp, inventoryItems, 2089f94c4ecfSEd Tanous callback{std::forward<Callback>(callback)}]( 2090002d39b4SEd Tanous const boost::system::error_code ec, const uint32_t value) { 209142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler enter"; 209242cbe538SGunnar Mills if (ec) 209342cbe538SGunnar Mills { 209442cbe538SGunnar Mills BMCWEB_LOG_ERROR 209542cbe538SGunnar Mills << "getPowerSupplyAttributesData respHandler DBus error " << ec; 20968d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 209742cbe538SGunnar Mills return; 209842cbe538SGunnar Mills } 209942cbe538SGunnar Mills 21001e1e598dSJonathan Doman BMCWEB_LOG_DEBUG << "PS EfficiencyPercent value: " << value; 210142cbe538SGunnar Mills // Store value in Power Supply Inventory Items 210242cbe538SGunnar Mills for (InventoryItem& inventoryItem : *inventoryItems) 210342cbe538SGunnar Mills { 210455f79e6fSEd Tanous if (inventoryItem.isPowerSupply) 210542cbe538SGunnar Mills { 210642cbe538SGunnar Mills inventoryItem.powerSupplyEfficiencyPercent = 21071e1e598dSJonathan Doman static_cast<int>(value); 210842cbe538SGunnar Mills } 210942cbe538SGunnar Mills } 211042cbe538SGunnar Mills 211142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler exit"; 211242cbe538SGunnar Mills callback(inventoryItems); 211342cbe538SGunnar Mills }; 211442cbe538SGunnar Mills 211542cbe538SGunnar Mills // Get the DeratingFactor property for the PowerSupplyAttributes 211642cbe538SGunnar Mills // Currently only property on the interface/only one we care about 21171e1e598dSJonathan Doman sdbusplus::asio::getProperty<uint32_t>( 21181e1e598dSJonathan Doman *crow::connections::systemBus, psAttributesConnection, psAttributesPath, 21191e1e598dSJonathan Doman "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor", 21201e1e598dSJonathan Doman std::move(respHandler)); 212142cbe538SGunnar Mills 212242cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData exit"; 212342cbe538SGunnar Mills } 212442cbe538SGunnar Mills 212542cbe538SGunnar Mills /** 212642cbe538SGunnar Mills * @brief Gets the Power Supply Attributes such as EfficiencyPercent 212742cbe538SGunnar Mills * 212842cbe538SGunnar Mills * Gets the D-Bus connection (service) that provides Power Supply Attributes 212942cbe538SGunnar Mills * data. Then gets the Power Supply Attributes data from the connection 213042cbe538SGunnar Mills * (currently just assumes 1 connection) and stores the data in the inventory 213142cbe538SGunnar Mills * item. 213242cbe538SGunnar Mills * 213342cbe538SGunnar Mills * This data is later used to provide sensor property values in the JSON 213442cbe538SGunnar Mills * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish. 213542cbe538SGunnar Mills * 213642cbe538SGunnar Mills * Finds the Power Supply Attributes data asynchronously. Invokes callback 213742cbe538SGunnar Mills * when information 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 callback Callback to invoke when data has been obtained. 214742cbe538SGunnar Mills */ 214842cbe538SGunnar Mills template <typename Callback> 214942cbe538SGunnar Mills void getPowerSupplyAttributes( 215042cbe538SGunnar Mills std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 215142cbe538SGunnar Mills std::shared_ptr<std::vector<InventoryItem>> inventoryItems, 215242cbe538SGunnar Mills Callback&& callback) 215342cbe538SGunnar Mills { 215442cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes enter"; 215542cbe538SGunnar Mills 215642cbe538SGunnar Mills // Only need the power supply attributes when the Power Schema 2157a0ec28b6SAdrian Ambrożewicz if (sensorsAsyncResp->chassisSubNode != sensors::node::power) 215842cbe538SGunnar Mills { 215942cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit since not Power"; 216042cbe538SGunnar Mills callback(inventoryItems); 216142cbe538SGunnar Mills return; 216242cbe538SGunnar Mills } 216342cbe538SGunnar Mills 216442cbe538SGunnar Mills const std::array<std::string, 1> interfaces = { 216542cbe538SGunnar Mills "xyz.openbmc_project.Control.PowerSupplyAttributes"}; 216642cbe538SGunnar Mills 216742cbe538SGunnar Mills // Response handler for parsing output from GetSubTree 2168b9d36b47SEd Tanous auto respHandler = 2169b9d36b47SEd Tanous [callback{std::forward<Callback>(callback)}, sensorsAsyncResp, 2170b9d36b47SEd Tanous inventoryItems]( 2171b9d36b47SEd Tanous const boost::system::error_code ec, 2172b9d36b47SEd Tanous const dbus::utility::MapperGetSubTreeResponse& subtree) { 217342cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler enter"; 217442cbe538SGunnar Mills if (ec) 217542cbe538SGunnar Mills { 21768d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 217742cbe538SGunnar Mills BMCWEB_LOG_ERROR 217842cbe538SGunnar Mills << "getPowerSupplyAttributes respHandler DBus error " << ec; 217942cbe538SGunnar Mills return; 218042cbe538SGunnar Mills } 218126f6976fSEd Tanous if (subtree.empty()) 218242cbe538SGunnar Mills { 218342cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Can't find Power Supply Attributes!"; 218442cbe538SGunnar Mills callback(inventoryItems); 218542cbe538SGunnar Mills return; 218642cbe538SGunnar Mills } 218742cbe538SGunnar Mills 218842cbe538SGunnar Mills // Currently we only support 1 power supply attribute, use this for 218942cbe538SGunnar Mills // all the power supplies. Build map of object path to connection. 219042cbe538SGunnar Mills // Assume just 1 connection and 1 path for now. 2191fe04d49cSNan Zhou std::map<std::string, std::string> psAttributesConnections; 219242cbe538SGunnar Mills 219342cbe538SGunnar Mills if (subtree[0].first.empty() || subtree[0].second.empty()) 219442cbe538SGunnar Mills { 219542cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!"; 219642cbe538SGunnar Mills callback(inventoryItems); 219742cbe538SGunnar Mills return; 219842cbe538SGunnar Mills } 219942cbe538SGunnar Mills 220042cbe538SGunnar Mills const std::string& psAttributesPath = subtree[0].first; 220142cbe538SGunnar Mills const std::string& connection = subtree[0].second.begin()->first; 220242cbe538SGunnar Mills 220342cbe538SGunnar Mills if (connection.empty()) 220442cbe538SGunnar Mills { 220542cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!"; 220642cbe538SGunnar Mills callback(inventoryItems); 220742cbe538SGunnar Mills return; 220842cbe538SGunnar Mills } 220942cbe538SGunnar Mills 221042cbe538SGunnar Mills psAttributesConnections[psAttributesPath] = connection; 221142cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "Added mapping " << psAttributesPath << " -> " 221242cbe538SGunnar Mills << connection; 221342cbe538SGunnar Mills 221442cbe538SGunnar Mills getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems, 221542cbe538SGunnar Mills psAttributesConnections, 221642cbe538SGunnar Mills std::move(callback)); 221742cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler exit"; 221842cbe538SGunnar Mills }; 221942cbe538SGunnar Mills // Make call to ObjectMapper to find the PowerSupplyAttributes service 222042cbe538SGunnar Mills crow::connections::systemBus->async_method_call( 222142cbe538SGunnar Mills std::move(respHandler), "xyz.openbmc_project.ObjectMapper", 222242cbe538SGunnar Mills "/xyz/openbmc_project/object_mapper", 222342cbe538SGunnar Mills "xyz.openbmc_project.ObjectMapper", "GetSubTree", 222442cbe538SGunnar Mills "/xyz/openbmc_project", 0, interfaces); 222542cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit"; 222642cbe538SGunnar Mills } 222742cbe538SGunnar Mills 222842cbe538SGunnar Mills /** 2229adc4f0dbSShawn McCarney * @brief Gets inventory items associated with sensors. 22308fb49dd6SShawn McCarney * 22318fb49dd6SShawn McCarney * Finds the inventory items that are associated with the specified sensors. 2232adc4f0dbSShawn McCarney * Then gets D-Bus data for the inventory items, such as presence and VPD. 22338fb49dd6SShawn McCarney * 2234adc4f0dbSShawn McCarney * This data is later used to provide sensor property values in the JSON 2235adc4f0dbSShawn McCarney * response. 22368fb49dd6SShawn McCarney * 2237adc4f0dbSShawn McCarney * Finds the inventory items asynchronously. Invokes callback when the 2238adc4f0dbSShawn McCarney * inventory items have been obtained. 2239adc4f0dbSShawn McCarney * 2240adc4f0dbSShawn McCarney * The callback must have the following signature: 2241adc4f0dbSShawn McCarney * @code 2242adc4f0dbSShawn McCarney * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems) 2243adc4f0dbSShawn McCarney * @endcode 22448fb49dd6SShawn McCarney * 22458fb49dd6SShawn McCarney * @param sensorsAsyncResp Pointer to object holding response data. 22468fb49dd6SShawn McCarney * @param sensorNames All sensors within the current chassis. 22478fb49dd6SShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 22488fb49dd6SShawn McCarney * implements ObjectManager. 2249adc4f0dbSShawn McCarney * @param callback Callback to invoke when inventory items have been obtained. 22508fb49dd6SShawn McCarney */ 2251adc4f0dbSShawn McCarney template <typename Callback> 2252adc4f0dbSShawn McCarney static void getInventoryItems( 22538fb49dd6SShawn McCarney std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp, 2254fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>> sensorNames, 2255fe04d49cSNan Zhou std::shared_ptr<std::map<std::string, std::string>> objectMgrPaths, 2256adc4f0dbSShawn McCarney Callback&& callback) 22578fb49dd6SShawn McCarney { 2258adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItems enter"; 2259adc4f0dbSShawn McCarney auto getInventoryItemAssociationsCb = 2260f94c4ecfSEd Tanous [sensorsAsyncResp, objectMgrPaths, 2261f94c4ecfSEd Tanous callback{std::forward<Callback>(callback)}]( 2262adc4f0dbSShawn McCarney std::shared_ptr<std::vector<InventoryItem>> inventoryItems) { 2263adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb enter"; 22648fb49dd6SShawn McCarney auto getInventoryItemsConnectionsCb = 2265adc4f0dbSShawn McCarney [sensorsAsyncResp, inventoryItems, objectMgrPaths, 2266f94c4ecfSEd Tanous callback{std::forward<const Callback>(callback)}]( 2267fe04d49cSNan Zhou std::shared_ptr<std::set<std::string>> invConnections) { 22688fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb enter"; 2269002d39b4SEd Tanous auto getInventoryItemsDataCb = [sensorsAsyncResp, inventoryItems, 2270d500549bSAnthony Wilson callback{std::move(callback)}]() { 2271d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb enter"; 227242cbe538SGunnar Mills 2273002d39b4SEd Tanous auto getInventoryLedsCb = [sensorsAsyncResp, inventoryItems, 2274002d39b4SEd Tanous callback{std::move(callback)}]() { 227542cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getInventoryLedsCb enter"; 227642cbe538SGunnar Mills // Find Power Supply Attributes and get the data 2277002d39b4SEd Tanous getPowerSupplyAttributes(sensorsAsyncResp, inventoryItems, 227842cbe538SGunnar Mills std::move(callback)); 227942cbe538SGunnar Mills BMCWEB_LOG_DEBUG << "getInventoryLedsCb exit"; 228042cbe538SGunnar Mills }; 228142cbe538SGunnar Mills 2282d500549bSAnthony Wilson // Find led connections and get the data 2283d500549bSAnthony Wilson getInventoryLeds(sensorsAsyncResp, inventoryItems, 228442cbe538SGunnar Mills std::move(getInventoryLedsCb)); 2285d500549bSAnthony Wilson BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb exit"; 2286d500549bSAnthony Wilson }; 22878fb49dd6SShawn McCarney 2288adc4f0dbSShawn McCarney // Get inventory item data from connections 2289adc4f0dbSShawn McCarney getInventoryItemsData(sensorsAsyncResp, inventoryItems, 2290adc4f0dbSShawn McCarney invConnections, objectMgrPaths, 2291d500549bSAnthony Wilson std::move(getInventoryItemsDataCb)); 22928fb49dd6SShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb exit"; 22938fb49dd6SShawn McCarney }; 22948fb49dd6SShawn McCarney 2295adc4f0dbSShawn McCarney // Get connections that provide inventory item data 2296002d39b4SEd Tanous getInventoryItemsConnections(sensorsAsyncResp, inventoryItems, 22978fb49dd6SShawn McCarney std::move(getInventoryItemsConnectionsCb)); 2298adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb exit"; 22998fb49dd6SShawn McCarney }; 23008fb49dd6SShawn McCarney 2301adc4f0dbSShawn McCarney // Get associations from sensors to inventory items 2302adc4f0dbSShawn McCarney getInventoryItemAssociations(sensorsAsyncResp, sensorNames, objectMgrPaths, 2303adc4f0dbSShawn McCarney std::move(getInventoryItemAssociationsCb)); 2304adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItems exit"; 2305adc4f0dbSShawn McCarney } 2306adc4f0dbSShawn McCarney 2307adc4f0dbSShawn McCarney /** 2308adc4f0dbSShawn McCarney * @brief Returns JSON PowerSupply object for the specified inventory item. 2309adc4f0dbSShawn McCarney * 2310adc4f0dbSShawn McCarney * Searches for a JSON PowerSupply object that matches the specified inventory 2311adc4f0dbSShawn McCarney * item. If one is not found, a new PowerSupply object is added to the JSON 2312adc4f0dbSShawn McCarney * array. 2313adc4f0dbSShawn McCarney * 2314adc4f0dbSShawn McCarney * Multiple sensors are often associated with one power supply inventory item. 2315adc4f0dbSShawn McCarney * As a result, multiple sensor values are stored in one JSON PowerSupply 2316adc4f0dbSShawn McCarney * object. 2317adc4f0dbSShawn McCarney * 2318adc4f0dbSShawn McCarney * @param powerSupplyArray JSON array containing Redfish PowerSupply objects. 2319adc4f0dbSShawn McCarney * @param inventoryItem Inventory item for the power supply. 2320adc4f0dbSShawn McCarney * @param chassisId Chassis that contains the power supply. 2321adc4f0dbSShawn McCarney * @return JSON PowerSupply object for the specified inventory item. 2322adc4f0dbSShawn McCarney */ 232323a21a1cSEd Tanous inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray, 2324adc4f0dbSShawn McCarney const InventoryItem& inventoryItem, 2325adc4f0dbSShawn McCarney const std::string& chassisId) 2326adc4f0dbSShawn McCarney { 2327adc4f0dbSShawn McCarney // Check if matching PowerSupply object already exists in JSON array 2328adc4f0dbSShawn McCarney for (nlohmann::json& powerSupply : powerSupplyArray) 2329adc4f0dbSShawn McCarney { 2330adc4f0dbSShawn McCarney if (powerSupply["MemberId"] == inventoryItem.name) 2331adc4f0dbSShawn McCarney { 2332adc4f0dbSShawn McCarney return powerSupply; 2333adc4f0dbSShawn McCarney } 2334adc4f0dbSShawn McCarney } 2335adc4f0dbSShawn McCarney 2336adc4f0dbSShawn McCarney // Add new PowerSupply object to JSON array 2337adc4f0dbSShawn McCarney powerSupplyArray.push_back({}); 2338adc4f0dbSShawn McCarney nlohmann::json& powerSupply = powerSupplyArray.back(); 2339adc4f0dbSShawn McCarney powerSupply["@odata.id"] = 2340adc4f0dbSShawn McCarney "/redfish/v1/Chassis/" + chassisId + "/Power#/PowerSupplies/"; 2341adc4f0dbSShawn McCarney powerSupply["MemberId"] = inventoryItem.name; 2342adc4f0dbSShawn McCarney powerSupply["Name"] = boost::replace_all_copy(inventoryItem.name, "_", " "); 2343adc4f0dbSShawn McCarney powerSupply["Manufacturer"] = inventoryItem.manufacturer; 2344adc4f0dbSShawn McCarney powerSupply["Model"] = inventoryItem.model; 2345adc4f0dbSShawn McCarney powerSupply["PartNumber"] = inventoryItem.partNumber; 2346adc4f0dbSShawn McCarney powerSupply["SerialNumber"] = inventoryItem.serialNumber; 2347d500549bSAnthony Wilson setLedState(powerSupply, &inventoryItem); 2348adc4f0dbSShawn McCarney 234942cbe538SGunnar Mills if (inventoryItem.powerSupplyEfficiencyPercent >= 0) 235042cbe538SGunnar Mills { 235142cbe538SGunnar Mills powerSupply["EfficiencyPercent"] = 235242cbe538SGunnar Mills inventoryItem.powerSupplyEfficiencyPercent; 235342cbe538SGunnar Mills } 235442cbe538SGunnar Mills 235542cbe538SGunnar Mills powerSupply["Status"]["State"] = getState(&inventoryItem); 2356adc4f0dbSShawn McCarney const char* health = inventoryItem.isFunctional ? "OK" : "Critical"; 2357adc4f0dbSShawn McCarney powerSupply["Status"]["Health"] = health; 2358adc4f0dbSShawn McCarney 2359adc4f0dbSShawn McCarney return powerSupply; 23608fb49dd6SShawn McCarney } 23618fb49dd6SShawn McCarney 23628fb49dd6SShawn McCarney /** 2363de629b6eSShawn McCarney * @brief Gets the values of the specified sensors. 2364de629b6eSShawn McCarney * 2365de629b6eSShawn McCarney * Stores the results as JSON in the SensorsAsyncResp. 2366de629b6eSShawn McCarney * 2367de629b6eSShawn McCarney * Gets the sensor values asynchronously. Stores the results later when the 2368de629b6eSShawn McCarney * information has been obtained. 2369de629b6eSShawn McCarney * 2370adc4f0dbSShawn McCarney * The sensorNames set contains all requested sensors for the current chassis. 2371de629b6eSShawn McCarney * 2372de629b6eSShawn McCarney * To minimize the number of DBus calls, the DBus method 2373de629b6eSShawn McCarney * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the 2374de629b6eSShawn McCarney * values of all sensors provided by a connection (service). 2375de629b6eSShawn McCarney * 2376de629b6eSShawn McCarney * The connections set contains all the connections that provide sensor values. 2377de629b6eSShawn McCarney * 2378de629b6eSShawn McCarney * The objectMgrPaths map contains mappings from a connection name to the 2379de629b6eSShawn McCarney * corresponding DBus object path that implements ObjectManager. 2380de629b6eSShawn McCarney * 2381adc4f0dbSShawn McCarney * The InventoryItem vector contains D-Bus inventory items associated with the 2382adc4f0dbSShawn McCarney * sensors. Inventory item data is needed for some Redfish sensor properties. 2383adc4f0dbSShawn McCarney * 2384de629b6eSShawn McCarney * @param SensorsAsyncResp Pointer to object holding response data. 2385adc4f0dbSShawn McCarney * @param sensorNames All requested sensors within the current chassis. 2386de629b6eSShawn McCarney * @param connections Connections that provide sensor values. 2387de629b6eSShawn McCarney * @param objectMgrPaths Mappings from connection name to DBus object path that 2388de629b6eSShawn McCarney * implements ObjectManager. 2389adc4f0dbSShawn McCarney * @param inventoryItems Inventory items associated with the sensors. 2390de629b6eSShawn McCarney */ 239123a21a1cSEd Tanous inline void getSensorData( 239281ce609eSEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 2393fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>>& sensorNames, 2394fe04d49cSNan Zhou const std::set<std::string>& connections, 2395fe04d49cSNan Zhou const std::shared_ptr<std::map<std::string, std::string>>& objectMgrPaths, 2396b5a76932SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems) 2397de629b6eSShawn McCarney { 2398de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getSensorData enter"; 2399de629b6eSShawn McCarney // Get managed objects from all services exposing sensors 2400de629b6eSShawn McCarney for (const std::string& connection : connections) 2401de629b6eSShawn McCarney { 2402de629b6eSShawn McCarney // Response handler to process managed objects 2403002d39b4SEd Tanous auto getManagedObjectsCb = 2404002d39b4SEd Tanous [sensorsAsyncResp, sensorNames, 2405002d39b4SEd Tanous inventoryItems](const boost::system::error_code ec, 240602cad96eSEd Tanous const dbus::utility::ManagedObjectType& resp) { 2407de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb enter"; 2408de629b6eSShawn McCarney if (ec) 2409de629b6eSShawn McCarney { 2410de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "getManagedObjectsCb DBUS error: " << ec; 24118d1b46d7Szhanghch05 messages::internalError(sensorsAsyncResp->asyncResp->res); 2412de629b6eSShawn McCarney return; 2413de629b6eSShawn McCarney } 2414de629b6eSShawn McCarney // Go through all objects and update response with sensor data 2415de629b6eSShawn McCarney for (const auto& objDictEntry : resp) 2416de629b6eSShawn McCarney { 2417de629b6eSShawn McCarney const std::string& objPath = 2418de629b6eSShawn McCarney static_cast<const std::string&>(objDictEntry.first); 2419de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb parsing object " 2420de629b6eSShawn McCarney << objPath; 2421de629b6eSShawn McCarney 2422de629b6eSShawn McCarney std::vector<std::string> split; 2423de629b6eSShawn McCarney // Reserve space for 2424de629b6eSShawn McCarney // /xyz/openbmc_project/sensors/<name>/<subname> 2425de629b6eSShawn McCarney split.reserve(6); 2426de629b6eSShawn McCarney boost::algorithm::split(split, objPath, boost::is_any_of("/")); 2427de629b6eSShawn McCarney if (split.size() < 6) 2428de629b6eSShawn McCarney { 2429de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "Got path that isn't long enough " 2430de629b6eSShawn McCarney << objPath; 2431de629b6eSShawn McCarney continue; 2432de629b6eSShawn McCarney } 2433de629b6eSShawn McCarney // These indexes aren't intuitive, as boost::split puts an empty 2434de629b6eSShawn McCarney // string at the beginning 2435de629b6eSShawn McCarney const std::string& sensorType = split[4]; 2436de629b6eSShawn McCarney const std::string& sensorName = split[5]; 2437de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "sensorName " << sensorName 2438de629b6eSShawn McCarney << " sensorType " << sensorType; 243949c53ac9SJohnathan Mantey if (sensorNames->find(objPath) == sensorNames->end()) 2440de629b6eSShawn McCarney { 2441accdbb2cSAndrew Geissler BMCWEB_LOG_DEBUG << sensorName << " not in sensor list "; 2442de629b6eSShawn McCarney continue; 2443de629b6eSShawn McCarney } 2444de629b6eSShawn McCarney 2445adc4f0dbSShawn McCarney // Find inventory item (if any) associated with sensor 2446adc4f0dbSShawn McCarney InventoryItem* inventoryItem = 2447adc4f0dbSShawn McCarney findInventoryItemForSensor(inventoryItems, objPath); 2448adc4f0dbSShawn McCarney 244995a3ecadSAnthony Wilson const std::string& sensorSchema = 245081ce609eSEd Tanous sensorsAsyncResp->chassisSubNode; 245195a3ecadSAnthony Wilson 245295a3ecadSAnthony Wilson nlohmann::json* sensorJson = nullptr; 245395a3ecadSAnthony Wilson 2454928fefb9SNan Zhou if (sensorSchema == sensors::node::sensors && 2455928fefb9SNan Zhou !sensorsAsyncResp->efficientExpand) 245695a3ecadSAnthony Wilson { 24578d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] = 245881ce609eSEd Tanous "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + 245981ce609eSEd Tanous "/" + sensorsAsyncResp->chassisSubNode + "/" + 246095a3ecadSAnthony Wilson sensorName; 24618d1b46d7Szhanghch05 sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue); 246295a3ecadSAnthony Wilson } 246395a3ecadSAnthony Wilson else 246495a3ecadSAnthony Wilson { 2465271584abSEd Tanous std::string fieldName; 2466928fefb9SNan Zhou if (sensorsAsyncResp->efficientExpand) 2467928fefb9SNan Zhou { 2468928fefb9SNan Zhou fieldName = "Members"; 2469928fefb9SNan Zhou } 2470928fefb9SNan Zhou else if (sensorType == "temperature") 2471de629b6eSShawn McCarney { 2472de629b6eSShawn McCarney fieldName = "Temperatures"; 2473de629b6eSShawn McCarney } 2474de629b6eSShawn McCarney else if (sensorType == "fan" || sensorType == "fan_tach" || 2475de629b6eSShawn McCarney sensorType == "fan_pwm") 2476de629b6eSShawn McCarney { 2477de629b6eSShawn McCarney fieldName = "Fans"; 2478de629b6eSShawn McCarney } 2479de629b6eSShawn McCarney else if (sensorType == "voltage") 2480de629b6eSShawn McCarney { 2481de629b6eSShawn McCarney fieldName = "Voltages"; 2482de629b6eSShawn McCarney } 2483de629b6eSShawn McCarney else if (sensorType == "power") 2484de629b6eSShawn McCarney { 248555f79e6fSEd Tanous if (sensorName == "total_power") 2486028f7ebcSEddie James { 2487028f7ebcSEddie James fieldName = "PowerControl"; 2488028f7ebcSEddie James } 2489adc4f0dbSShawn McCarney else if ((inventoryItem != nullptr) && 2490adc4f0dbSShawn McCarney (inventoryItem->isPowerSupply)) 2491028f7ebcSEddie James { 2492de629b6eSShawn McCarney fieldName = "PowerSupplies"; 2493de629b6eSShawn McCarney } 2494adc4f0dbSShawn McCarney else 2495adc4f0dbSShawn McCarney { 2496adc4f0dbSShawn McCarney // Other power sensors are in SensorCollection 2497adc4f0dbSShawn McCarney continue; 2498adc4f0dbSShawn McCarney } 2499028f7ebcSEddie James } 2500de629b6eSShawn McCarney else 2501de629b6eSShawn McCarney { 2502de629b6eSShawn McCarney BMCWEB_LOG_ERROR << "Unsure how to handle sensorType " 2503de629b6eSShawn McCarney << sensorType; 2504de629b6eSShawn McCarney continue; 2505de629b6eSShawn McCarney } 2506de629b6eSShawn McCarney 2507de629b6eSShawn McCarney nlohmann::json& tempArray = 25088d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue[fieldName]; 2509adc4f0dbSShawn McCarney if (fieldName == "PowerControl") 251049c53ac9SJohnathan Mantey { 2511adc4f0dbSShawn McCarney if (tempArray.empty()) 25127ab06f49SGunnar Mills { 251395a3ecadSAnthony Wilson // Put multiple "sensors" into a single 251495a3ecadSAnthony Wilson // PowerControl. Follows MemberId naming and 251595a3ecadSAnthony Wilson // naming in power.hpp. 25161476687dSEd Tanous nlohmann::json::object_t power; 25171476687dSEd Tanous power["@odata.id"] = 2518adc4f0dbSShawn McCarney "/redfish/v1/Chassis/" + 251981ce609eSEd Tanous sensorsAsyncResp->chassisId + "/" + 252081ce609eSEd Tanous sensorsAsyncResp->chassisSubNode + "#/" + 25211476687dSEd Tanous fieldName + "/0"; 25221476687dSEd Tanous tempArray.push_back(std::move(power)); 2523adc4f0dbSShawn McCarney } 2524adc4f0dbSShawn McCarney sensorJson = &(tempArray.back()); 2525adc4f0dbSShawn McCarney } 2526adc4f0dbSShawn McCarney else if (fieldName == "PowerSupplies") 2527adc4f0dbSShawn McCarney { 2528adc4f0dbSShawn McCarney if (inventoryItem != nullptr) 2529adc4f0dbSShawn McCarney { 2530adc4f0dbSShawn McCarney sensorJson = 2531adc4f0dbSShawn McCarney &(getPowerSupply(tempArray, *inventoryItem, 253281ce609eSEd Tanous sensorsAsyncResp->chassisId)); 2533adc4f0dbSShawn McCarney } 253449c53ac9SJohnathan Mantey } 2535928fefb9SNan Zhou else if (fieldName == "Members") 2536928fefb9SNan Zhou { 25371476687dSEd Tanous nlohmann::json::object_t member; 25381476687dSEd Tanous member["@odata.id"] = 2539928fefb9SNan Zhou "/redfish/v1/Chassis/" + 2540928fefb9SNan Zhou sensorsAsyncResp->chassisId + "/" + 25411476687dSEd Tanous sensorsAsyncResp->chassisSubNode + "/" + sensorName; 25421476687dSEd Tanous tempArray.push_back(std::move(member)); 2543928fefb9SNan Zhou sensorJson = &(tempArray.back()); 2544928fefb9SNan Zhou } 254549c53ac9SJohnathan Mantey else 254649c53ac9SJohnathan Mantey { 25471476687dSEd Tanous nlohmann::json::object_t member; 25481476687dSEd Tanous member["@odata.id"] = "/redfish/v1/Chassis/" + 25491476687dSEd Tanous sensorsAsyncResp->chassisId + 25501476687dSEd Tanous "/" + 25511476687dSEd Tanous sensorsAsyncResp->chassisSubNode + 25521476687dSEd Tanous "#/" + fieldName + "/"; 25531476687dSEd Tanous tempArray.push_back(std::move(member)); 2554adc4f0dbSShawn McCarney sensorJson = &(tempArray.back()); 255549c53ac9SJohnathan Mantey } 255695a3ecadSAnthony Wilson } 2557de629b6eSShawn McCarney 2558adc4f0dbSShawn McCarney if (sensorJson != nullptr) 2559adc4f0dbSShawn McCarney { 2560*1d7c0054SEd Tanous objectInterfacesToJson(sensorName, sensorType, 2561*1d7c0054SEd Tanous sensorsAsyncResp->chassisSubNode, 2562*1d7c0054SEd Tanous objDictEntry.second, *sensorJson, 2563*1d7c0054SEd Tanous inventoryItem); 2564*1d7c0054SEd Tanous 2565*1d7c0054SEd Tanous std::string path = "/xyz/openbmc_project/sensors/"; 2566*1d7c0054SEd Tanous path += sensorType; 2567*1d7c0054SEd Tanous path += "/"; 2568*1d7c0054SEd Tanous path += sensorName; 2569*1d7c0054SEd Tanous sensorsAsyncResp->addMetadata(*sensorJson, sensorType, 2570*1d7c0054SEd Tanous path); 2571adc4f0dbSShawn McCarney } 2572de629b6eSShawn McCarney } 257381ce609eSEd Tanous if (sensorsAsyncResp.use_count() == 1) 257449c53ac9SJohnathan Mantey { 257581ce609eSEd Tanous sortJSONResponse(sensorsAsyncResp); 2576928fefb9SNan Zhou if (sensorsAsyncResp->chassisSubNode == 2577928fefb9SNan Zhou sensors::node::sensors && 2578928fefb9SNan Zhou sensorsAsyncResp->efficientExpand) 2579928fefb9SNan Zhou { 2580928fefb9SNan Zhou sensorsAsyncResp->asyncResp->res 2581928fefb9SNan Zhou .jsonValue["Members@odata.count"] = 2582928fefb9SNan Zhou sensorsAsyncResp->asyncResp->res.jsonValue["Members"] 2583928fefb9SNan Zhou .size(); 2584928fefb9SNan Zhou } 2585928fefb9SNan Zhou else if (sensorsAsyncResp->chassisSubNode == 2586928fefb9SNan Zhou sensors::node::thermal) 25878bd25ccdSJames Feist { 258881ce609eSEd Tanous populateFanRedundancy(sensorsAsyncResp); 25898bd25ccdSJames Feist } 259049c53ac9SJohnathan Mantey } 2591de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getManagedObjectsCb exit"; 2592de629b6eSShawn McCarney }; 2593de629b6eSShawn McCarney 2594de629b6eSShawn McCarney // Find DBus object path that implements ObjectManager for the current 2595de629b6eSShawn McCarney // connection. If no mapping found, default to "/". 25968fb49dd6SShawn McCarney auto iter = objectMgrPaths->find(connection); 2597de629b6eSShawn McCarney const std::string& objectMgrPath = 25988fb49dd6SShawn McCarney (iter != objectMgrPaths->end()) ? iter->second : "/"; 2599de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is " 2600de629b6eSShawn McCarney << objectMgrPath; 2601de629b6eSShawn McCarney 2602de629b6eSShawn McCarney crow::connections::systemBus->async_method_call( 2603de629b6eSShawn McCarney getManagedObjectsCb, connection, objectMgrPath, 2604de629b6eSShawn McCarney "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); 260523a21a1cSEd Tanous } 2606de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getSensorData exit"; 2607de629b6eSShawn McCarney } 2608de629b6eSShawn McCarney 2609fe04d49cSNan Zhou inline void 2610fe04d49cSNan Zhou processSensorList(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp, 2611fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>>& sensorNames) 26121abe55efSEd Tanous { 2613fe04d49cSNan Zhou auto getConnectionCb = [sensorsAsyncResp, sensorNames]( 2614fe04d49cSNan Zhou const std::set<std::string>& connections) { 261555c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getConnectionCb enter"; 2616de629b6eSShawn McCarney auto getObjectManagerPathsCb = 2617fe04d49cSNan Zhou [sensorsAsyncResp, sensorNames, connections]( 2618fe04d49cSNan Zhou const std::shared_ptr<std::map<std::string, std::string>>& 2619fe04d49cSNan Zhou objectMgrPaths) { 2620de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb enter"; 2621adc4f0dbSShawn McCarney auto getInventoryItemsCb = 2622002d39b4SEd Tanous [sensorsAsyncResp, sensorNames, connections, objectMgrPaths]( 2623f23b7296SEd Tanous const std::shared_ptr<std::vector<InventoryItem>>& 2624adc4f0dbSShawn McCarney inventoryItems) { 2625adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsCb enter"; 262649c53ac9SJohnathan Mantey // Get sensor data and store results in JSON 2627002d39b4SEd Tanous getSensorData(sensorsAsyncResp, sensorNames, connections, 2628002d39b4SEd Tanous objectMgrPaths, inventoryItems); 2629adc4f0dbSShawn McCarney BMCWEB_LOG_DEBUG << "getInventoryItemsCb exit"; 2630adc4f0dbSShawn McCarney }; 2631adc4f0dbSShawn McCarney 2632adc4f0dbSShawn McCarney // Get inventory items associated with sensors 2633002d39b4SEd Tanous getInventoryItems(sensorsAsyncResp, sensorNames, objectMgrPaths, 2634adc4f0dbSShawn McCarney std::move(getInventoryItemsCb)); 2635adc4f0dbSShawn McCarney 2636de629b6eSShawn McCarney BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb exit"; 263708777fb0SLewanczyk, Dawid }; 2638de629b6eSShawn McCarney 263949c53ac9SJohnathan Mantey // Get mapping from connection names to the DBus object 264049c53ac9SJohnathan Mantey // paths that implement the ObjectManager interface 264181ce609eSEd Tanous getObjectManagerPaths(sensorsAsyncResp, 2642de629b6eSShawn McCarney std::move(getObjectManagerPathsCb)); 264355c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getConnectionCb exit"; 264408777fb0SLewanczyk, Dawid }; 2645de629b6eSShawn McCarney 2646de629b6eSShawn McCarney // Get set of connections that provide sensor values 264781ce609eSEd Tanous getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb)); 264895a3ecadSAnthony Wilson } 264995a3ecadSAnthony Wilson 265095a3ecadSAnthony Wilson /** 265195a3ecadSAnthony Wilson * @brief Entry point for retrieving sensors data related to requested 265295a3ecadSAnthony Wilson * chassis. 265395a3ecadSAnthony Wilson * @param SensorsAsyncResp Pointer to object holding response data 265495a3ecadSAnthony Wilson */ 2655b5a76932SEd Tanous inline void 265681ce609eSEd Tanous getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp) 265795a3ecadSAnthony Wilson { 265895a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisData enter"; 265995a3ecadSAnthony Wilson auto getChassisCb = 266081ce609eSEd Tanous [sensorsAsyncResp]( 2661fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>>& sensorNames) { 266295a3ecadSAnthony Wilson BMCWEB_LOG_DEBUG << "getChassisCb enter"; 266381ce609eSEd Tanous processSensorList(sensorsAsyncResp, sensorNames); 266455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassisCb exit"; 266508777fb0SLewanczyk, Dawid }; 2666928fefb9SNan Zhou // SensorCollection doesn't contain the Redundancy property 2667928fefb9SNan Zhou if (sensorsAsyncResp->chassisSubNode != sensors::node::sensors) 2668928fefb9SNan Zhou { 26698d1b46d7Szhanghch05 sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] = 26708d1b46d7Szhanghch05 nlohmann::json::array(); 2671928fefb9SNan Zhou } 267226f03899SShawn McCarney // Get set of sensors in chassis 267381ce609eSEd Tanous getChassis(sensorsAsyncResp, std::move(getChassisCb)); 267455c7b7a2SEd Tanous BMCWEB_LOG_DEBUG << "getChassisData exit"; 2675271584abSEd Tanous } 267608777fb0SLewanczyk, Dawid 2677413961deSRichard Marian Thomaiyar /** 267849c53ac9SJohnathan Mantey * @brief Find the requested sensorName in the list of all sensors supplied by 267949c53ac9SJohnathan Mantey * the chassis node 268049c53ac9SJohnathan Mantey * 268149c53ac9SJohnathan Mantey * @param sensorName The sensor name supplied in the PATCH request 268249c53ac9SJohnathan Mantey * @param sensorsList The list of sensors managed by the chassis node 268349c53ac9SJohnathan Mantey * @param sensorsModified The list of sensors that were found as a result of 268449c53ac9SJohnathan Mantey * repeated calls to this function 268549c53ac9SJohnathan Mantey */ 2686fe04d49cSNan Zhou inline bool 2687fe04d49cSNan Zhou findSensorNameUsingSensorPath(std::string_view sensorName, 268802cad96eSEd Tanous const std::set<std::string>& sensorsList, 2689fe04d49cSNan Zhou std::set<std::string>& sensorsModified) 269049c53ac9SJohnathan Mantey { 2691fe04d49cSNan Zhou for (const auto& chassisSensor : sensorsList) 269249c53ac9SJohnathan Mantey { 269328aa8de5SGeorge Liu sdbusplus::message::object_path path(chassisSensor); 2694b00dcc27SEd Tanous std::string thisSensorName = path.filename(); 269528aa8de5SGeorge Liu if (thisSensorName.empty()) 269649c53ac9SJohnathan Mantey { 269749c53ac9SJohnathan Mantey continue; 269849c53ac9SJohnathan Mantey } 269949c53ac9SJohnathan Mantey if (thisSensorName == sensorName) 270049c53ac9SJohnathan Mantey { 270149c53ac9SJohnathan Mantey sensorsModified.emplace(chassisSensor); 270249c53ac9SJohnathan Mantey return true; 270349c53ac9SJohnathan Mantey } 270449c53ac9SJohnathan Mantey } 270549c53ac9SJohnathan Mantey return false; 270649c53ac9SJohnathan Mantey } 270749c53ac9SJohnathan Mantey 270849c53ac9SJohnathan Mantey /** 2709413961deSRichard Marian Thomaiyar * @brief Entry point for overriding sensor values of given sensor 2710413961deSRichard Marian Thomaiyar * 27118d1b46d7Szhanghch05 * @param sensorAsyncResp response object 27124bb3dc34SCarol Wang * @param allCollections Collections extract from sensors' request patch info 2713413961deSRichard Marian Thomaiyar * @param chassisSubNode Chassis Node for which the query has to happen 2714413961deSRichard Marian Thomaiyar */ 271523a21a1cSEd Tanous inline void setSensorsOverride( 2716b5a76932SEd Tanous const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp, 27174bb3dc34SCarol Wang std::unordered_map<std::string, std::vector<nlohmann::json>>& 2718397fd61fSjayaprakash Mutyala allCollections) 2719413961deSRichard Marian Thomaiyar { 272070d1d0aaSjayaprakash Mutyala BMCWEB_LOG_INFO << "setSensorsOverride for subNode" 27214bb3dc34SCarol Wang << sensorAsyncResp->chassisSubNode << "\n"; 2722413961deSRichard Marian Thomaiyar 2723543f4400SEd Tanous const char* propertyValueName = nullptr; 2724f65af9e8SRichard Marian Thomaiyar std::unordered_map<std::string, std::pair<double, std::string>> overrideMap; 2725413961deSRichard Marian Thomaiyar std::string memberId; 2726543f4400SEd Tanous double value = 0.0; 2727f65af9e8SRichard Marian Thomaiyar for (auto& collectionItems : allCollections) 2728f65af9e8SRichard Marian Thomaiyar { 2729f65af9e8SRichard Marian Thomaiyar if (collectionItems.first == "Temperatures") 2730f65af9e8SRichard Marian Thomaiyar { 2731f65af9e8SRichard Marian Thomaiyar propertyValueName = "ReadingCelsius"; 2732f65af9e8SRichard Marian Thomaiyar } 2733f65af9e8SRichard Marian Thomaiyar else if (collectionItems.first == "Fans") 2734f65af9e8SRichard Marian Thomaiyar { 2735f65af9e8SRichard Marian Thomaiyar propertyValueName = "Reading"; 2736f65af9e8SRichard Marian Thomaiyar } 2737f65af9e8SRichard Marian Thomaiyar else 2738f65af9e8SRichard Marian Thomaiyar { 2739f65af9e8SRichard Marian Thomaiyar propertyValueName = "ReadingVolts"; 2740f65af9e8SRichard Marian Thomaiyar } 2741f65af9e8SRichard Marian Thomaiyar for (auto& item : collectionItems.second) 2742f65af9e8SRichard Marian Thomaiyar { 27438d1b46d7Szhanghch05 if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res, 27448d1b46d7Szhanghch05 "MemberId", memberId, propertyValueName, 27458d1b46d7Szhanghch05 value)) 2746413961deSRichard Marian Thomaiyar { 2747413961deSRichard Marian Thomaiyar return; 2748413961deSRichard Marian Thomaiyar } 2749f65af9e8SRichard Marian Thomaiyar overrideMap.emplace(memberId, 2750f65af9e8SRichard Marian Thomaiyar std::make_pair(value, collectionItems.first)); 2751f65af9e8SRichard Marian Thomaiyar } 2752f65af9e8SRichard Marian Thomaiyar } 27534bb3dc34SCarol Wang 2754002d39b4SEd Tanous auto getChassisSensorListCb = 2755002d39b4SEd Tanous [sensorAsyncResp, overrideMap]( 2756fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>>& sensorsList) { 275749c53ac9SJohnathan Mantey // Match sensor names in the PATCH request to those managed by the 275849c53ac9SJohnathan Mantey // chassis node 2759fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>> sensorNames = 2760fe04d49cSNan Zhou std::make_shared<std::set<std::string>>(); 2761f65af9e8SRichard Marian Thomaiyar for (const auto& item : overrideMap) 2762413961deSRichard Marian Thomaiyar { 2763f65af9e8SRichard Marian Thomaiyar const auto& sensor = item.first; 276449c53ac9SJohnathan Mantey if (!findSensorNameUsingSensorPath(sensor, *sensorsList, 276549c53ac9SJohnathan Mantey *sensorNames)) 2766f65af9e8SRichard Marian Thomaiyar { 2767f65af9e8SRichard Marian Thomaiyar BMCWEB_LOG_INFO << "Unable to find memberId " << item.first; 27688d1b46d7Szhanghch05 messages::resourceNotFound(sensorAsyncResp->asyncResp->res, 2769f65af9e8SRichard Marian Thomaiyar item.second.second, item.first); 2770413961deSRichard Marian Thomaiyar return; 2771413961deSRichard Marian Thomaiyar } 2772f65af9e8SRichard Marian Thomaiyar } 2773413961deSRichard Marian Thomaiyar // Get the connection to which the memberId belongs 2774002d39b4SEd Tanous auto getObjectsWithConnectionCb = 2775fe04d49cSNan Zhou [sensorAsyncResp, 2776fe04d49cSNan Zhou overrideMap](const std::set<std::string>& /*connections*/, 2777002d39b4SEd Tanous const std::set<std::pair<std::string, std::string>>& 2778413961deSRichard Marian Thomaiyar objectsWithConnection) { 2779f65af9e8SRichard Marian Thomaiyar if (objectsWithConnection.size() != overrideMap.size()) 2780413961deSRichard Marian Thomaiyar { 2781413961deSRichard Marian Thomaiyar BMCWEB_LOG_INFO 2782f65af9e8SRichard Marian Thomaiyar << "Unable to find all objects with proper connection " 2783f65af9e8SRichard Marian Thomaiyar << objectsWithConnection.size() << " requested " 2784f65af9e8SRichard Marian Thomaiyar << overrideMap.size() << "\n"; 27854f277b54SJayaprakash Mutyala messages::resourceNotFound(sensorAsyncResp->asyncResp->res, 2786a0ec28b6SAdrian Ambrożewicz sensorAsyncResp->chassisSubNode == 2787a0ec28b6SAdrian Ambrożewicz sensors::node::thermal 2788413961deSRichard Marian Thomaiyar ? "Temperatures" 2789413961deSRichard Marian Thomaiyar : "Voltages", 2790f65af9e8SRichard Marian Thomaiyar "Count"); 2791f65af9e8SRichard Marian Thomaiyar return; 2792f65af9e8SRichard Marian Thomaiyar } 2793f65af9e8SRichard Marian Thomaiyar for (const auto& item : objectsWithConnection) 2794f65af9e8SRichard Marian Thomaiyar { 279528aa8de5SGeorge Liu sdbusplus::message::object_path path(item.first); 279628aa8de5SGeorge Liu std::string sensorName = path.filename(); 279728aa8de5SGeorge Liu if (sensorName.empty()) 2798f65af9e8SRichard Marian Thomaiyar { 27994f277b54SJayaprakash Mutyala messages::internalError(sensorAsyncResp->asyncResp->res); 2800f65af9e8SRichard Marian Thomaiyar return; 2801f65af9e8SRichard Marian Thomaiyar } 2802f65af9e8SRichard Marian Thomaiyar 2803f65af9e8SRichard Marian Thomaiyar const auto& iterator = overrideMap.find(sensorName); 2804f65af9e8SRichard Marian Thomaiyar if (iterator == overrideMap.end()) 2805f65af9e8SRichard Marian Thomaiyar { 2806f65af9e8SRichard Marian Thomaiyar BMCWEB_LOG_INFO << "Unable to find sensor object" 2807f65af9e8SRichard Marian Thomaiyar << item.first << "\n"; 28084f277b54SJayaprakash Mutyala messages::internalError(sensorAsyncResp->asyncResp->res); 2809413961deSRichard Marian Thomaiyar return; 2810413961deSRichard Marian Thomaiyar } 2811413961deSRichard Marian Thomaiyar crow::connections::systemBus->async_method_call( 2812f65af9e8SRichard Marian Thomaiyar [sensorAsyncResp](const boost::system::error_code ec) { 2813413961deSRichard Marian Thomaiyar if (ec) 2814413961deSRichard Marian Thomaiyar { 28154f277b54SJayaprakash Mutyala if (ec.value() == 28164f277b54SJayaprakash Mutyala boost::system::errc::permission_denied) 28174f277b54SJayaprakash Mutyala { 28184f277b54SJayaprakash Mutyala BMCWEB_LOG_WARNING 28194f277b54SJayaprakash Mutyala << "Manufacturing mode is not Enabled...can't " 28204f277b54SJayaprakash Mutyala "Override the sensor value. "; 28214f277b54SJayaprakash Mutyala 28224f277b54SJayaprakash Mutyala messages::insufficientPrivilege( 28238d1b46d7Szhanghch05 sensorAsyncResp->asyncResp->res); 2824413961deSRichard Marian Thomaiyar return; 2825413961deSRichard Marian Thomaiyar } 28264f277b54SJayaprakash Mutyala BMCWEB_LOG_DEBUG 28274f277b54SJayaprakash Mutyala << "setOverrideValueStatus DBUS error: " << ec; 28284f277b54SJayaprakash Mutyala messages::internalError( 28294f277b54SJayaprakash Mutyala sensorAsyncResp->asyncResp->res); 28304f277b54SJayaprakash Mutyala } 2831413961deSRichard Marian Thomaiyar }, 28324f277b54SJayaprakash Mutyala item.second, item.first, "org.freedesktop.DBus.Properties", 28334f277b54SJayaprakash Mutyala "Set", "xyz.openbmc_project.Sensor.Value", "Value", 2834168e20c1SEd Tanous dbus::utility::DbusVariantType(iterator->second.first)); 2835f65af9e8SRichard Marian Thomaiyar } 2836413961deSRichard Marian Thomaiyar }; 2837413961deSRichard Marian Thomaiyar // Get object with connection for the given sensor name 2838413961deSRichard Marian Thomaiyar getObjectsWithConnection(sensorAsyncResp, sensorNames, 2839413961deSRichard Marian Thomaiyar std::move(getObjectsWithConnectionCb)); 2840413961deSRichard Marian Thomaiyar }; 2841413961deSRichard Marian Thomaiyar // get full sensor list for the given chassisId and cross verify the sensor. 2842413961deSRichard Marian Thomaiyar getChassis(sensorAsyncResp, std::move(getChassisSensorListCb)); 2843413961deSRichard Marian Thomaiyar } 2844413961deSRichard Marian Thomaiyar 2845a0ec28b6SAdrian Ambrożewicz /** 2846a0ec28b6SAdrian Ambrożewicz * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus 2847a0ec28b6SAdrian Ambrożewicz * path of the sensor. 2848a0ec28b6SAdrian Ambrożewicz * 2849a0ec28b6SAdrian Ambrożewicz * Function builds valid Redfish response for sensor query of given chassis and 2850a0ec28b6SAdrian Ambrożewicz * node. It then builds metadata about Redfish<->D-Bus correlations and provides 2851a0ec28b6SAdrian Ambrożewicz * it to caller in a callback. 2852a0ec28b6SAdrian Ambrożewicz * 2853a0ec28b6SAdrian Ambrożewicz * @param chassis Chassis for which retrieval should be performed 2854a0ec28b6SAdrian Ambrożewicz * @param node Node (group) of sensors. See sensors::node for supported values 2855a0ec28b6SAdrian Ambrożewicz * @param mapComplete Callback to be called with retrieval result 2856a0ec28b6SAdrian Ambrożewicz */ 2857021d32cfSKrzysztof Grobelny inline void retrieveUriToDbusMap(const std::string& chassis, 2858021d32cfSKrzysztof Grobelny const std::string& node, 2859a0ec28b6SAdrian Ambrożewicz SensorsAsyncResp::DataCompleteCb&& mapComplete) 2860a0ec28b6SAdrian Ambrożewicz { 286102da7c5aSEd Tanous decltype(sensors::paths)::const_iterator pathIt = 286202da7c5aSEd Tanous std::find_if(sensors::paths.cbegin(), sensors::paths.cend(), 286302da7c5aSEd Tanous [&node](auto&& val) { return val.first == node; }); 286402da7c5aSEd Tanous if (pathIt == sensors::paths.cend()) 2865a0ec28b6SAdrian Ambrożewicz { 2866a0ec28b6SAdrian Ambrożewicz BMCWEB_LOG_ERROR << "Wrong node provided : " << node; 2867a0ec28b6SAdrian Ambrożewicz mapComplete(boost::beast::http::status::bad_request, {}); 2868a0ec28b6SAdrian Ambrożewicz return; 2869a0ec28b6SAdrian Ambrożewicz } 2870d51e072fSKrzysztof Grobelny 287172374eb7SNan Zhou auto asyncResp = std::make_shared<bmcweb::AsyncResp>(); 2872fe04d49cSNan Zhou auto callback = [asyncResp, mapCompleteCb{std::move(mapComplete)}]( 2873a0ec28b6SAdrian Ambrożewicz const boost::beast::http::status status, 2874fe04d49cSNan Zhou const std::map<std::string, std::string>& uriToDbus) { 2875fe04d49cSNan Zhou mapCompleteCb(status, uriToDbus); 2876fe04d49cSNan Zhou }; 2877a0ec28b6SAdrian Ambrożewicz 2878a0ec28b6SAdrian Ambrożewicz auto resp = std::make_shared<SensorsAsyncResp>( 2879d51e072fSKrzysztof Grobelny asyncResp, chassis, pathIt->second, node, std::move(callback)); 2880a0ec28b6SAdrian Ambrożewicz getChassisData(resp); 2881a0ec28b6SAdrian Ambrożewicz } 2882a0ec28b6SAdrian Ambrożewicz 2883bacb2162SNan Zhou namespace sensors 2884bacb2162SNan Zhou { 2885928fefb9SNan Zhou 2886bacb2162SNan Zhou inline void getChassisCallback( 2887bacb2162SNan Zhou const std::shared_ptr<SensorsAsyncResp>& asyncResp, 2888fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>>& sensorNames) 2889bacb2162SNan Zhou { 2890bacb2162SNan Zhou BMCWEB_LOG_DEBUG << "getChassisCallback enter"; 2891bacb2162SNan Zhou 2892bacb2162SNan Zhou nlohmann::json& entriesArray = 2893bacb2162SNan Zhou asyncResp->asyncResp->res.jsonValue["Members"]; 2894fe04d49cSNan Zhou for (const auto& sensor : *sensorNames) 2895bacb2162SNan Zhou { 2896bacb2162SNan Zhou BMCWEB_LOG_DEBUG << "Adding sensor: " << sensor; 2897bacb2162SNan Zhou 2898bacb2162SNan Zhou sdbusplus::message::object_path path(sensor); 2899bacb2162SNan Zhou std::string sensorName = path.filename(); 2900bacb2162SNan Zhou if (sensorName.empty()) 2901bacb2162SNan Zhou { 2902bacb2162SNan Zhou BMCWEB_LOG_ERROR << "Invalid sensor path: " << sensor; 2903bacb2162SNan Zhou messages::internalError(asyncResp->asyncResp->res); 2904bacb2162SNan Zhou return; 2905bacb2162SNan Zhou } 29061476687dSEd Tanous nlohmann::json::object_t member; 29071476687dSEd Tanous member["@odata.id"] = "/redfish/v1/Chassis/" + asyncResp->chassisId + 29081476687dSEd Tanous "/" + asyncResp->chassisSubNode + "/" + 29091476687dSEd Tanous sensorName; 29101476687dSEd Tanous entriesArray.push_back(std::move(member)); 2911bacb2162SNan Zhou } 2912bacb2162SNan Zhou 2913bacb2162SNan Zhou asyncResp->asyncResp->res.jsonValue["Members@odata.count"] = 2914bacb2162SNan Zhou entriesArray.size(); 2915bacb2162SNan Zhou BMCWEB_LOG_DEBUG << "getChassisCallback exit"; 2916bacb2162SNan Zhou } 2917e6bd846dSNan Zhou 2918de167a6fSNan Zhou inline void 2919de167a6fSNan Zhou handleSensorCollectionGet(App& app, const crow::Request& req, 2920de167a6fSNan Zhou const std::shared_ptr<bmcweb::AsyncResp>& aResp, 2921de167a6fSNan Zhou const std::string& chassisId) 2922de167a6fSNan Zhou { 2923de167a6fSNan Zhou query_param::QueryCapabilities capabilities = { 2924de167a6fSNan Zhou .canDelegateExpandLevel = 1, 2925de167a6fSNan Zhou }; 2926de167a6fSNan Zhou query_param::Query delegatedQuery; 29273ba00073SCarson Labrado if (!redfish::setUpRedfishRouteWithDelegation(app, req, aResp, 2928de167a6fSNan Zhou delegatedQuery, capabilities)) 2929de167a6fSNan Zhou { 2930de167a6fSNan Zhou return; 2931de167a6fSNan Zhou } 2932de167a6fSNan Zhou 2933de167a6fSNan Zhou if (delegatedQuery.expandType != query_param::ExpandType::None) 2934de167a6fSNan Zhou { 2935de167a6fSNan Zhou // we perform efficient expand. 2936de167a6fSNan Zhou auto asyncResp = std::make_shared<SensorsAsyncResp>( 2937de167a6fSNan Zhou aResp, chassisId, sensors::dbus::sensorPaths, 2938de167a6fSNan Zhou sensors::node::sensors, 2939de167a6fSNan Zhou /*efficientExpand=*/true); 2940de167a6fSNan Zhou getChassisData(asyncResp); 2941de167a6fSNan Zhou 2942de167a6fSNan Zhou BMCWEB_LOG_DEBUG 2943de167a6fSNan Zhou << "SensorCollection doGet exit via efficient expand handler"; 2944de167a6fSNan Zhou return; 29450bad320cSEd Tanous } 2946de167a6fSNan Zhou 2947de167a6fSNan Zhou // if there's no efficient expand available, we use the default 2948de167a6fSNan Zhou // Query Parameters route 2949de167a6fSNan Zhou auto asyncResp = std::make_shared<SensorsAsyncResp>( 2950de167a6fSNan Zhou aResp, chassisId, sensors::dbus::sensorPaths, sensors::node::sensors); 2951de167a6fSNan Zhou 2952de167a6fSNan Zhou // We get all sensors as hyperlinkes in the chassis (this 2953de167a6fSNan Zhou // implies we reply on the default query parameters handler) 2954de167a6fSNan Zhou getChassis(asyncResp, 2955de167a6fSNan Zhou std::bind_front(sensors::getChassisCallback, asyncResp)); 2956de167a6fSNan Zhou BMCWEB_LOG_DEBUG << "SensorCollection doGet exit"; 2957de167a6fSNan Zhou } 2958de167a6fSNan Zhou 2959e6bd846dSNan Zhou inline void handleSensorGet(App& app, const crow::Request& req, 2960e6bd846dSNan Zhou const std::shared_ptr<bmcweb::AsyncResp>& aResp, 2961e6bd846dSNan Zhou const std::string& chassisId, 2962e6bd846dSNan Zhou const std::string& sensorName) 2963e6bd846dSNan Zhou { 29643ba00073SCarson Labrado if (!redfish::setUpRedfishRoute(app, req, aResp)) 2965e6bd846dSNan Zhou { 2966e6bd846dSNan Zhou return; 2967e6bd846dSNan Zhou } 2968e6bd846dSNan Zhou BMCWEB_LOG_DEBUG << "Sensor doGet enter"; 2969e6bd846dSNan Zhou std::shared_ptr<SensorsAsyncResp> asyncResp = 2970e6bd846dSNan Zhou std::make_shared<SensorsAsyncResp>(aResp, chassisId, 2971e6bd846dSNan Zhou std::span<std::string_view>(), 2972e6bd846dSNan Zhou sensors::node::sensors); 2973e6bd846dSNan Zhou 2974e6bd846dSNan Zhou const std::array<const char*, 1> interfaces = { 2975e6bd846dSNan Zhou "xyz.openbmc_project.Sensor.Value"}; 2976e6bd846dSNan Zhou 2977e6bd846dSNan Zhou // Get a list of all of the sensors that implement Sensor.Value 2978e6bd846dSNan Zhou // and get the path and service name associated with the sensor 2979e6bd846dSNan Zhou crow::connections::systemBus->async_method_call( 2980e6bd846dSNan Zhou [asyncResp, 2981e6bd846dSNan Zhou sensorName](const boost::system::error_code ec, 2982e6bd846dSNan Zhou const ::dbus::utility::MapperGetSubTreeResponse& subtree) { 2983e6bd846dSNan Zhou BMCWEB_LOG_DEBUG << "respHandler1 enter"; 2984e6bd846dSNan Zhou if (ec) 2985e6bd846dSNan Zhou { 2986e6bd846dSNan Zhou messages::internalError(asyncResp->asyncResp->res); 2987e6bd846dSNan Zhou BMCWEB_LOG_ERROR << "Sensor getSensorPaths resp_handler: " 2988e6bd846dSNan Zhou << "Dbus error " << ec; 2989e6bd846dSNan Zhou return; 2990e6bd846dSNan Zhou } 2991e6bd846dSNan Zhou 2992e6bd846dSNan Zhou ::dbus::utility::MapperGetSubTreeResponse::const_iterator it = 2993e6bd846dSNan Zhou std::find_if( 2994e6bd846dSNan Zhou subtree.begin(), subtree.end(), 2995e6bd846dSNan Zhou [sensorName]( 2996e6bd846dSNan Zhou const std::pair< 2997e6bd846dSNan Zhou std::string, 2998e6bd846dSNan Zhou std::vector<std::pair< 2999e6bd846dSNan Zhou std::string, std::vector<std::string>>>>& object) { 3000e6bd846dSNan Zhou sdbusplus::message::object_path path(object.first); 3001e6bd846dSNan Zhou std::string name = path.filename(); 3002e6bd846dSNan Zhou if (name.empty()) 3003e6bd846dSNan Zhou { 3004e6bd846dSNan Zhou BMCWEB_LOG_ERROR << "Invalid sensor path: " << object.first; 3005e6bd846dSNan Zhou return false; 3006e6bd846dSNan Zhou } 3007e6bd846dSNan Zhou 3008e6bd846dSNan Zhou return name == sensorName; 3009e6bd846dSNan Zhou }); 3010e6bd846dSNan Zhou 3011e6bd846dSNan Zhou if (it == subtree.end()) 3012e6bd846dSNan Zhou { 3013e6bd846dSNan Zhou BMCWEB_LOG_ERROR << "Could not find path for sensor: " 3014e6bd846dSNan Zhou << sensorName; 3015e6bd846dSNan Zhou messages::resourceNotFound(asyncResp->asyncResp->res, "Sensor", 3016e6bd846dSNan Zhou sensorName); 3017e6bd846dSNan Zhou return; 3018e6bd846dSNan Zhou } 3019e6bd846dSNan Zhou std::string_view sensorPath = (*it).first; 3020e6bd846dSNan Zhou BMCWEB_LOG_DEBUG << "Found sensor path for sensor '" << sensorName 3021e6bd846dSNan Zhou << "': " << sensorPath; 3022e6bd846dSNan Zhou 3023fe04d49cSNan Zhou const std::shared_ptr<std::set<std::string>> sensorList = 3024fe04d49cSNan Zhou std::make_shared<std::set<std::string>>(); 3025e6bd846dSNan Zhou 3026e6bd846dSNan Zhou sensorList->emplace(sensorPath); 3027e6bd846dSNan Zhou processSensorList(asyncResp, sensorList); 3028e6bd846dSNan Zhou BMCWEB_LOG_DEBUG << "respHandler1 exit"; 3029e6bd846dSNan Zhou }, 3030e6bd846dSNan Zhou "xyz.openbmc_project.ObjectMapper", 3031e6bd846dSNan Zhou "/xyz/openbmc_project/object_mapper", 3032e6bd846dSNan Zhou "xyz.openbmc_project.ObjectMapper", "GetSubTree", 3033e6bd846dSNan Zhou "/xyz/openbmc_project/sensors", 2, interfaces); 3034e6bd846dSNan Zhou } 3035e6bd846dSNan Zhou 3036bacb2162SNan Zhou } // namespace sensors 3037bacb2162SNan Zhou 30387e860f15SJohn Edward Broadbent inline void requestRoutesSensorCollection(App& app) 303995a3ecadSAnthony Wilson { 30407e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/") 3041ed398213SEd Tanous .privileges(redfish::privileges::getSensorCollection) 3042002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3043de167a6fSNan Zhou std::bind_front(sensors::handleSensorCollectionGet, std::ref(app))); 304495a3ecadSAnthony Wilson } 304595a3ecadSAnthony Wilson 30467e860f15SJohn Edward Broadbent inline void requestRoutesSensor(App& app) 304795a3ecadSAnthony Wilson { 30487e860f15SJohn Edward Broadbent BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/") 3049ed398213SEd Tanous .privileges(redfish::privileges::getSensor) 3050002d39b4SEd Tanous .methods(boost::beast::http::verb::get)( 3051e6bd846dSNan Zhou std::bind_front(sensors::handleSensorGet, std::ref(app))); 305295a3ecadSAnthony Wilson } 305395a3ecadSAnthony Wilson 305408777fb0SLewanczyk, Dawid } // namespace redfish 3055