1/* Memory-mapping-related declarations/definitions, not architecture-specific.
2 Copyright (C) 2017-2022 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <https://www.gnu.org/licenses/>. */
18
19#ifndef _SYS_MMAN_H
20# error "Never use <bits/mman-shared.h> directly; include <sys/mman.h> instead."
21#endif
22
23#ifdef __USE_GNU
24/* Flags for mremap. */
25# define MREMAP_MAYMOVE 1
26# define MREMAP_FIXED 2
27# define MREMAP_DONTUNMAP 4
28
29/* Flags for memfd_create. */
30# ifndef MFD_CLOEXEC
31# define MFD_CLOEXEC 1U
32# define MFD_ALLOW_SEALING 2U
33# define MFD_HUGETLB 4U
34# endif
35
36/* Flags for mlock2. */
37# ifndef MLOCK_ONFAULT
38# define MLOCK_ONFAULT 1U
39# endif
40
41/* Access rights for pkey_alloc. */
42# ifndef PKEY_DISABLE_ACCESS
43# define PKEY_DISABLE_ACCESS 0x1
44# define PKEY_DISABLE_WRITE 0x2
45# endif
46
47__BEGIN_DECLS
48
49/* Create a new memory file descriptor. NAME is a name for debugging.
50 FLAGS is a combination of the MFD_* constants. */
51int memfd_create (const char *__name, unsigned int __flags) __THROW;
52
53/* Lock pages from ADDR (inclusive) to ADDR + LENGTH (exclusive) into
54 memory. FLAGS is a combination of the MLOCK_* flags above. */
55int mlock2 (const void *__addr, size_t __length, unsigned int __flags) __THROW;
56
57/* Allocate a new protection key, with the PKEY_DISABLE_* bits
58 specified in ACCESS_RIGHTS. The protection key mask for the
59 current thread is updated to match the access privilege for the new
60 key. */
61int pkey_alloc (unsigned int __flags, unsigned int __access_rights) __THROW;
62
63/* Update the access rights for the current thread for KEY, which must
64 have been allocated using pkey_alloc. */
65int pkey_set (int __key, unsigned int __access_rights) __THROW;
66
67/* Return the access rights for the current thread for KEY, which must
68 have been allocated using pkey_alloc. */
69int pkey_get (int __key) __THROW;
70
71/* Free an allocated protection key, which must have been allocated
72 using pkey_alloc. */
73int pkey_free (int __key) __THROW;
74
75/* Apply memory protection flags for KEY to the specified address
76 range. */
77int pkey_mprotect (void *__addr, size_t __len, int __prot, int __pkey) __THROW;
78
79__END_DECLS
80
81#endif /* __USE_GNU */
82