rtl-obj.h

Go to the documentation of this file.

/*
 *  COPYRIGHT (c) 2012 Chris Johns <chrisj@rtems.org>
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */
#if !defined (_RTEMS_RTL_OBJ_H_)
#define _RTEMS_RTL_OBJ_H_

#include <rtems.h>
#include <rtems/chain.h>
#include <rtems/rtl/rtl-sym.h>
#include <rtems/rtl/rtl-unresolved.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define RTEMS_RTL_FMT_ELF     (1 << 0)
#define RTEMS_RTL_FMT_COMP    (1 << 1)
#define RTEMS_RTL_FMT_PRIVATE (1 << 16)

typedef struct rtems_rtl_loader_format_s
{
  const char* label;

  uint32_t flags;
} rtems_rtl_loader_format_t;

typedef bool (*rtems_rtl_loader_check) (rtems_rtl_obj_t* obj, int fd);

typedef bool (*rtems_rtl_loader_load) (rtems_rtl_obj_t* obj, int fd);

typedef bool (*rtems_rtl_loader_unload) (rtems_rtl_obj_t* obj);

typedef rtems_rtl_loader_format_t* (*rtems_rtl_loader_sig) (void);

typedef struct rtems_rtl_loader_table_s
{
  rtems_rtl_loader_check  check;     
  rtems_rtl_loader_load   load;      
  rtems_rtl_loader_unload unload;    
  rtems_rtl_loader_sig    signature; 
} rtems_rtl_loader_table_t;

#define RTEMS_RTL_OBJ_SECT_TEXT  (1 << 0)  
#define RTEMS_RTL_OBJ_SECT_CONST (1 << 1)  
#define RTEMS_RTL_OBJ_SECT_DATA  (1 << 2)  
#define RTEMS_RTL_OBJ_SECT_BSS   (1 << 3)  
#define RTEMS_RTL_OBJ_SECT_EH    (1 << 4)  
#define RTEMS_RTL_OBJ_SECT_REL   (1 << 5)  
#define RTEMS_RTL_OBJ_SECT_RELA  (1 << 6)  
#define RTEMS_RTL_OBJ_SECT_SYM   (1 << 7)  
#define RTEMS_RTL_OBJ_SECT_STR   (1 << 8)  
#define RTEMS_RTL_OBJ_SECT_ALLOC (1 << 9)  
#define RTEMS_RTL_OBJ_SECT_LOAD  (1 << 10) 
#define RTEMS_RTL_OBJ_SECT_WRITE (1 << 11) 
#define RTEMS_RTL_OBJ_SECT_EXEC  (1 << 12) 
#define RTEMS_RTL_OBJ_SECT_ZERO  (1 << 13) 
#define RTEMS_RTL_OBJ_SECT_LINK  (1 << 14) 
#define RTEMS_RTL_OBJ_SECT_CTOR  (1 << 15) 
#define RTEMS_RTL_OBJ_SECT_DTOR  (1 << 16) 
#define RTEMS_RTL_OBJ_SECT_LOCD  (1 << 17) 
#define RTEMS_RTL_OBJ_SECT_TYPES (RTEMS_RTL_OBJ_SECT_TEXT | \
                                  RTEMS_RTL_OBJ_SECT_CONST | \
                                  RTEMS_RTL_OBJ_SECT_DATA | \
                                  RTEMS_RTL_OBJ_SECT_BSS | \
                                  RTEMS_RTL_OBJ_SECT_EH)

struct rtems_rtl_obj_sect_s
{
  rtems_chain_node node;        
  int              section;     
  const char*      name;        
  size_t           size;        
  off_t            offset;      
  uint32_t         alignment;   
  int              link;        
  int              info;        
  uint32_t         flags;       
  void*            base;        
  int              load_order;  
};

#define RTEMS_RTL_OBJ_LOCKED     (1 << 0) 
#define RTEMS_RTL_OBJ_UNRESOLVED (1 << 1) 
struct rtems_rtl_obj_s
{
  rtems_chain_node     link;         
  uint32_t             flags;        
  uint32_t             users;        
  int                  format;       
  const char*          fname;        
  const char*          oname;        
  const char*          aname;        
  off_t                ooffset;      
  size_t               fsize;        
  rtems_chain_control  sections;     
  rtems_rtl_obj_sym_t* local_table;  
  size_t               local_syms;   
  size_t               local_size;   
  rtems_rtl_obj_sym_t* global_table; 
  size_t               global_syms;  
  size_t               global_size;  
  uint32_t             unresolved;   
  void*                text_base;    
  size_t               text_size;     
  void*                const_base;   
  void*                eh_base;      
  size_t               eh_size;      
  void*                data_base;    
  void*                bss_base;     
  size_t               bss_size;     
  size_t               exec_size;    
  void*                entry;        
  uint32_t             checksum;     
  uint32_t*            sec_num;      
  uint32_t             obj_num;      
  struct link_map*     linkmap;      
  void*                loader;       
};

