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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd October 30, 2007
  29 .Dt VALLOC 3
  30 .Os
  31 .Sh NAME
  32 .Nm valloc
  33 .Nd aligned memory allocation function
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In unistd.h
  38 .Ft void *
  39 .Fn valloc "size_t size"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn valloc
  43 function is obsoleted by
  44 .Xr posix_memalign 3 ,
  45 which can be used to request page-aligned allocations.
  46 .Pp
  47 The
  48 .Fn valloc
  49 function
  50 allocates
  51 .Fa size
  52 bytes aligned on a page boundary.
  53 .Sh RETURN VALUES
  54 The
  55 .Fn valloc
  56 function returns
  57 a pointer to the allocated space if successful; otherwise
  58 a null pointer is returned.
  59 .Sh SEE ALSO
  60 .Xr posix_memalign 3
  61 .Sh HISTORY
  62 The
  63 .Fn valloc
  64 function appeared in
  65 .Bx 3.0 .
  66 .Pp
  67 The
  68 .Fn valloc
  69 function correctly allocated memory that could be deallocated via
  70 .Fn free
  71 starting in
  72 .Fx 7.0 .