mman.h revision 319278 
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: stable/10/sys/sys/mman.h 319278 2017-05-31 05:11:28Z delphij $
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#define INHERIT_ZERO	3
47#endif
48
49/*
50 * Protections are chosen from these bits, or-ed together
51 */
52#define	PROT_NONE	0x00	/* no permissions */
53#define	PROT_READ	0x01	/* pages can be read */
54#define	PROT_WRITE	0x02	/* pages can be written */
55#define	PROT_EXEC	0x04	/* pages can be executed */
56
57/*
58 * Flags contain sharing type and options.
59 * Sharing types; choose one.
60 */
61#define	MAP_SHARED	0x0001		/* share changes */
62#define	MAP_PRIVATE	0x0002		/* changes are private */
63#if __BSD_VISIBLE
64#define	MAP_COPY	MAP_PRIVATE	/* Obsolete */
65#endif
66
67/*
68 * Other flags
69 */
70#define	MAP_FIXED	 0x0010	/* map addr must be exactly as requested */
71
72#if __BSD_VISIBLE
73#define	MAP_RENAME	 0x0020	/* Sun: rename private pages to file */
74#define	MAP_NORESERVE	 0x0040	/* Sun: don't reserve needed swap area */
75#define	MAP_RESERVED0080 0x0080	/* previously misimplemented MAP_INHERIT */
76#define	MAP_RESERVED0100 0x0100	/* previously unimplemented MAP_NOEXTEND */
77#define	MAP_HASSEMAPHORE 0x0200	/* region may contain semaphores */
78#define	MAP_STACK	 0x0400	/* region grows down, like a stack */
79#define	MAP_NOSYNC	 0x0800 /* page to but do not sync underlying file */
80
81/*
82 * Mapping type
83 */
84#define	MAP_FILE	 0x0000	/* map from file (default) */
85#define	MAP_ANON	 0x1000	/* allocated from memory, swap space */
86#ifndef _KERNEL
87#define	MAP_ANONYMOUS	 MAP_ANON /* For compatibility. */
88#endif /* !_KERNEL */
89
90/*
91 * Extended flags
92 */
93#define	MAP_EXCL	 0x00004000 /* for MAP_FIXED, fail if address is used */
94#define	MAP_NOCORE	 0x00020000 /* dont include these pages in a coredump */
95#define	MAP_PREFAULT_READ 0x00040000 /* prefault mapping for reading */
96#ifdef __LP64__
97#define	MAP_32BIT	 0x00080000 /* map in the low 2GB of address space */
98#endif
99
100/*
101 * Request specific alignment (n == log2 of the desired alignment).
102 *
103 * MAP_ALIGNED_SUPER requests optimal superpage alignment, but does
104 * not enforce a specific alignment.
105 */
106#define	MAP_ALIGNED(n)	 ((n) << MAP_ALIGNMENT_SHIFT)
107#define	MAP_ALIGNMENT_SHIFT	24
108#define	MAP_ALIGNMENT_MASK	MAP_ALIGNED(0xff)
109#define	MAP_ALIGNED_SUPER	MAP_ALIGNED(1) /* align on a superpage */
110#endif /* __BSD_VISIBLE */
111
112#if __POSIX_VISIBLE >= 199309
113/*
114 * Process memory locking
115 */
116#define MCL_CURRENT	0x0001	/* Lock only current memory */
117#define MCL_FUTURE	0x0002	/* Lock all future memory as well */
118#endif
119
120/*
121 * Error return from mmap()
122 */
123#define MAP_FAILED	((void *)-1)
124
125/*
126 * msync() flags
127 */
128#define	MS_SYNC		0x0000	/* msync synchronously */
129#define MS_ASYNC	0x0001	/* return immediately */
130#define MS_INVALIDATE	0x0002	/* invalidate all cached data */
131
132/*
133 * Advice to madvise
134 */
135#define	_MADV_NORMAL	0	/* no further special treatment */
136#define	_MADV_RANDOM	1	/* expect random page references */
137#define	_MADV_SEQUENTIAL 2	/* expect sequential page references */
138#define	_MADV_WILLNEED	3	/* will need these pages */
139#define	_MADV_DONTNEED	4	/* dont need these pages */
140
141#if __BSD_VISIBLE
142#define	MADV_NORMAL	_MADV_NORMAL
143#define	MADV_RANDOM	_MADV_RANDOM
144#define	MADV_SEQUENTIAL _MADV_SEQUENTIAL
145#define	MADV_WILLNEED	_MADV_WILLNEED
146#define	MADV_DONTNEED	_MADV_DONTNEED
147#define	MADV_FREE	5	/* dont need these pages, and junk contents */
148#define	MADV_NOSYNC	6	/* try to avoid flushes to physical media */
149#define	MADV_AUTOSYNC	7	/* revert to default flushing strategy */
150#define	MADV_NOCORE	8	/* do not include these pages in a core file */
151#define	MADV_CORE	9	/* revert to including pages in a core file */
152#define	MADV_PROTECT	10	/* protect process from pageout kill */
153
154/*
155 * Return bits from mincore
156 */
157#define	MINCORE_INCORE	 	 0x1 /* Page is incore */
158#define	MINCORE_REFERENCED	 0x2 /* Page has been referenced by us */
159#define	MINCORE_MODIFIED	 0x4 /* Page has been modified by us */
160#define	MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
161#define	MINCORE_MODIFIED_OTHER	0x10 /* Page has been modified */
162#define	MINCORE_SUPER		0x20 /* Page is a "super" page */
163
164/*
165 * Anonymous object constant for shm_open().
166 */
167#define	SHM_ANON		((char *)1)
168#endif /* __BSD_VISIBLE */
169
170/*
171 * XXX missing POSIX_TYPED_MEM_* macros and
172 * posix_typed_mem_info structure.
173 */
174#if __POSIX_VISIBLE >= 200112
175#define	POSIX_MADV_NORMAL	_MADV_NORMAL
176#define	POSIX_MADV_RANDOM	_MADV_RANDOM
177#define	POSIX_MADV_SEQUENTIAL	_MADV_SEQUENTIAL
178#define	POSIX_MADV_WILLNEED	_MADV_WILLNEED
179#define	POSIX_MADV_DONTNEED	_MADV_DONTNEED
180#endif
181
182#ifndef _MODE_T_DECLARED
183typedef	__mode_t	mode_t;
184#define	_MODE_T_DECLARED
185#endif
186
187#ifndef _OFF_T_DECLARED
188typedef	__off_t		off_t;
189#define	_OFF_T_DECLARED
190#endif
191
192#ifndef _SIZE_T_DECLARED
193typedef	__size_t	size_t;
194#define	_SIZE_T_DECLARED
195#endif
196
197#if defined(_KERNEL) || defined(_WANT_FILE)
198#include <sys/lock.h>
199#include <sys/mutex.h>
200#include <sys/queue.h>
201#include <sys/rangelock.h>
202#include <vm/vm.h>
203
204struct file;
205
206struct shmfd {
207	size_t		shm_size;
208	vm_object_t	shm_object;
209	int		shm_refs;
210	uid_t		shm_uid;
211	gid_t		shm_gid;
212	mode_t		shm_mode;
213	int		shm_kmappings;
214
215	/*
216	 * Values maintained solely to make this a better-behaved file
217	 * descriptor for fstat() to run on.
218	 */
219	struct timespec	shm_atime;
220	struct timespec	shm_mtime;
221	struct timespec	shm_ctime;
222	struct timespec	shm_birthtime;
223	ino_t		shm_ino;
224
225	struct label	*shm_label;		/* MAC label */
226	const char	*shm_path;
227
228	struct rangelock shm_rl;
229	struct mtx	shm_mtx;
230};
231#endif
232
233#ifdef _KERNEL
234int	shm_mmap(struct shmfd *shmfd, vm_size_t objsize, vm_ooffset_t foff,
235	    vm_object_t *obj);
236int	shm_map(struct file *fp, size_t size, off_t offset, void **memp);
237int	shm_unmap(struct file *fp, void *mem, size_t size);
238void	shm_path(struct shmfd *shmfd, char *path, size_t size);
239
240#else /* !_KERNEL */
241
242__BEGIN_DECLS
243/*
244 * XXX not yet implemented: posix_mem_offset(), posix_typed_mem_get_info(),
245 * posix_typed_mem_open().
246 */
247#if __BSD_VISIBLE
248int	getpagesizes(size_t *, int);
249int	madvise(void *, size_t, int);
250int	mincore(const void *, size_t, char *);
251int	minherit(void *, size_t, int);
252#endif
253int	mlock(const void *, size_t);
254#ifndef _MMAP_DECLARED
255#define	_MMAP_DECLARED
256void *	mmap(void *, size_t, int, int, int, off_t);
257#endif
258int	mprotect(const void *, size_t, int);
259int	msync(void *, size_t, int);
260int	munlock(const void *, size_t);
261int	munmap(void *, size_t);
262#if __POSIX_VISIBLE >= 200112
263int	posix_madvise(void *, size_t, int);
264#endif
265#if __POSIX_VISIBLE >= 199309
266int	mlockall(int);
267int	munlockall(void);
268int	shm_open(const char *, int, mode_t);
269int	shm_unlink(const char *);
270#endif
271__END_DECLS
272
273#endif /* !_KERNEL */
274
275#endif /* !_SYS_MMAN_H_ */
276