Re: [PATCH v10] sgx.7: New page with overview of Software Guard eXtensions (SGX)

[Jarkko Sakkinen <jarkko@kernel.org>]

On Mon, Dec 13, 2021 at 11:51:36AM -0800, Reinette Chatre wrote:
> Hi Jarkko,
> 
> On 12/11/2021 7:19 AM, Jarkko Sakkinen wrote:
> > On Wed, 2021-12-08 at 14:11 -0800, Reinette Chatre wrote:
> > > On 11/30/2021 9:50 AM, Jarkko Sakkinen wrote:
> 
> ...
> 
> > > > +.SH SYNOPSIS
> > > > +.EX
> > > > +.B #include <asm/sgx.h>
> > > > +.PP
> > > > +.IB enclave " = open(""/dev/sgx_enclave", " O_RDWR);"
> > > 
> > > I view the man page output using "man -l man7/sgx.7" and when I do so
> > > the above line is unbalanced: "enclave" and (unexpectedly) the comma are
> > > underlined and the line is displayed with a single instance of a double
> > > quote: enclave = open("/dev/sgx_enclave, O_RDWR);
> > 
> > After some trial and error, and looking at symlink.7, this seems to
> > fix it:
> > 
> > -.IB enclave " = open(""/dev/sgx_enclave", " O_RDWR);"
> > +.IB enclave " = open(""/dev/sgx_enclave"", O_RDWR);"
> > 
> > Does this fix for you?
> 
> Yes, thank you. When looking at your updated patch I see that only enclave
> is underlined and the quotes are matching.
> 
> ...
> 
> > > > +is called with higher protections than those defined during the build,
> > > > +it will return
> > > > +.B -EACCES.
> > > > +If
> > > > +.BR ioctl(SGX_IOC_ENCLAVE_ADD_PAGES)
> > > > +is called after
> > > > +.BR mmap (2)
> > > > +with lower protections,
> > > > +the caller receives
> > > > +.BR SIGBUS,
> > > > +once it accesses the page for the first time.
> > > > +.SH VERSIONS
> > > > +The SGX feature was added in Linux 5.11.
> > > 
> > > This does not document the SGX_IOC_VEPC_REMOVE ioctl that was added in
> > > v5.16. How do you envision additions to this page as new features are
> > > added to the Linux support of SGX?
> > 
> > I started this before any of KVM stuff was in upstream. It'd be better
> > to get the basic ioctl's done first. I cannot really give estimate for
> > vepc at this point.
> 
> SGX_IOC_VEPC_REMOVE_ALL can be found in v5.16.

I'd get the basic API documentation ready first and continue to that after
it is final.

> > For future features (e.g. SGX2), the expectation is that the feature is
> > supported by an associated man page update.
> > 
> 
> ok, thank you.
> 
> Reinette

/Jarkko