1 #pragma once 2 3 #include <analyzer/service_data.hpp> 4 5 namespace analyzer 6 { 7 8 /** @brief An abstract class for service event resolutions. */ 9 class Resolution 10 { 11 public: 12 /** @brief Pure virtual destructor. */ 13 virtual ~Resolution() = 0; 14 15 public: 16 /** 17 * @brief Resolves the service actions required by this resolution. 18 * @param io_sd An object containing the service data collected during 19 * hardware error analysis. 20 */ 21 virtual void resolve(ServiceData& io_sd) const = 0; 22 }; 23 24 // Pure virtual destructor must be defined. 25 inline Resolution::~Resolution() {} 26 27 /** @brief Resolves a hardware callout service event. */ 28 class HardwareCalloutResolution : public Resolution 29 { 30 public: 31 /** 32 * @brief Constructor from components. 33 * @param i_path The devtree path of a guardable unit relative to a 34 * chip. An empty string refers to the chip itself. 35 * @param i_priority The callout priority. 36 * @param i_guard True, if guard is required. False, otherwise. 37 */ 38 HardwareCalloutResolution(const std::string& i_path, 39 Callout::Priority i_priority, bool i_guard) : 40 iv_path(i_path), 41 iv_priority(i_priority), iv_guard(i_guard) 42 {} 43 44 private: 45 /** The devtree path of a guardable unit relative to a chip. An empty string 46 * refers to the chip itself. */ 47 const std::string iv_path; 48 49 /** The callout priority. */ 50 const Callout::Priority iv_priority; 51 52 /** True, if guard is required. False, otherwise. */ 53 const bool iv_guard; 54 55 public: 56 void resolve(ServiceData& io_sd) const override; 57 }; 58 59 /** @brief Resolves a procedure callout service event. */ 60 class ProcedureCalloutResolution : public Resolution 61 { 62 public: 63 /** 64 * @brief Constructor from components. 65 * @param i_procedure The procedure callout type. 66 * @param i_priority The callout priority. 67 */ 68 ProcedureCalloutResolution(ProcedureCallout::Type i_procedure, 69 Callout::Priority i_priority) : 70 iv_procedure(i_procedure), 71 iv_priority(i_priority) 72 {} 73 74 private: 75 /** The procedure callout type. */ 76 const ProcedureCallout::Type iv_procedure; 77 78 /** The callout priority. */ 79 const Callout::Priority iv_priority; 80 81 public: 82 void resolve(ServiceData& io_sd) const override 83 { 84 // Simply add the procedure to the callout list. 85 io_sd.addCallout( 86 std::make_shared<ProcedureCallout>(iv_procedure, iv_priority)); 87 } 88 }; 89 90 /** 91 * @brief Contains a list of resolutions. This resolutions will be resolved the 92 * list in the order in which they were inputted into the constructor. 93 */ 94 class ResolutionList : public Resolution 95 { 96 public: 97 /** @brief Default constructor. */ 98 ResolutionList() = default; 99 100 private: 101 /** The resolution list. */ 102 std::vector<std::shared_ptr<Resolution>> iv_list; 103 104 public: 105 /** 106 * @brief Adds a new resolution to the end of the list. 107 * @param i_resolution The new resolution 108 */ 109 void push(const std::shared_ptr<Resolution>& i_resolution) 110 { 111 iv_list.push_back(i_resolution); 112 } 113 114 // Overloaded from parent. 115 void resolve(ServiceData& io_sd) const override 116 { 117 for (const auto& e : iv_list) 118 { 119 e->resolve(io_sd); 120 } 121 } 122 }; 123 124 } // namespace analyzer 125