[dpdk-dev] [PATCH 0/4] fixes for example app builds

[dpdk-dev] [PATCH 0/4] fixes for example app builds

[Bruce Richardson]

While helping prepare some patches for converting the DPDK examples to
build using pkg-config, a number of errors and warnings were encountered in
the example app builds. These patches fix those issues.

Bruce Richardson (4):
  power: make guest channel headers public
  examples/vm_power_manager: fix string truncation warning
  examples/mp_server: fix snprintf overflow
  examples/mp_server: clear string truncation warning

 .../multi_process/client_server_mp/mp_server/main.c   |  2 +-
 .../multi_process/client_server_mp/shared/common.h    |  2 +-
 examples/vm_power_manager/channel_manager.c           | 11 ++++++++---
 examples/vm_power_manager/channel_monitor.c           |  1 -
 examples/vm_power_manager/channel_monitor.h           |  2 +-
 examples/vm_power_manager/guest_cli/main.c            |  1 +
 .../vm_power_manager/guest_cli/vm_power_cli_guest.c   |  2 +-
 .../vm_power_manager/guest_cli/vm_power_cli_guest.h   |  2 +-
 examples/vm_power_manager/vm_power_cli.c              |  1 -
 lib/librte_power/guest_channel.c                      |  3 +--
 lib/librte_power/meson.build                          |  4 +++-
 lib/librte_power/power_kvm_vm.c                       |  3 +--
 ...hannel_commands.h => rte_power_channel_commands.h} |  0
 .../{guest_channel.h => rte_power_guest_channel.h}    |  2 +-
 14 files changed, 20 insertions(+), 16 deletions(-)
 rename lib/librte_power/{channel_commands.h => rte_power_channel_commands.h} (100%)
 rename lib/librte_power/{guest_channel.h => rte_power_guest_channel.h} (98%)

-- 
2.25.1

[dpdk-dev] [PATCH 1/4] power: make guest channel headers public

[Bruce Richardson]

The channel commands header file contains definitions that are used by the
example application for power management, and so need to be made public.
Similarly the guest_channel.h header is used by the guest_cli example
utility, so needs to be public also.  Without this change, the example
apps, or any end-user apps based on them, can not be compiled outside the
main DPDK build.

Fixes: 210c383e247b ("power: packet format for vm power management")
Fixes: cd0d5547e873 ("power: vm communication channels in guest")
Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 examples/vm_power_manager/channel_manager.c                   | 1 -
 examples/vm_power_manager/channel_monitor.c                   | 1 -
 examples/vm_power_manager/channel_monitor.h                   | 2 +-
 examples/vm_power_manager/guest_cli/main.c                    | 1 +
 examples/vm_power_manager/guest_cli/vm_power_cli_guest.c      | 2 +-
 examples/vm_power_manager/guest_cli/vm_power_cli_guest.h      | 2 +-
 examples/vm_power_manager/vm_power_cli.c                      | 1 -
 lib/librte_power/guest_channel.c                              | 3 +--
 lib/librte_power/meson.build                                  | 4 +++-
 lib/librte_power/power_kvm_vm.c                               | 3 +--
 .../{channel_commands.h => rte_power_channel_commands.h}      | 0
 .../{guest_channel.h => rte_power_guest_channel.h}            | 2 +-
 12 files changed, 10 insertions(+), 12 deletions(-)
 rename lib/librte_power/{channel_commands.h => rte_power_channel_commands.h} (100%)
 rename lib/librte_power/{guest_channel.h => rte_power_guest_channel.h} (98%)

diff --git a/examples/vm_power_manager/channel_manager.c b/examples/vm_power_manager/channel_manager.c
index 74a2a677e8..3da01b46d8 100644
--- a/examples/vm_power_manager/channel_manager.c
+++ b/examples/vm_power_manager/channel_manager.c
@@ -27,7 +27,6 @@
 #include <libvirt/libvirt.h>
 
 #include "channel_manager.h"
-#include "channel_commands.h"
 #include "channel_monitor.h"
 #include "power_manager.h"
 
diff --git a/examples/vm_power_manager/channel_monitor.c b/examples/vm_power_manager/channel_monitor.c
index 1d00a6cf6c..75a29d2589 100644
--- a/examples/vm_power_manager/channel_monitor.c
+++ b/examples/vm_power_manager/channel_monitor.c
@@ -35,7 +35,6 @@
 
 #include <libvirt/libvirt.h>
 #include "channel_monitor.h"
-#include "channel_commands.h"
 #include "channel_manager.h"
 #include "power_manager.h"
 #include "oob_monitor.h"
diff --git a/examples/vm_power_manager/channel_monitor.h b/examples/vm_power_manager/channel_monitor.h
index 7362a80d26..fe6ceedc95 100644
--- a/examples/vm_power_manager/channel_monitor.h
+++ b/examples/vm_power_manager/channel_monitor.h
@@ -6,7 +6,7 @@
 #define CHANNEL_MONITOR_H_
 
 #include "channel_manager.h"
-#include "channel_commands.h"
+#include "rte_power_channel_commands.h"
 
 struct core_share {
 	unsigned int pcpu;
diff --git a/examples/vm_power_manager/guest_cli/main.c b/examples/vm_power_manager/guest_cli/main.c
index f63b3c988a..4c0c98f498 100644
--- a/examples/vm_power_manager/guest_cli/main.c
+++ b/examples/vm_power_manager/guest_cli/main.c
@@ -14,6 +14,7 @@
 #include <rte_eal.h>
 #include <rte_log.h>
 
+#include "rte_power_channel_commands.h"
 #include "vm_power_cli_guest.h"
 #include "parse.h"
 
diff --git a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
index 96c1a1ff69..263e7ec9ff 100644
--- a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
+++ b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
@@ -19,7 +19,7 @@
 #include <rte_ethdev.h>
 
 #include <rte_power.h>
-#include <guest_channel.h>
+#include <rte_power_guest_channel.h>
 
 #include "vm_power_cli_guest.h"
 
diff --git a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
index 6ad14a3dea..33c01ff7ca 100644
--- a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
+++ b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
@@ -9,7 +9,7 @@
 extern "C" {
 #endif
 
-#include "channel_commands.h"
+struct channel_packet;
 
 struct channel_packet *get_policy(void);
 
diff --git a/examples/vm_power_manager/vm_power_cli.c b/examples/vm_power_manager/vm_power_cli.c
index 7edeaccda5..4c41645664 100644
--- a/examples/vm_power_manager/vm_power_cli.c
+++ b/examples/vm_power_manager/vm_power_cli.c
@@ -21,7 +21,6 @@
 #include "channel_manager.h"
 #include "channel_monitor.h"
 #include "power_manager.h"
-#include "channel_commands.h"
 
 struct cmd_quit_result {
 	cmdline_fixed_string_t quit;
diff --git a/lib/librte_power/guest_channel.c b/lib/librte_power/guest_channel.c
index 7b5926e5c4..d49cf0cd57 100644
--- a/lib/librte_power/guest_channel.c
+++ b/lib/librte_power/guest_channel.c
@@ -16,8 +16,7 @@
 
 #include <rte_log.h>
 
-#include "guest_channel.h"
-#include "channel_commands.h"
+#include "rte_power_guest_channel.h"
 
 #define RTE_LOGTYPE_GUEST_CHANNEL RTE_LOGTYPE_USER1
 
diff --git a/lib/librte_power/meson.build b/lib/librte_power/meson.build
index 78c031c943..e9b1fa6e45 100644
--- a/lib/librte_power/meson.build
+++ b/lib/librte_power/meson.build
@@ -10,5 +10,7 @@ sources = files('rte_power.c', 'power_acpi_cpufreq.c',
 		'rte_power_empty_poll.c',
 		'power_pstate_cpufreq.c',
 		'power_common.c')
-headers = files('rte_power.h','rte_power_empty_poll.h')
+headers = files('rte_power.h','rte_power_empty_poll.h',
+		'rte_power_guest_channel.h',
+		'rte_power_channel_commands.h')
 deps += ['timer']
diff --git a/lib/librte_power/power_kvm_vm.c b/lib/librte_power/power_kvm_vm.c
index 409c3e03ab..e9094e1230 100644
--- a/lib/librte_power/power_kvm_vm.c
+++ b/lib/librte_power/power_kvm_vm.c
@@ -6,8 +6,7 @@
 
 #include <rte_log.h>
 
-#include "guest_channel.h"
-#include "channel_commands.h"
+#include "rte_power_guest_channel.h"
 #include "power_kvm_vm.h"
 #include "power_common.h"
 
diff --git a/lib/librte_power/channel_commands.h b/lib/librte_power/rte_power_channel_commands.h
similarity index 100%
rename from lib/librte_power/channel_commands.h
rename to lib/librte_power/rte_power_channel_commands.h
diff --git a/lib/librte_power/guest_channel.h b/lib/librte_power/rte_power_guest_channel.h
similarity index 98%
rename from lib/librte_power/guest_channel.h
rename to lib/librte_power/rte_power_guest_channel.h
index e15db46fc7..9853839129 100644
--- a/lib/librte_power/guest_channel.h
+++ b/lib/librte_power/rte_power_guest_channel.h
@@ -8,7 +8,7 @@
 extern "C" {
 #endif
 
-#include <channel_commands.h>
+#include <rte_power_channel_commands.h>
 
 /**
  * Check if any Virtio-Serial VM end-points exist in path.
-- 
2.25.1

[dpdk-dev] [PATCH 2/4] examples/vm_power_manager: fix string truncation warning

[Bruce Richardson]

When compiling on ubuntu 20.04, a warning was issued about possible
truncation of the path string for the power management socket.

channel_manager.c: In function ‘add_all_channels’:
channel_manager.c:470:41: warning: ‘%s’ directive output may be truncated writing up to 255 bytes into a region of size 90 [-Wformat-truncation=]
  470 |     sizeof(chan_info->channel_path), "%s%s",
      |                                         ^~

This can be fixed by adding in an explicit truncation check to the code and
handling it appropriately.

Fixes: e8ae9b662506 ("examples/vm_power: channel manager and monitor in host")
Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 examples/vm_power_manager/channel_manager.c | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/examples/vm_power_manager/channel_manager.c b/examples/vm_power_manager/channel_manager.c
index 3da01b46d8..0a28cb643b 100644
--- a/examples/vm_power_manager/channel_manager.c
+++ b/examples/vm_power_manager/channel_manager.c
@@ -466,9 +466,15 @@ add_all_channels(const char *vm_name)
 			continue;
 		}
 
-		snprintf(chan_info->channel_path,
+		if ((size_t)snprintf(chan_info->channel_path,
 				sizeof(chan_info->channel_path), "%s%s",
-				CHANNEL_MGR_SOCKET_PATH, dir->d_name);
+				CHANNEL_MGR_SOCKET_PATH, dir->d_name)
+					>= sizeof(chan_info->channel_path)) {
+			RTE_LOG(ERR, CHANNEL_MANAGER, "Pathname too long for channel '%s%s'\n",
+					CHANNEL_MGR_SOCKET_PATH, dir->d_name);
+			rte_free(chan_info);
+			continue;
+		}
 
 		if (setup_channel_info(&vm_info, &chan_info, channel_num) < 0) {
 			rte_free(chan_info);
-- 
2.25.1

[dpdk-dev] [PATCH 3/4] examples/mp_server: fix snprintf overflow

[Bruce Richardson]

When producing a printable mac address the buffer was appropriately sized
for holding the mac address exactly, but the actual snprintf included a
'\n' character at the end, which means that the snprintf technically is
getting truncated i.e. the \n would not be added due to lack of space.
This gets flagged as a problem by modern versions of gcc, e.g. on Ubuntu
20.04.

main.c:77:37: warning: ‘__builtin___snprintf_chk’ output truncated before the last format character [-Wformat-truncation=]
   77 |     "%02x:%02x:%02x:%02x:%02x:%02x\n",
      |                                     ^

Since the \n is getting stripped anyway, we can fix the issue by just
removing it from the printf string.

Fixes: af75078fece3 ("first public release")
Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 examples/multi_process/client_server_mp/mp_server/main.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/examples/multi_process/client_server_mp/mp_server/main.c b/examples/multi_process/client_server_mp/mp_server/main.c
index 280dab8672..af5af672c3 100644
--- a/examples/multi_process/client_server_mp/mp_server/main.c
+++ b/examples/multi_process/client_server_mp/mp_server/main.c
@@ -74,7 +74,7 @@ get_printable_mac_addr(uint16_t port)
 			return err_address;
 		}
 		snprintf(addresses[port], sizeof(addresses[port]),
-				"%02x:%02x:%02x:%02x:%02x:%02x\n",
+				"%02x:%02x:%02x:%02x:%02x:%02x",
 				mac.addr_bytes[0], mac.addr_bytes[1], mac.addr_bytes[2],
 				mac.addr_bytes[3], mac.addr_bytes[4], mac.addr_bytes[5]);
 	}
-- 
2.25.1

[dpdk-dev] [PATCH 4/4] examples/mp_server: clear string truncation warning

[Bruce Richardson]

Compiling with GCC 9.3 on Ubuntu 20.04 gives a warning about possible
string truncation when getting the RX queue name:

In file included from init.c:36:
init.c: In function ‘init’:
../shared/common.h:38:28: warning: ‘%u’ directive output may be truncated writing between 1 and 10 bytes into a region of size 8 [-Wformat-truncation=]
   38 | #define MP_CLIENT_RXQ_NAME "MProc_Client_%u_RX"
      |                            ^~~~~~~~~~~~~~~~~~~~
../shared/common.h:52:35: note: in expansion of macro ‘MP_CLIENT_RXQ_NAME’
   52 |  snprintf(buffer, sizeof(buffer), MP_CLIENT_RXQ_NAME, id);
      |                                   ^~~~~~~~~~~~~~~~~~

This is a false positive, as the value of the "id" is limited to 255, being
stored in the app as a uint8_t value, removing the possibility of the %u
being replaced by anything other then 3 characters max (rather than up to
10 as thought by the compiler). Therefore, the warning can be easily
removed by changing the type of the "id" parameter to the local function
from "unsigned" to "uint8_t" also, ensuring the compiler is aware of the
range limit.

Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 examples/multi_process/client_server_mp/shared/common.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/examples/multi_process/client_server_mp/shared/common.h b/examples/multi_process/client_server_mp/shared/common.h
index 6dd43fcac2..76beca0101 100644
--- a/examples/multi_process/client_server_mp/shared/common.h
+++ b/examples/multi_process/client_server_mp/shared/common.h
@@ -43,7 +43,7 @@ struct port_info {
  * Given the rx queue name template above, get the queue name
  */
 static inline const char *
-get_rx_queue_name(unsigned id)
+get_rx_queue_name(uint8_t id)
 {
 	/* buffer for return value. Size calculated by %u being replaced
 	 * by maximum 3 digits (plus an extra byte for safety) */
-- 
2.25.1

Re: [dpdk-dev] [PATCH 1/4] power: make guest channel headers public

[Bruce Richardson]

On Fri, Aug 14, 2020 at 12:00:42PM +0100, Bruce Richardson wrote:
> The channel commands header file contains definitions that are used by the
> example application for power management, and so need to be made public.
> Similarly the guest_channel.h header is used by the guest_cli example
> utility, so needs to be public also.  Without this change, the example
> apps, or any end-user apps based on them, can not be compiled outside the
> main DPDK build.
> 
> Fixes: 210c383e247b ("power: packet format for vm power management")
> Fixes: cd0d5547e873 ("power: vm communication channels in guest")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
>  examples/vm_power_manager/channel_manager.c                   | 1 -
>  examples/vm_power_manager/channel_monitor.c                   | 1 -
>  examples/vm_power_manager/channel_monitor.h                   | 2 +-
>  examples/vm_power_manager/guest_cli/main.c                    | 1 +
>  examples/vm_power_manager/guest_cli/vm_power_cli_guest.c      | 2 +-
>  examples/vm_power_manager/guest_cli/vm_power_cli_guest.h      | 2 +-
>  examples/vm_power_manager/vm_power_cli.c                      | 1 -
>  lib/librte_power/guest_channel.c                              | 3 +--
>  lib/librte_power/meson.build                                  | 4 +++-
>  lib/librte_power/power_kvm_vm.c                               | 3 +--
>  .../{channel_commands.h => rte_power_channel_commands.h}      | 0
>  .../{guest_channel.h => rte_power_guest_channel.h}            | 2 +-
>  12 files changed, 10 insertions(+), 12 deletions(-)
>  rename lib/librte_power/{channel_commands.h => rte_power_channel_commands.h} (100%)
>  rename lib/librte_power/{guest_channel.h => rte_power_guest_channel.h} (98%)
> 
Note, this patch does not include the makefile changes, as the work was
done when testing with the makefile removal patchset applied, and make
support is being removed in this release.

Re: [dpdk-dev] [PATCH 3/4] examples/mp_server: fix snprintf overflow

[Stephen Hemminger]

On Fri, 14 Aug 2020 12:00:44 +0100
Bruce Richardson <bruce.richardson@intel.com> wrote:

> When producing a printable mac address the buffer was appropriately sized
> for holding the mac address exactly, but the actual snprintf included a
> '\n' character at the end, which means that the snprintf technically is
> getting truncated i.e. the \n would not be added due to lack of space.
> This gets flagged as a problem by modern versions of gcc, e.g. on Ubuntu
> 20.04.
> 
> main.c:77:37: warning: ‘__builtin___snprintf_chk’ output truncated before the last format character [-Wformat-truncation=]
>    77 |     "%02x:%02x:%02x:%02x:%02x:%02x\n",
>       |                                     ^
> 
> Since the \n is getting stripped anyway, we can fix the issue by just
> removing it from the printf string.
> 
> Fixes: af75078fece3 ("first public release")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
>  examples/multi_process/client_server_mp/mp_server/main.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/examples/multi_process/client_server_mp/mp_server/main.c b/examples/multi_process/client_server_mp/mp_server/main.c
> index 280dab8672..af5af672c3 100644
> --- a/examples/multi_process/client_server_mp/mp_server/main.c
> +++ b/examples/multi_process/client_server_mp/mp_server/main.c
> @@ -74,7 +74,7 @@ get_printable_mac_addr(uint16_t port)
>  			return err_address;
>  		}
>  		snprintf(addresses[port], sizeof(addresses[port]),
> -				"%02x:%02x:%02x:%02x:%02x:%02x\n",
> +				"%02x:%02x:%02x:%02x:%02x:%02x",
>  				mac.addr_bytes[0], mac.addr_bytes[1], mac.addr_bytes[2],
>  				mac.addr_bytes[3], mac.addr_bytes[4], mac.addr_bytes[5]);
>  	}

Please convert to rte_ether_format_addr() instead of local hard coded format.

[dpdk-dev] [PATCH v2 0/4] fixes for example app builds

[Bruce Richardson]

While helping prepare some patches for converting the DPDK examples to
build using pkg-config, a number of errors and warnings were encountered in
the example app builds. These patches fix those issues.

NOTE: no makefile changes are included since make support is being removed
in this release

Bruce Richardson (4):
  power: make guest channel headers public
  examples/vm_power_manager: fix string truncation warning
  examples/mp_server: fix snprintf overflow
  examples/mp_server: clear string truncation warning

 .../client_server_mp/mp_server/main.c           | 17 ++++++++++-------
 .../client_server_mp/shared/common.h            |  2 +-
 examples/vm_power_manager/channel_manager.c     | 11 ++++++++---
 examples/vm_power_manager/channel_monitor.c     |  1 -
 examples/vm_power_manager/channel_monitor.h     |  2 +-
 examples/vm_power_manager/guest_cli/main.c      |  1 +
 .../guest_cli/vm_power_cli_guest.c              |  2 +-
 .../guest_cli/vm_power_cli_guest.h              |  2 +-
 examples/vm_power_manager/vm_power_cli.c        |  1 -
 lib/librte_power/guest_channel.c                |  3 +--
 lib/librte_power/meson.build                    |  4 +++-
 lib/librte_power/power_kvm_vm.c                 |  3 +--
 ..._commands.h => rte_power_channel_commands.h} |  0
 ...uest_channel.h => rte_power_guest_channel.h} |  2 +-
 14 files changed, 29 insertions(+), 22 deletions(-)
 rename lib/librte_power/{channel_commands.h => rte_power_channel_commands.h} (100%)
 rename lib/librte_power/{guest_channel.h => rte_power_guest_channel.h} (98%)

-- 
2.25.1

[dpdk-dev] [PATCH v2 1/4] power: make guest channel headers public

[Bruce Richardson]

The channel commands header file contains definitions that are used by the
example application for power management, and so need to be made public.
Similarly the guest_channel.h header is used by the guest_cli example
utility, so needs to be public also.  Without this change, the example
apps, or any end-user apps based on them, can not be compiled outside the
main DPDK build.

Fixes: 210c383e247b ("power: packet format for vm power management")
Fixes: cd0d5547e873 ("power: vm communication channels in guest")
Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 examples/vm_power_manager/channel_manager.c                   | 1 -
 examples/vm_power_manager/channel_monitor.c                   | 1 -
 examples/vm_power_manager/channel_monitor.h                   | 2 +-
 examples/vm_power_manager/guest_cli/main.c                    | 1 +
 examples/vm_power_manager/guest_cli/vm_power_cli_guest.c      | 2 +-
 examples/vm_power_manager/guest_cli/vm_power_cli_guest.h      | 2 +-
 examples/vm_power_manager/vm_power_cli.c                      | 1 -
 lib/librte_power/guest_channel.c                              | 3 +--
 lib/librte_power/meson.build                                  | 4 +++-
 lib/librte_power/power_kvm_vm.c                               | 3 +--
 .../{channel_commands.h => rte_power_channel_commands.h}      | 0
 .../{guest_channel.h => rte_power_guest_channel.h}            | 2 +-
 12 files changed, 10 insertions(+), 12 deletions(-)
 rename lib/librte_power/{channel_commands.h => rte_power_channel_commands.h} (100%)
 rename lib/librte_power/{guest_channel.h => rte_power_guest_channel.h} (98%)

diff --git a/examples/vm_power_manager/channel_manager.c b/examples/vm_power_manager/channel_manager.c
index 74a2a677e8..3da01b46d8 100644
--- a/examples/vm_power_manager/channel_manager.c
+++ b/examples/vm_power_manager/channel_manager.c
@@ -27,7 +27,6 @@
 #include <libvirt/libvirt.h>
 
 #include "channel_manager.h"
-#include "channel_commands.h"
 #include "channel_monitor.h"
 #include "power_manager.h"
 
diff --git a/examples/vm_power_manager/channel_monitor.c b/examples/vm_power_manager/channel_monitor.c
index 1d00a6cf6c..75a29d2589 100644
--- a/examples/vm_power_manager/channel_monitor.c
+++ b/examples/vm_power_manager/channel_monitor.c
@@ -35,7 +35,6 @@
 
 #include <libvirt/libvirt.h>
 #include "channel_monitor.h"
-#include "channel_commands.h"
 #include "channel_manager.h"
 #include "power_manager.h"
 #include "oob_monitor.h"
diff --git a/examples/vm_power_manager/channel_monitor.h b/examples/vm_power_manager/channel_monitor.h
index 7362a80d26..fe6ceedc95 100644
--- a/examples/vm_power_manager/channel_monitor.h
+++ b/examples/vm_power_manager/channel_monitor.h
@@ -6,7 +6,7 @@
 #define CHANNEL_MONITOR_H_
 
 #include "channel_manager.h"
-#include "channel_commands.h"
+#include "rte_power_channel_commands.h"
 
 struct core_share {
 	unsigned int pcpu;
diff --git a/examples/vm_power_manager/guest_cli/main.c b/examples/vm_power_manager/guest_cli/main.c
index f63b3c988a..4c0c98f498 100644
--- a/examples/vm_power_manager/guest_cli/main.c
+++ b/examples/vm_power_manager/guest_cli/main.c
@@ -14,6 +14,7 @@
 #include <rte_eal.h>
 #include <rte_log.h>
 
+#include "rte_power_channel_commands.h"
 #include "vm_power_cli_guest.h"
 #include "parse.h"
 
diff --git a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
index 96c1a1ff69..263e7ec9ff 100644
--- a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
+++ b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
@@ -19,7 +19,7 @@
 #include <rte_ethdev.h>
 
 #include <rte_power.h>
-#include <guest_channel.h>
+#include <rte_power_guest_channel.h>
 
 #include "vm_power_cli_guest.h"
 
diff --git a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
index 6ad14a3dea..33c01ff7ca 100644
--- a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
+++ b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
@@ -9,7 +9,7 @@
 extern "C" {
 #endif
 
-#include "channel_commands.h"
+struct channel_packet;
 
 struct channel_packet *get_policy(void);
 
diff --git a/examples/vm_power_manager/vm_power_cli.c b/examples/vm_power_manager/vm_power_cli.c
index 7edeaccda5..4c41645664 100644
--- a/examples/vm_power_manager/vm_power_cli.c
+++ b/examples/vm_power_manager/vm_power_cli.c
@@ -21,7 +21,6 @@
 #include "channel_manager.h"
 #include "channel_monitor.h"
 #include "power_manager.h"
-#include "channel_commands.h"
 
 struct cmd_quit_result {
 	cmdline_fixed_string_t quit;
diff --git a/lib/librte_power/guest_channel.c b/lib/librte_power/guest_channel.c
index 7b5926e5c4..d49cf0cd57 100644
--- a/lib/librte_power/guest_channel.c
+++ b/lib/librte_power/guest_channel.c
@@ -16,8 +16,7 @@
 
 #include <rte_log.h>
 
-#include "guest_channel.h"
-#include "channel_commands.h"
+#include "rte_power_guest_channel.h"
 
 #define RTE_LOGTYPE_GUEST_CHANNEL RTE_LOGTYPE_USER1
 
diff --git a/lib/librte_power/meson.build b/lib/librte_power/meson.build
index 78c031c943..e9b1fa6e45 100644
--- a/lib/librte_power/meson.build
+++ b/lib/librte_power/meson.build
@@ -10,5 +10,7 @@ sources = files('rte_power.c', 'power_acpi_cpufreq.c',
 		'rte_power_empty_poll.c',
 		'power_pstate_cpufreq.c',
 		'power_common.c')
-headers = files('rte_power.h','rte_power_empty_poll.h')
+headers = files('rte_power.h','rte_power_empty_poll.h',
+		'rte_power_guest_channel.h',
+		'rte_power_channel_commands.h')
 deps += ['timer']
diff --git a/lib/librte_power/power_kvm_vm.c b/lib/librte_power/power_kvm_vm.c
index 409c3e03ab..e9094e1230 100644
--- a/lib/librte_power/power_kvm_vm.c
+++ b/lib/librte_power/power_kvm_vm.c
@@ -6,8 +6,7 @@
 
 #include <rte_log.h>
 
-#include "guest_channel.h"
-#include "channel_commands.h"
+#include "rte_power_guest_channel.h"
 #include "power_kvm_vm.h"
 #include "power_common.h"
 
diff --git a/lib/librte_power/channel_commands.h b/lib/librte_power/rte_power_channel_commands.h
similarity index 100%
rename from lib/librte_power/channel_commands.h
rename to lib/librte_power/rte_power_channel_commands.h
diff --git a/lib/librte_power/guest_channel.h b/lib/librte_power/rte_power_guest_channel.h
similarity index 98%
rename from lib/librte_power/guest_channel.h
rename to lib/librte_power/rte_power_guest_channel.h
index e15db46fc7..9853839129 100644
--- a/lib/librte_power/guest_channel.h
+++ b/lib/librte_power/rte_power_guest_channel.h
@@ -8,7 +8,7 @@
 extern "C" {
 #endif
 
-#include <channel_commands.h>
+#include <rte_power_channel_commands.h>
 
 /**
  * Check if any Virtio-Serial VM end-points exist in path.
-- 
2.25.1

[dpdk-dev] [PATCH v2 2/4] examples/vm_power_manager: fix string truncation warning

[Bruce Richardson]

When compiling on ubuntu 20.04, a warning was issued about possible
truncation of the path string for the power management socket.

channel_manager.c: In function ‘add_all_channels’:
channel_manager.c:470:41: warning: ‘%s’ directive output may be truncated writing up to 255 bytes into a region of size 90 [-Wformat-truncation=]
  470 |     sizeof(chan_info->channel_path), "%s%s",
      |                                         ^~

This can be fixed by adding in an explicit truncation check to the code and
handling it appropriately.

Fixes: e8ae9b662506 ("examples/vm_power: channel manager and monitor in host")
Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 examples/vm_power_manager/channel_manager.c | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/examples/vm_power_manager/channel_manager.c b/examples/vm_power_manager/channel_manager.c
index 3da01b46d8..0a28cb643b 100644
--- a/examples/vm_power_manager/channel_manager.c
+++ b/examples/vm_power_manager/channel_manager.c
@@ -466,9 +466,15 @@ add_all_channels(const char *vm_name)
 			continue;
 		}
 
-		snprintf(chan_info->channel_path,
+		if ((size_t)snprintf(chan_info->channel_path,
 				sizeof(chan_info->channel_path), "%s%s",
-				CHANNEL_MGR_SOCKET_PATH, dir->d_name);
+				CHANNEL_MGR_SOCKET_PATH, dir->d_name)
+					>= sizeof(chan_info->channel_path)) {
+			RTE_LOG(ERR, CHANNEL_MANAGER, "Pathname too long for channel '%s%s'\n",
+					CHANNEL_MGR_SOCKET_PATH, dir->d_name);
+			rte_free(chan_info);
+			continue;
+		}
 
 		if (setup_channel_info(&vm_info, &chan_info, channel_num) < 0) {
 			rte_free(chan_info);
-- 
2.25.1

[dpdk-dev] [PATCH v2 3/4] examples/mp_server: fix snprintf overflow

[Bruce Richardson]

When producing a printable mac address the buffer was appropriately sized
for holding the mac address exactly, but the actual snprintf included a
'\n' character at the end, which means that the snprintf technically is
getting truncated i.e. the \n would not be added due to lack of space.
This gets flagged as a problem by modern versions of gcc, e.g. on Ubuntu
20.04.

main.c:77:37: warning: ‘__builtin___snprintf_chk’ output truncated before the last format character [-Wformat-truncation=]
   77 |     "%02x:%02x:%02x:%02x:%02x:%02x\n",
      |                                     ^

Since the \n is getting stripped anyway, we can fix the issue by just
removing it. In the process we can switch to using the standard ethernet
address formating function from rte_ether.h.

Fixes: af75078fece3 ("first public release")
Cc: stable@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

---
V2: switched code to use standard formatting function
---
 .../client_server_mp/mp_server/main.c           | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/examples/multi_process/client_server_mp/mp_server/main.c b/examples/multi_process/client_server_mp/mp_server/main.c
index 280dab8672..fb2aa49678 100644
--- a/examples/multi_process/client_server_mp/mp_server/main.c
+++ b/examples/multi_process/client_server_mp/mp_server/main.c
@@ -59,12 +59,17 @@ static struct client_rx_buf *cl_rx_buf;
 static const char *
 get_printable_mac_addr(uint16_t port)
 {
-	static const char err_address[] = "00:00:00:00:00:00";
-	static char addresses[RTE_MAX_ETHPORTS][sizeof(err_address)];
+	static const struct rte_ether_addr null_mac; /* static defaults to 0 */
+	static char err_address[32];
+	static char addresses[RTE_MAX_ETHPORTS][32];
 	int ret;
 
-	if (unlikely(port >= RTE_MAX_ETHPORTS))
+	if (unlikely(port >= RTE_MAX_ETHPORTS)) {
+		if (err_address[0] == '\0')
+			rte_ether_format_addr(err_address,
+					sizeof(err_address), &null_mac);
 		return err_address;
+	}
 	if (unlikely(addresses[port][0]=='\0')){
 		struct rte_ether_addr mac;
 		ret = rte_eth_macaddr_get(port, &mac);
@@ -73,10 +78,8 @@ get_printable_mac_addr(uint16_t port)
 			       port, rte_strerror(-ret));
 			return err_address;
 		}
-		snprintf(addresses[port], sizeof(addresses[port]),
-				"%02x:%02x:%02x:%02x:%02x:%02x\n",
-				mac.addr_bytes[0], mac.addr_bytes[1], mac.addr_bytes[2],
-				mac.addr_bytes[3], mac.addr_bytes[4], mac.addr_bytes[5]);
+		rte_ether_format_addr(addresses[port],
+				sizeof(addresses[port]), &mac);
 	}
 	return addresses[port];
 }
-- 
2.25.1

[dpdk-dev] [PATCH v2 4/4] examples/mp_server: clear string truncation warning

[Bruce Richardson]

Compiling with GCC 9.3 on Ubuntu 20.04 gives a warning about possible
string truncation when getting the RX queue name:

In file included from init.c:36:
init.c: In function ‘init’:
../shared/common.h:38:28: warning: ‘%u’ directive output may be truncated writing between 1 and 10 bytes into a region of size 8 [-Wformat-truncation=]
   38 | #define MP_CLIENT_RXQ_NAME "MProc_Client_%u_RX"
      |                            ^~~~~~~~~~~~~~~~~~~~
../shared/common.h:52:35: note: in expansion of macro ‘MP_CLIENT_RXQ_NAME’
   52 |  snprintf(buffer, sizeof(buffer), MP_CLIENT_RXQ_NAME, id);
      |                                   ^~~~~~~~~~~~~~~~~~

This is a false positive, as the value of the "id" is limited to 255, being
stored in the app as a uint8_t value, removing the possibility of the %u
being replaced by anything other then 3 characters max (rather than up to
10 as thought by the compiler). Therefore, the warning can be easily
removed by changing the type of the "id" parameter to the local function
from "unsigned" to "uint8_t" also, ensuring the compiler is aware of the
range limit.

Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 examples/multi_process/client_server_mp/shared/common.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/examples/multi_process/client_server_mp/shared/common.h b/examples/multi_process/client_server_mp/shared/common.h
index 6dd43fcac2..76beca0101 100644
--- a/examples/multi_process/client_server_mp/shared/common.h
+++ b/examples/multi_process/client_server_mp/shared/common.h
@@ -43,7 +43,7 @@ struct port_info {
  * Given the rx queue name template above, get the queue name
  */
 static inline const char *
-get_rx_queue_name(unsigned id)
+get_rx_queue_name(uint8_t id)
 {
 	/* buffer for return value. Size calculated by %u being replaced
 	 * by maximum 3 digits (plus an extra byte for safety) */
-- 
2.25.1

Re: [dpdk-dev] [PATCH v2 1/4] power: make guest channel headers public

[David Hunt]

Hi Bruce,

On 21/8/2020 6:10 PM, Bruce Richardson wrote:
> The channel commands header file contains definitions that are used by the
> example application for power management, and so need to be made public.
> Similarly the guest_channel.h header is used by the guest_cli example
> utility, so needs to be public also.  Without this change, the example
> apps, or any end-user apps based on them, can not be compiled outside the
> main DPDK build.
>
> Fixes: 210c383e247b ("power: packet format for vm power management")
> Fixes: cd0d5547e873 ("power: vm communication channels in guest")
> Cc: stable@dpdk.org
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
>   examples/vm_power_manager/channel_manager.c                   | 1 -
>   examples/vm_power_manager/channel_monitor.c                   | 1 -
>   examples/vm_power_manager/channel_monitor.h                   | 2 +-
>   examples/vm_power_manager/guest_cli/main.c                    | 1 +
>   examples/vm_power_manager/guest_cli/vm_power_cli_guest.c      | 2 +-
>   examples/vm_power_manager/guest_cli/vm_power_cli_guest.h      | 2 +-
>   examples/vm_power_manager/vm_power_cli.c                      | 1 -
>   lib/librte_power/guest_channel.c                              | 3 +--
>   lib/librte_power/meson.build                                  | 4 +++-
>   lib/librte_power/power_kvm_vm.c                               | 3 +--
>   .../{channel_commands.h => rte_power_channel_commands.h}      | 0
>   .../{guest_channel.h => rte_power_guest_channel.h}            | 2 +-
>   12 files changed, 10 insertions(+), 12 deletions(-)
>   rename lib/librte_power/{channel_commands.h => rte_power_channel_commands.h} (100%)
>   rename lib/librte_power/{guest_channel.h => rte_power_guest_channel.h} (98%)
>
> diff --git a/examples/vm_power_manager/channel_manager.c b/examples/vm_power_manager/channel_manager.c
> index 74a2a677e8..3da01b46d8 100644
> --- a/examples/vm_power_manager/channel_manager.c
> +++ b/examples/vm_power_manager/channel_manager.c
> @@ -27,7 +27,6 @@
>   #include <libvirt/libvirt.h>
>   
>   #include "channel_manager.h"
> -#include "channel_commands.h"
>   #include "channel_monitor.h"
>   #include "power_manager.h"
>   
> diff --git a/examples/vm_power_manager/channel_monitor.c b/examples/vm_power_manager/channel_monitor.c
> index 1d00a6cf6c..75a29d2589 100644
> --- a/examples/vm_power_manager/channel_monitor.c
> +++ b/examples/vm_power_manager/channel_monitor.c
> @@ -35,7 +35,6 @@
>   
>   #include <libvirt/libvirt.h>
>   #include "channel_monitor.h"
> -#include "channel_commands.h"
>   #include "channel_manager.h"
>   #include "power_manager.h"
>   #include "oob_monitor.h"
> diff --git a/examples/vm_power_manager/channel_monitor.h b/examples/vm_power_manager/channel_monitor.h
> index 7362a80d26..fe6ceedc95 100644
> --- a/examples/vm_power_manager/channel_monitor.h
> +++ b/examples/vm_power_manager/channel_monitor.h
> @@ -6,7 +6,7 @@
>   #define CHANNEL_MONITOR_H_
>   
>   #include "channel_manager.h"
> -#include "channel_commands.h"
> +#include "rte_power_channel_commands.h"
>   
>   struct core_share {
>   	unsigned int pcpu;
> diff --git a/examples/vm_power_manager/guest_cli/main.c b/examples/vm_power_manager/guest_cli/main.c
> index f63b3c988a..4c0c98f498 100644
> --- a/examples/vm_power_manager/guest_cli/main.c
> +++ b/examples/vm_power_manager/guest_cli/main.c
> @@ -14,6 +14,7 @@
>   #include <rte_eal.h>
>   #include <rte_log.h>
>   
> +#include "rte_power_channel_commands.h"
>   #include "vm_power_cli_guest.h"
>   #include "parse.h"
>   
> diff --git a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
> index 96c1a1ff69..263e7ec9ff 100644
> --- a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
> +++ b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.c
> @@ -19,7 +19,7 @@
>   #include <rte_ethdev.h>
>   
>   #include <rte_power.h>
> -#include <guest_channel.h>
> +#include <rte_power_guest_channel.h>
>   
>   #include "vm_power_cli_guest.h"
>   
> diff --git a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
> index 6ad14a3dea..33c01ff7ca 100644
> --- a/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
> +++ b/examples/vm_power_manager/guest_cli/vm_power_cli_guest.h
> @@ -9,7 +9,7 @@
>   extern "C" {
>   #endif
>   
> -#include "channel_commands.h"
> +struct channel_packet;
>   
>   struct channel_packet *get_policy(void);
>   
> diff --git a/examples/vm_power_manager/vm_power_cli.c b/examples/vm_power_manager/vm_power_cli.c
> index 7edeaccda5..4c41645664 100644
> --- a/examples/vm_power_manager/vm_power_cli.c
> +++ b/examples/vm_power_manager/vm_power_cli.c
> @@ -21,7 +21,6 @@
>   #include "channel_manager.h"
>   #include "channel_monitor.h"
>   #include "power_manager.h"
> -#include "channel_commands.h"
>   
>   struct cmd_quit_result {
>   	cmdline_fixed_string_t quit;
> diff --git a/lib/librte_power/guest_channel.c b/lib/librte_power/guest_channel.c
> index 7b5926e5c4..d49cf0cd57 100644
> --- a/lib/librte_power/guest_channel.c
> +++ b/lib/librte_power/guest_channel.c
> @@ -16,8 +16,7 @@
>   
>   #include <rte_log.h>
>   
> -#include "guest_channel.h"
> -#include "channel_commands.h"
> +#include "rte_power_guest_channel.h"
>   
>   #define RTE_LOGTYPE_GUEST_CHANNEL RTE_LOGTYPE_USER1
>   
> diff --git a/lib/librte_power/meson.build b/lib/librte_power/meson.build
> index 78c031c943..e9b1fa6e45 100644
> --- a/lib/librte_power/meson.build
> +++ b/lib/librte_power/meson.build
> @@ -10,5 +10,7 @@ sources = files('rte_power.c', 'power_acpi_cpufreq.c',
>   		'rte_power_empty_poll.c',
>   		'power_pstate_cpufreq.c',
>   		'power_common.c')
> -headers = files('rte_power.h','rte_power_empty_poll.h')
> +headers = files('rte_power.h','rte_power_empty_poll.h',
> +		'rte_power_guest_channel.h',
> +		'rte_power_channel_commands.h')
>   deps += ['timer']
> diff --git a/lib/librte_power/power_kvm_vm.c b/lib/librte_power/power_kvm_vm.c
> index 409c3e03ab..e9094e1230 100644
> --- a/lib/librte_power/power_kvm_vm.c
> +++ b/lib/librte_power/power_kvm_vm.c
> @@ -6,8 +6,7 @@
>   
>   #include <rte_log.h>
>   
> -#include "guest_channel.h"
> -#include "channel_commands.h"
> +#include "rte_power_guest_channel.h"
>   #include "power_kvm_vm.h"
>   #include "power_common.h"
>   
> diff --git a/lib/librte_power/channel_commands.h b/lib/librte_power/rte_power_channel_commands.h
> similarity index 100%
> rename from lib/librte_power/channel_commands.h
> rename to lib/librte_power/rte_power_channel_commands.h
> diff --git a/lib/librte_power/guest_channel.h b/lib/librte_power/rte_power_guest_channel.h
> similarity index 98%
> rename from lib/librte_power/guest_channel.h
> rename to lib/librte_power/rte_power_guest_channel.h
> index e15db46fc7..9853839129 100644
> --- a/lib/librte_power/guest_channel.h
> +++ b/lib/librte_power/rte_power_guest_channel.h
> @@ -8,7 +8,7 @@
>   extern "C" {
>   #endif
>   
> -#include <channel_commands.h>
> +#include <rte_power_channel_commands.h>
>   
>   /**
>    * Check if any Virtio-Serial VM end-points exist in path.


Acked-by: David Hunt <david.hunt@intel.com>

Re: [dpdk-dev] [PATCH v2 2/4] examples/vm_power_manager: fix string truncation warning

[David Hunt]

Hi Bruce,

On 21/8/2020 6:10 PM, Bruce Richardson wrote:
> When compiling on ubuntu 20.04, a warning was issued about possible
> truncation of the path string for the power management socket.
>
> channel_manager.c: In function ‘add_all_channels’:
> channel_manager.c:470:41: warning: ‘%s’ directive output may be truncated writing up to 255 bytes into a region of size 90 [-Wformat-truncation=]
>    470 |     sizeof(chan_info->channel_path), "%s%s",
>        |                                         ^~
>
> This can be fixed by adding in an explicit truncation check to the code and
> handling it appropriately.
>
> Fixes: e8ae9b662506 ("examples/vm_power: channel manager and monitor in host")
> Cc: stable@dpdk.org
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
>   examples/vm_power_manager/channel_manager.c | 10 ++++++++--
>   1 file changed, 8 insertions(+), 2 deletions(-)
>
> diff --git a/examples/vm_power_manager/channel_manager.c b/examples/vm_power_manager/channel_manager.c
> index 3da01b46d8..0a28cb643b 100644
> --- a/examples/vm_power_manager/channel_manager.c
> +++ b/examples/vm_power_manager/channel_manager.c
> @@ -466,9 +466,15 @@ add_all_channels(const char *vm_name)
>   			continue;
>   		}
>   
> -		snprintf(chan_info->channel_path,
> +		if ((size_t)snprintf(chan_info->channel_path,
>   				sizeof(chan_info->channel_path), "%s%s",
> -				CHANNEL_MGR_SOCKET_PATH, dir->d_name);
> +				CHANNEL_MGR_SOCKET_PATH, dir->d_name)
> +					>= sizeof(chan_info->channel_path)) {
> +			RTE_LOG(ERR, CHANNEL_MANAGER, "Pathname too long for channel '%s%s'\n",
> +					CHANNEL_MGR_SOCKET_PATH, dir->d_name);
> +			rte_free(chan_info);
> +			continue;
> +		}
>   
>   		if (setup_channel_info(&vm_info, &chan_info, channel_num) < 0) {
>   			rte_free(chan_info);


Acked-by: David Hunt <david.hunt@intel.com>

Re: [dpdk-dev] [dpdk-stable] [PATCH v2 1/4] power: make guest channel headers public

[Thomas Monjalon]

\0> The channel commands header file contains definitions that are used by the
> example application for power management, and so need to be made public.
> Similarly the guest_channel.h header is used by the guest_cli example
> utility, so needs to be public also.  Without this change, the example
> apps, or any end-user apps based on them, can not be compiled outside the
> main DPDK build.
[...]
>  rename lib/librte_power/{channel_commands.h => rte_power_channel_commands.h} (100%)
>  rename lib/librte_power/{guest_channel.h => rte_power_guest_channel.h} (98%)

Yes there are dirty includes, but it requires more than just a renaming.
At least the namespace of these functions should be checked
to start with "rte_".
But before adding all these new functions as stable public API,
I would like we check whether it is a well designed API or not.

Re: [dpdk-dev] [PATCH v2 4/4] examples/mp_server: clear string truncation warning

[Nicolau, Radu]

On 8/21/2020 6:10 PM, Bruce Richardson wrote:
> Compiling with GCC 9.3 on Ubuntu 20.04 gives a warning about possible
> string truncation when getting the RX queue name:
>
> In file included from init.c:36:
> init.c: In function ‘init’:
> ../shared/common.h:38:28: warning: ‘%u’ directive output may be truncated writing between 1 and 10 bytes into a region of size 8 [-Wformat-truncation=]
>     38 | #define MP_CLIENT_RXQ_NAME "MProc_Client_%u_RX"
>        |                            ^~~~~~~~~~~~~~~~~~~~
> ../shared/common.h:52:35: note: in expansion of macro ‘MP_CLIENT_RXQ_NAME’
>     52 |  snprintf(buffer, sizeof(buffer), MP_CLIENT_RXQ_NAME, id);
>        |                                   ^~~~~~~~~~~~~~~~~~
>
> This is a false positive, as the value of the "id" is limited to 255, being
> stored in the app as a uint8_t value, removing the possibility of the %u
> being replaced by anything other then 3 characters max (rather than up to
> 10 as thought by the compiler). Therefore, the warning can be easily
> removed by changing the type of the "id" parameter to the local function
> from "unsigned" to "uint8_t" also, ensuring the compiler is aware of the
> range limit.
>
> Cc: stable@dpdk.org
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
Acked-by: Radu Nicolau <radu.nicolau@intel.com>

Re: [dpdk-dev] [PATCH v2 3/4] examples/mp_server: fix snprintf overflow

[Nicolau, Radu]

On 8/21/2020 6:10 PM, Bruce Richardson wrote:
> When producing a printable mac address the buffer was appropriately sized
> for holding the mac address exactly, but the actual snprintf included a
> '\n' character at the end, which means that the snprintf technically is
> getting truncated i.e. the \n would not be added due to lack of space.
> This gets flagged as a problem by modern versions of gcc, e.g. on Ubuntu
> 20.04.
>
> main.c:77:37: warning: ‘__builtin___snprintf_chk’ output truncated before the last format character [-Wformat-truncation=]
>     77 |     "%02x:%02x:%02x:%02x:%02x:%02x\n",
>        |                                     ^
>
> Since the \n is getting stripped anyway, we can fix the issue by just
> removing it. In the process we can switch to using the standard ethernet
> address formating function from rte_ether.h.
>
> Fixes: af75078fece3 ("first public release")
> Cc: stable@dpdk.org
> Cc: Stephen Hemminger <stephen@networkplumber.org>
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>
> ---
> V2: switched code to use standard formatting function
> ---

Acked-by: Radu Nicolau <radu.nicolau@intel.com>

[dpdk-dev] [PATCH v3 0/3] fixes for example app builds

[Bruce Richardson]

While helping prepare some patches for converting the DPDK examples to
build using pkg-config, a number of errors and warnings were encountered in
the example app builds. These patches fix those issues.

v3:
	Dropped patch 1, since other approaches to fix this are being
	investigated, as discussed in other threads on-list.

v2:
	Changed to use standard ether-address formatting function in first
	mp_server patch.

Bruce Richardson (3):
  examples/vm_power_manager: fix string truncation warning
  examples/mp_server: fix snprintf overflow
  examples/mp_server: clear string truncation warning

 .../client_server_mp/mp_server/main.c           | 17 ++++++++++-------
 .../client_server_mp/shared/common.h            |  2 +-
 examples/vm_power_manager/channel_manager.c     | 10 ++++++++--
 3 files changed, 19 insertions(+), 10 deletions(-)

-- 
2.25.1

[dpdk-dev] [PATCH v3 1/3] examples/vm_power_manager: fix string truncation warning

[Bruce Richardson]

When compiling on ubuntu 20.04, a warning was issued about possible
truncation of the path string for the power management socket.

channel_manager.c: In function ‘add_all_channels’:
channel_manager.c:470:41: warning: ‘%s’ directive output may be truncated writing up to 255 bytes into a region of size 90 [-Wformat-truncation=]
  470 |     sizeof(chan_info->channel_path), "%s%s",
      |                                         ^~

This can be fixed by adding in an explicit truncation check to the code and
handling it appropriately.

Fixes: e8ae9b662506 ("examples/vm_power: channel manager and monitor in host")
Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: David Hunt <david.hunt@intel.com>
---
 examples/vm_power_manager/channel_manager.c | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/examples/vm_power_manager/channel_manager.c b/examples/vm_power_manager/channel_manager.c
index 74a2a677e..a26315051 100644
--- a/examples/vm_power_manager/channel_manager.c
+++ b/examples/vm_power_manager/channel_manager.c
@@ -467,9 +467,15 @@ add_all_channels(const char *vm_name)
 			continue;
 		}
 
-		snprintf(chan_info->channel_path,
+		if ((size_t)snprintf(chan_info->channel_path,
 				sizeof(chan_info->channel_path), "%s%s",
-				CHANNEL_MGR_SOCKET_PATH, dir->d_name);
+				CHANNEL_MGR_SOCKET_PATH, dir->d_name)
+					>= sizeof(chan_info->channel_path)) {
+			RTE_LOG(ERR, CHANNEL_MANAGER, "Pathname too long for channel '%s%s'\n",
+					CHANNEL_MGR_SOCKET_PATH, dir->d_name);
+			rte_free(chan_info);
+			continue;
+		}
 
 		if (setup_channel_info(&vm_info, &chan_info, channel_num) < 0) {
 			rte_free(chan_info);
-- 
2.25.1

[dpdk-dev] [PATCH v3 2/3] examples/mp_server: fix snprintf overflow

[Bruce Richardson]

When producing a printable mac address the buffer was appropriately sized
for holding the mac address exactly, but the actual snprintf included a
'\n' character at the end, which means that the snprintf technically is
getting truncated i.e. the \n would not be added due to lack of space.
This gets flagged as a problem by modern versions of gcc, e.g. on Ubuntu
20.04.

main.c:77:37: warning: ‘__builtin___snprintf_chk’ output truncated before the last format character [-Wformat-truncation=]
   77 |     "%02x:%02x:%02x:%02x:%02x:%02x\n",
      |                                     ^

Since the \n is getting stripped anyway, we can fix the issue by just
removing it. In the process we can switch to using the standard ethernet
address formating function from rte_ether.h.

Fixes: af75078fece3 ("first public release")
Cc: stable@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Radu Nicolau <radu.nicolau@intel.com>
---
V2: switched code to use standard formatting function
---

 .../client_server_mp/mp_server/main.c           | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/examples/multi_process/client_server_mp/mp_server/main.c b/examples/multi_process/client_server_mp/mp_server/main.c
index ec7f6b11f..b18e12dd4 100644
--- a/examples/multi_process/client_server_mp/mp_server/main.c
+++ b/examples/multi_process/client_server_mp/mp_server/main.c
@@ -59,12 +59,17 @@ static struct client_rx_buf *cl_rx_buf;
 static const char *
 get_printable_mac_addr(uint16_t port)
 {
-	static const char err_address[] = "00:00:00:00:00:00";
-	static char addresses[RTE_MAX_ETHPORTS][sizeof(err_address)];
+	static const struct rte_ether_addr null_mac; /* static defaults to 0 */
+	static char err_address[32];
+	static char addresses[RTE_MAX_ETHPORTS][32];
 	int ret;
 
-	if (unlikely(port >= RTE_MAX_ETHPORTS))
+	if (unlikely(port >= RTE_MAX_ETHPORTS)) {
+		if (err_address[0] == '\0')
+			rte_ether_format_addr(err_address,
+					sizeof(err_address), &null_mac);
 		return err_address;
+	}
 	if (unlikely(addresses[port][0]=='\0')){
 		struct rte_ether_addr mac;
 		ret = rte_eth_macaddr_get(port, &mac);
@@ -73,10 +78,8 @@ get_printable_mac_addr(uint16_t port)
 			       port, rte_strerror(-ret));
 			return err_address;
 		}
-		snprintf(addresses[port], sizeof(addresses[port]),
-				"%02x:%02x:%02x:%02x:%02x:%02x\n",
-				mac.addr_bytes[0], mac.addr_bytes[1], mac.addr_bytes[2],
-				mac.addr_bytes[3], mac.addr_bytes[4], mac.addr_bytes[5]);
+		rte_ether_format_addr(addresses[port],
+				sizeof(addresses[port]), &mac);
 	}
 	return addresses[port];
 }
-- 
2.25.1

[dpdk-dev] [PATCH v3 3/3] examples/mp_server: clear string truncation warning

[Bruce Richardson]

Compiling with GCC 9.3 on Ubuntu 20.04 gives a warning about possible
string truncation when getting the RX queue name:

In file included from init.c:36:
init.c: In function ‘init’:
../shared/common.h:38:28: warning: ‘%u’ directive output may be truncated writing between 1 and 10 bytes into a region of size 8 [-Wformat-truncation=]
   38 | #define MP_CLIENT_RXQ_NAME "MProc_Client_%u_RX"
      |                            ^~~~~~~~~~~~~~~~~~~~
../shared/common.h:52:35: note: in expansion of macro ‘MP_CLIENT_RXQ_NAME’
   52 |  snprintf(buffer, sizeof(buffer), MP_CLIENT_RXQ_NAME, id);
      |                                   ^~~~~~~~~~~~~~~~~~

This is a false positive, as the value of the "id" is limited to 255, being
stored in the app as a uint8_t value, removing the possibility of the %u
being replaced by anything other then 3 characters max (rather than up to
10 as thought by the compiler). Therefore, the warning can be easily
removed by changing the type of the "id" parameter to the local function
from "unsigned" to "uint8_t" also, ensuring the compiler is aware of the
range limit.

Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Radu Nicolau <radu.nicolau@intel.com>
---
 examples/multi_process/client_server_mp/shared/common.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/examples/multi_process/client_server_mp/shared/common.h b/examples/multi_process/client_server_mp/shared/common.h
index 6dd43fcac..76beca010 100644
--- a/examples/multi_process/client_server_mp/shared/common.h
+++ b/examples/multi_process/client_server_mp/shared/common.h
@@ -43,7 +43,7 @@ struct port_info {
  * Given the rx queue name template above, get the queue name
  */
 static inline const char *
-get_rx_queue_name(unsigned id)
+get_rx_queue_name(uint8_t id)
 {
 	/* buffer for return value. Size calculated by %u being replaced
 	 * by maximum 3 digits (plus an extra byte for safety) */
-- 
2.25.1

Re: [dpdk-dev] [PATCH v3 0/3] fixes for example app builds

[David Marchand]

On Wed, Oct 28, 2020 at 5:27 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> While helping prepare some patches for converting the DPDK examples to
> build using pkg-config, a number of errors and warnings were encountered in
> the example app builds. These patches fix those issues.

Series applied, thanks.


-- 
David Marchand