diff options
Diffstat (limited to 'man3/libsimple_aligned_memdup.3')
| -rw-r--r-- | man3/libsimple_aligned_memdup.3 | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/man3/libsimple_aligned_memdup.3 b/man3/libsimple_aligned_memdup.3 new file mode 100644 index 0000000..6cd287a --- /dev/null +++ b/man3/libsimple_aligned_memdup.3 @@ -0,0 +1,152 @@ +.TH LIBSIMPLE_ALIGNED_MEMDUP 3 2018-10-27 libsimple +.SH NAME +libsimple_aligned_memdup, libsimple_aligned_memdupa \- duplicate bytes in memory +.SH SYNOPSIS +.nf +#include <libsimple.h> + +void *libsimple_aligned_memdupa(const void *\fIs\fP, size_t \fIalignment\fP, size_t \fIn\fP); +void *libsimple_aligned_memdup(const void *\fIs\fP, size_t \fIalignment\fP, size_t \fIn\fP); +void *libsimple_enaligned_memdup(int \fIstatus\fP, const void *\fIs\fP, size_t \fIalignment\fP, size_t \fIn\fP); +static inline void *libsimple_ealigned_memdup(const void *\fIs\fP, size_t \fIalignment\fP, size_t \fIn\fP); + +#ifndef aligned_memdupa +# define aligned_memdupa libsimple_aligned_memdupa +#endif +#ifndef aligned_memdup +# define aligned_memdup libsimple_aligned_memdup +#endif +#ifndef enaligned_memdup +# define enaligned_memdup libsimple_enaligned_memdup +#endif +#ifndef ealigned_memdup +# define ealigned_memdup libsimple_ealigned_memdup +#endif +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_aligned_memdup () +function constructs allocates memory with the alignment +specified in the +.I alignment +parameter and copies +.I n +first bytes from +.I s +into the new allocation. +.PP +The +.BR libsimple_enaligned_memdup () +and +.BR libsimple_ealigned_memdup () +functions are versions of the +.BR libsimple_aligned_memdup () +function that call the +.BR libsimple_enprintf (3) +function on failure, causing the process to print +an error message and exit. See +.BR libsimple_enprintf (3) +for more information. +.PP +The +.BR libsimple_memdupa () +function is implemented as a macro and is a version +of the +.BR libsimple_memdup () +function that uses allocates the memory on the stack +rather than on the heap, causing the return pointer +to become invalid when the calling function returns. +It is only available when compling with GCC or Clang. +.SH RETURN VALUE +Upon successful completion, the +.BR libsimple_aligned_memdupa (), +.BR libsimple_aligned_memdup (), +.BR libsimple_enaligned_memdup (), +and +.BR libsimple_ealigned_memdup () +functions return a non-null pointer, on failure the +.BR libsimple_aligned_memdup () +function returns +.B NULL +and set +.I errno +to indicate the error, and the +.BR libsimple_enaligned_memdup (), +and +.BR libsimple_ealigned_memdup () +functions exit the process. The +.BR libsimple_aligned_memdupa () +function cannot fail, however the kernel +can kill the thread, and possibly the process, with a +.B SIGSEGV +signal if the memory cannot be allocated. +.PP +The returned pointer should be deallocated when it +is no longer needed, except for the pointer returned +by the +.BR libsimple_aligned_memdupa () +function, it is automatically deallocated when the +calling function returns. +.SH ERRORS +The +.BR libsimple_aligned_memdup () +function may fail for any reason specified for the +.BR aligned_alloc (3) +function. +.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_aligned_memdupa (), +.br +.BR libsimple_aligned_memdup (), +.br +.BR libsimple_enaligned_memdup (), +.br +.BR libsimple_ealigned_memdup (), +T} Thread safety MT-Safe +T{ +.BR libsimple_aligned_memdupa (), +.br +.BR libsimple_aligned_memdup (), +.br +.BR libsimple_enaligned_memdup (), +.br +.BR libsimple_ealigned_memdup (), +T} Async-signal safety AS-Safe +T{ +.BR libsimple_aligned_memdupa (), +.br +.BR libsimple_aligned_memdup (), +.br +.BR libsimple_enaligned_memdup (), +.br +.BR libsimple_ealigned_memdup (), +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_memdup (3), +.BR libsimple_enstrndup (3), +.BR libsimple_enstrdup (3), +.BR strndup (3), +.BR strdup (3) |