Re: [PATCH 1/2] efi: add a function for transferring status to string

[joeyli]

Hi Mimi,

On Wed, Mar 27, 2019 at 03:04:02PM -0400, Mimi Zohar wrote:
> On Wed, 2019-03-27 at 19:58 +0100, Ard Biesheuvel wrote:
> > On Sun, 24 Mar 2019 at 01:26, Lee, Chun-Yi <joeyli.kernel@xxxxxxxxx> wrote:
> > >
> > > This function can be used to transfer EFI status code to string
> > > for printing out debug message. Using this function can improve
> > > the readability of log.
> 
> Maybe instead of "for transferring status" use "to convert the status
> value to a" in the Subject line and here in the patch description.
>

Thanks for your suggestion. I will change subject and description.
 
> > >
> > > Cc: Ard Biesheuvel <ard.biesheuvel@xxxxxxxxxx>
> > > Cc: Kees Cook <keescook@xxxxxxxxxxxx>
> > > Cc: Anton Vorontsov <anton@xxxxxxxxxx>
> > > Cc: Colin Cross <ccross@xxxxxxxxxxx>
> > > Cc: Tony Luck <tony.luck@xxxxxxxxx>
> > > Signed-off-by: "Lee, Chun-Yi" <jlee@xxxxxxxx>
> > > ---
> > >  include/linux/efi.h | 28 ++++++++++++++++++++++++++++
> > >  1 file changed, 28 insertions(+)
> > >
> > > diff --git a/include/linux/efi.h b/include/linux/efi.h
> > > index 54357a258b35..a43cb0dc37af 100644
> > > --- a/include/linux/efi.h
> > > +++ b/include/linux/efi.h
> > > @@ -1768,4 +1768,32 @@ struct linux_efi_memreserve {
> > >  #define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
> > >         / sizeof(((struct linux_efi_memreserve *)0)->entry[0]))
> > >
> > > +#define EFI_STATUS_STR(_status) \
> > > +case EFI_##_status: \
> > > +       return "EFI_" __stringify(_status);
> > > +
> > > +static inline char *
> > > +efi_status_to_str(efi_status_t status)
> > > +{
> > > +       switch (status) {
> > > +       EFI_STATUS_STR(SUCCESS)
> > > +       EFI_STATUS_STR(LOAD_ERROR)
> > > +       EFI_STATUS_STR(INVALID_PARAMETER)
> > > +       EFI_STATUS_STR(UNSUPPORTED)
> > > +       EFI_STATUS_STR(BAD_BUFFER_SIZE)
> > > +       EFI_STATUS_STR(BUFFER_TOO_SMALL)
> > > +       EFI_STATUS_STR(NOT_READY)
> > > +       EFI_STATUS_STR(DEVICE_ERROR)
> > > +       EFI_STATUS_STR(WRITE_PROTECTED)
> > > +       EFI_STATUS_STR(OUT_OF_RESOURCES)
> > > +       EFI_STATUS_STR(NOT_FOUND)
> > > +       EFI_STATUS_STR(ABORTED)
> > > +       EFI_STATUS_STR(SECURITY_VIOLATION)
> > > +       default:
> > > +               pr_warn("Unknown efi status: 0x%lx", status);
> > > +       }
> > > +
> > > +       return "Unknown efi status";
> > > +}
> > > +
> > >  #endif /* _LINUX_EFI_H */
> > > --
> > > 2.16.4
> > >
> > 
> > Please turn this into a proper function so that not every calling
> > object has to duplicate all these strings.
> 
> Hi Ard,
> 
> Keeping the status values and strings in sync is difficult.  I was
> going to suggest moving the macro immediately after the status value
> definitions.
>

I will move the code to after the status value definitions.

Thanks
Joey Lee