[PATCH v3 2/3] tools/bootconfig: Align the bootconfig applied initrd image size to 4

Masami Hiramatsu
2020-11-17T09:53:28Z

Align the bootconfig applied initrd image size to 4. To fill the gap,
the bootconfig command uses null characters in between the bootconfig
data and the footer. This will expands the footer size but don't change
the checksum.
Thus the block image of the initrd file with bootconfig is as follows.

[initrd][bootconfig][(pad)][size][csum]["#BOOTCONFIG\n"]

Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org>
---
Changes in v3:
- Fix patch description
- Fix a typo.
- Consolidate several write()s to 1 time write to fix/simplify
the error check.
Changes in v2:
- Fix to add the footer size.
---
include/linux/bootconfig.h | 1 +
tools/bootconfig/main.c | 48 ++++++++++++++++++++---------------
tools/bootconfig/test-bootconfig.sh | 6 ++++
3 files changed, 33 insertions(+), 22 deletions(-)

diff --git a/include/linux/bootconfig.h b/include/linux/bootconfig.h
index 9903088891fa..461f621047f3 100644
--- a/include/linux/bootconfig.h
+++ b/include/linux/bootconfig.h
@@ -12,6 +12,7 @@

#define BOOTCONFIG_MAGIC "#BOOTCONFIG\n"
#define BOOTCONFIG_MAGIC_LEN 12
+#define BOOTCONFIG_ALIGN 4

/* XBC tree node */
struct xbc_node {
diff --git a/tools/bootconfig/main.c b/tools/bootconfig/main.c
index f7b89a50404c..3991754c97e9 100644
--- a/tools/bootconfig/main.c
+++ b/tools/bootconfig/main.c
@@ -332,12 +332,13 @@ static int delete_xbc(const char *path)

static int apply_xbc(const char *path, const char *xbc_path)
{
+ size_t total_size;
struct stat stat;
u32 size, csum;
char *buf, *data;
int ret, fd;
const char *msg;
- int pos;
+ int pos, pad;

ret = load_xbc_file(xbc_path, &buf);
if (ret < 0) {
@@ -347,13 +348,12 @@ static int apply_xbc(const char *path, const char *xbc_path)
size = strlen(buf) + 1;
csum = checksum((unsigned char *)buf, size);

- /* Prepare xbc_path data */
- data = malloc(size + 8);
+ /* Backup the bootconfig data */
+ data = calloc(size + BOOTCONFIG_ALIGN +
+ sizeof(u32) + sizeof(u32) + BOOTCONFIG_MAGIC_LEN, 1);
if (!data)
return -ENOMEM;
- strcpy(data, buf);
- *(u32 *)(data + size) = size;
- *(u32 *)(data + size + 4) = csum;
+ memcpy(data, buf, size);

/* Check the data format */
ret = xbc_init(buf, &msg, &pos);
@@ -393,24 +393,30 @@ static int apply_xbc(const char *path, const char *xbc_path)
pr_err("Failed to get the size of %s\n", path);
goto out;
}
- ret = write(fd, data, size + 8);
- if (ret < size + 8) {
+
+ /* To align up the total size to BOOTCONFIG_ALIGN, get padding size */
+ total_size = stat.st_size + size + sizeof(u32) * 2 + BOOTCONFIG_MAGIC_LEN;
+ pad = BOOTCONFIG_ALIGN - total_size % BOOTCONFIG_ALIGN;
+ if (pad == BOOTCONFIG_ALIGN)
+ pad = 0;
+ size += pad;
+
+ /* Add a footer */
+ *(u32 *)(data + size) = size;
+ *(u32 *)(data + size + sizeof(u32)) = csum;
+ memcpy(data + size + sizeof(u32) * 2, BOOTCONFIG_MAGIC, BOOTCONFIG_MAGIC_LEN);
+ total_size = size + sizeof(u32) * 2 + BOOTCONFIG_MAGIC_LEN;
+
+ ret = write(fd, data, total_size);
+ if (ret < total_size) {
if (ret < 0)
ret = -errno;
pr_err("Failed to apply a boot config: %d\n", ret);
- if (ret < 0)
- goto out;
- goto out_rollback;
- }
- /* Write a magic word of the bootconfig */
- ret = write(fd, BOOTCONFIG_MAGIC, BOOTCONFIG_MAGIC_LEN);
- if (ret < BOOTCONFIG_MAGIC_LEN) {
- if (ret < 0)
- ret = -errno;
- pr_err("Failed to apply a boot config magic: %d\n", ret);
- goto out_rollback;
- }
- ret = 0;
+ if (ret > 0)
+ goto out_rollback;
+ } else
+ ret = 0;
+
out:
close(fd);
free(data);
diff --git a/tools/bootconfig/test-bootconfig.sh b/tools/bootconfig/test-bootconfig.sh
index d295e406a756..baed891d0ba4 100755
--- a/tools/bootconfig/test-bootconfig.sh
+++ b/tools/bootconfig/test-bootconfig.sh
@@ -9,6 +9,7 @@ else
TESTDIR=.
fi
BOOTCONF=${TESTDIR}/bootconfig
+ALIGN=4

INITRD=`mktemp ${TESTDIR}/initrd-XXXX`
TEMPCONF=`mktemp ${TESTDIR}/temp-XXXX.bconf`
@@ -59,7 +60,10 @@ echo "Show command test"
xpass $BOOTCONF $INITRD

echo "File size check"
-xpass test $new_size -eq $(expr $bconf_size + $initrd_size + 9 + 12)
+total_size=$(expr $bconf_size + $initrd_size + 9 + 12 + $ALIGN - 1 )
+total_size=$(expr $total_size / $ALIGN)
+total_size=$(expr $total_size \* $ALIGN)
+xpass test $new_size -eq $total_size

echo "Apply command repeat test"
xpass $BOOTCONF -a $TEMPCONF $INITRD