Add buffer based decoders
libcper currently supports an API that reads from a FILE* type. This
is fine for some use cases, but in the majority of use cases where we're
embedding, libcper would prefer to not be opinionated about how a file
came to be.
This patchset adds two new public methods, cper_buf_to_ir and
cper_buf_single_section_to_ir, which function like the existing non _buf
versions of these.
As a stepping stone, these are implemented as a fmemopen to get a FILE*
object to be passed to the underlying functions. This allows us in a
future commit to start removing the FILE* interfaces internally and pass
the buffer directly throughout libcper.
Change-Id: I9fb7ab46b8ba7bfef7bd71ec37f2b55054b09d72
Signed-off-by: Ed Tanous <etanous@nvidia.com>
diff --git a/cper-parse.c b/cper-parse.c
index 128b768..27ca4b2 100644
--- a/cper-parse.c
+++ b/cper-parse.c
@@ -22,6 +22,21 @@
json_object *cper_section_to_ir(FILE *handle, long base_pos,
EFI_ERROR_SECTION_DESCRIPTOR *descriptor);
+json_object *cper_buf_to_ir(void *cper_buf, size_t size)
+{
+ // TODO, this really should avoid the overhead of fmemopen()
+ // but doing so would require a lot of code changes to evict FILE* from
+ // The internals of libcper
+ FILE *cper_file = fmemopen(cper_buf, size, "r");
+ if (!cper_file) {
+ printf("Failed to open CPER buffer.\n");
+ return NULL;
+ }
+ json_object *ir = cper_to_ir(cper_file);
+ fclose(cper_file);
+ return ir;
+}
+
//Reads a CPER log file at the given file location, and returns an intermediate
//JSON representation of this CPER record.
json_object *cper_to_ir(FILE *cper_file)
@@ -376,6 +391,21 @@
return result;
}
+json_object *cper_buf_single_section_to_ir(void *cper_buf, size_t size)
+{
+ // TODO, this really should avoid the overhead of fmemopen()
+ // but doing so would require a lot of code changes to evict FILE* from
+ // The internals of libcper.
+ FILE *cper_file = fmemopen(cper_buf, size, "r");
+ if (!cper_file) {
+ printf("Failed to open CPER buffer.\n");
+ return NULL;
+ }
+ json_object *ir = cper_to_ir(cper_file);
+ fclose(cper_file);
+ return ir;
+}
+
//Converts a single CPER section, without a header but with a section descriptor, to JSON.
json_object *cper_single_section_to_ir(FILE *cper_section_file)
{
diff --git a/include/libcper/cper-parse.h b/include/libcper/cper-parse.h
index 123c83e..bb9d831 100644
--- a/include/libcper/cper-parse.h
+++ b/include/libcper/cper-parse.h
@@ -29,7 +29,10 @@
"HW_ERROR_FLAGS_SIMULATED" }
json_object *cper_to_ir(FILE *cper_file);
+json_object *cper_buf_to_ir(void *cper_buf, size_t size);
json_object *cper_single_section_to_ir(FILE *cper_section_file);
+json_object *cper_buf_single_section_to_ir(void *cper_buf, size_t size);
+
void ir_to_cper(json_object *ir, FILE *out);
void ir_single_section_to_cper(json_object *ir, FILE *out);