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_FIXED 0x10 /* user assigns address */ 85 #define MAP_NORESERVE 0x40 /* don't reserve needed swap area */ 86 #define MAP_ANON 0x100 /* map anonymous pages directly */ 87 #define MAP_ANONYMOUS MAP_ANON /* (source compatibility) */ 88 #define MAP_ALIGN 0x200 /* addr specifies alignment */ 89 #define MAP_TEXT 0x400 /* map code segment */ 90 #define MAP_INITDATA 0x800 /* map data segment */ 91 92 #ifdef _KERNEL 93 #define _MAP_TEXTREPL 0x1000 94 #endif /* _KERNEL */ 95 96 /* these flags not yet implemented */ 97 #define MAP_RENAME 0x20 /* rename private pages to file */ 98 99 #if (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) 100 /* these flags are used by memcntl */ 101 #define PROC_TEXT (PROT_EXEC | PROT_READ) 102 #define PROC_DATA (PROT_READ | PROT_WRITE | PROT_EXEC) 103 #define SHARED 0x10 104 #define PRIVATE 0x20 105 #define VALID_ATTR (PROT_READ|PROT_WRITE|PROT_EXEC|SHARED|PRIVATE) 106 #endif /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) */ 107 108 #if (_POSIX_C_SOURCE <= 2) || defined(_XPG4_2) 109 #ifdef _KERNEL 110 #define PROT_EXCL 0x20 111 #endif /* _KERNEL */ 112 113 #define _MAP_LOW32 0x80 /* force mapping in lower 4G of address space */ 114 #define MAP_32BIT _MAP_LOW32 115 116 /* 117 * For the sake of backward object compatibility, we use the _MAP_NEW flag. 118 * This flag will be automatically or'ed in by the C library for all 119 * new mmap calls. Previous binaries with old mmap calls will continue 120 * to get 0 or -1 for return values. New mmap calls will get the mapped 121 * address as the return value if successful and -1 on errors. By default, 122 * new mmap calls automatically have the kernel assign the map address 123 * unless the MAP_FIXED flag is given. 124 */ 125 #define _MAP_NEW 0x80000000 /* users should not need to use this */ 126 #endif /* (_POSIX_C_SOURCE <= 2) */ 127 128 129 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) 130 /* External flags for mmapobj syscall (Exclusive of MAP_* flags above) */ 131 #define MMOBJ_PADDING 0x10000 132 #define MMOBJ_INTERPRET 0x20000 133 134 #define MMOBJ_ALL_FLAGS (MMOBJ_PADDING | MMOBJ_INTERPRET) 135 136 /* 137 * Values for mr_flags field of mmapobj_result_t below. 138 * The bottom 16 bits are mutually exclusive and thus only one 139 * of them can be set at a time. Use MR_GET_TYPE below to check this value. 140 * The top 16 bits are used for flags which are not mutually exclusive and 141 * thus more than one of these flags can be set for a given mmapobj_result_t. 142 * 143 * MR_PADDING being set indicates that this memory range represents the user 144 * requested padding. 145 * 146 * MR_HDR_ELF being set indicates that the ELF header of the mapped object 147 * is mapped at mr_addr + mr_offset. 148 * 149 * MR_HDR_AOUT being set indicates that the AOUT (4.x) header of the mapped 150 * object is mapped at mr_addr + mr_offset. 151 */ 152 153 /* 154 * External flags for mr_flags field below. 155 */ 156 #define MR_PADDING 0x1 157 #define MR_HDR_ELF 0x2 158 #define MR_HDR_AOUT 0x3 159 160 /* 161 * Internal flags for mr_flags field below. 162 */ 163 #ifdef _KERNEL 164 #define MR_RESV 0x80000000 /* overmapped /dev/null */ 165 #endif /* _KERNEL */ 166 167 #define MR_TYPE_MASK 0x0000ffff 168 #define MR_GET_TYPE(val) ((val) & MR_TYPE_MASK) 169 170 #if !defined(_ASM) 171 typedef struct mmapobj_result { 172 caddr_t mr_addr; /* mapping address */ 173 size_t mr_msize; /* mapping size */ 174 size_t mr_fsize; /* file size */ 175 size_t mr_offset; /* offset into file */ 176 uint_t mr_prot; /* the protections provided */ 177 uint_t mr_flags; /* info on the mapping */ 178 } mmapobj_result_t; 179 180 #if defined(_KERNEL) || defined(_SYSCALL32) 181 typedef struct mmapobj_result32 { 182 caddr32_t mr_addr; /* mapping address */ 183 size32_t mr_msize; /* mapping size */ 184 size32_t mr_fsize; /* file size */ 185 size32_t mr_offset; /* offset into file */ 186 uint_t mr_prot; /* the protections provided */ 187 uint_t mr_flags; /* info on the mapping */ 188 } mmapobj_result32_t; 189 #endif /* defined(_KERNEL) || defined(_SYSCALL32) */ 190 #endif /* !defined(_ASM) */ 191 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */ 192 193 #if !defined(_ASM) && !defined(_KERNEL) 194 /* 195 * large file compilation environment setup 196 * 197 * In the LP64 compilation environment, map large file interfaces 198 * back to native versions where possible. 199 */ 200 201 #if !defined(_LP64) && _FILE_OFFSET_BITS == 64 202 #ifdef __PRAGMA_REDEFINE_EXTNAME 203 #pragma redefine_extname mmap mmap64 204 #else 205 #define mmap mmap64 206 #endif 207 #endif /* !_LP64 && _FILE_OFFSET_BITS == 64 */ 208 209 #if defined(_LP64) && defined(_LARGEFILE64_SOURCE) 210 #ifdef __PRAGMA_REDEFINE_EXTNAME 211 #pragma redefine_extname mmap64 mmap 212 #else 213 #define mmap64 mmap 214 #endif 215 #endif /* _LP64 && _LARGEFILE64_SOURCE */ 216 217 #ifdef __PRAGMA_REDEFINE_EXTNAME 218 #pragma redefine_extname getpagesizes getpagesizes2 219 #else 220 #define getpagesizes getpagesizes2 221 #endif 222 223 /* 224 * Except for old binaries mmap() will return the resultant 225 * address of mapping on success and (caddr_t)-1 on error. 226 */ 227 #if (_POSIX_C_SOURCE > 2) || defined(_XPG4_2) 228 extern void *mmap(void *, size_t, int, int, int, off_t); 229 extern int munmap(void *, size_t); 230 extern int mprotect(void *, size_t, int); 231 extern int msync(void *, size_t, int); 232 #if (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2)) || defined(__EXTENSIONS__) 233 extern int mlock(const void *, size_t); 234 extern int munlock(const void *, size_t); 235 #endif /* (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2))... */ 236 /* transitional large file interface version */ 237 #if defined(_LARGEFILE64_SOURCE) && !((_FILE_OFFSET_BITS == 64) && \ 238 !defined(__PRAGMA_REDEFINE_EXTNAME)) 239 extern void *mmap64(void *, size_t, int, int, int, off64_t); 240 #endif /* _LARGEFILE64_SOURCE... */ 241 #else /* (_POSIX_C_SOURCE > 2) || defined(_XPG4_2) */ 242 extern caddr_t mmap(caddr_t, size_t, int, int, int, off_t); 243 extern int munmap(caddr_t, size_t); 244 extern int mprotect(caddr_t, size_t, int); 245 extern int msync(caddr_t, size_t, int); 246 extern int mlock(caddr_t, size_t); 247 extern int munlock(caddr_t, size_t); 248 extern int mincore(caddr_t, size_t, char *); 249 extern int memcntl(caddr_t, size_t, int, caddr_t, int, int); 250 extern int madvise(caddr_t, size_t, int); 251 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) 252 extern int getpagesizes(size_t *, int); 253 extern int getpagesizes2(size_t *, int); 254 extern int mmapobj(int, uint_t, mmapobj_result_t *, uint_t *, void *); 255 /* guard visibility of uint64_t */ 256 #if defined(_INT64_TYPE) 257 extern int meminfo(const uint64_t *, int, const uint_t *, int, uint64_t *, 258 uint_t *); 259 #endif /* defined(_INT64_TYPE) */ 260 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */ 261 /* transitional large file interface version */ 262 #ifdef _LARGEFILE64_SOURCE 263 extern caddr_t mmap64(caddr_t, size_t, int, int, int, off64_t); 264 #endif 265 #endif /* (_POSIX_C_SOURCE > 2) || defined(_XPG4_2) */ 266 267 #if (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2)) || defined(__EXTENSIONS__) 268 extern int mlockall(int); 269 extern int munlockall(void); 270 extern int shm_open(const char *, int, mode_t); 271 extern int shm_unlink(const char *); 272 #endif 273 274 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__) 275 extern int posix_madvise(void *, size_t, int); 276 #endif 277 278 /* mmap failure value */ 279 #define MAP_FAILED ((void *) -1) 280 281 282 #endif /* !_ASM && !_KERNEL */ 283 284 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) 285 #if !defined(_ASM) 286 /* 287 * structure for memcntl hat advise operations. 288 */ 289 struct memcntl_mha { 290 uint_t mha_cmd; /* command(s) */ 291 uint_t mha_flags; 292 size_t mha_pagesize; 293 }; 294 295 #if defined(_SYSCALL32) 296 struct memcntl_mha32 { 297 uint_t mha_cmd; /* command(s) */ 298 uint_t mha_flags; 299 size32_t mha_pagesize; 300 }; 301 #endif /* _SYSCALL32 */ 302 #endif /* !defined(_ASM) */ 303 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */ 304 305 #if (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) || defined(__EXTENSIONS__) 306 /* 307 * advice to madvise 308 * 309 * Note, if more than 4 bits worth of advice (eg. 16) are specified then 310 * changes will be necessary to the struct vpage. 311 */ 312 #define MADV_NORMAL 0 /* no further special treatment */ 313 #define MADV_RANDOM 1 /* expect random page references */ 314 #define MADV_SEQUENTIAL 2 /* expect sequential page references */ 315 #define MADV_WILLNEED 3 /* will need these pages */ 316 #define MADV_DONTNEED 4 /* don't need these pages */ 317 #define MADV_FREE 5 /* contents can be freed */ 318 #define MADV_ACCESS_DEFAULT 6 /* default access */ 319 #define MADV_ACCESS_LWP 7 /* next LWP to access heavily */ 320 #define MADV_ACCESS_MANY 8 /* many processes to access heavily */ 321 #define MADV_PURGE 9 /* contents will be purged */ 322 323 #endif /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) ... */ 324 325 #if !defined(__XOPEN_OR_POSIX) || defined(_XPG6) || defined(__EXTENSIONS__) 326 /* advice to posix_madvise */ 327 /* these values must be kept in sync with the MADV_* values, above */ 328 #define POSIX_MADV_NORMAL 0 /* MADV_NORMAL */ 329 #define POSIX_MADV_RANDOM 1 /* MADV_RANDOM */ 330 #define POSIX_MADV_SEQUENTIAL 2 /* MADV_SEQUENTIAL */ 331 #define POSIX_MADV_WILLNEED 3 /* MADV_WILLNEED */ 332 #define POSIX_MADV_DONTNEED 4 /* MADV_DONTNEED */ 333 #endif 334 335 /* flags to msync */ 336 #define MS_OLDSYNC 0x0 /* old value of MS_SYNC */ 337 /* modified for UNIX98 compliance */ 338 #define MS_SYNC 0x4 /* wait for msync */ 339 #define MS_ASYNC 0x1 /* return immediately */ 340 #define MS_INVALIDATE 0x2 /* invalidate caches */ 341 342 #if (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) || defined(__EXTENSIONS__) 343 /* functions to mctl */ 344 #define MC_SYNC 1 /* sync with backing store */ 345 #define MC_LOCK 2 /* lock pages in memory */ 346 #define MC_UNLOCK 3 /* unlock pages from memory */ 347 #define MC_ADVISE 4 /* give advice to management */ 348 #define MC_LOCKAS 5 /* lock address space in memory */ 349 #define MC_UNLOCKAS 6 /* unlock address space from memory */ 350 #define MC_HAT_ADVISE 7 /* advise hat map size */ 351 #define MC_INHERIT_ZERO 8 /* zero out regions on fork() */ 352 353 /* sub-commands for MC_HAT_ADVISE */ 354 #define MHA_MAPSIZE_VA 0x1 /* set preferred page size */ 355 #define MHA_MAPSIZE_BSSBRK 0x2 /* set preferred page size */ 356 /* for last bss adjacent to */ 357 /* brk area and brk area itself */ 358 #define MHA_MAPSIZE_STACK 0x4 /* set preferred page size */ 359 /* processes main stack */ 360 361 #endif /* (_POSIX_C_SOURCE <= 2) && !defined(_XPG4_2) ... */ 362 363 #if (!defined(_XPG4_2) || (_POSIX_C_SOURCE > 2)) || defined(__EXTENSIONS__) 364 /* flags to mlockall */ 365 #define MCL_CURRENT 0x1 /* lock current mappings */ 366 #define MCL_FUTURE 0x2 /* lock future mappings */ 367 #endif /* (!defined(_XPG4_2) || (_POSIX_C_SOURCE)) || defined(__EXTENSIONS__) */ 368 369 #if !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) 370 371 /* definitions for meminfosys syscall */ 372 #define MISYS_MEMINFO 0x0 373 374 #if !defined(_ASM) 375 376 #if defined(_INT64_TYPE) 377 /* private structure for meminfo */ 378 typedef struct meminfo { 379 const uint64_t *mi_inaddr; /* array of input addresses */ 380 const uint_t *mi_info_req; /* array of types of info requested */ 381 uint64_t *mi_outdata; /* array of results are placed */ 382 uint_t *mi_validity; /* array of bitwise result codes */ 383 int mi_info_count; /* number of pieces of info requested */ 384 } meminfo_t; 385 #endif /* defined(_INT64_TYPE) */ 386 387 #if defined(_SYSCALL32) 388 typedef struct meminfo32 { 389 caddr32_t mi_inaddr; /* array of input addresses */ 390 caddr32_t mi_info_req; /* array of types of information requested */ 391 caddr32_t mi_outdata; /* array of results are placed */ 392 caddr32_t mi_validity; /* array of bitwise result codes */ 393 int32_t mi_info_count; /* number of pieces of information requested */ 394 } meminfo32_t; 395 #endif /* defined(_SYSCALL32) */ 396 397 #endif /* !defined(_ASM) */ 398 399 /* 400 * info_req request type definitions for meminfo 401 * request types starting with MEMINFO_V are used for Virtual addresses 402 * and should not be mixed with MEMINFO_PLGRP which is targeted for Physical 403 * addresses 404 */ 405 #define MEMINFO_SHIFT 16 406 #define MEMINFO_MASK (0xFF << MEMINFO_SHIFT) 407 #define MEMINFO_VPHYSICAL (0x01 << MEMINFO_SHIFT) /* get physical addr */ 408 #define MEMINFO_VLGRP (0x02 << MEMINFO_SHIFT) /* get lgroup */ 409 #define MEMINFO_VPAGESIZE (0x03 << MEMINFO_SHIFT) /* size of phys page */ 410 #define MEMINFO_VREPLCNT (0x04 << MEMINFO_SHIFT) /* no. of replica */ 411 #define MEMINFO_VREPL (0x05 << MEMINFO_SHIFT) /* physical replica */ 412 #define MEMINFO_VREPL_LGRP (0x06 << MEMINFO_SHIFT) /* lgrp of replica */ 413 #define MEMINFO_PLGRP (0x07 << MEMINFO_SHIFT) /* lgroup for paddr */ 414 415 /* maximum number of addresses meminfo() can process at a time */ 416 #define MAX_MEMINFO_CNT 256 417 418 /* maximum number of request types */ 419 #define MAX_MEMINFO_REQ 31 420 421 #endif /* !defined(__XOPEN_OR_POSIX) || defined(__EXTENSIONS__) */ 422 423 #ifdef __cplusplus 424 } 425 #endif 426 427 #endif /* _SYS_MMAN_H */ 428