bsd/sys/mman.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  23 /*-
  24  * Copyright (c) 1982, 1986, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * Redistribution and use in source and binary forms, with or without
  28  * modification, are permitted provided that the following conditions
  29  * are met:
  30  * 1. Redistributions of source code must retain the above copyright
  31  *    notice, this list of conditions and the following disclaimer.
  32  * 2. Redistributions in binary form must reproduce the above copyright
  33  *    notice, this list of conditions and the following disclaimer in the
  34  *    documentation and/or other materials provided with the distribution.
  35  * 3. All advertising materials mentioning features or use of this software
  36  *    must display the following acknowledgement:
  37  *      This product includes software developed by the University of
  38  *      California, Berkeley and its contributors.
  39  * 4. Neither the name of the University nor the names of its contributors
  40  *    may be used to endorse or promote products derived from this software
  41  *    without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  53  * SUCH DAMAGE.
  54  *
  55  *      @(#)mman.h      8.1 (Berkeley) 6/2/93
  56  */
  57
  58 #ifndef _SYS_MMAN_H_
  59 #define _SYS_MMAN_H_
  60
  61 #include <sys/appleapiopts.h>
  62 #include <mach/shared_memory_server.h>
  63
  64 /*
  65  * Protections are chosen from these bits, or-ed together
  66  */
  67 #define PROT_NONE       0x00    /* no permissions */
  68 #define PROT_READ       0x01    /* pages can be read */
  69 #define PROT_WRITE      0x02    /* pages can be written */
  70 #define PROT_EXEC       0x04    /* pages can be executed */
  71
  72 /*
  73  * Flags contain sharing type and options.
  74  * Sharing types; choose one.
  75  */
  76 #define MAP_SHARED      0x0001          /* share changes */
  77 #define MAP_PRIVATE     0x0002          /* changes are private */
  78 #define MAP_COPY        MAP_PRIVATE     /* Obsolete */
  79
  80 /*
  81  * Other flags
  82  */
  83 #define MAP_FIXED        0x0010 /* map addr must be exactly as requested */
  84 #define MAP_RENAME       0x0020 /* Sun: rename private pages to file */
  85 #define MAP_NORESERVE    0x0040 /* Sun: don't reserve needed swap area */
  86 #define MAP_INHERIT      0x0080 /* region is retained after exec */
  87 #define MAP_NOEXTEND     0x0100 /* for MAP_FILE, don't change file size */
  88 #define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */
  89
  90 #ifdef _P1003_1B_VISIBLE
  91 /*
  92  * Process memory locking
  93  */
  94 #define MCL_CURRENT     0x0001  /* Lock only current memory */
  95 #define MCL_FUTURE      0x0002  /* Lock all future memory as well */
  96
  97 #endif /* _P1003_1B_VISIBLE */
  98
  99 /*
 100  * Error return from mmap()
 101  */
 102 #define MAP_FAILED      ((void *)-1)
 103
 104 /*
 105  * msync() flags
 106  */
 107 #define MS_SYNC         0x0000  /* msync synchronously */
 108 #define MS_ASYNC        0x0001  /* return immediately */
 109 #define MS_INVALIDATE   0x0002  /* invalidate all cached data */
 110
 111 #ifndef _POSIX_SOURCE
 112 #define MS_KILLPAGES    0x0004  /* invalidate pages, leave mapped */
 113 #define MS_DEACTIVATE   0x0008  /* deactivate pages, leave mapped */
 114 #endif
 115
 116 /*
 117  * Mapping type
 118  */
 119 #define MAP_FILE        0x0000  /* map from file (default) */
 120 #define MAP_ANON        0x1000  /* allocated from memory, swap space */
 121
 122 /*
 123  * Advice to madvise
 124  */
 125 #define MADV_NORMAL     0       /* no further special treatment */
 126 #define MADV_RANDOM     1       /* expect random page references */
 127 #define MADV_SEQUENTIAL 2       /* expect sequential page references */
 128 #define MADV_WILLNEED   3       /* will need these pages */
 129 #define MADV_DONTNEED   4       /* dont need these pages */
 130 #define MADV_FREE       5       /* dont need these pages, and junk contents */
 131 #define POSIX_MADV_NORMAL       MADV_NORMAL
 132 #define POSIX_MADV_RANDOM       MADV_RANDOM
 133 #define POSIX_MADV_SEQUENTIAL   MADV_SEQUENTIAL
 134 #define POSIX_MADV_WILLNEED     MADV_WILLNEED
 135 #define POSIX_MADV_DONTNEED     MADV_DONTNEED
 136
 137 /*
 138  * Return bits from mincore
 139  */
 140 #define MINCORE_INCORE           0x1 /* Page is incore */
 141 #define MINCORE_REFERENCED       0x2 /* Page has been referenced by us */
 142 #define MINCORE_MODIFIED         0x4 /* Page has been modified by us */
 143 #define MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
 144 #define MINCORE_MODIFIED_OTHER  0x10 /* Page has been modified */
 145
 146 #ifndef KERNEL
 147
 148 #include <sys/cdefs.h>
 149
 150 __BEGIN_DECLS
 151 #ifdef _P1003_1B_VISIBLE
 152 int     mlockall __P((int));
 153 int     munlockall __P((void));
 154 #endif /* _P1003_1B_VISIBLE */
 155 int     mlock __P((const void *, size_t));
 156 #ifndef _MMAP_DECLARED
 157 #define _MMAP_DECLARED
 158 void *  mmap __P((void *, size_t, int, int, int, off_t));
 159 #endif
 160 int     mprotect __P((const void *, size_t, int));
 161 int     msync __P((void *, size_t, int));
 162 int     munlock __P((const void *, size_t));
 163 int     munmap __P((void *, size_t));
 164 int     shm_open __P((const char *, int, ...));
 165 int     shm_unlink __P((const char *));
 166 int     posix_madvise __P((void *, size_t, int));
 167 #ifndef _POSIX_SOURCE
 168 #ifdef __APPLE_API_PRIVATE
 169 int     load_shared_file __P((char *, caddr_t, u_long,
 170                 caddr_t *, int, sf_mapping_t *, int *));
 171 int     reset_shared_file __P((caddr_t *, int, sf_mapping_t *));
 172 int     new_system_shared_regions __P((void));
 173 #endif /* __APPLE_API_PRIVATE */
 174 int     madvise __P((void *, size_t, int));
 175 int     mincore __P((const void *, size_t, char *));
 176 int     minherit __P((void *, size_t, int));
 177 #endif
 178 __END_DECLS
 179
 180 #endif /* !KERNEL */
 181 #endif /* !_SYS_MMAN_H_ */