blob: bc247c967e142aa3329bd92811288457134c99ff [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
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060021class Manager;
22
23/** @class Entry
24 * @brief System Dump Entry implementation.
25 * @details A concrete implementation for the
26 * xyz.openbmc_project.Dump.Entry DBus API
27 */
28class Entry : virtual public EntryIfaces, virtual public phosphor::dump::Entry
29{
30 public:
31 Entry() = delete;
32 Entry(const Entry&) = delete;
33 Entry& operator=(const Entry&) = delete;
34 Entry(Entry&&) = delete;
35 Entry& operator=(Entry&&) = delete;
36 ~Entry() = default;
37
38 /** @brief Constructor for the Dump Entry Object
39 * @param[in] bus - Bus to attach to.
40 * @param[in] objPath - Object path to attach to
41 * @param[in] dumpId - Dump id.
42 * @param[in] timeStamp - Dump creation timestamp
43 * since the epoch.
44 * @param[in] dumpSize - Dump size in bytes.
Dhruvaraj Subhashchandrana6ab8062020-10-29 15:29:10 -050045 * @param[in] sourceId - DumpId provided by the source.
46 * @param[in] status - status of the dump.
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060047 * @param[in] parent - The dump entry's parent.
48 */
Patrick Williams9b18bf22022-07-22 19:26:55 -050049 Entry(sdbusplus::bus_t& bus, const std::string& objPath, uint32_t dumpId,
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060050 uint64_t timeStamp, uint64_t dumpSize, const uint32_t sourceId,
Dhruvaraj Subhashchandrana6ab8062020-10-29 15:29:10 -050051 phosphor::dump::OperationStatus status,
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060052 phosphor::dump::Manager& parent) :
Patrick Williams73f64072022-04-01 17:04:47 -050053 EntryIfaces(bus, objPath.c_str(), EntryIfaces::action::defer_emit),
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060054 phosphor::dump::Entry(bus, objPath.c_str(), dumpId, timeStamp, dumpSize,
Dhruvaraj Subhashchandrana6ab8062020-10-29 15:29:10 -050055 status, parent)
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060056 {
57 sourceDumpId(sourceId);
Dhruvaraj Subhashchandran2f8e2762021-02-11 07:22:35 -060058 // Emit deferred signal.
59 this->openpower::dump::system::EntryIfaces::emit_object_added();
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060060 };
Dhruvaraj Subhashchandran69e61522020-02-04 06:39:11 -060061
62 /** @brief Method to initiate the offload of dump
63 * @param[in] uri - URI to offload dump.
64 */
Dhruvaraj Subhashchandran2f8e2762021-02-11 07:22:35 -060065 void initiateOffload(std::string uri) override;
Dhruvaraj Subhashchandran6ccb50e2020-10-29 09:33:18 -050066
67 /** @brief Method to update an existing dump entry
68 * @param[in] timeStamp - Dump creation timestamp
69 * @param[in] dumpSize - Dump size in bytes.
70 * @param[in] sourceId - DumpId provided by the source.
71 */
72 void update(uint64_t timeStamp, uint64_t dumpSize, const uint32_t sourceId)
73 {
74 elapsed(timeStamp);
75 size(dumpSize);
76 sourceDumpId(sourceId);
Dhruvaraj Subhashchandrana6ab8062020-10-29 15:29:10 -050077 // TODO: Handled dump failure case with
78 // #bm-openbmc/2808
79 status(OperationStatus::Completed);
80 completedTime(timeStamp);
Dhruvaraj Subhashchandran6ccb50e2020-10-29 09:33:18 -050081 }
Ramesh Iyyar22793862020-12-04 04:03:03 -060082
83 /**
84 * @brief Delete host system dump and it entry dbus object
85 */
86 void delete_() override;
Dhruvaraj Subhashchandranf140f662020-01-30 00:29:01 -060087};
88
89} // namespace system
90} // namespace dump
Dhruvaraj Subhashchandran341d6832021-01-15 06:28:04 -060091} // namespace openpower