DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: "Huisong Li" <lihuisong@huawei.com>,
	"Chengwen Feng" <fengchengwen@huawei.com>,
	"Morten Brørup" <mb@smartsharesystems.com>,
	"Bruce Richardson" <bruce.richardson@intel.com>
Subject: [PATCH] telemetry: rework code to avoid compiler warnings
Date: Wed,  8 Feb 2023 14:37:42 +0000	[thread overview]
Message-ID: <20230208143742.493533-1-bruce.richardson@intel.com> (raw)

When printing values as hex strings, the telemetry code temporarily
disabled warnings about non-literal format strings. This was because the
actual format string was built-up programmatically to ensure the output
was of the desired bitwidth.

However, this code can be reworked and shortened by taking advantage of
the "*" printf flag, which is used to specify that the output width is
given by a separate printf parameter. This allows the format to be a
literal string in all cases, and also allows the code in the function to
be shortened considerably.

Note: the type of the width should be an "int" variable, which is why
this patch changes the type of the existing variable. Also, while we
could shorten the format string by using the "#" flag in place of an
explicit "0x", this would make the code more confusing because it would
mean that the "0x" would be included in the specified with, forcing us
to add 2 to the existing computed width.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/telemetry/telemetry_data.c | 38 +++++++---------------------------
 1 file changed, 7 insertions(+), 31 deletions(-)

diff --git a/lib/telemetry/telemetry_data.c b/lib/telemetry/telemetry_data.c
index eb3cb98176..2bac2de2c2 100644
--- a/lib/telemetry/telemetry_data.c
+++ b/lib/telemetry/telemetry_data.c
@@ -119,45 +119,21 @@ rte_tel_data_add_array_container(struct rte_tel_data *d,
 	return 0;
 }
 
-/* To suppress compiler warning about format string. */
-#if defined(RTE_TOOLCHAIN_GCC)
-#pragma GCC diagnostic push
-#pragma GCC diagnostic ignored "-Wformat-nonliteral"
-#elif defined(RTE_TOOLCHAIN_CLANG)
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wformat-nonliteral"
-#endif
-
 static int
 rte_tel_uint_to_hex_encoded_str(char *buf, size_t buf_len, uint64_t val,
 				uint8_t display_bitwidth)
 {
-#define RTE_TEL_HEX_FORMAT_LEN 16
-
-	uint8_t spec_hex_width = (display_bitwidth + 3) / 4;
-	char format[RTE_TEL_HEX_FORMAT_LEN];
-
-	if (display_bitwidth != 0) {
-		if (snprintf(format, RTE_TEL_HEX_FORMAT_LEN, "0x%%0%u" PRIx64,
-				spec_hex_width) >= RTE_TEL_HEX_FORMAT_LEN)
-			return -EINVAL;
+	int spec_hex_width = (display_bitwidth + 3) / 4;
+	int len;
 
-		if (snprintf(buf, buf_len, format, val) >= (int)buf_len)
-			return -EINVAL;
-	} else {
-		if (snprintf(buf, buf_len, "0x%" PRIx64, val) >= (int)buf_len)
-			return -EINVAL;
-	}
+	if (display_bitwidth != 0)
+		len = snprintf(buf, buf_len, "0x%0*" PRIx64, spec_hex_width, val);
+	else
+		len = snprintf(buf, buf_len, "0x%" PRIx64, val);
 
-	return 0;
+	return len < (int)buf_len ? 0 : -EINVAL;
 }
 
-#if defined(RTE_TOOLCHAIN_GCC)
-#pragma GCC diagnostic pop
-#elif defined(RTE_TOOLCHAIN_CLANG)
-#pragma clang diagnostic pop
-#endif
-
 int
 rte_tel_data_add_array_uint_hex(struct rte_tel_data *d, uint64_t val,
 				uint8_t display_bitwidth)
-- 
2.37.2


             reply	other threads:[~2023-02-08 14:38 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-08 14:37 Bruce Richardson [this message]
2023-02-08 15:00 ` Morten Brørup
2023-02-08 15:05 ` Wiles, Keith
2023-02-09  1:07 ` fengchengwen
2023-02-09  2:03   ` lihuisong (C)
2023-02-09  7:45 ` David Marchand

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230208143742.493533-1-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=fengchengwen@huawei.com \
    --cc=lihuisong@huawei.com \
    --cc=mb@smartsharesystems.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).