usr/src/man/man3c/posix_memalign.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH POSIX_MEMALIGN 3C "Jul 14, 2008"
  47 .SH NAME
  48 posix_memalign \- aligned memory allocation
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <sys/mman.h>
  53
  54 \fBint\fR \fBposix_memalign\fR(\fBvoid **\fR\fImemptr\fR, \fBsize_t\fR \fIalignment\fR, \fBsize_t\fR \fIsize\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBposix_memalign()\fR function allocates size bytes aligned on a boundary
  61 specified by alignment, and returns a pointer to the allocated memory in
  62 \fImemptr\fR. The value of alignment must be a power of two multiple of
  63 \fBsizeof\fR(\fBvoid *\fR).
  64 .sp
  65 .LP
  66 Upon successful completion, the value pointed to by \fImemptr\fR will be a
  67 multiple of alignment.
  68 .sp
  69 .LP
  70 If the size of the space requested is 0, the value returned in \fImemptr\fR
  71 will be a null pointer.
  72 .sp
  73 .LP
  74 The \fBfree\fR(3C) function will deallocate memory that has previously been
  75 allocated by \fBposix_memalign()\fR.
  76 .SH RETURN VALUES
  77 .sp
  78 .LP
  79 Upon successful completion, \fBposix_memalign()\fR returns zero. Otherwise, an
  80 error number is returned to indicate the error.
  81 .SH ERRORS
  82 .sp
  83 .LP
  84 The \fBposix_memalign()\fR function will fail if:
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBEINVAL\fR\fR
  89 .ad
  90 .RS 10n
  91 The value of the alignment parameter is not a power of two multiple of
  92 \fBsizeof\fR(\fBvoid *\fR).
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBENOMEM\fR\fR
  99 .ad
 100 .RS 10n
 101 There is insufficient memory available with the requested alignment.
 102 .RE
 103
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109
 110 .sp
 111 .TS
 112 box;
 113 c | c
 114 l | l .
 115 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 116 _
 117 Interface Stability     Committed
 118 _
 119 MT-Level        MT-Safe
 120 _
 121 Standard        See \fBstandards\fR(5).
 122 .TE
 123
 124 .SH SEE ALSO
 125 .sp
 126 .LP
 127 \fBfree\fR(3C), \fBmalloc\fR(3C), \fBmemalign\fR(3C), \fBattributes\fR(5),
 128 \fBstandards\fR(5)