POSIX_MEMALIGN(3)          POSIX Programmer's Manual         POSIX_MEMALIGN(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.


NNAAMMEE
       posix_memalign -- aligned memory allocation (AADDVVAANNCCEEDD RREEAALLTTIIMMEE)

SSYYNNOOPPSSIISS
       #include <stdlib.h>

       int posix_memalign(void **_m_e_m_p_t_r, size_t _a_l_i_g_n_m_e_n_t, size_t _s_i_z_e);

DDEESSCCRRIIPPTTIIOONN
       The _p_o_s_i_x___m_e_m_a_l_i_g_n() function shall allocate _s_i_z_e bytes aligned on a
       boundary specified by _a_l_i_g_n_m_e_n_t, and shall return a pointer to the
       allocated memory in _m_e_m_p_t_r.  The value of _a_l_i_g_n_m_e_n_t shall be a power of
       two multiple of _s_i_z_e_o_f(vvooiidd **).

       Upon successful completion, the value pointed to by _m_e_m_p_t_r shall be a
       multiple of _a_l_i_g_n_m_e_n_t.

       If the size of the space requested is 0, the behavior is
       implementation-defined; the value returned in _m_e_m_p_t_r shall be either a
       null pointer or a unique pointer.

       The _f_r_e_e() function shall deallocate memory that has previously been
       allocated by _p_o_s_i_x___m_e_m_a_l_i_g_n().

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _p_o_s_i_x___m_e_m_a_l_i_g_n() shall return zero;
       otherwise, an error number shall be returned to indicate the error.

EERRRROORRSS
       The _p_o_s_i_x___m_e_m_a_l_i_g_n() function shall fail if:

       EEIINNVVAALL The value of the alignment parameter is not a power of two
              multiple of _s_i_z_e_o_f(vvooiidd **).

       EENNOOMMEEMM There is insufficient memory available with the requested
              alignment.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       The _p_o_s_i_x___m_e_m_a_l_i_g_n() function is part of the Advisory Information
       option and need not be provided on all implementations.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _f_r_e_e(), _m_a_l_l_o_c()

       The Base Definitions volume of POSIX.1-2008, <<ssttddlliibb..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
       -- Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, Copyright (C) 2013 by the Institute of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is
       POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
       event of any discrepancy between this version and the original IEEE and
       The Open Group Standard, the original IEEE and The Open Group Standard
       is the referee document. The original Standard can be obtained online
       at http://www.unix.org/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2013                    POSIX_MEMALIGN(3)
