1 /* Definitions for BSD-style memory management.
2 Copyright (C) 1994-2000, 2003, 2004 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
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.
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.
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
24 #include <bits/types.h>
28 #ifndef __off_t_defined
29 # ifndef __USE_FILE_OFFSET64
30 typedef __off_t off_t;
32 typedef __off64_t off_t;
34 # define __off_t_defined
37 #ifndef __mode_t_defined
38 typedef __mode_t mode_t;
39 # define __mode_t_defined
42 #include <bits/mman.h>
44 /* Return value of `mmap' in case of an error. */
45 #define MAP_FAILED ((void *) -1)
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. */
57 #ifndef __USE_FILE_OFFSET64
58 extern void *mmap (void *__addr, size_t __len, int __prot,
59 int __flags, int __fd, __off_t __offset) __THROW;
62 extern void * __REDIRECT (mmap,
63 (void *__addr, size_t __len, int __prot,
64 int __flags, int __fd, __off64_t __offset),
70 #ifdef __USE_LARGEFILE64
71 extern void *mmap64 (void *__addr, size_t __len, int __prot,
72 int __flags, int __fd, __off64_t __offset) __THROW;
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). */
77 extern int munmap (void *__addr, size_t __len) __THROW;
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
82 extern int mprotect (void *__addr, size_t __len, int __prot) __THROW;
84 #ifdef __ARCH_USE_MMU__
86 /* Synchronize the region starting at ADDR and extending LEN bytes with the
87 file it maps. Filesystem operations on a file being mapped are
88 unpredictable before this is done. Flags are from the MS_* set.
90 This function is a cancellation point and therefore not marked with
92 extern int msync (void *__addr, size_t __len, int __flags);
96 /* On no-mmu systems you can't have real private mappings. */
97 static __inline__ int msync (void *__addr, size_t __len, int __flags) { return 0; }
101 #if defined __USE_BSD && defined __UCLIBC_LINUX_SPECIFIC__
102 /* Advise the system about particular usage patterns the program follows
103 for the region starting at ADDR and extending LEN bytes. */
104 extern int madvise (void *__addr, size_t __len, int __advice) __THROW;
106 #if defined __USE_XOPEN2K && defined __UCLIBC_HAS_ADVANCED_REALTIME__
107 /* This is the POSIX name for this function. */
108 extern int posix_madvise (void *__addr, size_t __len, int __advice) __THROW;
111 #if defined __UCLIBC_HAS_REALTIME__
112 # ifdef __ARCH_USE_MMU__
114 /* Guarantee all whole pages mapped by the range [ADDR,ADDR+LEN) to
115 be memory resident. */
116 extern int mlock (__const void *__addr, size_t __len) __THROW;
118 /* Unlock whole pages previously mapped by the range [ADDR,ADDR+LEN). */
119 extern int munlock (__const void *__addr, size_t __len) __THROW;
121 /* Cause all currently mapped pages of the process to be memory resident
122 until unlocked by a call to the `munlockall', until the process exits,
123 or until the process calls `execve'. */
124 extern int mlockall (int __flags) __THROW;
126 /* All currently mapped pages of the process' address space become
128 extern int munlockall (void) __THROW;
132 /* On no-mmu systems, memory cannot be swapped out, so
133 * these functions will always succeed. */
134 static __inline__ int mlock (__const void *__addr, size_t __len) { return 0; }
135 static __inline__ int munlock (__const void *__addr, size_t __len) { return 0; }
136 static __inline__ int mlockall (int __flags) { return 0; }
137 static __inline__ int munlockall (void) { return 0; }
139 #endif /* __UCLIBC_HAS_REALTIME__ */
141 #if defined __USE_MISC && defined __UCLIBC_BSD_SPECIFIC__
142 /* mincore returns the memory residency status of the pages in the
143 current process's address space specified by [start, start + len).
144 The status is returned in a vector of bytes. The least significant
145 bit of each byte is 1 if the referenced page is in memory, otherwise
147 extern int mincore (void *__start, size_t __len, unsigned char *__vec)
152 /* Remap pages mapped by the range [ADDR,ADDR+OLD_LEN) to new length
153 NEW_LEN. If MREMAP_MAYMOVE is set in FLAGS the returned address
154 may differ from ADDR. If MREMAP_FIXED is set in FLAGS the function
155 takes another paramter which is a fixed address at which the block
156 resides after a successful call. */
157 extern void *mremap (void *__addr, size_t __old_len, size_t __new_len,
158 int __flags, ...) __THROW;
160 /* Remap arbitrary pages of a shared backing store within an existing
162 extern int remap_file_pages (void *__start, size_t __size, int __prot,
163 size_t __pgoff, int __flags) __THROW;
167 /* Open shared memory segment. */
168 extern int shm_open (__const char *__name, int __oflag, mode_t __mode);
170 /* Remove shared memory segment. */
171 extern int shm_unlink (__const char *__name);
175 #endif /* sys/mman.h */