bsd/sys/mman.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*-
  30  * Copyright (c) 1982, 1986, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)mman.h      8.1 (Berkeley) 6/2/93
  62  */
  63
  64 /*
  65  * Currently unsupported:
  66  *
  67  * [TYM]        POSIX_TYPED_MEM_ALLOCATE
  68  * [TYM]        POSIX_TYPED_MEM_ALLOCATE_CONTIG
  69  * [TYM]        POSIX_TYPED_MEM_MAP_ALLOCATABLE
  70  * [TYM]        struct posix_typed_mem_info
  71  * [TYM]        posix_mem_offset()
  72  * [TYM]        posix_typed_mem_get_info()
  73  * [TYM]        posix_typed_mem_open()
  74  */
  75
  76 #ifndef _SYS_MMAN_H_
  77 #define _SYS_MMAN_H_
  78
  79 #include <sys/appleapiopts.h>
  80 #include <sys/cdefs.h>
  81
  82 #include <sys/_types.h>
  83
  84 /*
  85  * [various] The mode_t, off_t, and size_t types shall be defined as
  86  * described in <sys/types.h>
  87  */
  88 #include <sys/_types/_mode_t.h>
  89 #include <sys/_types/_off_t.h>
  90 #include <sys/_types/_size_t.h>
  91
  92 /*
  93  * Protections are chosen from these bits, or-ed together
  94  */
  95 #define PROT_NONE       0x00    /* [MC2] no permissions */
  96 #define PROT_READ       0x01    /* [MC2] pages can be read */
  97 #define PROT_WRITE      0x02    /* [MC2] pages can be written */
  98 #define PROT_EXEC       0x04    /* [MC2] pages can be executed */
  99
 100 /*
 101  * Flags contain sharing type and options.
 102  * Sharing types; choose one.
 103  */
 104 #define MAP_SHARED      0x0001          /* [MF|SHM] share changes */
 105 #define MAP_PRIVATE     0x0002          /* [MF|SHM] changes are private */
 106 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 107 #define MAP_COPY        MAP_PRIVATE     /* Obsolete */
 108 #endif  /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 109
 110 /*
 111  * Other flags
 112  */
 113 #define MAP_FIXED        0x0010 /* [MF|SHM] interpret addr exactly */
 114 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 115 #define MAP_RENAME       0x0020 /* Sun: rename private pages to file */
 116 #define MAP_NORESERVE    0x0040 /* Sun: don't reserve needed swap area */
 117 #define MAP_RESERVED0080 0x0080 /* previously unimplemented MAP_INHERIT */
 118 #define MAP_NOEXTEND     0x0100 /* for MAP_FILE, don't change file size */
 119 #define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */
 120 #define MAP_NOCACHE      0x0400 /* don't cache pages for this mapping */
 121 #define MAP_JIT          0x0800 /* Allocate a region that will be used for JIT purposes */
 122
 123 /*
 124  * Mapping type
 125  */
 126 #define MAP_FILE        0x0000  /* map from file (default) */
 127 #define MAP_ANON        0x1000  /* allocated from memory, swap space */
 128 #define MAP_ANONYMOUS   MAP_ANON
 129
 130 /*
 131  * The MAP_RESILIENT_* flags can be used when the caller wants to map some
 132  * possibly unreliable memory and be able to access it safely, possibly
 133  * getting the wrong contents rather than raising any exception.
 134  * For safety reasons, such mappings have to be read-only (PROT_READ access
 135  * only).
 136  *
 137  * MAP_RESILIENT_CODESIGN:
 138  *      accessing this mapping will not generate code-signing violations,
 139  *      even if the contents are tainted.
 140  * MAP_RESILIENT_MEDIA:
 141  *      accessing this mapping will not generate an exception if the contents
 142  *      are not available (unreachable removable or remote media, access beyond
 143  *      end-of-file, ...).  Missing contents will be replaced with zeroes.
 144  */
 145 #define MAP_RESILIENT_CODESIGN  0x2000 /* no code-signing failures */
 146 #define MAP_RESILIENT_MEDIA     0x4000 /* no backing-store failures */
 147
 148 #endif  /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 149
 150 /*
 151  * Process memory locking
 152  */
 153 #define MCL_CURRENT     0x0001  /* [ML] Lock only current memory */
 154 #define MCL_FUTURE      0x0002  /* [ML] Lock all future memory as well */
 155
 156 /*
 157  * Error return from mmap()
 158  */
 159 #define MAP_FAILED      ((void *)-1)    /* [MF|SHM] mmap failed */
 160
 161 /*
 162  * msync() flags
 163  */
 164 #define MS_ASYNC        0x0001  /* [MF|SIO] return immediately */
 165 #define MS_INVALIDATE   0x0002  /* [MF|SIO] invalidate all cached data */
 166 #define MS_SYNC         0x0010  /* [MF|SIO] msync synchronously */
 167
 168 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 169 #define MS_KILLPAGES    0x0004  /* invalidate pages, leave mapped */
 170 #define MS_DEACTIVATE   0x0008  /* deactivate pages, leave mapped */
 171
 172 #endif  /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 173
 174
 175 /*
 176  * Advice to madvise
 177  */
 178 #define POSIX_MADV_NORMAL       0       /* [MC1] no further special treatment */
 179 #define POSIX_MADV_RANDOM       1       /* [MC1] expect random page refs */
 180 #define POSIX_MADV_SEQUENTIAL   2       /* [MC1] expect sequential page refs */
 181 #define POSIX_MADV_WILLNEED     3       /* [MC1] will need these pages */
 182 #define POSIX_MADV_DONTNEED     4       /* [MC1] dont need these pages */
 183
 184 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 185 #define MADV_NORMAL             POSIX_MADV_NORMAL
 186 #define MADV_RANDOM             POSIX_MADV_RANDOM
 187 #define MADV_SEQUENTIAL         POSIX_MADV_SEQUENTIAL
 188 #define MADV_WILLNEED           POSIX_MADV_WILLNEED
 189 #define MADV_DONTNEED           POSIX_MADV_DONTNEED
 190 #define MADV_FREE               5       /* pages unneeded, discard contents */
 191 #define MADV_ZERO_WIRED_PAGES   6       /* zero the wired pages that have not been unwired before the entry is deleted */
 192 #define MADV_FREE_REUSABLE      7       /* pages can be reused (by anyone) */
 193 #define MADV_FREE_REUSE         8       /* caller wants to reuse those pages */
 194 #define MADV_CAN_REUSE          9
 195 #define MADV_PAGEOUT            10      /* page out now (internal only) */
 196
 197 /*
 198  * Return bits from mincore
 199  */
 200 #define MINCORE_INCORE           0x1     /* Page is incore */
 201 #define MINCORE_REFERENCED       0x2     /* Page has been referenced by us */
 202 #define MINCORE_MODIFIED         0x4     /* Page has been modified by us */
 203 #define MINCORE_REFERENCED_OTHER 0x8     /* Page has been referenced */
 204 #define MINCORE_MODIFIED_OTHER  0x10     /* Page has been modified */
 205 #define MINCORE_PAGED_OUT       0x20     /* Page has been paged out */
 206 #define MINCORE_COPIED          0x40     /* Page has been copied */
 207 #define MINCORE_ANONYMOUS       0x80     /* Page belongs to an anonymous object */
 208 #endif  /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
 209
 210
 211 #ifndef KERNEL
 212
 213 __BEGIN_DECLS
 214 /* [ML] */
 215 int     mlockall(int);
 216 int     munlockall(void);
 217 /* [MR] */
 218 int     mlock(const void *, size_t);
 219 #ifndef _MMAP
 220 #define _MMAP
 221 /* [MC3]*/
 222 void *  mmap(void *, size_t, int, int, int, off_t) __DARWIN_ALIAS(mmap);
 223 #endif
 224 /* [MPR] */
 225 int     mprotect(void *, size_t, int) __DARWIN_ALIAS(mprotect);
 226 /* [MF|SIO] */
 227 int     msync(void *, size_t, int) __DARWIN_ALIAS_C(msync);
 228 /* [MR] */
 229 int     munlock(const void *, size_t);
 230 /* [MC3]*/
 231 int     munmap(void *, size_t) __DARWIN_ALIAS(munmap);
 232 /* [SHM] */
 233 int     shm_open(const char *, int, ...);
 234 int     shm_unlink(const char *);
 235 /* [ADV] */
 236 int     posix_madvise(void *, size_t, int);
 237
 238 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 239 int     madvise(void *, size_t, int);
 240 int     mincore(const void *, size_t, char *);
 241 int     minherit(void *, size_t, int);
 242 #endif
 243
 244 #ifdef PRIVATE
 245 int mremap_encrypted(void *, size_t, __uint32_t, __uint32_t, __uint32_t);
 246 #endif
 247
 248 __END_DECLS
 249
 250 #else   /* KERNEL */
 251 #ifdef XNU_KERNEL_PRIVATE
 252 void pshm_cache_init(void);     /* for bsd_init() */
 253 void pshm_lock_init(void);
 254
 255 /*
 256  * XXX routine exported by posix_shm.c, but never used there, only used in
 257  * XXX kern_mman.c in the implementation of mmap().
 258  */
 259 struct mmap_args;
 260 struct fileproc;
 261 int pshm_mmap(struct proc *p, struct mmap_args *uap, user_addr_t *retval,
 262                 struct fileproc *fp, off_t pageoff);
 263 /* Really need to overhaul struct fileops to avoid this... */
 264 struct pshmnode;
 265 struct stat;
 266 int pshm_stat(struct pshmnode *pnode, void *ub, int isstat64);
 267 struct fileproc;
 268 int pshm_truncate(struct proc *p, struct fileproc *fp, int fd, off_t length, int32_t *retval);
 269
 270 #endif /* XNU_KERNEL_PRIVATE */
 271 #endif /* KERNEL */
 272 #endif /* !_SYS_MMAN_H_ */