<foo.h> -> <bits/foo.h>.
[kopensolaris-gnu/glibc.git] / sysdeps / unix / bsd / osf / sys / mman.h
1 /* Definitions for BSD-style memory management.  OSF/1 version.
2    Copyright (C) 1994, 1995, 1996 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 not,
17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18    Boston, MA 02111-1307, USA.  */
19
20 #ifndef _SYS_MMAN_H
21
22 #define _SYS_MMAN_H     1
23 #include <features.h>
24
25 #include <bits/types.h>
26 #define __need_size_t
27 #include <stddef.h>
28
29
30 /* Protections are chosen from these bits, OR'd together.  The
31    implementation does not necessarily support PROT_EXEC or PROT_WRITE
32    without PROT_READ.  The only guarantees are that no writing will be
33    allowed without PROT_WRITE and no access will be allowed for PROT_NONE. */
34
35 #define PROT_NONE       0x00    /* No access.  */
36 #define PROT_READ       0x01    /* Pages can be read.  */
37 #define PROT_WRITE      0x02    /* Pages can be written.  */
38 #define PROT_EXEC       0x04    /* Pages can be executed.  */
39
40
41 /* Flags contain mapping type, sharing type and options.  */
42
43 /* Mapping type (must choose one and only one of these).  */
44 #define MAP_FILE        0x00    /* Mapped from a file or device.  */
45 #define MAP_ANON        0x10    /* Allocated from anonymous virtual memory.  */
46 #define MAP_ANONYMOUS   MAP_ANON
47 #define MAP_TYPE        0xf0    /* Mask for type field.  */
48
49 /* Sharing types (must choose one and only one of these).  */
50 #define MAP_SHARED      0x01    /* Share changes.  */
51 #define MAP_PRIVATE     0x02    /* Changes private; copy pages on write.  */
52
53 /* Other flags.  */
54 #define MAP_FIXED       0x0100  /* Map address must be exactly as requested. */
55 #define MAP_VARIABLE    0       /* Absence of MAP_FIXED.  */
56 #define MAP_HASSEMPHORE 0x0200  /* Region may contain semaphores.  */
57 #define MAP_INHERIT     0x0400  /* Region is retained after exec.  */
58 #define MAP_UNALIGNED   0x0800  /* File offset need not be page-aligned.  */
59
60 /* Advice to `madvise'.  */
61 #define MADV_NORMAL     0       /* No further special treatment.  */
62 #define MADV_RANDOM     1       /* Expect random page references.  */
63 #define MADV_SEQUENTIAL 2       /* Expect sequential page references.  */
64 #define MADV_WILLNEED   3       /* Will need these pages.  */
65 #define MADV_DONTNEED   4       /* Don't need these pages.  */
66 #define MADV_SPACEAVAIL 5       /* Ensure that resources are available.  */
67
68 /* Flags to `msync'.  */
69 #define MS_ASYNC        1               /* Asynchronous cache flush.  */
70 #define MS_SYNC         3               /* Synchronous cache flush.  */
71 #define MS_INVALIDATE   4               /* Invalidate cached pages.  */
72
73
74 #include <sys/cdefs.h>
75
76 __BEGIN_DECLS
77 /* Map addresses starting near ADDR and extending for LEN bytes.  from
78    OFFSET into the file FD describes according to PROT and FLAGS.  If ADDR
79    is nonzero, it is the desired mapping address.  If the MAP_FIXED bit is
80    set in FLAGS, the mapping will be at ADDR exactly (which must be
81    page-aligned); otherwise the system chooses a convenient nearby address.
82    The return value is the actual mapping address chosen or (caddr_t) -1
83    for errors (in which case `errno' is set).  A successful `mmap' call
84    deallocates any previous mapping for the affected region.  */
85
86 __caddr_t __mmap __P ((__caddr_t __addr, size_t __len,
87                        int __prot, int __flags, int __fd, off_t __offset));
88 __caddr_t mmap __P ((__caddr_t __addr, size_t __len,
89                      int __prot, int __flags, int __fd, off_t __offset));
90
91 /* Deallocate any mapping for the region starting at ADDR and extending LEN
92    bytes.  Returns 0 if successful, -1 for errors (and sets errno).  */
93 int __munmap __P ((__caddr_t __addr, size_t __len));
94 int munmap __P ((__caddr_t __addr, size_t __len));
95
96 /* Change the memory protection of the region starting at ADDR and
97    extending LEN bytes to PROT.  Returns 0 if successful, -1 for errors
98    (and sets errno).  */
99 int __mprotect __P ((__caddr_t __addr, size_t __len, int __prot));
100 int mprotect __P ((__caddr_t __addr, size_t __len, int __prot));
101
102 /* Synchronize the region starting at ADDR and extending LEN bytes with the
103    file it maps.  Filesystem operations on a file being mapped are
104    unpredictable before this is done.  */
105 int msync __P ((__caddr_t __addr, size_t __len, int __flags));
106
107 /* Advise the system about particular usage patterns the program follows
108    for the region starting at ADDR and extending LEN bytes.  */
109 int madvise __P ((__caddr_t __addr, size_t __len, int __advice));
110
111 __END_DECLS
112
113
114 #endif  /* sys/mman.h */