mirror of
https://github.com/AsahiLinux/u-boot
synced 2024-12-12 22:33:18 +00:00
4b9b25d943
Update the zstd implementation to match Linux zstd 1.5.2 from commit 2aa14b1ab2. This was motivated by running into decompression corruption issues when trying to uncompress files compressed with newer versions of zstd. zstd users also claim significantly improved decompression times with newer zstd versions which is a side benefit. Original zstd code was copied from Linux commit 2aa14b1ab2 which is a custom-built implementation based on zstd 1.3.1. Linux switched to an implementation that is a copy of the upstream zstd code in Linux commit e0c1b49f5b, this results in a large code diff. However this should make future updates easier along with other benefits[1]. This commit is a straight mirror of the Linux zstd code, except to: - update a few #include that do not translate cleanly - linux/swab.h -> asm/byteorder.h - linux/limits.h -> linux/kernel.h - linux/module.h -> linux/compat.h - remove assert() from debug.h so it doesn't conflict with u-boot's assert() - strip out the compressor code as was done in the previous u-boot zstd - update existing zstd users to the new Linux zstd API - change the #define for MEM_STATIC to use INLINE_KEYWORD for codesize - add a new KConfig option that sets zstd build options to minify code based on zstd's ZSTD_LIB_MINIFY[2]. These changes were tested by booting a zstd 1.5.2 compressed kernel inside a FIT. And the squashfs changes by loading a file from zstd compressed squashfs with sqfsload. buildman was used to compile test other boards and check for binary bloat, as follows: > $ buildman -b zstd2 --boards dh_imx6,m53menlo,mvebu_espressobin-88f3720,sandbox,sandbox64,stm32mp15_dhcom_basic,stm32mp15_dhcor_basic,turris_mox,turris_omnia -sS > Summary of 6 commits for 9 boards (8 threads, 1 job per thread) > 01: Merge branch '2023-01-10-platform-updates' > arm: w+ m53menlo dh_imx6 > 02: lib: zstd: update to latest Linux zstd 1.5.2 > aarch64: (for 2/2 boards) all -3186.0 rodata +920.0 text -4106.0 > arm: (for 5/5 boards) all +1254.4 rodata +940.0 text +314.4 > sandbox: (for 2/2 boards) all -4452.0 data -16.0 rodata +640.0 text -5076.0 [1]e0c1b49f5b
[2]f302ad8811/lib/libzstd.mk (L31)
Signed-off-by: Brandon Maier <brandon.maier@collins.com> [trini: Set ret to -EINVAL for the error of "failed to detect compressed" to fix warning, drop ZSTD_SRCSIZEHINT_MAX for non-Linux host tool builds] Signed-off-by: Tom Rini <trini@konsulko.com>
158 lines
3.1 KiB
C
158 lines
3.1 KiB
C
// SPDX-License-Identifier: GPL-2.0
|
|
/*
|
|
* Copyright (C) 2020 Bootlin
|
|
*
|
|
* Author: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
|
|
*/
|
|
|
|
#include <errno.h>
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
|
|
#if IS_ENABLED(CONFIG_LZO)
|
|
#include <linux/lzo.h>
|
|
#endif
|
|
|
|
#if IS_ENABLED(CONFIG_ZLIB)
|
|
#include <u-boot/zlib.h>
|
|
#endif
|
|
|
|
#if IS_ENABLED(CONFIG_ZSTD)
|
|
#include <linux/zstd.h>
|
|
#endif
|
|
|
|
#include "sqfs_decompressor.h"
|
|
#include "sqfs_utils.h"
|
|
|
|
int sqfs_decompressor_init(struct squashfs_ctxt *ctxt)
|
|
{
|
|
u16 comp_type = get_unaligned_le16(&ctxt->sblk->compression);
|
|
|
|
switch (comp_type) {
|
|
#if IS_ENABLED(CONFIG_LZO)
|
|
case SQFS_COMP_LZO:
|
|
break;
|
|
#endif
|
|
#if IS_ENABLED(CONFIG_ZLIB)
|
|
case SQFS_COMP_ZLIB:
|
|
break;
|
|
#endif
|
|
#if IS_ENABLED(CONFIG_ZSTD)
|
|
case SQFS_COMP_ZSTD:
|
|
ctxt->zstd_workspace = malloc(zstd_dctx_workspace_bound());
|
|
if (!ctxt->zstd_workspace)
|
|
return -ENOMEM;
|
|
break;
|
|
#endif
|
|
default:
|
|
printf("Error: unknown compression type.\n");
|
|
return -EINVAL;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
void sqfs_decompressor_cleanup(struct squashfs_ctxt *ctxt)
|
|
{
|
|
u16 comp_type = get_unaligned_le16(&ctxt->sblk->compression);
|
|
|
|
switch (comp_type) {
|
|
#if IS_ENABLED(CONFIG_LZO)
|
|
case SQFS_COMP_LZO:
|
|
break;
|
|
#endif
|
|
#if IS_ENABLED(CONFIG_ZLIB)
|
|
case SQFS_COMP_ZLIB:
|
|
break;
|
|
#endif
|
|
#if IS_ENABLED(CONFIG_ZSTD)
|
|
case SQFS_COMP_ZSTD:
|
|
free(ctxt->zstd_workspace);
|
|
break;
|
|
#endif
|
|
}
|
|
}
|
|
|
|
#if IS_ENABLED(CONFIG_ZLIB)
|
|
static void zlib_decompression_status(int ret)
|
|
{
|
|
switch (ret) {
|
|
case Z_BUF_ERROR:
|
|
printf("Error: 'dest' buffer is not large enough.\n");
|
|
break;
|
|
case Z_DATA_ERROR:
|
|
printf("Error: corrupted compressed data.\n");
|
|
break;
|
|
case Z_MEM_ERROR:
|
|
printf("Error: insufficient memory.\n");
|
|
break;
|
|
}
|
|
}
|
|
#endif
|
|
|
|
#if IS_ENABLED(CONFIG_ZSTD)
|
|
static int sqfs_zstd_decompress(struct squashfs_ctxt *ctxt, void *dest,
|
|
unsigned long dest_len, void *source, u32 src_len)
|
|
{
|
|
ZSTD_DCtx *ctx;
|
|
size_t wsize;
|
|
int ret;
|
|
|
|
wsize = zstd_dctx_workspace_bound();
|
|
|
|
ctx = zstd_init_dctx(ctxt->zstd_workspace, wsize);
|
|
if (!ctx)
|
|
return -EINVAL;
|
|
ret = zstd_decompress_dctx(ctx, dest, dest_len, source, src_len);
|
|
|
|
return zstd_is_error(ret);
|
|
}
|
|
#endif /* CONFIG_ZSTD */
|
|
|
|
int sqfs_decompress(struct squashfs_ctxt *ctxt, void *dest,
|
|
unsigned long *dest_len, void *source, u32 src_len)
|
|
{
|
|
u16 comp_type = get_unaligned_le16(&ctxt->sblk->compression);
|
|
int ret = 0;
|
|
|
|
switch (comp_type) {
|
|
#if IS_ENABLED(CONFIG_LZO)
|
|
case SQFS_COMP_LZO: {
|
|
size_t lzo_dest_len = *dest_len;
|
|
ret = lzo1x_decompress_safe(source, src_len, dest, &lzo_dest_len);
|
|
if (ret) {
|
|
printf("LZO decompression failed. Error code: %d\n", ret);
|
|
return -EINVAL;
|
|
}
|
|
|
|
break;
|
|
}
|
|
#endif
|
|
#if IS_ENABLED(CONFIG_ZLIB)
|
|
case SQFS_COMP_ZLIB:
|
|
ret = uncompress(dest, dest_len, source, src_len);
|
|
if (ret) {
|
|
zlib_decompression_status(ret);
|
|
return -EINVAL;
|
|
}
|
|
|
|
break;
|
|
#endif
|
|
#if IS_ENABLED(CONFIG_ZSTD)
|
|
case SQFS_COMP_ZSTD:
|
|
ret = sqfs_zstd_decompress(ctxt, dest, *dest_len, source, src_len);
|
|
if (ret) {
|
|
printf("ZSTD Error code: %d\n", zstd_get_error_code(ret));
|
|
return -EINVAL;
|
|
}
|
|
|
|
break;
|
|
#endif
|
|
default:
|
|
printf("Error: unknown compression type.\n");
|
|
return -EINVAL;
|
|
}
|
|
|
|
return ret;
|
|
}
|