bsd/man/man2/munmap.2

   1 .\"     $NetBSD: munmap.2,v 1.5 1995/02/27 12:35:03 cgd Exp $
   2 .\"
   3 .\" Copyright (c) 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)munmap.2    8.2 (Berkeley) 4/15/94
  35 .\"
  36 .Dd April 15, 1994
  37 .Dt MUNMAP 2
  38 .Os
  39 .Sh NAME
  40 .Nm munmap
  41 .Nd remove a mapping
  42 .Sh SYNOPSIS
  43 .Fd #include <sys/types.h>
  44 .Fd #include <sys/mman.h>
  45 .Ft int
  46 .Fn munmap "caddr_t addr" "size_t len"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn munmap
  50 system call
  51 deletes the mappings for the specified address range,
  52 and causes further references to addresses within the range
  53 to generate invalid memory references.
  54 .Sh RETURN VALUES
  55 Upon successful completion,
  56 .Nm munmap
  57 returns zero.
  58 Otherwise, a value of -1 is returned and
  59 .Va errno
  60 is set to indicate the error.
  61 .Sh ERRORS
  62 .Fn Munmap
  63 will fail if:
  64 .Bl -tag -width Er
  65 .It Bq Er EINVAL
  66 The
  67 .Fa addr
  68 parameter was not page aligned, the
  69 .Fa len
  70 parameter was negative, or
  71 some part of the region being unmapped is not part of the currently
  72 valid address space.
  73 .Sh "SEE ALSO"
  74 .Xr getpagesize 3 ,
  75 .Xr msync 2 ,
  76 .Xr munmap 2 ,
  77 .Xr mprotect 2 ,
  78 .Xr madvise 2 ,
  79 .Xr mincore 2
  80 .Sh HISTORY
  81 The
  82 .Fn munmap
  83 function first appeared in 4.4BSD.