diff mbox series

[v3,2/2] misc: Align argument name for pkey_*() functions with the manual

Message ID 20241101100223.1019242-3-yury.khrustalev@arm.com
State New
Headers show
Series Fix arg name of pkey_*() functions | expand

Commit Message

Yury Khrustalev Nov. 1, 2024, 10:02 a.m. UTC
Change name of the access_rights argument to access_restrictions
of the following functions:

 - pkey_alloc()
 - pkey_set()

as this argument refers to access restrictions rather than access
rights and previous name might have been misleading.
---
 sysdeps/unix/sysv/linux/bits/mman-shared.h | 12 ++++++------
 sysdeps/unix/sysv/linux/pkey_set.c         |  2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)

Comments

Adhemerval Zanella Nov. 1, 2024, 4:20 p.m. UTC | #1
On 01/11/24 07:02, Yury Khrustalev wrote:
> Change name of the access_rights argument to access_restrictions
> of the following functions:
> 
>  - pkey_alloc()
>  - pkey_set()
> 
> as this argument refers to access restrictions rather than access
> rights and previous name might have been misleading.


LGTM, thanks.

Reviewed-by: Adhemerval Zanella  <adhemerval.zanella@linaro.org>

> ---
>  sysdeps/unix/sysv/linux/bits/mman-shared.h | 12 ++++++------
>  sysdeps/unix/sysv/linux/pkey_set.c         |  2 +-
>  2 files changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/sysdeps/unix/sysv/linux/bits/mman-shared.h b/sysdeps/unix/sysv/linux/bits/mman-shared.h
> index d8ed4436b6..7a9874204d 100644
> --- a/sysdeps/unix/sysv/linux/bits/mman-shared.h
> +++ b/sysdeps/unix/sysv/linux/bits/mman-shared.h
> @@ -42,7 +42,7 @@
>  #  define MLOCK_ONFAULT 1U
>  # endif
>  
> -/* Access rights for pkey_alloc.  */
> +/* Access restrictions for pkey_alloc.  */
>  # ifndef PKEY_DISABLE_ACCESS
>  #  define PKEY_DISABLE_ACCESS 0x1
>  #  define PKEY_DISABLE_WRITE 0x2
> @@ -59,16 +59,16 @@ int memfd_create (const char *__name, unsigned int __flags) __THROW;
>  int mlock2 (const void *__addr, size_t __length, unsigned int __flags) __THROW;
>  
>  /* Allocate a new protection key, with the PKEY_DISABLE_* bits
> -   specified in ACCESS_RIGHTS.  The protection key mask for the
> +   specified in ACCESS_RESTRICTIONS.  The protection key mask for the
>     current thread is updated to match the access privilege for the new
>     key.  */
> -int pkey_alloc (unsigned int __flags, unsigned int __access_rights) __THROW;
> +int pkey_alloc (unsigned int __flags, unsigned int __access_restrictions) __THROW;
>  
> -/* Update the access rights for the current thread for KEY, which must
> +/* Update the access restrictions for the current thread for KEY, which must
>     have been allocated using pkey_alloc.  */
> -int pkey_set (int __key, unsigned int __access_rights) __THROW;
> +int pkey_set (int __key, unsigned int __access_restrictions) __THROW;
>  
> -/* Return the access rights for the current thread for KEY, which must
> +/* Return the access restrictions for the current thread for KEY, which must
>     have been allocated using pkey_alloc.  */
>  int pkey_get (int __key) __THROW;
>  
> diff --git a/sysdeps/unix/sysv/linux/pkey_set.c b/sysdeps/unix/sysv/linux/pkey_set.c
> index 30463ef89b..9cb14af0ec 100644
> --- a/sysdeps/unix/sysv/linux/pkey_set.c
> +++ b/sysdeps/unix/sysv/linux/pkey_set.c
> @@ -20,7 +20,7 @@
>  #include <sys/mman.h>
>  
>  int
> -__pkey_set (int key, unsigned int access_rights)
> +__pkey_set (int key, unsigned int access_restrictions)
>  {
>    __set_errno (ENOSYS);
>    return -1;
diff mbox series

Patch

diff --git a/sysdeps/unix/sysv/linux/bits/mman-shared.h b/sysdeps/unix/sysv/linux/bits/mman-shared.h
index d8ed4436b6..7a9874204d 100644
--- a/sysdeps/unix/sysv/linux/bits/mman-shared.h
+++ b/sysdeps/unix/sysv/linux/bits/mman-shared.h
@@ -42,7 +42,7 @@ 
 #  define MLOCK_ONFAULT 1U
 # endif
 
-/* Access rights for pkey_alloc.  */
+/* Access restrictions for pkey_alloc.  */
 # ifndef PKEY_DISABLE_ACCESS
 #  define PKEY_DISABLE_ACCESS 0x1
 #  define PKEY_DISABLE_WRITE 0x2
@@ -59,16 +59,16 @@  int memfd_create (const char *__name, unsigned int __flags) __THROW;
 int mlock2 (const void *__addr, size_t __length, unsigned int __flags) __THROW;
 
 /* Allocate a new protection key, with the PKEY_DISABLE_* bits
-   specified in ACCESS_RIGHTS.  The protection key mask for the
+   specified in ACCESS_RESTRICTIONS.  The protection key mask for the
    current thread is updated to match the access privilege for the new
    key.  */
-int pkey_alloc (unsigned int __flags, unsigned int __access_rights) __THROW;
+int pkey_alloc (unsigned int __flags, unsigned int __access_restrictions) __THROW;
 
-/* Update the access rights for the current thread for KEY, which must
+/* Update the access restrictions for the current thread for KEY, which must
    have been allocated using pkey_alloc.  */
-int pkey_set (int __key, unsigned int __access_rights) __THROW;
+int pkey_set (int __key, unsigned int __access_restrictions) __THROW;
 
-/* Return the access rights for the current thread for KEY, which must
+/* Return the access restrictions for the current thread for KEY, which must
    have been allocated using pkey_alloc.  */
 int pkey_get (int __key) __THROW;
 
diff --git a/sysdeps/unix/sysv/linux/pkey_set.c b/sysdeps/unix/sysv/linux/pkey_set.c
index 30463ef89b..9cb14af0ec 100644
--- a/sysdeps/unix/sysv/linux/pkey_set.c
+++ b/sysdeps/unix/sysv/linux/pkey_set.c
@@ -20,7 +20,7 @@ 
 #include <sys/mman.h>
 
 int
-__pkey_set (int key, unsigned int access_rights)
+__pkey_set (int key, unsigned int access_restrictions)
 {
   __set_errno (ENOSYS);
   return -1;