Re: [PATCH] kconfig: handle format string before calling conf_message_callback()

From: Dirk Gouders
Date: Tue Jul 17 2018 - 09:52:24 EST


Masahiro Yamada <yamada.masahiro@xxxxxxxxxxxxx> writes:

> As you see in mconf.c and nconf.c, conf_message_callback() hooks are
> likely to end up with the boilerplate of vsnprintf(). Process the
> string format before calling conf_message_callback() so that it
> receives a simple string.

I looked at and tested this patch and found no issues -- perhaps: except
that it seems to require another series:

kbuild/kconfig: do not update config during installation

Dirk

> Signed-off-by: Masahiro Yamada <yamada.masahiro@xxxxxxxxxxxxx>
> ---
>
> scripts/kconfig/confdata.c | 17 +++++++++++------
> scripts/kconfig/lkc_proto.h | 2 +-
> scripts/kconfig/mconf.c | 9 +++------
> scripts/kconfig/nconf.c | 7 ++-----
> 4 files changed, 17 insertions(+), 18 deletions(-)
>
> diff --git a/scripts/kconfig/confdata.c b/scripts/kconfig/confdata.c
> index 5af25a0..d0988a9 100644
> --- a/scripts/kconfig/confdata.c
> +++ b/scripts/kconfig/confdata.c
> @@ -105,16 +105,16 @@ static void conf_warning(const char *fmt, ...)
> conf_warnings++;
> }
>
> -static void conf_default_message_callback(const char *fmt, va_list ap)
> +static void conf_default_message_callback(const char *s)
> {
> printf("#\n# ");
> - vprintf(fmt, ap);
> + printf("%s", s);
> printf("\n#\n");
> }
>
> -static void (*conf_message_callback) (const char *fmt, va_list ap) =
> +static void (*conf_message_callback)(const char *s) =
> conf_default_message_callback;
> -void conf_set_message_callback(void (*fn) (const char *fmt, va_list ap))
> +void conf_set_message_callback(void (*fn)(const char *s))
> {
> conf_message_callback = fn;
> }
> @@ -122,10 +122,15 @@ void conf_set_message_callback(void (*fn) (const char *fmt, va_list ap))
> static void conf_message(const char *fmt, ...)
> {
> va_list ap;
> + char buf[4096];
> +
> + if (!conf_message_callback)
> + return;
>
> va_start(ap, fmt);
> - if (conf_message_callback)
> - conf_message_callback(fmt, ap);
> +
> + vsnprintf(buf, sizeof(buf), fmt, ap);
> + conf_message_callback(buf);
> va_end(ap);
> }
>
> diff --git a/scripts/kconfig/lkc_proto.h b/scripts/kconfig/lkc_proto.h
> index b0cd52f..86c2675 100644
> --- a/scripts/kconfig/lkc_proto.h
> +++ b/scripts/kconfig/lkc_proto.h
> @@ -10,7 +10,7 @@ int conf_write(const char *name);
> int conf_write_autoconf(int overwrite);
> bool conf_get_changed(void);
> void conf_set_changed_callback(void (*fn)(void));
> -void conf_set_message_callback(void (*fn)(const char *fmt, va_list ap));
> +void conf_set_message_callback(void (*fn)(const char *s));
>
> /* menu.c */
> extern struct menu rootmenu;
> diff --git a/scripts/kconfig/mconf.c b/scripts/kconfig/mconf.c
> index 82b27a0..83b5836 100644
> --- a/scripts/kconfig/mconf.c
> +++ b/scripts/kconfig/mconf.c
> @@ -772,16 +772,13 @@ static void show_helptext(const char *title, const char *text)
> show_textbox(title, text, 0, 0);
> }
>
> -static void conf_message_callback(const char *fmt, va_list ap)
> +static void conf_message_callback(const char *s)
> {
> - char buf[PATH_MAX+1];
> -
> - vsnprintf(buf, sizeof(buf), fmt, ap);
> if (save_and_exit) {
> if (!silent)
> - printf("%s", buf);
> + printf("%s", s);
> } else {
> - show_textbox(NULL, buf, 6, 60);
> + show_textbox(NULL, s, 6, 60);
> }
> }
>
> diff --git a/scripts/kconfig/nconf.c b/scripts/kconfig/nconf.c
> index 208f7be..1ef232a 100644
> --- a/scripts/kconfig/nconf.c
> +++ b/scripts/kconfig/nconf.c
> @@ -1211,12 +1211,9 @@ static void conf(struct menu *menu)
> }
> }
>
> -static void conf_message_callback(const char *fmt, va_list ap)
> +static void conf_message_callback(const char *s)
> {
> - char buf[1024];
> -
> - vsnprintf(buf, sizeof(buf), fmt, ap);
> - btn_dialog(main_window, buf, 1, "<OK>");
> + btn_dialog(main_window, s, 1, "<OK>");
> }
>
> static void show_help(struct menu *menu)