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