rtl-unresolved.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  COPYRIGHT (c) 2012, 2019 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_UNRESOLVED_H_)
#define _RTEMS_RTL_UNRESOLVED_H_
 
#include <rtems.h>
#include <rtems/chain.h>
#include "rtl-obj-fwd.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef uint32_t rtems_rtl_word;

typedef enum rtems_rtl_unresolved_rtype
{
  rtems_rtl_unresolved_empty = 0,  
  rtems_rtl_unresolved_symbol = 1, 
  rtems_rtl_unresolved_reloc = 2,  
  rtems_rtl_trampoline_reloc = 3   
} rtems_rtl_unresolved_rtype;

#define RTEMS_RTL_UNRESOLV_SYM_SEARCH_ARCHIVE (1 << 0) 
#define RTEMS_RTL_UNRESOLV_SYM_HAS_ERROR      (1 << 1) 

typedef struct rtems_rtl_unresolv_symbol
{
  uint16_t   refs;     
  uint16_t   flags;    
  uint16_t   length;   
  const char name[];   
} rtems_rtl_unresolv_symbol;

typedef struct rtems_rtl_unresolv_reloc
{
  rtems_rtl_obj* obj;     
  uint16_t       flags;   
  uint16_t       name;    
  uint16_t       sect;    
  rtems_rtl_word rel[3];  
} rtems_rtl_unresolv_reloc;

typedef struct rtems_rtl_tramp_reloc
{
  rtems_rtl_obj* obj;      
  uint16_t       flags;    
  uint16_t       sect;     
  rtems_rtl_word symvalue; 
  rtems_rtl_word rel[3];   
} rtems_rtl_tramp_reloc;

typedef struct rtems_rtl_unresolv_rec
{
  rtems_rtl_unresolved_rtype type;
  union
  {
    rtems_rtl_unresolv_symbol name;   
    rtems_rtl_unresolv_reloc  reloc;  
    rtems_rtl_tramp_reloc     tramp;  
  } rec;
} rtems_rtl_unresolv_rec;

typedef struct rtems_rtl_unresolv_block
{
  rtems_chain_node       link;  
  uint32_t               recs;  
  rtems_rtl_unresolv_rec rec[]; 
} rtems_rtl_unresolv_block;

typedef struct rtems_rtl_unresolved
{
  uint32_t            marker;     
  size_t              block_recs; 
  rtems_chain_control blocks;     
} rtems_rtl_unresolved;

typedef bool rtems_rtl_unresolved_iterator (rtems_rtl_unresolv_rec* rec,
                                            void*                   data);

bool rtems_rtl_unresolved_table_open (rtems_rtl_unresolved* unresolved,
                                      size_t                block_records);

void rtems_rtl_unresolved_table_close (rtems_rtl_unresolved* unresolved);

bool rtems_rtl_unresolved_iterate (rtems_rtl_unresolved_iterator iterator,
                                   void*                         data);

bool rtems_rtl_unresolved_add (rtems_rtl_obj*        obj,
                               const uint16_t        flags,
                               const char*           name,
                               const uint16_t        sect,
                               const rtems_rtl_word* rel);

void rtems_rtl_unresolved_resolve (void);

bool rtems_rtl_unresolved_remove (rtems_rtl_obj*        obj,
                                  const char*           name,
                                  const uint16_t        sect,
                                  const rtems_rtl_word* rel);

void rtems_rtl_unresolved_set_archive_search (void);

void rtems_rtl_unresolved_dump (void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif