From: Kent Overstreet <kent.overstreet@linux.dev>
To: akpm@linux-foundation.org
Cc: linux-kernel@vger.kernel.org,
Kent Overstreet <kent.overstreet@gmail.com>
Subject: [PATCH 08/32] lib/printbuf: Unit specifiers
Date: Sun, 14 Aug 2022 17:19:47 -0400 [thread overview]
Message-ID: <20220814212011.1727798-9-kent.overstreet@linux.dev> (raw)
In-Reply-To: <20220814212011.1727798-1-kent.overstreet@linux.dev>
From: Kent Overstreet <kent.overstreet@gmail.com>
This adds options to printbuf for specifying whether units should be
printed raw (default) or with human readable units, and for controlling
whether human-readable units should be base 2 (default), or base 10.
This also adds new helpers that obey these options:
- pr_human_readable_u64
- pr_human_readable_s64
These obey printbuf->si_units
- pr_units_u64
- pr_units_s64
These obey both printbuf-human_readable_units and printbuf->si_units
Signed-off-by: Kent Overstreet <kent.overstreet@gmail.com>
---
include/linux/printbuf.h | 15 +++++++++++
lib/printbuf.c | 57 ++++++++++++++++++++++++++++++++++++++++
2 files changed, 72 insertions(+)
diff --git a/include/linux/printbuf.h b/include/linux/printbuf.h
index c1a482b6c0..ebbc4a55fc 100644
--- a/include/linux/printbuf.h
+++ b/include/linux/printbuf.h
@@ -57,11 +57,20 @@
*
* Make sure you use prt_newline() instead of \n in the format string for indent
* level and tabstops to work corretly.
+ *
+ * Output units: printbuf->units exists to tell pretty-printers how to output
+ * numbers: a raw value (e.g. directly from a superblock field), as bytes, or as
+ * human readable bytes. prt_units() obeys it.
*/
#include <linux/kernel.h>
#include <linux/string.h>
+enum printbuf_si {
+ PRINTBUF_UNITS_2, /* use binary powers of 2^10 */
+ PRINTBUF_UNITS_10, /* use powers of 10^3 (standard SI) */
+};
+
struct printbuf {
char *buf;
unsigned size;
@@ -75,6 +84,8 @@ struct printbuf {
u8 atomic;
bool allocation_failure:1;
bool heap_allocated:1;
+ enum printbuf_si si_units:1;
+ bool human_readable_units:1;
u8 tabstop;
u8 tabstops[4];
};
@@ -88,6 +99,10 @@ void printbuf_indent_add(struct printbuf *, unsigned);
void printbuf_indent_sub(struct printbuf *, unsigned);
void prt_tab(struct printbuf *);
void prt_tab_rjust(struct printbuf *);
+void prt_human_readable_u64(struct printbuf *, u64);
+void prt_human_readable_s64(struct printbuf *, s64);
+void prt_units_u64(struct printbuf *, u64);
+void prt_units_s64(struct printbuf *, s64);
/* Initializer for a heap allocated printbuf: */
#define PRINTBUF ((struct printbuf) { .heap_allocated = true })
diff --git a/lib/printbuf.c b/lib/printbuf.c
index 395c681e3a..0474700257 100644
--- a/lib/printbuf.c
+++ b/lib/printbuf.c
@@ -10,6 +10,7 @@
#include <linux/err.h>
#include <linux/slab.h>
+#include <linux/string_helpers.h>
#include <linux/printbuf.h>
static inline size_t printbuf_linelen(struct printbuf *buf)
@@ -199,3 +200,59 @@ void prt_tab_rjust(struct printbuf *buf)
buf->tabstop++;
}
EXPORT_SYMBOL(prt_tab_rjust);
+
+/**
+ * prt_human_readable_u64 - Print out a u64 in human readable units
+ *
+ * Units of 2^10 (default) or 10^3 are controlled via @buf->si_units
+ */
+void prt_human_readable_u64(struct printbuf *buf, u64 v)
+{
+ printbuf_make_room(buf, 10);
+ buf->pos += string_get_size(v, 1, !buf->si_units,
+ buf->buf + buf->pos,
+ printbuf_remaining_size(buf));
+}
+EXPORT_SYMBOL(prt_human_readable_u64);
+
+/**
+ * prt_human_readable_s64 - Print out a s64 in human readable units
+ *
+ * Units of 2^10 (default) or 10^3 are controlled via @buf->si_units
+ */
+void prt_human_readable_s64(struct printbuf *buf, s64 v)
+{
+ if (v < 0)
+ prt_char(buf, '-');
+ prt_human_readable_u64(buf, abs(v));
+}
+EXPORT_SYMBOL(prt_human_readable_s64);
+
+/**
+ * prt_units_u64 - Print out a u64 according to printbuf unit options
+ *
+ * Units are either raw (default), or human reabable units (controlled via
+ * @buf->human_readable_units)
+ */
+void prt_units_u64(struct printbuf *out, u64 v)
+{
+ if (out->human_readable_units)
+ prt_human_readable_u64(out, v);
+ else
+ prt_printf(out, "%llu", v);
+}
+EXPORT_SYMBOL(prt_units_u64);
+
+/**
+ * prt_units_s64 - Print out a s64 according to printbuf unit options
+ *
+ * Units are either raw (default), or human reabable units (controlled via
+ * @buf->human_readable_units)
+ */
+void prt_units_s64(struct printbuf *out, s64 v)
+{
+ if (v < 0)
+ prt_char(out, '-');
+ prt_units_u64(out, abs(v));
+}
+EXPORT_SYMBOL(prt_units_s64);
--
2.36.1
next prev parent reply other threads:[~2022-08-14 21:21 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-14 21:19 Printbufs v6 Kent Overstreet
2022-08-14 21:19 ` [PATCH 01/32] lib/printbuf: New data structure for printing strings Kent Overstreet
2022-08-14 21:19 ` [PATCH 02/32] lib/string_helpers: Convert string_escape_mem() to printbuf Kent Overstreet
2022-08-14 21:19 ` [PATCH 03/32] vsprintf: Convert " Kent Overstreet
2022-08-14 21:19 ` [PATCH 04/32] lib/hexdump: " Kent Overstreet
2022-08-14 21:19 ` [PATCH 05/32] lib/string_helpers: string_get_size() now returns characters wrote Kent Overstreet
2022-08-14 21:19 ` [PATCH 06/32] lib/printbuf: Heap allocation Kent Overstreet
2022-08-14 21:19 ` [PATCH 07/32] lib/printbuf: Tabstops, indenting Kent Overstreet
2022-08-14 21:19 ` Kent Overstreet [this message]
2022-08-14 21:19 ` [PATCH 09/32] vsprintf: Improve number() Kent Overstreet
2022-08-14 21:19 ` [PATCH 10/32] vsprintf: prt_u64_minwidth(), prt_u64() Kent Overstreet
2022-08-14 21:19 ` [PATCH 11/32] test_printf: Drop requirement that sprintf not write past nul Kent Overstreet
2022-08-14 21:19 ` [PATCH 12/32] vsprintf: Start consolidating printf_spec handling Kent Overstreet
2022-08-14 21:19 ` [PATCH 13/32] vsprintf: Refactor resource_string() Kent Overstreet
2022-08-14 21:19 ` [PATCH 14/32] vsprintf: Refactor fourcc_string() Kent Overstreet
2022-08-14 21:19 ` [PATCH 15/32] vsprintf: Refactor ip_addr_string() Kent Overstreet
2022-08-14 21:19 ` [PATCH 16/32] vsprintf: Refactor mac_address_string() Kent Overstreet
2022-08-14 21:19 ` [PATCH 17/32] vsprintf: time_and_date() no longer takes printf_spec Kent Overstreet
2022-08-14 21:19 ` [PATCH 18/32] vsprintf: flags_string() " Kent Overstreet
2022-08-14 21:19 ` [PATCH 19/32] vsprintf: Refactor device_node_string, fwnode_string Kent Overstreet
2022-08-14 21:19 ` [PATCH 20/32] vsprintf: Refactor hex_string, bitmap_string_list, bitmap_string Kent Overstreet
2022-08-14 21:20 ` [PATCH 21/32] Input/joystick/analog: Convert from seq_buf -> printbuf Kent Overstreet
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=20220814212011.1727798-9-kent.overstreet@linux.dev \
--to=kent.overstreet@linux.dev \
--cc=akpm@linux-foundation.org \
--cc=kent.overstreet@gmail.com \
--cc=linux-kernel@vger.kernel.org \
/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).