]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/mman.h
xnu-2782.30.5.tar.gz
[apple/xnu.git] / bsd / sys / mman.h
CommitLineData
1c79356b 1/*
5d5c5d0d
A
2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
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.
8f6c56a5 14 *
2d21ac55
A
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
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
91447636
A
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
1c79356b
A
76#ifndef _SYS_MMAN_H_
77#define _SYS_MMAN_H_
78
9bccf70c 79#include <sys/appleapiopts.h>
91447636
A
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 */
39236c6e
A
88#include <sys/_types/_mode_t.h>
89#include <sys/_types/_off_t.h>
90#include <sys/_types/_size_t.h>
1c79356b
A
91
92/*
93 * Protections are chosen from these bits, or-ed together
94 */
91447636
A
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 */
1c79356b
A
99
100/*
101 * Flags contain sharing type and options.
102 * Sharing types; choose one.
103 */
91447636
A
104#define MAP_SHARED 0x0001 /* [MF|SHM] share changes */
105#define MAP_PRIVATE 0x0002 /* [MF|SHM] changes are private */
2d21ac55 106#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b 107#define MAP_COPY MAP_PRIVATE /* Obsolete */
2d21ac55 108#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1c79356b
A
109
110/*
111 * Other flags
112 */
91447636 113#define MAP_FIXED 0x0010 /* [MF|SHM] interpret addr exactly */
2d21ac55 114#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
115#define MAP_RENAME 0x0020 /* Sun: rename private pages to file */
116#define MAP_NORESERVE 0x0040 /* Sun: don't reserve needed swap area */
55e303ae 117#define MAP_RESERVED0080 0x0080 /* previously unimplemented MAP_INHERIT */
1c79356b
A
118#define MAP_NOEXTEND 0x0100 /* for MAP_FILE, don't change file size */
119#define MAP_HASSEMAPHORE 0x0200 /* region may contain semaphores */
2d21ac55 120#define MAP_NOCACHE 0x0400 /* don't cache pages for this mapping */
6d2010ae 121#define MAP_JIT 0x0800 /* Allocate a region that will be used for JIT purposes */
2d21ac55 122#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1c79356b 123
1c79356b
A
124/*
125 * Process memory locking
126 */
91447636
A
127#define MCL_CURRENT 0x0001 /* [ML] Lock only current memory */
128#define MCL_FUTURE 0x0002 /* [ML] Lock all future memory as well */
1c79356b
A
129
130/*
131 * Error return from mmap()
132 */
91447636 133#define MAP_FAILED ((void *)-1) /* [MF|SHM] mmap failed */
1c79356b
A
134
135/*
136 * msync() flags
137 */
91447636
A
138#define MS_ASYNC 0x0001 /* [MF|SIO] return immediately */
139#define MS_INVALIDATE 0x0002 /* [MF|SIO] invalidate all cached data */
140#define MS_SYNC 0x0010 /* [MF|SIO] msync synchronously */
1c79356b 141
2d21ac55 142#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
143#define MS_KILLPAGES 0x0004 /* invalidate pages, leave mapped */
144#define MS_DEACTIVATE 0x0008 /* deactivate pages, leave mapped */
1c79356b
A
145
146/*
147 * Mapping type
148 */
149#define MAP_FILE 0x0000 /* map from file (default) */
150#define MAP_ANON 0x1000 /* allocated from memory, swap space */
2d21ac55 151#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
91447636 152
1c79356b
A
153
154/*
155 * Advice to madvise
156 */
91447636
A
157#define POSIX_MADV_NORMAL 0 /* [MC1] no further special treatment */
158#define POSIX_MADV_RANDOM 1 /* [MC1] expect random page refs */
159#define POSIX_MADV_SEQUENTIAL 2 /* [MC1] expect sequential page refs */
160#define POSIX_MADV_WILLNEED 3 /* [MC1] will need these pages */
161#define POSIX_MADV_DONTNEED 4 /* [MC1] dont need these pages */
162
2d21ac55 163#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
91447636
A
164#define MADV_NORMAL POSIX_MADV_NORMAL
165#define MADV_RANDOM POSIX_MADV_RANDOM
166#define MADV_SEQUENTIAL POSIX_MADV_SEQUENTIAL
167#define MADV_WILLNEED POSIX_MADV_WILLNEED
168#define MADV_DONTNEED POSIX_MADV_DONTNEED
169#define MADV_FREE 5 /* pages unneeded, discard contents */
b0d623f7
A
170#define MADV_ZERO_WIRED_PAGES 6 /* zero the wired pages that have not been unwired before the entry is deleted */
171#define MADV_FREE_REUSABLE 7 /* pages can be reused (by anyone) */
172#define MADV_FREE_REUSE 8 /* caller wants to reuse those pages */
173#define MADV_CAN_REUSE 9
1c79356b
A
174
175/*
176 * Return bits from mincore
177 */
91447636
A
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 */
2d21ac55 183#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1c79356b 184
1c79356b 185
91447636 186#ifndef KERNEL
1c79356b
A
187
188__BEGIN_DECLS
91447636
A
189/* [ML] */
190int mlockall(int);
191int munlockall(void);
192/* [MR] */
193int mlock(const void *, size_t);
194#ifndef _MMAP
195#define _MMAP
196/* [MC3]*/
197void * mmap(void *, size_t, int, int, int, off_t) __DARWIN_ALIAS(mmap);
1c79356b 198#endif
91447636
A
199/* [MPR] */
200int mprotect(void *, size_t, int) __DARWIN_ALIAS(mprotect);
201/* [MF|SIO] */
2d21ac55 202int msync(void *, size_t, int) __DARWIN_ALIAS_C(msync);
91447636
A
203/* [MR] */
204int munlock(const void *, size_t);
205/* [MC3]*/
206int munmap(void *, size_t) __DARWIN_ALIAS(munmap);
207/* [SHM] */
208int shm_open(const char *, int, ...);
209int shm_unlink(const char *);
210/* [ADV] */
211int posix_madvise(void *, size_t, int);
212
2d21ac55 213#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
91447636
A
214int madvise(void *, size_t, int);
215int mincore(const void *, size_t, char *);
216int minherit(void *, size_t, int);
1c79356b 217#endif
fe8ab488
A
218
219#ifdef PRIVATE
220int mremap_encrypted(void *, size_t, __uint32_t, __uint32_t, __uint32_t);
221#endif
222
1c79356b
A
223__END_DECLS
224
91447636 225#else /* KERNEL */
b0d623f7 226#ifdef XNU_KERNEL_PRIVATE
39236c6e 227void pshm_cache_init(void); /* for bsd_init() */
2d21ac55 228void pshm_lock_init(void);
91447636
A
229
230/*
231 * XXX routine exported by posix_shm.c, but never used there, only used in
232 * XXX kern_mman.c in the implementation of mmap().
233 */
234struct mmap_args;
235struct fileproc;
236int pshm_mmap(struct proc *p, struct mmap_args *uap, user_addr_t *retval,
237 struct fileproc *fp, off_t pageoff);
238/* Really need to overhaul struct fileops to avoid this... */
239struct pshmnode;
2d21ac55
A
240struct stat;
241int pshm_stat(struct pshmnode *pnode, void *ub, int isstat64);
91447636 242struct fileproc;
b0d623f7 243int pshm_truncate(struct proc *p, struct fileproc *fp, int fd, off_t length, int32_t *retval);
91447636 244
b0d623f7 245#endif /* XNU_KERNEL_PRIVATE */
91447636 246#endif /* KERNEL */
1c79356b 247#endif /* !_SYS_MMAN_H_ */