blob: 36855c411e8ce1b88f4162664ae09de48703c72c [file] [log] [blame]
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -06001#pragma once
2
3#include "dump_entry.hpp"
4#include "xyz/openbmc_project/Dump/Entry/System/server.hpp"
5
6#include <sdbusplus/bus.hpp>
7#include <sdbusplus/server/object.hpp>
8
Dhruvaraj Subhashchandran341d6832021-01-15 06:28:04 -06009namespace openpower
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060010{
11namespace dump
12{
13namespace system
14{
15template <typename T>
Patrick Williams9b18bf22022-07-22 19:26:55 -050016using ServerObject = typename sdbusplus::server::object_t<T>;
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060017
Patrick Williams9b18bf22022-07-22 19:26:55 -050018using EntryIfaces = sdbusplus::server::object_t<
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060019 sdbusplus::xyz::openbmc_project::Dump::Entry::server::System>;
20
Asmitha Karunanithi74a1f392021-10-27 03:23:59 -050021using originatorTypes = sdbusplus::xyz::openbmc_project::Common::server::
22 OriginatedBy::OriginatorTypes;
23
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060024class Manager;
25
26/** @class Entry
27 * @brief System Dump Entry implementation.
28 * @details A concrete implementation for the
29 * xyz.openbmc_project.Dump.Entry DBus API
30 */
31class Entry : virtual public EntryIfaces, virtual public phosphor::dump::Entry
32{
33 public:
34 Entry() = delete;
35 Entry(const Entry&) = delete;
36 Entry& operator=(const Entry&) = delete;
37 Entry(Entry&&) = delete;
38 Entry& operator=(Entry&&) = delete;
39 ~Entry() = default;
40
41 /** @brief Constructor for the Dump Entry Object
42 * @param[in] bus - Bus to attach to.
43 * @param[in] objPath - Object path to attach to
44 * @param[in] dumpId - Dump id.
45 * @param[in] timeStamp - Dump creation timestamp
46 * since the epoch.
47 * @param[in] dumpSize - Dump size in bytes.
Dhruvaraj Subhashchandrana6ab8062020-10-29 15:29:10 -050048 * @param[in] sourceId - DumpId provided by the source.
49 * @param[in] status - status of the dump.
Asmitha Karunanithi74a1f392021-10-27 03:23:59 -050050 * @param[in] originatorId - Id of the originator of the dump
51 * @param[in] originatorType - Originator type
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060052 * @param[in] parent - The dump entry's parent.
53 */
Patrick Williams9b18bf22022-07-22 19:26:55 -050054 Entry(sdbusplus::bus_t& bus, const std::string& objPath, uint32_t dumpId,
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060055 uint64_t timeStamp, uint64_t dumpSize, const uint32_t sourceId,
Asmitha Karunanithi74a1f392021-10-27 03:23:59 -050056 phosphor::dump::OperationStatus status, std::string originatorId,
57 originatorTypes originatorType, phosphor::dump::Manager& parent) :
Patrick Williams73f64072022-04-01 17:04:47 -050058 EntryIfaces(bus, objPath.c_str(), EntryIfaces::action::defer_emit),
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060059 phosphor::dump::Entry(bus, objPath.c_str(), dumpId, timeStamp, dumpSize,
Dhruvaraj Subhashchandran64f8da92021-12-08 03:48:23 -060060 std::string(), status, originatorId,
61 originatorType, parent)
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060062 {
63 sourceDumpId(sourceId);
Dhruvaraj Subhashchandran2f8e2762021-02-11 07:22:35 -060064 // Emit deferred signal.
65 this->openpower::dump::system::EntryIfaces::emit_object_added();
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060066 };
Dhruvaraj Subhashchandran69e61522020-02-04 06:39:11 -060067
68 /** @brief Method to initiate the offload of dump
69 * @param[in] uri - URI to offload dump.
70 */
Dhruvaraj Subhashchandran2f8e2762021-02-11 07:22:35 -060071 void initiateOffload(std::string uri) override;
Dhruvaraj Subhashchandran6ccb50e2020-10-29 09:33:18 -050072
73 /** @brief Method to update an existing dump entry
74 * @param[in] timeStamp - Dump creation timestamp
75 * @param[in] dumpSize - Dump size in bytes.
76 * @param[in] sourceId - DumpId provided by the source.
77 */
78 void update(uint64_t timeStamp, uint64_t dumpSize, const uint32_t sourceId)
79 {
80 elapsed(timeStamp);
81 size(dumpSize);
82 sourceDumpId(sourceId);
Dhruvaraj Subhashchandrana6ab8062020-10-29 15:29:10 -050083 // TODO: Handled dump failure case with
84 // #bm-openbmc/2808
85 status(OperationStatus::Completed);
86 completedTime(timeStamp);
Dhruvaraj Subhashchandran6ccb50e2020-10-29 09:33:18 -050087 }
Ramesh Iyyar22793862020-12-04 04:03:03 -060088
89 /**
90 * @brief Delete host system dump and it entry dbus object
91 */
92 void delete_() override;
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060093};
94
95} // namespace system
96} // namespace dump
Dhruvaraj Subhashchandran341d6832021-01-15 06:28:04 -060097} // namespace openpower