It's common to use %' in the printf format specifier to make large numbers
more easily readable by having the thousands grouped. However, this
grouping does not work on Windows. Therefore, a function is needed to make
uint64_t numbers more easily readable. There are at least two tests that
can benefit from this new function.
Signed-off-by: Andre Muezerie <andre...@linux.microsoft.com>
---
lib/eal/common/eal_common_string_fns.c | 53 ++++++++++++++++++++++++++
lib/eal/include/rte_common.h | 34 +++++++++++++++++
lib/eal/version.map | 3 ++
3 files changed, 90 insertions(+)
diff --git a/lib/eal/common/eal_common_string_fns.c
b/lib/eal/common/eal_common_string_fns.c
index 9ca2045b18..bda7d076c5 100644
--- a/lib/eal/common/eal_common_string_fns.c
+++ b/lib/eal/common/eal_common_string_fns.c
@@ -4,6 +4,7 @@
#include <ctype.h>
#include <errno.h>
+#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
@@ -87,6 +88,12 @@ rte_str_to_size(const char *str)
endptr++; /* allow 1 space gap */
switch (*endptr) {
+ case 'E': case 'e':
+ size *= 1024; /* fall-through */
+ case 'P': case 'p':
+ size *= 1024; /* fall-through */
+ case 'T': case 't':
+ size *= 1024; /* fall-through */
case 'G': case 'g':
size *= 1024; /* fall-through */
case 'M': case 'm':
@@ -98,3 +105,49 @@ rte_str_to_size(const char *str)
}
return size;
}
+
+char*
+rte_size_to_str(char *buf, int buf_size, uint64_t count, bool use_iec, const
char *unit)
+{
+ /* https://en.wikipedia.org/wiki/International_System_of_Units */
+ const char *prefix = "kMGTPE";
+ const unsigned int base = use_iec ? 1024 : 1000;
+ uint64_t powi = 1;
+ uint16_t powj = 1;
+ uint8_t precision = 2;
+ int result;
+
+ if (count < base) {
+ if (unit != NULL && *unit != '\0')
+ result = snprintf(buf, buf_size, "%"PRIu64" %s", count,
unit);
+ else
+ result = snprintf(buf, buf_size, "%"PRIu64, count);
+
+ return result < buf_size ? buf : NULL;
+ }
+
+ /* increase value by a factor of 1000/1024 and store
+ * if result is something a human can read
+ */
+ for (;;) {
+ powi *= base;
+ if (count / powi < base)
+ break;
+
+ if (prefix[1] == '\0')
+ break;
+ ++prefix;
+ }
+
+ /* try to guess a good number of digits for precision */
+ for (; precision > 0; precision--) {
+ powj *= 10;
+ if (count / powi < powj)
+ break;
+ }
+
+ result = snprintf(buf, buf_size, "%.*f %c%s%s", precision,
+ (double)count / powi, *prefix, use_iec ? "i" : "",
+ (unit != NULL) ? unit : "");
+ return result < buf_size ? buf : NULL;
+}
diff --git a/lib/eal/include/rte_common.h b/lib/eal/include/rte_common.h
index 386f11ae40..a6085dce27 100644
--- a/lib/eal/include/rte_common.h
+++ b/lib/eal/include/rte_common.h
@@ -14,9 +14,11 @@
#include <assert.h>
#include <limits.h>
+#include <stdbool.h>
#include <stdint.h>
#include <stdalign.h>
+#include <rte_compat.h>
#include <rte_config.h>
/* OS specific include */
@@ -919,6 +921,38 @@ __extension__ typedef uint64_t RTE_MARKER64[0];
uint64_t
rte_str_to_size(const char *str);
+/**
+ * Converts the uint64_t value provided to a human-readable string.
+ * It null-terminates the string, truncating the data if needed.
+ * An optional unit (like "B") can be provided as a string. It will be
+ * appended to the number, and a space will be inserted before the unit if
needed.
+ *
+ * Sample outputs: (1) "use_iec" disabled, (2) "use_iec" enabled,
+ * (3) "use_iec" enabled and "B" as unit.
+ * 0 : "0", "0", "0 B"
+ * 700 : "700", "700", "700 B"
+ * 1000 : "1.00 k", "1000", "1000 B"
+ * 1024 : "1.02 k", "1.00 ki", "1.00 kiB"
+ * 21474836480 : "21.5 G", "20.0 Gi", "20.0 GiB"
+ * 109951162777600 : "110 T", "100 Ti", "100 TiB"
+ *
+ * @param buf
+ * Buffer to write the string to.
+ * @param buf_size
+ * Size of the buffer.
+ * @param count
+ * Number to convert.
+ * @param use_iec
+ * If true, use IEC units (1024-based), otherwise use SI units
(1000-based).
+ * @param unit
+ * Unit to append to the string (Like "B" for bytes). Can be NULL.
+ * @return
+ * buf on success, NULL if the buffer is too small.
+ */
+__rte_experimental
+char *
+rte_size_to_str(char *buf, int buf_size, uint64_t count, bool use_iec, const
char *unit);
+
/**
* Function to terminate the application immediately, printing an error
* message and returning the exit_code back to the shell.
diff --git a/lib/eal/version.map b/lib/eal/version.map
index a20c713eb1..01b6a7c190 100644
--- a/lib/eal/version.map
+++ b/lib/eal/version.map
@@ -398,6 +398,9 @@ EXPERIMENTAL {
# added in 24.11
rte_bitset_to_str;
rte_lcore_var_alloc;
+
+ # added in 25.07
+ rte_size_to_str;
};
INTERNAL {
--
2.48.1.vfs.0.1
