blob: 9a59b080ea50b7b525aaa57dfb4b5dc4bbcfa894 [file] [log] [blame]
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +05301#pragma once
2
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +05303#include "config.h"
Gunnar Mills94df8c92018-09-14 14:50:03 -05004
5#include "occ_events.hpp"
6
7#include <unistd.h>
8
George Liubcef3b42021-09-10 12:39:02 +08009#include <filesystem>
Gunnar Mills94df8c92018-09-14 14:50:03 -050010#include <functional>
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053011namespace open_power
12{
13namespace occ
14{
15
George Liubcef3b42021-09-10 12:39:02 +080016namespace fs = std::filesystem;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053017
Eddie James9789e712022-05-25 15:43:40 -050018constexpr auto PRESENCE_ERROR_PATH =
19 "org.open_power.OCC.Firmware.PresenceMismatch";
20constexpr auto SAFE_ERROR_PATH = "org.open_power.OCC.Device.SafeState";
21
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053022/** @class Error
23 * @brief Monitors for OCC device error condition
24 */
25class Error
26{
Gunnar Mills94df8c92018-09-14 14:50:03 -050027 public:
28 Error() = delete;
29 Error(const Error&) = delete;
30 Error& operator=(const Error&) = delete;
31 Error(Error&&) = default;
32 Error& operator=(Error&&) = default;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053033
Gunnar Mills94df8c92018-09-14 14:50:03 -050034 /** @brief Constructs the Error object
35 *
36 * @param[in] event - reference to sd_event unique_ptr
37 * @param[in] file - File used by driver to communicate errors
38 * @param[in] callBack - Optional function callback on error condition
39 */
40 Error(EventPtr& event, const fs::path& file,
Eddie James9789e712022-05-25 15:43:40 -050041 std::function<void(int)> callBack = nullptr) :
Gunnar Mills94df8c92018-09-14 14:50:03 -050042 event(event),
Eddie James774f9af2019-03-19 20:58:53 +000043 file(file), callBack(callBack)
Gunnar Mills94df8c92018-09-14 14:50:03 -050044 {
45 // Nothing to do here.
46 }
47
George Liubddcf852021-09-08 08:46:22 +080048 virtual ~Error()
Gunnar Mills94df8c92018-09-14 14:50:03 -050049 {
50 if (fd >= 0)
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053051 {
Gunnar Mills94df8c92018-09-14 14:50:03 -050052 close(fd);
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053053 }
Gunnar Mills94df8c92018-09-14 14:50:03 -050054 }
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053055
Eddie James9789e712022-05-25 15:43:40 -050056 /** @class Descriptor
57 * @brief Contains data relevant to an error that occurred.
58 */
59 class Descriptor
60 {
61 public:
62 Descriptor(const Descriptor&) = default;
63 Descriptor& operator=(const Descriptor&) = default;
64 Descriptor(Descriptor&&) = default;
65 Descriptor& operator=(Descriptor&&) = default;
66
Patrick Williamsa49c9872023-05-10 07:50:35 -050067 Descriptor() : log(false), err(0), callout(nullptr), path(nullptr) {}
Eddie James9789e712022-05-25 15:43:40 -050068
69 /** @brief Constructs the Descriptor object
70 *
71 * @param[in] path - the DBus error path
72 * @param[in] err - Optional error return code
73 * @param[in] callout - Optional PEL callout path
74 */
75 Descriptor(const char* path, int err = 0,
76 const char* callout = nullptr) :
77 log(true),
78 err(err), callout(callout), path(path)
79 {}
80
81 bool log;
82 int err;
83 const char* callout;
84 const char* path;
85 };
86
Eddie James774f9af2019-03-19 20:58:53 +000087 /** @brief Starts to monitor for error conditions
88 *
89 * @param[in] poll - Indicates whether or not the error file should
90 * actually be polled for changes. Disabling polling is
91 * necessary for error files that don't support the poll
92 * file operation.
93 */
94 void addWatch(bool poll = true);
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053095
Gunnar Mills94df8c92018-09-14 14:50:03 -050096 /** @brief Removes error watch */
97 void removeWatch();
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +053098
Eddie James774f9af2019-03-19 20:58:53 +000099 inline void setFile(const fs::path& f)
100 {
101 file = f;
102 }
103
Gunnar Mills94df8c92018-09-14 14:50:03 -0500104 private:
105 /** @brief sd_event wrapped in unique_ptr */
106 EventPtr& event;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530107
Gunnar Mills94df8c92018-09-14 14:50:03 -0500108 /** @brief event source wrapped in unique_ptr */
109 EventSourcePtr eventSource;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530110
Gunnar Mills94df8c92018-09-14 14:50:03 -0500111 /** @brief Current state of error watching */
112 bool watching = false;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530113
Gunnar Mills94df8c92018-09-14 14:50:03 -0500114 /** @brief attaches FD to events and sets up callback handler */
115 void registerCallBack();
Vishwanatha Subbanna2dc9b1a2017-08-18 18:29:41 +0530116
Gunnar Mills94df8c92018-09-14 14:50:03 -0500117 /** @brief Opens the file and populates fd */
118 void openFile();
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530119
Gunnar Mills94df8c92018-09-14 14:50:03 -0500120 /** @brief Callback handler when the FD has some activity on it
121 *
122 * @param[in] es - Populated event source
123 * @param[in] fd - Associated File descriptor
124 * @param[in] revents - Type of event
125 * @param[in] userData - User data that was passed during registration
126 *
127 * @return - 0 or positive number on success and negative
128 * errno otherwise
129 */
130 static int processEvents(sd_event_source* es, int fd, uint32_t revents,
131 void* userData);
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530132
Gunnar Mills94df8c92018-09-14 14:50:03 -0500133 /** @brief When the error event is received, analyzes it
134 * and makes a callback to error handler if the
135 * content denotes an error condition
136 */
137 virtual void analyzeEvent();
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530138
Gunnar Mills94df8c92018-09-14 14:50:03 -0500139 protected:
140 /** @brief File descriptor to watch for errors */
141 int fd = -1;
Edward A. James636577f2017-10-06 10:53:55 -0500142
Gunnar Mills94df8c92018-09-14 14:50:03 -0500143 /** Error file */
Eddie James774f9af2019-03-19 20:58:53 +0000144 fs::path file;
Edward A. James636577f2017-10-06 10:53:55 -0500145
Gunnar Mills94df8c92018-09-14 14:50:03 -0500146 /** @brief Optional function to call on error scenario */
Eddie James9789e712022-05-25 15:43:40 -0500147 std::function<void(int)> callBack;
Edward A. James636577f2017-10-06 10:53:55 -0500148
Gunnar Mills94df8c92018-09-14 14:50:03 -0500149 /** @brief Reads file data
150 *
151 * @return data read. Since its a /sysfs entry,
152 * it would be a string
153 */
154 std::string readFile(int) const;
Vishwanatha Subbannaee4d83d2017-06-29 18:35:00 +0530155};
156
157} // namespace occ
158} // namespace open_power