#include "config.h" #include "dump_manager_bmc.hpp" #include "bmc_dump_entry.hpp" #include "dump_internal.hpp" #include "xyz/openbmc_project/Common/error.hpp" #include "xyz/openbmc_project/Dump/Create/error.hpp" #include #include #include #include #include #include #include #include namespace phosphor { namespace dump { namespace bmc { using namespace sdbusplus::xyz::openbmc_project::Common::Error; using namespace phosphor::logging; namespace internal { void Manager::create(Type type, std::vector fullPaths) { dumpMgr.phosphor::dump::bmc::Manager::captureDump(type, fullPaths); } } // namespace internal sdbusplus::message::object_path Manager::createDump(phosphor::dump::DumpCreateParams params) { if (!params.empty()) { log("BMC dump accepts no additional parameters"); } std::vector paths; auto id = captureDump(Type::UserRequested, paths); // Entry Object path. auto objPath = std::filesystem::path(baseEntryPath) / std::to_string(id); try { std::time_t timeStamp = std::time(nullptr); entries.insert(std::make_pair( id, std::make_unique( bus, objPath.c_str(), id, timeStamp, 0, std::string(), phosphor::dump::OperationStatus::InProgress, *this))); } catch (const std::invalid_argument& e) { log(fmt::format("Error in creating dump entry, " "errormsg({}), OBJECTPATH({}), ID({})", e.what(), objPath.c_str(), id) .c_str()); elog(); } return objPath.string(); } uint32_t Manager::captureDump(Type type, const std::vector& fullPaths) { // Get Dump size. auto size = getAllowedSize(); pid_t pid = fork(); if (pid == 0) { std::filesystem::path dumpPath(dumpDir); auto id = std::to_string(lastEntryId + 1); dumpPath /= id; // get dreport type map entry auto tempType = TypeMap.find(type); execl("/usr/bin/dreport", "dreport", "-d", dumpPath.c_str(), "-i", id.c_str(), "-s", std::to_string(size).c_str(), "-q", "-v", "-p", fullPaths.empty() ? "" : fullPaths.front().c_str(), "-t", tempType->second.c_str(), nullptr); // dreport script execution is failed. auto error = errno; log( fmt::format( "Error occurred during dreport function execution, errno({})", error) .c_str()); elog(); } else if (pid > 0) { auto rc = sd_event_add_child(eventLoop.get(), nullptr, pid, WEXITED | WSTOPPED, callback, nullptr); if (0 > rc) { // Failed to add to event loop log( fmt::format( "Error occurred during the sd_event_add_child call, rc({})", rc) .c_str()); elog(); } } else { auto error = errno; log( fmt::format("Error occurred during fork, errno({})", error) .c_str()); elog(); } return ++lastEntryId; } void Manager::createEntry(const std::filesystem::path& file) { // Dump File Name format obmcdump_ID_EPOCHTIME.EXT static constexpr auto ID_POS = 1; static constexpr auto EPOCHTIME_POS = 2; std::regex file_regex("obmcdump_([0-9]+)_([0-9]+).([a-zA-Z0-9]+)"); std::smatch match; std::string name = file.filename(); if (!((std::regex_search(name, match, file_regex)) && (match.size() > 0))) { log(fmt::format("Invalid Dump file name, FILENAME({})", file.filename().c_str()) .c_str()); return; } auto idString = match[ID_POS]; uint64_t timestamp = stoull(match[EPOCHTIME_POS]) * 1000 * 1000; auto id = stoul(idString); // If there is an existing entry update it and return. auto dumpEntry = entries.find(id); if (dumpEntry != entries.end()) { dynamic_cast(dumpEntry->second.get()) ->update(timestamp, std::filesystem::file_size(file), file); return; } // Entry Object path. auto objPath = std::filesystem::path(baseEntryPath) / std::to_string(id); try { entries.insert(std::make_pair( id, std::make_unique( bus, objPath.c_str(), id, timestamp, std::filesystem::file_size(file), file, phosphor::dump::OperationStatus::Completed, *this))); } catch (const std::invalid_argument& e) { log( fmt::format( "Error in creating dump entry, errormsg({}), OBJECTPATH({}), " "ID({}), TIMESTAMP({}), SIZE({}), FILENAME({})", e.what(), objPath.c_str(), id, timestamp, std::filesystem::file_size(file), file.filename().c_str()) .c_str()); return; } } void Manager::watchCallback(const UserMap& fileInfo) { for (const auto& i : fileInfo) { // For any new dump file create dump entry object // and associated inotify watch. if (IN_CLOSE_WRITE == i.second) { removeWatch(i.first); createEntry(i.first); } // Start inotify watch on newly created directory. else if ((IN_CREATE == i.second) && std::filesystem::is_directory(i.first)) { auto watchObj = std::make_unique( eventLoop, IN_NONBLOCK, IN_CLOSE_WRITE, EPOLLIN, i.first, std::bind( std::mem_fn(&phosphor::dump::bmc::Manager::watchCallback), this, std::placeholders::_1)); childWatchMap.emplace(i.first, std::move(watchObj)); } } } void Manager::removeWatch(const std::filesystem::path& path) { // Delete Watch entry from map. childWatchMap.erase(path); } void Manager::restore() { std::filesystem::path dir(dumpDir); if (!std::filesystem::exists(dir) || std::filesystem::is_empty(dir)) { return; } // Dump file path: // for (const auto& p : std::filesystem::directory_iterator(dir)) { auto idStr = p.path().filename().string(); // Consider only directory's with dump id as name. // Note: As per design one file per directory. if ((std::filesystem::is_directory(p.path())) && std::all_of(idStr.begin(), idStr.end(), ::isdigit)) { lastEntryId = std::max(lastEntryId, static_cast(std::stoul(idStr))); auto fileIt = std::filesystem::directory_iterator(p.path()); // Create dump entry d-bus object. if (fileIt != std::filesystem::end(fileIt)) { createEntry(fileIt->path()); } } } } size_t Manager::getAllowedSize() { using namespace sdbusplus::xyz::openbmc_project::Dump::Create::Error; using Reason = xyz::openbmc_project::Dump::Create::QuotaExceeded::REASON; auto size = 0; // Get current size of the dump directory. for (const auto& p : std::filesystem::recursive_directory_iterator(dumpDir)) { if (!std::filesystem::is_directory(p)) { size += std::ceil(std::filesystem::file_size(p) / 1024.0); } } // Set the Dump size to Maximum if the free space is greater than // Dump max size otherwise return the available size. size = (size > BMC_DUMP_TOTAL_SIZE ? 0 : BMC_DUMP_TOTAL_SIZE - size); if (size < BMC_DUMP_MIN_SPACE_REQD) { // Reached to maximum limit elog(Reason("Not enough space: Delete old dumps")); } if (size > BMC_DUMP_MAX_SIZE) { size = BMC_DUMP_MAX_SIZE; } return size; } } // namespace bmc } // namespace dump } // namespace phosphor