1 // SPDX-License-Identifier: Apache-2.0
2 // SPDX-FileCopyrightText: Copyright 2019 IBM Corporation
3
4 #include "extensions/openpower-pels/private_header.hpp"
5 #include "pel_utils.hpp"
6
7 #include <gtest/gtest.h>
8
9 using namespace openpower::pels;
10
11 class PrivateHeaderTest : public CleanLogID
12 {};
13
TEST_F(PrivateHeaderTest,SizeTest)14 TEST_F(PrivateHeaderTest, SizeTest)
15 {
16 EXPECT_EQ(PrivateHeader::flattenedSize(), 48);
17 }
18
TEST_F(PrivateHeaderTest,UnflattenFlattenTest)19 TEST_F(PrivateHeaderTest, UnflattenFlattenTest)
20 {
21 auto data = pelDataFactory(TestPELType::privateHeaderSection);
22
23 Stream stream(data);
24 PrivateHeader ph(stream);
25 EXPECT_EQ(ph.valid(), true);
26
27 EXPECT_EQ(ph.header().id, 0x5048);
28 EXPECT_EQ(ph.header().size, PrivateHeader::flattenedSize());
29 EXPECT_EQ(ph.header().version, 0x01);
30 EXPECT_EQ(ph.header().subType, 0x02);
31 EXPECT_EQ(ph.header().componentID, 0x0304);
32
33 auto ct = ph.createTimestamp();
34 EXPECT_EQ(ct.yearMSB, 0x20);
35 EXPECT_EQ(ct.yearLSB, 0x30);
36 EXPECT_EQ(ct.month, 0x05);
37 EXPECT_EQ(ct.day, 0x09);
38 EXPECT_EQ(ct.hour, 0x11);
39 EXPECT_EQ(ct.minutes, 0x1E);
40 EXPECT_EQ(ct.seconds, 0x01);
41 EXPECT_EQ(ct.hundredths, 0x63);
42
43 auto mt = ph.commitTimestamp();
44 EXPECT_EQ(mt.yearMSB, 0x20);
45 EXPECT_EQ(mt.yearLSB, 0x31);
46 EXPECT_EQ(mt.month, 0x06);
47 EXPECT_EQ(mt.day, 0x0F);
48 EXPECT_EQ(mt.hour, 0x09);
49 EXPECT_EQ(mt.minutes, 0x22);
50 EXPECT_EQ(mt.seconds, 0x3A);
51 EXPECT_EQ(mt.hundredths, 0x00);
52
53 EXPECT_EQ(ph.creatorID(), 0x4F);
54 EXPECT_EQ(ph.logType(), 0x00);
55 EXPECT_EQ(ph.sectionCount(), 0x02);
56 EXPECT_EQ(ph.obmcLogID(), 0x90919293);
57
58 char expected[] = {0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x00};
59 EXPECT_TRUE(memcmp(ph.creatorVersion().version, expected, 8) == 0);
60
61 EXPECT_EQ(ph.plid(), 0x50515253);
62 EXPECT_EQ(ph.id(), 0x80818283);
63
64 // Now flatten into a vector and check that this vector
65 // matches the original one.
66 std::vector<uint8_t> newData;
67 Stream newStream(newData);
68
69 ph.flatten(newStream);
70 EXPECT_EQ(data, newData);
71
72 // Change a field, then flatten and unflatten again
73 ph.setID(0x55);
74
75 newStream.offset(0);
76 newData.clear();
77 ph.flatten(newStream);
78 EXPECT_NE(data, newData);
79
80 newStream.offset(0);
81 PrivateHeader newPH(newStream);
82
83 EXPECT_TRUE(newPH.valid());
84 EXPECT_EQ(newPH.id(), 0x55);
85 }
86
TEST_F(PrivateHeaderTest,ShortDataTest)87 TEST_F(PrivateHeaderTest, ShortDataTest)
88 {
89 auto data = pelDataFactory(TestPELType::privateHeaderSection);
90 data.resize(PrivateHeader::flattenedSize() - 1);
91 Stream stream(data);
92
93 PrivateHeader ph(stream);
94
95 EXPECT_EQ(ph.valid(), false);
96 }
97
TEST_F(PrivateHeaderTest,CorruptDataTest1)98 TEST_F(PrivateHeaderTest, CorruptDataTest1)
99 {
100 auto data = pelDataFactory(TestPELType::privateHeaderSection);
101 Stream stream(data);
102
103 data.at(0) = 0; // corrupt the section ID
104
105 PrivateHeader ph(stream);
106
107 EXPECT_EQ(ph.valid(), false);
108 }
109
TEST_F(PrivateHeaderTest,CorruptDataTest2)110 TEST_F(PrivateHeaderTest, CorruptDataTest2)
111 {
112 auto data = pelDataFactory(TestPELType::privateHeaderSection);
113 Stream stream(data);
114
115 data.at(4) = 0x22; // corrupt the version
116
117 PrivateHeader ph(stream);
118
119 EXPECT_EQ(ph.valid(), false);
120 }
121
TEST_F(PrivateHeaderTest,CorruptDataTest3)122 TEST_F(PrivateHeaderTest, CorruptDataTest3)
123 {
124 auto data = pelDataFactory(TestPELType::privateHeaderSection);
125 Stream stream(data);
126
127 data.at(27) = 1; // corrupt the section count
128
129 PrivateHeader ph(stream);
130
131 EXPECT_EQ(ph.valid(), false);
132 }
133
134 // Construct a PrivateHeader from scratch
TEST_F(PrivateHeaderTest,ConstructionTest)135 TEST_F(PrivateHeaderTest, ConstructionTest)
136 {
137 tm time_tm;
138 time_tm.tm_year = 125;
139 time_tm.tm_mon = 11;
140 time_tm.tm_mday = 31;
141 time_tm.tm_hour = 15;
142 time_tm.tm_min = 23;
143 time_tm.tm_sec = 42;
144 time_tm.tm_isdst = 0;
145
146 // Convert the above time into a uint64_t in ms since the epoch time
147 auto timepoint = std::chrono::system_clock::from_time_t(timegm(&time_tm));
148 auto timestamp = std::chrono::duration_cast<std::chrono::milliseconds>(
149 timepoint.time_since_epoch())
150 .count();
151
152 PrivateHeader ph(0x3300, 42, timestamp);
153
154 EXPECT_TRUE(ph.valid());
155 EXPECT_EQ(ph.header().id, 0x5048);
156 EXPECT_EQ(ph.header().size, PrivateHeader::flattenedSize());
157 EXPECT_EQ(ph.header().version, 0x01);
158 EXPECT_EQ(ph.header().subType, 0x00);
159 EXPECT_EQ(ph.header().componentID, 0x3300);
160
161 auto& ct = ph.createTimestamp();
162 EXPECT_EQ(ct.yearMSB, 0x20);
163 EXPECT_EQ(ct.yearLSB, 0x25);
164 EXPECT_EQ(ct.month, 0x12);
165 EXPECT_EQ(ct.day, 0x31);
166 EXPECT_EQ(ct.hour, 0x15);
167 EXPECT_EQ(ct.minutes, 0x23);
168 EXPECT_EQ(ct.seconds, 0x42);
169 EXPECT_EQ(ct.hundredths, 0x00);
170
171 EXPECT_EQ(ph.creatorID(), 'O');
172 EXPECT_EQ(ph.logType(), 0x00);
173 EXPECT_EQ(ph.sectionCount(), 0x01);
174 EXPECT_EQ(ph.obmcLogID(), 42);
175
176 char expected[] = {0, 0, 0, 0, 0, 0, 0, 0};
177 EXPECT_TRUE(memcmp(ph.creatorVersion().version, expected, 8) == 0);
178
179 EXPECT_EQ(ph.id(), 0x50000001);
180 EXPECT_EQ(ph.id(), ph.plid());
181 }
182