The zstd decompression code, as it is right now, will have internal
values overflow on 32-bit systems when the output size is LONG_MAX.
Until someone smarter than me can figure out how to fix the zstd code
properly, limit the destination buffer size to 512 MiB, which should be
enough for everybody, in order to make it usable on 32-bit systems.
Signed-off-by: Paul Cercueil <[email protected]>
---
lib/decompress_unzstd.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/lib/decompress_unzstd.c b/lib/decompress_unzstd.c
index 0ad2c15479ed..e1c03b1eaa6e 100644
--- a/lib/decompress_unzstd.c
+++ b/lib/decompress_unzstd.c
@@ -77,6 +77,7 @@
#include <linux/decompress/mm.h>
#include <linux/kernel.h>
+#include <linux/sizes.h>
#include <linux/zstd.h>
/* 128MB is the maximum window size supported by zstd. */
@@ -179,7 +180,7 @@ static int INIT __unzstd(unsigned char *in_buf, long in_len,
size_t ret;
if (out_len == 0)
- out_len = LONG_MAX; /* no limit */
+ out_len = SZ_512M; /* should be big enough, right? */
if (fill == NULL && flush == NULL)
/*
--
2.28.0
Add support for self-extracting kernels with a ZSTD compression.
Tested on a kernel for the GCW-Zero, it allows to reduce the size of the
kernel file from 4.1 MiB with gzip to 3.5 MiB with ZSTD, and boots just
as fast.
Signed-off-by: Paul Cercueil <[email protected]>
---
arch/mips/Kconfig | 1 +
arch/mips/boot/compressed/Makefile | 1 +
arch/mips/boot/compressed/decompress.c | 4 ++++
arch/mips/boot/compressed/string.c | 16 ++++++++++++++++
4 files changed, 22 insertions(+)
diff --git a/arch/mips/Kconfig b/arch/mips/Kconfig
index c95fa3a2484c..b9d7c4249dc9 100644
--- a/arch/mips/Kconfig
+++ b/arch/mips/Kconfig
@@ -1890,6 +1890,7 @@ config SYS_SUPPORTS_ZBOOT
select HAVE_KERNEL_LZMA
select HAVE_KERNEL_LZO
select HAVE_KERNEL_XZ
+ select HAVE_KERNEL_ZSTD
config SYS_SUPPORTS_ZBOOT_UART16550
bool
diff --git a/arch/mips/boot/compressed/Makefile b/arch/mips/boot/compressed/Makefile
index 6e56caef69f0..86ddc6fc16f4 100644
--- a/arch/mips/boot/compressed/Makefile
+++ b/arch/mips/boot/compressed/Makefile
@@ -70,6 +70,7 @@ tool_$(CONFIG_KERNEL_LZ4) = lz4
tool_$(CONFIG_KERNEL_LZMA) = lzma
tool_$(CONFIG_KERNEL_LZO) = lzo
tool_$(CONFIG_KERNEL_XZ) = xzkern
+tool_$(CONFIG_KERNEL_ZSTD) = zstd
targets += vmlinux.bin.z
$(obj)/vmlinux.bin.z: $(obj)/vmlinux.bin FORCE
diff --git a/arch/mips/boot/compressed/decompress.c b/arch/mips/boot/compressed/decompress.c
index 88f5d637b1c4..c61c641674e6 100644
--- a/arch/mips/boot/compressed/decompress.c
+++ b/arch/mips/boot/compressed/decompress.c
@@ -72,6 +72,10 @@ void error(char *x)
#include "../../../../lib/decompress_unxz.c"
#endif
+#ifdef CONFIG_KERNEL_ZSTD
+#include "../../../../lib/decompress_unzstd.c"
+#endif
+
const unsigned long __stack_chk_guard = 0x000a0dff;
void __stack_chk_fail(void)
diff --git a/arch/mips/boot/compressed/string.c b/arch/mips/boot/compressed/string.c
index 43beecc3587c..ab95722ec0c9 100644
--- a/arch/mips/boot/compressed/string.c
+++ b/arch/mips/boot/compressed/string.c
@@ -27,3 +27,19 @@ void *memset(void *s, int c, size_t n)
ss[i] = c;
return s;
}
+
+void *memmove(void *dest, const void *src, size_t n)
+{
+ unsigned int i;
+ const char *s = src;
+ char *d = dest;
+
+ if ((uintptr_t)dest < (uintptr_t)src) {
+ for (i = 0; i < n; i++)
+ d[i] = s[i];
+ } else {
+ for (i = n; i > 0; i--)
+ d[i - 1] = s[i - 1];
+ }
+ return dest;
+}
--
2.28.0
> On Aug 21, 2020, at 9:29 AM, Paul Cercueil <[email protected]> wrote:
>
> Add support for self-extracting kernels with a ZSTD compression.
>
> Tested on a kernel for the GCW-Zero, it allows to reduce the size of the
> kernel file from 4.1 MiB with gzip to 3.5 MiB with ZSTD, and boots just
> as fast.
>
> Signed-off-by: Paul Cercueil <[email protected]>
> ---
> arch/mips/Kconfig | 1 +
> arch/mips/boot/compressed/Makefile | 1 +
> arch/mips/boot/compressed/decompress.c | 4 ++++
> arch/mips/boot/compressed/string.c | 16 ++++++++++++++++
> 4 files changed, 22 insertions(+)
>
> diff --git a/arch/mips/Kconfig b/arch/mips/Kconfig
> index c95fa3a2484c..b9d7c4249dc9 100644
> --- a/arch/mips/Kconfig
> +++ b/arch/mips/Kconfig
> @@ -1890,6 +1890,7 @@ config SYS_SUPPORTS_ZBOOT
> select HAVE_KERNEL_LZMA
> select HAVE_KERNEL_LZO
> select HAVE_KERNEL_XZ
> + select HAVE_KERNEL_ZSTD
>
> config SYS_SUPPORTS_ZBOOT_UART16550
> bool
> diff --git a/arch/mips/boot/compressed/Makefile b/arch/mips/boot/compressed/Makefile
> index 6e56caef69f0..86ddc6fc16f4 100644
> --- a/arch/mips/boot/compressed/Makefile
> +++ b/arch/mips/boot/compressed/Makefile
> @@ -70,6 +70,7 @@ tool_$(CONFIG_KERNEL_LZ4) = lz4
> tool_$(CONFIG_KERNEL_LZMA) = lzma
> tool_$(CONFIG_KERNEL_LZO) = lzo
> tool_$(CONFIG_KERNEL_XZ) = xzkern
> +tool_$(CONFIG_KERNEL_ZSTD) = zstd
You can use zstd22 here. It will give you slightly better compression
without any additional memory usage. Also, you should add
-D__DISABLE_EXPORTS to the KBUILD_CFLAGS like x86 does [1].
[1] https://github.com/torvalds/linux/blob/master/arch/x86/boot/compressed/Makefile
-Nick
> targets += vmlinux.bin.z
> $(obj)/vmlinux.bin.z: $(obj)/vmlinux.bin FORCE
> diff --git a/arch/mips/boot/compressed/decompress.c b/arch/mips/boot/compressed/decompress.c
> index 88f5d637b1c4..c61c641674e6 100644
> --- a/arch/mips/boot/compressed/decompress.c
> +++ b/arch/mips/boot/compressed/decompress.c
> @@ -72,6 +72,10 @@ void error(char *x)
> #include "../../../../lib/decompress_unxz.c"
> #endif
>
> +#ifdef CONFIG_KERNEL_ZSTD
> +#include "../../../../lib/decompress_unzstd.c"
> +#endif
> +
> const unsigned long __stack_chk_guard = 0x000a0dff;
>
> void __stack_chk_fail(void)
> diff --git a/arch/mips/boot/compressed/string.c b/arch/mips/boot/compressed/string.c
> index 43beecc3587c..ab95722ec0c9 100644
> --- a/arch/mips/boot/compressed/string.c
> +++ b/arch/mips/boot/compressed/string.c
> @@ -27,3 +27,19 @@ void *memset(void *s, int c, size_t n)
> ss[i] = c;
> return s;
> }
> +
> +void *memmove(void *dest, const void *src, size_t n)
> +{
> + unsigned int i;
> + const char *s = src;
> + char *d = dest;
> +
> + if ((uintptr_t)dest < (uintptr_t)src) {
> + for (i = 0; i < n; i++)
> + d[i] = s[i];
> + } else {
> + for (i = n; i > 0; i--)
> + d[i - 1] = s[i - 1];
> + }
> + return dest;
> +}
> --
> 2.28.0
>
> On Aug 21, 2020, at 9:29 AM, Paul Cercueil <[email protected]> wrote:
>
> The zstd decompression code, as it is right now, will have internal
> values overflow on 32-bit systems when the output size is LONG_MAX.
>
> Until someone smarter than me can figure out how to fix the zstd code
> properly, limit the destination buffer size to 512 MiB, which should be
> enough for everybody, in order to make it usable on 32-bit systems.
Can you bump the size up to 2GB? I suspect the problem inside of zstd
is an off-by-one error or something similar, so getting closer to the limit
shouldn't be a problem. I’d feel more comfortable with 2GB, since
kernels can get pretty large.
Hmm, zstd shouldn’t be overflowing that value. I’m currently preparing
a patch to updating the version of zstd in the kernel, and using upstream
directly. I will add a test upstream in 32-bit mode to ensure that we don’t
overflow a 32-bit size_t, so this will be fixed after the update.
-Nick
> Signed-off-by: Paul Cercueil <[email protected]>
> ---
> lib/decompress_unzstd.c | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/lib/decompress_unzstd.c b/lib/decompress_unzstd.c
> index 0ad2c15479ed..e1c03b1eaa6e 100644
> --- a/lib/decompress_unzstd.c
> +++ b/lib/decompress_unzstd.c
> @@ -77,6 +77,7 @@
>
> #include <linux/decompress/mm.h>
> #include <linux/kernel.h>
> +#include <linux/sizes.h>
> #include <linux/zstd.h>
>
> /* 128MB is the maximum window size supported by zstd. */
> @@ -179,7 +180,7 @@ static int INIT __unzstd(unsigned char *in_buf, long in_len,
> size_t ret;
>
> if (out_len == 0)
> - out_len = LONG_MAX; /* no limit */
> + out_len = SZ_512M; /* should be big enough, right? */
>
> if (fill == NULL && flush == NULL)
> /*
> --
> 2.28.0
>
Hi Nick,
Le lun. 24 ao?t 2020 ? 19:51, Nick Terrell <[email protected]> a ?crit
:
>
>
>> On Aug 21, 2020, at 9:29 AM, Paul Cercueil <[email protected]>
>> wrote:
>>
>> Add support for self-extracting kernels with a ZSTD compression.
>>
>> Tested on a kernel for the GCW-Zero, it allows to reduce the size
>> of the
>> kernel file from 4.1 MiB with gzip to 3.5 MiB with ZSTD, and boots
>> just
>> as fast.
>>
>> Signed-off-by: Paul Cercueil <[email protected]>
>> ---
>> arch/mips/Kconfig | 1 +
>> arch/mips/boot/compressed/Makefile | 1 +
>> arch/mips/boot/compressed/decompress.c | 4 ++++
>> arch/mips/boot/compressed/string.c | 16 ++++++++++++++++
>> 4 files changed, 22 insertions(+)
>>
>> diff --git a/arch/mips/Kconfig b/arch/mips/Kconfig
>> index c95fa3a2484c..b9d7c4249dc9 100644
>> --- a/arch/mips/Kconfig
>> +++ b/arch/mips/Kconfig
>> @@ -1890,6 +1890,7 @@ config SYS_SUPPORTS_ZBOOT
>> select HAVE_KERNEL_LZMA
>> select HAVE_KERNEL_LZO
>> select HAVE_KERNEL_XZ
>> + select HAVE_KERNEL_ZSTD
>>
>> config SYS_SUPPORTS_ZBOOT_UART16550
>> bool
>> diff --git a/arch/mips/boot/compressed/Makefile
>> b/arch/mips/boot/compressed/Makefile
>> index 6e56caef69f0..86ddc6fc16f4 100644
>> --- a/arch/mips/boot/compressed/Makefile
>> +++ b/arch/mips/boot/compressed/Makefile
>> @@ -70,6 +70,7 @@ tool_$(CONFIG_KERNEL_LZ4) = lz4
>> tool_$(CONFIG_KERNEL_LZMA) = lzma
>> tool_$(CONFIG_KERNEL_LZO) = lzo
>> tool_$(CONFIG_KERNEL_XZ) = xzkern
>> +tool_$(CONFIG_KERNEL_ZSTD) = zstd
>
> You can use zstd22 here. It will give you slightly better compression
> without any additional memory usage. Also, you should add
> -D__DISABLE_EXPORTS to the KBUILD_CFLAGS like x86 does [1].
Indeed, it's 0.01% smaller :)
What is __DISABLE_EXPORTS for?
-Paul
>
> [1]
> https://github.com/torvalds/linux/blob/master/arch/x86/boot/compressed/Makefile
>
> -Nick
>
>> targets += vmlinux.bin.z
>> $(obj)/vmlinux.bin.z: $(obj)/vmlinux.bin FORCE
>> diff --git a/arch/mips/boot/compressed/decompress.c
>> b/arch/mips/boot/compressed/decompress.c
>> index 88f5d637b1c4..c61c641674e6 100644
>> --- a/arch/mips/boot/compressed/decompress.c
>> +++ b/arch/mips/boot/compressed/decompress.c
>> @@ -72,6 +72,10 @@ void error(char *x)
>> #include "../../../../lib/decompress_unxz.c"
>> #endif
>>
>> +#ifdef CONFIG_KERNEL_ZSTD
>> +#include "../../../../lib/decompress_unzstd.c"
>> +#endif
>> +
>> const unsigned long __stack_chk_guard = 0x000a0dff;
>>
>> void __stack_chk_fail(void)
>> diff --git a/arch/mips/boot/compressed/string.c
>> b/arch/mips/boot/compressed/string.c
>> index 43beecc3587c..ab95722ec0c9 100644
>> --- a/arch/mips/boot/compressed/string.c
>> +++ b/arch/mips/boot/compressed/string.c
>> @@ -27,3 +27,19 @@ void *memset(void *s, int c, size_t n)
>> ss[i] = c;
>> return s;
>> }
>> +
>> +void *memmove(void *dest, const void *src, size_t n)
>> +{
>> + unsigned int i;
>> + const char *s = src;
>> + char *d = dest;
>> +
>> + if ((uintptr_t)dest < (uintptr_t)src) {
>> + for (i = 0; i < n; i++)
>> + d[i] = s[i];
>> + } else {
>> + for (i = n; i > 0; i--)
>> + d[i - 1] = s[i - 1];
>> + }
>> + return dest;
>> +}
>> --
>> 2.28.0
>>
Le lun. 24 août 2020 à 20:11, Nick Terrell <[email protected]> a écrit
:
>
>
>> On Aug 21, 2020, at 9:29 AM, Paul Cercueil <[email protected]>
>> wrote:
>>
>> The zstd decompression code, as it is right now, will have internal
>> values overflow on 32-bit systems when the output size is LONG_MAX.
>>
>> Until someone smarter than me can figure out how to fix the zstd
>> code
>> properly, limit the destination buffer size to 512 MiB, which
>> should be
>> enough for everybody, in order to make it usable on 32-bit systems.
>
> Can you bump the size up to 2GB? I suspect the problem inside of zstd
> is an off-by-one error or something similar, so getting closer to the
> limit
> shouldn't be a problem. I’d feel more comfortable with 2GB, since
> kernels can get pretty large.
SZ_1G is the biggest I can go to get the kernel to boot. With SZ_2G it
won't boot.
> Hmm, zstd shouldn’t be overflowing that value. I’m currently
> preparing
> a patch to updating the version of zstd in the kernel, and using
> upstream
> directly. I will add a test upstream in 32-bit mode to ensure that we
> don’t
> overflow a 32-bit size_t, so this will be fixed after the update.
Great, thanks.
Cheers,
-Paul
>
> -Nick
>
>> Signed-off-by: Paul Cercueil <[email protected]>
>> ---
>> lib/decompress_unzstd.c | 3 ++-
>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/lib/decompress_unzstd.c b/lib/decompress_unzstd.c
>> index 0ad2c15479ed..e1c03b1eaa6e 100644
>> --- a/lib/decompress_unzstd.c
>> +++ b/lib/decompress_unzstd.c
>> @@ -77,6 +77,7 @@
>>
>> #include <linux/decompress/mm.h>
>> #include <linux/kernel.h>
>> +#include <linux/sizes.h>
>> #include <linux/zstd.h>
>>
>> /* 128MB is the maximum window size supported by zstd. */
>> @@ -179,7 +180,7 @@ static int INIT __unzstd(unsigned char *in_buf,
>> long in_len,
>> size_t ret;
>>
>> if (out_len == 0)
>> - out_len = LONG_MAX; /* no limit */
>> + out_len = SZ_512M; /* should be big enough, right? */
>>
>> if (fill == NULL && flush == NULL)
>> /*
>> --
>> 2.28.0
>>
>
> On Aug 24, 2020, at 2:02 PM, Paul Cercueil <[email protected]> wrote:
>
> Hi Nick,
>
> Le lun. 24 août 2020 à 19:51, Nick Terrell <[email protected]> a écrit :
>>> On Aug 21, 2020, at 9:29 AM, Paul Cercueil <[email protected]> wrote:
>>> Add support for self-extracting kernels with a ZSTD compression.
>>> Tested on a kernel for the GCW-Zero, it allows to reduce the size of the
>>> kernel file from 4.1 MiB with gzip to 3.5 MiB with ZSTD, and boots just
>>> as fast.
>>> Signed-off-by: Paul Cercueil <[email protected]>
>>> ---
>>> arch/mips/Kconfig | 1 +
>>> arch/mips/boot/compressed/Makefile | 1 +
>>> arch/mips/boot/compressed/decompress.c | 4 ++++
>>> arch/mips/boot/compressed/string.c | 16 ++++++++++++++++
>>> 4 files changed, 22 insertions(+)
>>> diff --git a/arch/mips/Kconfig b/arch/mips/Kconfig
>>> index c95fa3a2484c..b9d7c4249dc9 100644
>>> --- a/arch/mips/Kconfig
>>> +++ b/arch/mips/Kconfig
>>> @@ -1890,6 +1890,7 @@ config SYS_SUPPORTS_ZBOOT
>>> select HAVE_KERNEL_LZMA
>>> select HAVE_KERNEL_LZO
>>> select HAVE_KERNEL_XZ
>>> + select HAVE_KERNEL_ZSTD
>>> config SYS_SUPPORTS_ZBOOT_UART16550
>>> bool
>>> diff --git a/arch/mips/boot/compressed/Makefile b/arch/mips/boot/compressed/Makefile
>>> index 6e56caef69f0..86ddc6fc16f4 100644
>>> --- a/arch/mips/boot/compressed/Makefile
>>> +++ b/arch/mips/boot/compressed/Makefile
>>> @@ -70,6 +70,7 @@ tool_$(CONFIG_KERNEL_LZ4) = lz4
>>> tool_$(CONFIG_KERNEL_LZMA) = lzma
>>> tool_$(CONFIG_KERNEL_LZO) = lzo
>>> tool_$(CONFIG_KERNEL_XZ) = xzkern
>>> +tool_$(CONFIG_KERNEL_ZSTD) = zstd
>> You can use zstd22 here. It will give you slightly better compression
>> without any additional memory usage. Also, you should add
>> -D__DISABLE_EXPORTS to the KBUILD_CFLAGS like x86 does [1].
>
> Indeed, it's 0.01% smaller :)
>
> What is __DISABLE_EXPORTS for?
It disables the EXPORT_SYMBOL() macros inside of lib/zstd/decompress.c.
On x86 the kernel won’t boot with these defined. Other decompressors hide
them if the STATIC macro is defined, but zstd uses this method, which was
added somewhat recently.
-Nick
> -Paul
>
>> [1] https://github.com/torvalds/linux/blob/master/arch/x86/boot/compressed/Makefile
>> -Nick
>>> targets += vmlinux.bin.z
>>> $(obj)/vmlinux.bin.z: $(obj)/vmlinux.bin FORCE
>>> diff --git a/arch/mips/boot/compressed/decompress.c b/arch/mips/boot/compressed/decompress.c
>>> index 88f5d637b1c4..c61c641674e6 100644
>>> --- a/arch/mips/boot/compressed/decompress.c
>>> +++ b/arch/mips/boot/compressed/decompress.c
>>> @@ -72,6 +72,10 @@ void error(char *x)
>>> #include "../../../../lib/decompress_unxz.c"
>>> #endif
>>> +#ifdef CONFIG_KERNEL_ZSTD
>>> +#include "../../../../lib/decompress_unzstd.c"
>>> +#endif
>>> +
>>> const unsigned long __stack_chk_guard = 0x000a0dff;
>>> void __stack_chk_fail(void)
>>> diff --git a/arch/mips/boot/compressed/string.c b/arch/mips/boot/compressed/string.c
>>> index 43beecc3587c..ab95722ec0c9 100644
>>> --- a/arch/mips/boot/compressed/string.c
>>> +++ b/arch/mips/boot/compressed/string.c
>>> @@ -27,3 +27,19 @@ void *memset(void *s, int c, size_t n)
>>> ss[i] = c;
>>> return s;
>>> }
>>> +
>>> +void *memmove(void *dest, const void *src, size_t n)
>>> +{
>>> + unsigned int i;
>>> + const char *s = src;
>>> + char *d = dest;
>>> +
>>> + if ((uintptr_t)dest < (uintptr_t)src) {
>>> + for (i = 0; i < n; i++)
>>> + d[i] = s[i];
>>> + } else {
>>> + for (i = n; i > 0; i--)
>>> + d[i - 1] = s[i - 1];
>>> + }
>>> + return dest;
>>> +}
>>> --
>>> 2.28.0
> On Aug 24, 2020, at 2:05 PM, Paul Cercueil <[email protected]> wrote:
>
>
>
> Le lun. 24 août 2020 à 20:11, Nick Terrell <[email protected]> a écrit :
>>> On Aug 21, 2020, at 9:29 AM, Paul Cercueil <[email protected]> wrote:
>>> The zstd decompression code, as it is right now, will have internal
>>> values overflow on 32-bit systems when the output size is LONG_MAX.
>>> Until someone smarter than me can figure out how to fix the zstd code
>>> properly, limit the destination buffer size to 512 MiB, which should be
>>> enough for everybody, in order to make it usable on 32-bit systems.
>> Can you bump the size up to 2GB? I suspect the problem inside of zstd
>> is an off-by-one error or something similar, so getting closer to the limit
>> shouldn't be a problem. I’d feel more comfortable with 2GB, since
>> kernels can get pretty large.
>
> SZ_1G is the biggest I can go to get the kernel to boot. With SZ_2G it won't boot.
Strange… I don’t quite know what is going on then. Thanks for the fix! You can add:
Reviewed-By: Nick Terrell <[email protected]>
Best,
Nick
>> Hmm, zstd shouldn’t be overflowing that value. I’m currently preparing
>> a patch to updating the version of zstd in the kernel, and using upstream
>> directly. I will add a test upstream in 32-bit mode to ensure that we don’t
>> overflow a 32-bit size_t, so this will be fixed after the update.
>
> Great, thanks.
>
> Cheers,
> -Paul
>
>> -Nick
>>> Signed-off-by: Paul Cercueil <[email protected]>
>>> ---
>>> lib/decompress_unzstd.c | 3 ++-
>>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>> diff --git a/lib/decompress_unzstd.c b/lib/decompress_unzstd.c
>>> index 0ad2c15479ed..e1c03b1eaa6e 100644
>>> --- a/lib/decompress_unzstd.c
>>> +++ b/lib/decompress_unzstd.c
>>> @@ -77,6 +77,7 @@
>>> #include <linux/decompress/mm.h>
>>> #include <linux/kernel.h>
>>> +#include <linux/sizes.h>
>>> #include <linux/zstd.h>
>>> /* 128MB is the maximum window size supported by zstd. */
>>> @@ -179,7 +180,7 @@ static int INIT __unzstd(unsigned char *in_buf, long in_len,
>>> size_t ret;
>>> if (out_len == 0)
>>> - out_len = LONG_MAX; /* no limit */
>>> + out_len = SZ_512M; /* should be big enough, right? */
>>> if (fill == NULL && flush == NULL)
>>> /*
>>> --
>>> 2.28.0
>
>