blob: ee0d23248dc45a0ebb4a8dd0d5500e53215b5a9b [file] [log] [blame]
Matt Spinler711d51d2019-11-06 09:36:51 -06001/**
2 * Copyright © 2019 IBM Corporation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Matt Spinler89fa0822019-07-17 13:54:30 -050016#include "repository.hpp"
17
Matt Spinlerdd325c32020-07-07 11:01:54 -050018#include <sys/stat.h>
19
Matt Spinler89fa0822019-07-17 13:54:30 -050020#include <fstream>
21#include <phosphor-logging/log.hpp>
22#include <xyz/openbmc_project/Common/File/error.hpp>
23
24namespace openpower
25{
26namespace pels
27{
28
29namespace fs = std::filesystem;
30using namespace phosphor::logging;
31namespace file_error = sdbusplus::xyz::openbmc_project::Common::File::Error;
32
Matt Spinler7e727a32020-07-07 15:00:17 -050033constexpr size_t warningPercentage = 95;
34
Matt Spinlerdd325c32020-07-07 11:01:54 -050035/**
36 * @brief Returns the amount of space the file uses on disk.
37 *
38 * This is different than just the regular size of the file.
39 *
40 * @param[in] file - The file to get the size of
41 *
42 * @return size_t The disk space the file uses
43 */
44size_t getFileDiskSize(const std::filesystem::path& file)
45{
46 constexpr size_t statBlockSize = 512;
47 struct stat statData;
48 auto rc = stat(file.c_str(), &statData);
49 if (rc != 0)
50 {
51 auto e = errno;
52 std::string msg = "call to stat() failed on " + file.native() +
53 " with errno " + std::to_string(e);
54 log<level::ERR>(msg.c_str());
55 abort();
56 }
57
58 return statData.st_blocks * statBlockSize;
59}
60
Matt Spinler8d5f3a22020-07-07 10:30:33 -050061Repository::Repository(const std::filesystem::path& basePath, size_t repoSize,
62 size_t maxNumPELs) :
63 _logPath(basePath / "logs"),
Sumit Kumar1d8835b2021-06-07 09:35:30 -050064 _maxRepoSize(repoSize), _maxNumPELs(maxNumPELs),
65 _archivePath(basePath / "logs" / "archive")
Matt Spinler89fa0822019-07-17 13:54:30 -050066{
67 if (!fs::exists(_logPath))
68 {
69 fs::create_directories(_logPath);
70 }
Matt Spinler475e5742019-07-18 16:09:49 -050071
Sumit Kumar1d8835b2021-06-07 09:35:30 -050072 if (!fs::exists(_archivePath))
73 {
74 fs::create_directories(_archivePath);
75 }
76
Matt Spinler475e5742019-07-18 16:09:49 -050077 restore();
78}
79
80void Repository::restore()
81{
82 for (auto& dirEntry : fs::directory_iterator(_logPath))
83 {
84 try
85 {
86 if (!fs::is_regular_file(dirEntry.path()))
87 {
88 continue;
89 }
90
91 std::ifstream file{dirEntry.path()};
92 std::vector<uint8_t> data{std::istreambuf_iterator<char>(file),
93 std::istreambuf_iterator<char>()};
94 file.close();
95
Matt Spinler07eefc52019-09-26 11:18:26 -050096 PEL pel{data};
Matt Spinler475e5742019-07-18 16:09:49 -050097 if (pel.valid())
98 {
Matt Spinlera3c12a42019-11-21 13:25:32 -060099 // If the host hasn't acked it, reset the host state so
100 // it will get sent up again.
101 if (pel.hostTransmissionState() == TransmissionState::sent)
102 {
103 pel.setHostTransmissionState(TransmissionState::newPEL);
104 try
105 {
106 write(pel, dirEntry.path());
107 }
Patrick Williams66491c62021-10-06 12:23:37 -0500108 catch (const std::exception& e)
Matt Spinlera3c12a42019-11-21 13:25:32 -0600109 {
110 log<level::ERR>(
111 "Failed to save PEL after updating host state",
112 entry("PELID=0x%X", pel.id()));
113 }
114 }
115
Matt Spinlerdd325c32020-07-07 11:01:54 -0500116 PELAttributes attributes{dirEntry.path(),
117 getFileDiskSize(dirEntry.path()),
118 pel.privateHeader().creatorID(),
Vijay Loboafb1b462021-07-21 23:29:13 -0500119 pel.userHeader().subsystem(),
Matt Spinlerdd325c32020-07-07 11:01:54 -0500120 pel.userHeader().severity(),
121 pel.userHeader().actionFlags(),
122 pel.hostTransmissionState(),
123 pel.hmcTransmissionState()};
Matt Spinler0ff00482019-11-06 16:19:46 -0600124
Matt Spinler475e5742019-07-18 16:09:49 -0500125 using pelID = LogID::Pel;
126 using obmcID = LogID::Obmc;
Matt Spinler0ff00482019-11-06 16:19:46 -0600127 _pelAttributes.emplace(
Matt Spinler475e5742019-07-18 16:09:49 -0500128 LogID(pelID(pel.id()), obmcID(pel.obmcLogID())),
Matt Spinler0ff00482019-11-06 16:19:46 -0600129 attributes);
Matt Spinlerb188f782020-07-07 11:18:12 -0500130
131 updateRepoStats(attributes, true);
Matt Spinler475e5742019-07-18 16:09:49 -0500132 }
133 else
134 {
135 log<level::ERR>(
136 "Found invalid PEL file while restoring. Removing.",
137 entry("FILENAME=%s", dirEntry.path().c_str()));
138 fs::remove(dirEntry.path());
139 }
140 }
Patrick Williams66491c62021-10-06 12:23:37 -0500141 catch (const std::exception& e)
Matt Spinler475e5742019-07-18 16:09:49 -0500142 {
143 log<level::ERR>("Hit exception while restoring PEL File",
144 entry("FILENAME=%s", dirEntry.path().c_str()),
145 entry("ERROR=%s", e.what()));
146 }
147 }
Sumit Kumar1d8835b2021-06-07 09:35:30 -0500148
149 // Get size of archive folder
150 for (auto& dirEntry : fs::directory_iterator(_archivePath))
151 {
152 _archiveSize += getFileDiskSize(dirEntry);
153 }
Matt Spinler89fa0822019-07-17 13:54:30 -0500154}
155
156std::string Repository::getPELFilename(uint32_t pelID, const BCDTime& time)
157{
158 char name[50];
159 sprintf(name, "%.2X%.2X%.2X%.2X%.2X%.2X%.2X%.2X_%.8X", time.yearMSB,
160 time.yearLSB, time.month, time.day, time.hour, time.minutes,
161 time.seconds, time.hundredths, pelID);
162 return std::string{name};
163}
164
165void Repository::add(std::unique_ptr<PEL>& pel)
166{
Matt Spinlerdf43a302019-11-21 13:16:56 -0600167 pel->setHostTransmissionState(TransmissionState::newPEL);
168 pel->setHMCTransmissionState(TransmissionState::newPEL);
169
Matt Spinler89fa0822019-07-17 13:54:30 -0500170 auto path = _logPath / getPELFilename(pel->id(), pel->commitTime());
Matt Spinlerab1b97f2019-11-07 13:38:07 -0600171
172 write(*(pel.get()), path);
173
Matt Spinlerdd325c32020-07-07 11:01:54 -0500174 PELAttributes attributes{path,
175 getFileDiskSize(path),
176 pel->privateHeader().creatorID(),
Vijay Loboafb1b462021-07-21 23:29:13 -0500177 pel->userHeader().subsystem(),
Matt Spinlerdd325c32020-07-07 11:01:54 -0500178 pel->userHeader().severity(),
179 pel->userHeader().actionFlags(),
Matt Spinler346f99a2019-11-21 13:06:35 -0600180 pel->hostTransmissionState(),
181 pel->hmcTransmissionState()};
Matt Spinlerab1b97f2019-11-07 13:38:07 -0600182
183 using pelID = LogID::Pel;
184 using obmcID = LogID::Obmc;
185 _pelAttributes.emplace(LogID(pelID(pel->id()), obmcID(pel->obmcLogID())),
186 attributes);
187
Matt Spinler44893cc2020-08-26 11:34:17 -0500188 _lastPelID = pel->id();
189
Matt Spinlerb188f782020-07-07 11:18:12 -0500190 updateRepoStats(attributes, true);
191
Matt Spinlerab1b97f2019-11-07 13:38:07 -0600192 processAddCallbacks(*pel);
193}
194
195void Repository::write(const PEL& pel, const fs::path& path)
196{
Matt Spinler89fa0822019-07-17 13:54:30 -0500197 std::ofstream file{path, std::ios::binary};
198
199 if (!file.good())
200 {
201 // If this fails, the filesystem is probably full so it isn't like
202 // we could successfully create yet another error log here.
203 auto e = errno;
Matt Spinler89fa0822019-07-17 13:54:30 -0500204 fs::remove(path);
205 log<level::ERR>("Unable to open PEL file for writing",
206 entry("ERRNO=%d", e), entry("PATH=%s", path.c_str()));
207 throw file_error::Open();
208 }
209
Matt Spinlerab1b97f2019-11-07 13:38:07 -0600210 auto data = pel.data();
Matt Spinler89fa0822019-07-17 13:54:30 -0500211 file.write(reinterpret_cast<const char*>(data.data()), data.size());
212
213 if (file.fail())
214 {
215 // Same note as above about not being able to create an error log
216 // for this case even if we wanted.
217 auto e = errno;
Matt Spinler89fa0822019-07-17 13:54:30 -0500218 file.close();
219 fs::remove(path);
220 log<level::ERR>("Unable to write PEL file", entry("ERRNO=%d", e),
221 entry("PATH=%s", path.c_str()));
222 throw file_error::Write();
223 }
Matt Spinler475e5742019-07-18 16:09:49 -0500224}
225
Matt Spinler52602e32020-07-15 12:37:28 -0500226std::optional<Repository::LogID> Repository::remove(const LogID& id)
Matt Spinler475e5742019-07-18 16:09:49 -0500227{
228 auto pel = findPEL(id);
Patrick Williamsff6b5982021-04-22 09:04:17 -0500229 if (pel == _pelAttributes.end())
Matt Spinler475e5742019-07-18 16:09:49 -0500230 {
Patrick Williamsff6b5982021-04-22 09:04:17 -0500231 return std::nullopt;
Matt Spinler5f5352e2020-03-05 16:23:27 -0600232 }
Matt Spinler52602e32020-07-15 12:37:28 -0500233
Patrick Williamsff6b5982021-04-22 09:04:17 -0500234 LogID actualID = pel->first;
235 updateRepoStats(pel->second, false);
236
237 log<level::DEBUG>("Removing PEL from repository",
238 entry("PEL_ID=0x%X", actualID.pelID.id),
239 entry("OBMC_LOG_ID=%d", actualID.obmcID.id));
Sumit Kumar1d8835b2021-06-07 09:35:30 -0500240
241 if (fs::exists(pel->second.path))
242 {
243 // Check for existense of new archive folder
244 if (!fs::exists(_archivePath))
245 {
246 fs::create_directories(_archivePath);
247 }
248
249 // Move log file to archive folder
250 auto fileName = _archivePath / pel->second.path.filename();
251 fs::rename(pel->second.path, fileName);
252
253 // Update size of file
254 _archiveSize += getFileDiskSize(fileName);
255 }
256
Patrick Williamsff6b5982021-04-22 09:04:17 -0500257 _pelAttributes.erase(pel);
258
259 processDeleteCallbacks(actualID.pelID.id);
260
Matt Spinler52602e32020-07-15 12:37:28 -0500261 return actualID;
Matt Spinler89fa0822019-07-17 13:54:30 -0500262}
263
Matt Spinler2813f362019-07-19 12:45:28 -0500264std::optional<std::vector<uint8_t>> Repository::getPELData(const LogID& id)
265{
266 auto pel = findPEL(id);
Matt Spinler0ff00482019-11-06 16:19:46 -0600267 if (pel != _pelAttributes.end())
Matt Spinler2813f362019-07-19 12:45:28 -0500268 {
Matt Spinler0ff00482019-11-06 16:19:46 -0600269 std::ifstream file{pel->second.path.c_str()};
Matt Spinler2813f362019-07-19 12:45:28 -0500270 if (!file.good())
271 {
272 auto e = errno;
273 log<level::ERR>("Unable to open PEL file", entry("ERRNO=%d", e),
Matt Spinler0ff00482019-11-06 16:19:46 -0600274 entry("PATH=%s", pel->second.path.c_str()));
Matt Spinler2813f362019-07-19 12:45:28 -0500275 throw file_error::Open();
276 }
277
278 std::vector<uint8_t> data{std::istreambuf_iterator<char>(file),
279 std::istreambuf_iterator<char>()};
280 return data;
281 }
282
283 return std::nullopt;
284}
285
Matt Spinler6d512242019-12-09 13:44:17 -0600286std::optional<sdbusplus::message::unix_fd> Repository::getPELFD(const LogID& id)
287{
288 auto pel = findPEL(id);
289 if (pel != _pelAttributes.end())
290 {
291 FILE* fp = fopen(pel->second.path.c_str(), "rb");
292
293 if (fp == nullptr)
294 {
295 auto e = errno;
296 log<level::ERR>("Unable to open PEL File", entry("ERRNO=%d", e),
297 entry("PATH=%s", pel->second.path.c_str()));
298 throw file_error::Open();
299 }
300
301 // Must leave the file open here. It will be closed by sdbusplus
302 // when it sends it back over D-Bus.
303
304 return fileno(fp);
305 }
306 return std::nullopt;
307}
308
Matt Spinler1ea78802019-11-01 13:04:59 -0500309void Repository::for_each(ForEachFunc func) const
310{
Matt Spinler0ff00482019-11-06 16:19:46 -0600311 for (const auto& [id, attributes] : _pelAttributes)
Matt Spinler1ea78802019-11-01 13:04:59 -0500312 {
Matt Spinler0ff00482019-11-06 16:19:46 -0600313 std::ifstream file{attributes.path};
Matt Spinler1ea78802019-11-01 13:04:59 -0500314
315 if (!file.good())
316 {
317 auto e = errno;
318 log<level::ERR>("Repository::for_each: Unable to open PEL file",
319 entry("ERRNO=%d", e),
Matt Spinler0ff00482019-11-06 16:19:46 -0600320 entry("PATH=%s", attributes.path.c_str()));
Matt Spinler1ea78802019-11-01 13:04:59 -0500321 continue;
322 }
323
324 std::vector<uint8_t> data{std::istreambuf_iterator<char>(file),
325 std::istreambuf_iterator<char>()};
326 file.close();
327
328 PEL pel{data};
329
330 try
331 {
332 if (func(pel))
333 {
334 break;
335 }
336 }
Patrick Williams66491c62021-10-06 12:23:37 -0500337 catch (const std::exception& e)
Matt Spinler1ea78802019-11-01 13:04:59 -0500338 {
339 log<level::ERR>("Repository::for_each function exception",
340 entry("ERROR=%s", e.what()));
341 }
342 }
343}
344
Matt Spinler421f6532019-11-06 15:40:45 -0600345void Repository::processAddCallbacks(const PEL& pel) const
346{
347 for (auto& [name, func] : _addSubscriptions)
348 {
349 try
350 {
351 func(pel);
352 }
Patrick Williams66491c62021-10-06 12:23:37 -0500353 catch (const std::exception& e)
Matt Spinler421f6532019-11-06 15:40:45 -0600354 {
355 log<level::ERR>("PEL Repository add callback exception",
356 entry("NAME=%s", name.c_str()),
357 entry("ERROR=%s", e.what()));
358 }
359 }
360}
361
362void Repository::processDeleteCallbacks(uint32_t id) const
363{
364 for (auto& [name, func] : _deleteSubscriptions)
365 {
366 try
367 {
368 func(id);
369 }
Patrick Williams66491c62021-10-06 12:23:37 -0500370 catch (const std::exception& e)
Matt Spinler421f6532019-11-06 15:40:45 -0600371 {
372 log<level::ERR>("PEL Repository delete callback exception",
373 entry("NAME=%s", name.c_str()),
374 entry("ERROR=%s", e.what()));
375 }
376 }
377}
378
Matt Spinler0ff00482019-11-06 16:19:46 -0600379std::optional<std::reference_wrapper<const Repository::PELAttributes>>
380 Repository::getPELAttributes(const LogID& id) const
381{
382 auto pel = findPEL(id);
383 if (pel != _pelAttributes.end())
384 {
385 return pel->second;
386 }
387
388 return std::nullopt;
389}
390
Matt Spinler29d18c12019-11-21 13:31:27 -0600391void Repository::setPELHostTransState(uint32_t pelID, TransmissionState state)
392{
393 LogID id{LogID::Pel{pelID}};
394 auto attr = std::find_if(_pelAttributes.begin(), _pelAttributes.end(),
395 [&id](const auto& a) { return a.first == id; });
396
397 if ((attr != _pelAttributes.end()) && (attr->second.hostState != state))
398 {
399 PELUpdateFunc func = [state](PEL& pel) {
400 pel.setHostTransmissionState(state);
401 };
402
403 try
404 {
405 updatePEL(attr->second.path, func);
406
407 attr->second.hostState = state;
408 }
Patrick Williams66491c62021-10-06 12:23:37 -0500409 catch (const std::exception& e)
Matt Spinler29d18c12019-11-21 13:31:27 -0600410 {
411 log<level::ERR>("Unable to update PEL host transmission state",
412 entry("PATH=%s", attr->second.path.c_str()),
413 entry("ERROR=%s", e.what()));
414 }
415 }
416}
417
418void Repository::setPELHMCTransState(uint32_t pelID, TransmissionState state)
419{
420 LogID id{LogID::Pel{pelID}};
421 auto attr = std::find_if(_pelAttributes.begin(), _pelAttributes.end(),
422 [&id](const auto& a) { return a.first == id; });
423
424 if ((attr != _pelAttributes.end()) && (attr->second.hmcState != state))
425 {
426 PELUpdateFunc func = [state](PEL& pel) {
427 pel.setHMCTransmissionState(state);
428 };
429
430 try
431 {
432 updatePEL(attr->second.path, func);
433
434 attr->second.hmcState = state;
435 }
Patrick Williams66491c62021-10-06 12:23:37 -0500436 catch (const std::exception& e)
Matt Spinler29d18c12019-11-21 13:31:27 -0600437 {
438 log<level::ERR>("Unable to update PEL HMC transmission state",
439 entry("PATH=%s", attr->second.path.c_str()),
440 entry("ERROR=%s", e.what()));
441 }
442 }
443}
444
445void Repository::updatePEL(const fs::path& path, PELUpdateFunc updateFunc)
446{
447 std::ifstream file{path};
448 std::vector<uint8_t> data{std::istreambuf_iterator<char>(file),
449 std::istreambuf_iterator<char>()};
450 file.close();
451
452 PEL pel{data};
453
454 if (pel.valid())
455 {
456 updateFunc(pel);
457
458 write(pel, path);
459 }
460 else
461 {
462 throw std::runtime_error(
463 "Unable to read a valid PEL when trying to update it");
464 }
465}
466
Matt Spinlerb188f782020-07-07 11:18:12 -0500467bool Repository::isServiceableSev(const PELAttributes& pel)
468{
469 auto sevType = static_cast<SeverityType>(pel.severity & 0xF0);
470 auto sevPVEntry =
471 pel_values::findByValue(pel.severity, pel_values::severityValues);
472 std::string sevName = std::get<pel_values::registryNamePos>(*sevPVEntry);
473
474 bool check1 = (sevType == SeverityType::predictive) ||
475 (sevType == SeverityType::unrecoverable) ||
476 (sevType == SeverityType::critical);
477
478 bool check2 = ((sevType == SeverityType::recovered) ||
479 (sevName == "symptom_recovered")) &&
480 !pel.actionFlags.test(hiddenFlagBit);
481
482 bool check3 = (sevName == "symptom_predictive") ||
483 (sevName == "symptom_unrecoverable") ||
484 (sevName == "symptom_critical");
485
486 return check1 || check2 || check3;
487}
488
489void Repository::updateRepoStats(const PELAttributes& pel, bool pelAdded)
490{
491 auto isServiceable = Repository::isServiceableSev(pel);
492 auto bmcPEL = CreatorID::openBMC == static_cast<CreatorID>(pel.creator);
493
494 auto adjustSize = [pelAdded, &pel](auto& runningSize) {
495 if (pelAdded)
496 {
497 runningSize += pel.sizeOnDisk;
498 }
499 else
500 {
501 runningSize = std::max(static_cast<int64_t>(runningSize) -
502 static_cast<int64_t>(pel.sizeOnDisk),
503 static_cast<int64_t>(0));
504 }
505 };
506
507 adjustSize(_sizes.total);
508
509 if (bmcPEL)
510 {
511 adjustSize(_sizes.bmc);
512 if (isServiceable)
513 {
514 adjustSize(_sizes.bmcServiceable);
515 }
516 else
517 {
518 adjustSize(_sizes.bmcInfo);
519 }
520 }
521 else
522 {
523 adjustSize(_sizes.nonBMC);
524 if (isServiceable)
525 {
526 adjustSize(_sizes.nonBMCServiceable);
527 }
528 else
529 {
530 adjustSize(_sizes.nonBMCInfo);
531 }
532 }
533}
534
Sumit Kumarc2966922021-07-21 10:14:03 -0500535bool Repository::sizeWarning()
Matt Spinler7e727a32020-07-07 15:00:17 -0500536{
Sumit Kumarc2966922021-07-21 10:14:03 -0500537 std::error_code ec;
538
Sumit Kumar1d8835b2021-06-07 09:35:30 -0500539 if ((_archiveSize > 0) && ((_sizes.total + _archiveSize) >
540 ((_maxRepoSize * warningPercentage) / 100)))
541 {
542 log<level::INFO>(
543 "Repository::sizeWarning function:Deleting the files in archive");
544
Sumit Kumarc2966922021-07-21 10:14:03 -0500545 for (const auto& dirEntry : fs::directory_iterator(_archivePath))
Sumit Kumar1d8835b2021-06-07 09:35:30 -0500546 {
Sumit Kumarc2966922021-07-21 10:14:03 -0500547 fs::remove(dirEntry.path(), ec);
548 if (ec)
549 {
550 log<level::INFO>(
551 "Repository::sizeWarning function:Could not delete "
552 "a file in PEL archive",
553 entry("FILENAME=%s", dirEntry.path().c_str()));
554 }
Sumit Kumar1d8835b2021-06-07 09:35:30 -0500555 }
Sumit Kumarc2966922021-07-21 10:14:03 -0500556
557 _archiveSize = 0;
Sumit Kumar1d8835b2021-06-07 09:35:30 -0500558 }
559
Matt Spinler7e727a32020-07-07 15:00:17 -0500560 return (_sizes.total > (_maxRepoSize * warningPercentage / 100)) ||
561 (_pelAttributes.size() > _maxNumPELs);
562}
563
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500564std::vector<Repository::AttributesReference>
565 Repository::getAllPELAttributes(SortOrder order) const
566{
567 std::vector<Repository::AttributesReference> attributes;
568
569 std::for_each(
570 _pelAttributes.begin(), _pelAttributes.end(),
571 [&attributes](auto& pelEntry) { attributes.push_back(pelEntry); });
572
573 std::sort(attributes.begin(), attributes.end(),
574 [order](const auto& left, const auto& right) {
575 if (order == SortOrder::ascending)
576 {
577 return left.get().second.path < right.get().second.path;
578 }
579 return left.get().second.path > right.get().second.path;
580 });
581
582 return attributes;
583}
584
Sumit Kumar027bf282022-01-24 11:25:19 -0600585std::vector<uint32_t>
586 Repository::prune(const std::vector<uint32_t>& idsWithHwIsoEntry)
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500587{
588 std::vector<uint32_t> obmcLogIDs;
589 std::string msg = "Pruning PEL repository that takes up " +
590 std::to_string(_sizes.total) + " bytes and has " +
591 std::to_string(_pelAttributes.size()) + " PELs";
592 log<level::INFO>(msg.c_str());
593
594 // Set up the 5 functions to check if the PEL category
595 // is still over its limits.
596
597 // BMC informational PELs should only take up 15%
598 IsOverLimitFunc overBMCInfoLimit = [this]() {
599 return _sizes.bmcInfo > _maxRepoSize * 15 / 100;
600 };
601
602 // BMC non informational PELs should only take up 30%
603 IsOverLimitFunc overBMCNonInfoLimit = [this]() {
604 return _sizes.bmcServiceable > _maxRepoSize * 30 / 100;
605 };
606
607 // Non BMC informational PELs should only take up 15%
608 IsOverLimitFunc overNonBMCInfoLimit = [this]() {
609 return _sizes.nonBMCInfo > _maxRepoSize * 15 / 100;
610 };
611
612 // Non BMC non informational PELs should only take up 15%
613 IsOverLimitFunc overNonBMCNonInfoLimit = [this]() {
614 return _sizes.nonBMCServiceable > _maxRepoSize * 30 / 100;
615 };
616
617 // Bring the total number of PELs down to 80% of the max
618 IsOverLimitFunc tooManyPELsLimit = [this]() {
619 return _pelAttributes.size() > _maxNumPELs * 80 / 100;
620 };
621
622 // Set up the functions to determine which category a PEL is in.
623 // TODO: Return false in these functions if a PEL caused a guard record.
624
625 // A BMC informational PEL
626 IsPELTypeFunc isBMCInfo = [](const PELAttributes& pel) {
627 return (CreatorID::openBMC == static_cast<CreatorID>(pel.creator)) &&
628 !Repository::isServiceableSev(pel);
629 };
630
631 // A BMC non informational PEL
632 IsPELTypeFunc isBMCNonInfo = [](const PELAttributes& pel) {
633 return (CreatorID::openBMC == static_cast<CreatorID>(pel.creator)) &&
634 Repository::isServiceableSev(pel);
635 };
636
637 // A non BMC informational PEL
638 IsPELTypeFunc isNonBMCInfo = [](const PELAttributes& pel) {
639 return (CreatorID::openBMC != static_cast<CreatorID>(pel.creator)) &&
640 !Repository::isServiceableSev(pel);
641 };
642
643 // A non BMC non informational PEL
644 IsPELTypeFunc isNonBMCNonInfo = [](const PELAttributes& pel) {
645 return (CreatorID::openBMC != static_cast<CreatorID>(pel.creator)) &&
646 Repository::isServiceableSev(pel);
647 };
648
649 // When counting PELs, count every PEL
Patrick Williamsd26fa3e2021-04-21 15:22:23 -0500650 IsPELTypeFunc isAnyPEL = [](const PELAttributes& /*pel*/) { return true; };
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500651
652 // Check all 4 categories, which will result in at most 90%
653 // usage (15 + 30 + 15 + 30).
Sumit Kumar027bf282022-01-24 11:25:19 -0600654 removePELs(overBMCInfoLimit, isBMCInfo, idsWithHwIsoEntry, obmcLogIDs);
655 removePELs(overBMCNonInfoLimit, isBMCNonInfo, idsWithHwIsoEntry,
656 obmcLogIDs);
657 removePELs(overNonBMCInfoLimit, isNonBMCInfo, idsWithHwIsoEntry,
658 obmcLogIDs);
659 removePELs(overNonBMCNonInfoLimit, isNonBMCNonInfo, idsWithHwIsoEntry,
660 obmcLogIDs);
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500661
662 // After the above pruning check if there are still too many PELs,
663 // which can happen depending on PEL sizes.
664 if (_pelAttributes.size() > _maxNumPELs)
665 {
Sumit Kumar027bf282022-01-24 11:25:19 -0600666 removePELs(tooManyPELsLimit, isAnyPEL, idsWithHwIsoEntry, obmcLogIDs);
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500667 }
668
669 if (!obmcLogIDs.empty())
670 {
Matt Spinler45796e82022-07-01 11:25:27 -0500671 std::string m = "Number of PELs removed to save space: " +
672 std::to_string(obmcLogIDs.size());
673 log<level::INFO>(m.c_str());
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500674 }
675
676 return obmcLogIDs;
677}
678
Matt Spinler45796e82022-07-01 11:25:27 -0500679void Repository::removePELs(const IsOverLimitFunc& isOverLimit,
680 const IsPELTypeFunc& isPELType,
Sumit Kumar027bf282022-01-24 11:25:19 -0600681 const std::vector<uint32_t>& idsWithHwIsoEntry,
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500682 std::vector<uint32_t>& removedBMCLogIDs)
683{
684 if (!isOverLimit())
685 {
686 return;
687 }
688
689 auto attributes = getAllPELAttributes(SortOrder::ascending);
690
691 // Make 4 passes on the PELs, stopping as soon as isOverLimit
692 // returns false.
693 // Pass 1: only delete HMC acked PELs
694 // Pass 2: only delete OS acked PELs
695 // Pass 3: only delete PHYP sent PELs
696 // Pass 4: delete all PELs
697 static const std::vector<std::function<bool(const PELAttributes& pel)>>
698 stateChecks{[](const auto& pel) {
699 return pel.hmcState == TransmissionState::acked;
700 },
701
702 [](const auto& pel) {
703 return pel.hostState == TransmissionState::acked;
704 },
705
706 [](const auto& pel) {
707 return pel.hostState == TransmissionState::sent;
708 },
709
Patrick Williamsd26fa3e2021-04-21 15:22:23 -0500710 [](const auto& /*pel*/) { return true; }};
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500711
712 for (const auto& stateCheck : stateChecks)
713 {
714 for (auto it = attributes.begin(); it != attributes.end();)
715 {
716 const auto& pel = it->get();
717 if (isPELType(pel.second) && stateCheck(pel.second))
718 {
719 auto removedID = pel.first.obmcID.id;
Sumit Kumar027bf282022-01-24 11:25:19 -0600720
721 auto idFound = std::find(idsWithHwIsoEntry.begin(),
722 idsWithHwIsoEntry.end(), removedID);
723 if (idFound != idsWithHwIsoEntry.end())
724 {
725 ++it;
726 continue;
727 }
728
Matt Spinlerb0a8df52020-07-07 14:41:06 -0500729 remove(pel.first);
730
731 removedBMCLogIDs.push_back(removedID);
732
733 attributes.erase(it);
734
735 if (!isOverLimit())
736 {
737 break;
738 }
739 }
740 else
741 {
742 ++it;
743 }
744 }
745
746 if (!isOverLimit())
747 {
748 break;
749 }
750 }
751}
752
Sumit Kumar2ccdcef2021-07-31 10:04:58 -0500753void Repository::archivePEL(const PEL& pel)
754{
755 if (pel.valid())
756 {
757 auto path = _archivePath / getPELFilename(pel.id(), pel.commitTime());
758
759 write(pel, path);
760
761 _archiveSize += getFileDiskSize(path);
762 }
763}
764
Matt Spinler89fa0822019-07-17 13:54:30 -0500765} // namespace pels
766} // namespace openpower