Update copyright notices with scripts/update-copyrights.
[jlayton/glibc.git] / ports / sysdeps / unix / sysv / linux / alpha / bits / mman.h
1 /* Definitions for POSIX memory map interface.  Linux/Alpha version.
2    Copyright (C) 1997-2013 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    <http://www.gnu.org/licenses/>.  */
18
19 #ifndef _SYS_MMAN_H
20 # error "Never use <bits/mman.h> directly; include <sys/mman.h> instead."
21 #endif
22
23 /* The following definitions basically come from the kernel headers.
24    But the kernel header is not namespace clean.  */
25
26
27 /* Protections are chosen from these bits, OR'd together.  The
28    implementation does not necessarily support PROT_EXEC or PROT_WRITE
29    without PROT_READ.  The only guarantees are that no writing will be
30    allowed without PROT_WRITE and no access will be allowed for PROT_NONE. */
31
32 #define PROT_READ         0x1           /* Page can be read.  */
33 #define PROT_WRITE        0x2           /* Page can be written.  */
34 #define PROT_EXEC         0x4           /* Page can be executed.  */
35 #define PROT_NONE         0x0           /* Page can not be accessed.  */
36 #define PROT_GROWSDOWN    0x01000000    /* Extend change to start of
37                                            growsdown vma (mprotect only).  */
38 #define PROT_GROWSUP      0x02000000    /* Extend change to start of
39                                            growsup vma (mprotect only).  */
40
41 /* Sharing types (must choose one and only one of these).  */
42 #define MAP_SHARED        0x01          /* Share changes.  */
43 #define MAP_PRIVATE       0x02          /* Changes are private.  */
44 #ifdef __USE_MISC
45 # define MAP_TYPE         0x0f          /* Mask for type of mapping.  */
46 #endif
47
48 /* Other flags.  */
49 #define MAP_FIXED         0x100         /* Interpret addr exactly.  */
50 #ifdef __USE_MISC
51 # define MAP_FILE         0
52 # define MAP_ANONYMOUS    0x10          /* Don't use a file.  */
53 # define MAP_ANON         MAP_ANONYMOUS
54 #endif
55
56 /* Not used by Linux, but here to make sure we don't clash with
57    OSF/1 defines.  */
58 #if 0 && defined __USE_BSD
59 # define MAP_HASSEMAPHORE 0x0200
60 # define MAP_INHERIT      0x0400
61 # define MAP_UNALIGNED    0x0800
62 #endif
63
64 /* These are Linux-specific.  */
65 #ifdef __USE_MISC
66 # define MAP_GROWSDOWN    0x01000       /* Stack-like segment.  */
67 # define MAP_DENYWRITE    0x02000       /* ETXTBSY */
68 # define MAP_EXECUTABLE   0x04000       /* Mark it as an executable.  */
69 # define MAP_LOCKED       0x08000       /* Lock the mapping.  */
70 # define MAP_NORESERVE    0x10000       /* Don't check for reservations.  */
71 # define MAP_POPULATE     0x20000       /* Populate (prefault) pagetables.  */
72 # define MAP_NONBLOCK     0x40000       /* Do not block on IO.  */
73 # define MAP_STACK        0x80000       /* Allocation is for a stack.  */
74 # define MAP_HUGETLB      0x100000      /* Create huge page mapping.  */
75 #endif
76
77 /* Flags to `msync'.  */
78 #define MS_ASYNC          1             /* Sync memory asynchronously.  */
79 #define MS_SYNC           2             /* Synchronous memory sync.  */
80 #define MS_INVALIDATE     4             /* Invalidate the caches.  */
81
82 /* Flags for `mlockall'.  */
83 #define MCL_CURRENT       8192          /* Lock all currently mapped pages.  */
84 #define MCL_FUTURE        16384         /* Lock all additions to address
85                                            space.  */
86
87 /* Flags for `mremap'.  */
88 #ifdef __USE_GNU
89 # define MREMAP_MAYMOVE 1
90 # define MREMAP_FIXED   2
91 #endif
92
93 /* Advice to `madvise'.  */
94 #ifdef __USE_BSD
95 # define MADV_NORMAL      0  /* No further special treatment.  */
96 # define MADV_RANDOM      1  /* Expect random page references.  */
97 # define MADV_SEQUENTIAL  2  /* Expect sequential page references.  */
98 # define MADV_WILLNEED    3  /* Will need these pages.  */
99 # define MADV_DONTNEED    6  /* Don't need these pages.  */
100 # define MADV_REMOVE      9  /* Remove these pages and resources.  */
101 # define MADV_DONTFORK    10 /* Do not inherit across fork.  */
102 # define MADV_DOFORK      11 /* Do inherit across fork.  */
103 # define MADV_MERGEABLE   12 /* KSM may merge identical pages.  */
104 # define MADV_UNMERGEABLE 13 /* KSM may not merge identical pages.  */
105 # define MADV_HUGEPAGE    14 /* Worth backing with hugepages.  */
106 # define MADV_NOHUGEPAGE  15 /* Not worth backing with hugepages.  */
107 # define MADV_DONTDUMP    16 /* Exclude from the core dump.  */
108 # define MADV_DODUMP      17 /* Clear MADV_DONTDUMP.  */
109 # define MADV_HWPOISON   100 /* Poison a page for testing.  */
110 #endif
111
112 /* The POSIX people had to invent similar names for the same things.  */
113 #ifdef __USE_XOPEN2K
114 # define POSIX_MADV_NORMAL      0 /* No further special treatment.  */
115 # define POSIX_MADV_RANDOM      1 /* Expect random page references.  */
116 # define POSIX_MADV_SEQUENTIAL  2 /* Expect sequential page references.  */
117 # define POSIX_MADV_WILLNEED    3 /* Will need these pages.  */
118 # define POSIX_MADV_DONTNEED    6 /* Don't need these pages.  */
119 #endif
120
121 /* Not used by Linux, but here to make sure we don't clash with
122    OSF/1 defines.  */
123 #if 0 && defined __USE_BSD
124 # define MADV_DONTNEED_COMPAT 4 /* Old version?  */
125 # define MADV_SPACEAVAIL 5      /* Ensure resources are available.  */
126 #endif