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