Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / libcper / c2ebdddb7d7b2d8c02b178ef1f7f6359bcac0c4c
commitc2ebdddb7d7b2d8c02b178ef1f7f6359bcac0c4c[log] [tgz]
authorEd Tanous <ed@tanous.net>Sun Mar 09 10:07:01 2025 -0700
committerEd Tanous <ed@tanous.net>Tue Mar 18 22:55:13 2025 +0000
treeed963aaf81db85b58d7725cf2760047ac800378a
parentbadae112389c19b2476437b69432463dfbb670c9 [diff]
Fix up guid

GUIDs have some cases where they might not be representable as a string,
due to an overflow.  To handle this previously, the existing
implementation just allocated extra space.

To ensure that we are always publishing correct guids, break this
function down into an add_guid method that we can call anytime we add a
guid to json.  This function can use the appropriate guid string length,
and if we go over, we can make sure that we don't publish the string at
all, by handling the appropriate error codes.

Change-Id: I98239b7d5ba7567cea1b016579d7566e292b6e81
Signed-off-by: Ed Tanous <ed@tanous.net>
5 files changed
tree: ed963aaf81db85b58d7725cf2760047ac800378a
  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.