Skip to content

Commit

Permalink
lib: zstd: update to latest Linux zstd 1.5.2
Browse files Browse the repository at this point in the history
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] torvalds/linux@e0c1b49
[2] https://github.com/facebook/zstd/blob/f302ad8811643c428c4e3498e28f53a0578020d3/lib/libzstd.mk#L31

Signed-off-by: Brandon Maier <[email protected]>
[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 <[email protected]>
  • Loading branch information
blmaier authored and trini committed Jan 19, 2023
1 parent e875cab commit 4b9b25d
Show file tree
Hide file tree
Showing 45 changed files with 13,639 additions and 7,548 deletions.
15 changes: 9 additions & 6 deletions fs/squashfs/sqfs_decompressor.c
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ int sqfs_decompressor_init(struct squashfs_ctxt *ctxt)
#endif
#if IS_ENABLED(CONFIG_ZSTD)
case SQFS_COMP_ZSTD:
ctxt->zstd_workspace = malloc(ZSTD_DCtxWorkspaceBound());
ctxt->zstd_workspace = malloc(zstd_dctx_workspace_bound());
if (!ctxt->zstd_workspace)
return -ENOMEM;
break;
Expand Down Expand Up @@ -99,11 +99,14 @@ static int sqfs_zstd_decompress(struct squashfs_ctxt *ctxt, void *dest,
size_t wsize;
int ret;

wsize = ZSTD_DCtxWorkspaceBound();
ctx = ZSTD_initDCtx(ctxt->zstd_workspace, wsize);
ret = ZSTD_decompressDCtx(ctx, dest, dest_len, source, src_len);
wsize = zstd_dctx_workspace_bound();

return ZSTD_isError(ret);
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 */

Expand Down Expand Up @@ -140,7 +143,7 @@ int sqfs_decompress(struct squashfs_ctxt *ctxt, void *dest,
case SQFS_COMP_ZSTD:
ret = sqfs_zstd_decompress(ctxt, dest, *dest_len, source, src_len);
if (ret) {
printf("ZSTD Error code: %d\n", ZSTD_getErrorCode(ret));
printf("ZSTD Error code: %d\n", zstd_get_error_code(ret));
return -EINVAL;
}

Expand Down
Loading

0 comments on commit 4b9b25d

Please sign in to comment.