[PATCH v2] FIT: add first support for compressed images
Sascha Hauer
sha at pengutronix.de
Tue Aug 9 02:39:37 PDT 2022
On Tue, Aug 09, 2022 at 11:19:46AM +0200, Ahmad Fatoum wrote:
> FIT image contents are often compressed, but we got by so far, because
> a compressed initramfs is usually meant to be decompressed by the kernel
> (and so has compression = "none") and arm32 kernels had their own
> decompresser embedded. On ARM64, bootloader is responsible for
> uncompressing kernel, so we should properly process the compression
> property we so far ignored.
>
> The decompression isn't as efficient as one would hope for, because
> the FIT format only describes length of the compressed data. We thus
> have two options:
>
> - define an output size up-front, e.g. by guessing the uncompressed
> buffer size for decompression or hardcoding it (e.g. U-Boot's
> CONFIG_SYS_BOOTM_LEN).
>
> - Uncompress to a file descriptor
>
> We choose the second one to play it safe, but it comes with worse
> performance because of extra memory copies. Intention is to go with
> first option for the kernel image: We know how much size we can spare
> for the kernel image and can have bootm_load_os uncompress there
> directly without intermittent memory copies. This would involve slight
> change to the barebox decompresser API to align it with the kernel's,
> which allows to have it accept and observe an output buffer size.
> So far, we had the kernel PREBOOT API, which lacks such a parameter,
> but that's an optimization for another day.
>
> Signed-off-by: Ahmad Fatoum <a.fatoum at pengutronix.de>
> ---
> v1 -> v2:
> - allocate new uncompressed-data property to reference buffer
> instead of reusing struct property::value instead of
> value_const
> ---
Much better, thanks. Applied.
Sascha
> common/image-fit.c | 31 ++++++++++++++++++++++++++++++-
> drivers/of/base.c | 4 ++--
> include/of.h | 8 ++++++++
> include/uncompress.h | 6 ++++++
> lib/uncompress.c | 40 ++++++++++++++++++++++++++++++++++++++++
> 5 files changed, 86 insertions(+), 3 deletions(-)
>
> diff --git a/common/image-fit.c b/common/image-fit.c
> index 507a857cadb4..82357731fa7a 100644
> --- a/common/image-fit.c
> +++ b/common/image-fit.c
> @@ -21,6 +21,7 @@
> #include <linux/err.h>
> #include <stringlist.h>
> #include <rsa.h>
> +#include <uncompress.h>
> #include <image-fit.h>
>
> #define FDT_MAX_DEPTH 32
> @@ -559,6 +560,11 @@ int fit_get_image_address(struct fit_handle *handle, void *configuration,
> return ret;
> }
>
> +static void fit_uncompress_error_fn(char *x)
> +{
> + pr_err("%s\n", x);
> +}
> +
> /**
> * fit_open_image - Open an image in a FIT image
> * @handle: The FIT image handle
> @@ -581,7 +587,8 @@ int fit_open_image(struct fit_handle *handle, void *configuration,
> unsigned long *outsize)
> {
> struct device_node *image;
> - const char *unit = name, *type = NULL, *desc= "(no description)";
> + const char *unit = name, *type = NULL, *compression = NULL,
> + *desc= "(no description)";
> const void *data;
> int data_len;
> int ret = 0;
> @@ -613,6 +620,28 @@ int fit_open_image(struct fit_handle *handle, void *configuration,
> if (ret < 0)
> return ret;
>
> + of_property_read_string(image, "compression", &compression);
> + if (compression && strcmp(compression, "none") != 0) {
> + void *uc_data;
> +
> + if (!IS_ENABLED(CONFIG_UNCOMPRESS)) {
> + pr_err("image has compression = \"%s\", but support not compiled in\n");
> + return -ENOSYS;
> + }
> +
> + data_len = uncompress_buf_to_buf(data, data_len, &uc_data,
> + fit_uncompress_error_fn);
> + if (data_len < 0) {
> + pr_err("data couldn't be decompressed\n");
> + return data_len;
> + }
> +
> + data = uc_data;
> +
> + /* associate buffer with FIT, so it's not leaked */
> + __of_new_property(image, "uncompressed-data", uc_data, data_len);
> + }
> +
> *outdata = data;
> *outsize = data_len;
>
> diff --git a/drivers/of/base.c b/drivers/of/base.c
> index 2247b5a1a348..37c94d00bf2a 100644
> --- a/drivers/of/base.c
> +++ b/drivers/of/base.c
> @@ -2221,8 +2221,8 @@ struct device_node *of_new_node(struct device_node *parent, const char *name)
> return node;
> }
>
> -static struct property *__of_new_property(struct device_node *node, const char *name,
> - void *data, int len)
> +struct property *__of_new_property(struct device_node *node, const char *name,
> + void *data, int len)
> {
> struct property *prop;
>
> diff --git a/include/of.h b/include/of.h
> index 4aadbb7edb49..25254456d014 100644
> --- a/include/of.h
> +++ b/include/of.h
> @@ -136,6 +136,8 @@ extern struct property *of_new_property(struct device_node *node,
> extern struct property *of_new_property_const(struct device_node *node,
> const char *name,
> const void *data, int len);
> +extern struct property *__of_new_property(struct device_node *node,
> + const char *name, void *data, int len);
> extern void of_delete_property(struct property *pp);
>
> extern struct device_node *of_find_node_by_name(struct device_node *from,
> @@ -520,6 +522,12 @@ static inline struct property *of_new_property(struct device_node *node,
> return NULL;
> }
>
> +extern struct property *__of_new_property(struct device_node *node,
> + const char *name, void *data, int len)
> +{
> + return NULL;
> +}
> +
> static inline void of_delete_property(struct property *pp)
> {
> }
> diff --git a/include/uncompress.h b/include/uncompress.h
> index 4bdb03d4f5b6..72ba1dfda607 100644
> --- a/include/uncompress.h
> +++ b/include/uncompress.h
> @@ -15,6 +15,12 @@ int uncompress_fd_to_fd(int infd, int outfd,
> int uncompress_fd_to_buf(int infd, void *output,
> void(*error_fn)(char *x));
>
> +int uncompress_buf_to_fd(const void *input, size_t input_len,
> + int outfd, void(*error_fn)(char *x));
> +
> +ssize_t uncompress_buf_to_buf(const void *input, size_t input_len,
> + void **buf, void(*error_fn)(char *x));
> +
> void uncompress_err_stdout(char *);
>
> #endif /* __UNCOMPRESS_H */
> diff --git a/lib/uncompress.c b/lib/uncompress.c
> index 15eb3da098c8..1134d8c52801 100644
> --- a/lib/uncompress.c
> +++ b/lib/uncompress.c
> @@ -178,3 +178,43 @@ int uncompress_fd_to_buf(int infd, void *output,
>
> return uncompress(NULL, 0, fill_fd, NULL, output, NULL, error_fn);
> }
> +
> +int uncompress_buf_to_fd(const void *input, size_t input_len,
> + int outfd, void(*error_fn)(char *x))
> +{
> + uncompress_outfd = outfd;
> +
> + return uncompress((void *)input, input_len, NULL, flush_fd,
> + NULL, NULL, error_fn);
> +}
> +
> +ssize_t uncompress_buf_to_buf(const void *input, size_t input_len,
> + void **buf, void(*error_fn)(char *x))
> +{
> + char *dstpath;
> + size_t size;
> + int outfd, ret;
> +
> + dstpath = make_temp("data-uncompressed");
> + if (!dstpath)
> + return -ENOMEM;
> +
> + outfd = open(dstpath, O_CREAT | O_WRONLY);
> + if (outfd < 0) {
> + ret = -ENODEV;
> + goto free_temp;
> + }
> +
> + ret = uncompress_buf_to_fd(input, input_len, outfd, uncompress_err_stdout);
> + if (ret)
> + goto close_outfd;
> +
> + *buf = read_file(dstpath, &size);
> +close_outfd:
> + close(outfd);
> + unlink(dstpath);
> +free_temp:
> + free(dstpath);
> +
> + return ret ?: size;
> +}
> --
> 2.30.2
>
>
>
--
Pengutronix e.K. | |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
More information about the barebox
mailing list