Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 1 | #include "report_manager.hpp" |
| 2 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 3 | #include "report.hpp" |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 4 | #include "types/report_types.hpp" |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 5 | #include "utils/conversion.hpp" |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 6 | #include "utils/transform.hpp" |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 7 | |
| 8 | #include <phosphor-logging/log.hpp> |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 9 | #include <sdbusplus/exception.hpp> |
| 10 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 11 | #include <stdexcept> |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 12 | #include <system_error> |
| 13 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 14 | ReadingParameters |
| 15 | convertToReadingParameters(ReadingParametersPastVersion params) |
| 16 | { |
| 17 | return utils::transform(params, [](const auto& param) { |
| 18 | using namespace std::chrono_literals; |
| 19 | |
| 20 | return ReadingParameters::value_type( |
| 21 | std::vector{{std::get<0>(param)}}, std::get<1>(param), |
| 22 | std::get<2>(param), std::get<3>(param), |
| 23 | utils::enumToString(CollectionTimeScope::point), 0u); |
| 24 | }); |
| 25 | } |
| 26 | |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 27 | ReportManager::ReportManager( |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 28 | std::unique_ptr<interfaces::ReportFactory> reportFactoryIn, |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 29 | std::unique_ptr<interfaces::JsonStorage> reportStorageIn, |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 30 | const std::shared_ptr<sdbusplus::asio::object_server>& objServerIn) : |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 31 | reportFactory(std::move(reportFactoryIn)), |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 32 | reportStorage(std::move(reportStorageIn)), objServer(objServerIn) |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 33 | { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 34 | reports.reserve(maxReports); |
Krzysztof Grobelny | 6ccfcbf | 2020-11-04 09:31:36 +0100 | [diff] [blame] | 35 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 36 | loadFromPersistent(); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 37 | |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 38 | reportManagerIface = objServer->add_unique_interface( |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 39 | reportManagerPath, reportManagerIfaceName, [this](auto& dbusIface) { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 40 | dbusIface.register_property_r( |
Wludzik, Jozef | 503c158 | 2020-12-11 14:48:01 +0100 | [diff] [blame] | 41 | "MaxReports", size_t{}, sdbusplus::vtable::property_::const_, |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 42 | [](const auto&) { return maxReports; }); |
| 43 | dbusIface.register_property_r( |
Karol Niczyj | 32859b6 | 2021-05-19 10:20:46 +0200 | [diff] [blame] | 44 | "MaxReportNameLength", size_t{}, |
| 45 | sdbusplus::vtable::property_::const_, |
| 46 | [](const auto&) { return maxReportNameLength; }); |
| 47 | dbusIface.register_property_r( |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 48 | "MinInterval", uint64_t{}, sdbusplus::vtable::property_::const_, |
| 49 | [](const auto&) -> uint64_t { return minInterval.count(); }); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 50 | |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 51 | dbusIface.register_method( |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 52 | "AddReport", [this](boost::asio::yield_context& yield, |
| 53 | const std::string& reportName, |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 54 | const std::string& reportingType, |
| 55 | const bool emitsReadingsUpdate, |
| 56 | const bool logToMetricReportsCollection, |
| 57 | const uint64_t interval, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 58 | ReadingParametersPastVersion metricParams) { |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 59 | return addReport(yield, reportName, reportingType, |
| 60 | emitsReadingsUpdate, |
| 61 | logToMetricReportsCollection, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 62 | Milliseconds(interval), |
| 63 | convertToReadingParameters( |
| 64 | std::move(metricParams))) |
| 65 | .getPath(); |
| 66 | }); |
| 67 | |
| 68 | dbusIface.register_method( |
| 69 | "AddReportFutureVersion", |
| 70 | [this](boost::asio::yield_context& yield, |
| 71 | const std::string& reportName, |
| 72 | const std::string& reportingType, |
| 73 | const bool emitsReadingsUpdate, |
| 74 | const bool logToMetricReportsCollection, |
| 75 | const uint64_t interval, |
| 76 | ReadingParameters metricParams) { |
| 77 | return addReport(yield, reportName, reportingType, |
| 78 | emitsReadingsUpdate, |
| 79 | logToMetricReportsCollection, |
| 80 | Milliseconds(interval), |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 81 | std::move(metricParams)) |
| 82 | .getPath(); |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 83 | }); |
| 84 | }); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 85 | } |
| 86 | |
Wludzik, Jozef | 2f9f9b8 | 2020-10-13 09:07:45 +0200 | [diff] [blame] | 87 | void ReportManager::removeReport(const interfaces::Report* report) |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 88 | { |
Wludzik, Jozef | cb88cfd | 2020-09-28 16:38:57 +0200 | [diff] [blame] | 89 | reports.erase( |
| 90 | std::remove_if(reports.begin(), reports.end(), |
| 91 | [report](const auto& x) { return report == x.get(); }), |
| 92 | reports.end()); |
Krzysztof Grobelny | 64b75a5 | 2020-09-18 10:17:16 +0200 | [diff] [blame] | 93 | } |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 94 | |
Karol Niczyj | 32859b6 | 2021-05-19 10:20:46 +0200 | [diff] [blame] | 95 | void ReportManager::verifyReportNameLength(const std::string& reportName) |
| 96 | { |
| 97 | if (reportName.length() > maxReportNameLength) |
| 98 | { |
| 99 | throw sdbusplus::exception::SdBusError( |
| 100 | static_cast<int>(std::errc::invalid_argument), |
| 101 | "Report name exceed maximum length"); |
| 102 | } |
| 103 | } |
| 104 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 105 | void ReportManager::verifyAddReport( |
| 106 | const std::string& reportName, const std::string& reportingType, |
| 107 | Milliseconds interval, |
| 108 | const std::vector<LabeledMetricParameters>& readingParams) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 109 | { |
| 110 | if (reports.size() >= maxReports) |
| 111 | { |
| 112 | throw sdbusplus::exception::SdBusError( |
| 113 | static_cast<int>(std::errc::too_many_files_open), |
| 114 | "Reached maximal report count"); |
| 115 | } |
| 116 | |
Karol Niczyj | 32859b6 | 2021-05-19 10:20:46 +0200 | [diff] [blame] | 117 | verifyReportNameLength(reportName); |
| 118 | |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 119 | for (const auto& report : reports) |
| 120 | { |
| 121 | if (report->getName() == reportName) |
| 122 | { |
| 123 | throw sdbusplus::exception::SdBusError( |
| 124 | static_cast<int>(std::errc::file_exists), "Duplicate report"); |
| 125 | } |
| 126 | } |
| 127 | |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 128 | auto found = std::find(supportedReportingType.begin(), |
| 129 | supportedReportingType.end(), reportingType); |
| 130 | if (found == supportedReportingType.end()) |
| 131 | { |
| 132 | throw sdbusplus::exception::SdBusError( |
| 133 | static_cast<int>(std::errc::invalid_argument), |
| 134 | "Invalid reportingType"); |
| 135 | } |
| 136 | |
| 137 | if (reportingType == "Periodic" && interval < minInterval) |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 138 | { |
| 139 | throw sdbusplus::exception::SdBusError( |
| 140 | static_cast<int>(std::errc::invalid_argument), "Invalid interval"); |
| 141 | } |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 142 | |
Wludzik, Jozef | 503c158 | 2020-12-11 14:48:01 +0100 | [diff] [blame] | 143 | if (readingParams.size() > maxReadingParams) |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 144 | |
Wludzik, Jozef | bc766b4 | 2020-12-08 16:06:22 +0100 | [diff] [blame] | 145 | { |
| 146 | throw sdbusplus::exception::SdBusError( |
| 147 | static_cast<int>(std::errc::argument_list_too_long), |
| 148 | "Too many reading parameters"); |
| 149 | } |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 150 | |
| 151 | try |
| 152 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 153 | namespace ts = utils::tstring; |
| 154 | |
| 155 | for (const LabeledMetricParameters& item : readingParams) |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 156 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 157 | utils::toOperationType( |
| 158 | utils::toUnderlying(item.at_label<ts::OperationType>())); |
Krzysztof Grobelny | e8fc575 | 2021-02-05 14:30:45 +0000 | [diff] [blame] | 159 | } |
| 160 | } |
| 161 | catch (const std::exception& e) |
| 162 | { |
| 163 | throw sdbusplus::exception::SdBusError( |
| 164 | static_cast<int>(std::errc::invalid_argument), e.what()); |
| 165 | } |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 166 | } |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 167 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 168 | interfaces::Report& ReportManager::addReport( |
| 169 | boost::asio::yield_context& yield, const std::string& reportName, |
| 170 | const std::string& reportingType, const bool emitsReadingsUpdate, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 171 | const bool logToMetricReportsCollection, Milliseconds interval, |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 172 | ReadingParameters metricParams) |
| 173 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 174 | auto labeledMetricParams = |
| 175 | reportFactory->convertMetricParams(yield, metricParams); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 176 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 177 | return addReport(reportName, reportingType, emitsReadingsUpdate, |
| 178 | logToMetricReportsCollection, interval, |
| 179 | std::move(labeledMetricParams)); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | interfaces::Report& ReportManager::addReport( |
| 183 | const std::string& reportName, const std::string& reportingType, |
| 184 | const bool emitsReadingsUpdate, const bool logToMetricReportsCollection, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 185 | Milliseconds interval, |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 186 | std::vector<LabeledMetricParameters> labeledMetricParams) |
| 187 | { |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 188 | verifyAddReport(reportName, reportingType, interval, labeledMetricParams); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 189 | |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 190 | reports.emplace_back( |
| 191 | reportFactory->make(reportName, reportingType, emitsReadingsUpdate, |
| 192 | logToMetricReportsCollection, interval, *this, |
| 193 | *reportStorage, labeledMetricParams)); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 194 | return *reports.back(); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 195 | } |
| 196 | |
| 197 | void ReportManager::loadFromPersistent() |
| 198 | { |
| 199 | std::vector<interfaces::JsonStorage::FilePath> paths = |
| 200 | reportStorage->list(); |
| 201 | |
| 202 | for (const auto& path : paths) |
| 203 | { |
| 204 | std::optional<nlohmann::json> data = reportStorage->load(path); |
| 205 | try |
| 206 | { |
| 207 | size_t version = data->at("Version").get<size_t>(); |
| 208 | if (version != Report::reportVersion) |
| 209 | { |
| 210 | throw std::logic_error("Invalid version"); |
| 211 | } |
| 212 | std::string& name = data->at("Name").get_ref<std::string&>(); |
| 213 | std::string& reportingType = |
| 214 | data->at("ReportingType").get_ref<std::string&>(); |
| 215 | bool emitsReadingsSignal = |
| 216 | data->at("EmitsReadingsUpdate").get<bool>(); |
| 217 | bool logToMetricReportsCollection = |
| 218 | data->at("LogToMetricReportsCollection").get<bool>(); |
| 219 | uint64_t interval = data->at("Interval").get<uint64_t>(); |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 220 | auto readingParameters = |
| 221 | data->at("ReadingParameters") |
| 222 | .get<std::vector<LabeledMetricParameters>>(); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 223 | |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 224 | addReport(name, reportingType, emitsReadingsSignal, |
Krzysztof Grobelny | dcc4e19 | 2021-03-08 09:09:34 +0000 | [diff] [blame^] | 225 | logToMetricReportsCollection, Milliseconds(interval), |
Krzysztof Grobelny | d223819 | 2020-12-02 09:27:28 +0000 | [diff] [blame] | 226 | std::move(readingParameters)); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 227 | } |
| 228 | catch (const std::exception& e) |
| 229 | { |
| 230 | phosphor::logging::log<phosphor::logging::level::ERR>( |
| 231 | "Failed to load report from storage", |
| 232 | phosphor::logging::entry( |
Wludzik, Jozef | 982c5b5 | 2021-01-02 12:05:21 +0100 | [diff] [blame] | 233 | "FILENAME=%s", |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 234 | static_cast<std::filesystem::path>(path).c_str()), |
Wludzik, Jozef | 982c5b5 | 2021-01-02 12:05:21 +0100 | [diff] [blame] | 235 | phosphor::logging::entry("EXCEPTION_MSG=%s", e.what())); |
Wludzik, Jozef | e236279 | 2020-10-27 17:23:55 +0100 | [diff] [blame] | 236 | reportStorage->remove(path); |
| 237 | } |
| 238 | } |
| 239 | } |
Wludzik, Jozef | d960e1f | 2021-01-08 09:25:59 +0100 | [diff] [blame] | 240 | |
| 241 | void ReportManager::updateReport(const std::string& name) |
| 242 | { |
| 243 | for (auto& report : reports) |
| 244 | { |
| 245 | if (report->getName() == name) |
| 246 | { |
| 247 | report->updateReadings(); |
| 248 | return; |
| 249 | } |
| 250 | } |
| 251 | } |