blob: a5982ea52a9a8817fccddfe0670357319d971abe [file] [log] [blame]
Zane Shelleyd3b9bac2020-11-17 21:59:12 -06001#include <unistd.h>
2
Zane Shelley4ed4be52021-02-15 17:53:40 -06003#include <analyzer/service_data.hpp>
Zane Shelley8f60a622021-02-01 14:41:30 -06004#include <analyzer/util.hpp>
Zane Shelleyd3b9bac2020-11-17 21:59:12 -06005#include <hei_main.hpp>
6#include <phosphor-logging/elog.hpp>
7#include <sdbusplus/bus.hpp>
Zane Shelleyb1106b52021-01-29 13:44:42 -06008#include <util/bin_stream.hpp>
Ben Tyner7029e522021-08-09 19:18:24 -05009#include <util/dbus.hpp>
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060010#include <util/ffdc_file.hpp>
11#include <util/pdbg.hpp>
12#include <util/trace.hpp>
13#include <xyz/openbmc_project/Logging/Create/server.hpp>
14#include <xyz/openbmc_project/Logging/Entry/server.hpp>
15
Zane Shelley021dab32020-12-08 20:28:40 -060016#include <fstream>
17#include <memory>
18
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060019namespace LogSvr = sdbusplus::xyz::openbmc_project::Logging::server;
20
21namespace analyzer
22{
23
Zane Shelley021dab32020-12-08 20:28:40 -060024//------------------------------------------------------------------------------
25
26enum FfdcSubType_t : uint8_t
27{
Zane Shelleyc18ba8f2021-12-01 16:29:20 -060028 FFDC_SIGNATURES = 0x01,
29 FFDC_REGISTER_DUMP = 0x02,
30 FFDC_CALLOUT_FFDC = 0x03,
31 FFDC_HB_SCRATCH_REGS = 0x04,
Zane Shelley021dab32020-12-08 20:28:40 -060032
33 // For the callout section, the value of '0xCA' is required per the
34 // phosphor-logging openpower-pel extention spec.
35 FFDC_CALLOUTS = 0xCA,
36};
37
38enum FfdcVersion_t : uint8_t
39{
40 FFDC_VERSION1 = 0x01,
41};
42
43//------------------------------------------------------------------------------
44
Zane Shelley021dab32020-12-08 20:28:40 -060045void __getSrc(const libhei::Signature& i_signature, uint32_t& o_word6,
46 uint32_t& o_word7, uint32_t& o_word8)
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060047{
48 // [ 0:15] chip model
49 // [16:23] reserved space in chip ID
50 // [24:31] chip EC level
Zane Shelley021dab32020-12-08 20:28:40 -060051 o_word6 = i_signature.getChip().getType();
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060052
53 // [ 0:15] chip position
Zane Shelleyff068a12021-06-17 17:45:40 -050054 // [16:23] node position
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060055 // [24:31] signature attention type
Zane Shelleyff068a12021-06-17 17:45:40 -050056 auto chipPos = util::pdbg::getChipPos(i_signature.getChip());
57 uint8_t nodePos = 0; // TODO: multi-node support
58 auto attn = i_signature.getAttnType();
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060059
Zane Shelleyff068a12021-06-17 17:45:40 -050060 o_word7 = (chipPos & 0xffff) << 16 | (nodePos & 0xff) << 8 | (attn & 0xff);
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060061
62 // [ 0:15] signature ID
63 // [16:23] signature instance
64 // [24:31] signature bit position
Zane Shelley021dab32020-12-08 20:28:40 -060065 o_word8 = i_signature.toUint32();
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060066
67 // Word 9 is currently unused
Zane Shelley021dab32020-12-08 20:28:40 -060068}
69
70//------------------------------------------------------------------------------
71
72void __setSrc(const libhei::Signature& i_rootCause,
73 std::map<std::string, std::string>& io_logData)
74{
75 uint32_t word6 = 0, word7 = 0, word8 = 0;
76 __getSrc(i_rootCause, word6, word7, word8);
Zane Shelleyd3b9bac2020-11-17 21:59:12 -060077
78 io_logData["SRC6"] = std::to_string(word6);
79 io_logData["SRC7"] = std::to_string(word7);
80 io_logData["SRC8"] = std::to_string(word8);
81}
82
83//------------------------------------------------------------------------------
84
Zane Shelley4ed4be52021-02-15 17:53:40 -060085void __addCalloutList(const ServiceData& i_servData,
86 std::vector<util::FFDCFile>& io_userDataFiles)
87{
Zane Shelley4ed4be52021-02-15 17:53:40 -060088 // Create a new entry for the user data section containing the callout list.
89 io_userDataFiles.emplace_back(util::FFDCFormat::JSON, FFDC_CALLOUTS,
90 FFDC_VERSION1);
91
92 // Use a file stream to write the JSON to file.
93 std::ofstream o{io_userDataFiles.back().getPath()};
Zane Shelleyc85716c2021-08-17 10:54:06 -050094 o << i_servData.getCalloutList();
Zane Shelley4ed4be52021-02-15 17:53:40 -060095}
96
97//------------------------------------------------------------------------------
98
Zane Shelley2d114322021-08-25 17:06:12 -050099void __addCalloutFFDC(const ServiceData& i_servData,
100 std::vector<util::FFDCFile>& io_userDataFiles)
101{
102 // Create a new entry for the user data section containing the FFDC.
103 io_userDataFiles.emplace_back(util::FFDCFormat::Custom, FFDC_CALLOUT_FFDC,
104 FFDC_VERSION1);
105
106 // Use a file stream to write the JSON to file.
107 std::ofstream o{io_userDataFiles.back().getPath()};
108 o << i_servData.getCalloutFFDC();
109}
110
111//------------------------------------------------------------------------------
112
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600113void __captureSignatureList(const libhei::IsolationData& i_isoData,
114 std::vector<util::FFDCFile>& io_userDataFiles)
115{
Zane Shelley021dab32020-12-08 20:28:40 -0600116 // Create a new entry for this user data section regardless if there are any
117 // signatures in the list.
118 io_userDataFiles.emplace_back(util::FFDCFormat::Custom, FFDC_SIGNATURES,
119 FFDC_VERSION1);
120
Zane Shelleyb1106b52021-01-29 13:44:42 -0600121 // Create a streamer for easy writing to the FFDC file.
122 auto path = io_userDataFiles.back().getPath();
123 util::BinFileWriter stream{path};
124
125 // The first 4 bytes in the FFDC contains the number of signatures in the
126 // list. Then, the list of signatures will follow.
127
Zane Shelley021dab32020-12-08 20:28:40 -0600128 auto list = i_isoData.getSignatureList();
129
Zane Shelleyb1106b52021-01-29 13:44:42 -0600130 uint32_t numSigs = list.size();
131 stream << numSigs;
Zane Shelley021dab32020-12-08 20:28:40 -0600132
Zane Shelley021dab32020-12-08 20:28:40 -0600133 for (const auto& sig : list)
134 {
Zane Shelleyb1106b52021-01-29 13:44:42 -0600135 // Each signature will use the same format as the SRC (12 bytes each).
136 uint32_t word6 = 0, word7 = 0, word8 = 0;
Zane Shelley021dab32020-12-08 20:28:40 -0600137 __getSrc(sig, word6, word7, word8);
Zane Shelleyb1106b52021-01-29 13:44:42 -0600138 stream << word6 << word7 << word8;
Zane Shelley021dab32020-12-08 20:28:40 -0600139 }
140
Zane Shelleyb1106b52021-01-29 13:44:42 -0600141 // If the stream failed for any reason, remove the FFDC file.
142 if (!stream.good())
Zane Shelley021dab32020-12-08 20:28:40 -0600143 {
Zane Shelleyb1106b52021-01-29 13:44:42 -0600144 trace::err("Unable to write signature list FFDC file: %s",
145 path.string().c_str());
146 io_userDataFiles.pop_back();
Zane Shelley021dab32020-12-08 20:28:40 -0600147 }
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600148}
149
150//------------------------------------------------------------------------------
151
Zane Shelley8f60a622021-02-01 14:41:30 -0600152void __captureRegisterDump(const libhei::IsolationData& i_isoData,
153 std::vector<util::FFDCFile>& io_userDataFiles)
154{
155 // Create a new entry for this user data section regardless if there are any
156 // registers in the dump.
157 io_userDataFiles.emplace_back(util::FFDCFormat::Custom, FFDC_REGISTER_DUMP,
158 FFDC_VERSION1);
159
160 // Create a streamer for easy writing to the FFDC file.
161 auto path = io_userDataFiles.back().getPath();
162 util::BinFileWriter stream{path};
163
164 // The first 4 bytes in the FFDC contains the number of chips with register
165 // data. Then the data for each chip will follow.
166
167 auto dump = i_isoData.getRegisterDump();
168
169 uint32_t numChips = dump.size();
170 stream << numChips;
171
172 for (const auto& entry : dump)
173 {
174 auto chip = entry.first;
175 auto regList = entry.second;
176
177 // Each chip will have the following information:
178 // 4 byte chip model/EC
179 // 2 byte chip position
Zane Shelleyff068a12021-06-17 17:45:40 -0500180 // 1 byte node position
Zane Shelley8f60a622021-02-01 14:41:30 -0600181 // 4 byte number of registers
182 // Then the data for each register will follow.
183
184 uint32_t chipType = chip.getType();
185 uint16_t chipPos = util::pdbg::getChipPos(chip);
Zane Shelleyff068a12021-06-17 17:45:40 -0500186 uint8_t nodePos = 0; // TODO: multi-node support
Zane Shelley8f60a622021-02-01 14:41:30 -0600187 uint32_t numRegs = regList.size();
Zane Shelleyff068a12021-06-17 17:45:40 -0500188 stream << chipType << chipPos << nodePos << numRegs;
Zane Shelley8f60a622021-02-01 14:41:30 -0600189
190 for (const auto& reg : regList)
191 {
192 // Each register will have the following information:
193 // 3 byte register ID
194 // 1 byte register instance
195 // 1 byte data size
196 // * byte data buffer (* depends on value of data size)
197
198 libhei::RegisterId_t regId = reg.regId; // 3 byte
199 libhei::Instance_t regInst = reg.regInst; // 1 byte
200
201 auto tmp = libhei::BitString::getMinBytes(reg.data->getBitLen());
202 if (255 < tmp)
203 {
204 trace::inf("Register data execeeded 255 and was truncated: "
205 "regId=0x%06x regInst=%u",
206 regId, regInst);
207 tmp = 255;
208 }
209 uint8_t dataSize = tmp;
210
211 stream << regId << regInst << dataSize;
212
213 stream.write(reg.data->getBufAddr(), dataSize);
214 }
215 }
216
217 // If the stream failed for any reason, remove the FFDC file.
218 if (!stream.good())
219 {
220 trace::err("Unable to write register dump FFDC file: %s",
221 path.string().c_str());
222 io_userDataFiles.pop_back();
223 }
224}
225
226//------------------------------------------------------------------------------
227
Zane Shelleyc18ba8f2021-12-01 16:29:20 -0600228void __captureHostbootScratchRegisters(
229 std::vector<util::FFDCFile>& io_userDataFiles)
230{
231 // Get the Hostboot scratch registers from the primary processor.
232
233 uint32_t cfamAddr = 0x283C;
234 uint32_t cfamValue = 0;
235
236 uint64_t scomAddr = 0x4602F489;
237 uint64_t scomValue = 0;
238
239 auto priProc = util::pdbg::getPrimaryProcessor();
240 if (nullptr == priProc)
241 {
242 trace::err("Unable to get primary processor");
243 }
244 else
245 {
246 if (0 != util::pdbg::getCfam(priProc, cfamAddr, cfamValue))
247 {
248 cfamValue = 0; // just in case
249 }
250
251 if (0 != util::pdbg::getScom(priProc, scomAddr, scomValue))
252 {
253 scomValue = 0; // just in case
254 }
255 }
256
257 // Create a new entry for this user data section.
258 io_userDataFiles.emplace_back(util::FFDCFormat::Custom,
259 FFDC_HB_SCRATCH_REGS, FFDC_VERSION1);
260
261 // Create a streamer for easy writing to the FFDC file.
262 auto path = io_userDataFiles.back().getPath();
263 util::BinFileWriter stream{path};
264
265 // Add the data (CFAM addr/val, then SCOM addr/val).
266 stream << cfamAddr << cfamValue << scomAddr << scomValue;
267
268 // If the stream failed for any reason, remove the FFDC file.
269 if (!stream.good())
270 {
271 trace::err("Unable to write register dump FFDC file: %s",
272 path.string().c_str());
273 io_userDataFiles.pop_back();
274 }
275}
276
277//------------------------------------------------------------------------------
278
Zane Shelleyf17bf3e2021-12-07 13:16:37 -0600279std::string __getMessageRegistry(AnalysisType i_type)
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600280{
Zane Shelleyf17bf3e2021-12-07 13:16:37 -0600281
282 if (AnalysisType::SYSTEM_CHECKSTOP == i_type)
283 {
284 return "org.open_power.HwDiags.Error.Checkstop";
285 }
286 else if (AnalysisType::TERMINATE_IMMEDIATE == i_type)
287 {
288 return "org.open_power.HwDiags.Error.Predictive";
289 }
290
291 return "org.open_power.HwDiags.Error.Informational"; // default
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600292}
293
294//------------------------------------------------------------------------------
295
Zane Shelleyf17bf3e2021-12-07 13:16:37 -0600296std::string __getMessageSeverity(AnalysisType i_type)
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600297{
Zane Shelleyf17bf3e2021-12-07 13:16:37 -0600298 // Default severity is informational (no service action required).
299 LogSvr::Entry::Level severity = LogSvr::Entry::Level::Informational;
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600300
Zane Shelleyf17bf3e2021-12-07 13:16:37 -0600301 if (AnalysisType::SYSTEM_CHECKSTOP == i_type)
302 {
303 // System checkstops are always unrecoverable errors (service action
304 // required).
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600305 severity = LogSvr::Entry::Level::Error;
Zane Shelleyf17bf3e2021-12-07 13:16:37 -0600306 }
307 else if (AnalysisType::TERMINATE_IMMEDIATE == i_type)
308 {
309 // TIs will be reported as a predicive error (service action required).
310 severity = LogSvr::Entry::Level::Warning;
311 }
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600312
313 // Convert the message severity to a string.
314 return LogSvr::Entry::convertLevelToString(severity);
315}
316
317//------------------------------------------------------------------------------
318
Zane Shelley62adf5c2022-01-18 21:06:50 -0600319uint32_t createPel(const ServiceData& i_servData)
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600320{
Zane Shelley611b3442021-11-19 16:02:01 -0600321 uint32_t o_plid = 0; // default, zero indicates PEL was not created
322
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600323 // The message registry will require additional log data to fill in keywords
324 // and additional log data.
325 std::map<std::string, std::string> logData;
326
327 // Keep track of the temporary files associated with the user data FFDC.
328 // WARNING: Once the objects stored in this vector go out of scope, the
329 // temporary files will be deleted. So they must remain in scope
330 // until the PEL is submitted.
331 std::vector<util::FFDCFile> userDataFiles;
332
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600333 // Set words 6-9 of the SRC.
Zane Shelley8af9e462021-03-11 10:44:28 -0600334 __setSrc(i_servData.getRootCause(), logData);
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600335
Zane Shelley4ed4be52021-02-15 17:53:40 -0600336 // Add the list of callouts to the PEL.
337 __addCalloutList(i_servData, userDataFiles);
338
Zane Shelleyc18ba8f2021-12-01 16:29:20 -0600339 // Add the Hostboot scratch register to the PEL.
340 __captureHostbootScratchRegisters(userDataFiles);
341
Zane Shelley2d114322021-08-25 17:06:12 -0500342 // Add the callout FFDC to the PEL.
343 __addCalloutFFDC(i_servData, userDataFiles);
344
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600345 // Capture the complete signature list.
Zane Shelley62adf5c2022-01-18 21:06:50 -0600346 __captureSignatureList(i_servData.getIsolationData(), userDataFiles);
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600347
Zane Shelley8f60a622021-02-01 14:41:30 -0600348 // Capture the complete signature list.
Zane Shelley62adf5c2022-01-18 21:06:50 -0600349 __captureRegisterDump(i_servData.getIsolationData(), userDataFiles);
Zane Shelley8f60a622021-02-01 14:41:30 -0600350
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600351 // Now, that all of the user data files have been created, transform the
352 // data into the proper format for the PEL.
353 std::vector<util::FFDCTuple> userData;
354 util::transformFFDC(userDataFiles, userData);
355
Ben Tyner7029e522021-08-09 19:18:24 -0500356 try
357 {
358 // We want to use the logging interface that returns the event log
359 // id's of the newly created logs (org.open_power.Logging.PEL) so
360 // find the service that implements this interface.
361 constexpr auto interface = "org.open_power.Logging.PEL";
362 constexpr auto path = "/xyz/openbmc_project/logging";
363 std::string service;
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600364
Ben Tyner7029e522021-08-09 19:18:24 -0500365 if (0 == util::dbus::findService(interface, path, service))
366 {
367 // Use function that returns log id's
368 constexpr auto function = "CreatePELWithFFDCFiles";
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600369
Ben Tyner7029e522021-08-09 19:18:24 -0500370 // Get access to logging interface and method for creating log.
371 auto bus = sdbusplus::bus::new_default_system();
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600372
Ben Tyner7029e522021-08-09 19:18:24 -0500373 // Using direct create method (for additional data).
374 auto method =
375 bus.new_method_call(service.c_str(), path, interface, function);
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600376
Ben Tyner7029e522021-08-09 19:18:24 -0500377 // The "Create" method requires manually adding the process ID.
378 logData["_PID"] = std::to_string(getpid());
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600379
Ben Tyner7029e522021-08-09 19:18:24 -0500380 // Get the message registry entry for this failure.
Zane Shelleyf17bf3e2021-12-07 13:16:37 -0600381 auto message = __getMessageRegistry(i_servData.getAnalysisType());
Ben Tyner7029e522021-08-09 19:18:24 -0500382
383 // Get the message severity for this failure.
Zane Shelleyf17bf3e2021-12-07 13:16:37 -0600384 auto severity = __getMessageSeverity(i_servData.getAnalysisType());
Ben Tyner7029e522021-08-09 19:18:24 -0500385
386 // Add the message, with additional log and user data.
387 method.append(message, severity, logData, userData);
388
389 // Log the event.
390 auto reply = bus.call(method);
391
Zane Shelley611b3442021-11-19 16:02:01 -0600392 // Response will be a tuple containing bmc-log-id, pel-log-id
393 std::tuple<uint32_t, uint32_t> response = {0, 0};
394
Ben Tyner7029e522021-08-09 19:18:24 -0500395 // Parse reply for response
396 reply.read(response);
Zane Shelley611b3442021-11-19 16:02:01 -0600397
398 o_plid = std::get<1>(response);
Ben Tyner7029e522021-08-09 19:18:24 -0500399 }
400 }
401 catch (const sdbusplus::exception::SdBusError& e)
402 {
403 trace::err("Exception while creating event log entry");
404 std::string exceptionString = std::string(e.what());
405 trace::err(exceptionString.c_str());
406 }
407
Zane Shelley611b3442021-11-19 16:02:01 -0600408 // Return the platorm log ID of the error.
409 return o_plid;
Zane Shelleyd3b9bac2020-11-17 21:59:12 -0600410}
411
412} // namespace analyzer