FreeBSD/Linux Kernel Cross Reference
sys/sys/mman.h
1 /*-
2 * Copyright (c) 1982, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * @(#)mman.h 8.2 (Berkeley) 1/9/95
30 * $FreeBSD$
31 */
32
33 #ifndef _SYS_MMAN_H_
34 #define _SYS_MMAN_H_
35
36 #include <sys/cdefs.h>
37 #include <sys/_types.h>
38
39 #if __BSD_VISIBLE
40 /*
41 * Inheritance for minherit()
42 */
43 #define INHERIT_SHARE 0
44 #define INHERIT_COPY 1
45 #define INHERIT_NONE 2
46 #endif
47
48 /*
49 * Protections are chosen from these bits, or-ed together
50 */
51 #define PROT_NONE 0x00 /* no permissions */
52 #define PROT_READ 0x01 /* pages can be read */
53 #define PROT_WRITE 0x02 /* pages can be written */
54 #define PROT_EXEC 0x04 /* pages can be executed */
55
56 /*
57 * Flags contain sharing type and options.
58 * Sharing types; choose one.
59 */
60 #define MAP_SHARED 0x0001 /* share changes */
61 #define MAP_PRIVATE 0x0002 /* changes are private */
62 #if __BSD_VISIBLE
63 #define MAP_COPY MAP_PRIVATE /* Obsolete */
64 #endif
65
66 /*
67 * Other flags
68 */
69 #define MAP_FIXED 0x0010 /* map addr must be exactly as requested */
70
71 #if __BSD_VISIBLE
72 #define MAP_RENAME 0x0020 /* Sun: rename private pages to file */
73 #define MAP_NORESERVE 0x0040 /* Sun: don't reserve needed swap area */
74 #define MAP_RESERVED0080 0x0080 /* previously misimplemented MAP_INHERIT */
75 #define MAP_RESERVED0100 0x0100 /* previously unimplemented MAP_NOEXTEND */
76 #define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */
77 #define MAP_STACK 0x0400 /* region grows down, like a stack */
78 #define MAP_NOSYNC 0x0800 /* page to but do not sync underlying file */
79
80 /*
81 * Mapping type
82 */
83 #define MAP_FILE 0x0000 /* map from file (default) */
84 #define MAP_ANON 0x1000 /* allocated from memory, swap space */
85 #ifndef _KERNEL
86 #define MAP_ANONYMOUS MAP_ANON /* For compatibility. */
87 #endif /* !_KERNEL */
88
89 /*
90 * Extended flags
91 */
92 #define MAP_NOCORE 0x00020000 /* dont include these pages in a coredump */
93 #define MAP_PREFAULT_READ 0x00040000 /* prefault mapping for reading */
94
95 /*
96 * Request specific alignment (n == log2 of the desired alignment).
97 *
98 * MAP_ALIGNED_SUPER requests optimal superpage alignment, but does
99 * not enforce a specific alignment.
100 */
101 #define MAP_ALIGNED(n) ((n) << MAP_ALIGNMENT_SHIFT)
102 #define MAP_ALIGNMENT_SHIFT 24
103 #define MAP_ALIGNMENT_MASK MAP_ALIGNED(0xff)
104 #define MAP_ALIGNED_SUPER MAP_ALIGNED(1) /* align on a superpage */
105 #endif /* __BSD_VISIBLE */
106
107 #if __POSIX_VISIBLE >= 199309
108 /*
109 * Process memory locking
110 */
111 #define MCL_CURRENT 0x0001 /* Lock only current memory */
112 #define MCL_FUTURE 0x0002 /* Lock all future memory as well */
113 #endif
114
115 /*
116 * Error return from mmap()
117 */
118 #define MAP_FAILED ((void *)-1)
119
120 /*
121 * msync() flags
122 */
123 #define MS_SYNC 0x0000 /* msync synchronously */
124 #define MS_ASYNC 0x0001 /* return immediately */
125 #define MS_INVALIDATE 0x0002 /* invalidate all cached data */
126
127 /*
128 * Advice to madvise
129 */
130 #define _MADV_NORMAL 0 /* no further special treatment */
131 #define _MADV_RANDOM 1 /* expect random page references */
132 #define _MADV_SEQUENTIAL 2 /* expect sequential page references */
133 #define _MADV_WILLNEED 3 /* will need these pages */
134 #define _MADV_DONTNEED 4 /* dont need these pages */
135
136 #if __BSD_VISIBLE
137 #define MADV_NORMAL _MADV_NORMAL
138 #define MADV_RANDOM _MADV_RANDOM
139 #define MADV_SEQUENTIAL _MADV_SEQUENTIAL
140 #define MADV_WILLNEED _MADV_WILLNEED
141 #define MADV_DONTNEED _MADV_DONTNEED
142 #define MADV_FREE 5 /* dont need these pages, and junk contents */
143 #define MADV_NOSYNC 6 /* try to avoid flushes to physical media */
144 #define MADV_AUTOSYNC 7 /* revert to default flushing strategy */
145 #define MADV_NOCORE 8 /* do not include these pages in a core file */
146 #define MADV_CORE 9 /* revert to including pages in a core file */
147 #define MADV_PROTECT 10 /* protect process from pageout kill */
148
149 /*
150 * Return bits from mincore
151 */
152 #define MINCORE_INCORE 0x1 /* Page is incore */
153 #define MINCORE_REFERENCED 0x2 /* Page has been referenced by us */
154 #define MINCORE_MODIFIED 0x4 /* Page has been modified by us */
155 #define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
156 #define MINCORE_MODIFIED_OTHER 0x10 /* Page has been modified */
157 #define MINCORE_SUPER 0x20 /* Page is a "super" page */
158
159 /*
160 * Anonymous object constant for shm_open().
161 */
162 #define SHM_ANON ((char *)1)
163 #endif /* __BSD_VISIBLE */
164
165 /*
166 * XXX missing POSIX_TYPED_MEM_* macros and
167 * posix_typed_mem_info structure.
168 */
169 #if __POSIX_VISIBLE >= 200112
170 #define POSIX_MADV_NORMAL _MADV_NORMAL
171 #define POSIX_MADV_RANDOM _MADV_RANDOM
172 #define POSIX_MADV_SEQUENTIAL _MADV_SEQUENTIAL
173 #define POSIX_MADV_WILLNEED _MADV_WILLNEED
174 #define POSIX_MADV_DONTNEED _MADV_DONTNEED
175 #endif
176
177 #ifndef _MODE_T_DECLARED
178 typedef __mode_t mode_t;
179 #define _MODE_T_DECLARED
180 #endif
181
182 #ifndef _OFF_T_DECLARED
183 typedef __off_t off_t;
184 #define _OFF_T_DECLARED
185 #endif
186
187 #ifndef _SIZE_T_DECLARED
188 typedef __size_t size_t;
189 #define _SIZE_T_DECLARED
190 #endif
191
192 #if defined(_KERNEL) || defined(_WANT_FILE)
193 #include <vm/vm.h>
194
195 struct file;
196
197 struct shmfd {
198 size_t shm_size;
199 vm_object_t shm_object;
200 int shm_refs;
201 uid_t shm_uid;
202 gid_t shm_gid;
203 mode_t shm_mode;
204 int shm_kmappings;
205
206 /*
207 * Values maintained solely to make this a better-behaved file
208 * descriptor for fstat() to run on.
209 */
210 struct timespec shm_atime;
211 struct timespec shm_mtime;
212 struct timespec shm_ctime;
213 struct timespec shm_birthtime;
214 ino_t shm_ino;
215
216 struct label *shm_label; /* MAC label */
217 const char *shm_path;
218 };
219 #endif
220
221 #ifdef _KERNEL
222 int shm_mmap(struct shmfd *shmfd, vm_size_t objsize, vm_ooffset_t foff,
223 vm_object_t *obj);
224 int shm_map(struct file *fp, size_t size, off_t offset, void **memp);
225 int shm_unmap(struct file *fp, void *mem, size_t size);
226 void shm_path(struct shmfd *shmfd, char *path, size_t size);
227
228 #else /* !_KERNEL */
229
230 __BEGIN_DECLS
231 /*
232 * XXX not yet implemented: posix_mem_offset(), posix_typed_mem_get_info(),
233 * posix_typed_mem_open().
234 */
235 #if __BSD_VISIBLE
236 int getpagesizes(size_t *, int);
237 int madvise(void *, size_t, int);
238 int mincore(const void *, size_t, char *);
239 int minherit(void *, size_t, int);
240 #endif
241 int mlock(const void *, size_t);
242 #ifndef _MMAP_DECLARED
243 #define _MMAP_DECLARED
244 void * mmap(void *, size_t, int, int, int, off_t);
245 #endif
246 int mprotect(const void *, size_t, int);
247 int msync(void *, size_t, int);
248 int munlock(const void *, size_t);
249 int munmap(void *, size_t);
250 #if __POSIX_VISIBLE >= 200112
251 int posix_madvise(void *, size_t, int);
252 #endif
253 #if __POSIX_VISIBLE >= 199309
254 int mlockall(int);
255 int munlockall(void);
256 int shm_open(const char *, int, mode_t);
257 int shm_unlink(const char *);
258 #endif
259 __END_DECLS
260
261 #endif /* !_KERNEL */
262
263 #endif /* !_SYS_MMAN_H_ */
Cache object: ff8c8ba9101514e58ef0403655feac60
|