lib/libc/stdlib/posix_memalign.3

   1 .\" Copyright (C) 2006 Jason Evans <jasone@FreeBSD.org>.
   2 .\" 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(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd January 11, 2006
  31 .Dt POSIX_MEMALIGN 3
  32 .Os
  33 .Sh NAME
  34 .Nm posix_memalign
  35 .Nd aligned memory allocation
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In stdlib.h
  40 .Ft int
  41 .Fn posix_memalign "void **ptr" "size_t alignment" "size_t size"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn posix_memalign
  45 function allocates
  46 .Fa size
  47 bytes of memory such that the allocation's base address is an even multiple of
  48 .Fa alignment ,
  49 and returns the allocation in the value pointed to by
  50 .Fa ptr .
  51 .Pp
  52 The requested
  53 .Fa alignment
  54 must be a power of 2 at least as large as sizeof(void *).
  55 .Pp
  56 Memory that is allocated via
  57 .Fn posix_memalign
  58 can be used as an argument in subsequent calls to
  59 .Xr realloc 3 ,
  60 .Xr reallocf 3 ,
  61 and
  62 .Xr free 3 .
  63 .Sh RETURN VALUES
  64 The
  65 .Fn posix_memalign
  66 function returns the value 0 if successful; otherwise it returns an error value.
  67 .Sh ERRORS
  68 The
  69 .Fn posix_memalign
  70 function will fail if:
  71 .Bl -tag -width Er
  72 .It Bq Er EINVAL
  73 The
  74 .Fa alignment
  75 parameter is not a power of 2 at least as large as sizeof(void *).
  76 .It Bq Er ENOMEM
  77 Memory allocation error.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr malloc 3 ,
  81 .Xr valloc 3 ,
  82 .Xr realloc 3 ,
  83 .Xr reallocf 3 ,
  84 .Xr free 3
  85 .Sh STANDARDS
  86 The
  87 .Fn posix_memalign
  88 function conforms to
  89 .St -p1003.1-2001 .