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 #endif /* __BSD_VISIBLE */ 95 96 #if __POSIX_VISIBLE >= 199309 97 /* 98 * Process memory locking 99 */ 100 #define MCL_CURRENT 0x0001 /* Lock only current memory */ 101 #define MCL_FUTURE 0x0002 /* Lock all future memory as well */ 102 #endif 103 104 /* 105 * Error return from mmap() 106 */ 107 #define MAP_FAILED ((void *)-1) 108 109 /* 110 * msync() flags 111 */ 112 #define MS_SYNC 0x0000 /* msync synchronously */ 113 #define MS_ASYNC 0x0001 /* return immediately */ 114 #define MS_INVALIDATE 0x0002 /* invalidate all cached data */ 115 116 /* 117 * Advice to madvise 118 */ 119 #define _MADV_NORMAL 0 /* no further special treatment */ 120 #define _MADV_RANDOM 1 /* expect random page references */ 121 #define _MADV_SEQUENTIAL 2 /* expect sequential page references */ 122 #define _MADV_WILLNEED 3 /* will need these pages */ 123 #define _MADV_DONTNEED 4 /* dont need these pages */ 124 125 #if __BSD_VISIBLE 126 #define MADV_NORMAL _MADV_NORMAL 127 #define MADV_RANDOM _MADV_RANDOM 128 #define MADV_SEQUENTIAL _MADV_SEQUENTIAL 129 #define MADV_WILLNEED _MADV_WILLNEED 130 #define MADV_DONTNEED _MADV_DONTNEED 131 #define MADV_FREE 5 /* dont need these pages, and junk contents */ 132 #define MADV_NOSYNC 6 /* try to avoid flushes to physical media */ 133 #define MADV_AUTOSYNC 7 /* revert to default flushing strategy */ 134 #define MADV_NOCORE 8 /* do not include these pages in a core file */ 135 #define MADV_CORE 9 /* revert to including pages in a core file */ 136 #define MADV_PROTECT 10 /* protect process from pageout kill */ 137 138 /* 139 * Return bits from mincore 140 */ 141 #define MINCORE_INCORE 0x1 /* Page is incore */ 142 #define MINCORE_REFERENCED 0x2 /* Page has been referenced by us */ 143 #define MINCORE_MODIFIED 0x4 /* Page has been modified by us */ 144 #define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */ 145 #define MINCORE_MODIFIED_OTHER 0x10 /* Page has been modified */ 146 #define MINCORE_SUPER 0x20 /* Page is a "super" page */ 147 148 /* 149 * Anonymous object constant for shm_open(). 150 */ 151 #define SHM_ANON ((char *)1) 152 #endif /* __BSD_VISIBLE */ 153 154 /* 155 * XXX missing POSIX_TYPED_MEM_* macros and 156 * posix_typed_mem_info structure. 157 */ 158 #if __POSIX_VISIBLE >= 200112 159 #define POSIX_MADV_NORMAL _MADV_NORMAL 160 #define POSIX_MADV_RANDOM _MADV_RANDOM 161 #define POSIX_MADV_SEQUENTIAL _MADV_SEQUENTIAL 162 #define POSIX_MADV_WILLNEED _MADV_WILLNEED 163 #define POSIX_MADV_DONTNEED _MADV_DONTNEED 164 #endif 165 166 #ifndef _MODE_T_DECLARED 167 typedef __mode_t mode_t; 168 #define _MODE_T_DECLARED 169 #endif 170 171 #ifndef _OFF_T_DECLARED 172 typedef __off_t off_t; 173 #define _OFF_T_DECLARED 174 #endif 175 176 #ifndef _SIZE_T_DECLARED 177 typedef __size_t size_t; 178 #define _SIZE_T_DECLARED 179 #endif 180 181 #if defined(_KERNEL) || defined(_WANT_FILE) 182 #include <vm/vm.h> 183 184 struct file; 185 186 struct shmfd { 187 size_t shm_size; 188 vm_object_t shm_object; 189 int shm_refs; 190 uid_t shm_uid; 191 gid_t shm_gid; 192 mode_t shm_mode; 193 int shm_kmappings; 194 195 /* 196 * Values maintained solely to make this a better-behaved file 197 * descriptor for fstat() to run on. 198 */ 199 struct timespec shm_atime; 200 struct timespec shm_mtime; 201 struct timespec shm_ctime; 202 struct timespec shm_birthtime; 203 204 struct label *shm_label; /* MAC label */ 205 const char *shm_path; 206 }; 207 #endif 208 209 #ifdef _KERNEL 210 int shm_mmap(struct shmfd *shmfd, vm_size_t objsize, vm_ooffset_t foff, 211 vm_object_t *obj); 212 int shm_map(struct file *fp, size_t size, off_t offset, void **memp); 213 int shm_unmap(struct file *fp, void *mem, size_t size); 214 void shm_path(struct shmfd *shmfd, char *path, size_t size); 215 216 #else /* !_KERNEL */ 217 218 __BEGIN_DECLS 219 /* 220 * XXX not yet implemented: posix_mem_offset(), posix_typed_mem_get_info(), 221 * posix_typed_mem_open(). 222 */ 223 #if __BSD_VISIBLE 224 int getpagesizes(size_t *, int); 225 int madvise(void *, size_t, int); 226 int mincore(const void *, size_t, char *); 227 int minherit(void *, size_t, int); 228 #endif 229 int mlock(const void *, size_t); 230 #ifndef _MMAP_DECLARED 231 #define _MMAP_DECLARED 232 void * mmap(void *, size_t, int, int, int, off_t); 233 #endif 234 int mprotect(const void *, size_t, int); 235 int msync(void *, size_t, int); 236 int munlock(const void *, size_t); 237 int munmap(void *, size_t); 238 #if __POSIX_VISIBLE >= 200112 239 int posix_madvise(void *, size_t, int); 240 #endif 241 #if __POSIX_VISIBLE >= 199309 242 int mlockall(int); 243 int munlockall(void); 244 int shm_open(const char *, int, mode_t); 245 int shm_unlink(const char *); 246 #endif 247 __END_DECLS 248 249 #endif /* !_KERNEL */ 250 251 #endif /* !_SYS_MMAN_H_ */ 252