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 .\" 4. 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 .\"     @(#)valloc.3    8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/gen/valloc.3,v 1.4.2.4 2001/12/14 18:33:51 ru Exp $
  30 .\" $DragonFly: src/lib/libc/gen/valloc.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  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 unistd.h
  42 .Ft void *
  43 .Fn valloc "size_t size"
  44 .Sh DESCRIPTION
  45 .Bf -symbolic
  46 The
  47 .Fn valloc
  48 function is obsoleted by the current version of
  49 .Xr 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.