Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
Message-ID: <d988d85f-c704-96cd-13b6-7715ea5cacbb@gnuweeb.org>
Date:   Thu, 12 May 2022 23:14:35 +0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.8.1
Subject: Re: [PATCH 1/1] tools/nolibc/stdio: Add format attribute to enable
 printf warnings
Content-Language: en-US
To:     Alviro Iskandar Setiawan <alviro.iskandar@gnuweeb.org>
Cc:     GNU/Weeb Mailing List <gwml@vger.gnuweeb.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
References: <20220509065445.3912334-1-alviro.iskandar@gnuweeb.org>
 <20220509065445.3912334-2-alviro.iskandar@gnuweeb.org>
From:   Ammar Faizi <ammarfaizi2@gnuweeb.org>
In-Reply-To: <20220509065445.3912334-2-alviro.iskandar@gnuweeb.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk

I will send it to Willy soon.

Anyway, __attribute__ can have multiple arguments, so no need
to write it twice. I simplified it, the end result patch below...

Thank you!

---
 From 7998cda9acdbfec6d6ba73642c27d710996c27ed Mon Sep 17 00:00:00 2001
From: Alviro Iskandar Setiawan <alviro.iskandar@gnuweeb.org>
Subject: tools/nolibc/stdio: Add format attribute to enable printf warnings

When we use printf and fprintf functions from the nolibc, we don't
get any warning from the compiler if we have the wrong arguments.
For example, the following calls will compile silently:
```
   printf("%s %s\n", "aaa");
   fprintf(stdout, "%s %s\n", "xxx", 1);
```
(Note the wrong arguments).

Those calls are undefined behavior. The compiler can help us warn
about the above mistakes by adding a `printf` format attribute to
those functions declaration. This patch adds it, and now it yields
these warnings for those mistakes:
```
   warning: format `%s` expects a matching `char *` argument [-Wformat=]
   warning: format `%s` expects argument of type `char *`, but argument 4 has type `int` [-Wformat=]
```

[ammarfaizi2: Simplify the attribute placement.]

Signed-off-by: Alviro Iskandar Setiawan <alviro.iskandar@gnuweeb.org>
Signed-off-by: Ammar Faizi <ammarfaizi2@gnuweeb.org>
---
  tools/include/nolibc/stdio.h | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/tools/include/nolibc/stdio.h b/tools/include/nolibc/stdio.h
index 15dedf8d0902..a3cebc4bc3ac 100644
--- a/tools/include/nolibc/stdio.h
+++ b/tools/include/nolibc/stdio.h
@@ -273,7 +273,7 @@ int vfprintf(FILE *stream, const char *fmt, va_list args)
  	return written;
  }
  
-static __attribute__((unused))
+static __attribute__((unused, format(printf, 2, 3)))
  int fprintf(FILE *stream, const char *fmt, ...)
  {
  	va_list args;
@@ -285,7 +285,7 @@ int fprintf(FILE *stream, const char *fmt, ...)
  	return ret;
  }
  
-static __attribute__((unused))
+static __attribute__((unused, format(printf, 1, 2)))
  int printf(const char *fmt, ...)
  {
  	va_list args;


-- 
Ammar Faizi