cpukit/libdl/rtl-unwind-dw2.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup rtems_rtl
0007  *
0008  * @brief RTEMS Run-Time Linker Unwind DWARF  Support.
0009  */
0010
0011 /*
0012  *  COPYRIGHT (c) 2016, 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_UNWIND_DW2_H_)
0037 #define _RTEMS_RTL_UNWIND_DW2_H_
0038
0039 #include "rtl-elf.h"
0040
0041 #ifdef __cplusplus
0042 extern "C" {
0043 #endif /* __cplusplus */
0044
0045 #if __SIZEOF_LONG__ >= __SIZEOF_POINTER__
0046   typedef long rtems_rtl_elf_unwind_dw2_sleb128;
0047   typedef unsigned long rtems_rtl_elf_unwind_dw2_uleb128;
0048 #elif __SIZEOF_LONG_LONG__ >= __SIZEOF_POINTER__
0049   typedef long long rtems_rtl_elf_unwind_dw2_sleb128;
0050   typedef unsigned long long rtems_rtl_elf_unwind_dw2_uleb128;
0051 #else
0052   #error No DW2 type available.
0053 #endif
0054
0055 /**
0056  * Architecture specific handler to check if a section contains exception
0057  * handler data..
0058  *
0059  * @param obj The object file.
0060  * @param name The section's name.
0061  * @param uint32 flags The object file's flags.
0062  * @retval true The section contains unwind information.
0063  * @retval false The section does not contain unwind information.
0064  */
0065 bool rtems_rtl_elf_unwind_dw2_parse (const rtems_rtl_obj* obj,
0066                      const char*          name,
0067                      uint32_t             flags);
0068
0069 /**
0070  * Architecture specific handler to add an object file's unwind information to
0071  * the base image.
0072  *
0073  * @param obj The object file.
0074  * @retval true The unwind information has been registered.
0075  * @retval false The unwind information could not be registered.
0076  */
0077 bool rtems_rtl_elf_unwind_dw2_register (const rtems_rtl_obj* obj);
0078
0079 /**
0080  * Architecture specific handler to remove an object file's unwind information
0081  * from the base image.
0082  *
0083  * @param obj The object file.
0084  * @retval true The unwind information has been deregistered.
0085  * @retval false The unwind information could not be deregistered.
0086  */
0087 bool rtems_rtl_elf_unwind_dw2_deregister (const rtems_rtl_obj* obj);
0088
0089 /**
0090  * Read signed and unsigned LEB128 values.
0091  */
0092 const uint8_t* rtems_rtl_elf_unwind_dw2_read_uleb128 (const uint8_t*                    data,
0093                               rtems_rtl_elf_unwind_dw2_uleb128* val);
0094 const uint8_t* rtems_rtl_elf_unwind_dw2_read_sleb128 (const uint8_t*                    data,
0095                               rtems_rtl_elf_unwind_dw2_sleb128* val);
0096
0097 bool rtems_rtl_elf_unwind_dw2_relocate (const Elf_Addr* where, Elf_Word value, Elf_Word mask);
0098
0099 #ifdef __cplusplus
0100 }
0101 #endif /* __cplusplus */
0102
0103 #endif