rtl-allocator.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  COPYRIGHT (c) 2012, 2018, 2023 Chris Johns <chrisj@rtems.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#if !defined (_RTEMS_RTL_ALLOCATOR_H_)
#define _RTEMS_RTL_ALLOCATOR_H_
 
#include <stdbool.h>
 
#include "rtl-indirect-ptr.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
enum rtems_rtl_alloc_tags {
  RTEMS_RTL_ALLOC_OBJECT,     
  RTEMS_RTL_ALLOC_SYMBOL,     
  RTEMS_RTL_ALLOC_EXTERNAL,   
  RTEMS_RTL_ALLOC_READ,       
  RTEMS_RTL_ALLOC_READ_WRITE, 
  RTEMS_RTL_ALLOC_READ_EXEC   
};
 
typedef enum rtems_rtl_alloc_tags rtems_rtl_alloc_tag;
 
enum rtems_rtl_alloc_cmd {
  RTEMS_RTL_ALLOC_NEW,        
  RTEMS_RTL_ALLOC_DEL,        
  RTEMS_RTL_ALLOC_RESIZE,     
  RTEMS_RTL_ALLOC_LOCK,       
  RTEMS_RTL_ALLOC_UNLOCK,     
  RTEMS_RTL_ALLOC_WR_ENABLE,  
  RTEMS_RTL_ALLOC_WR_DISABLE, 
};
 
typedef enum rtems_rtl_alloc_cmd rtems_rtl_alloc_cmd;
 
#define RTEMS_RTL_ALLOC_TAGS ((size_t) (RTEMS_RTL_ALLOC_READ_EXEC + 1))
 
typedef void (*rtems_rtl_allocator)(rtems_rtl_alloc_cmd cmd,
                                    rtems_rtl_alloc_tag tag,
                                    void**              address,
                                    size_t              size);
 
struct rtems_rtl_alloc_data {
  rtems_rtl_allocator allocator;
  rtems_chain_control indirects[RTEMS_RTL_ALLOC_TAGS];
};
 
typedef struct rtems_rtl_alloc_data rtems_rtl_alloc_data;
 
void rtems_rtl_alloc_initialise (rtems_rtl_alloc_data* data);
 
void* rtems_rtl_alloc_new (rtems_rtl_alloc_tag tag, size_t size, bool zero);
 
void rtems_rtl_alloc_del (rtems_rtl_alloc_tag tag, void* address);
 
void* rtems_rtl_alloc_resize (rtems_rtl_alloc_tag tag,
                              void*               address,
                              size_t              size,
                              bool                zero);
 
void rtems_rtl_alloc_lock (void);
 
void rtems_rtl_alloc_unlock (void);
 
void rtems_rtl_alloc_wr_enable (rtems_rtl_alloc_tag tag, void* address);
 
void rtems_rtl_alloc_wr_disable (rtems_rtl_alloc_tag tag, void* address);
 
rtems_rtl_allocator rtems_rtl_alloc_hook (rtems_rtl_allocator handler);
 
void rtems_rtl_alloc_indirect_new (rtems_rtl_alloc_tag tag,
                                   rtems_rtl_ptr*      handle,
                                   size_t              size);
 
void rtems_rtl_alloc_indirect_del (rtems_rtl_alloc_tag tag,
                                   rtems_rtl_ptr*      handle);
 
rtems_rtl_alloc_tag rtems_rtl_alloc_text_tag (void);
 
rtems_rtl_alloc_tag rtems_rtl_alloc_const_tag (void);
 
rtems_rtl_alloc_tag rtems_rtl_alloc_eh_tag (void);
 
rtems_rtl_alloc_tag rtems_rtl_alloc_data_tag (void);
 
rtems_rtl_alloc_tag rtems_rtl_alloc_bss_tag (void);
 
bool rtems_rtl_alloc_module_new (void** text_base, size_t text_size,
                                 void** const_base, size_t const_size,
                                 void** eh_base, size_t eh_size,
                                 void** data_base, size_t data_size,
                                 void** bss_base, size_t bss_size);
 
bool rtems_rtl_alloc_module_resize (void** text_base, size_t text_size,
                                    void** const_base, size_t const_size,
                                    void** eh_base, size_t eh_size,
                                    void** data_base, size_t data_size,
                                    void** bss_base, size_t bss_size);
 
void rtems_rtl_alloc_module_del (void** text_base, void** const_base,
                                 void** eh_base, void** data_base,
                                 void** bss_base);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif