xref: /openbmc/phosphor-debug-collector/bmc_dump_entry.hpp (revision a63f4a6f17cd5fa743d2cb7ad4e03f63d8a916aa)
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] 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, const fs::path& file,
56           phosphor::dump::Manager& parent) :
57         EntryIfaces(bus, objPath.c_str(), true),
58         phosphor::dump::Entry(bus, objPath.c_str(), dumpId, timeStamp, fileSize,
59                               parent),
60         file(file){};
61 
62     /** @brief Delete this d-bus object.
63      */
64     void delete_() override;
65 
66     /** @brief Method to initiate the offload of dump
67      *  @param[in] uri - URI to offload dump
68      */
69     void initiateOffload(std::string uri) override;
70 
71   private:
72     /** @Dump file name */
73     fs::path file;
74 };
75 
76 } // namespace bmc
77 } // namespace dump
78 } // namespace phosphor
79