lib/libc/gen/valloc.3

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)valloc.3    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt VALLOC 3
  37 .Os BSD 3
  38 .Sh NAME
  39 .Nm valloc
  40 .Nd aligned memory allocation function
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .Fd #include <unistd.h>
  45 .Ft void *
  46 .Fn valloc "size_t size"
  47 .Sh DESCRIPTION
  48 .Bf -symbolic
  49 Valloc is obsoleted by the current version of malloc(3),
  50 which aligns page-sized and larger allocations.
  51 .Ef
  52 .Pp
  53 The
  54 .Fn valloc
  55 function
  56 allocates
  57 .Fa size
  58 bytes aligned on a page boundary.
  59 It is implemented by calling
  60 .Xr malloc 3
  61 with a slightly larger request, saving the true beginning of the block
  62 allocated, and returning a properly aligned pointer.
  63 .Sh RETURN VALUES
  64 The
  65 .Fn valloc
  66 function returns
  67 a pointer to the allocated space if successful; otherwise
  68 a null pointer is returned
  69 .Sh HISTORY
  70 The
  71 .Fn valloc
  72 function appeared in
  73 .Bx 3.0 .
  74 .Sh BUGS
  75 A
  76 .Em vfree
  77 function
  78 has not been implemented.