cds/os/libc/alloc_aligned.h

   1 /*
   2     This file is a part of libcds - Concurrent Data Structures library
   3
   4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
   5
   6     Source code repo: http://github.com/khizmax/libcds/
   7     Download: http://sourceforge.net/projects/libcds/files/
   8
   9     Redistribution and use in source and binary forms, with or without
  10     modification, are permitted provided that the following conditions are met:
  11
  12     * Redistributions of source code must retain the above copyright notice, this
  13       list of conditions and the following disclaimer.
  14
  15     * Redistributions in binary form must reproduce the above copyright notice,
  16       this list of conditions and the following disclaimer in the documentation
  17       and/or other materials provided with the distribution.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 */
  30
  31 #ifndef CDSLIB_OS_LIBC_ALLOC_ALIGNED_H
  32 #define CDSLIB_OS_LIBC_ALLOC_ALIGNED_H
  33
  34 #include <stdlib.h>
  35
  36 //@cond none
  37 namespace cds { namespace OS {
  38     CDS_CXX11_INLINE_NAMESPACE namespace libc {
  39         /// Allocates memory on a specified alignment boundary
  40         static inline void * aligned_malloc(
  41             size_t nSize,       ///< Size of the requested memory allocation
  42             size_t nAlignment   ///< The alignment value, which must be an integer power of 2
  43             )
  44         {
  45             return ::memalign( nAlignment, nSize );
  46         }
  47
  48         /// Frees a block of memory that was allocated with aligned_malloc.
  49         static inline void aligned_free(
  50             void * pBlock   ///< A pointer to the memory block that was returned to the aligned_malloc function
  51             )
  52         {
  53             ::free( pBlock );
  54         }
  55     }   // namespace libc
  56
  57 #ifndef CDS_CXX11_INLINE_NAMESPACE_SUPPORT
  58     using libc::aligned_malloc;
  59     using libc::aligned_free;
  60 #endif
  61
  62 }} // namespace cds::OS
  63 //@endcond
  64
  65 #endif // #ifndef CDSLIB_OS_LIBC_ALLOC_ALIGNED_H
  66