initramfs: kunit tests and cleanups
Subsystems (4)
v2 cover initramfs: kunit tests and cleanups
This patchset adds basic kunit test coverage for initramfs unpacking and cleans up some minor buffer handling issues / inefficiencies.
Changes since v1 (RFC):
- rebase atop v6.12-rc6 and filename field overrun fix from
https://lore.kernel.org/r/[email protected]
- add unit test coverage (new patches 1 and 2)
- add patch: fix hardlink hash leak without TRAILER
- rework patch: avoid static buffer for error message
+ drop unnecessary message propagation
- drop patch: cpio_buf reuse for built-in and bootloader initramfs
+ no good justification for the change
Feedback appreciated.
David Disseldorp (9):
init: add initramfs_internal.h
initramfs_test: kunit tests for initramfs unpacking
vsprintf: add simple_strntoul
initramfs: avoid memcpy for hex header fields
initramfs: remove extra symlink path buffer
initramfs: merge header_buf and name_buf
initramfs: reuse name_len for dir mtime tracking
initramfs: fix hardlink hash leak without TRAILER
initramfs: avoid static buffer for error message
include/linux/kstrtox.h | 1 + init/.kunitconfig | 3 + init/Kconfig | 7 + init/Makefile | 1 + init/initramfs.c | 73 +++++---- init/initramfs_internal.h | 8 + init/initramfs_test.c | 387 ++++++++++++++++++++++++++++++++++++++++++++++ lib/vsprintf.c | 7 + 8 files changed, 455 insertions(+), 32 deletions(-) create mode 100644 init/.kunitconfig create mode 100644 init/initramfs_internal.h create mode 100644 init/initramfs_test.c
PATCH v2 1/9 init: add initramfs_internal.h
The new header only exports a single unpack function and a CPIO_HDRLEN constant for future test use.
--- init/initramfs.c | 16 +++++++++++++--- init/initramfs_internal.h | 8 ++++++++ 2 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 init/initramfs_internal.h
init/initramfs.c +13 -3
@@ -20,6 +20,7 @@#include <linux/security.h> #include "do_mounts.h" +#include "initramfs_internal.h" static __initdata bool csum_present;static __initdata u32 io_csum;
@@ -256,7 +257,7 @@ static __initdata char *header_buf, *symlink_buf, *name_buf;static int __init do_start (void ) { -read_into (header_buf,110 , GotHeader); +read_into (header_buf,CPIO_HDRLEN , GotHeader);return 0 ; }
@@ -497,14 +498,23 @@ static unsigned long my_inptr __initdata; /* index of next byte to be processed#include <linux/decompress/generic.h> -static char *__init unpack_to_rootfs (char *buf,unsigned long len) +/** +* unpack_to_rootfs - decompress and extract an initramfs archive +* @buf: input initramfs archive to extract +* @len: length of initramfs data to process +* +* Returns: NULL for success or an error message string +* +* This symbol shouldn't be used externally. It's available for unit tests. +*/ +char *__init unpack_to_rootfs (char *buf,unsigned long len) {long written;decompress_fn decompress;const char *compress_name;static __initdata char msg_buf[64 ]; - header_buf =kmalloc (110 ,GFP_KERNEL ); + header_buf =kmalloc (CPIO_HDRLEN ,GFP_KERNEL ); symlink_buf =kmalloc (PATH_MAX +N_ALIGN (PATH_MAX ) +1 ,GFP_KERNEL ); name_buf =kmalloc (N_ALIGN (PATH_MAX ),GFP_KERNEL );
init/initramfs_internal.h new file +8 -0
@@ -0,0 +1,8 @@ +// SPDX-License-Identifier: GPL-2.0 +#ifndef __INITRAMFS_INTERNAL_H__ +#define __INITRAMFS_INTERNAL_H__ + +char *unpack_to_rootfs (char *buf,unsigned long len); +#define CPIO_HDRLEN 110 + +#endif
Signature · 1 line
2.43.0
PATCH v2 2/9 initramfs_test: kunit tests for initramfs unpacking
In reply to David DisseldorpProvide some basic initramfs unpack sanity tests covering:
- simple file / dir extraction
- filename field overrun, as reported and fixed separately via
https://lore.kernel.org/r/[email protected]
- "070702" cpio data checksums
- hardlinks
--- init/.kunitconfig | 3 + init/Kconfig | 7 + init/Makefile | 1 + init/initramfs_test.c | 393 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 404 insertions(+) create mode 100644 init/.kunitconfig create mode 100644 init/initramfs_test.c
init/.kunitconfig new file +3 -0
@@ -0,0 +1,3 @@ +CONFIG_KUNIT=y +CONFIG_BLK_DEV_INITRD=y +CONFIG_INITRAMFS_TEST=y
init/Kconfig +7 -0
@@ -1431,6 +1431,13 @@ config INITRAMFS_PRESERVE_MTIME If unsure, say Y. +config INITRAMFS_TEST + bool "Test initramfs cpio archive extraction" if !KUNIT_ALL_TESTS + depends on BLK_DEV_INITRD && KUNIT=y + default KUNIT_ALL_TESTS + help + Build KUnit tests for initramfs. See Documentation/dev-tools/kunit + choice prompt "Compiler optimization level" default CC_OPTIMIZE_FOR_PERFORMANCE
init/Makefile +1 -0
@@ -12,6 +12,7 @@ else obj-$(CONFIG_BLK_DEV_INITRD) += initramfs.o endif obj-$(CONFIG_GENERIC_CALIBRATE_DELAY) += calibrate.o +obj-$(CONFIG_INITRAMFS_TEST) += initramfs_test.o obj-y += init_task.o
init/initramfs_test.c new file +393 -0
393 lines not on this page · raw message
Signature · 1 line
2.43.0
kernel test robot
build botRe: [PATCH v2 2/9] initramfs_test: kunit tests for initramfs unpacking
kernel test robot noticed the following build errors:
Hi David,
kernel test robot noticed the following build errors:
[auto build test ERROR on akpm-mm/mm-nonmm-unstable]
[also build test ERROR on brauner-vfs/vfs.all linus/master v6.12-rc6 next-20241105] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/David-Disseldorp/init-add-initramfs_internal-h/20241104-223438 base: https://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git mm-nonmm-unstable patch link: https://lore.kernel.org/r/20241104141750.16119-3-ddiss%40suse.de patch subject: [PATCH v2 2/9] initramfs_test: kunit tests for initramfs unpacking config: arm-randconfig-004-20241105 (https://download.01.org/0day-ci/archive/20241105/[email protected]/config) compiler: clang version 16.0.6 (https://github.com/llvm/llvm-project 7cbf1a2591520c2491aa35339f227775f4d3adf6) reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20241105/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All errors (new ones prefixed by >>):
>> init/initramfs_test.c:210:9: error: call to undeclared function 'filp_open'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
file = filp_open(c[0].fname, O_RDONLY, 0);
^
>> init/initramfs_test.c:210:31: error: use of undeclared identifier 'O_RDONLY'
file = filp_open(c[0].fname, O_RDONLY, 0);
^
>> init/initramfs_test.c:217:8: error: call to undeclared function 'kernel_read'; ISO C99 and later do not support implicit function declarations [-Wimplicit-function-declaration]
len = kernel_read(file, cpio_srcbuf, c[0].filesize, NULL);
^
init/initramfs_test.c:217:8: note: did you mean 'kref_read'?
include/linux/kref.h:34:28: note: 'kref_read' declared here
static inline unsigned int kref_read(const struct kref *kref)
^3 errors generated.
vim +/filp_open +210 init/initramfs_test.c
176
177 static void __init initramfs_test_data(struct kunit *test)
178 {
179 char *err, *cpio_srcbuf;
180 size_t len;
181 struct file *file;
182 struct initramfs_test_cpio c[] = { {
183 .magic = "070701",
184 .ino = 1,
185 .mode = S_IFREG | 0777,
186 .uid = 0,
187 .gid = 0,
188 .nlink = 1,
189 .mtime = 1,
190 .filesize = sizeof("ASDF") - 1,
191 .devmajor = 0,
192 .devminor = 1,
193 .rdevmajor = 0,
194 .rdevminor = 0,
195 .namesize = sizeof("initramfs_test_data"),
196 .csum = 0,
197 .fname = "initramfs_test_data",
198 .data = "ASDF",
199 } };
200
201 /* +6 for max name and data 4-byte padding */
202 cpio_srcbuf = kmalloc(CPIO_HDRLEN + c[0].namesize + c[0].filesize + 6,
203 GFP_KERNEL);
204
205 len = fill_cpio(c, ARRAY_SIZE(c), cpio_srcbuf);
206
207 err = unpack_to_rootfs(cpio_srcbuf, len);
208 KUNIT_EXPECT_NULL(test, err);
209
> 210 file = filp_open(c[0].fname, O_RDONLY, 0);
211 if (!file) {
212 KUNIT_FAIL(test, "open failed");
213 goto out;
214 }
215
216 /* read back file contents into @cpio_srcbuf and confirm match */
> 217 len = kernel_read(file, cpio_srcbuf, c[0].filesize, NULL); 218 KUNIT_EXPECT_EQ(test, len, c[0].filesize);
219 KUNIT_EXPECT_MEMEQ(test, cpio_srcbuf, c[0].data, len);
220
221 fput(file);
222 KUNIT_EXPECT_EQ(test, init_unlink(c[0].fname), 0);
223 out:
224 kfree(cpio_srcbuf);
225 }
226
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
kernel test robot
build botRe: [PATCH v2 2/9] initramfs_test: kunit tests for initramfs unpacking
In reply to David Disseldorpkernel test robot noticed the following build errors:
Hi David,
kernel test robot noticed the following build errors:
[auto build test ERROR on akpm-mm/mm-nonmm-unstable]
[also build test ERROR on brauner-vfs/vfs.all linus/master v6.12-rc6 next-20241105] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/David-Disseldorp/init-add-initramfs_internal-h/20241104-223438 base: https://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git mm-nonmm-unstable patch link: https://lore.kernel.org/r/20241104141750.16119-3-ddiss%40suse.de patch subject: [PATCH v2 2/9] initramfs_test: kunit tests for initramfs unpacking config: alpha-allyesconfig (https://download.01.org/0day-ci/archive/20241105/[email protected]/config) compiler: alpha-linux-gcc (GCC) 13.3.0 reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20241105/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All errors (new ones prefixed by >>):
init/initramfs_test.c: In function 'initramfs_test_data':
>> init/initramfs_test.c:210:16: error: implicit declaration of function 'filp_open' [-Werror=implicit-function-declaration]
210 | file = filp_open(c[0].fname, O_RDONLY, 0);
| ^~~~~~~~~
>> init/initramfs_test.c:210:38: error: 'O_RDONLY' undeclared (first use in this function)
210 | file = filp_open(c[0].fname, O_RDONLY, 0);
| ^~~~~~~~
init/initramfs_test.c:210:38: note: each undeclared identifier is reported only once for each function it appears in
>> init/initramfs_test.c:217:15: error: implicit declaration of function 'kernel_read'; did you mean 'kref_read'? [-Werror=implicit-function-declaration]
217 | len = kernel_read(file, cpio_srcbuf, c[0].filesize, NULL);
| ^~~~~~~~~~~
| kref_readcc1: some warnings being treated as errors
vim +/filp_open +210 init/initramfs_test.c
176
177 static void __init initramfs_test_data(struct kunit *test)
178 {
179 char *err, *cpio_srcbuf;
180 size_t len;
181 struct file *file;
182 struct initramfs_test_cpio c[] = { {
183 .magic = "070701",
184 .ino = 1,
185 .mode = S_IFREG | 0777,
186 .uid = 0,
187 .gid = 0,
188 .nlink = 1,
189 .mtime = 1,
190 .filesize = sizeof("ASDF") - 1,
191 .devmajor = 0,
192 .devminor = 1,
193 .rdevmajor = 0,
194 .rdevminor = 0,
195 .namesize = sizeof("initramfs_test_data"),
196 .csum = 0,
197 .fname = "initramfs_test_data",
198 .data = "ASDF",
199 } };
200
201 /* +6 for max name and data 4-byte padding */
202 cpio_srcbuf = kmalloc(CPIO_HDRLEN + c[0].namesize + c[0].filesize + 6,
203 GFP_KERNEL);
204
205 len = fill_cpio(c, ARRAY_SIZE(c), cpio_srcbuf);
206
207 err = unpack_to_rootfs(cpio_srcbuf, len);
208 KUNIT_EXPECT_NULL(test, err);
209
> 210 file = filp_open(c[0].fname, O_RDONLY, 0);
211 if (!file) {
212 KUNIT_FAIL(test, "open failed");
213 goto out;
214 }
215
216 /* read back file contents into @cpio_srcbuf and confirm match */
> 217 len = kernel_read(file, cpio_srcbuf, c[0].filesize, NULL); 218 KUNIT_EXPECT_EQ(test, len, c[0].filesize);
219 KUNIT_EXPECT_MEMEQ(test, cpio_srcbuf, c[0].data, len);
220
221 fput(file);
222 KUNIT_EXPECT_EQ(test, init_unlink(c[0].fname), 0);
223 out:
224 kfree(cpio_srcbuf);
225 }
226
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
kernel test robot
build botRe: [PATCH v2 2/9] initramfs_test: kunit tests for initramfs unpacking
In reply to David Disseldorpkernel test robot noticed the following build warnings:
Hi David,
kernel test robot noticed the following build warnings:
[auto build test WARNING on akpm-mm/mm-nonmm-unstable]
[also build test WARNING on brauner-vfs/vfs.all linus/master v6.12-rc6 next-20241105] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/David-Disseldorp/init-add-initramfs_internal-h/20241104-223438 base: https://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git mm-nonmm-unstable patch link: https://lore.kernel.org/r/20241104141750.16119-3-ddiss%40suse.de patch subject: [PATCH v2 2/9] initramfs_test: kunit tests for initramfs unpacking config: arm64-randconfig-002-20241106 (https://download.01.org/0day-ci/archive/20241106/[email protected]/config) compiler: aarch64-linux-gcc (GCC) 14.1.0 reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20241106/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>, old ones prefixed by <<):
>> WARNING: modpost: vmlinux: section mismatch in reference: initramfs_test_cases+0x0 (section: .data) -> initramfs_test_extract (section: .init.text) >> WARNING: modpost: vmlinux: section mismatch in reference: initramfs_test_cases+0x30 (section: .data) -> initramfs_test_fname_overrun (section: .init.text) >> WARNING: modpost: vmlinux: section mismatch in reference: initramfs_test_cases+0x60 (section: .data) -> initramfs_test_data (section: .init.text) >> WARNING: modpost: vmlinux: section mismatch in reference: initramfs_test_cases+0x90 (section: .data) -> initramfs_test_csum (section: .init.text) >> WARNING: modpost: vmlinux: section mismatch in reference: initramfs_test_cases+0xc0 (section: .data) -> initramfs_test_hardlink (section: .init.text) >> WARNING: modpost: vmlinux: section mismatch in reference: initramfs_test_cases+0xf0 (section: .data) -> initramfs_test_many (section: .init.text)
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
Re: [PATCH v2 2/9] initramfs_test: kunit tests for initramfs unpacking
[adding kunit lists to cc, see lore link below for context]
https://lore.kernel.org/linux-fsdevel/[email protected]/
On Wed, 6 Nov 2024 07:04:21 +0800, kernel test robot wrote:
...
Quoted 8 lines
All warnings (new ones prefixed by >>, old ones prefixed by <<):
Quoted 6 lines
Quoted 6 lines
WARNING: modpost: vmlinux: section mismatch in reference:
initramfs_test_cases+0x0(section: .data) ->initramfs_test_extract(section: .init.text)
WARNING: modpost: vmlinux: section mismatch in reference:initramfs_test_cases+0x30(section: .data) ->initramfs_test_fname_overrun(section: .init.text)
WARNING: modpost: vmlinux: section mismatch in reference:initramfs_test_cases+0x60(section: .data) ->initramfs_test_data(section: .init.text)
WARNING: modpost: vmlinux: section mismatch in reference:initramfs_test_cases+0x90(section: .data) ->initramfs_test_csum(section: .init.text)
WARNING: modpost: vmlinux: section mismatch in reference:initramfs_test_cases+0xc0(section: .data) ->initramfs_test_hardlink(section: .init.text)
WARNING: modpost: vmlinux: section mismatch in reference:initramfs_test_cases+0xf0(section: .data) ->initramfs_test_many(section: .init.text)
If I understand correctly, the kunit_case initramfs_test_cases[] members can't be flagged __initdata, as they need to be present post-init for results queries via debugfs.
The remaining -Wimplicit-function-declaration reports are all valid. I'll fix them in v3.
Thanks, David
Re: [PATCH v2 2/9] initramfs_test: kunit tests for initramfs unpacking
In reply to David DisseldorpQuoted 9 lines · David Disseldorp
Provide some basic initramfs unpack sanity tests covering:
- simple file / dir extraction
- filename field overrun, as reported and fixed separately via
https://lore.kernel.org/r/[email protected]
- "070702" cpio data checksums
- hardlinksSigned-off-by David Disseldorp <[email protected]>---
...
init/initramfs_test.c line 393
Quoted 3 lines
init/initramfs_test.c new file +3
-0+kunit_test_init_section_suites (&initramfs_test_suite); + +MODULE_LICENSE ("GPL" );
Since commit 1fffe7a34c89 ("script: modpost: emit a warning when the description is missing"), a module without a MODULE_DESCRIPTION() will result in a warning when built with make W=1. Recently, multiple developers have been eradicating these warnings treewide, and very few (if any) are left, so please don't introduce a new one :)
Please add the missing MODULE_DESCRIPTION()
PATCH v2 3/9 vsprintf: add simple_strntoul
In reply to David Disseldorpcpio extraction currently does a memcpy to ensure that the archive hex fields are null terminated for simple_strtoul(). simple_strntoul() will allow us to avoid the memcpy.
--- include/linux/kstrtox.h | 1 + lib/vsprintf.c | 7 +++++++ 2 files changed, 8 insertions(+)
include/linux/kstrtox.h +1 -0
@@ -143,6 +143,7 @@ static inline int __must_check kstrtos32_from_user(const char __user *s, size_t*/ extern unsigned long simple_strtoul (const char *,char **,unsigned int ); +extern unsigned long simple_strntoul (const char *,char **,unsigned int ,size_t );extern long simple_strtol (const char *,char **,unsigned int );extern unsigned long long simple_strtoull (const char *,char **,unsigned int );extern long long simple_strtoll (const char *,char **,unsigned int );
lib/vsprintf.c +7 -0
@@ -114,6 +114,13 @@ unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base) }EXPORT_SYMBOL (simple_strtoul); +unsigned long simple_strntoul (const char *cp,char **endp,unsigned int base, +size_t max_chars) +{ +return simple_strntoull (cp, endp, base, max_chars); +} +EXPORT_SYMBOL (simple_strntoul); +/** * simple_strtol - convert a string to a signed long * @cp: The start of the string
Signature · 1 line
2.43.0
PATCH v2 4/9 initramfs: avoid memcpy for hex header fields
In reply to David Disseldorpnewc/crc cpio headers contain a bunch of 8-character hexadecimal fields which we convert via simple_strtoul(), following memcpy() into a zero-terminated stack buffer. The new simple_strntoul() helper allows us to pass in max_chars=8 to avoid zero-termination and memcpy().
--- init/initramfs.c | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-)
init/initramfs.c +3 -6
@@ -189,14 +189,11 @@ static __initdata u32 hdr_csum;static void __init parse_header (char *s) {unsigned long parsed[13 ]; -char buf[9 ];int i; - buf[8 ] ='\0' ; -for (i =0 , s +=6 ; i <13 ; i++, s +=8 ) { -memcpy (buf, s,8 ); - parsed[i] =simple_strtoul (buf,NULL ,16 ); - } +for (i =0 , s +=6 ; i <13 ; i++, s +=8 ) + parsed[i] =simple_strntoul (s,NULL ,16 ,8 ); + ino = parsed[0 ]; mode = parsed[1 ]; uid = parsed[2 ];
Signature · 1 line
2.43.0
PATCH v2 5/9 initramfs: remove extra symlink path buffer
In reply to David DisseldorpA (newc/crc) cpio entry with mode.S_IFLNK set carries the symlink target in the cpio data segment, following the padded name_len sized file path. symlink_buf is heap-allocated for staging both file path and symlink target, while name_buf is additionally allocated for staging paths for non-symlink cpio entries.
Separate symlink / non-symlink buffers are unnecessary, so just extend the size of name_buf and use it for both.
--- init/initramfs.c | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-)
init/initramfs.c +5 -7
@@ -250,7 +250,7 @@ static void __init read_into(char *buf, unsigned size, enum state next) } } -static __initdata char *header_buf, *symlink_buf, *name_buf; +static __initdata char *header_buf, *name_buf;static int __init do_start (void ) {
@@ -294,7 +294,7 @@ static int __init do_header(void)if (S_ISLNK (mode)) {if (body_len >PATH_MAX )return 0 ; - collect = collected = symlink_buf; + collect = collected = name_buf; remains =N_ALIGN (name_len) + body_len; next_state = GotSymlink; state = Collect;
@@ -512,10 +512,9 @@ char * __init unpack_to_rootfs(char *buf, unsigned long len)static __initdata char msg_buf[64 ]; header_buf =kmalloc (CPIO_HDRLEN ,GFP_KERNEL ); - symlink_buf =kmalloc (PATH_MAX +N_ALIGN (PATH_MAX ) +1 ,GFP_KERNEL ); - name_buf =kmalloc (N_ALIGN (PATH_MAX ),GFP_KERNEL ); - -if (!header_buf || !symlink_buf || !name_buf) +/* 2x PATH_MAX as @name_buf is also used for staging symlink targets */ + name_buf =kmalloc (N_ALIGN (PATH_MAX ) +PATH_MAX +1 ,GFP_KERNEL ); +if (!header_buf || !name_buf)panic_show_mem ("can't allocate buffers" ); state = Start;
@@ -561,7 +560,6 @@ char * __init unpack_to_rootfs(char *buf, unsigned long len) }dir_utime ();kfree (name_buf); -kfree (symlink_buf);kfree (header_buf);return message; }
Signature · 1 line
2.43.0
PATCH v2 6/9 initramfs: merge header_buf and name_buf
In reply to David Disseldorpheader_buf is only used in FSM states up to GotHeader, while name_buf is only used in states following GotHeader (Collect is shared, but the collect pointer tracks each buffer). These buffers can therefore be combined into a single cpio_buf, which can be used for both header and file name storage.
--- init/initramfs.c | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-)
init/initramfs.c +15 -11
@@ -250,11 +250,11 @@ static void __init read_into(char *buf, unsigned size, enum state next) } } -static __initdata char *header_buf, *name_buf; +static __initdata char *cpio_buf;static int __init do_start (void ) { -read_into (header_buf,CPIO_HDRLEN , GotHeader); +read_into (cpio_buf,CPIO_HDRLEN , GotHeader);return 0 ; }
@@ -294,14 +294,14 @@ static int __init do_header(void)if (S_ISLNK (mode)) {if (body_len >PATH_MAX )return 0 ; - collect = collected = name_buf; + collect = collected = cpio_buf; remains =N_ALIGN (name_len) + body_len; next_state = GotSymlink; state = Collect;return 0 ; }if (S_ISREG (mode) || !body_len) -read_into (name_buf,N_ALIGN (name_len), GotName); +read_into (cpio_buf,N_ALIGN (name_len), GotName);return 0 ; }
@@ -511,11 +511,16 @@ char * __init unpack_to_rootfs(char *buf, unsigned long len)const char *compress_name;static __initdata char msg_buf[64 ]; - header_buf =kmalloc (CPIO_HDRLEN ,GFP_KERNEL ); -/* 2x PATH_MAX as @name_buf is also used for staging symlink targets */ - name_buf =kmalloc (N_ALIGN (PATH_MAX ) +PATH_MAX +1 ,GFP_KERNEL ); -if (!header_buf || !name_buf) -panic_show_mem ("can't allocate buffers" ); +/* +* @cpio_buf can be used for staging the 110 byte newc/crc cpio header, +* after which parse_header() converts and stashes fields into +* corresponding types. The same buffer can then be reused for file +* path staging. 2 x PATH_MAX covers any possible symlink target. +*/ +BUILD_BUG_ON (CPIO_HDRLEN >N_ALIGN (PATH_MAX ) +PATH_MAX +1 ); + cpio_buf =kmalloc (N_ALIGN (PATH_MAX ) +PATH_MAX +1 ,GFP_KERNEL ); +if (!cpio_buf) +panic_show_mem ("can't allocate buffer" ); state = Start; this_header =0 ;
@@ -559,8 +564,7 @@ char * __init unpack_to_rootfs(char *buf, unsigned long len) len -= my_inptr; }dir_utime (); -kfree (name_buf); -kfree (header_buf); +kfree (cpio_buf);return message; }
Signature · 1 line
2.43.0
PATCH v2 7/9 initramfs: reuse name_len for dir mtime tracking
In reply to David DisseldorpWe already have a nulterm-inclusive, checked name_len for the directory name, so use that instead of calling strlen().
--- init/initramfs.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
init/initramfs.c +3 -4
@@ -144,9 +144,8 @@ struct dir_entry {char name[]; }; -static void __init dir_add (const char *name,time64_t mtime) +static void __init dir_add (const char *name,size_t nlen,time64_t mtime) { -size_t nlen =strlen (name) +1 ;struct dir_entry *de; de =kmalloc (sizeof (struct dir_entry ) + nlen,GFP_KERNEL );
@@ -170,7 +169,7 @@ static void __init dir_utime(void)#else static void __init do_utime (char *filename,time64_t mtime) {}static void __init do_utime_path (const struct path *path,time64_t mtime) {} -static void __init dir_add (const char *name,time64_t mtime) {} +static void __init dir_add (const char *name,size_t nlen,time64_t mtime) {}static void __init dir_utime (void ) {}#endif
@@ -394,7 +393,7 @@ static int __init do_name(void)init_mkdir (collected, mode);init_chown (collected, uid, gid,0 );init_chmod (collected, mode); -dir_add (collected, mtime); +dir_add (collected, name_len, mtime); }else if (S_ISBLK (mode) ||S_ISCHR (mode) ||S_ISFIFO (mode) ||S_ISSOCK (mode)) {if (maybe_link () ==0 ) {
Signature · 1 line
2.43.0
PATCH v2 8/9 initramfs: fix hardlink hash leak without TRAILER
In reply to David DisseldorpCovered in Documentation/driver-api/early-userspace/buffer-format.rst , initramfs archives can carry an optional "TRAILER!!!" entry which serves as a boundary for collecting and associating hardlinks with matching inode and major / minor device numbers.
Although optional, if hardlinks are found in an archive without a subsequent "TRAILER!!!" entry then the hardlink state hash table is leaked, e.g. unfixed kernel, with initramfs_test.c hunk applied only:
unreferenced object 0xffff9405408cc000 (size 8192):
comm "kunit_try_catch", pid 53, jiffies 4294892519
hex dump (first 32 bytes):
01 00 00 00 01 00 00 00 00 00 00 00 ff 81 00 00 ................
00 00 00 00 00 00 00 00 69 6e 69 74 72 61 6d 66 ........initramf
backtrace (crc a9fb0ee0):
[<0000000066739faa>] __kmalloc_cache_noprof+0x11d/0x250
[<00000000fc755219>] maybe_link.part.5+0xbc/0x120
[<000000000526a128>] do_name+0xce/0x2f0
[<00000000145c1048>] write_buffer+0x22/0x40
[<000000003f0b4f32>] unpack_to_rootfs+0xf9/0x2a0
[<00000000d6f7e5af>] initramfs_test_hardlink+0xe3/0x3f0
[<0000000014fde8d6>] kunit_try_run_case+0x5f/0x130
[<00000000dc9dafc5>] kunit_generic_run_threadfn_adapter+0x18/0x30
[<000000001076c239>] kthread+0xc8/0x100
[<00000000d939f1c1>] ret_from_fork+0x2b/0x40
[<00000000f848ad1a>] ret_from_fork_asm+0x1a/0x30Fix this by calling free_hash() after initramfs buffer processing in unpack_to_rootfs(). An extra hardlink_seen global is added as an optimization to avoid walking the 32 entry hash array unnecessarily. The expectation is that a "TRAILER!!!" entry will normally be present, and initramfs hardlinks are uncommon.
There is one user facing side-effect of this fix: hardlinks can currently be associated across built-in and external initramfs archives, *if* the built-in initramfs archive lacks a "TRAILER!!!" terminator. I'd consider this cross-archive association broken, but perhaps it's used.
--- init/initramfs.c | 7 ++++++- init/initramfs_test.c | 5 ----- 2 files changed, 6 insertions(+), 6 deletions(-)
init/initramfs.c +6 -1
@@ -76,6 +76,7 @@ static __initdata struct hash {struct hash *next;char name[N_ALIGN (PATH_MAX )]; } *head[32 ]; +static __initdata bool hardlink_seen;static inline int hash (int major,int minor,int ino) {
@@ -109,19 +110,21 @@ static char __init *find_link(int major, int minor, int ino,strcpy (q->name, name); q->next =NULL ; *p = q; + hardlink_seen = true;return NULL ; }static void __init free_hash (void ) {struct hash **p, *q; -for (p = head; p < head +32 ; p++) { +for (p = head; hardlink_seen && p < head +32 ; p++) {while (*p) { q = *p; *p = q->next;kfree (q); } } + hardlink_seen = false; }#ifdef CONFIG_INITRAMFS_PRESERVE_MTIME
@@ -563,6 +566,8 @@ char * __init unpack_to_rootfs(char *buf, unsigned long len) len -= my_inptr; }dir_utime (); +/* free any hardlink state collected without optional TRAILER!!! */ +free_hash ();kfree (cpio_buf);return message; }
init/initramfs_test.c +0 -5
@@ -305,11 +305,6 @@ static void __init initramfs_test_hardlink(struct kunit *test) .namesize = sizeof("initramfs_test_hardlink_link"), .fname = "initramfs_test_hardlink_link", .data = "ASDF", - }, { -/* hardlink hashtable leaks when the archive omits a trailer */ - .magic = "070701", - .namesize = sizeof("TRAILER!!!"), - .fname = "TRAILER!!!", } }; cpio_srcbuf =kmalloc (8192 ,GFP_KERNEL );
Signature · 1 line
2.43.0
PATCH v2 9/9 initramfs: avoid static buffer for error message
In reply to David DisseldorpThe dynamic error message printed if CONFIG_RD_$ALG compression support is missing needn't be propagated up to the caller via a static buffer. Print it immediately via pr_err() and set @message to a const string to flag error.
Before:
text data bss dec hex filename
7695 1102 8 8805 2265 ./init/initramfs.o
After:
text data bss dec hex filename
7683 1006 8 8697 21f9 ./init/initramfs.o
--- init/initramfs.c | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-)
init/initramfs.c +3 -7
@@ -511,7 +511,6 @@ char * __init unpack_to_rootfs(char *buf, unsigned long len)long written;decompress_fn decompress;const char *compress_name; -static __initdata char msg_buf[64 ];/* * @cpio_buf can be used for staging the 110 byte newc/crc cpio header,
@@ -551,12 +550,9 @@ char * __init unpack_to_rootfs(char *buf, unsigned long len)if (res)error ("decompressor failed" ); }else if (compress_name) { -if (!message) { -snprintf (msg_buf,sizeof msg_buf, -"compression method %s not configured" , - compress_name); - message = msg_buf; - } +pr_err ("compression method %s not configured\n" , + compress_name); +error ("decompressor failed" ); }else error ("invalid magic at start of compressed archive" );if (state != Reset)
Signature · 1 line
2.43.0