linux-sgx.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jarkko Sakkinen <jarkko@kernel.org>
To: Reinette Chatre <reinette.chatre@intel.com>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>,
	linux-man@vger.kernel.org, linux-sgx@vger.kernel.org,
	dave.hansen@linux.intel.com, nathaniel@profian.com
Subject: Re: [PATCH v10] sgx.7: New page with overview of Software Guard eXtensions (SGX)
Date: Wed, 22 Dec 2021 02:39:02 +0200	[thread overview]
Message-ID: <YcJzpqa9RNzg+Vim@iki.fi> (raw)
In-Reply-To: <3af1d311-7ef8-1b67-fcae-5cd15be02606@intel.com>

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

      reply	other threads:[~2021-12-22  0:39 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-30 17:50 [PATCH v10] sgx.7: New page with overview of Software Guard eXtensions (SGX) Jarkko Sakkinen
2021-12-08 22:11 ` Reinette Chatre
2021-12-11 15:19   ` Jarkko Sakkinen
2021-12-13 19:51     ` Reinette Chatre
2021-12-22  0:39       ` Jarkko Sakkinen [this message]

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=YcJzpqa9RNzg+Vim@iki.fi \
    --to=jarkko@kernel.org \
    --cc=dave.hansen@linux.intel.com \
    --cc=linux-man@vger.kernel.org \
    --cc=linux-sgx@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    --cc=nathaniel@profian.com \
    --cc=reinette.chatre@intel.com \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).