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: stable/10/sys/sys/mman.h 321717 2017-07-30 10:36:20Z kib $ 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#define INHERIT_ZERO 3 47#endif 48 49/* 50 * Protections are chosen from these bits, or-ed together 51 */ 52#define PROT_NONE 0x00 /* no permissions */ 53#define PROT_READ 0x01 /* pages can be read */ 54#define PROT_WRITE 0x02 /* pages can be written */ 55#define PROT_EXEC 0x04 /* pages can be executed */ 56 57/* 58 * Flags contain sharing type and options. 59 * Sharing types; choose one. 60 */ 61#define MAP_SHARED 0x0001 /* share changes */ 62#define MAP_PRIVATE 0x0002 /* changes are private */ 63#if __BSD_VISIBLE 64#define MAP_COPY MAP_PRIVATE /* Obsolete */ 65#endif 66 67/* 68 * Other flags 69 */ 70#define MAP_FIXED 0x0010 /* map addr must be exactly as requested */ 71 72#if __BSD_VISIBLE 73#define MAP_RENAME 0x0020 /* Sun: rename private pages to file */ 74#define MAP_NORESERVE 0x0040 /* Sun: don't reserve needed swap area */ 75#define MAP_RESERVED0080 0x0080 /* previously misimplemented MAP_INHERIT */ 76#define MAP_RESERVED0100 0x0100 /* previously unimplemented MAP_NOEXTEND */ 77#define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */ 78#define MAP_STACK 0x0400 /* region grows down, like a stack */ 79#define MAP_NOSYNC 0x0800 /* page to but do not sync underlying file */ 80 81/* 82 * Mapping type 83 */ 84#define MAP_FILE 0x0000 /* map from file (default) */ 85#define MAP_ANON 0x1000 /* allocated from memory, swap space */ 86#ifndef _KERNEL 87#define MAP_ANONYMOUS MAP_ANON /* For compatibility. */ 88#endif /* !_KERNEL */ 89 90/* 91 * Extended flags 92 */ 93#define MAP_GUARD 0x00002000 /* reserve but don't map address range */ 94#define MAP_EXCL 0x00004000 /* for MAP_FIXED, fail if address is used */ 95#define MAP_NOCORE 0x00020000 /* dont include these pages in a coredump */ 96#define MAP_PREFAULT_READ 0x00040000 /* prefault mapping for reading */ 97#ifdef __LP64__ 98#define MAP_32BIT 0x00080000 /* map in the low 2GB of address space */ 99#endif 100 101/* 102 * Request specific alignment (n == log2 of the desired alignment). 103 * 104 * MAP_ALIGNED_SUPER requests optimal superpage alignment, but does 105 * not enforce a specific alignment. 106 */ 107#define MAP_ALIGNED(n) ((n) << MAP_ALIGNMENT_SHIFT) 108#define MAP_ALIGNMENT_SHIFT 24 109#define MAP_ALIGNMENT_MASK MAP_ALIGNED(0xff) 110#define MAP_ALIGNED_SUPER MAP_ALIGNED(1) /* align on a superpage */ 111#endif /* __BSD_VISIBLE */ 112 113#if __POSIX_VISIBLE >= 199309 114/* 115 * Process memory locking 116 */ 117#define MCL_CURRENT 0x0001 /* Lock only current memory */ 118#define MCL_FUTURE 0x0002 /* Lock all future memory as well */ 119#endif 120 121/* 122 * Error return from mmap() 123 */ 124#define MAP_FAILED ((void *)-1) 125 126/* 127 * msync() flags 128 */ 129#define MS_SYNC 0x0000 /* msync synchronously */ 130#define MS_ASYNC 0x0001 /* return immediately */ 131#define MS_INVALIDATE 0x0002 /* invalidate all cached data */ 132 133/* 134 * Advice to madvise 135 */ 136#define _MADV_NORMAL 0 /* no further special treatment */ 137#define _MADV_RANDOM 1 /* expect random page references */ 138#define _MADV_SEQUENTIAL 2 /* expect sequential page references */ 139#define _MADV_WILLNEED 3 /* will need these pages */ 140#define _MADV_DONTNEED 4 /* dont need these pages */ 141 142#if __BSD_VISIBLE 143#define MADV_NORMAL _MADV_NORMAL 144#define MADV_RANDOM _MADV_RANDOM 145#define MADV_SEQUENTIAL _MADV_SEQUENTIAL 146#define MADV_WILLNEED _MADV_WILLNEED 147#define MADV_DONTNEED _MADV_DONTNEED 148#define MADV_FREE 5 /* dont need these pages, and junk contents */ 149#define MADV_NOSYNC 6 /* try to avoid flushes to physical media */ 150#define MADV_AUTOSYNC 7 /* revert to default flushing strategy */ 151#define MADV_NOCORE 8 /* do not include these pages in a core file */ 152#define MADV_CORE 9 /* revert to including pages in a core file */ 153#define MADV_PROTECT 10 /* protect process from pageout kill */ 154 155/* 156 * Return bits from mincore 157 */ 158#define MINCORE_INCORE 0x1 /* Page is incore */ 159#define MINCORE_REFERENCED 0x2 /* Page has been referenced by us */ 160#define MINCORE_MODIFIED 0x4 /* Page has been modified by us */ 161#define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */ 162#define MINCORE_MODIFIED_OTHER 0x10 /* Page has been modified */ 163#define MINCORE_SUPER 0x20 /* Page is a "super" page */ 164 165/* 166 * Anonymous object constant for shm_open(). 167 */ 168#define SHM_ANON ((char *)1) 169#endif /* __BSD_VISIBLE */ 170 171/* 172 * XXX missing POSIX_TYPED_MEM_* macros and 173 * posix_typed_mem_info structure. 174 */ 175#if __POSIX_VISIBLE >= 200112 176#define POSIX_MADV_NORMAL _MADV_NORMAL 177#define POSIX_MADV_RANDOM _MADV_RANDOM 178#define POSIX_MADV_SEQUENTIAL _MADV_SEQUENTIAL 179#define POSIX_MADV_WILLNEED _MADV_WILLNEED 180#define POSIX_MADV_DONTNEED _MADV_DONTNEED 181#endif 182 183#ifndef _MODE_T_DECLARED 184typedef __mode_t mode_t; 185#define _MODE_T_DECLARED 186#endif 187 188#ifndef _OFF_T_DECLARED 189typedef __off_t off_t; 190#define _OFF_T_DECLARED 191#endif 192 193#ifndef _SIZE_T_DECLARED 194typedef __size_t size_t; 195#define _SIZE_T_DECLARED 196#endif 197 198#if defined(_KERNEL) || defined(_WANT_FILE) 199#include <sys/lock.h> 200#include <sys/mutex.h> 201#include <sys/queue.h> 202#include <sys/rangelock.h> 203#include <vm/vm.h> 204 205struct file; 206 207struct shmfd { 208 size_t shm_size; 209 vm_object_t shm_object; 210 int shm_refs; 211 uid_t shm_uid; 212 gid_t shm_gid; 213 mode_t shm_mode; 214 int shm_kmappings; 215 216 /* 217 * Values maintained solely to make this a better-behaved file 218 * descriptor for fstat() to run on. 219 */ 220 struct timespec shm_atime; 221 struct timespec shm_mtime; 222 struct timespec shm_ctime; 223 struct timespec shm_birthtime; 224 ino_t shm_ino; 225 226 struct label *shm_label; /* MAC label */ 227 const char *shm_path; 228 229 struct rangelock shm_rl; 230 struct mtx shm_mtx; 231}; 232#endif 233 234#ifdef _KERNEL 235int shm_mmap(struct shmfd *shmfd, vm_size_t objsize, vm_ooffset_t foff, 236 vm_object_t *obj); 237int shm_map(struct file *fp, size_t size, off_t offset, void **memp); 238int shm_unmap(struct file *fp, void *mem, size_t size); 239void shm_path(struct shmfd *shmfd, char *path, size_t size); 240 241#else /* !_KERNEL */ 242 243__BEGIN_DECLS 244/* 245 * XXX not yet implemented: posix_mem_offset(), posix_typed_mem_get_info(), 246 * posix_typed_mem_open(). 247 */ 248#if __BSD_VISIBLE 249int getpagesizes(size_t *, int); 250int madvise(void *, size_t, int); 251int mincore(const void *, size_t, char *); 252int minherit(void *, size_t, int); 253#endif 254int mlock(const void *, size_t); 255#ifndef _MMAP_DECLARED 256#define _MMAP_DECLARED 257void * mmap(void *, size_t, int, int, int, off_t); 258#endif 259int mprotect(const void *, size_t, int); 260int msync(void *, size_t, int); 261int munlock(const void *, size_t); 262int munmap(void *, size_t); 263#if __POSIX_VISIBLE >= 200112 264int posix_madvise(void *, size_t, int); 265#endif 266#if __POSIX_VISIBLE >= 199309 267int mlockall(int); 268int munlockall(void); 269int shm_open(const char *, int, mode_t); 270int shm_unlink(const char *); 271#endif 272__END_DECLS 273 274#endif /* !_KERNEL */ 275 276#endif /* !_SYS_MMAN_H_ */ 277