xref: /dragonfly/sys/sys/mman.h (revision 333227be)
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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)mman.h	8.2 (Berkeley) 1/9/95
34  * $FreeBSD: src/sys/sys/mman.h,v 1.29.2.1 2001/08/25 07:25:43 dillon Exp $
35  * $DragonFly: src/sys/sys/mman.h,v 1.3 2003/08/20 07:31:21 rob Exp $
36  */
37 
38 #ifndef _SYS_MMAN_H_
39 #define _SYS_MMAN_H_
40 
41 #include <sys/_posix.h>
42 
43 /*
44  * Inheritance for minherit()
45  */
46 #define INHERIT_SHARE  0
47 #define INHERIT_COPY   1
48 #define INHERIT_NONE   2
49 
50 /*
51  * Protections are chosen from these bits, or-ed together
52  */
53 #define	PROT_NONE	0x00	/* no permissions */
54 #define	PROT_READ	0x01	/* pages can be read */
55 #define	PROT_WRITE	0x02	/* pages can be written */
56 #define	PROT_EXEC	0x04	/* pages can be executed */
57 
58 /*
59  * Flags contain sharing type and options.
60  * Sharing types; choose one.
61  */
62 #define	MAP_SHARED	0x0001		/* share changes */
63 #define	MAP_PRIVATE	0x0002		/* changes are private */
64 #define	MAP_COPY	MAP_PRIVATE	/* Obsolete */
65 
66 /*
67  * Other flags
68  */
69 #define	MAP_FIXED	 0x0010	/* map addr must be exactly as requested */
70 #define	MAP_RENAME	 0x0020	/* Sun: rename private pages to file */
71 #define	MAP_NORESERVE	 0x0040	/* Sun: don't reserve needed swap area */
72 #define	MAP_INHERIT	 0x0080	/* region is retained after exec */
73 #define	MAP_NOEXTEND	 0x0100	/* for MAP_FILE, don't change file size */
74 #define	MAP_HASSEMAPHORE 0x0200	/* region may contain semaphores */
75 #define	MAP_STACK	 0x0400	/* region grows down, like a stack */
76 #define	MAP_NOSYNC	 0x0800 /* page to but do not sync underlying file */
77 
78 /*
79  * Extended flags
80  */
81 #define	MAP_NOCORE	 0x00020000 /* dont include these pages in a coredump */
82 
83 #ifdef _P1003_1B_VISIBLE
84 /*
85  * Process memory locking
86  */
87 #define MCL_CURRENT	0x0001	/* Lock only current memory */
88 #define MCL_FUTURE	0x0002	/* Lock all future memory as well */
89 
90 #endif /* _P1003_1B_VISIBLE */
91 
92 /*
93  * Error return from mmap()
94  */
95 #define MAP_FAILED	((void *)-1)
96 
97 /*
98  * msync() flags
99  */
100 #define	MS_SYNC		0x0000	/* msync synchronously */
101 #define MS_ASYNC	0x0001	/* return immediately */
102 #define MS_INVALIDATE	0x0002	/* invalidate all cached data */
103 
104 
105 /*
106  * Mapping type
107  */
108 #define	MAP_FILE	0x0000	/* map from file (default) */
109 #define	MAP_ANON	0x1000	/* allocated from memory, swap space */
110 
111 /*
112  * Advice to madvise
113  */
114 #define	MADV_NORMAL	0	/* no further special treatment */
115 #define	MADV_RANDOM	1	/* expect random page references */
116 #define	MADV_SEQUENTIAL	2	/* expect sequential page references */
117 #define	MADV_WILLNEED	3	/* will need these pages */
118 #define	MADV_DONTNEED	4	/* dont need these pages */
119 #define	MADV_FREE	5	/* dont need these pages, and junk contents */
120 #define	MADV_NOSYNC	6	/* try to avoid flushes to physical media */
121 #define	MADV_AUTOSYNC	7	/* revert to default flushing strategy */
122 #define	MADV_NOCORE	8	/* do not include these pages in a core file */
123 #define	MADV_CORE	9	/* revert to including pages in a core file */
124 
125 /*
126  * Return bits from mincore
127  */
128 #define	MINCORE_INCORE	 	 0x1 /* Page is incore */
129 #define	MINCORE_REFERENCED	 0x2 /* Page has been referenced by us */
130 #define	MINCORE_MODIFIED	 0x4 /* Page has been modified by us */
131 #define	MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
132 #define	MINCORE_MODIFIED_OTHER	0x10 /* Page has been modified */
133 
134 #ifndef _KERNEL
135 
136 #include <sys/cdefs.h>
137 
138 __BEGIN_DECLS
139 #ifdef _P1003_1B_VISIBLE
140 int	mlockall (int);
141 int	munlockall (void);
142 int	shm_open (const char *, int, mode_t);
143 int	shm_unlink (const char *);
144 #endif /* _P1003_1B_VISIBLE */
145 int	mlock (const void *, size_t);
146 #ifndef _MMAP_DECLARED
147 #define	_MMAP_DECLARED
148 void *	mmap (void *, size_t, int, int, int, off_t);
149 #endif
150 int	mprotect (const void *, size_t, int);
151 int	msync (void *, size_t, int);
152 int	munlock (const void *, size_t);
153 int	munmap (void *, size_t);
154 #ifndef _POSIX_SOURCE
155 int	madvise (void *, size_t, int);
156 int	mincore (const void *, size_t, char *);
157 int	minherit (void *, size_t, int);
158 #endif
159 __END_DECLS
160 
161 #endif /* !_KERNEL */
162 
163 #endif
164