blob: d4fa5aed6475b2594444d42967c04385e268ec75 [file] [log] [blame]
Adriana Kobylak88d7cf82017-01-24 12:30:15 -06001#pragma once
2
Adriana Kobylak88d7cf82017-01-24 12:30:15 -06003#include "xyz/openbmc_project/Logging/Entry/server.hpp"
Deepak Kodihalli36db46c2017-03-31 06:28:44 -05004#include "xyz/openbmc_project/Object/Delete/server.hpp"
Matt Spinler375ac9b2018-05-01 15:20:55 -05005#include "xyz/openbmc_project/Software/Version/server.hpp"
Patrick Venturef18bf832018-10-26 18:14:00 -07006
7#include <sdbusplus/bus.hpp>
8#include <sdbusplus/server/object.hpp>
Adriana Kobylakeb5d3f22021-02-04 14:03:28 -06009#include <sdeventplus/event.hpp>
10#include <sdeventplus/source/event.hpp>
John Wang27d82812019-09-11 16:39:36 +080011#include <xyz/openbmc_project/Association/Definitions/server.hpp>
Adriana Kobylak1ff95ef2020-12-03 13:52:19 -060012#include <xyz/openbmc_project/Common/FilePath/server.hpp>
Adriana Kobylak88d7cf82017-01-24 12:30:15 -060013
14namespace phosphor
15{
16namespace logging
17{
Adriana Kobylak88d7cf82017-01-24 12:30:15 -060018
Patrick Williams45e83522022-07-22 19:26:52 -050019using EntryIfaces = sdbusplus::server::object_t<
Willy Tu6ddbf692023-09-05 10:54:16 -070020 sdbusplus::server::xyz::openbmc_project::logging::Entry,
21 sdbusplus::server::xyz::openbmc_project::object::Delete,
22 sdbusplus::server::xyz::openbmc_project::association::Definitions,
23 sdbusplus::server::xyz::openbmc_project::software::Version,
24 sdbusplus::server::xyz::openbmc_project::common::FilePath>;
Adriana Kobylak88d7cf82017-01-24 12:30:15 -060025
Deepak Kodihalli35b46372017-02-27 04:58:18 -060026using AssociationList =
Patrick Venturef18bf832018-10-26 18:14:00 -070027 std::vector<std::tuple<std::string, std::string, std::string>>;
Deepak Kodihalli35b46372017-02-27 04:58:18 -060028
Nagaraju Goruganti05aae8b2017-08-30 07:56:12 -050029namespace internal
30{
Deepak Kodihalli8110ca62017-04-10 02:11:54 -050031class Manager;
Nagaraju Goruganti05aae8b2017-08-30 07:56:12 -050032}
Deepak Kodihalli8110ca62017-04-10 02:11:54 -050033
Adriana Kobylak88d7cf82017-01-24 12:30:15 -060034/** @class Entry
35 * @brief OpenBMC logging entry implementation.
36 * @details A concrete implementation for the
Deepak Kodihallib388da62017-02-27 00:47:12 -060037 * xyz.openbmc_project.Logging.Entry and
John Wang27d82812019-09-11 16:39:36 +080038 * xyz.openbmc_project.Associations.Definitions DBus APIs.
Adriana Kobylak88d7cf82017-01-24 12:30:15 -060039 */
Deepak Kodihallib388da62017-02-27 00:47:12 -060040class Entry : public EntryIfaces
Adriana Kobylak88d7cf82017-01-24 12:30:15 -060041{
Patrick Venturef18bf832018-10-26 18:14:00 -070042 public:
43 Entry() = delete;
44 Entry(const Entry&) = delete;
45 Entry& operator=(const Entry&) = delete;
46 Entry(Entry&&) = delete;
47 Entry& operator=(Entry&&) = delete;
48 virtual ~Entry() = default;
Adriana Kobylak88d7cf82017-01-24 12:30:15 -060049
Patrick Venturef18bf832018-10-26 18:14:00 -070050 /** @brief Constructor to put object onto bus at a dbus path.
51 * Defer signal registration (pass true for deferSignal to the
52 * base class) until after the properties are set.
53 * @param[in] bus - Bus to attach to.
Matt Spinlerfb978da2022-01-21 08:42:24 -060054 * @param[in] objectPath - Path to attach at.
Patrick Venturef18bf832018-10-26 18:14:00 -070055 * @param[in] idErr - The error entry id.
56 * @param[in] timestampErr - The commit timestamp.
57 * @param[in] severityErr - The severity of the error.
58 * @param[in] msgErr - The message of the error.
59 * @param[in] additionalDataErr - The error metadata.
60 * @param[in] objects - The list of associations.
61 * @param[in] fwVersion - The BMC code version.
Matt Spinlerfb978da2022-01-21 08:42:24 -060062 * @param[in] filePath - Serialization path
Patrick Venturef18bf832018-10-26 18:14:00 -070063 * @param[in] parent - The error's parent.
64 */
Patrick Williams45e83522022-07-22 19:26:52 -050065 Entry(sdbusplus::bus_t& bus, const std::string& objectPath, uint32_t idErr,
66 uint64_t timestampErr, Level severityErr, std::string&& msgErr,
67 std::vector<std::string>&& additionalDataErr,
Patrick Venturef18bf832018-10-26 18:14:00 -070068 AssociationList&& objects, const std::string& fwVersion,
Matt Spinlerfb978da2022-01-21 08:42:24 -060069 const std::string& filePath, internal::Manager& parent) :
Patrick Williams6ef6b252022-03-30 14:28:27 -050070 EntryIfaces(bus, objectPath.c_str(), EntryIfaces::action::defer_emit),
Patrick Venturef18bf832018-10-26 18:14:00 -070071 parent(parent)
72 {
Matt Spinleref952af2021-08-19 10:23:05 -050073 id(idErr, true);
74 severity(severityErr, true);
75 timestamp(timestampErr, true);
76 updateTimestamp(timestampErr, true);
77 message(std::move(msgErr), true);
78 additionalData(std::move(additionalDataErr), true);
79 associations(std::move(objects), true);
Patrick Venturef18bf832018-10-26 18:14:00 -070080 // Store a copy of associations in case we need to recreate
81 assocs = associations();
Patrick Williams075c7922024-08-16 15:19:49 -040082 sdbusplus::server::xyz::openbmc_project::logging::Entry::resolved(
83 false, true);
Adriana Kobylak4ea7f312017-01-10 12:52:34 -060084
Matt Spinleref952af2021-08-19 10:23:05 -050085 version(fwVersion, true);
86 purpose(VersionPurpose::BMC, true);
Matt Spinlerfb978da2022-01-21 08:42:24 -060087 path(filePath, true);
Matt Spinler375ac9b2018-05-01 15:20:55 -050088
Patrick Venturef18bf832018-10-26 18:14:00 -070089 // Emit deferred signal.
90 this->emit_object_added();
91 };
Adriana Kobylak4ea7f312017-01-10 12:52:34 -060092
Patrick Venturef18bf832018-10-26 18:14:00 -070093 /** @brief Constructor that puts an "empty" error object on the bus,
94 * with only the id property populated. Rest of the properties
95 * to be set by the caller. Caller should emit the added signal.
96 * @param[in] bus - Bus to attach to.
97 * @param[in] path - Path to attach at.
98 * @param[in] id - The error entry id.
99 * @param[in] parent - The error's parent.
100 */
Patrick Williams45e83522022-07-22 19:26:52 -0500101 Entry(sdbusplus::bus_t& bus, const std::string& path, uint32_t entryId,
Patrick Venturef18bf832018-10-26 18:14:00 -0700102 internal::Manager& parent) :
Patrick Williams6ef6b252022-03-30 14:28:27 -0500103 EntryIfaces(bus, path.c_str(), EntryIfaces::action::defer_emit),
Patrick Venturef18bf832018-10-26 18:14:00 -0700104 parent(parent)
105 {
Matt Spinleref952af2021-08-19 10:23:05 -0500106 id(entryId, true);
Patrick Venturef18bf832018-10-26 18:14:00 -0700107 };
Deepak Kodihalli72654f12017-06-12 04:33:29 -0500108
Patrick Venturef18bf832018-10-26 18:14:00 -0700109 /** @brief Set resolution status of the error.
110 * @param[in] value - boolean indicating resolution
111 * status (true = resolved)
112 * @returns value of 'Resolved' property
113 */
114 bool resolved(bool value) override;
Deepak Kodihalli90abed62017-03-27 03:56:44 -0500115
Willy Tu6ddbf692023-09-05 10:54:16 -0700116 using sdbusplus::server::xyz::openbmc_project::logging::Entry::resolved;
Deepak Kodihalli90abed62017-03-27 03:56:44 -0500117
Vijay Lobod354a392021-06-01 16:21:02 -0500118 /** @brief Update eventId string of the error.
119 * @param[in] value - The eventID
120 * @returns New property value
121 */
122 std::string eventId(std::string value) override;
123
Willy Tu6ddbf692023-09-05 10:54:16 -0700124 using sdbusplus::server::xyz::openbmc_project::logging::Entry::eventId;
Vijay Lobod354a392021-06-01 16:21:02 -0500125
Vijay Lobo593a4c62021-06-16 14:25:26 -0500126 /** @brief Update resolution string of the error.
127 * @param[in] value - The resolution
128 * @returns New property value
129 */
130 std::string resolution(std::string value) override;
131
Willy Tu6ddbf692023-09-05 10:54:16 -0700132 using sdbusplus::server::xyz::openbmc_project::logging::Entry::resolution;
Vijay Lobo593a4c62021-06-16 14:25:26 -0500133
Patrick Venturef18bf832018-10-26 18:14:00 -0700134 /** @brief Delete this d-bus object.
135 */
136 void delete_() override;
Deepak Kodihalli36db46c2017-03-31 06:28:44 -0500137
Patrick Venturef18bf832018-10-26 18:14:00 -0700138 /** @brief Severity level to check in cap.
139 * @details Errors with severity lesser than this will be
140 * considered as low priority and maximum ERROR_INFO_CAP
141 * number errors of this category will be captured.
142 */
143 static constexpr auto sevLowerLimit = Entry::Level::Informational;
Nagaraju Gorugantif8a5a792017-10-13 08:09:52 -0500144
Adriana Kobylakeb5d3f22021-02-04 14:03:28 -0600145 /**
146 * @brief Returns the file descriptor to the Entry file.
147 * @return unix_fd - File descriptor to the Entry file.
148 */
149 sdbusplus::message::unix_fd getEntry() override;
150
Patrick Venturef18bf832018-10-26 18:14:00 -0700151 private:
152 /** @brief This entry's associations */
153 AssociationList assocs = {};
Deepak Kodihalli8110ca62017-04-10 02:11:54 -0500154
Patrick Venturef18bf832018-10-26 18:14:00 -0700155 /** @brief This entry's parent */
156 internal::Manager& parent;
Adriana Kobylakeb5d3f22021-02-04 14:03:28 -0600157
158 /**
159 * @brief The event source for closing the Entry file descriptor after it
160 * has been returned from the getEntry D-Bus method.
161 */
162 std::unique_ptr<sdeventplus::source::Defer> fdCloseEventSource;
163
164 /**
165 * @brief Closes the file descriptor passed in.
166 * @details This is called from the event loop to close FDs returned from
167 * getEntry().
168 * @param[in] fd - The file descriptor to close
169 * @param[in] source - The event source object used
170 */
171 void closeFD(int fd, sdeventplus::source::EventBase& source);
Adriana Kobylak88d7cf82017-01-24 12:30:15 -0600172};
173
174} // namespace logging
175} // namespace phosphor