linux-cxl.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Verma, Vishal L" <vishal.l.verma@intel.com>
To: "Williams, Dan J" <dan.j.williams@intel.com>
Cc: "Widawsky, Ben" <ben.widawsky@intel.com>,
	"linux-cxl@vger.kernel.org" <linux-cxl@vger.kernel.org>,
	"nvdimm@lists.linux.dev" <nvdimm@lists.linux.dev>
Subject: Re: [ndctl PATCH v4 09/17] util/hexdump: Add a util helper to print a buffer in hex
Date: Thu, 14 Oct 2021 20:33:03 +0000	[thread overview]
Message-ID: <39a3f49daff50d8065e95cf4cd5ef4268d3a1c18.camel@intel.com> (raw)
In-Reply-To: <CAPcyv4gRM_3UxQkKxLg_up-zNecyTjrvG1CAuJyF1Wd+9bwfUA@mail.gmail.com>

On Thu, 2021-10-14 at 09:48 -0700, Dan Williams wrote:
> On Thu, Oct 7, 2021 at 1:22 AM Vishal Verma <vishal.l.verma@intel.com> wrote:
> > 
> > In preparation for tests that may need to set, retrieve, and display
> > opaque data, add a hexdump function in util/
> > 
> > Cc: Ben Widawsky <ben.widawsky@intel.com>
> > Cc: Dan Williams <dan.j.williams@intel.com>
> > Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
> > ---
> >  util/hexdump.h |  8 ++++++++
> >  util/hexdump.c | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++
> 
> If this is just for tests shouldn't it go in tests/ with the other
> common test helpers? If it stays in util/ I would kind of expect it to
> use the log infrastructure, no?

Agreed on using the log infra. I was originally using it in the old
test stuff, but right now there's no user for it.. However having
something like this was nice when developing the early cmd submission
stuff. Do you think it would be good to always do a hexdump with dbg()
when under --verbose for evert cxl_cmd_submit? (and maybe even add it
for ndctl_cmd_submit later too) Or is that too noisy?

If we want to do that then it makes sense to redo with the logging api,
else maybe jsut drop this until we have a real in-tree user?

