1 #pragma once 2 3 #include "dump_entry.hpp" 4 #include "xyz/openbmc_project/Dump/Entry/BMC/server.hpp" 5 #include "xyz/openbmc_project/Dump/Entry/server.hpp" 6 #include "xyz/openbmc_project/Object/Delete/server.hpp" 7 #include "xyz/openbmc_project/Time/EpochTime/server.hpp" 8 9 #include <sdbusplus/bus.hpp> 10 #include <sdbusplus/server/object.hpp> 11 12 #include <filesystem> 13 14 namespace phosphor 15 { 16 namespace dump 17 { 18 namespace bmc 19 { 20 template <typename T> 21 using ServerObject = typename sdbusplus::server::object::object<T>; 22 23 using EntryIfaces = sdbusplus::server::object::object< 24 sdbusplus::xyz::openbmc_project::Dump::Entry::server::BMC>; 25 26 class Manager; 27 28 /** @class Entry 29 * @brief OpenBMC Dump Entry implementation. 30 * @details A concrete implementation for the 31 * xyz.openbmc_project.Dump.Entry DBus API 32 */ 33 class Entry : virtual public EntryIfaces, virtual public phosphor::dump::Entry 34 { 35 public: 36 Entry() = delete; 37 Entry(const Entry&) = delete; 38 Entry& operator=(const Entry&) = delete; 39 Entry(Entry&&) = delete; 40 Entry& operator=(Entry&&) = delete; 41 ~Entry() = default; 42 43 /** @brief Constructor for the Dump Entry Object 44 * @param[in] bus - Bus to attach to. 45 * @param[in] objPath - Object path to attach to 46 * @param[in] dumpId - Dump id. 47 * @param[in] timeStamp - Dump creation timestamp 48 * since the epoch. 49 * @param[in] fileSize - Dump file size in bytes. 50 * @param[in] file - Name of dump file. 51 * @param[in] status - status of the dump. 52 * @param[in] parent - The dump entry's parent. 53 */ 54 Entry(sdbusplus::bus::bus& bus, const std::string& objPath, uint32_t dumpId, 55 uint64_t timeStamp, uint64_t fileSize, 56 const std::filesystem::path& file, 57 phosphor::dump::OperationStatus status, 58 phosphor::dump::Manager& parent) : 59 EntryIfaces(bus, objPath.c_str(), true), 60 phosphor::dump::Entry(bus, objPath.c_str(), dumpId, timeStamp, fileSize, 61 status, parent), 62 file(file) 63 { 64 // Emit deferred signal. 65 this->phosphor::dump::bmc::EntryIfaces::emit_object_added(); 66 } 67 68 /** @brief Delete this d-bus object. 69 */ 70 void delete_() override; 71 72 /** @brief Method to initiate the offload of dump 73 * @param[in] uri - URI to offload dump 74 */ 75 void initiateOffload(std::string uri) override; 76 77 /** @brief Method to update an existing dump entry, once the dump creation 78 * is completed this function will be used to update the entry which got 79 * created during the dump request. 80 * @param[in] timeStamp - Dump creation timestamp 81 * @param[in] fileSize - Dump file size in bytes. 82 * @param[in] file - Name of dump file. 83 */ 84 void update(uint64_t timeStamp, uint64_t fileSize, 85 const std::filesystem::path& filePath) 86 { 87 elapsed(timeStamp); 88 size(fileSize); 89 // TODO: Handled dump failed case with #ibm-openbmc/2808 90 status(OperationStatus::Completed); 91 file = filePath; 92 // TODO: serialization of this property will be handled with 93 // #ibm-openbmc/2597 94 completedTime(timeStamp); 95 } 96 97 private: 98 /** @Dump file name */ 99 std::filesystem::path file; 100 }; 101 102 } // namespace bmc 103 } // namespace dump 104 } // namespace phosphor 105