mman.h revision 82295
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: head/sys/sys/mman.h 82295 2001-08-24 19:48:07Z dillon $
35 */
36
37#ifndef _SYS_MMAN_H_
38#define _SYS_MMAN_H_
39
40#include <sys/_posix.h>
41
42/*
43 * Inheritance for minherit()
44 */
45#define INHERIT_SHARE	0
46#define INHERIT_COPY	1
47#define INHERIT_NONE	2
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#define	MAP_COPY	MAP_PRIVATE	/* Obsolete */
64
65/*
66 * Other flags
67 */
68#define	MAP_FIXED	 0x0010	/* map addr must be exactly as requested */
69#define	MAP_RENAME	 0x0020	/* Sun: rename private pages to file */
70#define	MAP_NORESERVE	 0x0040	/* Sun: don't reserve needed swap area */
71#define	MAP_RESERVED0080 0x0080	/* previously misimplemented MAP_INHERIT */
72#define	MAP_RESERVED0100 0x0100	/* previously unimplemented MAP_NOEXTEND */
73#define	MAP_HASSEMAPHORE 0x0200	/* region may contain semaphores */
74#define	MAP_STACK	 0x0400	/* region grows down, like a stack */
75#define	MAP_NOSYNC	 0x0800 /* page to but do not sync underlying file */
76
77/*
78 * Extended flags
79 */
80#define	MAP_NOCORE	 0x00020000 /* dont include these pages in a coredump */
81
82#ifdef _P1003_1B_VISIBLE
83/*
84 * Process memory locking
85 */
86#define MCL_CURRENT	0x0001	/* Lock only current memory */
87#define MCL_FUTURE	0x0002	/* Lock all future memory as well */
88
89#endif /* _P1003_1B_VISIBLE */
90
91/*
92 * Error return from mmap()
93 */
94#define MAP_FAILED	((void *)-1)
95
96/*
97 * msync() flags
98 */
99#define	MS_SYNC		0x0000	/* msync synchronously */
100#define MS_ASYNC	0x0001	/* return immediately */
101#define MS_INVALIDATE	0x0002	/* invalidate all cached data */
102
103
104/*
105 * Mapping type
106 */
107#define	MAP_FILE	0x0000	/* map from file (default) */
108#define	MAP_ANON	0x1000	/* allocated from memory, swap space */
109
110/*
111 * Advice to madvise
112 */
113#define	MADV_NORMAL	0	/* no further special treatment */
114#define	MADV_RANDOM	1	/* expect random page references */
115#define	MADV_SEQUENTIAL	2	/* expect sequential page references */
116#define	MADV_WILLNEED	3	/* will need these pages */
117#define	MADV_DONTNEED	4	/* dont need these pages */
118#define	MADV_FREE	5	/* dont need these pages, and junk contents */
119#define	MADV_NOSYNC	6	/* try to avoid flushes to physical media */
120#define	MADV_AUTOSYNC	7	/* revert to default flushing strategy */
121#define	MADV_NOCORE	8	/* do not include these pages in a core file */
122#define	MADV_CORE	9	/* revert to including pages in a core file */
123
124/*
125 * Return bits from mincore
126 */
127#define	MINCORE_INCORE	 	 0x1 /* Page is incore */
128#define	MINCORE_REFERENCED	 0x2 /* Page has been referenced by us */
129#define	MINCORE_MODIFIED	 0x4 /* Page has been modified by us */
130#define	MINCORE_REFERENCED_OTHER 0x8 /* Page has been referenced */
131#define	MINCORE_MODIFIED_OTHER	0x10 /* Page has been modified */
132
133#ifndef _KERNEL
134
135#include <sys/cdefs.h>
136
137__BEGIN_DECLS
138#ifdef _P1003_1B_VISIBLE
139int	mlockall __P((int));
140int	munlockall __P((void));
141int	shm_open __P((const char *, int, mode_t));
142int	shm_unlink __P((const char *));
143#endif /* _P1003_1B_VISIBLE */
144int	mlock __P((const void *, size_t));
145#ifndef _MMAP_DECLARED
146#define	_MMAP_DECLARED
147void *	mmap __P((void *, size_t, int, int, int, off_t));
148#endif
149int	mprotect __P((const void *, size_t, int));
150int	msync __P((void *, size_t, int));
151int	munlock __P((const void *, size_t));
152int	munmap __P((void *, size_t));
153#ifndef _POSIX_SOURCE
154int	madvise __P((void *, size_t, int));
155int	mincore __P((const void *, size_t, char *));
156int	minherit __P((void *, size_t, int));
157#endif
158__END_DECLS
159
160#endif /* !_KERNEL */
161
162#endif
163