Linux specific, but platform independent headers.
[kopensolaris-gnu/glibc.git] / sysdeps / unix / sysv / linux / sys / mman.h
1 /* Definitions for BSD-style memory management.  Linux version.
2 Copyright (C) 1994, 1995 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 Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 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 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB.  If
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, USA.  */
19
20 /* These are the bits used by 4.4 BSD and its derivatives.  On systems
21    (such as GNU) where these facilities are not system services but can be
22    emulated in the C library, these are the definitions we emulate.  */
23
24 #ifndef _SYS_MMAN_H
25
26 #define _SYS_MMAN_H     1
27 #include <features.h>
28
29 #include <gnu/types.h>
30 #define __need_size_t
31 #include <stddef.h>
32
33
34 /* Protections are chosen from these bits, OR'd together.  The
35    implementation does not necessarily support PROT_EXEC or PROT_WRITE
36    without PROT_READ.  The only guarantees are that no writing will be
37    allowed without PROT_WRITE and no access will be allowed for PROT_NONE. */
38
39 #define PROT_NONE       0x00    /* No access.  */
40 #define PROT_READ       0x01    /* Pages can be read.  */
41 #define PROT_WRITE      0x02    /* Pages can be written.  */
42 #define PROT_EXEC       0x04    /* Pages can be executed.  */
43
44
45 /* Flags contain mapping type, sharing type and options.  */
46
47 /* Mapping type (must choose one and only one of these).  */
48 #define MAP_FILE        0x0000  /* Mapped from a file or device.  */
49 #define MAP_ANON        0x0020  /* Allocated from anonymous virtual memory.  */
50 #define MAP_TYPE        0x000f  /* Mask for type field.  */
51
52 /* Sharing types (must choose one and only one of these).  */
53 #define MAP_COPY        MAP_PRIVATE     /* Virtual copy of region at mapping time.  */
54 #define MAP_SHARED      0x0001  /* Share changes.  */
55 #define MAP_PRIVATE     0x0002  /* Changes private; copy pages on write.  */
56
57 /* Other flags.  */
58 #define MAP_FIXED       0x0010  /* Map address must be exactly as requested. */
59 #define MAP_NOEXTEND    0x0000  /* For MAP_FILE, don't change file size.
60                                    Not available on Linux???  */
61 #define MAP_HASSEMPHORE 0x0000  /* Region may contain semaphores.
62                                    Not available on Linux???  */
63 #define MAP_INHERIT     0x0000  /* Region is retained after exec.
64                                    Not available on Linux???  */
65
66 /* Advice to `madvise'.  */
67 #define MADV_NORMAL     0       /* No further special treatment.  */
68 #define MADV_RANDOM     1       /* Expect random page references.  */
69 #define MADV_SEQUENTIAL 2       /* Expect sequential page references.  */
70 #define MADV_WILLNEED   3       /* Will need these pages.  */
71 #define MADV_DONTNEED   4       /* Don't need these pages.  */
72
73 #include <sys/cdefs.h>
74
75 __BEGIN_DECLS
76 /* Map addresses starting near ADDR and extending for LEN bytes.  from
77    OFFSET into the file FD describes according to PROT and FLAGS.  If ADDR
78    is nonzero, it is the desired mapping address.  If the MAP_FIXED bit is
79    set in FLAGS, the mapping will be at ADDR exactly (which must be
80    page-aligned); otherwise the system chooses a convenient nearby address.
81    The return value is the actual mapping address chosen or (caddr_t) -1
82    for errors (in which case `errno' is set).  A successful `mmap' call
83    deallocates any previous mapping for the affected region.  */
84
85 __caddr_t __mmap __P ((__caddr_t __addr, size_t __len,
86                        int __prot, int __flags, int __fd, __off_t __offset));
87 __caddr_t mmap __P ((__caddr_t __addr, size_t __len,
88                      int __prot, int __flags, int __fd, __off_t __offset));
89
90 /* Deallocate any mapping for the region starting at ADDR and extending LEN
91    bytes.  Returns 0 if successful, -1 for errors (and sets errno).  */
92 int __munmap __P ((__caddr_t __addr, size_t __len));
93 int munmap __P ((__caddr_t __addr, size_t __len));
94
95 /* Change the memory protection of the region starting at ADDR and
96    extending LEN bytes to PROT.  Returns 0 if successful, -1 for errors
97    (and sets errno).  */
98 int mprotect __P ((__caddr_t __addr, size_t __len, int __prot));
99
100 /* Synchronize the region starting at ADDR and extending LEN bytes with the
101    file it maps.  Filesystem operations on a file being mapped are
102    unpredictable before this is done.  */
103 int msync __P ((__caddr_t __addr, size_t __len));
104
105 /* Advise the system about particular usage patterns the program follows
106    for the region starting at ADDR and extending LEN bytes.  */
107 int madvise __P ((__caddr_t __addr, size_t __len, int __advice));
108
109 __END_DECLS
110
111
112 #endif  /* sys/mman.h */