#include #include #include #include #include #include #include #include #include #include #include "config.h" #include "elog_entry.hpp" #include #include "log_manager.hpp" #include "elog_meta.hpp" #include "elog_serialize.hpp" using namespace phosphor::logging; extern const std::map> meta; namespace phosphor { namespace logging { namespace internal { void Manager::commit(uint64_t transactionId, std::string errMsg) { auto reqLevel = level::ERR; // Default to ERR size_t realErrCnt = entries.size() - infoErrors.size(); auto levelmap = g_errLevelMap.find(errMsg); if (levelmap != g_errLevelMap.end()) { reqLevel = levelmap->second; } if (static_cast(reqLevel) < Entry::sevLowerLimit) { if (capped) { return; } if (realErrCnt >= ERROR_CAP) { log("Reached error cap, Ignoring error", entry("SIZE=%d", realErrCnt), entry("ERROR_CAP=%d", ERROR_CAP)); capped = true; return; } } else { if (infoErrors.size() >= ERROR_INFO_CAP) { erase(infoErrors.front()); } } constexpr const auto transactionIdVar = "TRANSACTION_ID"; // Length of 'TRANSACTION_ID' string. constexpr const auto transactionIdVarSize = strlen(transactionIdVar); // Length of 'TRANSACTION_ID=' string. constexpr const auto transactionIdVarOffset = transactionIdVarSize + 1; // Flush all the pending log messages into the journal via Synchronize constexpr auto JOURNAL_BUSNAME = "org.freedesktop.journal1"; constexpr auto JOURNAL_PATH = "/org/freedesktop/journal1"; constexpr auto JOURNAL_INTERFACE = "org.freedesktop.journal1"; auto bus = sdbusplus::bus::new_default(); auto method = bus.new_method_call(JOURNAL_BUSNAME, JOURNAL_PATH, JOURNAL_INTERFACE, "Synchronize"); bus.call_noreply(method); sd_journal *j = nullptr; int rc = sd_journal_open(&j, SD_JOURNAL_LOCAL_ONLY); if (rc < 0) { logging::log("Failed to open journal", logging::entry("DESCRIPTION=%s", strerror(-rc))); return; } std::string transactionIdStr = std::to_string(transactionId); std::set metalist; auto metamap = g_errMetaMap.find(errMsg); if (metamap != g_errMetaMap.end()) { metalist.insert(metamap->second.begin(), metamap->second.end()); } //Add _PID field information in AdditionalData. metalist.insert("_PID"); std::vector additionalData; // Read the journal from the end to get the most recent entry first. // The result from the sd_journal_get_data() is of the form VARIABLE=value. SD_JOURNAL_FOREACH_BACKWARDS(j) { const char *data = nullptr; size_t length = 0; // Look for the transaction id metadata variable rc = sd_journal_get_data(j, transactionIdVar, (const void **)&data, &length); if (rc < 0) { // This journal entry does not have the TRANSACTION_ID // metadata variable. continue; } // journald does not guarantee that sd_journal_get_data() returns NULL // terminated strings, so need to specify the size to use to compare, // use the returned length instead of anything that relies on NULL // terminators like strlen(). // The data variable is in the form of 'TRANSACTION_ID=1234'. Remove // the TRANSACTION_ID characters plus the (=) sign to do the comparison. // 'data + transactionIdVarOffset' will be in the form of '1234'. // 'length - transactionIdVarOffset' will be the length of '1234'. if ((length <= (transactionIdVarOffset)) || (transactionIdStr.compare(0, transactionIdStr.size(), data + transactionIdVarOffset, length - transactionIdVarOffset) != 0)) { // The value of the TRANSACTION_ID metadata is not the requested // transaction id number. continue; } // Search for all metadata variables in the current journal entry. for (auto i = metalist.cbegin(); i != metalist.cend();) { rc = sd_journal_get_data(j, (*i).c_str(), (const void **)&data, &length); if (rc < 0) { // Metadata variable not found, check next metadata variable. i++; continue; } // Metadata variable found, save it and remove it from the set. additionalData.emplace_back(data, length); i = metalist.erase(i); } if (metalist.empty()) { // All metadata variables found, break out of journal loop. break; } } if (!metalist.empty()) { // Not all the metadata variables were found in the journal. for (auto& metaVarStr : metalist) { logging::log("Failed to find metadata", logging::entry("META_FIELD=%s", metaVarStr.c_str())); } } sd_journal_close(j); // Create error Entry dbus object entryId++; if (static_cast(reqLevel) >= Entry::sevLowerLimit) { infoErrors.push_back(entryId); } auto ms = std::chrono::duration_cast( std::chrono::system_clock::now().time_since_epoch()).count(); auto objPath = std::string(OBJ_ENTRY) + '/' + std::to_string(entryId); AssociationList objects {}; processMetadata(errMsg, additionalData, objects); auto e = std::make_unique( busLog, objPath, entryId, ms, // Milliseconds since 1970 static_cast(reqLevel), std::move(errMsg), std::move(additionalData), std::move(objects), *this); serialize(*e); entries.insert(std::make_pair(entryId, std::move(e))); } void Manager::processMetadata(const std::string& errorName, const std::vector& additionalData, AssociationList& objects) const { // additionalData is a list of "metadata=value" constexpr auto separator = '='; for(const auto& entry: additionalData) { auto found = entry.find(separator); if(std::string::npos != found) { auto metadata = entry.substr(0, found); auto iter = meta.find(metadata); if(meta.end() != iter) { (iter->second)(metadata, additionalData, objects); } } } } void Manager::erase(uint32_t entryId) { auto entry = entries.find(entryId); if(entries.end() != entry) { // Delete the persistent representation of this error. fs::path errorPath(ERRLOG_PERSIST_PATH); errorPath /= std::to_string(entryId); fs::remove(errorPath); if (entry->second->severity() >= Entry::sevLowerLimit) { auto it = std::find(infoErrors.begin(), infoErrors.end(), entryId); if (it != infoErrors.end()) { infoErrors.erase(it); } } entries.erase(entry); } else { logging::log("Invalid entry ID to delete", logging::entry("ID=%d", entryId)); } size_t realErrCnt = entries.size() - infoErrors.size(); if (realErrCnt < ERROR_CAP) { capped = false; } } void Manager::restore() { std::vector errorIds; fs::path dir(ERRLOG_PERSIST_PATH); if (!fs::exists(dir) || fs::is_empty(dir)) { return; } for(auto& file: fs::directory_iterator(dir)) { auto id = file.path().filename().c_str(); auto idNum = std::stol(id); auto e = std::make_unique( busLog, std::string(OBJ_ENTRY) + '/' + id, idNum, *this); if (deserialize(file.path(), *e)) { e->emit_object_added(); if (e->severity() >= Entry::sevLowerLimit) { infoErrors.push_back(idNum); } entries.insert(std::make_pair(idNum, std::move(e))); errorIds.push_back(idNum); } } if (!errorIds.empty()) { entryId = *(std::max_element(errorIds.begin(), errorIds.end())); } } } // namespace internal } // namespace logging } // namepsace phosphor