modpost: rework and consolidate logging interface
PATCH 1/2 modpost: rework and consolidate logging interface
Rework modpost's logging interface by consolidating merror(), warn(), and fatal() to use a single function, modpost_log(). Introduce different logging levels (WARN, ERROR, FATAL) as well as a conditional warn (warn_unless()). The conditional warn is useful in determining whether to use merror() or warn() based on a condition. This reduces code duplication overall.
---
Hi,
This patch was added in response to the code duplication comments in the first version of "modpost: return error if module is missing ns imports and MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS=n" [1]
[1] See [email protected]
scripts/mod/modpost.c | 69 ++++++++++++++++++++++++--------------------------- scripts/mod/modpost.h | 22 +++++++++++++--- 2 files changed, 51 insertions(+), 40 deletions(-)
scripts/mod/modpost.c +32 -37
@@ -51,41 +51,39 @@ enum export {#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr)) -#define PRINTF __attribute__ ((format (printf, 1, 2))) +#define PRINTF __attribute__ ((format (printf, 2, 3))) -PRINTF void fatal(const char *fmt, ...) +PRINTF void modpost_log(enum loglevel loglevel, const char *fmt, ...) { +char *level =NULL ;va_list arglist; -fprintf (stderr,"FATAL: " ); +switch (loglevel) { +case (LOG_WARN ): + level ="WARNING: " ; +break ; +case (LOG_ERROR ): + level ="ERROR: " ; +break ; +case (LOG_FATAL ): + level ="FATAL: " ; +break ; +default :/* invalid loglevel, ignore */ +break ; + } -va_start (arglist, fmt); -vfprintf (stderr, fmt, arglist); -va_end (arglist); +if (level) +fprintf (stderr, level); -exit (1 ); -} - -PRINTF void warn(const char *fmt, ...) -{ -va_list arglist; - -fprintf (stderr,"WARNING: " ); +fprintf (stderr,"modpost: " );va_start (arglist, fmt);vfprintf (stderr, fmt, arglist);va_end (arglist); -} - -PRINTF void merror(const char *fmt, ...) -{ -va_list arglist; -fprintf (stderr,"ERROR: " ); +if (loglevel ==LOG_FATAL ) +exit (1 ); -va_start (arglist, fmt); -vfprintf (stderr, fmt, arglist); -va_end (arglist); }static inline bool strends (const char *str,const char *postfix)
@@ -113,7 +111,7 @@ static int is_vmlinux(const char *modname)void *do_nofail (void *ptr,const char *expr) {if (!ptr) -fatal ("modpost: Memory allocation failure: %s.\n" , expr); +fatal ("Memory allocation failure: %s.\n" , expr);return ptr; }
@@ -2021,7 +2019,7 @@ static void read_symbols(const char *modname) license =get_modinfo (&info,"license" );if (!license && !is_vmlinux (modname)) -warn ("modpost: missing MODULE_LICENSE() in %s\n" +warn ("missing MODULE_LICENSE() in %s\n" "see include/linux/module.h for " "more information\n" , modname);while (license) {
@@ -2152,15 +2150,15 @@ static void check_for_gpl_usage(enum export exp, const char *m, const char *s)switch (exp) {case export_gpl: -fatal ("modpost: GPL-incompatible module %s%s " +fatal ("GPL-incompatible module %s%s " "uses GPL-only symbol '%s'\n" , m, e, s);break ;case export_unused_gpl: -fatal ("modpost: GPL-incompatible module %s%s " +fatal ("GPL-incompatible module %s%s " "uses GPL-only symbol marked UNUSED '%s'\n" , m, e, s);break ;case export_gpl_future: -warn ("modpost: GPL-incompatible module %s%s " +warn ("GPL-incompatible module %s%s " "uses future GPL-only symbol '%s'\n" , m, e, s);break ;case export_plain:
@@ -2178,7 +2176,7 @@ static void check_for_unused(enum export exp, const char *m, const char *s)switch (exp) {case export_unused:case export_unused_gpl: -warn ("modpost: module %s%s " +warn ("module %s%s " "uses symbol '%s' marked UNUSED\n" , m, e, s);break ;default :
@@ -2197,14 +2195,11 @@ static int check_exports(struct module *mod) exp =find_symbol (s->name);if (!exp || exp->module == mod) {if (have_vmlinux && !s->weak) { -if (warn_unresolved) { -warn ("\"%s\" [%s.ko] undefined!\n" , - s->name, mod->name); - }else { -merror ("\"%s\" [%s.ko] undefined!\n" , - s->name, mod->name); +warn_unless (!warn_unresolved, +"\"%s\" [%s.ko] undefined!\n" , + s->name, mod->name); +if (!warn_unresolved) err =1 ; - } }continue ; }
@@ -2653,7 +2648,7 @@ int main(int argc, char **argv)if (dump_write)write_dump (dump_write);if (sec_mismatch_count && sec_mismatch_fatal) -fatal ("modpost: Section mismatches detected.\n" +fatal ("Section mismatches detected.\n" "Set CONFIG_SECTION_MISMATCH_WARN_ONLY=y to allow them.\n" );for (n =0 ; n <SYMBOL_HASH_SIZE ; n++) {struct symbol *s;
scripts/mod/modpost.h +19 -3
@@ -198,6 +198,22 @@ void *grab_file(const char *filename, unsigned long *size);char *get_next_line (unsigned long *pos,void *file,unsigned long size);void release_file (void *file,unsigned long size); -void fatal (const char *fmt, ...); -void warn (const char *fmt, ...); -void merror (const char *fmt, ...); +enum loglevel { +LOG_WARN , +LOG_ERROR , +LOG_FATAL +}; + +void modpost_log (enum loglevel loglevel,const char *fmt, ...); + +#define warn(fmt, args...) modpost_log(LOG_WARN, fmt, ##args) +#define merror(fmt, args...) modpost_log(LOG_ERROR, fmt, ##args) +#define fatal(fmt, args...) modpost_log(LOG_FATAL, fmt, ##args) +/* Warn unless condition is true, then use merror() */ +#define warn_unless(condition, fmt, args...) \ +do { \ + if (condition) \ + merror(fmt, ##args); \ + else \ + warn(fmt, ##args); \ +} while (0)
Signature · 1 line
2.16.4
PATCH 2/2 modpost: return error if module is missing ns imports and MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS=n
Currently when CONFIG_MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS=n, modpost only warns when a module is missing namespace imports. Under this configuration, such a module cannot be loaded into the kernel anyway, as the module loader would reject it. We might as well return a build error when a module is missing namespace imports under CONFIG_MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS=n, so that the build warning does not go ignored/unnoticed.
--- scripts/Makefile.modpost | 15 ++++++++------- scripts/mod/modpost.c | 14 +++++++++++--- 2 files changed, 19 insertions(+), 10 deletions(-)
scripts/Makefile.modpost +8 -7
@@ -46,13 +46,14 @@ include scripts/Kbuild.include kernelsymfile := $(objtree)/Module.symvers modulesymfile := $(firstword $(KBUILD_EXTMOD))/Module.symvers -MODPOST = scripts/mod/modpost \ - $(if $(CONFIG_MODVERSIONS),-m) \ - $(if $(CONFIG_MODULE_SRCVERSION_ALL),-a) \ - $(if $(KBUILD_EXTMOD),-i,-o) $(kernelsymfile) \ - $(if $(KBUILD_EXTMOD),$(addprefix -e ,$(KBUILD_EXTRA_SYMBOLS))) \ - $(if $(KBUILD_EXTMOD),-o $(modulesymfile)) \ - $(if $(CONFIG_SECTION_MISMATCH_WARN_ONLY),,-E) \ +MODPOST = scripts/mod/modpost \ + $(if $(CONFIG_MODVERSIONS),-m) \ + $(if $(CONFIG_MODULE_SRCVERSION_ALL),-a) \ + $(if $(KBUILD_EXTMOD),-i,-o) $(kernelsymfile) \ + $(if $(KBUILD_EXTMOD),$(addprefix -e ,$(KBUILD_EXTRA_SYMBOLS))) \ + $(if $(KBUILD_EXTMOD),-o $(modulesymfile)) \ + $(if $(CONFIG_SECTION_MISMATCH_WARN_ONLY),,-E) \ + $(if $(CONFIG_MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS)$(KBUILD_NSDEPS),-N) \ $(if $(KBUILD_MODPOST_WARN),-w) ifdef MODPOST_VMLINUX
scripts/mod/modpost.c +11 -3
@@ -39,6 +39,8 @@ static int sec_mismatch_count = 0;static int sec_mismatch_fatal =0 ;/* ignore missing files */ static int ignore_missing_files; +/* If set to 1, only warn (instead of error) about missing ns imports */ +static int allow_missing_ns_imports =0 ;enum export { export_plain, export_unused, export_gpl,
@@ -2211,8 +2213,11 @@ static int check_exports(struct module *mod)if (exp->namespace && !module_imports_namespace (mod, exp->namespace)) { -warn ("module %s uses symbol %s from namespace %s, but does not import it.\n" , - basename, exp->name, exp->namespace); +warn_unless (!allow_missing_ns_imports, +"module %s uses symbol %s from namespace %s, but does not import it.\n" , + basename, exp->name, exp->namespace); +if (!allow_missing_ns_imports) + err =1 ;add_namespace (&mod->missing_namespaces, exp->namespace); }
@@ -2555,7 +2560,7 @@ int main(int argc, char **argv)struct ext_sym_list *extsym_iter;struct ext_sym_list *extsym_start =NULL ; -while ((opt =getopt (argc, argv,"i:e:mnsT:o:awEd:" )) !=-1 ) { +while ((opt =getopt (argc, argv,"i:e:mnsT:o:awENd:" )) !=-1 ) {switch (opt) {case 'i' : kernel_read = optarg;
@@ -2593,6 +2598,9 @@ int main(int argc, char **argv)case 'E' : sec_mismatch_fatal =1 ;break ; +case 'N' : + allow_missing_ns_imports =1 ; +break ;case 'd' : missing_namespace_deps = optarg;break ;
Signature · 1 line
2.16.4
Quoted 6 lines · Jessica Yu
Rework modpost's logging interface by consolidating
merror(),warn(), andfatal()to use a single function,modpost_log(). Introduce different logging levels (WARN, ERROR, FATAL) as well as a conditional warn (warn_unless()). The conditional warn is useful in determining whether to usemerror()orwarn()based on a condition. This reduces code duplication overall.
[]
scripts/mod/modpost.c
Quoted 1 line
scripts/mod/modpost.c +0
-0
[]
Quoted 16 lines
scripts/mod/modpost.c +5
-3@@ -51,41 +51,39 @@ enum export {#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr)) -#define PRINTF __attribute__ ((format (printf, 1, 2))) +#define PRINTF __attribute__ ((format (printf, 2, 3))) -PRINTF void fatal(const char *fmt, ...) +PRINTF void modpost_log(enum loglevel loglevel, const char *fmt, ...) { +char *level =NULL ;va_list arglist; -fprintf (stderr,"FATAL: " ); +switch (loglevel) { +case (LOG_WARN ):
scripts/mod/modpost.c enum export { · line 72
Quoted 10 lines
scripts/mod/modpost.c +10
-0+ level ="WARNING: " ; +break ; +case (LOG_ERROR ): + level ="ERROR: " ; +break ; +case (LOG_FATAL ): + level ="FATAL: " ; +break ; +default :/* invalid loglevel, ignore */ +break ;
Odd parentheses around case labels and
likely level should be initialized as ""
and not NULL.
const char *level = "";
...
switch (loglevel) {
case LOG_WARN:
level = "WARNING: ";
break;
...
}+++ Joe Perches [25/02/20 14:30 -0800]:
Quoted 41 lines · Jessica Yu
Quoted 6 lines
Rework modpost's logging interface by consolidating
merror(),warn(), andfatal()to use a single function,modpost_log(). Introduce different logging levels (WARN, ERROR, FATAL) as well as a conditional warn (warn_unless()). The conditional warn is useful in determining whether to usemerror()orwarn()based on a condition. This reduces code duplication overall.[]
scripts/mod/modpost.c
Quoted 1 line
scripts/mod/modpost.c +0
-0[]
Quoted 16 lines
scripts/mod/modpost.c +5
-3@@ -51,41 +51,39 @@ enum export {#define MODULE_NAME_LEN (64 - sizeof(Elf_Addr)) -#define PRINTF __attribute__ ((format (printf, 1, 2))) +#define PRINTF __attribute__ ((format (printf, 2, 3))) -PRINTF void fatal(const char *fmt, ...) +PRINTF void modpost_log(enum loglevel loglevel, const char *fmt, ...) { +char *level =NULL ;va_list arglist; -fprintf (stderr,"FATAL: " ); +switch (loglevel) { +case (LOG_WARN ):scripts/mod/modpost.c enum export { · line 72
Quoted 10 lines
scripts/mod/modpost.c +10
-0+ level ="WARNING: " ; +break ; +case (LOG_ERROR ): + level ="ERROR: " ; +break ; +case (LOG_FATAL ): + level ="FATAL: " ; +break ; +default :/* invalid loglevel, ignore */ +break ;Odd parentheses around case labels and
likely level should be initialized as ""
and not NULL.
Quoted 10 lines
const char *level = "";
...
switch (loglevel) {
case LOG_WARN:
level = "WARNING: ";
break;
...
}Thanks for the review! Will fix this in v2 shortly.
kbuild test robot
build botI love your patch! Perhaps something to improve:
Hi Jessica,
I love your patch! Perhaps something to improve:
[auto build test WARNING on kbuild/for-next]
[also build test WARNING on v5.6-rc3 next-20200225]
[if your patch is applied to the wrong git tree, please drop us a note to help improve the system. BTW, we also suggest to use '--base' option to specify the base tree in git format-patch, please see https://stackoverflow.com/a/37406982]
url: https://github.com/0day-ci/linux/commits/Jessica-Yu/modpost-rework-and-consolidate-logging-interface/20200226-040811 base: https://git.kernel.org/pub/scm/linux/kernel/git/masahiroy/linux-kbuild.git for-next config: x86_64-randconfig-s2-20200226 (attached as .config) compiler: gcc-5 (Ubuntu 5.5.0-12ubuntu1) 5.5.0 20171010 reproduce: # save the attached .config to linux build tree make ARCH=x86_64
If you fix the issue, kindly add following tag
All warnings (new ones prefixed by >>):
scripts/mod/modpost.c: In function 'modpost_log':
>> scripts/mod/modpost.c:76:3: warning: format not a string literal and no format arguments [-Wformat-security]
fprintf(stderr, level);
^171 real 10 user 8 sys 11.18% cpu make prepare
vim +76 scripts/mod/modpost.c
55
56 PRINTF void modpost_log(enum loglevel loglevel, const char *fmt, ...)
57 {
58 char *level = NULL;
59 va_list arglist;
60
61 switch(loglevel) {
62 case(LOG_WARN):
63 level = "WARNING: ";
64 break;
65 case(LOG_ERROR):
66 level = "ERROR: ";
67 break;
68 case(LOG_FATAL):
69 level = "FATAL: ";
70 break;
71 default: /* invalid loglevel, ignore */
72 break;
73 }
74
75 if (level)
> 76 fprintf(stderr, level);
77
78 fprintf(stderr, "modpost: ");
79
80 va_start(arglist, fmt);
81 vfprintf(stderr, fmt, arglist);
82 va_end(arglist);
83
84 if (loglevel == LOG_FATAL)
85 exit(1);
86 ---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org