summaryrefslogtreecommitdiff
path: root/usr/src/man/man3c/aligned_alloc.3c
diff options
context:
space:
mode:
authorJerry Jelinek <jerry.jelinek@joyent.com>2016-05-20 11:11:36 +0000
committerJerry Jelinek <jerry.jelinek@joyent.com>2016-05-20 11:11:36 +0000
commitb22cc2b5e082fb850f02e032a81cf11561262b95 (patch)
tree2ac128535e6eff2fa208c6b703dfb5282ddefa3c /usr/src/man/man3c/aligned_alloc.3c
parentdea7bb8f6a5a7494442b7d496b73ccf6995cd15c (diff)
parent7dc9a163b382daee1ce43b6588dd1b507363dae5 (diff)
downloadillumos-joyent-b22cc2b5e082fb850f02e032a81cf11561262b95.tar.gz
[illumos-gate merge]
commit 7dc9a163b382daee1ce43b6588dd1b507363dae5 6790 want suite of endian(3C) functions commit e56998eefc33ead0f12b364be915dd6bfc12a3f5 6501 Implement pthread_attr_get_np() interface commit fc2512cfb727d49529d8ed99164db871f4829b73 6951 Initial c11 support 6952 gets should not be visible in C11 6953 add support for c11 threads api 6954 Symbols test should support validating pre-processor symbols commit ea4a67f462de0a39a9adea8197bcdef849de5371 6980 6902 causes zfs send to break due to 32-bit/64-bit struct mismatch Conflicts: usr/src/test/libc-tests/tests/Makefile usr/src/test/libc-tests/runfiles/default.run usr/src/lib/libcmdutils/libcmdutils.h usr/src/lib/libcmdutils/common/custr.c usr/src/lib/libcmdutils/common/mapfile-vers
Diffstat (limited to 'usr/src/man/man3c/aligned_alloc.3c')
-rw-r--r--usr/src/man/man3c/aligned_alloc.3c74
1 files changed, 74 insertions, 0 deletions
diff --git a/usr/src/man/man3c/aligned_alloc.3c b/usr/src/man/man3c/aligned_alloc.3c
new file mode 100644
index 0000000000..d3c6f43c32
--- /dev/null
+++ b/usr/src/man/man3c/aligned_alloc.3c
@@ -0,0 +1,74 @@
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source. A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright 2016 Joyent, Inc.
+.\"
+.Dd "Mar 26, 2016"
+.Dt ALIGNED_ALLOC 3C
+.Os
+.Sh NAME
+.Nm aligned_alloc
+.Nd aligned memory allocation
+.Sh SYNOPSIS
+.In stdlib.h
+.Ft "void *"
+.Fo aligned_alloc
+.Fa "size_t alignment"
+.Fa "size_t size"
+.Fc
+.Sh DESCRIPTION
+The
+.Fn aligned_alloc
+function allocates
+.Fa size
+bytes aligned on the specified alignment boundary
+.Fa alignment .
+The value of
+.Fa alignment
+is constrained, it must be a power of two and it must be greater than or
+equal to the size of a word on the platform.
+.Sh RETURN VALUES
+Upon successful completion, the
+.Fn aligned_alloc
+function returns a pointer to suitably aligned memory at least
+.Fa size
+bytes large. Otherwise, a
+.Sy NULL
+pointer is returned and
+.Sy errno
+is set to indicate the error.
+.Sh ERRORS
+The
+.Fn aligned_alloc
+function will fail if:
+.Bl -tag -width Er
+.It Er ENOMEM
+The physical limits of the system are exceeded by
+.Fa size
+bytes of memory which cannot be allocated.
+.It Er EAGAIN
+There is not enough memory available to allocate
+.Fa size
+bytes of memory; but the application could try again later.
+.It Er EINVAL
+An invalid value for
+.Fa alignment
+was passed in. It is not a power of two multiple of the word size.
+.El
+.Sh INTERFACE STABILITY
+.Sy STANDARD
+.Sh MT-LEVEL
+.Sy MT-Safe
+.Sh SEE ALSO
+.Xr malloc 3C ,
+.Xr memalgin 3C ,
+.Xr posix_memalign 3C ,
+.Xr attributes 5