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 <filesystem> 10 #include <sdbusplus/bus.hpp> 11 #include <sdbusplus/server/object.hpp> 12 13 namespace phosphor 14 { 15 namespace dump 16 { 17 namespace bmc 18 { 19 template <typename T> 20 using ServerObject = typename sdbusplus::server::object::object<T>; 21 22 using EntryIfaces = sdbusplus::server::object::object< 23 sdbusplus::xyz::openbmc_project::Dump::Entry::server::BMC>; 24 25 namespace fs = std::experimental::filesystem; 26 27 class Manager; 28 29 /** @class Entry 30 * @brief OpenBMC Dump Entry implementation. 31 * @details A concrete implementation for the 32 * xyz.openbmc_project.Dump.Entry DBus API 33 */ 34 class Entry : virtual public EntryIfaces, virtual public phosphor::dump::Entry 35 { 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 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] fileSize - Dump file size in bytes. 51 * @param[in] file - Name of dump file. 52 * @param[in] status - status of the dump. 53 * @param[in] parent - The dump entry's parent. 54 */ 55 Entry(sdbusplus::bus::bus& bus, const std::string& objPath, uint32_t dumpId, 56 uint64_t timeStamp, uint64_t fileSize, const fs::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 /** @brief Delete this d-bus object. 65 */ 66 void delete_() override; 67 68 /** @brief Method to initiate the offload of dump 69 * @param[in] uri - URI to offload dump 70 */ 71 void initiateOffload(std::string uri) override; 72 73 /** @brief Method to update an existing dump entry, once the dump creation 74 * is completed this function will be used to update the entry which got 75 * created during the dump request. 76 * @param[in] timeStamp - Dump creation timestamp 77 * @param[in] fileSize - Dump file size in bytes. 78 * @param[in] file - Name of dump file. 79 */ 80 void update(uint64_t timeStamp, uint64_t fileSize, const fs::path& filePath) 81 { 82 elapsed(timeStamp); 83 size(fileSize); 84 // TODO: Handled dump failed case with #ibm-openbmc/2808 85 status(OperationStatus::Completed); 86 file = filePath; 87 // TODO: serialization of this property will be handled with 88 // #ibm-openbmc/2597 89 completedTime(timeStamp); 90 } 91 92 private: 93 /** @Dump file name */ 94 fs::path file; 95 }; 96 97 } // namespace bmc 98 } // namespace dump 99 } // namespace phosphor 100