lib/libc/gen/valloc.3

   1 .\"     $NetBSD: valloc.3,v 1.11 2003/04/16 13:34:40 wiz 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 .\"     @(#)valloc.3    8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt VALLOC 3
  34 .Os
  35 .Sh NAME
  36 .Nm valloc
  37 .Nd aligned memory allocation function
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In stdlib.h
  42 .Ft void *
  43 .Fn valloc "size_t size"
  44 .Sh DESCRIPTION
  45 .Bf -symbolic
  46 Valloc is obsoleted by the current version of
  47 .Xr malloc 3 ,
  48 which aligns page-sized and larger allocations.
  49 .Ef
  50 .Pp
  51 The
  52 .Fn valloc
  53 function
  54 allocates
  55 .Fa size
  56 bytes aligned on a page boundary.
  57 It is implemented by calling
  58 .Xr malloc 3
  59 with a slightly larger request, saving the true beginning of the block
  60 allocated, and returning a properly aligned pointer.
  61 .Sh RETURN VALUES
  62 The
  63 .Fn valloc
  64 function returns
  65 a pointer to the allocated space if successful; otherwise
  66 a null pointer is returned
  67 .Sh HISTORY
  68 The
  69 .Fn valloc
  70 function appeared in
  71 .Bx 3.0 .
  72 .Sh BUGS
  73 A
  74 .Em vfree
  75 function has not been implemented.