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