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