Skip to contentSkip to conversation

kheaders: explicitly validate existence of cpio command

PATCH In review Thomas Weißschuh 4 participants 5 messages Jan 17, 2023 – Jan 18, 2023 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kheaders: explicitly validate existence of cpio command

If the cpio command is not available the error emitted by gen_kheaders.so is not clear as all output of the call to cpio is discarded:

GNU make 4.4:

GEN kernel/kheaders_data.tar.xz
find: 'standard output': Broken pipe
find: write error
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

GNU make < 4.4:

GEN kernel/kheaders_data.tar.xz
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[2]: *** Waiting for unfinished jobs....
make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

Add an explicit check that will trigger a clear message about the issue:

CHK kernel/kheaders_data.tar.xz
./kernel/gen_kheaders.sh: line 17: type: cpio: not found

The other commands executed by gen_kheaders.sh are part of a standard installation, so they are not checked.

---
 kernel/gen_kheaders.sh | 2 ++
 1 file changed, 2 insertions(+)
kernel/gen_kheaders.sh +2 -0
index 473036b43c83..81b97f0f6556 100755
@@ -14,6 +14,8 @@ include/
 arch/$SRCARCH/include/
 "
 
+type cpio > /dev/null
+
 # Support incremental builds by skipping archive generation
 # if timestamps of files being archived are not changed.
 

---
base-commit: d532dd102151cc69fcd00b13e5a9689b23c0c8d9
change-id: 20230117-kernel-kheaders-cpio-2f7c70bc9c19

Best regards,

Signature · 1 line
Thomas Weißschuh <[email protected]>
Reviewed-by on v1 1/1
#1 lore raw
Quoted 19 lines · Thomas Weißschuh

If the cpio command is not available the error emitted by gen_kheaders.so is not clear as all output of the call to cpio is discarded:

GNU make 4.4:

GEN kernel/kheaders_data.tar.xz
find: 'standard output': Broken pipe
find: write error
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

GNU make < 4.4:

GEN kernel/kheaders_data.tar.xz
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[2]: *** Waiting for unfinished jobs....
make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

Quoted 4 lines

Add an explicit check that will trigger a clear message about the issue:

CHK kernel/kheaders_data.tar.xz
./kernel/gen_kheaders.sh: line 17: type: cpio: not found

Thanks for the patch! What would you think about an even more verbose message? Perhaps something like:

    echo >&2 ' *** "cpio" is required for "CONFIG_IKHEADERS". >&2

Kind regards,
Nicolas

#2 lore raw
Quoted 22 lines · Nicolas Schier
Quoted 21 lines · Thomas Weißschuh

If the cpio command is not available the error emitted by gen_kheaders.so is not clear as all output of the call to cpio is discarded:

GNU make 4.4:

GEN kernel/kheaders_data.tar.xz
find: 'standard output': Broken pipe
find: write error
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

GNU make < 4.4:

GEN kernel/kheaders_data.tar.xz
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[2]: *** Waiting for unfinished jobs....
make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

Add an explicit check that will trigger a clear message about the issue:

Quoted 7 lines
Quoted 2 lines

CHK kernel/kheaders_data.tar.xz
./kernel/gen_kheaders.sh: line 17: type: cpio: not found

Thanks for the patch! What would you think about an even more verbose message? Perhaps something like:

    echo >&2 ' *** "cpio" is required for "CONFIG_IKHEADERS". >&2

Wouldn't hurt obviously.
The other scripts used by the kernel don't seem to try to provide this kind of explicit message either, though.
Having a line number, some sort of "not found" and the name of the command are enough, in my opinion.

Quoted 1 line

Thanks!

Thomas

#3 lore raw
Quoted 30 lines · Thomas Weißschuh
Quoted 28 lines · Nicolas Schier
Quoted 19 lines · Thomas Weißschuh

If the cpio command is not available the error emitted by gen_kheaders.so is not clear as all output of the call to cpio is discarded:

GNU make 4.4:

GEN kernel/kheaders_data.tar.xz
find: 'standard output': Broken pipe
find: write error
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

GNU make < 4.4:

GEN kernel/kheaders_data.tar.xz
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[2]: *** Waiting for unfinished jobs....
make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

Quoted 4 lines

Add an explicit check that will trigger a clear message about the issue:

CHK kernel/kheaders_data.tar.xz
./kernel/gen_kheaders.sh: line 17: type: cpio: not found

Thanks for the patch! What would you think about an even more verbose message? Perhaps something like:

Quoted 7 lines
Quoted 1 line
    echo >&2 ' *** "cpio" is required for "CONFIG_IKHEADERS". >&2

Wouldn't hurt obviously.
The other scripts used by the kernel don't seem to try to provide this kind of explicit message either, though.
Having a line number, some sort of "not found" and the name of the command are enough, in my opinion.

Agree. I am fine with this patch.

Just a side note.

'type' is defined in posix [1], so this code is portable.

Kbuild often uses "command -v" to check the existence of a command because it is also posix compliant [2].

I just wondered why we did not use 'type' before...

'type' is more efficient because it is shell-builtin (at least for dash and bash) but 'command' is not.

[1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/type.html

[2]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/command.html

Quoted 6 lines
Quoted 2 lines

Thanks!

Thomas

Signature · 2 lines
Best Regards
Masahiro Yamada
#4 lore raw
In reply to Thomas Weißschuh
Quoted 38 lines · Thomas Weißschuh
Quoted 22 lines · Nicolas Schier
Quoted 21 lines · Thomas Weißschuh

If the cpio command is not available the error emitted by gen_kheaders.so is not clear as all output of the call to cpio is discarded:

GNU make 4.4:

GEN kernel/kheaders_data.tar.xz
find: 'standard output': Broken pipe
find: write error
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

GNU make < 4.4:

GEN kernel/kheaders_data.tar.xz
make[2]: *** [kernel/Makefile:157: kernel/kheaders_data.tar.xz] Error 127 make[2]: *** Waiting for unfinished jobs....
make[1]: *** [scripts/Makefile.build:504: kernel] Error 2

Add an explicit check that will trigger a clear message about the issue:

Quoted 7 lines
Quoted 2 lines

CHK kernel/kheaders_data.tar.xz
./kernel/gen_kheaders.sh: line 17: type: cpio: not found

Thanks for the patch! What would you think about an even more verbose message? Perhaps something like:

    echo >&2 ' *** "cpio" is required for "CONFIG_IKHEADERS". >&2

Wouldn't hurt obviously.
The other scripts used by the kernel don't seem to try to provide this kind of explicit message either, though.
Having a line number, some sort of "not found" and the name of the command are enough, in my opinion.

Quoted 5 lines
Quoted 1 line

Thanks!

Thomas

Applied to linux-kbuild. Thanks.

Signature · 2 lines
Best Regards
Masahiro Yamada