typedef bool (*rtems_rtl_obj_sect_handler_t)(rtems_rtl_obj_t*      obj,
                                             int                   fd,
                                             rtems_rtl_obj_sect_t* sect,
                                             void*                 data);

static inline const char* rtems_rtl_obj_fname (const rtems_rtl_obj_t* obj)
{
  return obj->fname;
}

static inline bool rtems_rtl_obj_fname_valid (const rtems_rtl_obj_t* obj)
{
  return obj->fname;
}

static inline const char* rtems_rtl_obj_oname (const rtems_rtl_obj_t* obj)
{
  return obj->oname;
}

static inline bool rtems_rtl_obj_oname_valid (const rtems_rtl_obj_t* obj)
{
  return obj->oname;
}

static inline const char* rtems_rtl_obj_aname (const rtems_rtl_obj_t* obj)
{
  return obj->aname;
}

static inline bool rtems_rtl_obj_aname_valid (const rtems_rtl_obj_t* obj)
{
  return obj->aname;
}

static inline bool rtems_rtl_obj_text_inside (const rtems_rtl_obj_t* obj,
                                              const void*            address)
{
  return
    (address >= obj->text_base) &&
    (address < (obj->text_base + obj->text_size));
}

rtems_rtl_obj_t* rtems_rtl_obj_alloc (void);

bool rtems_rtl_obj_free (rtems_rtl_obj_t* obj);

bool rtems_rtl_obj_unresolved (rtems_rtl_obj_t* obj);

bool rtems_rtl_parse_name (const char*  name,
                           const char** aname,
                           const char** oname,
                           off_t*       ooffset);

bool rtems_rtl_match_name (rtems_rtl_obj_t* obj, const char* name);

bool rtems_rtl_obj_find_file (rtems_rtl_obj_t* obj, const char* name);

bool rtems_rtl_obj_add_section (rtems_rtl_obj_t* obj,
                                int              section,
                                const char*      name,
                                size_t           size,
                                off_t            offset,
                                uint32_t         alignment,
                                int              link,
                                int              info,
                                uint32_t         flags);

void rtems_rtl_obj_erase_sections (rtems_rtl_obj_t* obj);

rtems_rtl_obj_sect_t* rtems_rtl_obj_find_section (const rtems_rtl_obj_t* obj,
                                                  const char*            name);

rtems_rtl_obj_sect_t* rtems_rtl_obj_find_section_by_index (const rtems_rtl_obj_t* obj,
                                                           int                    index);

size_t rtems_rtl_obj_text_size (const rtems_rtl_obj_t* obj);

uint32_t rtems_rtl_obj_text_alignment (const rtems_rtl_obj_t* obj);

size_t rtems_rtl_obj_const_size (const rtems_rtl_obj_t* obj);

uint32_t rtems_rtl_obj_const_alignment (const rtems_rtl_obj_t* obj);

size_t rtems_rtl_obj_eh_size (const rtems_rtl_obj_t* obj);

uint32_t rtems_rtl_obj_eh_alignment (const rtems_rtl_obj_t* obj);

size_t rtems_rtl_obj_data_size (const rtems_rtl_obj_t* obj);

uint32_t rtems_rtl_obj_data_alignment (const rtems_rtl_obj_t* obj);

size_t rtems_rtl_obj_bss_size (const rtems_rtl_obj_t* obj);

uint32_t rtems_rtl_obj_bss_alignment (const rtems_rtl_obj_t* obj);

bool rtems_rtl_obj_relocate (rtems_rtl_obj_t*             obj,
                             int                          fd,
                             rtems_rtl_obj_sect_handler_t handler,
                             void*                        data);

void rtems_rtl_obj_synchronize_cache (rtems_rtl_obj_t*    obj);

bool rtems_rtl_obj_relocate_unresolved (rtems_rtl_unresolv_reloc_t* reloc,
                                        rtems_rtl_obj_sym_t*        sym);

bool rtems_rtl_obj_load_symbols (rtems_rtl_obj_t*             obj,
                                 int                          fd,
                                 rtems_rtl_obj_sect_handler_t handler,
                                 void*                        data);

bool rtems_rtl_obj_load_sections (rtems_rtl_obj_t*             obj,
                                  int                          fd,
                                  rtems_rtl_obj_sect_handler_t handler,
                                  void*                        data);

void rtems_rtl_obj_run_ctors (rtems_rtl_obj_t* obj);

void rtems_rtl_obj_run_dtors (rtems_rtl_obj_t* obj);

bool rtems_rtl_obj_load (rtems_rtl_obj_t* obj);

bool rtems_rtl_obj_unload (rtems_rtl_obj_t* obj);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif