cpukit/libdl/rtl-alloc-heap.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup rtems_rtl
0007  *
0008  * @brief RTEMS Run-Time Linker Allocator for the standard heap.
0009  */
0010
0011 /*
0012  *  COPYRIGHT (c) 2012, 2018 Chris Johns <chrisj@rtems.org>
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 #if !defined (_RTEMS_RTL_ALLOC_HEAP_H_)
0037 #define _RTEMS_RTL_ALLOC_HEAP_H_
0038
0039 #include <rtems/rtl/rtl-allocator.h>
0040
0041 #ifdef __cplusplus
0042 extern "C" {
0043 #endif /* __cplusplus */
0044
0045 /**
0046  * Allocator handler for the standard libc heap.
0047  *
0048  * @param cmd The allocation command.
0049  * @param tag The type of allocation request.
0050  * @param address Pointer to the memory address. If an allocation the value is
0051  *                unspecific on entry and the allocated address or NULL on
0052  *                exit. The NULL value means the allocation failed. If a delete
0053  *                or free request the memory address is the block to free. A
0054  *                free request of NULL is silently ignored.
0055  * @param size The size of the allocation if an allocation request and
0056  *             not used if deleting or freeing a previous allocation.
0057  */
0058 void rtems_rtl_alloc_heap(rtems_rtl_alloc_cmd cmd,
0059                           rtems_rtl_alloc_tag tag,
0060                           void**              address,
0061                           size_t              size);
0062
0063 #ifdef __cplusplus
0064 }
0065 #endif /* __cplusplus */
0066
0067 #endif