mman.h revision 128680
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 128680 2004-04-27 13:13:20Z mux $ 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#define MAP_COPY MAP_PRIVATE /* Obsolete */ 63 64#if __BSD_VISIBLE 65/* 66 * Other flags 67 */ 68#define MAP_FIXED 0x0010 /* map addr must be exactly as requested */ 69#define MAP_RENAME 0x0020 /* Sun: rename private pages to file */ 70#define MAP_NORESERVE 0x0040 /* Sun: don't reserve needed swap area */ 71#define MAP_RESERVED0080 0x0080 /* previously misimplemented MAP_INHERIT */ 72#define MAP_RESERVED0100 0x0100 /* previously unimplemented MAP_NOEXTEND */ 73#define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */ 74#define MAP_STACK 0x0400 /* region grows down, like a stack */ 75#define MAP_NOSYNC 0x0800 /* page to but do not sync underlying file */ 76 77/* 78 * Mapping type 79 */ 80#define MAP_FILE 0x0000 /* map from file (default) */ 81#define MAP_ANON 0x1000 /* allocated from memory, swap space */ 82 83/* 84 * Extended flags 85 */ 86#define MAP_NOCORE 0x00020000 /* dont include these pages in a coredump */ 87#endif /* __BSD_VISIBLE */ 88 89#if __POSIX_VISIBLE >= 199309 90/* 91 * Process memory locking 92 */ 93#define MCL_CURRENT 0x0001 /* Lock only current memory */ 94#define MCL_FUTURE 0x0002 /* Lock all future memory as well */ 95#endif 96 97/* 98 * Error return from mmap() 99 */ 100#define MAP_FAILED ((void *)-1) 101 102/* 103 * msync() flags 104 */ 105#define MS_SYNC 0x0000 /* msync synchronously */ 106#define MS_ASYNC 0x0001 /* return immediately */ 107#define MS_INVALIDATE 0x0002 /* invalidate all cached data */ 108 109#if __BSD_VISIBLE 110/* 111 * Advice to madvise 112 */ 113#define MADV_NORMAL 0 /* no further special treatment */ 114#define MADV_RANDOM 1 /* expect random page references */ 115#define MADV_SEQUENTIAL 2 /* expect sequential page references */ 116#define MADV_WILLNEED 3 /* will need these pages */ 117#define MADV_DONTNEED 4 /* dont need these pages */ 118#define MADV_FREE 5 /* dont need these pages, and junk contents */ 119#define MADV_NOSYNC 6 /* try to avoid flushes to physical media */ 120#define MADV_AUTOSYNC 7 /* revert to default flushing strategy */ 121#define MADV_NOCORE 8 /* do not include these pages in a core file */ 122#define MADV_CORE 9 /* revert to including pages in a core file */ 123#define MADV_PROTECT 10 /* protect process from pageout kill */ 124 125/* 126 * Return bits from mincore 127 */ 128#define MINCORE_INCORE 0x1 /* Page is incore */ 129#define MINCORE_REFERENCED 0x2 /* Page has been referenced by us */ 130#define MINCORE_MODIFIED 0x4 /* Page has been modified by us */ 131#define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */ 132#define MINCORE_MODIFIED_OTHER 0x10 /* Page has been modified */ 133#endif /* __BSD_VISIBLE */ 134 135/* 136 * XXX missing POSIX_TYPED_MEM_* macros and 137 * posix_typed_mem_info structure. 138 */ 139#if __POSIX_VISIBLE >= 200112 140#define POSIX_MADV_NORMAL MADV_NORMAL 141#define POSIX_MADV_RANDOM MADV_RANDOM 142#define POSIX_MADV_SEQUENTIAL MADV_SEQUENTIAL 143#define POSIX_MADV_WILLNEED MADV_WILLNEED 144#define POSIX_MADV_DONTNEED MADV_DONTNEED 145#endif 146 147#ifndef _MODE_T_DECLARED 148typedef __mode_t mode_t; 149#define _MODE_T_DECLARED 150#endif 151 152#ifndef _OFF_T_DECLARED 153typedef __off_t off_t; 154#define _OFF_T_DECLARED 155#endif 156 157#ifndef _SIZE_T_DECLARED 158typedef __size_t size_t; 159#define _SIZE_T_DECLARED 160#endif 161 162#ifndef _KERNEL 163 164__BEGIN_DECLS 165/* 166 * XXX not yet implemented: posix_mem_offset(), posix_typed_mem_get_info(), 167 * posix_typed_mem_open(). 168 */ 169#if __BSD_VISIBLE 170int madvise(void *, size_t, int); 171int mincore(const void *, size_t, char *); 172int minherit(void *, size_t, int); 173#endif 174int mlock(const void *, size_t); 175#ifndef _MMAP_DECLARED 176#define _MMAP_DECLARED 177void * mmap(void *, size_t, int, int, int, off_t); 178#endif 179int mprotect(const void *, size_t, int); 180int msync(void *, size_t, int); 181int munlock(const void *, size_t); 182int munmap(void *, size_t); 183#if __POSIX_VISIBLE >= 200112 184int posix_madvise(void *, size_t, int); 185#endif 186#if __POSIX_VISIBLE >= 199309 187int mlockall(int); 188int munlockall(void); 189int shm_open(const char *, int, mode_t); 190int shm_unlink(const char *); 191#endif 192__END_DECLS 193 194#endif /* !_KERNEL */ 195 196#endif /* !_SYS_MMAN_H_ */ 197