rtl.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  COPYRIGHT (c) 2012, 2018 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_H_)
#define _RTEMS_RTL_H_
 
#include <link.h>
#include <rtems/chain.h>
#include <rtems/thread.h>
 
#include <rtems/rtl/rtl-allocator.h>
#include <rtems/rtl/rtl-archive.h>
#include <rtems/rtl/rtl-fwd.h>
#include <rtems/rtl/rtl-obj.h>
#include <rtems/rtl/rtl-obj-cache.h>
#include <rtems/rtl/rtl-obj-comp.h>
#include <rtems/rtl/rtl-sym.h>
#include <rtems/rtl/rtl-unresolved.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#ifdef __STDC__
#define RTL_XGLUE(a,b) a##b
#else
#define RTL_XGLUE(a,b) ab
#endif
 
#define RTL_GLUE(a,b) RTL_XGLUE(a,b)
 
#define RTEMS_RTL_SYMS_GLOBAL_BUCKETS (32)
 
#define RTEMS_RTL_UNRESOLVED_BLOCK_SIZE (256)
 
#define RTEMS_RTL_DEPENDENCY_BLOCK_SIZE (16)
 
extern struct r_debug _rtld_debug;
 
void _rtld_debug_state (void);
 
typedef void (*rtems_rtl_cdtor)(void);
 
struct rtems_rtl_data
{
  rtems_recursive_mutex lock;           
  rtems_rtl_alloc_data  allocator;      
  rtems_chain_control   objects;        
  rtems_chain_control   pending;        
  const char*           paths;          
  rtems_rtl_symbols     globals;        
  rtems_rtl_archives    archives;       
  rtems_rtl_unresolved  unresolved;     
  rtems_rtl_obj*        base;           
  rtems_rtl_obj_cache   symbols;        
  rtems_rtl_obj_cache   strings;        
  rtems_rtl_obj_cache   relocs;         
  rtems_rtl_obj_comp    decomp;         
  int                   last_errno;     
  char                  last_error[64]; 
};
 
rtems_rtl_data* rtems_rtl_data_unprotected (void);
 
rtems_rtl_symbols* rtems_rtl_global_symbols (void);
 
const char* rtems_rtl_last_error_unprotected (void);
 
rtems_chain_control* rtems_rtl_objects_unprotected (void);
 
rtems_chain_control* rtems_rtl_pending_unprotected (void);
 
rtems_rtl_unresolved* rtems_rtl_unresolved_unprotected (void);
 
rtems_rtl_archives* rtems_rtl_archives_unprotected (void);
 
void rtems_rtl_obj_caches (rtems_rtl_obj_cache** symbols,
                           rtems_rtl_obj_cache** strings,
                           rtems_rtl_obj_cache** relocs);
 
void rtems_rtl_obj_caches_flush (void);
 
void rtems_rtl_obj_decompress (rtems_rtl_obj_comp** decomp,
                               rtems_rtl_obj_cache* cache,
                               int                  fd,
                               int                  compression,
                               off_t                offset);
 
void rtems_rtl_obj_update_flags (uint32_t clear, uint32_t set);
 
rtems_rtl_data* rtems_rtl_lock (void);
 
void rtems_rtl_unlock (void);
 
rtems_rtl_obj* rtems_rtl_check_handle (void* handle);
 
rtems_rtl_obj* rtems_rtl_find_obj (const char* name);
 
rtems_rtl_obj* rtems_rtl_find_obj_with_symbol (const rtems_rtl_obj_sym* sym);
 
rtems_rtl_obj* rtems_rtl_load_object (const char* name, int mode);
 
bool rtems_rtl_unload_object (rtems_rtl_obj* obj);
 
rtems_rtl_obj* rtems_rtl_load (const char* name, int mode);
 
bool rtems_rtl_unload (rtems_rtl_obj* obj);
 
int rtems_rtl_get_error (char* message, size_t max_message);
 
bool rtems_rtl_path_append (const char* path);
 
bool rtems_rtl_path_prepend (const char* path);
 
void rtems_rtl_base_sym_global_add (const unsigned char*  esyms,
                                    unsigned int          count,
                                    rtems_rtl_tls_offset* tls_offsets,
                                    unsigned int          tls_size);
 
rtems_rtl_obj* rtems_rtl_baseimage (void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif