From: Nick Child <nnac123@linux.ibm.com>
To: linux-kernel@vger.kernel.org
Cc: nick.child@ibm.com, netdev@vger.kernel.org,
Nick Child <nnac123@linux.ibm.com>
Subject: [PATCH 0/3] Use new for_each macro to create hexdumps
Date: Mon, 13 Jan 2025 16:17:18 -0600 [thread overview]
Message-ID: <20250113221721.362093-1-nnac123@linux.ibm.com> (raw)
Apologies, not sure what mailing list/tree to target. First 2 patches look
like *-next and last patch should go to net-next.
Currently, obtaining a hexdump can be done through one of the following:
1. hex_dump_to_buffer - takes at most 32 bytes of a buffer and returns a
hexdump string representation
2. print_hex_dump - prints output of hex_dump_to_buffer iteratively over
a large buffer
There is no functionality for iterating over a large buffer and receiving
the string representation. It seems most users of hex_dump_to_buffer are
calling hex_dump_to_buffer within the body of a loop which iterates
through a buffer.
This patchset creates a for_each macro that accepts a buffer and fills
out an output string with the converted hexdump. This loops over the
buffer and takes care of incrementing pointers. Hopefully this makes
writing sequential calls to hex_dump_to_buffer more straightforward.
From a users perspective there should be no difference in output.
The inspiration here was I wanted to use print_hex_dump in ibmvnic code
but I wanted to print through netdevice printing functions to maintain
formatting. Looking at other users of hex_dump_to_buffer it seems they had
similar intentions.
Side question:
hex_dump_to_buffer automatically sets groupsize to 1 if user given
groupsize is not a multiple of len. When printing large buffers this
makes non-uniform output. For example, this is a 31 byte 8 groupsize
buffer:
ibmvnic 30000003 env3: 6c6774732e737561 2e6d62692e736261
ibmvnic 30000003 env3: 63 6f 6d 00 03 00 05 65 6e 76 33 00 00 00 00
Since the second line is only 15 bytes, the group size is set to 1. I
have written a patch which keeps groupsize so output would be:
ibmvnic 30000003 env3: 6c6774732e737561 2e6d62692e736261
ibmvnic 30000003 env3: 636f6d0003000565 6e763300000000
But since I am not sure if this would break some dependency for someone,
and my justification for change is purely pedantic, I chose to omit
that patch in this patchset. Let me know if there is any interest and
I will send a different patchset for that.
Thanks for your consideration/review.
Nick Child (3):
hexdump: Implement macro for converting large buffers
hexdump: Use for_each macro in print_hex_dump
ibmvnic: Print data buffers with kernel API's
drivers/net/ethernet/ibm/ibmvnic.c | 23 ++++++++++++++---------
include/linux/printk.h | 21 +++++++++++++++++++++
lib/hexdump.c | 11 +++--------
3 files changed, 38 insertions(+), 17 deletions(-)
--
2.47.1
next reply other threads:[~2025-01-13 22:17 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-13 22:17 Nick Child [this message]
2025-01-13 22:17 ` [PATCH 1/3] hexdump: Implement macro for converting large buffers Nick Child
2025-01-14 14:48 ` Simon Horman
2025-01-13 22:17 ` [PATCH 2/3] hexdump: Use for_each macro in print_hex_dump Nick Child
2025-01-13 22:17 ` [PATCH 3/3] ibmvnic: Print data buffers with kernel API's Nick Child
2025-01-14 0:04 ` Jacob Keller
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=20250113221721.362093-1-nnac123@linux.ibm.com \
--to=nnac123@linux.ibm.com \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=nick.child@ibm.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
all inboxes | Powered by JetHome®