1 /* Definitions for POSIX memory map interface.  Linux generic version.
2    Copyright (C) 2001-2018 Free Software Foundation, Inc.
3 
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Lesser General Public
6    License as published by the Free Software Foundation; either
7    version 2.1 of the License, or (at your option) any later version.
8 
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Lesser General Public License for more details.
13 
14    You should have received a copy of the GNU Lesser General Public
15    License along with the GNU C Library; if not, see
16    <http://www.gnu.org/licenses/>.  */
17 
18 #ifndef _SYS_MMAN_H
19 # error "Never use <bits/mman-linux.h> directly; include <sys/mman.h> instead."
20 #endif
21 
22 /* The following definitions basically come from the kernel headers.
23    But the kernel header is not namespace clean.  */
24 
25 
26 /* Protections are chosen from these bits, OR'd together.  The
27    implementation does not necessarily support PROT_EXEC or PROT_WRITE
28    without PROT_READ.  The only guarantees are that no writing will be
29    allowed without PROT_WRITE and no access will be allowed for PROT_NONE. */
30 
31 #define PROT_READ	0x1		/* Page can be read.  */
32 #define PROT_WRITE	0x2		/* Page can be written.  */
33 #define PROT_EXEC	0x4		/* Page can be executed.  */
34 #define PROT_NONE	0x0		/* Page can not be accessed.  */
35 #define PROT_GROWSDOWN	0x01000000	/* Extend change to start of
36 					   growsdown vma (mprotect only).  */
37 #define PROT_GROWSUP	0x02000000	/* Extend change to start of
38 					   growsup vma (mprotect only).  */
39 
40 /* Sharing types (must choose one and only one of these).  */
41 #define MAP_SHARED	0x01		/* Share changes.  */
42 #define MAP_PRIVATE	0x02		/* Changes are private.  */
43 #ifdef __USE_MISC
44 # define MAP_TYPE	0x0f		/* Mask for type of mapping.  */
45 #endif
46 
47 /* Other flags.  */
48 #define MAP_FIXED	0x10		/* Interpret addr exactly.  */
49 # define MAP_FIXED_NOREPLACE 0x100000 /* Used to solve problem with MAP_FIXED */
50 #ifdef __USE_MISC
51 # define MAP_FILE	0
52 # ifdef __MAP_ANONYMOUS
53 #  define MAP_ANONYMOUS	__MAP_ANONYMOUS	/* Don't use a file.  */
54 # else
55 #  define MAP_ANONYMOUS	0x20		/* Don't use a file.  */
56 # endif
57 # define MAP_ANON	MAP_ANONYMOUS
58 /* When MAP_HUGETLB is set bits [26:31] encode the log2 of the huge page size.  */
59 # define MAP_HUGE_SHIFT	26
60 # define MAP_HUGE_MASK	0x3f
61 #endif
62 
63 /* Flags to `msync'.  */
64 #define MS_ASYNC	1		/* Sync memory asynchronously.  */
65 #define MS_SYNC		4		/* Synchronous memory sync.  */
66 #define MS_INVALIDATE	2		/* Invalidate the caches.  */
67 
68 /* Flags for `mremap'.  */
69 #ifdef __USE_GNU
70 # define MREMAP_MAYMOVE	1
71 # define MREMAP_FIXED	2
72 #endif
73 
74 /* only define for MMU targets, no-MMU does not support madvise.  */
75 #ifdef __ARCH_USE_MMU__
76 /* Advice to `madvise'.  */
77 # ifdef __USE_MISC
78 #  define MADV_NORMAL	  0	/* No further special treatment.  */
79 #  define MADV_RANDOM	  1	/* Expect random page references.  */
80 #  define MADV_SEQUENTIAL 2	/* Expect sequential page references.  */
81 #  define MADV_WILLNEED	  3	/* Will need these pages.  */
82 #  define MADV_DONTNEED	  4	/* Don't need these pages.  */
83 #  define MADV_FREE	  8	/* Free pages only if memory pressure.  */
84 #  define MADV_REMOVE	  9	/* Remove these pages and resources.  */
85 #  define MADV_DONTFORK	  10	/* Do not inherit across fork.  */
86 #  define MADV_DOFORK	  11	/* Do inherit across fork.  */
87 #  define MADV_MERGEABLE  12	/* KSM may merge identical pages.  */
88 #  define MADV_UNMERGEABLE 13	/* KSM may not merge identical pages.  */
89 #  define MADV_HUGEPAGE	  14	/* Worth backing with hugepages.  */
90 #  define MADV_NOHUGEPAGE 15	/* Not worth backing with hugepages.  */
91 #  define MADV_DONTDUMP	  16    /* Explicity exclude from the core dump,
92                                     overrides the coredump filter bits.  */
93 #  define MADV_DODUMP	  17	/* Clear the MADV_DONTDUMP flag.  */
94 #  define MADV_WIPEONFORK 18	/* Zero memory on fork, child only.  */
95 #  define MADV_KEEPONFORK 19	/* Undo MADV_WIPEONFORK.  */
96 #  define MADV_HWPOISON	 100	/* Poison a page for testing.  */
97 # endif
98 
99 /* The POSIX people had to invent similar names for the same things.  */
100 # ifdef __USE_XOPEN2K
101 #  define POSIX_MADV_NORMAL	0 /* No further special treatment.  */
102 #  define POSIX_MADV_RANDOM	1 /* Expect random page references.  */
103 #  define POSIX_MADV_SEQUENTIAL	2 /* Expect sequential page references.  */
104 #  define POSIX_MADV_WILLNEED	3 /* Will need these pages.  */
105 #  define POSIX_MADV_DONTNEED	4 /* Don't need these pages.  */
106 # endif
107 #endif
108 
109 /* Flags for `mlockall'.  */
110 #ifndef MCL_CURRENT
111 # define MCL_CURRENT	1		/* Lock all currently mapped pages.  */
112 # define MCL_FUTURE	2		/* Lock all additions to address
113 					   space.  */
114 # define MCL_ONFAULT	4		/* Lock all pages that are
115 					   faulted in.  */
116 #endif
117 
118 #include <bits/mman-shared.h>
119