.TH LIBSIMPLE_VPOSIX_MEMALIGNZN 3 libsimple
.SH NAME
libsimple_vposix_memalignzn \- allocate optionally initialised memory with custom alignment
.SH SYNOPSIS
.nf
#include <libsimple.h>
int libsimple_vposix_memalignzn(void **\fImemptr\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, va_list \fIap\fP);
void libsimple_envposix_memalignzn(int \fIstatus\fP, void **\fImemptr\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, va_list \fIap\fP);
inline void libsimple_evposix_memalignzn(void **\fImemptr\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, va_list \fIap\fP);
inline int libsimple_posix_memalignzn(void **\fImemptr\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, ..., /* (size_t)0 */);
inline void libsimple_enposix_memalignzn(int \fIstatus\fP, void **\fImemptr\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, ..., /* (size_t)0 */);
inline int libsimple_eposix_memalignzn(void **\fImemptr\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP, ..., /* (size_t)0 */);
#ifndef vposix_memalignzn
# define vposix_memalignzn libsimple_vposix_memalignzn
#endif
#ifndef envposix_memalignzn
# define envposix_memalignzn libsimple_envposix_memalignzn
#endif
#ifndef evposix_memalignzn
# define evposix_memalignzn libsimple_evposix_memalignzn
#endif
#ifndef posix_memalignzn
# define posix_memalignzn libsimple_posix_memalignzn
#endif
#ifndef enposix_memalignzn
# define enposix_memalignzn libsimple_enposix_memalignzn
#endif
#ifndef eposix_memalignzn
# define eposix_memalignzn libsimple_eposix_memalignzn
#endif
.fi
.PP
Link with
.IR \-lsimple .
.SH DESCRIPTION
The
.BR libsimple_posix_memalignzn (),
.BR libsimple_enposix_memalignzn (),
and
.BR libsimple_eposix_memalignzn ()
functions allocate
.I N
bytes to the heap and store a pointer with an
alignment of
.I alignment
bytes to the allocated memory in
.IR memptr ,
where
.I N
is the product of
.I n
and all following arguments (which should have the type
.BR size_t )
up to the first 0;
.I n
must not be 0. The memory will be initialised
with zeroes if
.I clear
is a non-zero value. The function
.BR free (3)
shall be called with the pointer stored in
.I memptr
as input when the allocated memory is no longer needed.
.I *memptr
remains unmodified on failure.
.PP
The
.BR libsimple_enposix_memalignzn ()
and
.BR libsimple_eposix_memalignzn ()
functions will terminate the process if the memory
cannot be allocated, 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_enposix_memalignzn ()
function is used or
.IR libsimple_default_failure_exit (3)
if the
.BR libsimple_eposix_memalignzn ()
function is used.
.PP
The
.BR libsimple_vposix_memalignzn (),
.BR libsimple_envposix_memalignzn (),
and
.BR libsimple_evposix_memalignzn ()
functions are versions of the
.BR libsimple_posix_memalignzn (),
.BR libsimple_enposix_memalignzn (),
and
.BR libsimple_eposix_memalignzn (),
respectively, that use
.B va_list
instead of variadic arguments.
.SH RETURN VALUE
The
.BR libsimple_vposix_memalignzn ()
and
.BR libsimple_posix_memalignzn ()
functions return 0 upon successful completion;
otherwise an error code is returned to indicate
the error.
.PP
The
.BR libsimple_envposix_memalignzn (),
.BR libsimple_evposix_memalignzn (),
.BR libsimple_enposix_memalignzn (),
and
.BR libsimple_eposix_memalignzn ()
functions do not return a value, but
terminated the process on failure.
.SH ERRORS
The
.BR libsimple_vposix_memalignzn (),
.BR libsimple_posix_memalignzn ()
function will fail if:
.TP
.B EINVAL
.I n
is 0.
.TP
.B EINVAL
.I alignment
is not a power of two.
.TP
.B EINVAL
.I alignment
is not a multiple of
.IR "sizeof(void *)" .
.TP
.B ENOMEM
Enough memory could not be allocated.
.PP
The
.BR libsimple_envposix_memalignzn (),
.BR libsimple_evposix_memalignzn (),
.BR libsimple_enposix_memalignzn (),
and
.BR libsimple_eposix_memalignzn ()
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_vposix_memalignzn (),
.br
.BR libsimple_envposix_memalignzn (),
.br
.BR libsimple_evposix_memalignzn (),
.br
.BR libsimple_posix_memalignzn (),
.br
.BR libsimple_enposix_memalignzn (),
.br
.BR libsimple_eposix_memalignzn ()
T} Thread safety MT-Safe
T{
.BR libsimple_vposix_memalignzn (),
.br
.BR libsimple_envposix_memalignzn (),
.br
.BR libsimple_evposix_memalignzn (),
.br
.BR libsimple_posix_memalignzn (),
.br
.BR libsimple_enposix_memalignzn (),
.br
.BR libsimple_eposix_memalignzn ()
T} Async-signal safety AS-Safe
T{
.BR libsimple_vposix_memalignzn (),
.br
.BR libsimple_envposix_memalignzn (),
.br
.BR libsimple_evposix_memalignzn (),
.br
.BR libsimple_posix_memalignzn (),
.br
.BR libsimple_enposix_memalignzn (),
.br
.BR libsimple_eposix_memalignzn ()
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 HISTORY
libsimple 1.1
.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_enaligned_alloc (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 posix_memalign (3)
