[coreboot-gerrit] [M] Change in coreboot[main]: util/cbfstool/cbfs-payload-linux: Add error handling

[Elyes Haouas (Code Review)]

Elyes Haouas has submitted this change. ( https://review.coreboot.org/c/coreboot/+/83617?usp=email )

Change subject: util/cbfstool/cbfs-payload-linux: Add error handling
......................................................................

util/cbfstool/cbfs-payload-linux: Add error handling

This adds some error handling to the code that adds the input segments
(e.g. kernel, cmdline, initrd...) to the output file.

Currently the compress function can fail and coreboot will still
build "successfully" leaving whoever build coreboot puzzled.

Change-Id: Ie36ad469c73cb3ff9360acc9bbe66c245e8b4a1e
Signed-off-by: Maximilian Brune 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/83617
Reviewed-by: Elyes Haouas 
Reviewed-by: Nico Huber 
Tested-by: build bot (Jenkins) 
---
M util/cbfstool/cbfs-payload-linux.c
1 file changed, 64 insertions(+), 25 deletions(-)

Approvals:
  Nico Huber: Looks good to me, approved
  Elyes Haouas: Looks good to me, approved
  build bot (Jenkins): Verified

diff --git a/util/cbfstool/cbfs-payload-linux.c b/util/cbfstool/cbfs-payload-linux.c
index 8c08fd2..d0f24fe 100644
--- a/util/cbfstool/cbfs-payload-linux.c
+++ b/util/cbfstool/cbfs-payload-linux.c
@@ -129,17 +129,19 @@
    return 0;
 }

-static void bzp_output_segment(struct bzpayload *bzp, struct buffer *b,
-			       uint32_t type, uint64_t load_addr,
-			       enum cbfs_compression algo)
+static int bzp_output_segment(struct bzpayload *bzp, struct buffer *b,
+			      uint32_t type, uint64_t load_addr,
+			      enum cbfs_compression algo)
 {
    struct buffer out;
    struct cbfs_payload_segment *seg;
    int len = 0;

/* Don't process empty buffers. */
-	if (b != NULL && buffer_size(b) == 0)
-		return;
+	if (b != NULL && buffer_size(b) == 0) {
+		ERROR("%s(): Input buffer is empty\n", __func__);
+		return -1;
+	}

seg = bzp->out_seg;
    seg->type = type;
@@ -147,8 +149,12 @@
    bzp->out_seg++;

/* No buffer associated with segment. */
-	if (b == NULL)
-		return;
+	if (b == NULL) {
+		if (type == PAYLOAD_SEGMENT_ENTRY)
+			return 0; // entry segments don't have a buffer attached
+		else
+			return -1;
+	}

/* Use a temp buffer for easier management. */
    buffer_splice(&out, &bzp->output, bzp->offset, buffer_size(b));
@@ -157,13 +163,19 @@
    seg->offset = bzp->offset;

comp_func_ptr compress_func = compression_function(algo);
-	compress_func(buffer_get(b), buffer_size(b), buffer_get(&out), &len);
+	int ret = compress_func(buffer_get(b), buffer_size(b), buffer_get(&out), &len);
+	if (ret) {
+		ERROR("%s(): Compression failed\n", __func__);
+		return ret;
+	}

seg->compression = algo;
    seg->len = len;

/* Update output offset. */
    bzp->offset += len;
+
+	return 0; // success
 }

/* TODO:
@@ -291,31 +303,58 @@
    if (bzp_init_output(&bzp, input->name) != 0)
    	return -1;

-	/* parameter block */
-	bzp_output_segment(&bzp, &bzp.parameters,
-			   PAYLOAD_SEGMENT_DATA, LINUX_PARAM_LOC, algo);
+	int ret;

-	/*
-	 * code block
-	 * Note: There is no point in compressing the bzImage (it is already compressed)
-	 */
-	bzp_output_segment(&bzp, &bzp.kernel,
-			   PAYLOAD_SEGMENT_CODE, kernel_base, CBFS_COMPRESS_NONE);
+	/* parameter block */
+	ret = bzp_output_segment(&bzp, &bzp.parameters,
+				 PAYLOAD_SEGMENT_DATA, LINUX_PARAM_LOC, algo);
+	if (ret) {
+		ERROR("%s(): Failed to write Linux zero page into segment\n", __func__);
+		return ret;
+	}
+
+	/* code block: There is no point in compressing the bzImage (it is already compressed)*/
+	ret = bzp_output_segment(&bzp, &bzp.kernel,
+				 PAYLOAD_SEGMENT_CODE, kernel_base, CBFS_COMPRESS_NONE);
+	if (ret) {
+		ERROR("%s(): Failed to write Linux kernel into segment\n", __func__);
+		return ret;
+	}

/* trampoline */
-	bzp_output_segment(&bzp, &bzp.trampoline,
-			   PAYLOAD_SEGMENT_CODE, TRAMPOLINE_ENTRY_LOC, algo);
+	ret = bzp_output_segment(&bzp, &bzp.trampoline,
+				 PAYLOAD_SEGMENT_CODE, TRAMPOLINE_ENTRY_LOC, algo);
+	if (ret) {
+		ERROR("%s(): Failed to write Linux trampoline into segment\n", __func__);
+		return ret;
+	}

/* cmdline */
-	bzp_output_segment(&bzp, &bzp.cmdline,
-			   PAYLOAD_SEGMENT_DATA, COMMAND_LINE_LOC, algo);
+	if (buffer_size(&bzp.cmdline) != 0) {
+		ret = bzp_output_segment(&bzp, &bzp.cmdline,
+					 PAYLOAD_SEGMENT_DATA, COMMAND_LINE_LOC, algo);
+		if (ret) {
+			ERROR("%s(): Failed to write Linux cmdline into segment\n", __func__);
+			return ret;
+		}
+	}

-	/* initrd */
-	bzp_output_segment(&bzp, &bzp.initrd,
-			   PAYLOAD_SEGMENT_DATA, initrd_base, algo);
+	if (buffer_size(&bzp.initrd) != 0) {
+		/* initrd */
+		ret = bzp_output_segment(&bzp, &bzp.initrd,
+					 PAYLOAD_SEGMENT_DATA, initrd_base, algo);
+		if (ret) {
+			ERROR("%s(): Failed to write Linux initrd into segment\n", __func__);
+			return ret;
+		}
+	}

/* Terminating entry segment. */
-	bzp_output_segment(&bzp, NULL, PAYLOAD_SEGMENT_ENTRY, TRAMPOLINE_ENTRY_LOC, algo);
+	ret = bzp_output_segment(&bzp, NULL, PAYLOAD_SEGMENT_ENTRY, TRAMPOLINE_ENTRY_LOC, algo);
+	if (ret) {
+		ERROR("%s(): Failed to write entry segment\n", __func__);
+		return ret;
+	}

/* Set size of buffer taking into account potential compression. */
    buffer_set_size(&bzp.output, bzp.offset);