Skip to contentSkip to conversation

modpost: move __attribute__((format(printf, 2, 3))) to modpost.h

PATCH Superseded Masahiro Yamada 2 participants 7 messages Nov 25, 2023 – Dec 3, 2023 Kbuild

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/3 modpost: move __attribute__((format(printf, 2, 3))) to modpost.h

This attribute must be added to the function declaration in a header for comprehensive checking of all the callsites.

Fixes 6d9a89ea4b06 ("kbuild: declare the modpost error functions as printf like")

---

 scripts/mod/modpost.c | 3 +--
 scripts/mod/modpost.h | 3 ++-
 2 files changed, 3 insertions(+), 3 deletions(-)
scripts/mod/modpost.c +1 -2
index cb6406f485a9..ca0a90158f85 100644
@@ -60,8 +60,7 @@ static unsigned int nr_unresolved;
 
 #define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
 
-void __attribute__((format(printf, 2, 3)))
-modpost_log(enum loglevel loglevel, const char *fmt, ...)
+void modpost_log(enum loglevel loglevel, const char *fmt, ...)
 {
 	va_list arglist;
 
scripts/mod/modpost.h +2 -1
index 69baf014da4f..9fe974dc1a52 100644
@@ -197,7 +197,8 @@ enum loglevel {
 	LOG_FATAL
 };
 
-void modpost_log(enum loglevel loglevel, const char *fmt, ...);
+void __attribute__((format(printf, 2, 3)))
+modpost_log(enum loglevel loglevel, const char *fmt, ...);
 
 /*
  * warn - show the given message, then let modpost continue running, still
Signature · 1 line
2.40.1
#1 lore raw

PATCH 2/3 modpost: remove unreachable code after fatal()

fatal() never returns. Remove unreachable code.

---

 scripts/mod/modpost.c | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)
scripts/mod/modpost.c +3 -6
index ca0a90158f85..013fc5031bc7 100644
@@ -473,11 +473,9 @@ static int parse_elf(struct elf_info *info, const char *filename)
 		fatal("%s: not relocatable object.", filename);
 
 	/* Check if file offset is correct */
-	if (hdr->e_shoff > info->size) {
+	if (hdr->e_shoff > info->size)
 		fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
 		      (unsigned long)hdr->e_shoff, filename, info->size);
-		return 0;
-	}
 
 	if (hdr->e_shnum == SHN_UNDEF) {
 		/*
@@ -515,12 +513,11 @@ static int parse_elf(struct elf_info *info, const char *filename)
 		const char *secname;
 		int nobits = sechdrs[i].sh_type == SHT_NOBITS;
 
-		if (!nobits && sechdrs[i].sh_offset > info->size) {
+		if (!nobits && sechdrs[i].sh_offset > info->size)
 			fatal("%s is truncated. sechdrs[i].sh_offset=%lu > sizeof(*hrd)=%zu\n",
 			      filename, (unsigned long)sechdrs[i].sh_offset,
 			      sizeof(*hdr));
-			return 0;
-		}
+
 		secname = secstrings + sechdrs[i].sh_name;
 		if (strcmp(secname, ".modinfo") == 0) {
 			if (nobits)
Signature · 1 line
2.40.1
maintainer Reviewed-by on v1 2/3
#2 lore raw

Re: [PATCH 2/3] modpost: remove unreachable code after fatal()

Quoted 3 lines · Masahiro Yamada

fatal() never returns. Remove unreachable code.

Quoted 40 lines

---

 scripts/mod/modpost.c | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)
scripts/mod/modpost.c +3 -6
index ca0a90158f85..013fc5031bc7 100644
@@ -473,11 +473,9 @@ static int parse_elf(struct elf_info *info, const char *filename)
 		fatal("%s: not relocatable object.", filename);
 
 	/* Check if file offset is correct */
-	if (hdr->e_shoff > info->size) {
+	if (hdr->e_shoff > info->size)
 		fatal("section header offset=%lu in file '%s' is bigger than filesize=%zu\n",
 		      (unsigned long)hdr->e_shoff, filename, info->size);
-		return 0;
-	}
 
 	if (hdr->e_shnum == SHN_UNDEF) {
 		/*
@@ -515,12 +513,11 @@ static int parse_elf(struct elf_info *info, const char *filename)
 		const char *secname;
 		int nobits = sechdrs[i].sh_type == SHT_NOBITS;
 
-		if (!nobits && sechdrs[i].sh_offset > info->size) {
+		if (!nobits && sechdrs[i].sh_offset > info->size)
 			fatal("%s is truncated. sechdrs[i].sh_offset=%lu > sizeof(*hrd)=%zu\n",
 			      filename, (unsigned long)sechdrs[i].sh_offset,
 			      sizeof(*hdr));
-			return 0;
-		}
+
 		secname = secstrings + sechdrs[i].sh_name;
 		if (strcmp(secname, ".modinfo") == 0) {
 			if (nobits)
Signature · 1 line
2.40.1
#3 lore raw

PATCH 3/3 modpost: move exit(1) for fatal() to modpost.h

In reply to Masahiro Yamada

fatal() never returns, but compilers are not aware of this fact because exit(1) is called within the modpost_log() definition.

Move exit(1) to the fatal() macro so that compilers can identify unreachable code flows.

Remove the initializer for 'taddr' in section_rel(), as compilers now recognize this is not an uninitialized bug.

---

 scripts/mod/modpost.c | 4 +---
 scripts/mod/modpost.h | 2 +-
 2 files changed, 2 insertions(+), 4 deletions(-)
scripts/mod/modpost.c +1 -3
index 013fc5031bc7..696c583a14ec 100644
@@ -84,8 +84,6 @@ void modpost_log(enum loglevel loglevel, const char *fmt, ...)
 	vfprintf(stderr, fmt, arglist);
 	va_end(arglist);
 
-	if (loglevel == LOG_FATAL)
-		exit(1);
 	if (loglevel == LOG_ERROR)
 		error_occurred = true;
 }
@@ -1415,7 +1413,7 @@ static void section_rel(struct module *mod, struct elf_info *elf,
 
 	for (rel = start; rel < stop; rel++) {
 		Elf_Sym *tsym;
-		Elf_Addr taddr = 0, r_offset;
+		Elf_Addr taddr, r_offset;
 		unsigned int r_type, r_sym;
 		void *loc;
 
scripts/mod/modpost.h +1 -1
index 9fe974dc1a52..aaa67b24775e 100644
@@ -215,4 +215,4 @@ modpost_log(enum loglevel loglevel, const char *fmt, ...);
  */
 #define warn(fmt, args...)	modpost_log(LOG_WARN, fmt, ##args)
 #define error(fmt, args...)	modpost_log(LOG_ERROR, fmt, ##args)
-#define fatal(fmt, args...)	modpost_log(LOG_FATAL, fmt, ##args)
+#define fatal(fmt, args...)	do { modpost_log(LOG_FATAL, fmt, ##args); exit(1); } while (1)
Signature · 1 line
2.40.1
maintainer Reviewed-by on v1 3/3
#4 lore raw

Re: [PATCH 3/3] modpost: move exit(1) for fatal() to modpost.h

Quoted 10 lines · Masahiro Yamada

fatal() never returns, but compilers are not aware of this fact because exit(1) is called within the modpost_log() definition.

Move exit(1) to the fatal() macro so that compilers can identify unreachable code flows.

Remove the initializer for 'taddr' in section_rel(), as compilers now recognize this is not an uninitialized bug.

While I did not see any warnings when testing, it seems like this patch should come before patch 2 to avoid any potential problems from dropping the unreachable code (since the compiler won't be able to infer that fatal() is __noreturn without this change); doesn't really matter though so:

Quoted 41 lines

---

 scripts/mod/modpost.c | 4 +---
 scripts/mod/modpost.h | 2 +-
 2 files changed, 2 insertions(+), 4 deletions(-)
scripts/mod/modpost.c +1 -3
index 013fc5031bc7..696c583a14ec 100644
@@ -84,8 +84,6 @@ void modpost_log(enum loglevel loglevel, const char *fmt, ...)
 	vfprintf(stderr, fmt, arglist);
 	va_end(arglist);
 
-	if (loglevel == LOG_FATAL)
-		exit(1);
 	if (loglevel == LOG_ERROR)
 		error_occurred = true;
 }
@@ -1415,7 +1413,7 @@ static void section_rel(struct module *mod, struct elf_info *elf,
 
 	for (rel = start; rel < stop; rel++) {
 		Elf_Sym *tsym;
-		Elf_Addr taddr = 0, r_offset;
+		Elf_Addr taddr, r_offset;
 		unsigned int r_type, r_sym;
 		void *loc;
 
scripts/mod/modpost.h +1 -1
index 9fe974dc1a52..aaa67b24775e 100644
@@ -215,4 +215,4 @@ modpost_log(enum loglevel loglevel, const char *fmt, ...);
  */
 #define warn(fmt, args...)	modpost_log(LOG_WARN, fmt, ##args)
 #define error(fmt, args...)	modpost_log(LOG_ERROR, fmt, ##args)
-#define fatal(fmt, args...)	modpost_log(LOG_FATAL, fmt, ##args)
+#define fatal(fmt, args...)	do { modpost_log(LOG_FATAL, fmt, ##args); exit(1); } while (1)
Signature · 1 line
2.40.1
#5 lore raw

Re: [PATCH 3/3] modpost: move exit(1) for fatal() to modpost.h

Quoted 11 lines · Nathan Chancellor
Quoted 9 lines · Masahiro Yamada

fatal() never returns, but compilers are not aware of this fact because exit(1) is called within the modpost_log() definition.

Move exit(1) to the fatal() macro so that compilers can identify unreachable code flows.

Remove the initializer for 'taddr' in section_rel(), as compilers now recognize this is not an uninitialized bug.

Quoted 7 lines
Quoted 1 line

While I did not see any warnings when testing, it seems like this patch should come before patch 2 to avoid any potential problems from dropping the unreachable code (since the compiler won't be able to infer that fatal() is __noreturn without this change); doesn't really matter though so:

My eyes spotted 2/3, but I can swap the patch order and rephase the patch description because clang can detect the unreachable code.

Quoted 44 lines
Quoted 41 lines

---

 scripts/mod/modpost.c | 4 +---
 scripts/mod/modpost.h | 2 +-
 2 files changed, 2 insertions(+), 4 deletions(-)
scripts/mod/modpost.c +1 -3
index 013fc5031bc7..696c583a14ec 100644
@@ -84,8 +84,6 @@ void modpost_log(enum loglevel loglevel, const char *fmt, ...)
      vfprintf(stderr, fmt, arglist);
      va_end(arglist);
 
-     if (loglevel == LOG_FATAL)
-             exit(1);
      if (loglevel == LOG_ERROR)
              error_occurred = true;
 }
@@ -1415,7 +1413,7 @@ static void section_rel(struct module *mod, struct elf_info *elf,
 
      for (rel = start; rel < stop; rel++) {
              Elf_Sym *tsym;
-             Elf_Addr taddr = 0, r_offset;
+             Elf_Addr taddr, r_offset;
              unsigned int r_type, r_sym;
              void *loc;
 
scripts/mod/modpost.h +1 -2
index 9fe974dc1a52..aaa67b24775e 100644
@@ -215,4 +215,4 @@ modpost_log(enum loglevel loglevel, const char *fmt, ...);
  */
 #define warn(fmt, args...)   modpost_log(LOG_WARN, fmt, ##args)
 #define error(fmt, args...)  modpost_log(LOG_ERROR, fmt, ##args)
-#define fatal(fmt, args...)  modpost_log(LOG_FATAL, fmt, ##args)
+#define fatal(fmt, args...)  do { modpost_log(LOG_FATAL, fmt, ##args); exit(1); } while (1)
--

2.40.1

Signature · 2 lines
Best Regards
Masahiro Yamada
maintainer Reviewed-by on v1 1/3
#6 lore raw
In reply to Masahiro Yamada
Quoted 5 lines · Masahiro Yamada

This attribute must be added to the function declaration in a header for comprehensive checking of all the callsites.

Fixes 6d9a89ea4b06 ("kbuild: declare the modpost error functions as printf like")
Quoted 37 lines

---

 scripts/mod/modpost.c | 3 +--
 scripts/mod/modpost.h | 3 ++-
 2 files changed, 3 insertions(+), 3 deletions(-)
scripts/mod/modpost.c +1 -2
index cb6406f485a9..ca0a90158f85 100644
@@ -60,8 +60,7 @@ static unsigned int nr_unresolved;
 
 #define MODULE_NAME_LEN (64 - sizeof(Elf_Addr))
 
-void __attribute__((format(printf, 2, 3)))
-modpost_log(enum loglevel loglevel, const char *fmt, ...)
+void modpost_log(enum loglevel loglevel, const char *fmt, ...)
 {
 	va_list arglist;
 
scripts/mod/modpost.h +2 -1
index 69baf014da4f..9fe974dc1a52 100644
@@ -197,7 +197,8 @@ enum loglevel {
 	LOG_FATAL
 };
 
-void modpost_log(enum loglevel loglevel, const char *fmt, ...);
+void __attribute__((format(printf, 2, 3)))
+modpost_log(enum loglevel loglevel, const char *fmt, ...);
 
 /*
  * warn - show the given message, then let modpost continue running, still
Signature · 1 line
2.40.1