.TH LIBSIMPLE_ENALIGNED_ALLOC 3 2018-11-03 libsimple
.SH NAME
libsimple_enaligned_alloc \- allocate memory with custom alignment or die
.SH SYNOPSIS
.nf
#include <libsimple.h>
static inline void *libsimple_enaligned_alloc(int \fIstatus\fP, size_t \fIalignment\fP, size_t \fIn\fP);
static inline void *libsimple_ealigned_alloc(size_t \fIalignment\fP, size_t \fIn\fP);
#ifndef enaligned_alloc
# define enaligned_alloc libsimple_enaligned_alloc
#endif
#ifndef ealigned_alloc
# define ealigned_alloc libsimple_ealigned_alloc
#endif
.fi
.PP
Link with
.IR \-lsimple .
.SH DESCRIPTION
The
.BR libsimple_enaligned_alloc ()
and
.BR libsimple_ealigned_alloc ()
functions allocate
.I n
uninitialised bytes to the heap and return a
pointer with an alignment of
.I alignment
bytes to the allocated memory. The function
.BR free (3)
shall be called with the returned pointer as
input when the allocated memory is no longer needed.
.PP
The
.BR libsimple_enaligned_alloc ()
and
.BR libsimple_ealigned_alloc ()
functions will terminate the process if the memory
cannot be allocated of if the user tries to allocate
0 bytes, by calling the
.BR libsimple_enprintf ()
and
.BR libsimple_eprintf ()
functions, respectively.
On failure, the process's exit value will be
.I status
if the
.BR libsimple_enaligned_alloc ()
function is used or
.IR libsimple_default_failure_exit (3)
if the
.BR libsimple_ealigned_alloc ()
function is used. Failure include,
.I alignment
not being a power of two, or
.I n
not being a multiple of
.IR alignment .
.PP
The
.BR libsimple_enaligned_alloc ()
and
.BR libsimple_ealigned_alloc ()
functions behaviour is unspecified if
.I n
is 0.
.SH RETURN VALUE
The
.BR libsimple_enaligned_alloc ()
and
.BR libsimple_ealigned_alloc ()
functions return a pointer to the allocated memory
upon success completion; otherwise the process is
terminated.
.SH ERRORS
The
.BR libsimple_enaligned_alloc ()
and
.BR libsimple_ealigned_alloc ()
functions will terminate the process on failure.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lb lb lb
l l l.
Interface Attribute Value
T{
.BR libsimple_enaligned_alloc (),
.br
.BR libsimple_ealigned_alloc ()
T} Thread safety MT-Safe
T{
.BR libsimple_enaligned_alloc (),
.br
.BR libsimple_ealigned_alloc ()
T} Async-signal safety AS-Safe
T{
.BR libsimple_enaligned_alloc (),
.br
.BR libsimple_ealigned_alloc ()
T} Async-cancel safety AC-Safe
.TE
.SH EXAMPLES
None.
.SH APPLICATION USAGE
None.
.SH RATIONALE
None.
.SH FUTURE DIRECTIONS
None.
.SH NOTES
None.
.SH BUGS
None.
.SH SEE ALSO
.BR libsimple_enmalloc (3),
.BR libsimple_mallocz (3),
.BR libsimple_vmallocn (3),
.BR libsimple_vmalloczn (3),
.BR libsimple_encalloc (3),
.BR libsimple_vcallocn (3),
.BR libsimple_enrealloc (3),
.BR libsimple_reallocarray (3),
.BR libsimple_vreallocn (3),
.BR libsimple_reallocf (3),
.BR libsimple_reallocarrayf (3),
.BR libsimple_vreallocfn (3),
.BR libsimple_aligned_realloc (3),
.BR libsimple_aligned_reallocarray (3),
.BR libsimple_aligned_vreallocn (3),
.BR libsimple_aligned_reallocf (3),
.BR libsimple_aligned_reallocarrayf (3),
.BR libsimple_aligned_vreallocfn (3),
.BR libsimple_memalign (3),
.BR libsimple_memalignz (3),
.BR libsimple_vmemalignn (3),
.BR libsimple_vmemalignzn (3),
.BR libsimple_enposix_memalign (3),
.BR libsimple_posix_memalignz (3),
.BR libsimple_vposix_memalignn (3),
.BR libsimple_vposix_memalignzn (3),
.BR libsimple_aligned_allocz (3),
.BR libsimple_valigned_allocn (3),
.BR libsimple_valigned_alloczn (3),
.BR libsimple_pvalloc (3),
.BR libsimple_pvallocz (3),
.BR libsimple_vpvallocn (3),
.BR libsimple_vpvalloczn (3),
.BR libsimple_valloc (3),
.BR libsimple_vallocz (3),
.BR libsimple_vvallocn (3),
.BR libsimple_vvalloczn (3),
.BR libsimple_vmemalloc (3),
.BR libsimple_varrayalloc (3),
.BR aligned_alloc (3)
