lib/libc/sys/mremap.2

   1 .\"     $NetBSD: mremap.2,v 1.3 2008/02/16 17:45:39 tnn Exp $
   2 .\"
   3 .\" Copyright (c) 2007 Thomas Klausner and Joerg Sonnenberger
   4 .\" 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 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" ------------------------------------------------------------
  28 .Dd February 14, 2008
  29 .Dt MREMAP 2
  30 .Os
  31 .Sh NAME
  32 .Nm mremap
  33 .Nd re-map a virtual memory address
  34 .\" ------------------------------------------------------------
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In sys/mman.h
  39 .Ft void *
  40 .Fn mremap "void *oldp" "size_t oldsize" "void *newp" "size_t newsize" \
  41 "int flags"
  42 .\" ------------------------------------------------------------
  43 .Sh DESCRIPTION
  44 The
  45 .Fn mremap
  46 function resizes the mapped range (see
  47 .Xr mmap 2 )
  48 starting at
  49 .Ar oldp
  50 and having size
  51 .Ar oldsize
  52 to
  53 .Ar newsize .
  54 The following arguments can be
  55 .Dv OR Ap ed
  56 together in the
  57 .Ar flags
  58 argument:
  59 .Bl -tag -width XXMAPXALIGNEDXnXX
  60 .It Dv MAP_ALIGNED Ns Pq Ar n
  61 The allocation should be aligned to the given boundary, i.e. ensure
  62 that the lowest
  63 .Ar n
  64 bits of the address are zero.
  65 The parameter
  66 .Ar n
  67 should be the base 2 logarithm of the desired alignment (e.g., to
  68 request alignment to 16K, use 14 as the value for n).
  69 The alignment must be equal to or greater than the platform's page
  70 size as returned by
  71 .Xr sysconf 3
  72 with the
  73 .Dv _SC_PAGESIZE
  74 request.
  75 .It Dv MAP_FIXED
  76 .Ar newp
  77 is tried and
  78 .Fn mremap
  79 fails if that address can't be used as new base address for the range.
  80 Otherwise,
  81 .Ar oldp
  82 and
  83 .Ar newp
  84 are used as hints for the position, factoring in the given alignment.
  85 .El
  86 .Sh RETURN VALUES
  87 .Fn mremap
  88 returns the new address or
  89 .Dv MAP_FAILED ,
  90 if the remap failed.
  91 .Sh HISTORY
  92 The
  93 .Fn mremap
  94 system call appeared in
  95 .Nx 5.0 .
  96 It was based on the code that supports
  97 .Fn mremap
  98 compatibility for Linux binaries.
  99 .Sh COMPATIBILITY
 100 The semantics of
 101 .Fn mremap
 102 differ from the one provided by glibc on Linux in that the
 103 .Ar newp
 104 argument was added and a different set of
 105 .Ar flags
 106 are implemented.
 107 .Sh SEE ALSO
 108 .Xr mmap 2 ,
 109 .Xr munmap 2