Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libcper / 596c59e92c4982ad325f60e8d0b3fc4f0cb24596
commit596c59e92c4982ad325f60e8d0b3fc4f0cb24596[log] [tgz]
authorEd Tanous <etanous@nvidia.com>Mon Mar 10 13:15:58 2025 -0700
committerEd Tanous <ed@tanous.net>Tue Mar 18 22:55:13 2025 +0000
tree7d0d47b570b7efa68334b202e3787c1572569a0c
parent73498f66c58efc3f11dd3da21f066a9fd8a8167e [diff]
Fix timestamp handling

timestamp_to_string can fail in unexpected ways.  It attempts to do some
level of error checks, but doesn't return the result of those back to
the caller, which means that this can possibly read from unpopulated
memory.

Adjust the prototype and fix the issues in this helper function.

Change-Id: I9df2dc17142b1fd3a686fd852ac80f4691fd25be
Signed-off-by: Ed Tanous <etanous@nvidia.com>
3 files changed
tree: 7d0d47b570b7efa68334b202e3787c1572569a0c
  1. cli-app/
  2. docs/
  3. examples/
  4. generator/
  5. include/
  6. sections/
  7. specification/
  8. subprojects/
  9. tests/
  10. .clang-format
  11. .clang-tidy
  12. .gitignore
  13. base64.c
  14. common-utils.c
  15. cper-parse.c
  16. cper-parse.i
  17. cper-utils.c
  18. Cper.c
  19. ir-parse.c
  20. json-schema.c
  21. LICENSE
  22. meson.build
  23. meson.options
  24. OWNERS
  25. README.md
README.md

CPER JSON Representation & Conversion Library

This repository specifies a structure for representing UEFI CPER records (as described in UEFI Specification Appendix N) in a human-readable JSON format, in addition to a library which can readily convert back and forth between the standard CPER binary format and the specified structured JSON.

Prerequisites

Before building this library and its associated tools, you must have meson (>=1.1.1)

Building

This project uses Meson (>=1.1.1). To build for native architecture, simply run:

meson setup build
ninja -C build

Usage

This project comes with several binaries to help you deal with CPER binary and CPER-JSON. The first of these is cper-convert, which is a command line tool that can be found in build/. With this, you can convert to and from CPER and CPER-JSON through the command line. An example usage scenario is below:

cper-convert to-cper samples/cper-json-test-arm.json --out cper.dump
cper-convert to-json cper.generated.dump

Another tool bundled with this repository is cper-generate, found in build/. This allows you to generate pseudo-random valid CPER records with sections of specified types for testing purposes. An example use of the program is below:

cper-generate --out cper.generated.dump --sections generic ia32x64

Help for both of these tools can be accessed through using the --help flag in isolation.

Finally, a static library containing symbols for converting CPER and CPER-JSON between an intermediate JSON format can be found generated at lib/libcper-parse.a. This contains the following useful library symbols:

json_object* cper_to_ir(FILE* cper_file);
void ir_to_cper(json_object* ir, FILE* out);

Specification

The specification for this project's CPER-JSON format can be found in specification/, defined in both JSON Schema format and also as a LaTeX document. Specification for the CPER binary format can be found in UEFI Specification Appendix N (2021/03/18).

Usage Examples

This library is utilised in a proof of concept displaying CPER communication between a SatMC and OpenBMC board, including a conversion into CPER JSON for logging that utilises this library. You can find information on how to reproduce the prototype at the scripts repository, and example usage of the library itself at the pldm repository.