blob: 8c26bf15fd517e836e5ac82c29ea769cd8788394 [file] [log] [blame]
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -06001#pragma once
2
3#include "com/ibm/Dump/Entry/Resource/server.hpp"
4#include "dump_entry.hpp"
5
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -06006#include <sdbusplus/bus.hpp>
7#include <sdbusplus/server/object.hpp>
8
Jayanth Othayoth0af74a52021-04-08 03:55:21 -05009#include <chrono>
10
Dhruvaraj Subhashchandran341d6832021-01-15 06:28:04 -060011namespace openpower
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060012{
13namespace dump
14{
15namespace resource
16{
17template <typename T>
Patrick Williams9b18bf22022-07-22 19:26:55 -050018using ServerObject = typename sdbusplus::server::object_t<T>;
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060019
Patrick Williams9b18bf22022-07-22 19:26:55 -050020using EntryIfaces = sdbusplus::server::object_t<
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060021 sdbusplus::com::ibm::Dump::Entry::server::Resource>;
22
Asmitha Karunanithi74a1f392021-10-27 03:23:59 -050023using originatorTypes = sdbusplus::xyz::openbmc_project::Common::server::
24 OriginatedBy::OriginatorTypes;
25
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060026class Manager;
27
28/** @class Entry
29 * @brief Resource Dump Entry implementation.
30 * @details An extension to Dump::Entry class and
31 * A concrete implementation for the
32 * com::ibm::Dump::Entry::Resource DBus API
33 */
Lei YU05ef8162022-11-23 13:49:53 +080034class Entry : virtual public phosphor::dump::Entry, virtual public EntryIfaces
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060035{
36 public:
37 Entry() = delete;
38 Entry(const Entry&) = delete;
39 Entry& operator=(const Entry&) = delete;
40 Entry(Entry&&) = delete;
41 Entry& operator=(Entry&&) = delete;
42 ~Entry() = default;
43
44 /** @brief Constructor for the resource dump Entry Object
45 * @param[in] bus - Bus to attach to.
46 * @param[in] objPath - Object path to attach to
47 * @param[in] dumpId - Dump id.
48 * @param[in] timeStamp - Dump creation timestamp
49 * since the epoch.
50 * @param[in] dumpSize - Dump size in bytes.
51 * @param[in] sourceId - DumpId provided by the source.
Patrick Williams4bc1c2b2021-05-10 14:22:18 -050052 * @param[in] vspStr- Input to host to generate the resource dump.
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060053 * @param[in] pwd - Password needed by host to validate the request.
54 * @param[in] status - status of the dump.
Asmitha Karunanithi74a1f392021-10-27 03:23:59 -050055 * @param[in] originatorId - Id of the originator of the dump
56 * @param[in] originatorType - Originator type
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060057 * @param[in] parent - The dump entry's parent.
58 */
Patrick Williams9b18bf22022-07-22 19:26:55 -050059 Entry(sdbusplus::bus_t& bus, const std::string& objPath, uint32_t dumpId,
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060060 uint64_t timeStamp, uint64_t dumpSize, const uint32_t sourceId,
Patrick Williams4bc1c2b2021-05-10 14:22:18 -050061 std::string vspStr, std::string pwd,
Asmitha Karunanithi74a1f392021-10-27 03:23:59 -050062 phosphor::dump::OperationStatus status, std::string originatorId,
63 originatorTypes originatorType, phosphor::dump::Manager& parent) :
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060064 phosphor::dump::Entry(bus, objPath.c_str(), dumpId, timeStamp, dumpSize,
Dhruvaraj Subhashchandran64f8da92021-12-08 03:48:23 -060065 std::string(), status, originatorId,
Lei YU05ef8162022-11-23 13:49:53 +080066 originatorType, parent),
67 EntryIfaces(bus, objPath.c_str(), EntryIfaces::action::defer_emit)
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060068 {
69 sourceDumpId(sourceId);
Patrick Williams4bc1c2b2021-05-10 14:22:18 -050070 vspString(vspStr);
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060071 password(pwd);
Dhruvaraj Subhashchandran2f8e2762021-02-11 07:22:35 -060072 // Emit deferred signal.
73 this->openpower::dump::resource::EntryIfaces::emit_object_added();
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060074 };
75
76 /** @brief Method to initiate the offload of dump
77 * @param[in] uri - URI to offload dump.
78 */
Dhruvaraj Subhashchandran2f8e2762021-02-11 07:22:35 -060079 void initiateOffload(std::string uri) override;
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -060080
81 /** @brief Method to update an existing dump entry
82 * @param[in] timeStamp - Dump creation timestamp
83 * @param[in] dumpSize - Dump size in bytes.
84 * @param[in] sourceId - The id of dump in the origin.
85 */
86 void update(uint64_t timeStamp, uint64_t dumpSize, uint32_t sourceId)
87 {
88 sourceDumpId(sourceId);
89 elapsed(timeStamp);
90 size(dumpSize);
91 // TODO: Handled dump failure case with
92 // #bm-openbmc/2808
93 status(OperationStatus::Completed);
94 completedTime(timeStamp);
95 }
Dhruvaraj Subhashchandran4c63ce52020-12-18 02:07:22 -060096
97 /**
98 * @brief Delete resource dump in host memory and the entry dbus object
99 */
100 void delete_() override;
Dhruvaraj Subhashchandran62337a92020-11-22 21:24:30 -0600101};
102
103} // namespace resource
104} // namespace dump
Dhruvaraj Subhashchandran341d6832021-01-15 06:28:04 -0600105} // namespace openpower