Re: [PATCH] x86/sgx: Improve comments for sgx_encl_lookup/alloc_backing()

From: Jarkko Sakkinen
Date: Mon Aug 01 2022 - 12:41:44 EST


On Mon, Aug 01, 2022 at 07:40:42PM +0300, Jarkko Sakkinen wrote:
> On Thu, Jul 28, 2022 at 06:47:01AM -0700, Dave Hansen wrote:
> > On 7/28/22 00:58, Jarkko Sakkinen wrote:
> > > On Wed, Jul 20, 2022 at 11:21:19AM -0700, Kristen Carlson Accardi wrote:
> > >> Modify the comments for sgx_encl_lookup_backing() and for
> > >> sgx_encl_alloc_backing() to indicate that they take a reference
> > >> which must be dropped with a call to sgx_encl_put_backing().
> > >> Make sgx_encl_lookup_backing() static for now, and change the
> > >> name of sgx_encl_get_backing() to __sgx_encl_get_backing() to
> > >> make it more clear that sgx_encl_get_backing() is an internal
> > >> function.
> > >>
> > >> Signed-off-by: Kristen Carlson Accardi <kristen@xxxxxxxxxxxxxxx>
> > > The rename is unnecessary.
> >
> > Well, it was done to address some reviewer confusion:
> >
> > https://lore.kernel.org/all/YtUs3MKLzFg+rqEV@xxxxxxx/
> >
> > I wouldn't call it unnecessary. Heck, I'd argue that the one of the
> > main reasons that this code leaked memory in the first place was the
> > naming and lack of comments.
>
> Maybe the rename should be its own patch with this tag in the commit:
>
> Link: https://lore.kernel.org/all/YtUs3MKLzFg+rqEV@xxxxxxx/

Actually, just adding this to the current patch would be fine
(no need to split necessariy).

BR, Jarkko