Messages in this thread Patch in this message | | | Date | Tue, 15 Dec 2020 11:38:40 +0100 (CET) | Subject | [PATCH v3] zstd compressed firmware loading | From | Rene Rebe <> |
| |
Now with zstd compressed kernel & initrd upstream, we would rather compress everything with one type of compressor, so I added support for zstd compressed firmware loading, too. Renamed FW_LOADER_COMPRESS to FW_LOADER_COMPRESS_XZ to indicate algorithm used.
Tested on x86_64, sparc64 and mips64.
Signed-off-by: René Rebe <rene@exactcode.de>
diff --git a/drivers/base/firmware_loader/Kconfig b/drivers/base/firmware_loader/Kconfig index 5b24f3959255..92e6bec4605a 100644 --- a/drivers/base/firmware_loader/Kconfig +++ b/drivers/base/firmware_loader/Kconfig @@ -155,8 +155,8 @@ config FW_LOADER_USER_HELPER_FALLBACK If you are unsure about this, say N here. -config FW_LOADER_COMPRESS - bool "Enable compressed firmware support" +config FW_LOADER_COMPRESS_XZ + bool "Enable XZ compressed firmware support" select FW_LOADER_PAGED_BUF select XZ_DEC help @@ -169,6 +169,16 @@ config FW_LOADER_COMPRESS be compressed with either none or crc32 integrity check type (pass "-C crc32" option to xz command). +config FW_LOADER_COMPRESS_ZSTD + bool "Enable Zstd compressed firmware support" + select FW_LOADER_PAGED_BUF + select ZSTD_DECOMPRESS + help + This option enables the support for loading Zstd compressed firmware + files. The caller of firmware API receives the decompressed file + content. The compressed file is loaded as a fallback, only after + loading the raw file failed at first. + config FW_CACHE bool "Enable firmware caching during suspend" depends on PM_SLEEP diff --git a/drivers/base/firmware_loader/main.c b/drivers/base/firmware_loader/main.c index 78355095e00d..0b1ea5e0708d 100644 --- a/drivers/base/firmware_loader/main.c +++ b/drivers/base/firmware_loader/main.c @@ -34,7 +34,9 @@ #include <linux/syscore_ops.h> #include <linux/reboot.h> #include <linux/security.h> +#include <linux/decompress/mm.h> #include <linux/xz.h> +#include <linux/zstd.h> #include <generated/utsrelease.h> @@ -365,7 +367,7 @@ int fw_map_paged_buf(struct fw_priv *fw_priv) /* * XZ-compressed firmware support */ -#ifdef CONFIG_FW_LOADER_COMPRESS +#ifdef CONFIG_FW_LOADER_COMPRESS_XZ /* show an error and return the standard error code */ static int fw_decompress_xz_error(struct device *dev, enum xz_ret xz_ret) { @@ -459,7 +461,186 @@ static int fw_decompress_xz(struct device *dev, struct fw_priv *fw_priv, else return fw_decompress_xz_pages(dev, fw_priv, in_size, in_buffer); } -#endif /* CONFIG_FW_LOADER_COMPRESS */ +#endif /* CONFIG_FW_LOADER_COMPRESS_XZ */ + +/* + * Zstd-compressed firmware support + */ +#ifdef CONFIG_FW_LOADER_COMPRESS_ZSTD +/* show an error and return the standard error code */ +static int handle_zstd_error(size_t ret) +{ + const int err = ZSTD_getErrorCode(ret); + + if (!ZSTD_isError(ret)) + return 0; + + switch (err) { + case ZSTD_error_memory_allocation: + printk("ZSTD decompressor ran out of memory"); + break; + case ZSTD_error_prefix_unknown: + printk("Input is not in the ZSTD format (wrong magic bytes)"); + break; + case ZSTD_error_dstSize_tooSmall: + case ZSTD_error_corruption_detected: + case ZSTD_error_checksum_wrong: + printk("ZSTD-compressed data is corrupt"); + break; + default: + printk("ZSTD-compressed data is probably corrupt"); + break; + } + return -1; +} + +/* single-shot decompression onto the pre-allocated buffer */ +static int fw_decompress_zstd_single(struct device *dev, struct fw_priv *fw_priv, + size_t in_size, const void *in_buffer) +{ + const size_t wksp_size = ZSTD_DCtxWorkspaceBound(); + void *wksp = large_malloc(wksp_size); + ZSTD_DCtx *dctx = ZSTD_initDCtx(wksp, wksp_size); + int err; + size_t ret; + + if (dctx == NULL) { + dev_warn(dev, "Out of memory while allocating ZSTD_DCtx"); + err = -1; + goto out; + } + /* Find out how large the frame actually is, there may be junk at + * the end of the frame that ZSTD_decompressDCtx() can't handle. + */ + ret = ZSTD_findFrameCompressedSize(in_buffer, in_size); + err = handle_zstd_error(ret); + if (err) + goto out; + in_size = (long)ret; + + ret = ZSTD_decompressDCtx(dctx, fw_priv->data, fw_priv->allocated_size, in_buffer, in_size); + err = handle_zstd_error(ret); + if (err) + goto out; + + fw_priv->size = ret; + +out: + if (wksp != NULL) + large_free(wksp); + return err; +} + +/* decompression on paged buffer and map it */ +static int fw_decompress_zstd_pages(struct device *dev, struct fw_priv *fw_priv, + size_t in_size, const void *in_buffer) +{ + ZSTD_inBuffer in; + ZSTD_outBuffer out; + ZSTD_frameParams params; + void *wksp = NULL; + size_t wksp_size; + ZSTD_DStream *dstream; + int err = 0; + size_t ret; + + struct page *page; + + fw_priv->is_paged_buf = true; + fw_priv->size = 0; + + /* Set the first non-empty input buffer. */ + in.src = in_buffer; + in.pos = 0; + in.size = in_size; + + /* + * We need to know the window size to allocate the ZSTD_DStream. + * Since we are streaming, we need to allocate a buffer for the sliding + * window. The window size varies from 1 KB to ZSTD_WINDOWSIZE_MAX + * (8 MB), so it is important to use the actual value so as not to + * waste memory when it is smaller. + */ + ret = ZSTD_getFrameParams(¶ms, in.src, in.size); + err = handle_zstd_error(ret); + if (err) + goto out; + if (ret != 0) { + printk("ZSTD-compressed data has an incomplete frame header"); + err = -1; + goto out; + } + if (params.windowSize > (1 << ZSTD_WINDOWLOG_MAX)) { + printk("ZSTD-compressed data has too large a window size"); + err = -1; + goto out; + } + + /* + * Allocate the ZSTD_DStream now that we know how much memory is + * required. + */ + wksp_size = ZSTD_DStreamWorkspaceBound(params.windowSize); + wksp = large_malloc(wksp_size); + dstream = ZSTD_initDStream(params.windowSize, wksp, wksp_size); + if (dstream == NULL) { + printk("Out of memory while allocating ZSTD_DStream"); + err = -1; + goto out; + } + + /* + * Decompression loop: + * Read more data if necessary (error if no more data can be read). + * Call the decompression function, which returns 0 when finished. + * Flush any data produced if using flush(). + */ + do { + /* If we need to reload data the input is truncated. */ + if (in.pos == in.size) { + printk("ZSTD-compressed data is truncated"); + err = -1; + goto out; + } + + /* Allocate the output buffer */ + if (fw_grow_paged_buf(fw_priv, fw_priv->nr_pages + 1)) { + err = -ENOMEM; + goto out; + } + + /* Decompress into the newly allocated page */ + page = fw_priv->pages[fw_priv->nr_pages - 1]; + out.dst = kmap(page); + out.pos = 0; + out.size = PAGE_SIZE; + + /* Returns zero when the frame is complete. */ + ret = ZSTD_decompressStream(dstream, &out, &in); + kunmap(page); + err = handle_zstd_error(ret); + if (err) + goto out; + fw_priv->size += out.pos; + } while (ret != 0); + + err = fw_map_paged_buf(fw_priv); +out: + if (wksp != NULL) + large_free(wksp); + return err; +} + +static int fw_decompress_zstd(struct device *dev, struct fw_priv *fw_priv, + size_t in_size, const void *in_buffer) +{ + /* if the buffer is pre-allocated, we can perform in single-shot mode */ + if (fw_priv->data) + return fw_decompress_zstd_single(dev, fw_priv, in_size, in_buffer); + else + return fw_decompress_zstd_pages(dev, fw_priv, in_size, in_buffer); +} +#endif /* CONFIG_FW_LOADER_COMPRESS_ZSTD */ /* direct firmware loading support */ static char fw_path_para[256]; @@ -814,10 +995,15 @@ _request_firmware(const struct firmware **firmware_p, const char *name, if (!(opt_flags & FW_OPT_PARTIAL)) nondirect = true; -#ifdef CONFIG_FW_LOADER_COMPRESS +#ifdef CONFIG_FW_LOADER_COMPRESS_XZ if (ret == -ENOENT && nondirect) ret = fw_get_filesystem_firmware(device, fw->priv, ".xz", fw_decompress_xz); +#endif +#ifdef CONFIG_FW_LOADER_COMPRESS_ZSTD + if (ret == -ENOENT && nondirect) + ret = fw_get_filesystem_firmware(device, fw->priv, ".zst", + fw_decompress_zstd); #endif if (ret == -ENOENT && nondirect) ret = firmware_fallback_platform(fw->priv); diff --git a/tools/testing/selftests/firmware/fw_lib.sh b/tools/testing/selftests/firmware/fw_lib.sh index 5b8c0fedee76..0eafd6bd0aba 100755 --- a/tools/testing/selftests/firmware/fw_lib.sh +++ b/tools/testing/selftests/firmware/fw_lib.sh @@ -62,7 +62,7 @@ check_setup() { HAS_FW_LOADER_USER_HELPER="$(kconfig_has CONFIG_FW_LOADER_USER_HELPER=y)" HAS_FW_LOADER_USER_HELPER_FALLBACK="$(kconfig_has CONFIG_FW_LOADER_USER_HELPER_FALLBACK=y)" - HAS_FW_LOADER_COMPRESS="$(kconfig_has CONFIG_FW_LOADER_COMPRESS=y)" + HAS_FW_LOADER_COMPRESS_XZ="$(kconfig_has CONFIG_FW_LOADER_COMPRESS_XZ=y)" PROC_FW_IGNORE_SYSFS_FALLBACK="0" PROC_FW_FORCE_SYSFS_FALLBACK="0" @@ -98,9 +98,9 @@ check_setup() OLD_FWPATH="$(cat /sys/module/firmware_class/parameters/path)" - if [ "$HAS_FW_LOADER_COMPRESS" = "yes" ]; then + if [ "$HAS_FW_LOADER_COMPRESS_XZ" = "yes" ]; then if ! which xz 2> /dev/null > /dev/null; then - HAS_FW_LOADER_COMPRESS="" + HAS_FW_LOADER_COMPRESS_XZ="" fi fi } -- René Rebe, ExactCODE GmbH, Lietzenburger Str. 42, DE-10789 Berlin https://exactcode.com | https://t2sde.org | https://rene.rebe.de
| |