1/* Definitions for BSD-style memory management.
2   Copyright (C) 1994-2000, 2003, 2004, 2005 Free Software Foundation, Inc.
3   This file is part of the GNU C Library.
4
5   The GNU C Library is free software; you can redistribute it and/or
6   modify it under the terms of the GNU Lesser General Public
7   License as published by the Free Software Foundation; either
8   version 2.1 of the License, or (at your option) any later version.
9
10   The GNU C Library is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   Lesser General Public License for more details.
14
15   You should have received a copy of the GNU Lesser General Public
16   License along with the GNU C Library; if not, write to the Free
17   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18   02111-1307 USA.  */
19
20#ifndef	_SYS_MMAN_H
21#define	_SYS_MMAN_H	1
22
23#include <features.h>
24#include <bits/types.h>
25#define __need_size_t
26#include <stddef.h>
27
28#ifndef __off_t_defined
29# ifndef __USE_FILE_OFFSET64
30typedef __off_t off_t;
31# else
32typedef __off64_t off_t;
33# endif
34# define __off_t_defined
35#endif
36
37#ifndef __mode_t_defined
38typedef __mode_t mode_t;
39# define __mode_t_defined
40#endif
41
42#include <bits/mman.h>
43
44/* Return value of `mmap' in case of an error.  */
45#define MAP_FAILED	((void *) -1)
46
47__BEGIN_DECLS
48/* Map addresses starting near ADDR and extending for LEN bytes.  from
49   OFFSET into the file FD describes according to PROT and FLAGS.  If ADDR
50   is nonzero, it is the desired mapping address.  If the MAP_FIXED bit is
51   set in FLAGS, the mapping will be at ADDR exactly (which must be
52   page-aligned); otherwise the system chooses a convenient nearby address.
53   The return value is the actual mapping address chosen or MAP_FAILED
54   for errors (in which case `errno' is set).  A successful `mmap' call
55   deallocates any previous mapping for the affected region.  */
56
57#ifndef __USE_FILE_OFFSET64
58extern void *mmap (void *__addr, size_t __len, int __prot,
59		   int __flags, int __fd, __off_t __offset) __THROW;
60#else
61# ifdef __REDIRECT_NTH
62extern void * __REDIRECT_NTH (mmap,
63			      (void *__addr, size_t __len, int __prot,
64			       int __flags, int __fd, __off64_t __offset),
65			      mmap64);
66# else
67#  define mmap mmap64
68# endif
69#endif
70#ifdef __USE_LARGEFILE64
71extern void *mmap64 (void *__addr, size_t __len, int __prot,
72		     int __flags, int __fd, __off64_t __offset) __THROW;
73#endif
74
75/* Deallocate any mapping for the region starting at ADDR and extending LEN
76   bytes.  Returns 0 if successful, -1 for errors (and sets errno).  */
77extern int munmap (void *__addr, size_t __len) __THROW;
78
79/* Change the memory protection of the region starting at ADDR and
80   extending LEN bytes to PROT.  Returns 0 if successful, -1 for errors
81   (and sets errno).  */
82extern int mprotect (void *__addr, size_t __len, int __prot) __THROW;
83
84/* Synchronize the region starting at ADDR and extending LEN bytes with the
85   file it maps.  Filesystem operations on a file being mapped are
86   unpredictable before this is done.  Flags are from the MS_* set.
87
88   This function is a cancellation point and therefore not marked with
89   __THROW.  */
90extern int msync (void *__addr, size_t __len, int __flags);
91
92#ifdef __USE_BSD
93/* Advise the system about particular usage patterns the program follows
94   for the region starting at ADDR and extending LEN bytes.  */
95extern int madvise (void *__addr, size_t __len, int __advice) __THROW;
96#endif
97#ifdef __USE_XOPEN2K
98/* This is the POSIX name for this function.  */
99extern int posix_madvise (void *__addr, size_t __len, int __advice) __THROW;
100#endif
101
102/* Guarantee all whole pages mapped by the range [ADDR,ADDR+LEN) to
103   be memory resident.  */
104extern int mlock (__const void *__addr, size_t __len) __THROW;
105
106/* Unlock whole pages previously mapped by the range [ADDR,ADDR+LEN).  */
107extern int munlock (__const void *__addr, size_t __len) __THROW;
108
109/* Cause all currently mapped pages of the process to be memory resident
110   until unlocked by a call to the `munlockall', until the process exits,
111   or until the process calls `execve'.  */
112extern int mlockall (int __flags) __THROW;
113
114/* All currently mapped pages of the process' address space become
115   unlocked.  */
116extern int munlockall (void) __THROW;
117
118#ifdef __USE_MISC
119/* mincore returns the memory residency status of the pages in the
120   current process's address space specified by [start, start + len).
121   The status is returned in a vector of bytes.  The least significant
122   bit of each byte is 1 if the referenced page is in memory, otherwise
123   it is zero.  */
124extern int mincore (void *__start, size_t __len, unsigned char *__vec)
125     __THROW;
126#endif
127
128#ifdef __USE_GNU
129/* Remap pages mapped by the range [ADDR,ADDR+OLD_LEN) to new length
130   NEW_LEN.  If MREMAP_MAYMOVE is set in FLAGS the returned address
131   may differ from ADDR.  If MREMAP_FIXED is set in FLAGS the function
132   takes another paramter which is a fixed address at which the block
133   resides after a successful call.  */
134extern void *mremap (void *__addr, size_t __old_len, size_t __new_len,
135		     int __flags, ...) __THROW;
136
137/* Remap arbitrary pages of a shared backing store within an existing
138   VMA.  */
139extern int remap_file_pages (void *__start, size_t __size, int __prot,
140			     size_t __pgoff, int __flags) __THROW;
141#endif
142
143
144/* Open shared memory segment.  */
145extern int shm_open (__const char *__name, int __oflag, mode_t __mode);
146
147/* Remove shared memory segment.  */
148extern int shm_unlink (__const char *__name);
149
150__END_DECLS
151
152#endif	/* sys/mman.h */
153