lib/libc/valloc.3

   1 .\"     $OpenBSD: valloc.3,v 1.14 2013/06/05 03:39:22 tedu Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 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. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .Dd $Mdocdate: June 5 2013 $
  31 .Dt VALLOC 3
  32 .Os
  33 .Sh NAME
  34 .Nm valloc
  35 .Nd aligned memory allocation function
  36 .Sh SYNOPSIS
  37 .In unistd.h
  38 .Ft void *
  39 .Fn valloc "size_t size"
  40 .Sh DESCRIPTION
  41 .Pp
  42 The
  43 .Fn valloc
  44 function allocates
  45 .Fa size
  46 bytes aligned on a page boundary.
  47 It is implemented by calling
  48 .Xr malloc 3
  49 with a slightly larger request, saving the true beginning of the block
  50 allocated, and returning a properly aligned pointer.
  51 .Sh RETURN VALUES
  52 The
  53 .Fn valloc
  54 function returns
  55 a pointer to the allocated space if successful; otherwise a
  56 null pointer is returned.
  57 .Sh SEE ALSO
  58 .Xr malloc 3
  59 .Sh HISTORY
  60 The
  61 .Fn valloc
  62 function appeared in
  63 .Bx 3.0 .
  64 .Sh BUGS
  65 A
  66 .Fn vfree
  67 function has not been implemented.