include/rtems/mallocinitone.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_one_area().
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_MALLOCINITONE_H
0038 #define _RTEMS_MALLOCINITONE_H
0039
0040 #include <rtems/malloc.h>
0041 #include <rtems/score/assert.h>
0042 #include <rtems/score/heapimpl.h>
0043
0044 #ifdef __cplusplus
0045 extern "C" {
0046 #endif
0047
0048 /**
0049  * @ingroup MallocSupport
0050  *
0051  * @brief Initializes the separate C Program Heap with support for exactly one
0052  *   memory area.
0053  *
0054  * This implementation should be used by BSPs which provide exactly one memory
0055  * area via _Memory_Get() to implement _Workspace_Malloc_initialize_separate().
0056  */
0057 static inline Heap_Control *_Malloc_Initialize_for_one_area(
0058   Heap_Control *heap
0059 )
0060 {
0061   const Memory_Information *mem;
0062   Memory_Area              *area;
0063   uintptr_t                 space_available;
0064
0065   mem = _Memory_Get();
0066   _Assert( _Memory_Get_count( mem ) == 1 );
0067
0068   RTEMS_Malloc_Heap = heap;
0069   area = _Memory_Get_area( mem, 0 );
0070   space_available = _Heap_Initialize(
0071     heap,
0072     _Memory_Get_free_begin( area ),
0073     _Memory_Get_free_size( area ),
0074     CPU_HEAP_ALIGNMENT
0075   );
0076
0077   if ( space_available > 0 ) {
0078     _Memory_Consume( area, _Memory_Get_free_size( area ) );
0079   } else {
0080     _Internal_error( INTERNAL_ERROR_NO_MEMORY_FOR_HEAP );
0081   }
0082
0083   return heap;
0084 }
0085
0086 #ifdef __cplusplus
0087 }
0088 #endif
0089
0090 #endif /* _RTEMS_MALLOCINITONE_H */