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