rtl-archive.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  COPYRIGHT (c) 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_ARCHIVE_H_)
#define _RTEMS_RTL_ARCHIVE_H_
 
#include <rtems.h>
#include <rtems/chain.h>
#include <rtems/printer.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define RTEMS_RTL_ARCHIVE_USER_LOAD (1 << 0) 
#define RTEMS_RTL_ARCHIVE_REMOVE    (1 << 1) 
#define RTEMS_RTL_ARCHIVE_LOAD      (1 << 2) 
typedef enum rtems_rtl_archive_search
{
  rtems_rtl_archive_search_not_found = 0, 
  rtems_rtl_archive_search_found = 1,     
  rtems_rtl_archive_search_loaded = 2,    
  rtems_rtl_archive_search_error = 3,     
  rtems_rtl_archive_search_no_config = 4 
} rtems_rtl_archive_search;
 
typedef struct rtems_rtl_archive_symbol
{
  size_t      entry;  
  const char* label;  
} rtems_rtl_archive_symbol;
 
typedef struct rtems_rtl_archive_symbols
{
  void*                     base;     
  size_t                    size;     
  size_t                    entries;  
  const char*               names;    
  rtems_rtl_archive_symbol* symbols;  
} rtems_rtl_archive_symbols;
 
typedef struct rtems_rtl_archive
{
  rtems_chain_node          node;     
  const char*               name;     
  size_t                    size;     
  time_t                    mtime;    
  off_t                     enames;   
  rtems_rtl_archive_symbols symbols;  
  size_t                    refs;     
  uint32_t                  flags;    
} rtems_rtl_archive;
 
typedef struct rtems_rtl_archives
{
  const char*         config_name;    
  time_t              config_mtime;   
  size_t              config_length;  
  char*               config;         
  rtems_chain_control archives;       
} rtems_rtl_archives;
 
typedef void (*rtems_rtl_archive_error)(int num, const char* text);
 
void rtems_rtl_archives_open (rtems_rtl_archives* archives, const char* config);
 
void rtems_rtl_archives_close (rtems_rtl_archives* archives);
 
bool rtems_rtl_archives_refresh (rtems_rtl_archives* archives);
 
bool rtems_rtl_archive_load (rtems_rtl_archives* archives, const char* name);
 
rtems_rtl_archive_search rtems_rtl_archive_obj_load (rtems_rtl_archives* archives,
                                                     const char*         symbol,
                                                     bool                load);
 
bool rtems_rtl_obj_archive_find_obj (int                     fd,
                                     size_t                  fsize,
                                     const char**            name,
                                     off_t*                  offset,
                                     size_t*                 size,
                                     off_t*                  extended_names,
                                     rtems_rtl_archive_error error);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif