Skip to contentSkip to conversation

tools/libs/stat: fix broken build

PATCH In review Juergen Gross 5 participants 14 messages Sep 12, 2020 – Oct 2, 2020

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 tools/libs/stat: fix broken build

Making getBridge() static triggered a build error with some gcc versions:

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")
---
 tools/libs/stat/xenstat_linux.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
tools/libs/stat/xenstat_linux.c +2 -2
index 793263f2b6..d2ee6fda64 100644
@@ -78,7 +78,7 @@ static void getBridge(char *excludeName, char *result, size_t resultLen)
 				sprintf(tmp, "/sys/class/net/%s/bridge", de->d_name);
 
 				if (access(tmp, F_OK) == 0) {
-					strncpy(result, de->d_name, resultLen - 1);
+					strncpy(result, de->d_name, resultLen);
 					result[resultLen - 1] = 0;
 				}
 		}
@@ -264,7 +264,7 @@ int xenstat_collect_networks(xenstat_node * node)
 {
 	/* Helper variables for parseNetDevLine() function defined above */
 	int i;
-	char line[512] = { 0 }, iface[16] = { 0 }, devBridge[16] = { 0 }, devNoBridge[17] = { 0 };
+	char line[512] = { 0 }, iface[16] = { 0 }, devBridge[256] = { 0 }, devNoBridge[257] = { 0 };
 	unsigned long long rxBytes, rxPackets, rxErrs, rxDrops, txBytes, txPackets, txErrs, txDrops;
 
 	struct priv_data *priv = get_priv_data(node->handle);
Signature · 1 line
2.26.2
Acked-by on v3 1/1
#1 lore raw
Quoted 9 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")
Reviewed-by on v3 1/1
#2 lore raw
In reply to Juergen Gross
Quoted 13 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")
Quoted 30 lines

---
tools/libs/stat/xenstat_linux.c | 4 ++--

1 file changed, 2 insertions(+), 2 deletions(-)
tools/libs/stat/xenstat_linux.c +2 -2
index 793263f2b6..d2ee6fda64 100644
@@ -78,7 +78,7 @@ static void getBridge(char *excludeName, char *result, size_t resultLen)
 				sprintf(tmp, "/sys/class/net/%s/bridge", de->d_name);
 
 				if (access(tmp, F_OK) == 0) {
-					strncpy(result, de->d_name, resultLen - 1);
+					strncpy(result, de->d_name, resultLen);
 					result[resultLen - 1] = 0;
 				}
 		}
@@ -264,7 +264,7 @@ int xenstat_collect_networks(xenstat_node * node)
 {
 	/* Helper variables for parseNetDevLine() function defined above */
 	int i;
-	char line[512] = { 0 }, iface[16] = { 0 }, devBridge[16] = { 0 }, devNoBridge[17] = { 0 };
+	char line[512] = { 0 }, iface[16] = { 0 }, devBridge[256] = { 0 }, devNoBridge[257] = { 0 };
 	unsigned long long rxBytes, rxPackets, rxErrs, rxDrops, txBytes, txPackets, txErrs, txDrops;
 
 	struct priv_data *priv = get_priv_data(node->handle);
Signature · 1 line
2.26.2
#3 lore raw

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

Regards
Bertrand

Quoted 32 lines
Quoted 31 lines

---
tools/libs/stat/xenstat_linux.c | 4 ++--

1 file changed, 2 insertions(+), 2 deletions(-)
tools/libs/stat/xenstat_linux.c +2 -2
index 793263f2b6..d2ee6fda64 100644
@@ -78,7 +78,7 @@ static void getBridge(char *excludeName, char *result, size_t resultLen)
 				sprintf(tmp, "/sys/class/net/%s/bridge", de->d_name);
 
 				if (access(tmp, F_OK) == 0) {
-					strncpy(result, de->d_name, resultLen - 1);
+					strncpy(result, de->d_name, resultLen);
 					result[resultLen - 1] = 0;
 				}
 		}
@@ -264,7 +264,7 @@ int xenstat_collect_networks(xenstat_node * node)
 {
 	/* Helper variables for parseNetDevLine() function defined above */
 	int i;
-	char line[512] = { 0 }, iface[16] = { 0 }, devBridge[16] = { 0 }, devNoBridge[17] = { 0 };
+	char line[512] = { 0 }, iface[16] = { 0 }, devBridge[256] = { 0 }, devNoBridge[257] = { 0 };
 	unsigned long long rxBytes, rxPackets, rxErrs, rxDrops, txBytes, txPackets, txErrs, txDrops;
 
 	struct priv_data *priv = get_priv_data(node->handle);
Signature · 1 line
2.26.2
#4 lore raw
Quoted 21 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

Quoted 7 lines

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

Making devBridge one byte longer would be dangerous, as this would do a strncpy with length of 257 from a source with a length of 256 bytes only.

BTW, I think Andrew? has tested my patch with a recent gcc which threw the original error without my patch, and it was fine with the patch. Either your compiler (assuming you are using gcc) has gained that error or you are missing an update fixing it.

Juergen

#5 lore raw
Quoted 28 lines · Jürgen Groß
Quoted 27 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Quoted 6 lines
Quoted 1 line

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

That's a matter of how you look at it, I think: If the original array doesn't hold a nul-terminated string, the destination array won't either, yet the common goal of strncpy() is to yield a properly nul- terminated string. IOW the warning may be since the standard even has a specific foot note to point out this possible pitfall.

Jan

#6 lore raw
Quoted 33 lines · Jan Beulich
Quoted 32 lines · Jürgen Groß
Quoted 21 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

Quoted 7 lines

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

Quoted 8 lines
Quoted 2 lines

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

That's a matter of how you look at it, I think: If the original array doesn't hold a nul-terminated string, the destination array won't either, yet the common goal of strncpy() is to yield a properly nul- terminated string. IOW the warning may be since the standard even has a specific foot note to point out this possible pitfall.

If the source doesn't hold a nul-terminated string there will still be 256 bytes copied, so there is no truncation done during strncpy().

In fact there is no way to use strncpy() in a safe way on a fixed sized source array with the above semantics: either the target is larger than the source and length is at least sizeof(source) + 1, resulting in a possible read beyond the end of source, or the target is the same length leading to the error.

Juergen

#7 lore raw
Quoted 43 lines · Jürgen Groß
Quoted 33 lines · Jan Beulich
Quoted 32 lines · Jürgen Groß
Quoted 21 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

Quoted 7 lines

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

Quoted 8 lines
Quoted 2 lines

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

That's a matter of how you look at it, I think: If the original array doesn't hold a nul-terminated string, the destination array won't either, yet the common goal of strncpy() is to yield a properly nul- terminated string. IOW the warning may be since the standard even has a specific foot note to point out this possible pitfall.

Quoted 8 lines

If the source doesn't hold a nul-terminated string there will still be 256 bytes copied, so there is no truncation done during strncpy().

In fact there is no way to use strncpy() in a safe way on a fixed sized source array with the above semantics: either the target is larger than the source and length is at least sizeof(source) + 1, resulting in a possible read beyond the end of source, or the target is the same length leading to the error.

I agree with all of what you say, but I can also see why said foot note alone may have motivated the emission of the warning.

Jan

#8 lore raw
Quoted 47 lines · Jan Beulich
Quoted 46 lines · Jürgen Groß
Quoted 33 lines · Jan Beulich
Quoted 32 lines · Jürgen Groß
Quoted 21 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

Quoted 7 lines

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

Quoted 8 lines
Quoted 2 lines

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

That's a matter of how you look at it, I think: If the original array doesn't hold a nul-terminated string, the destination array won't either, yet the common goal of strncpy() is to yield a properly nul- terminated string. IOW the warning may be since the standard even has a specific foot note to point out this possible pitfall.

If the source doesn't hold a nul-terminated string there will still be 256 bytes copied, so there is no truncation done during strncpy().

Quoted 8 lines
Quoted 5 lines

In fact there is no way to use strncpy() in a safe way on a fixed sized source array with the above semantics: either the target is larger than the source and length is at least sizeof(source) + 1, resulting in a possible read beyond the end of source, or the target is the same length leading to the error.

I agree with all of what you say, but I can also see why said foot note alone may have motivated the emission of the warning.

The motivation can be explained, yes, but it is wrong. strncpy() is not limited to source arrays of unknown length. So this warning is making strncpy() unusable for fixed sized source strings and -Werror. And that is nothing a compiler should be allowed to do, hence a compiler bug.

Juergen

#9 lore raw

Hi,

Quoted 55 lines · Jürgen Groß
Quoted 52 lines · Jan Beulich
Quoted 51 lines · Jürgen Groß
Quoted 33 lines · Jan Beulich
Quoted 32 lines · Jürgen Groß
Quoted 21 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

Quoted 7 lines

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

Quoted 8 lines
Quoted 2 lines

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

That's a matter of how you look at it, I think: If the original array doesn't hold a nul-terminated string, the destination array won't either, yet the common goal of strncpy() is to yield a properly nul- terminated string. IOW the warning may be since the standard even has a specific foot note to point out this possible pitfall.

If the source doesn't hold a nul-terminated string there will still be 256 bytes copied, so there is no truncation done during strncpy().

In fact there is no way to use strncpy() in a safe way on a fixed sized source array with the above semantics: either the target is larger than the source and length is at least sizeof(source) + 1, resulting in a possible read beyond the end of source, or the target is the same length leading to the error.

Quoted 7 lines
Quoted 2 lines

I agree with all of what you say, but I can also see why said foot note alone may have motivated the emission of the warning.

The motivation can be explained, yes, but it is wrong. strncpy() is not limited to source arrays of unknown length. So this warning is making strncpy() unusable for fixed sized source strings and -Werror. And that is nothing a compiler should be allowed to do, hence a compiler bug.

I do agree that in this case the compiler is doing to much.

We could also choose to turn off the warning either using pragma (which i really do not like) or by adding a cflag for this specific file (but this might hit us later in other places).

All in all this currently makes Xen master and staging not possible to compile with Yocto so we need to find a solution as this will also come in any distribution using a new compiler,

Cheers
Bertrand

#10 lore raw
Quoted 60 lines · Bertrand Marquis

Hi,

Quoted 58 lines · Jürgen Groß
Quoted 54 lines · Jan Beulich
Quoted 43 lines · Jürgen Groß
Quoted 33 lines · Jan Beulich
Quoted 32 lines · Jürgen Groß
Quoted 21 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

Quoted 7 lines

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

Quoted 8 lines
Quoted 2 lines

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

That's a matter of how you look at it, I think: If the original array doesn't hold a nul-terminated string, the destination array won't either, yet the common goal of strncpy() is to yield a properly nul- terminated string. IOW the warning may be since the standard even has a specific foot note to point out this possible pitfall.

Quoted 8 lines

If the source doesn't hold a nul-terminated string there will still be 256 bytes copied, so there is no truncation done during strncpy().

In fact there is no way to use strncpy() in a safe way on a fixed sized source array with the above semantics: either the target is larger than the source and length is at least sizeof(source) + 1, resulting in a possible read beyond the end of source, or the target is the same length leading to the error.

I agree with all of what you say, but I can also see why said foot note alone may have motivated the emission of the warning.

Quoted 6 lines
Quoted 4 lines

The motivation can be explained, yes, but it is wrong. strncpy() is not limited to source arrays of unknown length. So this warning is making strncpy() unusable for fixed sized source strings and -Werror. And that is nothing a compiler should be allowed to do, hence a compiler bug.

I do agree that in this case the compiler is doing to much.

It is plain wrong here. Rendering a Posix defined function unusable for a completely legal use case is in no way a matter of taste or of "doing to much". It is a bug.

Quoted 7 lines

We could also choose to turn off the warning either using pragma (which i really do not like) or by adding a cflag for this specific file (but this might hit us later in other places).

All in all this currently makes Xen master and staging not possible to compile with Yocto so we need to find a solution as this will also come in any distribution using a new compiler,

A variant you didn't mention would be open coding of strncpy() (or having a related inline function in a common header). This route would be the one I'd prefer in case the compiler guys insist on the behavior being fine.

You didn't tell us which compiler is being used and whether it really is up to date. A workaround might be to set EXTRA_CFLAGS_XEN_TOOLS to "-Wno-stringop-truncation" for the build.

Juergen

#11 lore raw
Quoted 68 lines · Jürgen Groß
Quoted 63 lines · Bertrand Marquis

Hi,

Quoted 62 lines · Jürgen Groß
Quoted 47 lines · Jan Beulich
Quoted 46 lines · Jürgen Groß
Quoted 33 lines · Jan Beulich
Quoted 32 lines · Jürgen Groß
Quoted 21 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

Quoted 7 lines

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

Quoted 8 lines
Quoted 2 lines

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

That's a matter of how you look at it, I think: If the original array doesn't hold a nul-terminated string, the destination array won't either, yet the common goal of strncpy() is to yield a properly nul- terminated string. IOW the warning may be since the standard even has a specific foot note to point out this possible pitfall.

If the source doesn't hold a nul-terminated string there will still be 256 bytes copied, so there is no truncation done during strncpy().

Quoted 7 lines
Quoted 5 lines

In fact there is no way to use strncpy() in a safe way on a fixed sized source array with the above semantics: either the target is larger than the source and length is at least sizeof(source) + 1, resulting in a possible read beyond the end of source, or the target is the same length leading to the error.

I agree with all of what you say, but I can also see why said foot note alone may have motivated the emission of the warning.

The motivation can be explained, yes, but it is wrong. strncpy() is not limited to source arrays of unknown length. So this warning is making strncpy() unusable for fixed sized source strings and -Werror. And that is nothing a compiler should be allowed to do, hence a compiler bug.

Quoted 5 lines
Quoted 1 line

I do agree that in this case the compiler is doing to much.

It is plain wrong here. Rendering a Posix defined function unusable for a completely legal use case is in no way a matter of taste or of "doing to much". It is a bug.

Agree.

Quoted 8 lines
Quoted 7 lines

We could also choose to turn off the warning either using pragma (which i really do not like) or by adding a cflag for this specific file (but this might hit us later in other places).
All in all this currently makes Xen master and staging not possible to compile with Yocto so we need to find a solution as this will also come in any distribution using a new compiler,

Quoted 4 lines

A variant you didn't mention would be open coding of strncpy() (or having a related inline function in a common header). This route would be the one I'd prefer in case the compiler guys insist on the behavior being fine.

True this possible, even though I do not like to modify the code that deeply for one specific compiler.

Quoted 4 lines

You didn't tell us which compiler is being used and whether it really is up to date. A workaround might be to set EXTRA_CFLAGS_XEN_TOOLS to "-Wno-stringop-truncation" for the build.

That’s what i meant by “adding a cflag”, as you suggest we could also make it global (and not limit it to this file).

The compiler I am using is the one from Yocto Gatesgarth (release coming in october): gcc version 10.2.0 (released in july 2020).

Cheers

Bertrand

#12 lore raw
Quoted 101 lines · Bertrand Marquis
Quoted 69 lines · Jürgen Groß
Quoted 63 lines · Bertrand Marquis

Hi,

Quoted 62 lines · Jürgen Groß
Quoted 47 lines · Jan Beulich
Quoted 46 lines · Jürgen Groß
Quoted 33 lines · Jan Beulich
Quoted 32 lines · Jürgen Groß
Quoted 21 lines · Bertrand Marquis

Hi Juergen,

Quoted 8 lines · Bertrand Marquis
Quoted 7 lines · Juergen Gross

Making getBridge() static triggered a build error with some gcc versions:

Quoted 8 lines
Quoted 7 lines

error: 'strncpy' output may be truncated copying 15 bytes from a string of length 255 [-Werror=stringop-truncation]

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new tools/libs/stat directory")

Sorry i have to come back on this one.

Quoted 7 lines

I still see an error compiling with Yocto on this one:

|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

Quoted 8 lines
Quoted 2 lines

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

That's a matter of how you look at it, I think: If the original array doesn't hold a nul-terminated string, the destination array won't either, yet the common goal of strncpy() is to yield a properly nul- terminated string. IOW the warning may be since the standard even has a specific foot note to point out this possible pitfall.

If the source doesn't hold a nul-terminated string there will still be 256 bytes copied, so there is no truncation done during strncpy().

Quoted 7 lines
Quoted 5 lines

In fact there is no way to use strncpy() in a safe way on a fixed sized source array with the above semantics: either the target is larger than the source and length is at least sizeof(source) + 1, resulting in a possible read beyond the end of source, or the target is the same length leading to the error.

I agree with all of what you say, but I can also see why said foot note alone may have motivated the emission of the warning.

The motivation can be explained, yes, but it is wrong. strncpy() is not limited to source arrays of unknown length. So this warning is making strncpy() unusable for fixed sized source strings and -Werror. And that is nothing a compiler should be allowed to do, hence a compiler bug.

Quoted 5 lines
Quoted 1 line

I do agree that in this case the compiler is doing to much.

It is plain wrong here. Rendering a Posix defined function unusable for a completely legal use case is in no way a matter of taste or of "doing to much". It is a bug.

Agree.

Quoted 8 lines
Quoted 7 lines

We could also choose to turn off the warning either using pragma (which i really do not like) or by adding a cflag for this specific file (but this might hit us later in other places).
All in all this currently makes Xen master and staging not possible to compile with Yocto so we need to find a solution as this will also come in any distribution using a new compiler,

Quoted 4 lines

A variant you didn't mention would be open coding of strncpy() (or having a related inline function in a common header). This route would be the one I'd prefer in case the compiler guys insist on the behavior being fine.

True this possible, even though I do not like to modify the code that deeply for one specific compiler.

Quoted 4 lines

You didn't tell us which compiler is being used and whether it really is up to date. A workaround might be to set EXTRA_CFLAGS_XEN_TOOLS to "-Wno-stringop-truncation" for the build.

Quoted 5 lines

That’s what i meant by “adding a cflag”, as you suggest we could also make it global (and not limit it to this file).

The compiler I am using is the one from Yocto Gatesgarth (release coming in october): gcc version 10.2.0 (released in july 2020).

After some discussion, I will propose a patch to solve the issue using memcpy instead of strncpy as in this specific case we know that we can truncate the string.
This will also allow to revert the big buffers in stack.

Cheers
Bertrand

#13 lore raw
In reply to Jürgen Groß
Quoted 41 lines · Jürgen Groß
Quoted 30 lines · Bertrand Marquis

Hi Juergen,

Quoted 14 lines
Quoted 9 lines · Bertrand Marquis

On 12 Sep 2020, at 14:08, Juergen Gross <[email protected]> wrote:

Making getBridge() static triggered a build error with some gcc versions:

error: 'strncpy' output may be truncated copying 15 bytes from a string of
length 255 [-Werror=stringop-truncation]

Quoted 6 lines
Quoted 5 lines

Fix that by using a buffer with 256 bytes instead.

Fixes 6d0ec053907794 ("tools: split libxenstat into new

tools/libs/stat directory")

Sorry i have to come back on this one.

I still see an error compiling with Yocto on this one:
|     inlined from 'xenstat_collect_networks' at xenstat_linux.c:306:2:
| xenstat_linux.c:81:6: error: 'strncpy' output may be truncated copying 255 bytes from a string of length 255 [-Werror=stringop-truncation]

Quoted 4 lines
|    81 |      strncpy(result, de->d_name, resultLen);
|       |      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To solve it, I need to define devBridge[257] as devNoBrideg.

IMHO this is a real compiler error.

de->d_name is an array of 256 bytes, so doing strncpy() from that to another array of 256 bytes with a length of 256 won't truncate anything.

Quoted 8 lines

Making devBridge one byte longer would be dangerous, as this would do a strncpy with length of 257 from a source with a length of 256 bytes only.

BTW, I think Andrew? has tested my patch with a recent gcc which threw the original error without my patch, and it was fine with the patch. Either your compiler (assuming you are using gcc) has gained that error or you are missing an update fixing it.

All I was doing was using the gitlab CI, and reporting the failing tests.

~Andrew