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