1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
#include "config.h"
#include "elog_serialize.hpp"
#include <cereal/archives/binary.hpp>
#include <cereal/types/string.hpp>
#include <cereal/types/tuple.hpp>
#include <cereal/types/vector.hpp>
#include <fstream>
#include <phosphor-logging/log.hpp>
// Register class version
// From cereal documentation;
// "This macro should be placed at global scope"
CEREAL_CLASS_VERSION(phosphor::logging::Entry, CLASS_VERSION);
namespace phosphor
{
namespace logging
{
/** @brief Function required by Cereal to perform serialization.
* @tparam Archive - Cereal archive type (binary in our case).
* @param[in] a - reference to Cereal archive.
* @param[in] e - const reference to error entry.
* @param[in] version - Class version that enables handling
* a serialized data across code levels
*/
template <class Archive>
void save(Archive& a, const Entry& e, const std::uint32_t version)
{
a(e.id(), e.severity(), e.timestamp(), e.message(), e.additionalData(),
e.associations(), e.resolved(), e.version());
}
/** @brief Function required by Cereal to perform deserialization.
* @tparam Archive - Cereal archive type (binary in our case).
* @param[in] a - reference to Cereal archive.
* @param[in] e - reference to error entry.
* @param[in] version - Class version that enables handling
* a serialized data across code levels
*/
template <class Archive>
void load(Archive& a, Entry& e, const std::uint32_t version)
{
using namespace sdbusplus::xyz::openbmc_project::Logging::server;
uint32_t id{};
Entry::Level severity{};
uint64_t timestamp{};
std::string message{};
std::vector<std::string> additionalData{};
bool resolved{};
AssociationList associations{};
std::string fwVersion{};
if (version < std::stoul(FIRST_CEREAL_CLASS_VERSION_WITH_FWLEVEL))
{
a(id, severity, timestamp, message, additionalData, associations,
resolved);
}
else
{
a(id, severity, timestamp, message, additionalData, associations,
resolved, fwVersion);
}
e.id(id);
e.severity(severity);
e.timestamp(timestamp);
e.message(message);
e.additionalData(additionalData);
e.sdbusplus::xyz::openbmc_project::Logging::server::Entry::resolved(
resolved);
e.associations(associations);
e.version(fwVersion);
e.purpose(sdbusplus::xyz::openbmc_project::Software::server::Version::
VersionPurpose::BMC);
}
fs::path serialize(const Entry& e, const fs::path& dir)
{
auto path = dir / std::to_string(e.id());
std::ofstream os(path.c_str(), std::ios::binary);
cereal::BinaryOutputArchive oarchive(os);
oarchive(e);
return path;
}
bool deserialize(const fs::path& path, Entry& e)
{
try
{
if (fs::exists(path))
{
std::ifstream is(path.c_str(), std::ios::in | std::ios::binary);
cereal::BinaryInputArchive iarchive(is);
iarchive(e);
return true;
}
return false;
}
catch (cereal::Exception& e)
{
log<level::ERR>(e.what());
fs::remove(path);
return false;
}
catch (const std::length_error& e)
{
// Running into: USCiLab/cereal#192
// This may be indicating some other issue in the
// way vector may have been used inside the logging.
// possibly associations ??. But handling it here for
// now since we are anyway tossing the log
// TODO: openbmc/phosphor-logging#8
log<level::ERR>(e.what());
fs::remove(path);
return false;
}
}
} // namespace logging
} // namespace phosphor
|
