Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 1 | #include "report_manager.hpp" |
| 2 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 3 | #include "interfaces/types.hpp" |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 4 | #include "report.hpp" |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 5 | #include "utils/transform.hpp" |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 6 | |
| 7 | #include <phosphor-logging/log.hpp> |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 8 | #include <sdbusplus/exception.hpp> |
| 9 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 10 | #include <stdexcept> |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 11 | #include <system_error> |
| 12 | |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 13 | ReportManager::ReportManager( |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 14 | std::unique_ptr<interfaces::ReportFactory> reportFactoryIn, |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 15 | std::unique_ptr<interfaces::JsonStorage> reportStorageIn, |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 16 | const std::shared_ptr<sdbusplus::asio::object_server>& objServerIn) : |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 17 | reportFactory(std::move(reportFactoryIn)), |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 18 | reportStorage(std::move(reportStorageIn)), objServer(objServerIn) |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 19 | { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 20 | reports.reserve(maxReports); |
Krzysztof Grobelny | 6ccfcbf | 2020-11-04 09:31:36 +0100 | [diff] [blame] | 21 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 22 | loadFromPersistent(); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 23 | |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 24 | reportManagerIface = objServer->add_unique_interface( |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 25 | reportManagerPath, reportManagerIfaceName, [this](auto& dbusIface) { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 26 | dbusIface.register_property_r( |
Wludzik, Jozef | 503c158 | 2020-12-11 14:48:01 +0100 | [diff] [blame] | 27 | "MaxReports", size_t{}, sdbusplus::vtable::property_::const_, |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 28 | [](const auto&) { return maxReports; }); |
| 29 | dbusIface.register_property_r( |
| 30 | "MinInterval", uint64_t{}, sdbusplus::vtable::property_::const_, |
| 31 | [](const auto&) -> uint64_t { return minInterval.count(); }); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 32 | |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 33 | dbusIface.register_method( |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 34 | "AddReport", [this](boost::asio::yield_context& yield, |
| 35 | const std::string& reportName, |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 36 | const std::string& reportingType, |
| 37 | const bool emitsReadingsUpdate, |
| 38 | const bool logToMetricReportsCollection, |
| 39 | const uint64_t interval, |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 40 | ReadingParameters metricParams) { |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 41 | return addReport(yield, reportName, reportingType, |
| 42 | emitsReadingsUpdate, |
| 43 | logToMetricReportsCollection, |
| 44 | std::chrono::milliseconds(interval), |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 45 | std::move(metricParams)) |
| 46 | .getPath(); |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 47 | }); |
| 48 | }); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 49 | } |
| 50 | |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 51 | void ReportManager::removeReport(const interfaces::Report* report) |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 52 | { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 53 | reports.erase( |
| 54 | std::remove_if(reports.begin(), reports.end(), |
| 55 | [report](const auto& x) { return report == x.get(); }), |
| 56 | reports.end()); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 57 | } |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 58 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 59 | void ReportManager::verifyAddReport(const std::string& reportName, |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 60 | const std::string& reportingType, |
| 61 | std::chrono::milliseconds interval, |
| 62 | const ReadingParameters& readingParams) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 63 | { |
| 64 | if (reports.size() >= maxReports) |
| 65 | { |
| 66 | throw sdbusplus::exception::SdBusError( |
| 67 | static_cast<int>(std::errc::too_many_files_open), |
| 68 | "Reached maximal report count"); |
| 69 | } |
| 70 | |
| 71 | for (const auto& report : reports) |
| 72 | { |
| 73 | if (report->getName() == reportName) |
| 74 | { |
| 75 | throw sdbusplus::exception::SdBusError( |
| 76 | static_cast<int>(std::errc::file_exists), "Duplicate report"); |
| 77 | } |
| 78 | } |
| 79 | |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 80 | auto found = std::find(supportedReportingType.begin(), |
| 81 | supportedReportingType.end(), reportingType); |
| 82 | if (found == supportedReportingType.end()) |
| 83 | { |
| 84 | throw sdbusplus::exception::SdBusError( |
| 85 | static_cast<int>(std::errc::invalid_argument), |
| 86 | "Invalid reportingType"); |
| 87 | } |
| 88 | |
| 89 | if (reportingType == "Periodic" && interval < minInterval) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 90 | { |
| 91 | throw sdbusplus::exception::SdBusError( |
| 92 | static_cast<int>(std::errc::invalid_argument), "Invalid interval"); |
| 93 | } |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 94 | |
| 95 | for (const auto& param : readingParams) |
| 96 | { |
| 97 | const auto& sensors = std::get<0>(param); |
| 98 | if (sensors.size() != 1) |
| 99 | { |
| 100 | throw sdbusplus::exception::SdBusError( |
| 101 | static_cast<int>(std::errc::not_supported), |
| 102 | "Only single sensor per metric is allowed"); |
| 103 | } |
| 104 | } |
Wludzik, Jozef | 503c158 | 2020-12-11 14:48:01 +0100 | [diff] [blame] | 105 | if (readingParams.size() > maxReadingParams) |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 106 | { |
| 107 | throw sdbusplus::exception::SdBusError( |
| 108 | static_cast<int>(std::errc::argument_list_too_long), |
| 109 | "Too many reading parameters"); |
| 110 | } |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 111 | } |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 112 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 113 | interfaces::Report& ReportManager::addReport( |
| 114 | boost::asio::yield_context& yield, const std::string& reportName, |
| 115 | const std::string& reportingType, const bool emitsReadingsUpdate, |
| 116 | const bool logToMetricReportsCollection, std::chrono::milliseconds interval, |
| 117 | ReadingParameters metricParams) |
| 118 | { |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 119 | verifyAddReport(reportName, reportingType, interval, metricParams); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 120 | |
| 121 | reports.emplace_back(reportFactory->make( |
| 122 | yield, reportName, reportingType, emitsReadingsUpdate, |
| 123 | logToMetricReportsCollection, interval, std::move(metricParams), *this, |
| 124 | *reportStorage)); |
| 125 | return *reports.back(); |
| 126 | } |
| 127 | |
| 128 | interfaces::Report& ReportManager::addReport( |
| 129 | const std::string& reportName, const std::string& reportingType, |
| 130 | const bool emitsReadingsUpdate, const bool logToMetricReportsCollection, |
| 131 | std::chrono::milliseconds interval, |
| 132 | std::vector<LabeledMetricParameters> labeledMetricParams) |
| 133 | { |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 134 | auto metricParams = utils::transform( |
| 135 | labeledMetricParams, [](const LabeledMetricParameters& param) { |
| 136 | using namespace utils::tstring; |
| 137 | |
| 138 | return ReadingParameters::value_type( |
| 139 | utils::transform(param.at_index<0>(), |
| 140 | [](const LabeledSensorParameters& p) { |
| 141 | return sdbusplus::message::object_path( |
| 142 | p.at_label<Path>()); |
| 143 | }), |
| 144 | param.at_index<1>(), param.at_index<2>(), param.at_index<3>()); |
| 145 | }); |
| 146 | |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 147 | verifyAddReport(reportName, reportingType, interval, metricParams); |
| 148 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 149 | reports.emplace_back(reportFactory->make( |
| 150 | reportName, reportingType, emitsReadingsUpdate, |
| 151 | logToMetricReportsCollection, interval, std::move(metricParams), *this, |
| 152 | *reportStorage, labeledMetricParams)); |
| 153 | return *reports.back(); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | void ReportManager::loadFromPersistent() |
| 157 | { |
| 158 | std::vector<interfaces::JsonStorage::FilePath> paths = |
| 159 | reportStorage->list(); |
| 160 | |
| 161 | for (const auto& path : paths) |
| 162 | { |
| 163 | std::optional<nlohmann::json> data = reportStorage->load(path); |
| 164 | try |
| 165 | { |
| 166 | size_t version = data->at("Version").get<size_t>(); |
| 167 | if (version != Report::reportVersion) |
| 168 | { |
| 169 | throw std::logic_error("Invalid version"); |
| 170 | } |
| 171 | std::string& name = data->at("Name").get_ref<std::string&>(); |
| 172 | std::string& reportingType = |
| 173 | data->at("ReportingType").get_ref<std::string&>(); |
| 174 | bool emitsReadingsSignal = |
| 175 | data->at("EmitsReadingsUpdate").get<bool>(); |
| 176 | bool logToMetricReportsCollection = |
| 177 | data->at("LogToMetricReportsCollection").get<bool>(); |
| 178 | uint64_t interval = data->at("Interval").get<uint64_t>(); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 179 | auto readingParameters = |
| 180 | data->at("ReadingParameters") |
| 181 | .get<std::vector<LabeledMetricParameters>>(); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 182 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 183 | addReport(name, reportingType, emitsReadingsSignal, |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 184 | logToMetricReportsCollection, |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 185 | std::chrono::milliseconds(interval), |
| 186 | std::move(readingParameters)); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 187 | } |
| 188 | catch (const std::exception& e) |
| 189 | { |
| 190 | phosphor::logging::log<phosphor::logging::level::ERR>( |
| 191 | "Failed to load report from storage", |
| 192 | phosphor::logging::entry( |
Wludzik, Jozef | 982c5b5 | 2021-01-02 12:05:21 +0100 | [diff] [blame] | 193 | "FILENAME=%s", |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 194 | static_cast<std::filesystem::path>(path).c_str()), |
Wludzik, Jozef | 982c5b5 | 2021-01-02 12:05:21 +0100 | [diff] [blame] | 195 | phosphor::logging::entry("EXCEPTION_MSG=%s", e.what())); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 196 | reportStorage->remove(path); |
| 197 | } |
| 198 | } |
| 199 | } |