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$
  35  */
  36
  37 #ifndef _SYS_MMAN_H_
  38 #define _SYS_MMAN_H_
  39
  40 #include <sys/_posix.h>
  41
  42 /*
  43  * Protections are chosen from these bits, or-ed together
  44  */
  45 #define PROT_NONE       0x00    /* no permissions */
  46 #define PROT_READ       0x01    /* pages can be read */
  47 #define PROT_WRITE      0x02    /* pages can be written */
  48 #define PROT_EXEC       0x04    /* pages can be executed */
  49
  50 /*
  51  * Flags contain sharing type and options.
  52  * Sharing types; choose one.
  53  */
  54 #define MAP_SHARED      0x0001          /* share changes */
  55 #define MAP_PRIVATE     0x0002          /* changes are private */
  56 #define MAP_COPY        MAP_PRIVATE     /* Obsolete */
  57
  58 /*
  59  * Other flags
  60  */
  61 #define MAP_FIXED        0x0010 /* map addr must be exactly as requested */
  62 #define MAP_RENAME       0x0020 /* Sun: rename private pages to file */
  63 #define MAP_NORESERVE    0x0040 /* Sun: don't reserve needed swap area */
  64 #define MAP_INHERIT      0x0080 /* region is retained after exec */
  65 #define MAP_NOEXTEND     0x0100 /* for MAP_FILE, don't change file size */
  66 #define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */
  67 #define MAP_STACK        0x0400 /* region grows down, like a stack */
  68 #define MAP_NOSYNC       0x0800 /* page to but do not sync underlying file */
  69
  70 /*
  71  * Extended flags
  72  */
  73 #define MAP_NOCORE       0x00020000 /* dont include these pages in a coredump */
  74
  75 #ifdef _P1003_1B_VISIBLE
  76 /*
  77  * Process memory locking
  78  */
  79 #define MCL_CURRENT     0x0001  /* Lock only current memory */
  80 #define MCL_FUTURE      0x0002  /* Lock all future memory as well */
  81
  82 #endif /* _P1003_1B_VISIBLE */
  83
  84 /*
  85  * Error return from mmap()
  86  */
  87 #define MAP_FAILED      ((void *)-1)
  88
  89 /*
  90  * msync() flags
  91  */
  92 #define MS_SYNC         0x0000  /* msync synchronously */
  93 #define MS_ASYNC        0x0001  /* return immediately */
  94 #define MS_INVALIDATE   0x0002  /* invalidate all cached data */
  95
  96
  97 /*
  98  * Mapping type
  99  */
 100 #define MAP_FILE        0x0000  /* map from file (default) */
 101 #define MAP_ANON        0x1000  /* allocated from memory, swap space */
 102
 103 /*
 104  * Advice to madvise
 105  */
 106 #define MADV_NORMAL     0       /* no further special treatment */
 107 #define MADV_RANDOM     1       /* expect random page references */
 108 #define MADV_SEQUENTIAL 2       /* expect sequential page references */
 109 #define MADV_WILLNEED   3       /* will need these pages */
 110 #define MADV_DONTNEED   4       /* dont need these pages */
 111 #define MADV_FREE       5       /* dont need these pages, and junk contents */
 112 #define MADV_NOSYNC     6       /* try to avoid flushes to physical media */
 113 #define MADV_AUTOSYNC   7       /* revert to default flushing strategy */
 114 #define MADV_NOCORE     8       /* do not include these pages in a core file */
 115 #define MADV_CORE       9       /* revert to including pages in a core file */
 116
 117 /*
 118  * Return bits from mincore
 119  */
 120 #define MINCORE_INCORE           0x1 /* Page is incore */
 121 #define MINCORE_REFERENCED       0x2 /* Page has been referenced by us */
 122 #define MINCORE_MODIFIED         0x4 /* Page has been modified by us */
 123 #define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
 124 #define MINCORE_MODIFIED_OTHER  0x10 /* Page has been modified */
 125
 126 #ifndef _KERNEL
 127
 128 #include <sys/cdefs.h>
 129
 130 __BEGIN_DECLS
 131 #ifdef _P1003_1B_VISIBLE
 132 int     mlockall __P((int));
 133 int     munlockall __P((void));
 134 int     shm_open __P((const char *, int, mode_t));
 135 int     shm_unlink __P((const char *));
 136 #endif /* _P1003_1B_VISIBLE */
 137 int     mlock __P((const void *, size_t));
 138 #ifndef _MMAP_DECLARED
 139 #define _MMAP_DECLARED
 140 void *  mmap __P((void *, size_t, int, int, int, off_t));
 141 #endif
 142 int     mprotect __P((const void *, size_t, int));
 143 int     msync __P((void *, size_t, int));
 144 int     munlock __P((const void *, size_t));
 145 int     munmap __P((void *, size_t));
 146 #ifndef _POSIX_SOURCE
 147 int     madvise __P((void *, size_t, int));
 148 int     mincore __P((const void *, size_t, char *));
 149 int     minherit __P((void *, size_t, int));
 150 #endif
 151 __END_DECLS
 152
 153 #endif /* !_KERNEL */
 154
 155 #endif