libcsupport/src/rtems_memalign.c

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  *  @file
0005  *
0006  *  @brief RTEMS Variation on Aligned Memory Allocation
0007  *  @ingroup MallocSupport
0008  */
0009
0010 /*
0011  *  COPYRIGHT (c) 1989-2008.
0012  *  On-Line Applications Research Corporation (OAR).
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #ifdef HAVE_CONFIG_H
0037 #include "config.h"
0038 #endif
0039
0040 #ifdef RTEMS_NEWLIB
0041 #include "malloc_p.h"
0042
0043 #include <stdlib.h>
0044 #include <errno.h>
0045
0046 int rtems_memalign(
0047   void   **pointer,
0048   size_t   alignment,
0049   size_t   size
0050 )
0051 {
0052   void *return_this;
0053
0054   /*
0055    *  Parameter error checks
0056    */
0057   if ( !pointer )
0058     return EINVAL;
0059
0060   *pointer = NULL;
0061
0062   if ( size == 0 ) {
0063     return 0;
0064   }
0065
0066   /*
0067    *  Perform the aligned allocation requested
0068    */
0069   return_this = rtems_heap_allocate_aligned_with_boundary( size, alignment, 0 );
0070   if ( !return_this )
0071     return ENOMEM;
0072
0073   *pointer = return_this;
0074   return 0;
0075 }
0076 #endif