Skip to contentSkip to conversation

scripts/kallsyms: Fix build failure by setting errno before calling getline()

PATCH In review James Clark 2 participants 2 messages Jul 25, 2023 – Jul 29, 2023 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 scripts/kallsyms: Fix build failure by setting errno before calling getline()

getline() returns -1 at EOF as well as on error. It also doesn't set errno to 0 on success, so initialize it to 0 before using errno to check for an error condition. See the paragraph here [1]:

For some system calls and library functions (e.g., getpriority(2)), -1 is a valid return on success. In such cases, a successful return can be distinguished from an error return by setting errno to zero before the call, and then, if the call returns a status that indicates that an error may have occurred, checking to see if errno has a nonzero value.

Bear has a bug [2] that launches processes with errno set and causes the following build failure:

 $ bear -- make LLVM=1
 ...
  LD      .tmp_vmlinux.kallsyms1
  NM      .tmp_vmlinux.kallsyms1.syms
  KSYMS   .tmp_vmlinux.kallsyms1.S
 read_symbol: Invalid argument

[1]: https://linux.die.net/man/3/errno
[2]: https://github.com/rizsotto/Bear/issues/469

Fixes 1c975da56a6f ("scripts/kallsyms: remove KSYM_NAME_LEN_BUFFER")
---
 scripts/kallsyms.c | 1 +
 1 file changed, 1 insertion(+)
scripts/kallsyms.c +1 -0
index 16c87938b316..653b92f6d4c8 100644
@@ -129,6 +129,7 @@ static struct sym_entry *read_symbol(FILE *in, char **buf, size_t *buf_len)
 	ssize_t readlen;
 	struct sym_entry *sym;
 
+	errno = 0;
 	readlen = getline(buf, buf_len, in);
 	if (readlen < 0) {
 		if (errno) {
Signature · 1 line
2.34.1
#1 lore raw
Quoted 22 lines · James Clark

getline() returns -1 at EOF as well as on error. It also doesn't set errno to 0 on success, so initialize it to 0 before using errno to check for an error condition. See the paragraph here [1]:

For some system calls and library functions (e.g., getpriority(2)), -1 is a valid return on success. In such cases, a successful return can be distinguished from an error return by setting errno to zero before the call, and then, if the call returns a status that indicates that an error may have occurred, checking to see if errno has a nonzero value.

Bear has a bug [2] that launches processes with errno set and causes the following build failure:

 $ bear -- make LLVM=1
 ...
  LD      .tmp_vmlinux.kallsyms1
  NM      .tmp_vmlinux.kallsyms1.syms
  KSYMS   .tmp_vmlinux.kallsyms1.S
 read_symbol: Invalid argument
Quoted 6 lines

[1]: https://linux.die.net/man/3/errno
[2]: https://github.com/rizsotto/Bear/issues/469

Fixes 1c975da56a6f ("scripts/kallsyms: remove KSYM_NAME_LEN_BUFFER")

Applied to linux-kbuild/fixes.
Thanks.

Quoted 19 lines
---
 scripts/kallsyms.c | 1 +
 1 file changed, 1 insertion(+)
scripts/kallsyms.c +1 -1
index 16c87938b316..653b92f6d4c8 100644
@@ -129,6 +129,7 @@ static struct sym_entry *read_symbol(FILE *in, char **buf, size_t *buf_len)
        ssize_t readlen;
        struct sym_entry *sym;
 
+       errno = 0;
        readlen = getline(buf, buf_len, in);
        if (readlen < 0) {
                if (errno) {
--

2.34.1

Signature · 2 lines
Best Regards
Masahiro Yamada