Skip to contentSkip to conversation

examples/cmdline: fix build error with gcc 12

PATCH In review Bruce Richardson 5 participants 7 messages Jan 18, 2023 – Feb 20, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 examples/cmdline: fix build error with gcc 12

When building the example without libbsd and using the DPDK-provided strlcpy function, a compiler warning is emitted by GCC 12 about the copy of the parsed string into the resulting object. This is because the source from cmdline library is 128 bytes and the destination buffer is 64-bytes.

commands.c: In function 'cmd_obj_add_parsed':
.../__BUILDS/build-x86-generic/install/usr/local/include/rte_string_fns.h:61:24: warning: '%s' directive output may be truncated writing up to 127 bytes into a region of size 64 [-Wformat-truncation=]

   61 |         return (size_t)snprintf(dst, size, "%s", src);
      |                        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In file included from /usr/include/stdio.h:894,
from commands.c:7:
/usr/include/x86_64-linux-gnu/bits/stdio2.h:71:10: note: '__builtin_snprintf' output between 1 and 128 bytes into a destination of size 64

Multiple options are possible to fix this, but the one taken in this patch is to ensure truncation never occurs by setting the destination buffer size to be the same as that used by the cmdline library.

Fixes af75078fece3 ("first public release")
---
 examples/cmdline/parse_obj_list.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
examples/cmdline/parse_obj_list.h +2 -1
index 6516d3e2c2..1223ac1e8b 100644
@@ -12,8 +12,9 @@
 
 #include <sys/queue.h>
 #include <cmdline_parse.h>
+#include <cmdline_parse_string.h>
 
