Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 3 | #include "config.h" |
Jayanth Othayoth | 671fc7f | 2017-06-14 08:01:41 -0500 | [diff] [blame] | 4 | |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 5 | #include "dump_entry.hpp" |
Jayanth Othayoth | 671fc7f | 2017-06-14 08:01:41 -0500 | [diff] [blame] | 6 | #include "dump_utils.hpp" |
Jayanth Othayoth | bcb174b | 2017-07-02 06:29:24 -0500 | [diff] [blame] | 7 | #include "watch.hpp" |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 8 | #include "xyz/openbmc_project/Collection/DeleteAll/server.hpp" |
| 9 | #include "xyz/openbmc_project/Dump/Internal/Create/server.hpp" |
| 10 | |
| 11 | #include <experimental/filesystem> |
| 12 | #include <sdbusplus/bus.hpp> |
| 13 | #include <sdbusplus/server/object.hpp> |
| 14 | #include <xyz/openbmc_project/Dump/Create/server.hpp> |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 15 | |
| 16 | namespace phosphor |
| 17 | { |
| 18 | namespace dump |
| 19 | { |
| 20 | namespace internal |
| 21 | { |
| 22 | |
| 23 | class Manager; |
| 24 | |
| 25 | } // namespace internal |
| 26 | |
Jayanth Othayoth | bcb174b | 2017-07-02 06:29:24 -0500 | [diff] [blame] | 27 | using UserMap = phosphor::dump::inotify::UserMap; |
| 28 | |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 29 | using Type = |
| 30 | sdbusplus::xyz::openbmc_project::Dump::Internal::server::Create::Type; |
| 31 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 32 | using CreateIface = sdbusplus::server::object::object< |
| 33 | sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll, |
| 34 | sdbusplus::xyz::openbmc_project::Dump::server::Create>; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 35 | |
Jayanth Othayoth | 671fc7f | 2017-06-14 08:01:41 -0500 | [diff] [blame] | 36 | namespace fs = std::experimental::filesystem; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 37 | |
Jayanth Othayoth | 764d1b2 | 2017-07-12 19:14:02 -0500 | [diff] [blame] | 38 | using Watch = phosphor::dump::inotify::Watch; |
| 39 | |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 40 | /** @class Manager |
| 41 | * @brief OpenBMC Dump manager implementation. |
| 42 | * @details A concrete implementation for the |
Nagaraju Goruganti | 3c899a4 | 2017-09-12 06:14:46 -0500 | [diff] [blame] | 43 | * xyz.openbmc_project.Dump.Create DBus API and |
| 44 | * xyz::openbmc_project::Collection::server::DeleteAll. |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 45 | */ |
| 46 | class Manager : public CreateIface |
| 47 | { |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 48 | friend class internal::Manager; |
| 49 | friend class Entry; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 50 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 51 | public: |
| 52 | Manager() = delete; |
| 53 | Manager(const Manager&) = default; |
| 54 | Manager& operator=(const Manager&) = delete; |
| 55 | Manager(Manager&&) = delete; |
| 56 | Manager& operator=(Manager&&) = delete; |
| 57 | virtual ~Manager() = default; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 58 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 59 | /** @brief Constructor to put object onto bus at a dbus path. |
| 60 | * @param[in] bus - Bus to attach to. |
| 61 | * @param[in] event - Dump manager sd_event loop. |
| 62 | * @param[in] path - Path to attach at. |
| 63 | */ |
| 64 | Manager(sdbusplus::bus::bus& bus, const EventPtr& event, const char* path) : |
| 65 | CreateIface(bus, path), bus(bus), eventLoop(event.get()), |
| 66 | lastEntryId(0), |
| 67 | dumpWatch( |
| 68 | eventLoop, IN_NONBLOCK, IN_CLOSE_WRITE | IN_CREATE, EPOLLIN, |
| 69 | BMC_DUMP_PATH, |
| 70 | std::bind(std::mem_fn(&phosphor::dump::Manager::watchCallback), |
| 71 | this, std::placeholders::_1)) |
| 72 | { |
| 73 | } |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 74 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 75 | /** @brief Implementation for CreateDump |
| 76 | * Method to create Dump. |
| 77 | * |
| 78 | * @return id - The Dump entry id number. |
| 79 | */ |
| 80 | uint32_t createDump() override; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 81 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 82 | /** @brief Implementation of dump watch call back |
| 83 | * @param [in] fileInfo - map of file info path:event |
| 84 | */ |
| 85 | void watchCallback(const UserMap& fileInfo); |
Jayanth Othayoth | bcb174b | 2017-07-02 06:29:24 -0500 | [diff] [blame] | 86 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 87 | /** @brief Construct dump d-bus objects from their persisted |
| 88 | * representations. |
| 89 | */ |
| 90 | void restore(); |
Jayanth Othayoth | 4309659 | 2017-07-20 02:17:37 -0500 | [diff] [blame] | 91 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 92 | private: |
| 93 | /** @brief Create Dump entry d-bus object |
| 94 | * @param[in] fullPath - Full path of the Dump file name |
| 95 | */ |
| 96 | void createEntry(const fs::path& fullPath); |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 97 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 98 | /** @brief Capture BMC Dump based on the Dump type. |
| 99 | * @param[in] type - Type of the Dump. |
| 100 | * @param[in] fullPaths - List of absolute paths to the files |
| 101 | * to be included as part of Dump package. |
| 102 | * @return id - The Dump entry id number. |
| 103 | */ |
| 104 | uint32_t captureDump(Type type, const std::vector<std::string>& fullPaths); |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 105 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 106 | /** @brief Erase specified entry d-bus object |
| 107 | * |
| 108 | * @param[in] entryId - unique identifier of the entry |
| 109 | */ |
| 110 | void erase(uint32_t entryId); |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 111 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 112 | /** @brief Erase all BMC dump entries and Delete all Dump files |
| 113 | * from Permanent location |
| 114 | * |
| 115 | */ |
| 116 | void deleteAll() override; |
Nagaraju Goruganti | 3c899a4 | 2017-09-12 06:14:46 -0500 | [diff] [blame] | 117 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 118 | /** @brief sd_event_add_child callback |
| 119 | * |
| 120 | * @param[in] s - event source |
| 121 | * @param[in] si - signal info |
| 122 | * @param[in] userdata - pointer to Watch object |
| 123 | * |
| 124 | * @returns 0 on success, -1 on fail |
| 125 | */ |
| 126 | static int callback(sd_event_source* s, const siginfo_t* si, void* userdata) |
| 127 | { |
| 128 | // No specific action required in |
| 129 | // the sd_event_add_child callback. |
| 130 | return 0; |
| 131 | } |
| 132 | /** @brief Remove specified watch object pointer from the |
| 133 | * watch map and associated entry from the map. |
| 134 | * @param[in] path - unique identifier of the map |
| 135 | */ |
| 136 | void removeWatch(const fs::path& path); |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 137 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 138 | /** @brief Calculate per dump allowed size based on the available |
| 139 | * size in the dump location. |
| 140 | * @returns dump size in kilobytes. |
| 141 | */ |
| 142 | size_t getAllowedSize(); |
Jayanth Othayoth | ab7f920 | 2017-08-02 06:24:58 -0500 | [diff] [blame] | 143 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 144 | /** @brief sdbusplus DBus bus connection. */ |
| 145 | sdbusplus::bus::bus& bus; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 146 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 147 | /** @brief sdbusplus Dump event loop */ |
| 148 | EventPtr eventLoop; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 149 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 150 | /** @brief Dump Entry dbus objects map based on entry id */ |
| 151 | std::map<uint32_t, std::unique_ptr<Entry>> entries; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 152 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 153 | /** @brief Id of the last Dump entry */ |
| 154 | uint32_t lastEntryId; |
Jayanth Othayoth | bcb174b | 2017-07-02 06:29:24 -0500 | [diff] [blame] | 155 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 156 | /** @brief Dump main watch object */ |
| 157 | Watch dumpWatch; |
Jayanth Othayoth | 764d1b2 | 2017-07-12 19:14:02 -0500 | [diff] [blame] | 158 | |
Jayanth Othayoth | cb65ffc | 2018-10-16 08:29:32 -0500 | [diff] [blame^] | 159 | /** @brief Child directory path and its associated watch object map |
| 160 | * [path:watch object] |
| 161 | */ |
| 162 | std::map<fs::path, std::unique_ptr<Watch>> childWatchMap; |
Jayanth Othayoth | a320c7c | 2017-06-14 07:17:21 -0500 | [diff] [blame] | 163 | }; |
| 164 | |
| 165 | } // namespace dump |
| 166 | } // namespace phosphor |