sysdeps/unix/bsd/sun/sunos4/sys/mman.h

   1 /* Definitions for BSD-style memory management.  SunOS 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 /* The following three flags are not actually implemented in SunOS 4.1.  */
  51 #ifdef __USE_BSD
  52 # define MAP_RENAME     0x20    /* Rename private pages to file.  */
  53 # define MAP_NORESERVE  0x40    /* Don't reserve needed swap area.  */
  54 # define MAP_INHERIT    0x80    /* Region is retained after exec.  */
  55 #endif
  56
  57 /* This is an internal flag that is always set in `mmap' system calls.  In
  58    older versions of SunOS 4 `mmap' did not return the actual mapping
  59    address, but always returned zero.  This flag says to return the
  60    address; the `mmap' C library function always sets it.  */
  61 #define _MAP_NEW        0x80000000
  62
  63 /* Advice to `madvise'.  */
  64 #ifdef __USE_BSD
  65 # define MADV_NORMAL    0       /* No further special treatment.  */
  66 # define MADV_RANDOM    1       /* Expect random page references.  */
  67 # define MADV_SEQUENTIAL        2       /* Expect sequential page references.  */
  68 # define MADV_WILLNEED  3       /* Will need these pages.  */
  69 # define MADV_DONTNEED  4       /* Don't need these pages.  */
  70 #endif
  71
  72 /* Flags to `msync'.  */
  73 #define MS_ASYNC        0x1             /* Return immediately, don't fsync.  */
  74 #define MS_INVALIDATE   0x2             /* Invalidate caches.  */
  75
  76 /* Return value of `mmap' in case of an error.  */
  77 #define MAP_FAILED      ((__caddr_t) -1)
  78
  79
  80 __BEGIN_DECLS
  81 /* Map addresses starting near ADDR and extending for LEN bytes.  from
  82    OFFSET into the file FD describes according to PROT and FLAGS.  If ADDR
  83    is nonzero, it is the desired mapping address.  If the MAP_FIXED bit is
  84    set in FLAGS, the mapping will be at ADDR exactly (which must be
  85    page-aligned); otherwise the system chooses a convenient nearby address.
  86    The return value is the actual mapping address chosen or MAP_FAILED
  87    for errors (in which case `errno' is set).  A successful `mmap' call
  88    deallocates any previous mapping for the affected region.  */
  89
  90 extern __caddr_t __mmap __P ((__caddr_t __addr, size_t __len, int __prot,
  91                               int __flags, int __fd, __off_t __offset));
  92 extern __caddr_t mmap __P ((__caddr_t __addr, size_t __len, int __prot,
  93                             int __flags, int __fd, __off_t __offset));
  94
  95 /* Deallocate any mapping for the region starting at ADDR and extending LEN
  96    bytes.  Returns 0 if successful, -1 for errors (and sets errno).  */
  97 extern int __munmap __P ((__caddr_t __addr, size_t __len));
  98 extern int munmap __P ((__caddr_t __addr, size_t __len));
  99
 100 /* Change the memory protection of the region starting at ADDR and
 101    extending LEN bytes to PROT.  Returns 0 if successful, -1 for errors
 102    (and sets errno).  */
 103 extern int __mprotect __P ((__caddr_t __addr, size_t __len, int __prot));
 104 extern int mprotect __P ((__caddr_t __addr, size_t __len, int __prot));
 105
 106 /* Synchronize the region starting at ADDR and extending LEN bytes with the
 107    file it maps.  Filesystem operations on a file being mapped are
 108    unpredictable before this is done.  */
 109 extern int msync __P ((__caddr_t __addr, size_t __len, int __flags));
 110
 111 #ifdef __USE_BSD
 112 /* Advise the system about particular usage patterns the program follows
 113    for the region starting at ADDR and extending LEN bytes.  */
 114 extern int madvise __P ((__caddr_t __addr, size_t __len, int __advice));
 115 #endif
 116
 117 __END_DECLS
 118
 119
 120 #endif  /* sys/mman.h */