-#define OBJ_NAME_LEN_MAX 64
+#define OBJ_NAME_LEN_MAX sizeof(cmdline_fixed_string_t)
 
 struct object {
 	SLIST_ENTRY(object) next;
Signature · 1 line
2.34.1
#1 lore raw
Quoted 31 lines · Bruce Richardson

When building the example without libbsd and using the DPDK-provided strlcpy function, a compiler warning is emitted by GCC 12 about the copy of the parsed string into the resulting object. This is because the source from cmdline library is 128 bytes and the destination buffer is 64-bytes.

commands.c: In function 'cmd_obj_add_parsed':
.../__BUILDS/build-x86-generic/install/usr/local/include/rte_string_fns.h:61:24: warning: '%s' directive output may be truncated writing up to 127 bytes into a region of size 64 [-Wformat-truncation=]

   61 |         return (size_t)snprintf(dst, size, "%s", src);
      |                        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In file included from /usr/include/stdio.h:894,
from commands.c:7:
/usr/include/x86_64-linux-gnu/bits/stdio2.h:71:10: note: '__builtin_snprintf' output between 1 and 128 bytes into a destination of size 64

Multiple options are possible to fix this, but the one taken in this patch is to ensure truncation never occurs by setting the destination buffer size to be the same as that used by the cmdline library.

Fixes af75078fece3 ("first public release")
---
 examples/cmdline/parse_obj_list.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
examples/cmdline/parse_obj_list.h +0 -0
index 6516d3e2c2..1223ac1e8b 100644

examples/cmdline/parse_obj_list.h line 20

Quoted 10 lines
examples/cmdline/parse_obj_list.h +2 -1
@@ -12,8 +12,9 @@
 
 #include <sys/queue.h>
 #include <cmdline_parse.h>
+#include <cmdline_parse_string.h>
 
-#define OBJ_NAME_LEN_MAX 64
+#define OBJ_NAME_LEN_MAX sizeof(cmdline_fixed_string_t)
 
 struct object {
 	SLIST_ENTRY(object) next;

I confirm it solves the build warning, but what about to get rid of OBJ_NAME_LEN_MAX completely if the intentions is to make size same as cmdline library array:

diff --git a/examples/cmdline/parse_obj_list.c
b/examples/cmdline/parse_obj_list.c
index 959bcd14527e..7b24bfb035d7 100644
--- a/examples/cmdline/parse_obj_list.c
+++ b/examples/cmdline/parse_obj_list.c
@@ -46,7 +46,7 @@ parse_obj_list(cmdline_parse_token_hdr_t *tk, const
char *buf, void *res,

                 token_len++;

         SLIST_FOREACH(o, tkd->list, next) {
 -               if (token_len != strnlen(o->name, OBJ_NAME_LEN_MAX))
 +               if (token_len != strnlen(o->name, STR_TOKEN_SIZE))
                         continue;
                 if (strncmp(buf, o->name, token_len))
                         continue;
 @@ -91,7 +91,7 @@ int
complete_get_elt_obj_list(cmdline_parse_token_hdr_t *tk,
         if (!o)
                 return -1;

- len = strnlen(o->name, OBJ_NAME_LEN_MAX);

 +       len = strnlen(o->name, STR_TOKEN_SIZE);
         if ((len + 1) > size)
                 return -1;

diff --git a/examples/cmdline/parse_obj_list.h
b/examples/cmdline/parse_obj_list.h
index 6516d3e2c236..ba234601f106 100644
--- a/examples/cmdline/parse_obj_list.h
+++ b/examples/cmdline/parse_obj_list.h
@@ -12,12 +12,11 @@

#include <sys/queue.h>
#include <cmdline_parse.h>
-
-#define OBJ_NAME_LEN_MAX 64
+#include <cmdline_parse_string.h>

  struct object {
         SLIST_ENTRY(object) next;
 -       char name[OBJ_NAME_LEN_MAX];
 +       cmdline_fixed_string_t name;
         cmdline_ipaddr_t ip;

};

#2 lore raw
Quoted 40 lines · Ferruh Yigit
Quoted 39 lines · Bruce Richardson

When building the example without libbsd and using the DPDK-provided strlcpy function, a compiler warning is emitted by GCC 12 about the copy of the parsed string into the resulting object. This is because the source from cmdline library is 128 bytes and the destination buffer is 64-bytes.

commands.c: In function 'cmd_obj_add_parsed':
.../__BUILDS/build-x86-generic/install/usr/local/include/rte_string_fns.h:61:24: warning: '%s' directive output may be truncated writing up to 127 bytes into a region of size 64 [-Wformat-truncation=]

   61 |         return (size_t)snprintf(dst, size, "%s", src);
      |                        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In file included from /usr/include/stdio.h:894,
from commands.c:7:
/usr/include/x86_64-linux-gnu/bits/stdio2.h:71:10: note: '__builtin_snprintf' output between 1 and 128 bytes into a destination of size 64

Multiple options are possible to fix this, but the one taken in this patch is to ensure truncation never occurs by setting the destination buffer size to be the same as that used by the cmdline library.

Fixes af75078fece3 ("first public release")
---
 examples/cmdline/parse_obj_list.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
examples/cmdline/parse_obj_list.h +2 -1
index 6516d3e2c2..1223ac1e8b 100644
@@ -12,8 +12,9 @@
 
 #include <sys/queue.h>
 #include <cmdline_parse.h>
+#include <cmdline_parse_string.h>
 
-#define OBJ_NAME_LEN_MAX 64
+#define OBJ_NAME_LEN_MAX sizeof(cmdline_fixed_string_t)
 
Quoted 7 lines

examples/cmdline/parse_obj_list.h line 20

Quoted 2 lines
examples/cmdline/parse_obj_list.h +0 -0
 struct object {
 	SLIST_ENTRY(object) next;

I confirm it solves the build warning, but what about to get rid of OBJ_NAME_LEN_MAX completely if the intentions is to make size same as cmdline library array:

Sure.
Another potential fix is just to cast-away [(void)] the return value from strlcpy and allow truncation.

Olivier, as maintainer, what is your preferred fix here?

/Bruce

#3 lore raw
Quoted 7 lines · On Thu, 19 Jan 2023 08:59:10 +0000 Bruce Richardson…
Quoted 7 lines
Quoted 2 lines

struct object {
SLIST_ENTRY(object) next;

I confirm it solves the build warning, but what about to get rid of OBJ_NAME_LEN_MAX completely if the intentions is to make size same as cmdline library array:

Quoted 7 lines

Sure.
Another potential fix is just to cast-away [(void)] the return value from strlcpy and allow truncation.

Olivier, as maintainer, what is your preferred fix here?

/Bruce

Another option would be to use flex-array and not have fixed size.

#4 lore raw
Quoted 14 lines · Stephen Hemminger
Quoted 11 lines · On Thu, 19 Jan 2023 08:59:10 +0000 Bruce Richardson…
Quoted 7 lines
Quoted 2 lines

struct object {
SLIST_ENTRY(object) next;

I confirm it solves the build warning, but what about to get rid of OBJ_NAME_LEN_MAX completely if the intentions is to make size same as cmdline library array:

Sure.
Another potential fix is just to cast-away [(void)] the return value from strlcpy and allow truncation.

Quoted 5 lines
Quoted 3 lines

Olivier, as maintainer, what is your preferred fix here?

/Bruce

Another option would be to use flex-array and not have fixed size.

I think that would add too many other additional complications. At least using the static array makes the sizes clear and allows the compilers to warn about possible truncation so we have to explicitly deal with it.

Acked-by
#5 lore raw
In reply to Bruce Richardson

Hi,

Sorry for the late reply.

Quoted 48 lines · Bruce Richardson
Quoted 40 lines · Ferruh Yigit
Quoted 39 lines · Bruce Richardson

When building the example without libbsd and using the DPDK-provided strlcpy function, a compiler warning is emitted by GCC 12 about the copy of the parsed string into the resulting object. This is because the source from cmdline library is 128 bytes and the destination buffer is 64-bytes.

commands.c: In function 'cmd_obj_add_parsed':
.../__BUILDS/build-x86-generic/install/usr/local/include/rte_string_fns.h:61:24: warning: '%s' directive output may be truncated writing up to 127 bytes into a region of size 64 [-Wformat-truncation=]

   61 |         return (size_t)snprintf(dst, size, "%s", src);
      |                        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In file included from /usr/include/stdio.h:894,
from commands.c:7:
/usr/include/x86_64-linux-gnu/bits/stdio2.h:71:10: note: '__builtin_snprintf' output between 1 and 128 bytes into a destination of size 64

Multiple options are possible to fix this, but the one taken in this patch is to ensure truncation never occurs by setting the destination buffer size to be the same as that used by the cmdline library.

Fixes af75078fece3 ("first public release")
---
 examples/cmdline/parse_obj_list.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
examples/cmdline/parse_obj_list.h +2 -1
index 6516d3e2c2..1223ac1e8b 100644
@@ -12,8 +12,9 @@
 
 #include <sys/queue.h>
 #include <cmdline_parse.h>
+#include <cmdline_parse_string.h>
 
-#define OBJ_NAME_LEN_MAX 64
+#define OBJ_NAME_LEN_MAX sizeof(cmdline_fixed_string_t)
 
Quoted 7 lines

examples/cmdline/parse_obj_list.h line 20

Quoted 2 lines
examples/cmdline/parse_obj_list.h +0 -0
 struct object {
 	SLIST_ENTRY(object) next;

I confirm it solves the build warning, but what about to get rid of OBJ_NAME_LEN_MAX completely if the intentions is to make size same as cmdline library array:

Quoted 5 lines

Sure.
Another potential fix is just to cast-away [(void)] the return value from strlcpy and allow truncation.

Olivier, as maintainer, what is your preferred fix here?

I think you solution is good enough, given it's a dummy example.

Ferruh's comment about getting rid of OBJ_NAME_LEN_MAX is right, however I think in this case we should allocate the string and store a pointer to this string instead of having a size limited buffer.

Olivier

#6 lore raw

10/02/2023 12:26, Olivier Matz:

Quoted 59 lines

Hi,

Sorry for the late reply.

Quoted 48 lines · Bruce Richardson
Quoted 40 lines · Ferruh Yigit
Quoted 39 lines · Bruce Richardson

When building the example without libbsd and using the DPDK-provided strlcpy function, a compiler warning is emitted by GCC 12 about the copy of the parsed string into the resulting object. This is because the source from cmdline library is 128 bytes and the destination buffer is 64-bytes.

commands.c: In function 'cmd_obj_add_parsed':
.../__BUILDS/build-x86-generic/install/usr/local/include/rte_string_fns.h:61:24: warning: '%s' directive output may be truncated writing up to 127 bytes into a region of size 64 [-Wformat-truncation=]

   61 |         return (size_t)snprintf(dst, size, "%s", src);
      |                        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In file included from /usr/include/stdio.h:894,
from commands.c:7:
/usr/include/x86_64-linux-gnu/bits/stdio2.h:71:10: note: '__builtin_snprintf' output between 1 and 128 bytes into a destination of size 64

Multiple options are possible to fix this, but the one taken in this patch is to ensure truncation never occurs by setting the destination buffer size to be the same as that used by the cmdline library.

Fixes af75078fece3 ("first public release")
---
 examples/cmdline/parse_obj_list.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
examples/cmdline/parse_obj_list.h +2 -1
index 6516d3e2c2..1223ac1e8b 100644
@@ -12,8 +12,9 @@
 
 #include <sys/queue.h>
 #include <cmdline_parse.h>
+#include <cmdline_parse_string.h>
 
-#define OBJ_NAME_LEN_MAX 64
+#define OBJ_NAME_LEN_MAX sizeof(cmdline_fixed_string_t)
 
Quoted 7 lines

examples/cmdline/parse_obj_list.h line 20

Quoted 2 lines
examples/cmdline/parse_obj_list.h +0 -0
 struct object {
 	SLIST_ENTRY(object) next;

I confirm it solves the build warning, but what about to get rid of OBJ_NAME_LEN_MAX completely if the intentions is to make size same as cmdline library array:

Quoted 5 lines

Sure.
Another potential fix is just to cast-away [(void)] the return value from strlcpy and allow truncation.

Olivier, as maintainer, what is your preferred fix here?

Quoted 7 lines

I think you solution is good enough, given it's a dummy example.

Ferruh's comment about getting rid of OBJ_NAME_LEN_MAX is right, however I think in this case we should allocate the string and store a pointer to this string instead of having a size limited buffer.

Applied this simple patch.