include/rtems/mallocinitmulti.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup MallocSupport
0007  *
0008  * @brief This header file provides the implementation of
0009  *   _Malloc_Initialize_for_multiple_areas().
0010  */
0011
0012 /*
0013  * Copyright (C) 2012, 2020 embedded brains GmbH & Co. KG
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_MALLOCINITMULTI_H
0038 #define _RTEMS_MALLOCINITMULTI_H
0039
0040 #include <rtems/malloc.h>
0041 #include <rtems/score/heapimpl.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif
0046
0047 /**
0048  * @ingroup MallocSupport
0049  *
0050  * @brief Initializes the separate C Program Heap with support for more than
0051  *   one memory area.
0052  *
0053  * This implementation should be used by BSPs which provide more than one
0054  * memory area via _Memory_Get() to implement
0055  * _Workspace_Malloc_initialize_separate().
0056  */
0057 static inline Heap_Control *_Malloc_Initialize_for_multiple_areas(
0058   Heap_Control *heap
0059 )
0060 {
0061   const Memory_Information              *mem;
0062   Heap_Initialization_or_extend_handler  init_or_extend;
0063   uintptr_t                              page_size;
0064   size_t                                 i;
0065
0066   mem = _Memory_Get();
0067   RTEMS_Malloc_Heap = heap;
0068   init_or_extend = _Heap_Initialize;
0069   page_size = CPU_HEAP_ALIGNMENT;
0070
0071   for (i = 0; i < _Memory_Get_count( mem ); ++i) {
0072     Memory_Area *area;
0073     uintptr_t    space_available;
0074
0075     area = _Memory_Get_area( mem, i );
0076     space_available = ( *init_or_extend )(
0077       heap,
0078       _Memory_Get_free_begin( area ),
0079       _Memory_Get_free_size( area ),
0080       page_size
0081     );
0082
0083     if ( space_available > 0 ) {
0084       _Memory_Consume( area, _Memory_Get_free_size( area ) );
0085       init_or_extend = _Heap_Extend;
0086     }
0087   }
0088
0089   if ( init_or_extend == _Heap_Initialize ) {
0090     _Internal_error( INTERNAL_ERROR_NO_MEMORY_FOR_HEAP );
0091   }
0092
0093   return heap;
0094 }
0095
0096 #ifdef __cplusplus
0097 }
0098 #endif
0099
0100 #endif /* _RTEMS_MALLOCINITMULTI_H */