Re: [PATCH v4 2/3] efi/cper: Add a new helper function to print bitmasks

[Mauro Carvalho Chehab <mchehab+huawei@kernel.org>]

Em Fri, 21 Jun 2024 10:20:36 +0100
Jonathan Cameron <Jonathan.Cameron@Huawei.com> escreveu:

> On Thu, 20 Jun 2024 20:01:45 +0200
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> 
> > Sometimes it is desired to produce a single log line for errors.
> > Add a new helper function for such purpose.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >  drivers/firmware/efi/cper.c | 59 +++++++++++++++++++++++++++++++++++++
> >  include/linux/cper.h        |  3 ++
> >  2 files changed, 62 insertions(+)
> > 
> > diff --git a/drivers/firmware/efi/cper.c b/drivers/firmware/efi/cper.c
> > index 7d2cdd9e2227..9bf27af3e870 100644
> > --- a/drivers/firmware/efi/cper.c
> > +++ b/drivers/firmware/efi/cper.c
> > @@ -106,6 +106,65 @@ void cper_print_bits(const char *pfx, unsigned int bits,
> >  		printk("%s\n", buf);
> >  }
> >  
> > +/*  
> 
> It's exported and in a header used by other code, so why not make
> this kernel-doc? /**

I tried to preserve the original non-kernel-doc way, as I'm not sure
why other comments on this file are not marked as kernel-doc stuff.

The code there at cper.c also has other coding style issues - for
instance it uses printk() without an error level.

Anyway, I intend to submit later on a separate patch series converting
the existing function documentation stuff to kernel-doc (and adding to
Documentation if not there already), and maybe addressing some other
coding style issues.

Yet, I would prefer to have such changes out of this fix patch series.

> > + * cper_bits_to_str - return a string for set bits
> > + * @buf: buffer to store the output string
> > + * @buf_size: size of the output string buffer
> > + * @bits: bit mask
> > + * @strs: string array, indexed by bit position
> > + * @strs_size: size of the string array: @strs  
> 
> If it had been kernel doc, W=1 would have told you mask is
> missing.

Yeah, I saw that just after hitting send :-) I'll add mask at
v5.

> Passing a 0 for mask seems probably not worth while.
> If all bits of the unsigned int are set then people can pass ~0

Makes sense.

> 
> Or make this cper_bits_to_str_masked() and have
> cper_bits_to_str() that doesn't take a mask.
> 
> If you do that, some simplifications can be easily made.
> 
> 
> 
> > + *
> > + * add to @buf the bitmask in hexadecimal. Then, for each set bit in @bits,
> > + * add the corresponding string in @strs to @buf.
> > + */
> > +char *cper_bits_to_str(char *buf, int buf_size, unsigned int bits,  
> 
> Perhaps make bits an unsigned long as then you can use the
> for_each_set_bit() etc.

Ok.

> 
> > +		       const char * const strs[], unsigned int strs_size,
> > +		       unsigned int mask)
> > +{
> > +	int i, size, first_bit;
> > +	int len = buf_size;
> > +	const char *start;
> > +	char *str = buf;
> > +
> > +	if (strs_size < 16)
> > +		size = snprintf(str, len, "0x%02x: ", bits);
> > +	if (strs_size < 32)
> > +		size = snprintf(str, len, "0x%04x: ", bits);
> > +
> > +	len -= size;
> > +	str += size;
> > +
> > +	start = str;
> > +
> > +	if (mask) {
> > +		first_bit = ffs(mask) - 1;
> > +		if (bits & ~mask) {
> > +			size = strscpy(str, "reserved bit(s)", len);
> > +			len -= size;
> > +			str += size;
> > +		}
> > +	} else {
> > +		first_bit = 0;
> > +	}  
> Might be worth
> 
> 	bits = bits & mask;

No need to to that if we use for_each_set_bit().

> 
> Obviously setting bits that aren't in the mask is
> odd though so maybe a warning print if that happens?

The code already warns about that printing:

	"reserved bit(s)"

at the output buffer.

Regards,
Mauro