sys/sys/mman.h

   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: src/sys/sys/mman.h,v 1.29.2.1 2001/08/25 07:25:43 dillon Exp $
  35  */
  36
  37 #ifndef _SYS_MMAN_H_
  38 #define _SYS_MMAN_H_
  39
  40 #ifndef _SYS_TYPES_H_
  41 #include <sys/types.h>
  42 #endif
  43 #ifndef _SYS_CDEFS_H_
  44 #include <sys/cdefs.h>
  45 #endif
  46
  47 #if __BSD_VISIBLE
  48 /*
  49  * Inheritance for minherit()
  50  */
  51 #define INHERIT_SHARE  0
  52 #define INHERIT_COPY   1
  53 #define INHERIT_NONE   2
  54 #endif
  55
  56 /*
  57  * Protections are chosen from these bits, or-ed together
  58  */
  59 #define PROT_NONE       0x00    /* no permissions */
  60 #define PROT_READ       0x01    /* pages can be read */
  61 #define PROT_WRITE      0x02    /* pages can be written */
  62 #define PROT_EXEC       0x04    /* pages can be executed */
  63
  64 /*
  65  * Flags contain sharing type and options.
  66  * Sharing types; choose one.
  67  */
  68 #define MAP_SHARED      0x0001          /* share changes */
  69 #define MAP_PRIVATE     0x0002          /* changes are private */
  70 #if __BSD_VISIBLE
  71 #define MAP_COPY        MAP_PRIVATE     /* Obsolete */
  72 #endif
  73
  74 /*
  75  * Other flags
  76  */
  77 #define MAP_FIXED        0x0010 /* map addr must be exactly as requested */
  78 #if __BSD_VISIBLE
  79 #define MAP_RENAME       0x0020 /* Sun: rename private pages to file */
  80 #define MAP_NORESERVE    0x0040 /* Sun: don't reserve needed swap area */
  81 #define MAP_INHERIT      0x0080 /* region is retained after exec */
  82 #define MAP_NOEXTEND     0x0100 /* for MAP_FILE, don't change file size */
  83 #define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */
  84 #define MAP_STACK        0x0400 /* region grows down, like a stack */
  85 #define MAP_NOSYNC       0x0800 /* page to but do not sync underlying file */
  86
  87 /*
  88  * Mapping type
  89  */
  90 #define MAP_FILE        0x0000          /* map from file (default) */
  91 #define MAP_ANON        0x1000          /* allocated from memory, swap space */
  92 #define MAP_ANONYMOUS   MAP_ANON        /* alias for compatibility */
  93 #define MAP_VPAGETABLE  0x2000          /* manage with virtualized page table */
  94
  95 /*
  96  * Extended flags
  97  */
  98 #define MAP_TRYFIXED    0x00010000 /* attempt hint address, even within heap */
  99 #define MAP_NOCORE      0x00020000 /* dont include these pages in a coredump */
 100 #define MAP_SIZEALIGN   0x00040000 /* size is also an alignment requirement */
 101 #endif /* __BSD_VISIBLE */
 102
 103 #if __POSIX_VISIBLE >= 199309
 104 /*
 105  * Process memory locking
 106  */
 107 #define MCL_CURRENT     0x0001  /* Lock only current memory */
 108 #define MCL_FUTURE      0x0002  /* Lock all future memory as well */
 109 #endif /* __POSIX_VISIBLE >= 199309 */
 110
 111 /*
 112  * Error return from mmap()
 113  */
 114 #define MAP_FAILED      ((void *)-1)
 115
 116 /*
 117  * msync() flags
 118  */
 119 #define MS_SYNC         0x0000  /* msync synchronously */
 120 #define MS_ASYNC        0x0001  /* return immediately */
 121 #define MS_INVALIDATE   0x0002  /* invalidate all cached data */
 122
 123 /*
 124  * Advice to madvise
 125  */
 126 #define _MADV_NORMAL    0       /* no further special treatment */
 127 #define _MADV_RANDOM    1       /* expect random page references */
 128 #define _MADV_SEQUENTIAL 2      /* expect sequential page references */
 129 #define _MADV_WILLNEED  3       /* will need these pages */
 130 #define _MADV_DONTNEED  4       /* dont need these pages */
 131
 132 #if __BSD_VISIBLE
 133 #define MADV_NORMAL     _MADV_NORMAL
 134 #define MADV_RANDOM     _MADV_RANDOM
 135 #define MADV_SEQUENTIAL _MADV_SEQUENTIAL
 136 #define MADV_WILLNEED   _MADV_WILLNEED
 137 #define MADV_DONTNEED   _MADV_DONTNEED
 138 #define MADV_FREE       5       /* dont need these pages, and junk contents */
 139 #define MADV_NOSYNC     6       /* try to avoid flushes to physical media */
 140 #define MADV_AUTOSYNC   7       /* revert to default flushing strategy */
 141 #define MADV_NOCORE     8       /* do not include these pages in a core file */
 142 #define MADV_CORE       9       /* revert to including pages in a core file */
 143 #define MADV_INVAL      10      /* virt page tables have changed, inval pmap */
 144 #define MADV_SETMAP     11      /* set page table directory page for map */
 145 #endif
 146
 147 /*
 148  * Advice to posix_madvise()
 149  */
 150 #if __POSIX_VISIBLE >= 200112
 151 #define POSIX_MADV_NORMAL       _MADV_NORMAL
 152 #define POSIX_MADV_RANDOM       _MADV_RANDOM
 153 #define POSIX_MADV_SEQUENTIAL   _MADV_SEQUENTIAL
 154 #define POSIX_MADV_WILLNEED     _MADV_WILLNEED
 155 #define POSIX_MADV_DONTNEED     _MADV_DONTNEED
 156 #endif
 157
 158 #if __BSD_VISIBLE
 159 /*
 160  * mcontrol() must be used for these functions instead of madvise()
 161  */
 162 #define MADV_CONTROL_START      MADV_INVAL
 163 #define MADV_CONTROL_END        MADV_SETMAP
 164
 165 /*
 166  * Return bits from mincore
 167  */
 168 #define MINCORE_INCORE           0x1 /* Page is incore */
 169 #define MINCORE_REFERENCED       0x2 /* Page has been referenced by us */
 170 #define MINCORE_MODIFIED         0x4 /* Page has been modified by us */
 171 #define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
 172 #define MINCORE_MODIFIED_OTHER  0x10 /* Page has been modified */
 173 #define MINCORE_SUPER           0x20 /* Page is a "super" page */
 174 #endif
 175
 176 __BEGIN_DECLS
 177 #if __POSIX_VISIBLE >= 199309
 178 int     mlockall(int);
 179 int     munlockall(void);
 180 int     shm_open(const char *, int, mode_t);
 181 int     shm_unlink(const char *);
 182 #endif /* __POSIX_VISIBLE >= 199309 */
 183 int     mlock(const void *, size_t);
 184 #ifndef _MMAP_DECLARED
 185 #define _MMAP_DECLARED
 186 void *  mmap(void *, size_t, int, int, int, off_t);
 187 #endif
 188 int     mprotect(void *, size_t, int);
 189 int     msync(void *, size_t, int);
 190 int     munlock(const void *, size_t);
 191 int     munmap(void *, size_t);
 192 #if __POSIX_VISIBLE >= 200112
 193 int     posix_madvise(void *, size_t, int);
 194 #endif
 195 #if __BSD_VISIBLE
 196 int     madvise(void *, size_t, int);
 197 int     mcontrol(void *, size_t, int, off_t);
 198 int     mincore(const void *, size_t, char *);
 199 int     minherit(void *, size_t, int);
 200 #endif
 201 __END_DECLS
 202
 203 #endif