Test feature macros before defining non-POSIX things. Add MAP_FAILED.
[kopensolaris-gnu/glibc.git] / sysdeps / unix / bsd / ultrix4 / sys / mman.h
1 /* Definitions for BSD-style memory management.  Ultrix 4 version.
2    Copyright (C) 1994, 1995, 1996, 1997 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 /* Sharing types (must choose one and only one of these).  */
42 #define MAP_SHARED      0x01    /* Share changes.  */
43 #define MAP_PRIVATE     0x02    /* Changes private; copy pages on write.  */
44 #ifdef __USE_BSD
45 # define MAP_TYPE       0x0f    /* Mask for sharing type.  */
46 #endif
47
48 /* Other flags.  */
49 #define MAP_FIXED       0x10    /* Map address must be exactly as requested. */
50
51 /* Advice to `madvise'.  */
52 #ifdef __USE_BSD
53 # define MADV_NORMAL    0       /* No further special treatment.  */
54 # define MADV_RANDOM    1       /* Expect random page references.  */
55 # define MADV_SEQUENTIAL        2       /* Expect sequential page references.  */
56 # define MADV_WILLNEED  3       /* Will need these pages.  */
57 # define MADV_DONTNEED  4       /* Don't need these pages.  */
58 #endif
59
60 /* Return value of `mmap' in case of an error.  */
61 #define MAP_FAILED      ((__caddr_t) -1)
62
63
64 __BEGIN_DECLS
65 /* Map addresses starting near ADDR and extending for LEN bytes.  from
66    OFFSET into the file FD describes according to PROT and FLAGS.  If ADDR
67    is nonzero, it is the desired mapping address.  If the MAP_FIXED bit is
68    set in FLAGS, the mapping will be at ADDR exactly (which must be
69    page-aligned); otherwise the system chooses a convenient nearby address.
70    The return value is the actual mapping address chosen or MAP_FAILED
71    for errors (in which case `errno' is set).  A successful `mmap' call
72    deallocates any previous mapping for the affected region.  */
73
74 extern __caddr_t __mmap __P ((__caddr_t __addr, size_t __len, int __prot,
75                               int __flags, int __fd, off_t __offset));
76 extern __caddr_t mmap __P ((__caddr_t __addr, size_t __len, int __prot,
77                             int __flags, int __fd, off_t __offset));
78
79 /* Deallocate any mapping for the region starting at ADDR and extending LEN
80    bytes.  Returns 0 if successful, -1 for errors (and sets errno).  */
81 extern int __munmap __P ((__caddr_t __addr, size_t __len));
82 extern int munmap __P ((__caddr_t __addr, size_t __len));
83
84 /* Change the memory protection of the region starting at ADDR and
85    extending LEN bytes to PROT.  Returns 0 if successful, -1 for errors
86    (and sets errno).  */
87 extern int __mprotect __P ((__caddr_t __addr, size_t __len, int __prot));
88 extern int mprotect __P ((__caddr_t __addr, size_t __len, int __prot));
89
90 /* Ultrix 4 does not implement `msync' or `madvise'.  */
91
92 /* Synchronize the region starting at ADDR and extending LEN bytes with the
93    file it maps.  Filesystem operations on a file being mapped are
94    unpredictable before this is done.  */
95 extern int msync __P ((caddr_t __addr, size_t __len));
96
97 #ifdef __USE_BSD
98 /* Advise the system about particular usage patterns the program follows
99    for the region starting at ADDR and extending LEN bytes.  */
100 extern int madvise __P ((__caddr_t __addr, size_t __len, int __advice));
101 #endif
102
103 __END_DECLS
104
105
106 #endif  /* sys/mman.h */