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