> 
> Other than that looks ok to me:
> 
> Reviewed-by: Dan Williams <dan.j.williams@intel.com>
> 
> >  2 files changed, 61 insertions(+)
> >  create mode 100644 util/hexdump.h
> >  create mode 100644 util/hexdump.c
> > 
> > diff --git a/util/hexdump.h b/util/hexdump.h
> > new file mode 100644
> > index 0000000..d322b6a
> > --- /dev/null
> > +++ b/util/hexdump.h
> > @@ -0,0 +1,8 @@
> > +/* SPDX-License-Identifier: GPL-2.0 */
> > +/* Copyright (C) 2021 Intel Corporation. All rights reserved. */
> > +#ifndef _UTIL_HEXDUMP_H_
> > +#define _UTIL_HEXDUMP_H_
> > +
> > +void hex_dump_buf(unsigned char *buf, int size);
> > +
> > +#endif /* _UTIL_HEXDUMP_H_*/
> > diff --git a/util/hexdump.c b/util/hexdump.c
> > new file mode 100644
> > index 0000000..1ab0118
> > --- /dev/null
> > +++ b/util/hexdump.c
> > @@ -0,0 +1,53 @@
> > +// SPDX-License-Identifier: GPL-2.0
> > +/* Copyright (C) 2015-2021 Intel Corporation. All rights reserved. */
> > +#include <stdio.h>
> > +#include <util/hexdump.h>
> > +
> > +static void print_separator(int len)
> > +{
> > +       int i;
> > +
> > +       for (i = 0; i < len; i++)
> > +               fprintf(stderr, "-");
> > +       fprintf(stderr, "\n");
> > +}
> > +
> > +void hex_dump_buf(unsigned char *buf, int size)
> > +{
> > +       int i;
> > +       const int grp = 4;  /* Number of bytes in a group */
> > +       const int wid = 16; /* Bytes per line. Should be a multiple of grp */
> > +       char ascii[wid + 1];
> > +
> > +       /* Generate header */
> > +       print_separator((wid * 4) + (wid / grp) + 12);
> > +
> > +       fprintf(stderr, "Offset    ");
> > +       for (i = 0; i < wid; i++) {
> > +               if (i % grp == 0) fprintf(stderr, " ");
> > +               fprintf(stderr, "%02x ", i);
> > +       }
> > +       fprintf(stderr, "  Ascii\n");
> > +
> > +       print_separator((wid * 4) + (wid / grp) + 12);
> > +
> > +       /* Generate hex dump */
> > +       for (i = 0; i < size; i++) {
> > +               if (i % wid == 0) fprintf(stderr, "%08x  ", i);
> > +               ascii[i % wid] =
> > +                   ((buf[i] >= ' ') && (buf[i] <= '~')) ? buf[i] : '.';
> > +               if (i % grp == 0) fprintf(stderr, " ");
> > +               fprintf(stderr, "%02x ", buf[i]);
> > +               if ((i == size - 1) && (size % wid != 0)) {
> > +                       int j;
> > +                       int done = size % wid;
> > +                       int grps_done = (done / grp) + ((done % grp) ? 1 : 0);
> > +                       int spaces = wid / grp - grps_done + ((wid - done) * 3);
> > +
> > +                       for (j = 0; j < spaces; j++) fprintf(stderr, " ");
> > +               }
> > +               if ((i % wid == wid - 1) || (i == size - 1))
> > +                       fprintf(stderr, "  %.*s\n", (i % wid) + 1, ascii);
> > +       }
> > +       print_separator((wid * 4) + (wid / grp) + 12);
> > +}
> > --
> > 2.31.1
> > 
> 


  reply	other threads:[~2021-10-14 20:33 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-07  8:21 [ndctl PATCH v4 00/17] Initial CXL support Vishal Verma
2021-10-07  8:21 ` [ndctl PATCH v4 01/17] ndctl: add .clang-format Vishal Verma
2021-10-07  8:21 ` [ndctl PATCH v4 02/17] cxl: add a cxl utility and libcxl library Vishal Verma
2021-10-07  8:21 ` [ndctl PATCH v4 03/17] cxl: add a local copy of the cxl_mem UAPI header Vishal Verma
2021-10-07  8:21 ` [ndctl PATCH v4 04/17] util: add the struct_size() helper from the kernel Vishal Verma
2021-10-14  2:40   ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 05/17] libcxl: add support for command query and submission Vishal Verma
2021-10-14  2:53   ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 06/17] libcxl: add support for the 'Identify Device' command Vishal Verma
2021-10-07  8:21 ` [ndctl PATCH v4 07/17] libcxl: add GET_HEALTH_INFO mailbox command and accessors Vishal Verma
2021-10-14 16:01   ` Dan Williams
2021-11-02 20:22     ` Verma, Vishal L
2021-11-02 20:27       ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 08/17] libcxl: add support for the 'GET_LSA' command Vishal Verma
2021-10-14 16:35   ` Dan Williams
2021-10-14 20:06     ` Verma, Vishal L
2021-10-14 20:55       ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 09/17] util/hexdump: Add a util helper to print a buffer in hex Vishal Verma
2021-10-14 16:48   ` Dan Williams
2021-10-14 20:33     ` Verma, Vishal L [this message]
2021-10-14 22:39       ` Dan Williams
2021-11-02 20:25         ` Verma, Vishal L
2021-10-07  8:21 ` [ndctl PATCH v4 10/17] libcxl: add label_size to cxl_memdev, and an API to retrieve it Vishal Verma
2021-10-14 18:24   ` Dan Williams
2021-10-14 21:50     ` Verma, Vishal L
2021-10-07  8:21 ` [ndctl PATCH v4 11/17] libcxl: add a stub interface to determine whether a memdev is active Vishal Verma
2021-10-14 19:59   ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 12/17] libcxl: add interfaces for label operations Vishal Verma
2021-10-14 21:27   ` Dan Williams
2021-10-14 22:18     ` Verma, Vishal L
2021-10-14 22:24     ` Verma, Vishal L
2021-10-14 22:45       ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 13/17] cxl: add commands to read, write, and zero labels Vishal Verma
2021-10-14 22:34   ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 14/17] Documentation/cxl: add library API documentation Vishal Verma
2021-10-14 23:31   ` Dan Williams
2021-11-05 18:58   ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 15/17] ndctl: Add CXL packages to the RPM spec Vishal Verma
2021-10-14 23:33   ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 16/17] cxl-cli: add bash completion Vishal Verma
2021-10-14 23:34   ` Dan Williams
2021-10-07  8:21 ` [ndctl PATCH v4 17/17] cxl: add health information to cxl-list Vishal Verma
2021-10-11 22:07   ` Verma, Vishal L
2021-10-15  0:09     ` Dan Williams
2021-10-14 23:42   ` Verma, Vishal L
2021-10-15 21:15     ` Dan Williams

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=39a3f49daff50d8065e95cf4cd5ef4268d3a1c18.camel@intel.com \
    --to=vishal.l.verma@intel.com \
    --cc=ben.widawsky@intel.com \
    --cc=dan.j.williams@intel.com \
    --cc=linux-cxl@vger.kernel.org \
    --cc=nvdimm@lists.linux.dev \
    --subject='Re: [ndctl PATCH v4 09/17] util/hexdump: Add a util helper to print a buffer in hex' \
    /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

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).