Print this page
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/uts/common/sys/mman.h
+++ new/usr/src/uts/common/sys/mman.h
1 1 /*
2 2 * CDDL HEADER START
3 3 *
4 4 * The contents of this file are subject to the terms of the
5 5 * Common Development and Distribution License (the "License").
6 6 * You may not use this file except in compliance with the License.
7 7 *
8 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 * or http://www.opensolaris.org/os/licensing.
10 10 * See the License for the specific language governing permissions
11 11 * and limitations under the License.
12 12 *
13 13 * When distributing Covered Code, include this CDDL HEADER in each
14 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 * If applicable, add the following below this CDDL HEADER, with the
16 16 * fields enclosed by brackets "[]" replaced with your own identifying
17 17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 18 *
19 19 * CDDL HEADER END
20 20 */
21 21
22 22 /* Copyright 2013 OmniTI Computer Consulting, Inc. All rights reserved. */
23 23 /*
24 24 * Copyright 2014 Garrett D'Amore <garrett@damore.org>
25 25 *
26 26 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
27 27 * Use is subject to license terms.
28 28 * Copyright 2015 Joyent, Inc. All rights reserved.
29 29 */
30 30
31 31 /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
32 32 /* All Rights Reserved */
33 33
34 34 /*
35 35 * University Copyright- Copyright (c) 1982, 1986, 1988
36 36 * The Regents of the University of California
37 37 * All Rights Reserved
38 38 *
39 39 * University Acknowledgment- Portions of this document are derived from
40 40 * software developed by the University of California, Berkeley, and its
41 41 * contributors.
42 42 */
43 43
44 44 #ifndef _SYS_MMAN_H
45 45 #define _SYS_MMAN_H
46 46
47 47 #include <sys/feature_tests.h>
48 48
49 49 #ifdef __cplusplus
50 50 extern "C" {
51 51 #endif
52 52
53 53 #if !defined(_ASM) && !defined(_KERNEL)
54 54 #include <sys/types.h>
55 55 #endif /* !_ASM && !_KERNEL */
56 56
57 57 /*
58 58 * Protections are chosen from these bits, or-ed together.
59 59 * Note - not all implementations literally provide all possible
60 60 * combinations. PROT_WRITE is often implemented as (PROT_READ |
61 61 * PROT_WRITE) and (PROT_EXECUTE as PROT_READ | PROT_EXECUTE).
62 62 * However, no implementation will permit a write to succeed
63 63 * where PROT_WRITE has not been set. Also, no implementation will
64 64 * allow any access to succeed where prot is specified as PROT_NONE.
65 65 */
66 66 #define PROT_READ 0x1 /* pages can be read */
67 67 #define PROT_WRITE 0x2 /* pages can be written */
68 68 #define PROT_EXEC 0x4 /* pages can be executed */
69 69
70 70 #ifdef _KERNEL
71 71 #define PROT_USER 0x8 /* pages are user accessable */
72 72 #define PROT_ZFOD (PROT_READ | PROT_WRITE | PROT_EXEC | PROT_USER)
73 73 #define PROT_ALL (PROT_READ | PROT_WRITE | PROT_EXEC | PROT_USER)
74 74 #endif /* _KERNEL */
75 75
76 76 #define PROT_NONE 0x0 /* pages cannot be accessed */
77 77
78 78 /* sharing types: must choose either SHARED or PRIVATE */
79 79 #define MAP_SHARED 1 /* share changes */
80 80 #define MAP_PRIVATE 2 /* changes are private */
81 81 #define MAP_TYPE 0xf /* mask for share type */
82 82
83 83 /* other flags to mmap (or-ed in to MAP_SHARED or MAP_PRIVATE) */
84 84 #define MAP_FILE 0 /* map from file (default) */
85 85 #define MAP_FIXED 0x10 /* user assigns address */
86 86 #define MAP_NORESERVE 0x40 /* don't reserve needed swap area */
87 87 #define MAP_ANON 0x100 /* map anonymous pages directly */
88 88 #define MAP_ANONYMOUS MAP_ANON /* (source compatibility) */
89 89 #define MAP_ALIGN 0x200 /* addr specifies alignment */
90 90 #define MAP_TEXT 0x400 /* map code segment */
91 91 #define MAP_INITDATA 0x800 /* map data segment */
92 92
93 93 #ifdef _KERNEL
94 94 #define _MAP_TEXTREPL 0x1000
95 95 #endif /* _KERNEL */
96 96
97 97 /* these flags not yet implemented */
98 98 #define MAP_RENAME 0x20 /* rename private pages to file */
99 99
100 100 #if (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2)
101 101 /* these flags are used by memcntl */
102 102 #define PROC_TEXT (PROT_EXEC | PROT_READ)
103 103 #define PROC_DATA (PROT_READ | PROT_WRITE | PROT_EXEC)
104 104 #define SHARED 0x10
105 105 #define PRIVATE 0x20
106 106 #define VALID_ATTR (PROT_READ|PROT_WRITE|PROT_EXEC|SHARED|PRIVATE)
107 107 #endif /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) */
108 108
109 109 #if (_POSIX_C_SOURCE <= 2) || defined(_XPG4_2)
110 110 #ifdef _KERNEL
111 111 #define PROT_EXCL 0x20
112 112 #endif /* _KERNEL */
113 113
114 114 #define _MAP_LOW32 0x80 /* force mapping in lower 4G of address space */
115 115 #define MAP_32BIT _MAP_LOW32
116 116
117 117 /*
118 118 * For the sake of backward object compatibility, we use the _MAP_NEW flag.
119 119 * This flag will be automatically or'ed in by the C library for all
120 120 * new mmap calls. Previous binaries with old mmap calls will continue
121 121 * to get 0 or -1 for return values. New mmap calls will get the mapped
122 122 * address as the return value if successful and -1 on errors. By default,
123 123 * new mmap calls automatically have the kernel assign the map address
124 124 * unless the MAP_FIXED flag is given.
125 125 */
126 126 #define _MAP_NEW 0x80000000 /* users should not need to use this */
127 127 #endif /* (_POSIX_C_SOURCE <= 2) */
128 128
129 129
130 130 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__)
131 131 /* External flags for mmapobj syscall (Exclusive of MAP_* flags above) */
132 132 #define MMOBJ_PADDING 0x10000
133 133 #define MMOBJ_INTERPRET 0x20000
134 134
135 135 #define MMOBJ_ALL_FLAGS (MMOBJ_PADDING | MMOBJ_INTERPRET)
136 136
137 137 /*
138 138 * Values for mr_flags field of mmapobj_result_t below.
139 139 * The bottom 16 bits are mutually exclusive and thus only one
140 140 * of them can be set at a time. Use MR_GET_TYPE below to check this value.
141 141 * The top 16 bits are used for flags which are not mutually exclusive and
142 142 * thus more than one of these flags can be set for a given mmapobj_result_t.
143 143 *
144 144 * MR_PADDING being set indicates that this memory range represents the user
145 145 * requested padding.
146 146 *
147 147 * MR_HDR_ELF being set indicates that the ELF header of the mapped object
148 148 * is mapped at mr_addr + mr_offset.
149 149 *
150 150 * MR_HDR_AOUT being set indicates that the AOUT (4.x) header of the mapped
151 151 * object is mapped at mr_addr + mr_offset.
152 152 */
153 153
154 154 /*
155 155 * External flags for mr_flags field below.
156 156 */
157 157 #define MR_PADDING 0x1
158 158 #define MR_HDR_ELF 0x2
159 159 #define MR_HDR_AOUT 0x3
160 160
161 161 /*
162 162 * Internal flags for mr_flags field below.
163 163 */
164 164 #ifdef _KERNEL
165 165 #define MR_RESV 0x80000000 /* overmapped /dev/null */
166 166 #endif /* _KERNEL */
167 167
168 168 #define MR_TYPE_MASK 0x0000ffff
169 169 #define MR_GET_TYPE(val) ((val) & MR_TYPE_MASK)
170 170
171 171 #if !defined(_ASM)
172 172 typedef struct mmapobj_result {
173 173 caddr_t mr_addr; /* mapping address */
174 174 size_t mr_msize; /* mapping size */
175 175 size_t mr_fsize; /* file size */
176 176 size_t mr_offset; /* offset into file */
177 177 uint_t mr_prot; /* the protections provided */
178 178 uint_t mr_flags; /* info on the mapping */
179 179 } mmapobj_result_t;
180 180
181 181 #if defined(_KERNEL) || defined(_SYSCALL32)
182 182 typedef struct mmapobj_result32 {
183 183 caddr32_t mr_addr; /* mapping address */
184 184 size32_t mr_msize; /* mapping size */
185 185 size32_t mr_fsize; /* file size */
186 186 size32_t mr_offset; /* offset into file */
187 187 uint_t mr_prot; /* the protections provided */
188 188 uint_t mr_flags; /* info on the mapping */
189 189 } mmapobj_result32_t;
190 190 #endif /* defined(_KERNEL) || defined(_SYSCALL32) */
191 191 #endif /* !defined(_ASM) */
192 192 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */
193 193
194 194 #if !defined(_ASM) && !defined(_KERNEL)
195 195 /*
196 196 * large file compilation environment setup
197 197 *
198 198 * In the LP64 compilation environment, map large file interfaces
199 199 * back to native versions where possible.
200 200 */
201 201
202 202 #if !defined(_LP64) && _FILE_OFFSET_BITS == 64
203 203 #ifdef __PRAGMA_REDEFINE_EXTNAME
204 204 #pragma redefine_extname mmap mmap64
205 205 #else
206 206 #define mmap mmap64
207 207 #endif
208 208 #endif /* !_LP64 && _FILE_OFFSET_BITS == 64 */
209 209
210 210 #if defined(_LP64) && defined(_LARGEFILE64_SOURCE)
211 211 #ifdef __PRAGMA_REDEFINE_EXTNAME
212 212 #pragma redefine_extname mmap64 mmap
213 213 #else
214 214 #define mmap64 mmap
215 215 #endif
216 216 #endif /* _LP64 && _LARGEFILE64_SOURCE */
217 217
218 218 #ifdef __PRAGMA_REDEFINE_EXTNAME
219 219 #pragma redefine_extname getpagesizes getpagesizes2
220 220 #else
221 221 #define getpagesizes getpagesizes2
222 222 #endif
223 223
224 224 /*
225 225 * Except for old binaries mmap() will return the resultant
226 226 * address of mapping on success and (caddr_t)-1 on error.
227 227 */
228 228 #if (_POSIX_C_SOURCE > 2) || defined(_XPG4_2)
229 229 extern void *mmap(void *, size_t, int, int, int, off_t);
230 230 extern int munmap(void *, size_t);
231 231 extern int mprotect(void *, size_t, int);
232 232 extern int msync(void *, size_t, int);
233 233 #if (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2)) || defined(__EXTENSIONS__)
234 234 extern int mlock(const void *, size_t);
235 235 extern int munlock(const void *, size_t);
236 236 #endif /* (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2))... */
237 237 /* transitional large file interface version */
238 238 #if defined(_LARGEFILE64_SOURCE) && !((_FILE_OFFSET_BITS == 64) && \
239 239 !defined(__PRAGMA_REDEFINE_EXTNAME))
240 240 extern void *mmap64(void *, size_t, int, int, int, off64_t);
241 241 #endif /* _LARGEFILE64_SOURCE... */
242 242 #else /* (_POSIX_C_SOURCE > 2) || defined(_XPG4_2) */
243 243 extern caddr_t mmap(caddr_t, size_t, int, int, int, off_t);
244 244 extern int munmap(caddr_t, size_t);
245 245 extern int mprotect(caddr_t, size_t, int);
246 246 extern int msync(caddr_t, size_t, int);
247 247 extern int mlock(caddr_t, size_t);
248 248 extern int munlock(caddr_t, size_t);
249 249 extern int mincore(caddr_t, size_t, char *);
250 250 extern int memcntl(caddr_t, size_t, int, caddr_t, int, int);
251 251 extern int madvise(caddr_t, size_t, int);
252 252 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__)
253 253 extern int getpagesizes(size_t *, int);
254 254 extern int getpagesizes2(size_t *, int);
255 255 extern int mmapobj(int, uint_t, mmapobj_result_t *, uint_t *, void *);
256 256 /* guard visibility of uint64_t */
257 257 #if defined(_INT64_TYPE)
258 258 extern int meminfo(const uint64_t *, int, const uint_t *, int, uint64_t *,
259 259 uint_t *);
260 260 #endif /* defined(_INT64_TYPE) */
261 261 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */
262 262 /* transitional large file interface version */
263 263 #ifdef _LARGEFILE64_SOURCE
264 264 extern caddr_t mmap64(caddr_t, size_t, int, int, int, off64_t);
265 265 #endif
266 266 #endif /* (_POSIX_C_SOURCE > 2) || defined(_XPG4_2) */
267 267
268 268 #if (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2)) || defined(__EXTENSIONS__)
269 269 extern int mlockall(int);
270 270 extern int munlockall(void);
271 271 extern int shm_open(const char *, int, mode_t);
272 272 extern int shm_unlink(const char *);
273 273 #endif
274 274
275 275 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__)
276 276 extern int posix_madvise(void *, size_t, int);
277 277 #endif
278 278
279 279 /* mmap failure value */
280 280 #define MAP_FAILED ((void *) -1)
281 281
282 282
283 283 #endif /* !_ASM && !_KERNEL */
284 284
285 285 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__)
286 286 #if !defined(_ASM)
287 287 /*
288 288 * structure for memcntl hat advise operations.
289 289 */
290 290 struct memcntl_mha {
291 291 uint_t mha_cmd; /* command(s) */
292 292 uint_t mha_flags;
293 293 size_t mha_pagesize;
294 294 };
295 295
296 296 #if defined(_SYSCALL32)
297 297 struct memcntl_mha32 {
298 298 uint_t mha_cmd; /* command(s) */
299 299 uint_t mha_flags;
300 300 size32_t mha_pagesize;
301 301 };
302 302 #endif /* _SYSCALL32 */
303 303 #endif /* !defined(_ASM) */
304 304 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */
305 305
306 306 #if (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) || defined(__EXTENSIONS__)
307 307 /*
308 308 * advice to madvise
309 309 *
310 310 * Note, if more than 4 bits worth of advice (eg. 16) are specified then
311 311 * changes will be necessary to the struct vpage.
312 312 */
313 313 #define MADV_NORMAL 0 /* no further special treatment */
314 314 #define MADV_RANDOM 1 /* expect random page references */
315 315 #define MADV_SEQUENTIAL 2 /* expect sequential page references */
316 316 #define MADV_WILLNEED 3 /* will need these pages */
317 317 #define MADV_DONTNEED 4 /* don't need these pages */
318 318 #define MADV_FREE 5 /* contents can be freed */
319 319 #define MADV_ACCESS_DEFAULT 6 /* default access */
320 320 #define MADV_ACCESS_LWP 7 /* next LWP to access heavily */
321 321 #define MADV_ACCESS_MANY 8 /* many processes to access heavily */
322 322 #define MADV_PURGE 9 /* contents will be purged */
323 323
324 324 #endif /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) ... */
325 325
326 326 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__)
327 327 /* advice to posix_madvise */
328 328 /* these values must be kept in sync with the MADV_* values, above */
329 329 #define POSIX_MADV_NORMAL 0 /* MADV_NORMAL */
330 330 #define POSIX_MADV_RANDOM 1 /* MADV_RANDOM */
331 331 #define POSIX_MADV_SEQUENTIAL 2 /* MADV_SEQUENTIAL */
332 332 #define POSIX_MADV_WILLNEED 3 /* MADV_WILLNEED */
333 333 #define POSIX_MADV_DONTNEED 4 /* MADV_DONTNEED */
334 334 #endif
335 335
336 336 /* flags to msync */
337 337 #define MS_OLDSYNC 0x0 /* old value of MS_SYNC */
338 338 /* modified for UNIX98 compliance */
339 339 #define MS_SYNC 0x4 /* wait for msync */
340 340 #define MS_ASYNC 0x1 /* return immediately */
341 341 #define MS_INVALIDATE 0x2 /* invalidate caches */
342 342 #define MS_INVALCURPROC 0x8 /* invalidate cache for curproc only */
343 343
344 344 #if (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) || defined(__EXTENSIONS__)
345 345 /* functions to mctl */
346 346 #define MC_SYNC 1 /* sync with backing store */
347 347 #define MC_LOCK 2 /* lock pages in memory */
348 348 #define MC_UNLOCK 3 /* unlock pages from memory */
349 349 #define MC_ADVISE 4 /* give advice to management */
350 350 #define MC_LOCKAS 5 /* lock address space in memory */
351 351 #define MC_UNLOCKAS 6 /* unlock address space from memory */
352 352 #define MC_HAT_ADVISE 7 /* advise hat map size */
353 353 #define MC_INHERIT_ZERO 8 /* zero out regions on fork() */
354 354
355 355 /* sub-commands for MC_HAT_ADVISE */
356 356 #define MHA_MAPSIZE_VA 0x1 /* set preferred page size */
357 357 #define MHA_MAPSIZE_BSSBRK 0x2 /* set preferred page size */
358 358 /* for last bss adjacent to */
359 359 /* brk area and brk area itself */
360 360 #define MHA_MAPSIZE_STACK 0x4 /* set preferred page size */
361 361 /* processes main stack */
362 362
363 363 #endif /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) ... */
364 364
365 365 #if (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2)) || defined(__EXTENSIONS__)
366 366 /* flags to mlockall */
367 367 #define MCL_CURRENT 0x1 /* lock current mappings */
368 368 #define MCL_FUTURE 0x2 /* lock future mappings */
369 369 #endif /* (!defined(_XPG4_2) || (_POSIX_C_SOURCE)) || defined(__EXTENSIONS__) */
370 370
371 371 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__)
372 372
373 373 /* definitions for meminfosys syscall */
374 374 #define MISYS_MEMINFO 0x0
375 375
376 376 #if !defined(_ASM)
377 377
378 378 #if defined(_INT64_TYPE)
379 379 /* private structure for meminfo */
380 380 typedef struct meminfo {
381 381 const uint64_t *mi_inaddr; /* array of input addresses */
382 382 const uint_t *mi_info_req; /* array of types of info requested */
383 383 uint64_t *mi_outdata; /* array of results are placed */
384 384 uint_t *mi_validity; /* array of bitwise result codes */
385 385 int mi_info_count; /* number of pieces of info requested */
386 386 } meminfo_t;
387 387 #endif /* defined(_INT64_TYPE) */
388 388
389 389 #if defined(_SYSCALL32)
390 390 typedef struct meminfo32 {
391 391 caddr32_t mi_inaddr; /* array of input addresses */
392 392 caddr32_t mi_info_req; /* array of types of information requested */
393 393 caddr32_t mi_outdata; /* array of results are placed */
394 394 caddr32_t mi_validity; /* array of bitwise result codes */
395 395 int32_t mi_info_count; /* number of pieces of information requested */
396 396 } meminfo32_t;
397 397 #endif /* defined(_SYSCALL32) */
398 398
399 399 #endif /* !defined(_ASM) */
400 400
401 401 /*
402 402 * info_req request type definitions for meminfo
403 403 * request types starting with MEMINFO_V are used for Virtual addresses
404 404 * and should not be mixed with MEMINFO_PLGRP which is targeted for Physical
405 405 * addresses
406 406 */
407 407 #define MEMINFO_SHIFT 16
408 408 #define MEMINFO_MASK (0xFF << MEMINFO_SHIFT)
409 409 #define MEMINFO_VPHYSICAL (0x01 << MEMINFO_SHIFT) /* get physical addr */
410 410 #define MEMINFO_VLGRP (0x02 << MEMINFO_SHIFT) /* get lgroup */
411 411 #define MEMINFO_VPAGESIZE (0x03 << MEMINFO_SHIFT) /* size of phys page */
412 412 #define MEMINFO_VREPLCNT (0x04 << MEMINFO_SHIFT) /* no. of replica */
413 413 #define MEMINFO_VREPL (0x05 << MEMINFO_SHIFT) /* physical replica */
414 414 #define MEMINFO_VREPL_LGRP (0x06 << MEMINFO_SHIFT) /* lgrp of replica */
415 415 #define MEMINFO_PLGRP (0x07 << MEMINFO_SHIFT) /* lgroup for paddr */
416 416
417 417 /* maximum number of addresses meminfo() can process at a time */
418 418 #define MAX_MEMINFO_CNT 256
419 419
420 420 /* maximum number of request types */
421 421 #define MAX_MEMINFO_REQ 31
422 422
423 423 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */
424 424
425 425 #ifdef __cplusplus
426 426 }
427 427 #endif
428 428
429 429 #endif /* _SYS_MMAN_H */
|
↓ open down ↓ |
429 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX