Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) client-ip=2620:137:e000::3:2;
Date:   Tue, 26 Sep 2023 01:52:34 +0200
From:   Alejandro Colomar <alx@kernel.org>
To:     Axel Rasmussen <axelrasmussen@google.com>
Cc:     Peter Xu <peterx@redhat.com>, linux-man@vger.kernel.org,
        linux-mm@kvack.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 07/10] ioctl_userfaultfd.2: correct and update UFFDIO_API
 ioctl error codes
Message-ID: <5ddepg57wqnidtvsio2pse44dot6pvr3rcmhwld6ml3sflwcz3@ijd3h4teqblr>
References: <20230919190206.388896-1-axelrasmussen@google.com>
 <20230919190206.388896-8-axelrasmussen@google.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="sfquo6rq2unvsafx"
Content-Disposition: inline
In-Reply-To: <20230919190206.388896-8-axelrasmussen@google.com>
Precedence: bulk


--sfquo6rq2unvsafx
Content-Type: text/plain; protected-headers=v1; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
Subject: Re: [PATCH 07/10] ioctl_userfaultfd.2: correct and update UFFDIO_API
 ioctl error codes
MIME-Version: 1.0

Hi Axel,

On Tue, Sep 19, 2023 at 12:02:03PM -0700, Axel Rasmussen wrote:
> First, it is not correct that repeated UFFDIO_API calls result in
> EINVAL. This is true *if both calls enable features*, but in the case
> where we're doing a two-step feature detection handshake, the kernel
> explicitly expects 2 calls (one with no features set). So, correct this
> description.
>=20
> Then, some new error cases have been added to the kernel recently, and
> the man page wasn't updated to note these. So, add in descriptions of
> these new error cases.
>=20
> Signed-off-by: Axel Rasmussen <axelrasmussen@google.com>
> ---
>  man2/ioctl_userfaultfd.2 | 24 +++++++++++++++++++-----
>  1 file changed, 19 insertions(+), 5 deletions(-)
>=20
> diff --git a/man2/ioctl_userfaultfd.2 b/man2/ioctl_userfaultfd.2
> index 53b1f473f..1aa9654be 100644
> --- a/man2/ioctl_userfaultfd.2
> +++ b/man2/ioctl_userfaultfd.2
> @@ -280,17 +280,31 @@ refers to an address that is outside the calling pr=
ocess's
>  accessible address space.
>  .TP
>  .B EINVAL
> -The userfaultfd has already been enabled by a previous
> -.B UFFDIO_API
> -operation.
> -.TP
> -.B EINVAL
>  The API version requested in the
>  .I api
>  field is not supported by this kernel, or the
>  .I features
>  field passed to the kernel includes feature bits that are not supported
>  by the current kernel version.
> +.TP
> +.B EPERM

This EPERM should probably be at the end.  Unless you have a good reason
to break alphabetic order.

Thanks,
Alex

> +The
> +.B UFFD_FEATURE_EVENT_FORK
> +feature was enabled,
> +but the calling process doesn't have the
> +.B CAP_SYS_PTRACE
> +capability.
> +.TP
> +.B EINVAL
> +A previous
> +.B UFFDIO_API
> +call already enabled one or more features for this userfaultfd.
> +Calling
> +.B UFFDIO_API
> +twice,
> +the first time with no features set,
> +is explicitly allowed
> +as per the two-step feature detection handshake.
>  .\" FIXME In the above error case, the returned 'uffdio_api' structure is
>  .\" zeroed out. Why is this done? This should be explained in the manual=
 page.
>  .\"
> --=20
> 2.42.0.459.ge4e396fd5e-goog
>=20

--sfquo6rq2unvsafx
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCgAdFiEE6jqH8KTroDDkXfJAnowa+77/2zIFAmUSHUIACgkQnowa+77/
2zJvng/+MbsU5MfmXIe0erS8L+2Cfzvvt85W8o6bTu7AEasSaESg7NtFhZ6wyQSk
tJcmVIh4F9UeVBwvs77EOapbDrcZuw0MfExT66INr0bxhCcZDEar3sKW6V9IDMYf
EgOaB83nGebwIkIU0nQNCZoBwnlnlGhPygmOl10IFwdSYV+Q/hkUFOY/5vLlSvdI
/kOSyq1S7r99I5EydbmZRzxlYtGlCoIiL8PuFtZuDv1JzpxkqL9gFDHIkkINfEcG
MhmMLi00ERAgWA3QQcREXnx7wI39mWthNHPTXGxkpdIDTVFfWJQ6uJdLpPAblU6z
/bnmX1ESYvOxBv/JgXExFu6dTZ2IeqncdOjwWdwrF3+E8lTkaMC+6S24QLYO7OBx
PESaaXkSdAIkTg+sgQQSdDdWIJJKlh5b9f5fUMIZaUpMhWkf2D9xK2aqvfYUP7od
2wV8iLjO/AGH3jopaHX+91lablgztxQSwGegH6X83PQSGpy946farEiYU0CT7j3y
gUk8UY5p4g2OIJqvQoPEkvTeU+bx1aWwPNJ4YdrlQh5oQaVNlHSMzqa+HxONJ9G1
K8WFVJyoMpiryQf49Gpvp8MBzmlilNB1zox2mTx/cDqJJPwKt/qE1/0ON0xaLJ+i
gp2ra6xS4+a8EjbPLjfbFQSU7GBJJje8/yoxKB7nTVGwYEdomh8=
=I/3k
-----END PGP SIGNATURE-----

--sfquo6rq2unvsafx--