mman.h revision 112881
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 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)mman.h 8.2 (Berkeley) 1/9/95 34 * $FreeBSD: head/sys/sys/mman.h 112881 2003-03-31 21:09:57Z wes $ 35 */ 36 37#ifndef _SYS_MMAN_H_ 38#define _SYS_MMAN_H_ 39 40#include <sys/cdefs.h> 41#include <sys/_types.h> 42 43#if __BSD_VISIBLE 44/* 45 * Inheritance for minherit() 46 */ 47#define INHERIT_SHARE 0 48#define INHERIT_COPY 1 49#define INHERIT_NONE 2 50#endif 51 52/* 53 * Protections are chosen from these bits, or-ed together 54 */ 55#define PROT_NONE 0x00 /* no permissions */ 56#define PROT_READ 0x01 /* pages can be read */ 57#define PROT_WRITE 0x02 /* pages can be written */ 58#define PROT_EXEC 0x04 /* pages can be executed */ 59 60/* 61 * Flags contain sharing type and options. 62 * Sharing types; choose one. 63 */ 64#define MAP_SHARED 0x0001 /* share changes */ 65#define MAP_PRIVATE 0x0002 /* changes are private */ 66#define MAP_COPY MAP_PRIVATE /* Obsolete */ 67 68#if __BSD_VISIBLE 69/* 70 * Other flags 71 */ 72#define MAP_FIXED 0x0010 /* map addr must be exactly as requested */ 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 87/* 88 * Extended flags 89 */ 90#define MAP_NOCORE 0x00020000 /* dont include these pages in a coredump */ 91#endif /* __BSD_VISIBLE */ 92 93#if __POSIX_VISIBLE >= 199309 94/* 95 * Process memory locking 96 */ 97#define MCL_CURRENT 0x0001 /* Lock only current memory */ 98#define MCL_FUTURE 0x0002 /* Lock all future memory as well */ 99#endif 100 101/* 102 * Error return from mmap() 103 */ 104#define MAP_FAILED ((void *)-1) 105 106/* 107 * msync() flags 108 */ 109#define MS_SYNC 0x0000 /* msync synchronously */ 110#define MS_ASYNC 0x0001 /* return immediately */ 111#define MS_INVALIDATE 0x0002 /* invalidate all cached data */ 112 113#if __BSD_VISIBLE 114/* 115 * Advice to madvise 116 */ 117#define MADV_NORMAL 0 /* no further special treatment */ 118#define MADV_RANDOM 1 /* expect random page references */ 119#define MADV_SEQUENTIAL 2 /* expect sequential page references */ 120#define MADV_WILLNEED 3 /* will need these pages */ 121#define MADV_DONTNEED 4 /* dont need these pages */ 122#define MADV_FREE 5 /* dont need these pages, and junk contents */ 123#define MADV_NOSYNC 6 /* try to avoid flushes to physical media */ 124#define MADV_AUTOSYNC 7 /* revert to default flushing strategy */ 125#define MADV_NOCORE 8 /* do not include these pages in a core file */ 126#define MADV_CORE 9 /* revert to including pages in a core file */ 127#define MADV_PROTECT 10 /* protect process from pageout kill */ 128 129/* 130 * Return bits from mincore 131 */ 132#define MINCORE_INCORE 0x1 /* Page is incore */ 133#define MINCORE_REFERENCED 0x2 /* Page has been referenced by us */ 134#define MINCORE_MODIFIED 0x4 /* Page has been modified by us */ 135#define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */ 136#define MINCORE_MODIFIED_OTHER 0x10 /* Page has been modified */ 137#endif /* __BSD_VISIBLE */ 138 139/* 140 * XXX missing POSIX_MADV_* macros, POSIX_TYPED_MEM_* macros, and 141 * posix_typed_mem_info structure. 142 */ 143 144#ifndef _MODE_T_DECLARED 145typedef __mode_t mode_t; 146#define _MODE_T_DECLARED 147#endif 148 149#ifndef _OFF_T_DECLARED 150typedef __off_t off_t; 151#define _OFF_T_DECLARED 152#endif 153 154#ifndef _SIZE_T_DECLARED 155typedef __size_t size_t; 156#define _SIZE_T_DECLARED 157#endif 158 159#ifndef _KERNEL 160 161__BEGIN_DECLS 162/* 163 * XXX not yet implemented: mlockall(), munlockall(), posix_madvise(), 164 * posix_mem_offset(), posix_typed_mem_get_info(), posix_typed_mem_open(). 165 */ 166#if __BSD_VISIBLE 167int madvise(void *, size_t, int); 168int mincore(const void *, size_t, char *); 169int minherit(void *, size_t, int); 170#endif 171int mlock(const void *, size_t); 172#ifndef _MMAP_DECLARED 173#define _MMAP_DECLARED 174void * mmap(void *, size_t, int, int, int, off_t); 175#endif 176int mprotect(const void *, size_t, int); 177int msync(void *, size_t, int); 178int munlock(const void *, size_t); 179int munmap(void *, size_t); 180#if __POSIX_VISIBLE >= 199309 181int shm_open(const char *, int, mode_t); 182int shm_unlink(const char *); 183#endif 184__END_DECLS 185 186#endif /* !_KERNEL */ 187 188#endif /* !_SYS_MMAN_H_ */ 189