cpukit/libdl/rtl-rap.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup rtems_rtl
0007  *
0008  * @brief RTEMS Run-Time Linker ELF Headers
0009  */
0010
0011 /*
0012  *  COPYRIGHT (c) 2012, 2018 Chris Johns <chrisj@rtems.org>
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #if !defined (_RTEMS_RTL_RAP_H_)
0037 #define _RTEMS_RTL_RAP_H_
0038
0039 #include <rtems/rtl/rtl-fwd.h>
0040 #include <rtems/rtl/rtl-obj-fwd.h>
0041 #include <rtems/rtl/rtl-sym.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif /* __cplusplus */
0046
0047 /**
0048  * The RAP format check handler.
0049  *
0050  * @param obj The object being checked.
0051  * @param fd The file descriptor.
0052  */
0053 bool rtems_rtl_rap_file_check (rtems_rtl_obj* obj, int fd);
0054
0055 /**
0056  * The RAP format load handler.
0057  *
0058  * @param obj The object to load.
0059  * @param fd The file descriptor.
0060  */
0061 bool rtems_rtl_rap_file_load (rtems_rtl_obj* obj, int fd);
0062
0063 /**
0064  * The RAP format unload handler.
0065  *
0066  * @param obj The object to unload.
0067  */
0068 bool rtems_rtl_rap_file_unload (rtems_rtl_obj* obj);
0069
0070 /**
0071  * The RAP format signature handler.
0072  *
0073  * @return rtems_rtl_loader_format* The format's signature.
0074  */
0075 rtems_rtl_loader_format* rtems_rtl_rap_file_sig (void);
0076
0077 #ifdef __cplusplus
0078 }
0079 #endif /* __cplusplus */
0080
0081 #endif