xref: /freebsd-src/sys/sys/mman.h (revision 17ed18fef3ee30b72f8f88ef7b43d082ae8d8bf1)
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  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)mman.h	8.2 (Berkeley) 1/9/95
30  * $FreeBSD$
31  */
32 
33 #ifndef _SYS_MMAN_H_
34 #define _SYS_MMAN_H_
35 
36 #include <sys/cdefs.h>
37 #include <sys/_types.h>
38 
39 #if __BSD_VISIBLE
40 /*
41  * Inheritance for minherit()
42  */
43 #define INHERIT_SHARE	0
44 #define INHERIT_COPY	1
45 #define INHERIT_NONE	2
46 #endif
47 
48 /*
49  * Protections are chosen from these bits, or-ed together
50  */
51 #define	PROT_NONE	0x00	/* no permissions */
52 #define	PROT_READ	0x01	/* pages can be read */
53 #define	PROT_WRITE	0x02	/* pages can be written */
54 #define	PROT_EXEC	0x04	/* pages can be executed */
55 
56 /*
57  * Flags contain sharing type and options.
58  * Sharing types; choose one.
59  */
60 #define	MAP_SHARED	0x0001		/* share changes */
61 #define	MAP_PRIVATE	0x0002		/* changes are private */
62 #if __BSD_VISIBLE
63 #define	MAP_COPY	MAP_PRIVATE	/* Obsolete */
64 #endif
65 
66 /*
67  * Other flags
68  */
69 #define	MAP_FIXED	 0x0010	/* map addr must be exactly as requested */
70 
71 #if __BSD_VISIBLE
72 #define	MAP_RENAME	 0x0020	/* Sun: rename private pages to file */
73 #define	MAP_NORESERVE	 0x0040	/* Sun: don't reserve needed swap area */
74 #define	MAP_RESERVED0080 0x0080	/* previously misimplemented MAP_INHERIT */
75 #define	MAP_RESERVED0100 0x0100	/* previously unimplemented MAP_NOEXTEND */
76 #define	MAP_HASSEMAPHORE 0x0200	/* region may contain semaphores */
77 #define	MAP_STACK	 0x0400	/* region grows down, like a stack */
78 #define	MAP_NOSYNC	 0x0800 /* page to but do not sync underlying file */
79 
80 /*
81  * Mapping type
82  */
83 #define	MAP_FILE	 0x0000	/* map from file (default) */
84 #define	MAP_ANON	 0x1000	/* allocated from memory, swap space */
85 
86 /*
87  * Extended flags
88  */
89 #define	MAP_NOCORE	 0x00020000 /* dont include these pages in a coredump */
90 #endif /* __BSD_VISIBLE */
91 
92 #if __POSIX_VISIBLE >= 199309
93 /*
94  * Process memory locking
95  */
96 #define MCL_CURRENT	0x0001	/* Lock only current memory */
97 #define MCL_FUTURE	0x0002	/* Lock all future memory as well */
98 #endif
99 
100 /*
101  * Error return from mmap()
102  */
103 #define MAP_FAILED	((void *)-1)
104 
105 /*
106  * msync() flags
107  */
108 #define	MS_SYNC		0x0000	/* msync synchronously */
109 #define MS_ASYNC	0x0001	/* return immediately */
110 #define MS_INVALIDATE	0x0002	/* invalidate all cached data */
111 
112 /*
113  * Advice to madvise
114  */
115 #define	_MADV_NORMAL	0	/* no further special treatment */
116 #define	_MADV_RANDOM	1	/* expect random page references */
117 #define	_MADV_SEQUENTIAL 2	/* expect sequential page references */
118 #define	_MADV_WILLNEED	3	/* will need these pages */
119 #define	_MADV_DONTNEED	4	/* dont need these pages */
120 
121 #if __BSD_VISIBLE
122 #define	MADV_NORMAL	_MADV_NORMAL
123 #define	MADV_RANDOM	_MADV_RANDOM
124 #define	MADV_SEQUENTIAL _MADV_SEQUENTIAL
125 #define	MADV_WILLNEED	_MADV_WILLNEED
126 #define	MADV_DONTNEED	_MADV_DONTNEED
127 #define	MADV_FREE	5	/* dont need these pages, and junk contents */
128 #define	MADV_NOSYNC	6	/* try to avoid flushes to physical media */
129 #define	MADV_AUTOSYNC	7	/* revert to default flushing strategy */
130 #define	MADV_NOCORE	8	/* do not include these pages in a core file */
131 #define	MADV_CORE	9	/* revert to including pages in a core file */
132 #define	MADV_PROTECT	10	/* protect process from pageout kill */
133 
134 /*
135  * Return bits from mincore
136  */
137 #define	MINCORE_INCORE	 	 0x1 /* Page is incore */
138 #define	MINCORE_REFERENCED	 0x2 /* Page has been referenced by us */
139 #define	MINCORE_MODIFIED	 0x4 /* Page has been modified by us */
140 #define	MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
141 #define	MINCORE_MODIFIED_OTHER	0x10 /* Page has been modified */
142 #endif /* __BSD_VISIBLE */
143 
144 /*
145  * XXX missing POSIX_TYPED_MEM_* macros and
146  * posix_typed_mem_info structure.
147  */
148 #if __POSIX_VISIBLE >= 200112
149 #define	POSIX_MADV_NORMAL	_MADV_NORMAL
150 #define	POSIX_MADV_RANDOM	_MADV_RANDOM
151 #define	POSIX_MADV_SEQUENTIAL	_MADV_SEQUENTIAL
152 #define	POSIX_MADV_WILLNEED	_MADV_WILLNEED
153 #define	POSIX_MADV_DONTNEED	_MADV_DONTNEED
154 #endif
155 
156 #ifndef _MODE_T_DECLARED
157 typedef	__mode_t	mode_t;
158 #define	_MODE_T_DECLARED
159 #endif
160 
161 #ifndef _OFF_T_DECLARED
162 typedef	__off_t		off_t;
163 #define	_OFF_T_DECLARED
164 #endif
165 
166 #ifndef _SIZE_T_DECLARED
167 typedef	__size_t	size_t;
168 #define	_SIZE_T_DECLARED
169 #endif
170 
171 #ifndef _KERNEL
172 
173 __BEGIN_DECLS
174 /*
175  * XXX not yet implemented: posix_mem_offset(), posix_typed_mem_get_info(),
176  * posix_typed_mem_open().
177  */
178 #if __BSD_VISIBLE
179 int	madvise(void *, size_t, int);
180 int	mincore(const void *, size_t, char *);
181 int	minherit(void *, size_t, int);
182 #endif
183 int	mlock(const void *, size_t);
184 #ifndef _MMAP_DECLARED
185 #define	_MMAP_DECLARED
186 void *	mmap(void *, size_t, int, int, int, off_t);
187 #endif
188 int	mprotect(const void *, size_t, int);
189 int	msync(void *, size_t, int);
190 int	munlock(const void *, size_t);
191 int	munmap(void *, size_t);
192 #if __POSIX_VISIBLE >= 200112
193 int	posix_madvise(void *, size_t, int);
194 #endif
195 #if __POSIX_VISIBLE >= 199309
196 int	mlockall(int);
197 int	munlockall(void);
198 int	shm_open(const char *, int, mode_t);
199 int	shm_unlink(const char *);
200 #endif
201 __END_DECLS
202 
203 #endif /* !_KERNEL */
204 
205 #endif /* !_SYS_MMAN_H_ */
206