/*
Copyright (C) 2000-2006 Silicon Graphics, Inc. All Rights Reserved.
Portions Copyright (C) 2007-2022 David Anderson. All Rights Reserved.
Portions Copyright 2012 SN Systems Ltd. All rights reserved.
This program is free software; you can redistribute it
and/or modify it under the terms of version 2.1 of the
GNU Lesser General Public License as published by the Free
Software Foundation.
This program is distributed in the hope that it would be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.
Further, this software is distributed without any warranty
that it is free of the rightful claim of any third person
regarding infringement or the like. Any license provided
herein, whether implied or otherwise, applies only to this
software file. Patent licenses, if any, provided herein
do not apply to combinations of this program with other
software, or any other product whatsoever.
You should have received a copy of the GNU Lesser General
Public License along with this program; if not, write the
Free Software Foundation, Inc., 51 Franklin Street - Fifth
Floor, Boston MA 02110-1301, USA.
*/
#include <config.h>
#include <stdio.h> /* debugging */
#include <string.h> /* memcmp() memcpy() memset() strcmp() strlen() */
#include <stdlib.h> /* calloc() free() */
#if defined(_WIN32) && defined(HAVE_STDAFX_H)
#include "stdafx.h"
#endif /* HAVE_STDAFX_H */
#ifdef HAVE_STDINT_H
#include <stdint.h> /* uintptr_t */
#endif /* HAVE_STDINT_H */
#include "dwarf.h"
#include "libdwarf.h"
#include "libdwarf_private.h"
#include "dwarf_base_types.h"
#include "dwarf_safe_strcpy.h"
#include "dwarf_opaque.h"
#include "dwarf_alloc.h"
#include "dwarf_error.h"
#include "dwarf_util.h"
#include "dwarf_str_offsets.h"
#include "dwarf_string.h"
#include "dwarf_die_deliv.h"
/* These are sanity checks, not 'rules'. */
#define MINIMUM_ADDRESS_SIZE 2
#define MAXIMUM_ADDRESS_SIZE 8
#if 0 /* dump rnglists context */
#include "dwarf_rnglists.h" /* for debugging declaration */
static void
dumprnglists_context(Dwarf_Rnglists_Context *rnglists,
Dwarf_Unsigned count)
{
Dwarf_Rnglists_Context prc = 0;
Dwarf_Unsigned i = 0;
printf("Rnglists_Context count: 0x%lu\n",(unsigned long)count);
for ( ; i < count; ++i) {
prc = rnglists[i];
printf("[%3lu] Rnglists_Context rc_index : %lu\n",
(unsigned long)i,
(unsigned long)prc->rc_index);
printf(" hed offset : %lu\n",
(unsigned long)prc->rc_header_offset);
printf(" rc_length : %lu\n",
(unsigned long)prc->rc_length);
printf(" Version: %u offset size: "
"%u address_size: %u \n",
prc->rc_version,prc->rc_offset_size,
prc->rc_address_size);
printf(" offset_entry count : %lu\n",
(unsigned long)prc->rc_offset_entry_count);
printf(" offsets offset_ : %lu\n",
(unsigned long)prc->rc_offsets_off_in_sect);
}
}
static void
dumpcu_context_list( Dwarf_CU_Context first)
{
Dwarf_CU_Context ctx = 0;
unsigned cc = 0;
for ( ctx = first; ctx ; ctx = ctx->cc_next, ++cc) {
printf("[%3u] CU_Context rnglists_base "
" : 0x%lx\n",cc,
(unsigned long)ctx->cc_rnglists_base);
printf(" rnglists_base_contr_size: 0x%lx\n",
(unsigned long)ctx->cc_rnglists_base_contr_size);
printf(" rnglists_base_present : 0x%lx\n",
(unsigned long)ctx->cc_rnglists_base_present);
printf(" rnglists_header_length_present: %lu\n",
(unsigned long)ctx->cc_rnglists_header_length_present);
printf(" ranges_base : 0x%lx\n",
(unsigned long)ctx->cc_ranges_base);
printf(" ranges_base present : 0x%lx\n",
(unsigned long)ctx->cc_ranges_base_present);
}
}
static void
dump_rnglists_data(const char *msg,
Dwarf_Debug dbg,Dwarf_CU_Context cucon)
{
printf("Debugging dump_rnglists_data %s\n",msg);
if (!dbg->de_debug_rnglists.dss_data) {
printf("No de_rnglists section\n");
}
if (!dbg->de_rnglists_context_count) {
printf("No de_rnglists contexts\n");
} else {
dumprnglists_context(dbg->de_rnglists_context,
dbg->de_rnglists_context_count);
}
if (dbg->de_info_reading.de_cu_context_list) {
if (cucon) {
dumpcu_context_list(cucon);
} else {
dumpcu_context_list(
dbg->de_info_reading.de_cu_context_list);
}
} else {
printf("No debug_info cu contexts\n");
}
if (dbg->de_types_reading.de_cu_context_list) {
if (cucon) {
dumpcu_context_list(cucon);
} else {
dumpcu_context_list(
dbg->de_types_reading.de_cu_context_list);
}
} else {
printf("No debug_types cu contexts\n");
}
fflush(stdout);
}
#endif
static void assign_correct_unit_type(Dwarf_CU_Context cu_context);
static int find_cu_die_base_fields(Dwarf_Debug dbg,
Dwarf_CU_Context cucon,
Dwarf_Die cudie,
Dwarf_Bool *bad_pc_form,
Dwarf_Error *error);
static int _dwarf_siblingof_internal(Dwarf_Debug dbg,
Dwarf_Die die,
Dwarf_CU_Context context,
Dwarf_Bool is_info,
Dwarf_Die * caller_ret_die, Dwarf_Error * error);
/* see cuandunit.txt for an overview of the
DWARF5 split dwarf sections and values
and the DWARF4 GNU cc version of a draft
version of DWARF5 (quite different from
the final DWARF5).
*/
static struct Dwarf_Sig8_s dwarfsig8zero;
#if 0 /* dump_bytes */
static void
dump_bytes(char * msg,Dwarf_Small * start, long len)
{
Dwarf_Small *end = start + len;
Dwarf_Small *cur = start;
printf("%s ",msg);
for (; cur < end; cur++) {
printf("%02x ", *cur);
}
printf("\n");
}
#endif /*0*/
/* New October 2011. Enables client code to know if
it is a debug_info or debug_types context. */
Dwarf_Bool
dwarf_get_die_infotypes_flag(Dwarf_Die die)
{
return die->di_is_info;
}
/*
For a given Dwarf_Debug dbg, this function checks
if a CU that includes the given offset has been read
or not. If yes, it returns the Dwarf_CU_Context
for the CU. Otherwise it returns NULL. Being an
internal routine, it is assumed that a valid dbg
is passed.
**This is a sequential search. May be too slow.
If debug_info and debug_abbrev not loaded, this will
wind up returning NULL. So no need to load before calling
this.
*/
static Dwarf_CU_Context
_dwarf_find_CU_Context(Dwarf_Debug dbg,
Dwarf_Off offset,
Dwarf_Bool is_info)
{
Dwarf_CU_Context cu_context = 0;
Dwarf_Debug_InfoTypes dis = is_info? &dbg->de_info_reading:
&dbg->de_types_reading;
if (offset >= dis->de_last_offset){
return NULL;
}
if (dis->de_cu_context != NULL &&
dis->de_cu_context->cc_next != NULL &&
dis->de_cu_context->cc_next->cc_debug_offset == offset) {
return dis->de_cu_context->cc_next;
}
if (dis->de_cu_context != NULL &&
dis->de_cu_context->cc_debug_offset <= offset) {
for (cu_context = dis->de_cu_context;
cu_context != NULL;
cu_context = cu_context->cc_next) {
if (offset >= cu_context->cc_debug_offset &&
offset < cu_context->cc_debug_offset +
cu_context->cc_length + cu_context->cc_length_size
+ cu_context->cc_extension_size) {
return cu_context;
}
}
}
for (cu_context = dis->de_cu_context_list;
cu_context != NULL;
cu_context = cu_context->cc_next) {
if (offset >= cu_context->cc_debug_offset &&
offset < cu_context->cc_debug_offset +
cu_context->cc_length + cu_context->cc_length_size
+ cu_context->cc_extension_size) {
return cu_context;
}
}
return NULL;
}
int
dwarf_get_debugfission_for_die(Dwarf_Die die,
struct Dwarf_Debug_Fission_Per_CU_s *fission_out,
Dwarf_Error *error)
{
Dwarf_CU_Context context = 0;
Dwarf_Debug dbg = 0;
struct Dwarf_Debug_Fission_Per_CU_s * percu = 0;
CHECK_DIE(die, DW_DLV_ERROR);
context = die->di_cu_context;
dbg = context->cc_dbg;
if (!_dwarf_file_has_debug_fission_index(dbg)) {
return DW_DLV_NO_ENTRY;
}
/* Logic should work for DW4 and DW5. */
if (context->cc_unit_type == DW_UT_type||
context->cc_unit_type == DW_UT_split_type ) {
if (!_dwarf_file_has_debug_fission_tu_index(dbg)) {
return DW_DLV_NO_ENTRY;
}
} else if (context->cc_unit_type == DW_UT_split_compile) {
if (!_dwarf_file_has_debug_fission_cu_index(dbg)) {
return DW_DLV_NO_ENTRY;
}
} else { /* Fall through*/ }
percu = &context->cc_dwp_offsets;
if (!percu->pcu_type) {
return DW_DLV_NO_ENTRY;
}
*fission_out = *percu;
return DW_DLV_OK;
}
static Dwarf_Bool
is_unknown_UT_value(int ut)
{
switch(ut) {
case DW_UT_compile:
case DW_UT_type:
case DW_UT_partial:
return FALSE;
case DW_UT_skeleton:
case DW_UT_split_compile:
case DW_UT_split_type:
return FALSE;
default:
break;
}
return TRUE;
}
/* ASSERT: whichone is a DW_SECT* macro value. */
Dwarf_Unsigned
_dwarf_get_dwp_extra_offset(struct Dwarf_Debug_Fission_Per_CU_s* dwp,
unsigned whichone, Dwarf_Unsigned * size)
{
Dwarf_Unsigned sectoff = 0;
if (!dwp->pcu_type) {
return 0;
}
sectoff = dwp->pcu_offset[whichone];
*size = dwp->pcu_size[whichone];
return sectoff;
}
/* _dwarf_get_fission_addition_die returns DW_DLV_OK etc.
*/
int
_dwarf_get_fission_addition_die(Dwarf_Die die, int dw_sect_index,
Dwarf_Unsigned *offset,
Dwarf_Unsigned *size,
Dwarf_Error *error)
{
/* We do not yet know the DIE hash, so we cannot use it
to identify the offset. */
Dwarf_CU_Context context = 0;
Dwarf_Unsigned dwpadd = 0;
Dwarf_Unsigned dwpsize = 0;
CHECK_DIE(die, DW_DLV_ERROR);
context = die->di_cu_context;
dwpadd = _dwarf_get_dwp_extra_offset(
&context->cc_dwp_offsets,
dw_sect_index,&dwpsize);
*offset = dwpadd;
*size = dwpsize;
return DW_DLV_OK;
}
/* Not sure if this is the only way to be sure early on in
reading a compile unit. */
static int
section_name_ends_with_dwo(const char *name)
{
size_t lenstr = 0;
size_t dotpos = 0;
if (!name) {
return FALSE;
}
lenstr = strlen(name);
if (lenstr < 5) {
return FALSE;
}
dotpos = lenstr - 4;
if (strcmp(name+dotpos,".dwo")) {
return FALSE;
}
return TRUE;
}
void
_dwarf_create_address_size_dwarf_error(Dwarf_Debug dbg,
Dwarf_Error *error,
Dwarf_Unsigned addrsize,
int errcode,const char *errname)
{
dwarfstring m;
const char *bites = "bytes";
if (addrsize == 1) {
bites = "byte";
}
dwarfstring_constructor(&m);
dwarfstring_append(&m,(char *)errname);
dwarfstring_append_printf_u(&m,
": Address size of %u ",
addrsize);
dwarfstring_append_printf_s(&m,
"%s is not supported. Corrupt DWARF.",
(char *)bites);
_dwarf_error_string(dbg,error,errcode,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
}
/* New January 2017 */
static int
_dwarf_read_cu_version_and_abbrev_offset(Dwarf_Debug dbg,
Dwarf_Small *data,
Dwarf_Bool is_info,
unsigned offset_size, /* 4 or 8 */
Dwarf_CU_Context cu_context,
/* end_data used for sanity checking */
Dwarf_Small * end_data,
Dwarf_Unsigned * bytes_read_out,
Dwarf_Error * error)
{
Dwarf_Small * data_start = data;
Dwarf_Small * dataptr = data;
Dwarf_Ubyte unit_type = 0;
Dwarf_Ubyte addrsize = 0;
Dwarf_Unsigned abbrev_offset = 0;
Dwarf_Half version = 0;
READ_UNALIGNED_CK(dbg, version, Dwarf_Half,
dataptr,DWARF_HALF_SIZE,error,end_data);
dataptr += DWARF_HALF_SIZE;
if (version == DW_CU_VERSION5) {
Dwarf_Ubyte unit_typeb = 0;
Dwarf_Unsigned herelen = sizeof(unit_typeb) +
sizeof(addrsize) + offset_size;
if ((dataptr+herelen) > end_data) {
_dwarf_error_string(dbg, error,
DW_DLE_CU_UT_TYPE_ERROR,
"DW_DLE_UT_TYPE_ERROR: "
" Reading the unit type, address size, "
"and abbrev_offset of the DWARF5 header"
" will run off the end of the section. "
"Corrupt DWARF");
}
READ_UNALIGNED_CK(dbg, unit_typeb, Dwarf_Ubyte,
dataptr, sizeof(unit_typeb),error,end_data);
dataptr += sizeof(unit_typeb);
unit_type = unit_typeb;
/* We do not need is_info flag in DWARF5 */
if (is_unknown_UT_value(unit_type)) {
/* DWARF5 object file is corrupt. Invalid value */
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
"DW_DLE_CU_UT_TYPE_ERROR: we do not know "
" the CU header unit_type 0x%x",unit_type);
dwarfstring_append_printf_u(&m," (%u) so cannot"
"process this compilation_unit. A valid type ",
unit_type);
dwarfstring_append(&m,"would be DW_UT_compile"
", for example");
_dwarf_error_string(dbg, error,
DW_DLE_CU_UT_TYPE_ERROR,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
READ_UNALIGNED_CK(dbg, addrsize, unsigned char,
dataptr, sizeof(addrsize),error,end_data);
dataptr += sizeof(char);
READ_UNALIGNED_CK(dbg, abbrev_offset, Dwarf_Unsigned,
dataptr, offset_size,error,end_data);
dataptr += offset_size;
} else if (version == DW_CU_VERSION2 ||
version == DW_CU_VERSION3 ||
version == DW_CU_VERSION4) {
Dwarf_Unsigned herelen = sizeof(addrsize) + offset_size;
if ((dataptr+herelen) > end_data) {
_dwarf_error_string(dbg, error,
DW_DLE_CU_UT_TYPE_ERROR,
"DW_DLE_UT_TYPE_ERROR: "
" Reading the address size, "
"and abbrev_offset of the DWARF header"
" will run off the end of the section. "
"Corrupt DWARF");
}
/* DWARF2,3,4 */
READ_UNALIGNED_CK(dbg, abbrev_offset, Dwarf_Unsigned,
dataptr, offset_size,error,end_data);
dataptr += offset_size;
READ_UNALIGNED_CK(dbg, addrsize, Dwarf_Ubyte,
dataptr, sizeof(addrsize),error,end_data);
dataptr += sizeof(addrsize);
/* This is an initial approximation of unit_type.
For DW4 we will refine this after we
have built the CU header (by reading
CU_die)
*/
unit_type = is_info?DW_UT_compile:DW_UT_type;
} else {
_dwarf_error(dbg, error, DW_DLE_VERSION_STAMP_ERROR);
return DW_DLV_ERROR;
}
cu_context->cc_version_stamp = version;
cu_context->cc_unit_type = unit_type;
cu_context->cc_address_size = addrsize;
cu_context->cc_abbrev_offset = abbrev_offset;
if (!addrsize) {
_dwarf_error(dbg,error,DW_DLE_ADDRESS_SIZE_ZERO);
return DW_DLV_ERROR;
}
if (addrsize < MINIMUM_ADDRESS_SIZE ||
addrsize > MAXIMUM_ADDRESS_SIZE ) {
_dwarf_create_address_size_dwarf_error(dbg,error,addrsize,
DW_DLE_ADDRESS_SIZE_ERROR,
"DW_DLE_ADDRESS_SIZE_ERROR::");
return DW_DLV_ERROR;
}
if (addrsize > sizeof(Dwarf_Addr)) {
_dwarf_create_address_size_dwarf_error(dbg,error,addrsize,
DW_DLE_ADDRESS_SIZE_ERROR,
"DW_DLE_ADDRESS_SIZE_ERROR: not representable"
" in Dwarf_Addr field.");
return DW_DLV_ERROR;
}
/* We are ignoring this. Can get it from DWARF5. */
cu_context->cc_segment_selector_size = 0;
*bytes_read_out = (dataptr - data_start);
return DW_DLV_OK;
}
/* .debug_info[.dwo] .debug_types[.dwo]
the latter only DWARF4. */
static int
read_info_area_length_and_check(Dwarf_Debug dbg,
Dwarf_CU_Context cu_context,
Dwarf_Unsigned offset,
Dwarf_Byte_Ptr *cu_ptr_io,
Dwarf_Unsigned section_size,
Dwarf_Byte_Ptr section_end_ptr,
Dwarf_Unsigned *max_cu_global_offset_out,
Dwarf_Error *error)
{
Dwarf_Byte_Ptr cu_ptr = 0;
/* The following two will be either 0,4, or 8. */
Dwarf_Unsigned local_length_size = 0;
Dwarf_Unsigned local_extension_size = 0;
Dwarf_Unsigned max_cu_global_offset = 0;
Dwarf_Unsigned length = 0;
cu_ptr = *cu_ptr_io;
/* READ_AREA_LENGTH updates cu_ptr for consumed bytes */
READ_AREA_LENGTH_CK(dbg, length, Dwarf_Unsigned,
cu_ptr, local_length_size, local_extension_size,
error,section_size,section_end_ptr);
if (!length) {
return DW_DLV_NO_ENTRY;
}
/* ASSERT: The following is either 4 or 8. */
cu_context->cc_length_size = (Dwarf_Small)local_length_size;
/* ASSERT: The following is either 0 or 4. */
cu_context->cc_extension_size = (Dwarf_Small)local_extension_size;
cu_context->cc_length = length;
/* This is a bare minimum, not the real max offset.
A preliminary sanity check. */
max_cu_global_offset = offset + length +
local_extension_size + local_length_size;
if (length > section_size ||
(length+local_length_size + local_extension_size)>
section_size) {
_dwarf_error(dbg, error, DW_DLE_CU_LENGTH_ERROR);
return DW_DLV_ERROR;
}
if (max_cu_global_offset > section_size) {
_dwarf_error(dbg, error, DW_DLE_CU_LENGTH_ERROR);
return DW_DLV_ERROR;
}
*cu_ptr_io = cu_ptr;
*max_cu_global_offset_out = max_cu_global_offset;
return DW_DLV_OK;
}
/* In DWARF4 GNU dwp there is a problem.
We cannot read the CU die and it's
DW_AT_GNU_dwo_id until we know the
section offsets from the index files.
Hence we do not know how to search the
index files by key. So search by offset.
There is no such problem in DWARF5.
We have not yet corrected the unit_type so, for DWARF4,
we check for simpler unit types.
*/
static int
fill_in_dwp_offsets_if_present(Dwarf_Debug dbg,
Dwarf_CU_Context cu_context,
Dwarf_Sig8 * signaturedata,
Dwarf_Off offset,
Dwarf_Error *error)
{
Dwarf_Half unit_type = cu_context->cc_unit_type;
const char * typename = 0;
Dwarf_Half ver = cu_context->cc_version_stamp;
if (unit_type == DW_UT_split_type ||
(ver == DW_CU_VERSION4 && unit_type == DW_UT_type)){
typename = "tu";
if (!_dwarf_file_has_debug_fission_tu_index(dbg) ){
/* nothing to do. */
return DW_DLV_OK;
}
} else if (unit_type == DW_UT_split_compile ||
(ver == DW_CU_VERSION4 &&
unit_type == DW_UT_compile)){
typename = "cu";
if (!_dwarf_file_has_debug_fission_cu_index(dbg) ){
/* nothing to do. */
return DW_DLV_OK;
}
} else {
/* nothing to do. */
return DW_DLV_OK;
}
if (cu_context->cc_signature_present) {
int resdf = 0;
resdf = dwarf_get_debugfission_for_key(dbg,
signaturedata,
typename,
&cu_context->cc_dwp_offsets,
error);
if (resdf == DW_DLV_ERROR) {
return resdf;
}
if (resdf == DW_DLV_NO_ENTRY) {
_dwarf_error_string(dbg, error,
DW_DLE_MISSING_REQUIRED_CU_OFFSET_HASH,
"DW_DLE_MISSING_REQUIRED_CU_OFFSET_HASH: "
" dwarf_get_debugfission_for_key returned"
" DW_DLV_NO_ENTRY, something is wrong");
return DW_DLV_ERROR;
}
} else {
int resdf = 0;
resdf = _dwarf_get_debugfission_for_offset(dbg,
offset,
typename,
&cu_context->cc_dwp_offsets,
error);
if (resdf == DW_DLV_ERROR) {
return resdf;
}
if (resdf == DW_DLV_NO_ENTRY) {
_dwarf_error_string(dbg, error,
DW_DLE_MISSING_REQUIRED_CU_OFFSET_HASH,
"DW_DLE_MISSING_REQUIRED_CU_OFFSET_HASH: "
" dwarf_get_debugfission_for_offset returned"
" DW_DLV_NO_ENTRY, something is wrong");
return DW_DLV_ERROR;
}
cu_context->cc_signature =
cu_context->cc_dwp_offsets.pcu_hash;
cu_context->cc_signature_present = TRUE;
}
return DW_DLV_OK;
}
/* If returning DW_DLV_OK this will
push the cudie pointer back up through
local_cudie_return if local_cudie_return
is non-null. */
static int
finish_cu_context_via_cudie_inner(
Dwarf_Debug dbg,
Dwarf_CU_Context cu_context,
Dwarf_Die *local_cudie_return,
Dwarf_Error *error)
{
/* DW4: Look for DW_AT_dwo_id and
DW_AT_low_pc and more.
if there is one pick up the hash
DW5: hash in skeleton CU die
Also pick up cc_str_offset_base and
any other base values. */
Dwarf_Die cudie = 0;
int resdwo = 0;
/* Must call the internal siblingof so
we do not depend on the dbg...de_cu_context
used by and for dwarf_cu_header_* calls.
Safe because we know the correct cu_context. */
resdwo = _dwarf_siblingof_internal(dbg,NULL,
cu_context,
cu_context->cc_is_info,
&cudie, error);
if (resdwo == DW_DLV_OK) {
Dwarf_Half cutag = 0;
Dwarf_Bool bad_pc_form = FALSE;
int resdwob = 0;
resdwob = find_cu_die_base_fields(dbg,
cu_context,
cudie, &bad_pc_form,
error);
if (resdwob == DW_DLV_NO_ENTRY) {
/* The CU die has no children or has
some other issue like DW_FORM_ref_addr
on a low or high pc attribute. (Metrowerks) */
if (local_cudie_return) {
*local_cudie_return = cudie;
} else {
dwarf_dealloc_die(cudie);
}
if (!bad_pc_form) {
cu_context->cc_cu_die_has_children = FALSE;
}
return DW_DLV_OK;
}
if (resdwob == DW_DLV_ERROR) {
/* Not applicable or an error */
dwarf_dealloc_die(cudie);
cudie = 0;
return resdwob;
}
resdwob = dwarf_tag(cudie,&cutag,error);
if (resdwob == DW_DLV_OK) {
cu_context->cc_cu_die_tag = cutag;
}
if (local_cudie_return) {
*local_cudie_return = cudie;
} else {
dwarf_dealloc_die(cudie);
}
return resdwob;
}
if (resdwo == DW_DLV_NO_ENTRY) {
/* no cudie. Empty CU. */
return DW_DLV_OK;
}
/* no cudie. DW_DLV_ERROR.*/
return resdwo;
}
static void
local_dealloc_cu_context(Dwarf_Debug dbg,
Dwarf_CU_Context context)
{
Dwarf_Hash_Table hash_table = 0;
if (!context) {
return;
}
hash_table = context->cc_abbrev_hash_table;
if (hash_table) {
_dwarf_free_abbrev_hash_table_contents(hash_table,
FALSE);
hash_table->tb_entries = 0;
free(hash_table);
context->cc_abbrev_hash_table = 0;
}
dwarf_dealloc(dbg, context, DW_DLA_CU_CONTEXT);
}
static void
report_local_unit_type_error(Dwarf_Debug dbg,
int unit_type,
const char *msg,
Dwarf_Error *error)
{
dwarfstring m;
if (!error) {
return;
}
dwarfstring_constructor(&m);
dwarfstring_append_printf_s(&m,
"DW_DLE_CU_UT_TYPE_VALUE: %s ",(char *)msg);
dwarfstring_append_printf_u(&m,
"the compilation unit unit_type is 0x%x,"
" which is unknown to libdwarf. Corrupt DWARF.",
unit_type);
_dwarf_error_string(dbg,error,DW_DLE_CU_UT_TYPE_VALUE,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
}
/* This function is used to create a CU Context for
a compilation-unit that begins at offset in
.debug_info. The CU Context is attached to the
list of CU Contexts for this dbg. It is assumed
that the CU at offset has not been read before,
and so do not call this routine before making
sure of this with _dwarf_find_CU_Context().
Returns NULL on error. As always, being an
internal routine, assumes a good dbg.
The offset argument is global offset, the offset
in the section, irrespective of CUs.
The offset has the DWP Package File offset built in
as it comes from the actual section.
max_cu_local_offset is a local offset in this CU.
So zero of this field is immediately following the length
field of the CU header. so max_cu_local_offset is
identical to the CU length field.
max_cu_global_offset is the offset one-past the end
of this entire CU. */
static int
_dwarf_make_CU_Context(Dwarf_Debug dbg,
Dwarf_Off offset,Dwarf_Bool is_info,
Dwarf_CU_Context * context_out,Dwarf_Error * error)
{
Dwarf_CU_Context cu_context = 0;
Dwarf_Unsigned length = 0;
Dwarf_Unsigned typeoffset = 0;
Dwarf_Sig8 signaturedata;
Dwarf_Unsigned types_extra_len = 0;
Dwarf_Unsigned max_cu_local_offset = 0;
Dwarf_Unsigned max_cu_global_offset = 0;
Dwarf_Byte_Ptr cu_ptr = 0;
Dwarf_Byte_Ptr section_end_ptr = 0;
int local_length_size = 0;
Dwarf_Unsigned bytes_read = 0;
const char * secname = 0;
Dwarf_Debug_InfoTypes dis = 0;
struct Dwarf_Section_s * secdp = 0;
Dwarf_Unsigned section_size = 0;
Dwarf_Half unit_type = 0;
Dwarf_Unsigned version = 0;
Dwarf_Small * dataptr = 0;
int res = 0;
if (is_info) {
secname = dbg->de_debug_info.dss_name;
dis = &dbg->de_info_reading;
secdp = &dbg->de_debug_info;
} else {
secname = dbg->de_debug_types.dss_name;
dis = &dbg->de_types_reading;
secdp = &dbg->de_debug_types;
}
section_size = secdp->dss_size;
signaturedata = dwarfsig8zero;
cu_context =
(Dwarf_CU_Context)_dwarf_get_alloc(dbg, DW_DLA_CU_CONTEXT, 1);
if (!cu_context) {
_dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);
return DW_DLV_ERROR;
}
cu_context->cc_dbg = dbg;
cu_context->cc_is_info = is_info;
dataptr = is_info? dbg->de_debug_info.dss_data:
dbg->de_debug_types.dss_data;
/* Preliminary sanity checking. */
if (!dataptr) {
local_dealloc_cu_context(dbg,cu_context);
_dwarf_error(dbg, error, DW_DLE_INFO_HEADER_ERROR);
return DW_DLV_ERROR;
}
if (offset >= section_size) {
local_dealloc_cu_context(dbg,cu_context);
_dwarf_error(dbg, error, DW_DLE_INFO_HEADER_ERROR);
return DW_DLV_ERROR;
}
if ((offset+4) > section_size) {
local_dealloc_cu_context(dbg,cu_context);
_dwarf_error(dbg, error, DW_DLE_INFO_HEADER_ERROR);
return DW_DLV_ERROR;
}
section_end_ptr = dataptr+section_size;
cu_ptr = (Dwarf_Byte_Ptr) (dataptr+offset);
if (section_name_ends_with_dwo(secname)) {
cu_context->cc_is_dwo = TRUE;
}
res = read_info_area_length_and_check(dbg,
cu_context,
offset,
&cu_ptr,
section_size,
section_end_ptr,
&max_cu_global_offset,
error);
if (res != DW_DLV_OK) {
local_dealloc_cu_context(dbg,cu_context);
return res;
}
local_length_size = cu_context->cc_length_size;
length = cu_context->cc_length;
max_cu_local_offset = length;
res = _dwarf_read_cu_version_and_abbrev_offset(dbg,
cu_ptr,
is_info,
local_length_size,
cu_context,
section_end_ptr,
&bytes_read,error);
if (res != DW_DLV_OK) {
local_dealloc_cu_context(dbg,cu_context);
return res;
}
version = cu_context->cc_version_stamp;
cu_ptr += bytes_read;
unit_type = cu_context->cc_unit_type;
if (cu_ptr > section_end_ptr) {
local_dealloc_cu_context(dbg,cu_context);
_dwarf_error(dbg, error, DW_DLE_INFO_HEADER_ERROR);
return DW_DLV_ERROR;
}
/* In a dwp context, the abbrev_offset is
still incomplete.
We need to add in the base from the .debug_cu_index
or .debug_tu_index . Done below */
/* At this point, for DW4, the unit_type is not fully
correct as we don't know if it is a skeleton or
a split_compile or split_type */
if (version == DW_CU_VERSION5 ||
version == DW_CU_VERSION4) {
/* DW4/DW5 header fields, depending on UT type.
See DW5 section 7.5.1.x, DW4
data is a GNU extension of DW4. */
switch(unit_type) {
case DW_UT_split_type:
case DW_UT_type: {
types_extra_len = sizeof(Dwarf_Sig8) /* 8 */ +
local_length_size /*type_offset size*/;
break;
}
case DW_UT_skeleton:
case DW_UT_split_compile: {
types_extra_len = sizeof(Dwarf_Sig8) /* 8 */;
break;
}
case DW_UT_compile: /* No additional fields */
case DW_UT_partial: /* No additional fields */
break;
default:
/* Data corruption in libdwarf? */
report_local_unit_type_error(dbg, unit_type,
"(DW4 or DW5)",error);
local_dealloc_cu_context(dbg,cu_context);
return DW_DLV_ERROR;
}
}
/* Compare the space following the length field
to the bytes in the CU header. */
if (length <
(CU_VERSION_STAMP_SIZE /* is 2 */ +
local_length_size /*for debug_abbrev offset */ +
CU_ADDRESS_SIZE_SIZE /* is 1 */ +
/* and finally size of the rest of the header: */
types_extra_len)) {
local_dealloc_cu_context(dbg,cu_context);
_dwarf_error_string(dbg, error, DW_DLE_CU_LENGTH_ERROR,
"DW_DLE_CU_LENGTH_ERROR: reading version "
"stamp and address size fields");
return DW_DLV_ERROR;
}
/* Now we can read the fields with some confidence,
we know the fields of the header are inside
the section. */
cu_context->cc_unit_type = unit_type;
switch(unit_type) {
case DW_UT_split_type:
case DW_UT_type: {
int tres = 0;
/* ASSERT: DW_CU_VERSION4 or DW_CU_VERSION5,
determined by logic above.
Now read the debug_types extra header fields of
the signature (8 bytes) and the typeoffset.
This can be in executable, ordinary object
(as in Type Unit),
there was no dwo in DWARF4
*/
if ((cu_ptr + sizeof(signaturedata)) > section_end_ptr) {
_dwarf_error_string(dbg, error, DW_DLE_CU_LENGTH_ERROR,
"DW_DLE_CU_LENGTH_ERROR: reading "
"Dwarf_Sig8 signature field");
local_dealloc_cu_context(dbg,cu_context);
return DW_DLV_ERROR;
}
memcpy(&signaturedata,cu_ptr,sizeof(signaturedata));
cu_ptr += sizeof(signaturedata);
tres = _dwarf_read_unaligned_ck_wrapper(dbg,
&typeoffset,cu_ptr,local_length_size,
section_end_ptr,error);
if (tres != DW_DLV_OK ) {
local_dealloc_cu_context(dbg,cu_context);
return tres;
}
cu_context->cc_signature = signaturedata;
cu_context->cc_signature_present = TRUE;
cu_context->cc_signature_offset = typeoffset;
if (typeoffset >= max_cu_local_offset) {
local_dealloc_cu_context(dbg,cu_context);
_dwarf_error(dbg, error,
DW_DLE_DEBUG_TYPEOFFSET_BAD);
return DW_DLV_ERROR;
}
}
break;
case DW_UT_skeleton:
case DW_UT_split_compile: {
if ((cu_ptr + sizeof(signaturedata)) > section_end_ptr) {
_dwarf_error_string(dbg, error, DW_DLE_CU_LENGTH_ERROR,
"DW_DLE_CU_LENGTH_ERROR: reading "
"Dwarf_Sig8 signature field");
local_dealloc_cu_context(dbg,cu_context);
return DW_DLV_ERROR;
}
/* These unit types make a pair and
paired units have identical signature.*/
memcpy(&signaturedata,cu_ptr,sizeof(signaturedata));
cu_context->cc_signature = signaturedata;
cu_context->cc_signature_present = TRUE;
break;
}
/* The following with no additional fields */
case DW_UT_compile:
case DW_UT_partial:
break;
default: {
/* Data corruption in libdwarf? */
report_local_unit_type_error(dbg, unit_type,
"",error);
local_dealloc_cu_context(dbg,cu_context);
return DW_DLV_ERROR;
}
}
cu_context->cc_abbrev_hash_table =
(Dwarf_Hash_Table) calloc(1,
sizeof(struct Dwarf_Hash_Table_s));
if (!cu_context->cc_abbrev_hash_table) {
local_dealloc_cu_context(dbg,cu_context);
_dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);
return DW_DLV_ERROR;
}
cu_context->cc_debug_offset = offset;
/* This is recording an overall section value for later
sanity checking. */
dis->de_last_offset = max_cu_global_offset;
*context_out = cu_context;
return DW_DLV_OK;
}
static int
reloc_incomplete(int res,Dwarf_Error err)
{
Dwarf_Unsigned e = 0;
if (res == DW_DLV_OK) {
return FALSE;
}
if (res == DW_DLV_NO_ENTRY) {
return FALSE;
}
e = dwarf_errno(err);
switch(e) {
case DW_DLE_RELOC_MISMATCH_INDEX:
case DW_DLE_RELOC_MISMATCH_RELOC_INDEX:
case DW_DLE_RELOC_MISMATCH_STRTAB_INDEX:
case DW_DLE_RELOC_SECTION_MISMATCH:
case DW_DLE_RELOC_SECTION_MISSING_INDEX:
case DW_DLE_RELOC_SECTION_LENGTH_ODD:
case DW_DLE_RELOC_SECTION_PTR_NULL:
case DW_DLE_RELOC_SECTION_MALLOC_FAIL:
case DW_DLE_SEEK_OFF_END:
case DW_DLE_RELOC_INVALID:
case DW_DLE_RELOC_SECTION_SYMBOL_INDEX_BAD:
case DW_DLE_ELF_RELOC_SECTION_ERROR:
case DW_DLE_RELOCATION_SECTION_SIZE_ERROR:
return TRUE;
default: break;
}
return FALSE;
}
/* Returns offset of next compilation-unit thru next_cu_offset
pointer.
It sequentially moves from one
cu to the next. The current cu is recorded
internally by libdwarf. */
int
dwarf_next_cu_header_d(Dwarf_Debug dbg,
Dwarf_Bool is_info,
Dwarf_Unsigned * cu_header_length,
Dwarf_Half * version_stamp,
Dwarf_Unsigned * abbrev_offset,
Dwarf_Half * address_size,
Dwarf_Half * offset_size,
Dwarf_Half * extension_size,
Dwarf_Sig8 * signature,
Dwarf_Unsigned * typeoffset,
Dwarf_Unsigned * next_cu_offset,
Dwarf_Half * header_cu_type,
Dwarf_Error * error)
{
Dwarf_Bool has_signature = FALSE;
int res = 0;
res = _dwarf_next_cu_header_internal(dbg,
is_info,
NULL,
cu_header_length,
version_stamp,
abbrev_offset,
address_size,
offset_size,
extension_size,
signature,
&has_signature,
typeoffset,
next_cu_offset,
header_cu_type,
error);
return res;
}
int
dwarf_next_cu_header_e(Dwarf_Debug dbg,
Dwarf_Bool is_info,
Dwarf_Die * cu_die_out,
Dwarf_Unsigned * cu_header_length,
Dwarf_Half * version_stamp,
Dwarf_Unsigned * abbrev_offset,
Dwarf_Half * address_size,
Dwarf_Half * offset_size,
Dwarf_Half * extension_size,
Dwarf_Sig8 * signature,
Dwarf_Unsigned * typeoffset,
Dwarf_Unsigned * next_cu_offset,
Dwarf_Half * header_cu_type,
Dwarf_Error * error)
{
Dwarf_Bool has_signature = FALSE;
int res = 0;
res = _dwarf_next_cu_header_internal(dbg,
is_info,
cu_die_out,
cu_header_length,
version_stamp,
abbrev_offset,
address_size,
offset_size,
extension_size,
signature,
&has_signature,
typeoffset,
next_cu_offset,
header_cu_type,
error);
if (! dbg->de_debug_addr_version) {
/* To enable printing raw GNU extension .debug_addr */
dbg->de_debug_addr_version = (Dwarf_Half)*version_stamp;
dbg->de_debug_addr_offset_size = (Dwarf_Half)*offset_size;
dbg->de_debug_addr_address_size = (Dwarf_Half)*address_size;
}
return res;
}
static void
local_attrlist_dealloc(Dwarf_Debug dbg,
Dwarf_Signed atcount,
Dwarf_Attribute *alist)
{
Dwarf_Signed i = 0;
for ( ; i < atcount; ++i) {
dwarf_dealloc(dbg,alist[i],DW_DLA_ATTR);
}
dwarf_dealloc(dbg,alist,DW_DLA_LIST);
}
static int
_dwarf_setup_base_address(Dwarf_Debug dbg,
const char *attrname,
Dwarf_Attribute attr,
Dwarf_Signed at_addr_base_attrnum,
Dwarf_CU_Context cucon,
Dwarf_Bool *bad_pc_form,
Dwarf_Error *error)
{
int lres = 0;
Dwarf_Half form = 0;
/* If the form is indexed, we better have
seen DW_AT_addr_base.! */
lres = dwarf_whatform(attr,&form,error);
if (lres != DW_DLV_OK) {
return lres;
}
if (dwarf_addr_form_is_indexed(form)) {
if (at_addr_base_attrnum < 0) {
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append(&m,
"DW_DLE_ATTR_NO_CU_CONTEXT: The ");
dwarfstring_append(&m,(char *)attrname);
dwarfstring_append(&m," CU_DIE uses "
"an indexed attribute yet "
"DW_AT_addr_base is not in the CU DIE.");
_dwarf_error_string(dbg,error,
DW_DLE_ATTR_NO_CU_CONTEXT,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
}
if (form == DW_FORM_ref_addr) {
/* The old Macrowerks compiler did this
from confusion vs DW_FORM_addr.
Lets just say it is not good rather
than generating an error.
*/
*bad_pc_form = TRUE;
return DW_DLV_NO_ENTRY;
}
lres = dwarf_formaddr(attr,
&cucon->cc_low_pc,error);
if (lres == DW_DLV_OK) {
/* Pretending low_pc (ie cu base address for loclists)
if it was DW_AT_entry_pc with no DW_AT_low_pc
Allowing DW_AT_entry_pc */
cucon->cc_low_pc_present = TRUE;
cucon->cc_base_address_present = TRUE;
cucon->cc_base_address = cucon->cc_low_pc;
} else {
/* Something is badly wrong. */
return lres;
}
return lres;
}
static void
_dwarf_set_children_flag(Dwarf_CU_Context cucon,
Dwarf_Die cudie)
{
int chres = 0;
Dwarf_Half flag = 0;
/* always winds up with cc_cu_die_has_children
set intentionally...to something. */
cucon->cc_cu_die_has_children = TRUE;
chres = dwarf_die_abbrev_children_flag(cudie,&flag);
/* If chres is not DW_DLV_OK the assumption
of children remains TRUE. */
if (chres == DW_DLV_OK) {
cucon->cc_cu_die_has_children = flag;
}
}
static int
_dwarf_prod_contains(const char *ck, const char *prod)
{
const char *cp = prod;
size_t len = strlen(ck);
for (; *cp ; ++cp) {
if ( ck[0] != *cp) {
continue;
}
if (strncmp(ck,cp,len)) {
continue;
}
return TRUE;
}
return FALSE;
}
/* Here we make an effort to determine if it is
Metrowerks C */
static void
set_producer_type(Dwarf_Die die,
Dwarf_CU_Context cu_context)
{
int res = 0;
Dwarf_Error error = 0;
char *producer = 0;
res = dwarf_die_text(die,DW_AT_producer,&producer,&error);
if (res == DW_DLV_ERROR) {
dwarf_dealloc_error(cu_context->cc_dbg,error);
error = 0;
return;
}
if (res == DW_DLV_NO_ENTRY) {
return;
}
if (_dwarf_prod_contains("Metrowerks",producer)) {
cu_context->cc_producer = CC_PROD_METROWERKS;
} else if (_dwarf_prod_contains("Apple",producer)) {
cu_context->cc_producer = CC_PROD_Apple;
}
}
/*
For a DWP/DWO the base fields
of a CU are inherited from the skeleton.
DWARF5 section 3.1.3
"Split Full Compilation Unit Entries".
*/
static int
find_cu_die_base_fields(Dwarf_Debug dbg,
Dwarf_CU_Context cucon,
Dwarf_Die cudie,
Dwarf_Bool *bad_pc_form,
Dwarf_Error* error)
{
Dwarf_CU_Context cu_context = 0;
Dwarf_Attribute * alist = 0;
Dwarf_Signed atcount = 0;
unsigned version_stamp = 2;
int alres = 0;
Dwarf_Signed i = 0;
Dwarf_Signed low_pc_attrnum = -1;
Dwarf_Signed entry_pc_attrnum = -1;
Dwarf_Signed at_addr_base_attrnum = -1;
cu_context = cudie->di_cu_context;
version_stamp = cu_context->cc_version_stamp;
alres = dwarf_attrlist(cudie, &alist,
&atcount,error);
if (alres != DW_DLV_OK) {
/* Something is badly wrong. No attrlist! */
return alres;
}
/* DW_AT_dwo_id and/or DW_AT_GNU_dwo_id
are only found in some
experimental DWARF4.
Even DWARF3,4 use DW_AT_low_pc as base address
DWARF5 changed CU header contents
to make this attribute unnecessary.
DW_AT_GNU_odr_signature is the same format,
but is in a different namespace so not
appropriate here..
*/
for (i = 0; i < atcount; ++i) {
Dwarf_Half attrnum = 0;
Dwarf_Half form = 0;
int ares = 0;
int ares2 = 0;
Dwarf_Attribute attr = alist[i];
ares = dwarf_whatattr(attr,&attrnum,error);
if (ares == DW_DLV_ERROR && error) {
dwarf_dealloc_error(dbg,*error);
*error = 0;
}
ares2 = dwarf_whatform(attr,&form,error);
if (ares2 == DW_DLV_ERROR && error) {
dwarf_dealloc_error(dbg,*error);
*error = 0;
}
/* We are not returning on DW_DLV_NO_ENTRY
or DW_DLV_ERROR here. Such will be
caught later. Lets finish a CU die
scan and finish the cu_context */
if (ares == DW_DLV_OK && ares2 == DW_DLV_OK) {
switch(form) {
case DW_FORM_strx:
case DW_FORM_strx1:
case DW_FORM_strx2:
case DW_FORM_strx3:
case DW_FORM_strx4:
cucon->cc_at_strx_present = TRUE;
break;
default:
break;
}
switch(attrnum) {
case DW_AT_producer:
set_producer_type(cudie,cu_context);
break;
case DW_AT_dwo_id:
case DW_AT_GNU_dwo_id: {
Dwarf_Sig8 signature;
/* This is for DWARF4 with an early
non-standard version
of split dwarf. Not DWARF5. */
int sres = 0;
if (version_stamp != DW_CU_VERSION4 ) {
/* Not supposed to happen. */
local_attrlist_dealloc(dbg,atcount,alist);
_dwarf_error(dbg,error,
DW_DLE_IMPROPER_DWO_ID);
return DW_DLV_ERROR;
}
signature = dwarfsig8zero;
sres = dwarf_formsig8_const(attr,
&signature,error);
if (sres == DW_DLV_OK) {
if (!cucon->cc_signature_present) {
cucon->cc_signature = signature;
cucon->cc_signature_present = TRUE;
} else {
/* Something wrong. Two styles of sig?
Can happen with DWARF4
debug-fission extension DWO_id.
*/
if (memcmp(&signature,&cucon->cc_signature,
sizeof(signature))) {
/* The two sigs do not match! */
const char *m="DW_DLE_SIGNATURE_MISMATCH"
"DWARF4 extension fission signature"
" and DW_AT_GNU_dwo_id do not match"
" ignoring DW_AT[_GNU]_dwo_id";
dwarf_insert_harmless_error(dbg,
(char*)m);
}
}
} else {
/* Something is badly wrong. */
local_attrlist_dealloc(dbg,atcount,alist);
return sres;
}
/* Something is badly wrong. */
break;
}
/* If, in .debug_rnglists for a CU the
applicable range has no base address
this attribute provides a base address.
If this is indexed doing this now would
lead to an infinite recursion.
So wait till all the other fields seen.
*/
case DW_AT_low_pc: {
low_pc_attrnum = i;
break;
}
/* DW_AT_producer 4.2.1 (Based on Apple Inc. build 5658)
(LLVM build 2336.1.00) uses DW_AT_entry_pc as the
base address (DW_AT_entry_pc
first appears in DWARF3).
So we allow that as an extension,
as a 'low_pc' if there is DW_AT_entry_pc with
no DW_AT_low_pc. 19 May 2022.
*/
case DW_AT_entry_pc: {
entry_pc_attrnum = i;
break;
}
case DW_AT_ranges: {
Dwarf_Unsigned at_ranges_offset = 0;
int res = 0;
Dwarf_Bool is_info = cucon->cc_is_info;
res = _dwarf_internal_global_formref_b(attr,
/* avoid recurse creating context */ 1,
&at_ranges_offset,
&is_info,
error);
if (res == DW_DLV_OK) {
cucon->cc_at_ranges_offset = at_ranges_offset;
cucon->cc_at_ranges_offset_present = TRUE;
} else {
local_attrlist_dealloc(dbg,atcount,alist);
return res;
}
break;
}
/* The offset is of the first offset in
.debug_str_offsets that is the string table
offset array for this CU. */
case DW_AT_str_offsets_base:{
int udres = 0;
Dwarf_Bool is_info = cucon->cc_is_info;
udres = _dwarf_internal_global_formref_b(attr,
/* avoid recurse creating context */ 1,
&cucon->cc_str_offsets_array_offset,
&is_info,
error);
if (udres == DW_DLV_OK) {
cucon->cc_str_offsets_array_offset_present = TRUE;
} else {
local_attrlist_dealloc(dbg,atcount,alist);
/* Something is badly wrong. */
return udres;
}
break;
}
/* offset in .debug_loclists of the offsets table
applicable to this CU. */
case DW_AT_loclists_base: {
int udres = 0;
Dwarf_Bool is_info = cucon->cc_is_info;
udres = _dwarf_internal_global_formref_b(attr,
/* avoid recurse creating context */ 1,
&cucon->cc_loclists_base,
&is_info,
error);
if (udres == DW_DLV_OK) {
cucon->cc_loclists_base_present = TRUE;
cucon->cc_loclists_base_via_at = TRUE;
} else {
local_attrlist_dealloc(dbg,atcount,alist);
/* Something is badly wrong. */
return udres;
}
break;
}
/* Base offset in .debug_addr of the addr table
for this CU. DWARF5 (and possibly GNU DWARF4)
So we really want to look in only
this section, not an offset referring
to another (DWARF5 debug_info vs debug_types) */
case DW_AT_addr_base:
case DW_AT_GNU_addr_base: {
int udres = 0;
Dwarf_Bool is_info = cucon->cc_is_info;
at_addr_base_attrnum = i;
udres = _dwarf_internal_global_formref_b(attr,
/* avoid recurse creating context */ 1,
&cucon->cc_addr_base_offset,
&is_info,
error);
if (udres == DW_DLV_OK) {
if (is_info == cucon->cc_is_info) {
/* Only accept if same .debug section,
which is relevant for DWARF4 */
cucon->cc_addr_base_offset_present = TRUE;
}
} else {
local_attrlist_dealloc(dbg,atcount,alist);
/* Something is badly wrong. */
return udres;
}
break;
}
case DW_AT_GNU_ranges_base: {
/* The DW4 ranges base was never used in GNU
but did get emitted in skeletons.
http://llvm.1065342.n5.nabble.com/
DebugInfo-DW-AT-GNU-ranges-base-in-
non-fission-td64194.html
But we accept it anyway.
In dw4 GNU fission extension
it is used and matters.
offset in .debug_rnglists of the offsets table
applicable to this CU.
Or for DW4 GNU .debug_ranges split dwarf
it refers to .debug_ranges.
Note that this base applies when
referencing from the dwp, but NOT
when referencing from the a.out
In DW4 extension split dwarf the .debug_ranges
is always in the tied-file (executable). */
int udres = 0;
Dwarf_Bool is_info = cucon->cc_is_info;
udres = _dwarf_internal_global_formref_b(attr,
/* avoid recurse creating context */ 1,
&cucon->cc_ranges_base,
&is_info,
error);
if (udres == DW_DLV_OK) {
cucon->cc_ranges_base_present = TRUE;
} else {
local_attrlist_dealloc(dbg,atcount,alist);
/* Something is badly wrong. */
return udres;
}
break;
}
case DW_AT_rnglists_base: {
int udres = 0;
Dwarf_Bool is_info = cucon->cc_is_info;
udres = _dwarf_internal_global_formref_b(attr,
/* avoid recurse creating context */ 1,
&cucon->cc_rnglists_base,
&is_info,
error);
if (udres == DW_DLV_OK) {
cucon->cc_rnglists_base_present = TRUE;
cucon->cc_rnglists_base_via_at = TRUE;
} else {
local_attrlist_dealloc(dbg,atcount,alist);
/* Something is badly wrong. */
return udres;
}
break;
}
/* A signature, found in a DWARF5 skeleton
compilation unit. */
case DW_AT_GNU_dwo_name:
case DW_AT_dwo_name: {
int dnres = 0;
dnres = dwarf_formstring(attr,
&cucon->cc_dwo_name,error);
if (dnres != DW_DLV_OK) {
local_attrlist_dealloc(dbg,atcount,alist);
return dnres;
}
cucon->cc_dwo_name_present = TRUE;
break;
}
default: /* do nothing, not an attribute
we need to deal with here. */
break;
}
}
}
/* Only on Apple do we let entry_pc
be used as base address. */
if (entry_pc_attrnum >= 0 &&
cucon->cc_producer == CC_PROD_Apple) {
int battr = 0;
/* Pretending that DW_AT_entry_pc with no
DW_AT_low_pc is a valid base address for
location lists.
DW_AT_producer 4.2.1 (Based on Apple Inc. build 5658)
(LLVM build 2336.1.00) uses DW_AT_entry_pc as the
base address (DW_AT_entry_pc first appears in DWARF3).
So we allow that as an extension,
as a 'low_pc' if there is DW_AT_entry_pc with
no DW_AT_low_pc. 19 May 2022.
Also used by gcc with a DWARF4 split-dwarf extension. */
Dwarf_Attribute attr = alist[entry_pc_attrnum];
battr = _dwarf_setup_base_address(dbg,"DW_AT_entry_pc",
attr,at_addr_base_attrnum, cucon,
bad_pc_form,error);
if (battr != DW_DLV_OK) {
local_attrlist_dealloc(dbg,atcount,alist);
/* Something is wrong */
_dwarf_set_children_flag(cucon,cudie);
return battr;
}
}
if (low_pc_attrnum >= 0 ){
int battr = 0;
Dwarf_Attribute attr = alist[low_pc_attrnum];
battr = _dwarf_setup_base_address(dbg,"DW_AT_low_pc",
attr,at_addr_base_attrnum, cucon,
bad_pc_form,error);
if (battr != DW_DLV_OK) {
local_attrlist_dealloc(dbg,atcount,alist);
/* Something is wrong, possibly
erroneous Macrowerks compiler. */
_dwarf_set_children_flag(cucon,cudie);
return battr;
}
}
local_attrlist_dealloc(dbg,atcount,alist);
alist = 0;
atcount = 0;
_dwarf_set_children_flag(cucon,cudie);
return DW_DLV_OK;
}
/* Called only for DWARF4 and earlier
so there is consistent naming of unit_type
even though there was no such field in
DWARF2-DWARF4. */
static void
assign_correct_unit_type(Dwarf_CU_Context cu_context)
{
Dwarf_Half tag = cu_context->cc_cu_die_tag;
if (!cu_context->cc_cu_die_has_children) {
if (cu_context->cc_signature_present) {
if (tag == DW_TAG_compile_unit ||
tag == DW_TAG_type_unit ) {
cu_context->cc_unit_type = DW_UT_skeleton;
}
}
} else {
if (cu_context->cc_signature_present) {
if (tag == DW_TAG_compile_unit) {
cu_context->cc_unit_type = DW_UT_split_compile;
} else if (tag == DW_TAG_type_unit) {
cu_context->cc_unit_type = DW_UT_split_type;
}
}
}
}
/* If local_cudie_return non-null, and returning DW_DLV_OK,
then we return a valid CU_DIE through
local_cudie_return. */
static int
finish_up_cu_context_from_cudie(Dwarf_Debug dbg,
Dwarf_Unsigned offset,
Dwarf_CU_Context cu_context,
Dwarf_Die *cudie_return,
Dwarf_Error *error)
{
int version = cu_context->cc_version_stamp;
Dwarf_Sig8 signaturedata = cu_context->cc_signature;
int res = 0;
/* Loads and initializes the dwarf .debug_cu_index
and .debug_tu_index split dwarf package
file sections */
res = fill_in_dwp_offsets_if_present(dbg,
cu_context,
&signaturedata,
offset,
error);
if (res != DW_DLV_OK) {
return res;
}
if (cu_context->cc_dwp_offsets.pcu_type) {
Dwarf_Unsigned absize = 0;
Dwarf_Unsigned aboff = 0;
aboff = _dwarf_get_dwp_extra_offset(
&cu_context->cc_dwp_offsets,
DW_SECT_ABBREV, &absize);
cu_context->cc_abbrev_offset += aboff;
}
if (cu_context->cc_abbrev_offset >=
dbg->de_debug_abbrev.dss_size) {
_dwarf_error(dbg, error, DW_DLE_ABBREV_OFFSET_ERROR);
return DW_DLV_ERROR;
}
/* Now we can read the CU die and determine
the correct DW_UT_ type for DWARF4 and some
offset base fields for DW4-fission and DW5,
and even DW3 and DW4 and some non-std DW2 */
{
res = finish_cu_context_via_cudie_inner(dbg,
cu_context,cudie_return, error);
if (res == DW_DLV_ERROR) {
return res;
}
if (res != DW_DLV_OK) {
return res;
}
if (version == DW_CU_VERSION4) {
assign_correct_unit_type(cu_context);
}
if (cu_context->cc_signature_present) {
/* For finding base data from skeleton.
For the few fields inherited
(per the DWARF5 standard but for
.debug_rnglists is not interited
in spite of what DW5 says). */
res = _dwarf_find_all_offsets_via_fission(dbg,
cu_context,error);
if (res == DW_DLV_ERROR) {
/* something seriously wrong. */
return res;
}
}
}
return DW_DLV_OK;
}
/*
CU_Contexts do not overlap.
cu_context we see here is not in the list we
are updating. See _dwarf_find_CU_Context()
Invariant: cc_debug_offset in strictly
ascending order in the list.
Never returns DW_DLV_NO_ENTRY
*/
static int
insert_into_cu_context_list(Dwarf_Debug_InfoTypes dis,
Dwarf_CU_Context icu_context)
{
Dwarf_Unsigned ioffset = icu_context->cc_debug_offset;
Dwarf_Unsigned eoffset = 0;
Dwarf_Unsigned hoffset = 0;
Dwarf_Unsigned coffset = 0;
Dwarf_CU_Context next = 0;
Dwarf_CU_Context past = 0;
Dwarf_CU_Context cur = 0;
/* Add the context into the section context list.
This is the one and only place where it is
saved for re-use and eventual dealloc. */
if (!dis->de_cu_context_list) {
/* First cu encountered. */
dis->de_cu_context_list = icu_context;
dis->de_cu_context_list_end = icu_context;
return DW_DLV_OK;
}
if (!dis->de_cu_context_list_end) {
return DW_DLV_ERROR;
}
eoffset = dis->de_cu_context_list_end->cc_debug_offset;
if (eoffset < ioffset) {
/* Normal case, add at end. */
dis->de_cu_context_list_end->cc_next = icu_context;
dis->de_cu_context_list_end = icu_context;
return DW_DLV_OK;
}
hoffset = dis->de_cu_context_list->cc_debug_offset;
if (hoffset > ioffset) {
/* insert as new head. Unusual. */
next = dis->de_cu_context_list;
dis->de_cu_context_list = icu_context;
dis->de_cu_context_list->cc_next = next;
/* No need to touch de_cu_context_list_end */
return DW_DLV_OK;
}
cur = dis->de_cu_context_list;
past = 0;
/* Insert in middle somewhere. Neither at
start nor end.
ASSERT: cur non-null
ASSERT: past non-null */
past = cur;
cur = cur->cc_next;
for ( ; cur ; cur = next) {
next = cur->cc_next;
coffset = cur->cc_debug_offset;
if (coffset > ioffset) {
/* Insert before cur, using past.
ASSERT: past non-null */
past->cc_next = icu_context;
icu_context->cc_next = cur;
return DW_DLV_OK;
}
past = cur;
}
/* Impossible, for end, coffset (ie, eoffset) > ioffset */
/* NOTREACHED */
return DW_DLV_ERROR;
}
Dwarf_Unsigned
_dwarf_calculate_next_cu_context_offset(Dwarf_CU_Context cu_context)
{
Dwarf_Unsigned next_cu_offset = 0;
next_cu_offset = cu_context->cc_debug_offset +
cu_context->cc_length +
cu_context->cc_length_size +
cu_context->cc_extension_size;
return next_cu_offset;
}
/* If local_cudie_return non-null, and returning DW_DLV_OK,
then we return a valid CU_DIE through
local_cudie_return. */
int
_dwarf_create_a_new_cu_context_record_on_list(
Dwarf_Debug dbg,
Dwarf_Debug_InfoTypes dis,
Dwarf_Bool is_info,
Dwarf_Unsigned section_size,
Dwarf_Unsigned new_cu_offset,
Dwarf_CU_Context *context_out,
Dwarf_Die *cudie_return,
Dwarf_Error *error)
{
int res = 0;
Dwarf_CU_Context cu_context = 0;
int icres = 0;
if ((new_cu_offset +
_dwarf_length_of_cu_header_simple(dbg,is_info)) >=
section_size) {
_dwarf_error(dbg, error, DW_DLE_OFFSET_BAD);
return DW_DLV_ERROR;
}
res = _dwarf_make_CU_Context(dbg, new_cu_offset,is_info,
&cu_context,error);
if (res != DW_DLV_OK) {
return res;
}
/* The called func does not dealloc cu_context
in case of error, so we do it here. */
res = finish_up_cu_context_from_cudie(dbg,new_cu_offset,
cu_context,cudie_return,error);
if (res == DW_DLV_ERROR) {
local_dealloc_cu_context(dbg,cu_context);
return res;
}
if (res == DW_DLV_NO_ENTRY) {
local_dealloc_cu_context(dbg,cu_context);
return res;
}
/* Add the new cu_context to a list of contexts
Never returns DW_DLV_NO_ENTRY */
icres = insert_into_cu_context_list(dis,cu_context);
if (icres == DW_DLV_ERROR) {
/* Correcting ossfuzz70721 DW202407-010 */
dwarf_dealloc_die(*cudie_return);
*cudie_return = 0;
local_dealloc_cu_context(dbg,cu_context);
_dwarf_error_string(dbg,error,DW_DLE_DIE_NO_CU_CONTEXT,
"DW_DLE_DIE_NO_CU_CONTEXT"
"Impossible error inserting into internal context list");
return icres;
}
*context_out = cu_context;
return DW_DLV_OK;
}
int
_dwarf_load_die_containing_section(Dwarf_Debug dbg,
Dwarf_Bool is_info,
Dwarf_Error *error)
{
Dwarf_Error err2 = 0;
int resd = is_info?
_dwarf_load_debug_info(dbg, &err2):
_dwarf_load_debug_types(dbg,&err2);
if (resd == DW_DLV_ERROR) {
if (reloc_incomplete(resd,err2)) {
/* We will assume all is ok, though it is not.
Relocation errors need not be fatal. */
char msg_buf[300];
char *dwerrmsg = 0;
char *msgprefix =
"Relocations did not complete successfully, "
"but we are " " ignoring error: ";
size_t totallen = 0;
size_t prefixlen = 0;
dwerrmsg = dwarf_errmsg(err2);
prefixlen = strlen(msgprefix);
totallen = prefixlen + strlen(dwerrmsg);
if ( totallen >= sizeof(msg_buf)) {
const char *m= "Error:corrupted dwarf message table!";
/* Impossible unless something corrupted.
Provide a shorter dwerrmsg*/
_dwarf_safe_strcpy(msg_buf,sizeof(msg_buf),
m,strlen(m));
} else {
_dwarf_safe_strcpy(msg_buf,sizeof(msg_buf),
msgprefix,prefixlen);
_dwarf_safe_strcpy(msg_buf +prefixlen,
sizeof(msg_buf)-prefixlen,
dwerrmsg,strlen(dwerrmsg));
}
dwarf_insert_harmless_error(dbg,msg_buf);
/* Fall thru to use the newly loaded section.
even though it might not be adequately
relocated. */
dwarf_dealloc_error(dbg,err2);
if (error) {
*error = 0;
}
return DW_DLV_OK;
}
if (error) {
*error = err2;
} else {
dwarf_dealloc_error(dbg,err2);
}
return DW_DLV_ERROR;
}
return resd;
}
int
_dwarf_next_cu_header_internal(Dwarf_Debug dbg,
Dwarf_Bool is_info,
Dwarf_Die * cu_die_out,
Dwarf_Unsigned * cu_header_length,
Dwarf_Half * version_stamp,
Dwarf_Unsigned * abbrev_offset,
Dwarf_Half * address_size,
Dwarf_Half * offset_size,
Dwarf_Half * extension_size,
Dwarf_Sig8 * signature_out,
Dwarf_Bool * has_signature,
Dwarf_Unsigned *typeoffset,
Dwarf_Unsigned * next_cu_offset,
/* header_type: DW_UT_compile, DW_UT_partial,
DW_UT_type, returned through the pointer.
A new item in DWARF5, synthesized for earlier DWARF
CUs (& TUs). */
Dwarf_Half * header_type,
Dwarf_Error * error)
{
/* Offset for current and new CU. */
Dwarf_Unsigned new_offset = 0;
Dwarf_Die local_cudie = 0;
/* CU Context for current CU. */
Dwarf_CU_Context cu_context = 0;
Dwarf_Debug_InfoTypes dis = 0;
Dwarf_Unsigned section_size = 0;
Dwarf_Small *dataptr = 0;
struct Dwarf_Section_s *secdp = 0;
int res = 0;
/* ***** BEGIN CODE ***** */
CHECK_DBG(dbg,error,"dwarf_next_cuheader_[d,e]()");
if (is_info) {
dis =&dbg->de_info_reading;
dataptr = dbg->de_debug_info.dss_data;
secdp = &dbg->de_debug_info;
} else {
dis =&dbg->de_types_reading;
dataptr = dbg->de_debug_types.dss_data;
secdp = &dbg->de_debug_types;
}
if (!dataptr) {
res = _dwarf_load_die_containing_section(dbg,
is_info, error);
if (res != DW_DLV_OK) {
return res;
}
}
if (!dis->de_cu_context) {
/* We are leaving new_offset zero. We are at the
start of a section. */
new_offset = 0;
} else {
new_offset = _dwarf_calculate_next_cu_context_offset(
dis->de_cu_context);
}
/* Check that there is room in .debug_info beyond
the new offset for at least a new cu header.
If not, return DW_DLV_NO_ENTRY to indicate end
of debug_info section, and reset
de_cu_debug_info_offset to
enable looping back through the cu's. */
section_size = secdp->dss_size;
if ((new_offset +
_dwarf_length_of_cu_header_simple(dbg,is_info)) >=
section_size) {
/* We must reset as we will not create a proper
de_cu_context here, see comment just above. */
dis->de_cu_context = NULL;
return DW_DLV_NO_ENTRY;
}
/* Check if this CU has been read before. */
cu_context = _dwarf_find_CU_Context(dbg, new_offset,is_info);
/* If not, make CU Context for it. */
if (!cu_context) {
res = _dwarf_create_a_new_cu_context_record_on_list(
dbg,dis,is_info,section_size,new_offset,
&cu_context,&local_cudie,error);
if (res != DW_DLV_OK) {
return res;
}
}
/* Next assignment is what makes
_dwarf_next_cu_header_d()
with no offset presented work to march
through all the CUs in order. Other places
creating a cu_context do not set de_cu_context.
if callers use dwarf_next_cu_header_e() this
is unimportant but not harmful. */
dis->de_cu_context = cu_context;
if (cu_header_length) {
*cu_header_length = cu_context->cc_length;
}
if (version_stamp) {
*version_stamp = cu_context->cc_version_stamp;
}
if (abbrev_offset) {
*abbrev_offset = cu_context->cc_abbrev_offset;
}
if (address_size) {
*address_size = cu_context->cc_address_size;
}
if (offset_size) {
*offset_size = cu_context->cc_length_size;
}
if (extension_size) {
*extension_size = cu_context->cc_extension_size;
}
if (header_type) {
*header_type = cu_context->cc_unit_type;
}
if (typeoffset) {
*typeoffset = cu_context->cc_signature_offset;
}
if (signature_out) {
*signature_out = cu_context->cc_signature;
}
if (has_signature) {
*has_signature = cu_context->cc_signature_present;
}
/* Determine the offset of the next CU. */
new_offset = new_offset + cu_context->cc_length +
cu_context->cc_length_size + cu_context->cc_extension_size;
/* Allowing null argument starting 22 April 2019. */
if (next_cu_offset) {
*next_cu_offset = new_offset;
}
{
Dwarf_Debug tieddbg = 0;
int tres = DW_DLV_OK;
tieddbg = dbg->de_secondary_dbg;
if (DBG_IS_PRIMARY(dbg) && DBG_IS_SECONDARY(tieddbg)) {
/* We are in the main, merge tied
into main cu_context */
tres = _dwarf_merge_all_base_attrs_of_cu_die(
cu_context,
tieddbg,
0 /* we do not want the context returned */,
error);
} /* Else no merge */
if (tres == DW_DLV_ERROR && error) {
/* We'll assume any errors will be
discovered later. Lets get our
finished.
if error NULL it's a caller issue
and there is nothing we can do here */
dwarf_dealloc_error(dbg,*error);
*error = 0;
}
}
if (cu_die_out) {
if (!local_cudie) {
/* This is safe since we know the
correct cu_context */
res = _dwarf_siblingof_internal(dbg,NULL,
cu_context, is_info,&local_cudie,error);
if (res != DW_DLV_OK) {
return res;
}
*cu_die_out = local_cudie;
} else {
*cu_die_out = local_cudie;
}
} else {
if (local_cudie) {
dwarf_dealloc_die(local_cudie);
}
}
return DW_DLV_OK;
}
/* This involves data in a split dwarf or package file.
Given hash signature, return the CU_die of the applicable CU.
The hash is assumed to be from 'somewhere'.
For DWARF 4:
From a skeleton DIE DW_AT_GNU_dwo_id ("cu" case) or
From a DW_FORM_ref_sig8 ("tu" case).
For DWARF5:
From dwo_id in a skeleton CU header (DW_UT_skeleton).
From a DW_FORM_ref_sig8 ("tu" case).
If "tu" request, the CU_die
of of the type unit.
Works on either a dwp package file or a dwo object.
If "cu" request, the CU_die
of the compilation unit.
Works on either a dwp package file or a dwo object.
If the hash passed is not present, returns DW_DLV_NO_ENTRY
(but read the next two paragraphs for more detail).
If a dwp package file with the hash signature
is present in the applicable index but no matching
compilation unit can be found, it returns DW_DLV_ERROR.
If a .dwo object there is no index and we look at the
compilation units (possibly all of them). If not present
then we return DW_DLV_NO_ENTRY.
The returned_die is a CU DIE if the sig_type is "cu".
The returned_die is a type DIE if the sig_type is "tu".
Perhaps both should return CU die.
New 27 April, 2015
*/
int
dwarf_die_from_hash_signature(Dwarf_Debug dbg,
Dwarf_Sig8 * hash_sig,
const char * sig_type /* "tu" or "cu"*/,
Dwarf_Die * returned_die,
Dwarf_Error* error)
{
Dwarf_Bool is_type_unit = FALSE;
int sres = 0;
CHECK_DBG(dbg,error,"dwarf_die_from_hash_signature()");
sres = _dwarf_load_debug_info(dbg,error);
if (sres == DW_DLV_ERROR) {
return sres;
}
sres = _dwarf_load_debug_types(dbg,error);
if (sres == DW_DLV_ERROR) {
return sres;
}
if (!strcmp(sig_type,"tu")) {
is_type_unit = TRUE;
} else if (!strcmp(sig_type,"cu")) {
is_type_unit = FALSE;
} else {
_dwarf_error(dbg,error,DW_DLE_SIG_TYPE_WRONG_STRING);
return DW_DLV_ERROR;
}
if (_dwarf_file_has_debug_fission_index(dbg)) {
/* This is a dwp package file. */
int fisres = 0;
Dwarf_Bool is_info2 = TRUE;
Dwarf_Off cu_header_off = 0;
Dwarf_Off cu_size = 0;
Dwarf_Off cu_die_off = 0;
Dwarf_Off typeoffset = 0;
Dwarf_Die cudie = 0;
Dwarf_Die typedie = 0;
Dwarf_CU_Context context = 0;
Dwarf_Debug_Fission_Per_CU fiss;
memset(&fiss,0,sizeof(fiss));
fisres = dwarf_get_debugfission_for_key(dbg,hash_sig,
sig_type,&fiss,error);
if (fisres != DW_DLV_OK) {
return fisres;
}
/* Found it */
if (is_type_unit) {
/* DW4 has debug_types, so look in .debug_types
Else look in .debug_info. */
is_info2 = dbg->de_debug_types.dss_size?FALSE:TRUE;
} else {
is_info2 = TRUE;
}
cu_header_off = _dwarf_get_dwp_extra_offset(&fiss,
is_info2?DW_SECT_INFO:DW_SECT_TYPES,
&cu_size);
fisres = dwarf_get_cu_die_offset_given_cu_header_offset_b(
dbg,cu_header_off,
is_info2,
&cu_die_off,error);
if (fisres != DW_DLV_OK) {
return fisres;
}
fisres = dwarf_offdie_b(dbg,cu_die_off,is_info2,
&cudie,error);
if (fisres != DW_DLV_OK) {
return fisres;
}
if (!is_type_unit) {
*returned_die = cudie;
return DW_DLV_OK;
}
context = cudie->di_cu_context;
typeoffset = context->cc_signature_offset;
typeoffset += cu_header_off;
fisres = dwarf_offdie_b(dbg,typeoffset,is_info2,
&typedie,error);
if (fisres != DW_DLV_OK) {
dwarf_dealloc(dbg,cudie,DW_DLA_DIE);
return fisres;
}
*returned_die = typedie;
dwarf_dealloc(dbg,cudie,DW_DLA_DIE);
return DW_DLV_OK;
}
/* Look thru all the CUs, there is no DWP tu/cu index.
There will be COMDAT sections for the type TUs
(DW_UT_type).
A single non-comdat for the DW_UT_compile. */
/* FIXME: DW_DLE_DEBUG_FISSION_INCOMPLETE */
_dwarf_error(dbg,error,DW_DLE_DEBUG_FISSION_INCOMPLETE);
return DW_DLV_ERROR;
}
static int
_dwarf_ptr_CU_offset(Dwarf_CU_Context cu_context,
Dwarf_Byte_Ptr di_ptr,
Dwarf_Bool is_info,
Dwarf_Off * cu_off)
{
Dwarf_Debug dbg = cu_context->cc_dbg;
Dwarf_Small *dataptr = is_info? dbg->de_debug_info.dss_data:
dbg->de_debug_types.dss_data;
*cu_off = (di_ptr - dataptr);
return DW_DLV_OK;
}
#if 0 /* print_sib_offset() for debugging */
/* Just for debug purposes */
void print_sib_offset(Dwarf_Die sibling)
{
Dwarf_Off sib_off;
Dwarf_Error error;
dwarf_dieoffset(sibling,&sib_off,&error);
fprintf(stderr," SIB OFF = 0x%" DW_PR_XZEROS DW_PR_DUx,sib_off);
}
void print_ptr_offset(Dwarf_CU_Context cu_context,
Dwarf_Byte_Ptr di_ptr)
{
Dwarf_Off ptr_off;
_dwarf_ptr_CU_offset(cu_context,di_ptr,
di_ptr->di_is_info,&ptr_off);
fprintf(stderr," PTR OFF = 0x%" DW_PR_XZEROS DW_PR_DUx,ptr_off);
}
#endif /*0*/
/* Validate the sibling DIE. This only makes sense to call
if the sibling's DIEs have been travsersed and
dwarf_child() called on each,
so that the last DIE dwarf_child saw was the last.
Essentially ensuring that (after such traversal) that we
are in the same place a sibling attribute would identify.
In case we return DW_DLV_ERROR, the global offset of the last
DIE traversed by dwarf_child is returned through *offset
It is essentially guaranteed that dbg->de_last_die
is a stale DIE pointer of a deallocated DIE when we get here.
It must not be used as a DIE pointer here,
just as a sort of anonymous pointer that we just check against
NULL.
There is a (subtle?) dependence on the fact that when we
call this the last dwarf_child() call would have been for
this sibling.
Meaning that this works in a depth-first
traversal even though there
is no stack of 'de_last_die' values.
The check for dbg->de_last_die just ensures sanity.
If one is switching between normal debug_frame and eh_frame
(traversing them in tandem, let us say) in a single
Dwarf_Debug this validator makes no sense.
It works if one processes a .debug_frame (entirely) and
then an eh_frame (or vice versa) though.
Use caution.
*/
int
dwarf_validate_die_sibling(Dwarf_Die sibling,Dwarf_Off *offset)
{
Dwarf_Debug dbg = 0;
Dwarf_Error *error = 0;
Dwarf_Debug_InfoTypes dis = 0;
CHECK_DIE(sibling, DW_DLV_ERROR);
dbg = sibling->di_cu_context->cc_dbg;
dis = sibling->di_is_info?
&dbg->de_info_reading: &dbg->de_types_reading;
*offset = 0;
if (dis->de_last_die && dis->de_last_di_ptr) {
if (sibling->di_debug_ptr == dis->de_last_di_ptr) {
return DW_DLV_OK;
}
}
/* Calculate global offset used for error reporting */
_dwarf_ptr_CU_offset(sibling->di_cu_context,
dis->de_last_di_ptr,sibling->di_is_info,offset);
return DW_DLV_ERROR;
}
/* This function does two slightly different things
depending on the input flag want_AT_sibling. If
this flag is TRUE, it checks if the input die has
a DW_AT_sibling attribute. If it does it returns
a pointer to the start of the sibling die in the
.debug_info section. Otherwise it behaves the
same as the want_AT_sibling FALSE case.
If the want_AT_sibling flag is FALSE, it returns
a pointer to the immediately adjacent die in the
.debug_info section.
Die_info_end points to the end of the .debug_info
portion for the cu the die belongs to. It is used
to check that the search for the next die does not
cross the end of the current cu. Cu_info_start points
to the start of the .debug_info portion for the
current cu, and is used to add to the offset for
DW_AT_sibling attributes. Finally, has_die_child
is a pointer to a Dwarf_Bool that is set TRUE if
the present die has children, FALSE otherwise.
However, in case want_AT_child is TRUE and the die
has a DW_AT_sibling attribute *has_die_child is set
FALSE to indicate that the children are being skipped.
die_info_end points to the last byte+1 of the cu. */
static int
_dwarf_next_die_info_ptr(Dwarf_Byte_Ptr die_info_ptr,
Dwarf_CU_Context cu_context,
Dwarf_Byte_Ptr die_info_end,
Dwarf_Byte_Ptr cu_info_start,
Dwarf_Bool want_AT_sibling,
Dwarf_Bool * has_die_child,
Dwarf_Byte_Ptr *next_die_ptr_out,
Dwarf_Error *error)
{
Dwarf_Byte_Ptr info_ptr = 0;
Dwarf_Byte_Ptr abbrev_ptr = 0;
Dwarf_Unsigned abbrev_code = 0;
Dwarf_Abbrev_List abbrev_list = 0;
Dwarf_Unsigned offset = 0;
Dwarf_Unsigned utmp = 0;
Dwarf_Debug dbg = 0;
Dwarf_Byte_Ptr abbrev_end = 0;
int lres = 0;
Dwarf_Unsigned i = 0;
Dwarf_Unsigned highest_code = 0;
dbg = cu_context->cc_dbg;
info_ptr = die_info_ptr;
DECODE_LEB128_UWORD_CK(info_ptr, utmp,dbg,error,die_info_end);
abbrev_code = (Dwarf_Unsigned) utmp;
if (abbrev_code == 0) {
/* Should never happen. Tested before we got here. */
_dwarf_error(dbg, error, DW_DLE_NEXT_DIE_PTR_NULL);
return DW_DLV_ERROR;
}
lres = _dwarf_get_abbrev_for_code(cu_context, abbrev_code,
&abbrev_list,&highest_code,error);
if (lres == DW_DLV_ERROR) {
return lres;
}
if (lres == DW_DLV_NO_ENTRY) {
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
" DW_DLE_NEXT_DIE_NO_ABBREV_LIST "
"There is no abbrev present for code %u"
" in this compilation unit. ",
abbrev_code);
dwarfstring_append_printf_u(&m,
"The highest known code in any "
"compilation unit is %u.",
highest_code);
_dwarf_error_string(dbg, error,
DW_DLE_NEXT_DIE_NO_ABBREV_LIST,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
*has_die_child = abbrev_list->abl_has_child;
abbrev_ptr = abbrev_list->abl_abbrev_ptr;
abbrev_end = _dwarf_calculate_abbrev_section_end_ptr(cu_context);
if (!abbrev_list->abl_attr) {
int bres = 0;
bres = _dwarf_fill_in_attr_form_abtable(cu_context,
abbrev_ptr, abbrev_end, abbrev_list,
error);
if (bres != DW_DLV_OK) {
return bres;
}
}
/* ASSERT list->abl_addr and list->abl_form
are non-null and if list->abl_implicit_const_count > 0
list->abl_implicit_const is non-null. */
for ( i = 0; i <abbrev_list->abl_abbrev_count; ++i) {
/* Dwarf_Signed implicit_const = 0; */
Dwarf_Half attr = 0;
Dwarf_Half attr_form = 0;
int res = 0;
Dwarf_Byte_Ptr next_die_ptr = 0;
attr = abbrev_list->abl_attr[i];
attr_form = abbrev_list->abl_form[i];
if (attr_form == DW_FORM_implicit_const) {
/* implicit_const = abbrev_list->abl_implicit_const[i];*/
} else if (attr_form == DW_FORM_indirect) {
Dwarf_Unsigned utmp6;
/* DECODE_LEB128_UWORD updates info_ptr */
DECODE_LEB128_UWORD_CK(info_ptr, utmp6,dbg,error,
die_info_end);
attr_form = (Dwarf_Half) utmp6;
if (attr_form == DW_FORM_implicit_const ||
attr_form == DW_FORM_indirect) {
_dwarf_error_string(dbg, error,
DW_DLE_NEXT_DIE_WRONG_FORM,
"DW_DLE_NEXT_DIE_WRONG_FORM: "
" Reading Attriutes: an indirect "
" or implicit_const form "
"leads to one of the same. "
"Which is not handled. Corrupt Dwarf");
return DW_DLV_ERROR;
}
}
if (attr_form == DW_FORM_implicit_const) {
SKIP_LEB128_CK(abbrev_ptr,dbg,error, abbrev_end);
}
if (want_AT_sibling && attr == DW_AT_sibling) {
switch (attr_form) {
case DW_FORM_ref1:
READ_UNALIGNED_CK(dbg, offset, Dwarf_Unsigned,
info_ptr, sizeof(Dwarf_Small),
error,die_info_end);
break;
case DW_FORM_ref2:
/* READ_UNALIGNED does not update info_ptr */
READ_UNALIGNED_CK(dbg, offset, Dwarf_Unsigned,
info_ptr,DWARF_HALF_SIZE,
error,die_info_end);
break;
case DW_FORM_ref4:
READ_UNALIGNED_CK(dbg, offset, Dwarf_Unsigned,
info_ptr, DWARF_32BIT_SIZE,
error,die_info_end);
break;
case DW_FORM_ref8:
READ_UNALIGNED_CK(dbg, offset, Dwarf_Unsigned,
info_ptr, DWARF_64BIT_SIZE,
error,die_info_end);
break;
case DW_FORM_ref_udata:
DECODE_LEB128_UWORD_CK(info_ptr, offset,
dbg,error,die_info_end);
break;
case DW_FORM_ref_addr:
/* Very unusual. The FORM is intended to refer to
a different CU, but a different CU cannot
be a sibling, can it?
We could ignore this and treat as if no
DW_AT_sibling
present. Or derive the offset from it and if
it is in the same CU use it directly.
The offset here is *supposed* to be a
global offset,
so adding cu_info_start is wrong to any offset
we find here unless cu_info_start
is zero! Lets pretend there is no DW_AT_sibling
attribute. */
goto no_sibling_attr;
default:
_dwarf_error(dbg, error, DW_DLE_NEXT_DIE_WRONG_FORM);
return DW_DLV_ERROR;
}
/* Reset *has_die_child to indicate children skipped. */
*has_die_child = FALSE;
/* A value beyond die_info_end indicates an error.
Exactly at die_info_end means 1-past-cu-end
and simply means we
are at the end, do not return error. Higher level
will detect that we are at the end. */
{ /* Care required here. Offset can be garbage. */
Dwarf_Unsigned plen = 0;
/* ptrdiff_t is generated but not named */
plen = (die_info_end >= cu_info_start)?
(die_info_end - cu_info_start):0;
if (offset > plen) {
/* Error case, bad DWARF. */
_dwarf_error_string(dbg, error,
DW_DLE_SIBLING_OFFSET_WRONG,
"DW_DLE_SIBLING_OFFSET_WRONG "
"the offset makes the new die ptr "
"off the end of the section. Corrupt dwarf");
return DW_DLV_ERROR;
}
}
/* At or before end-of-cu */
next_die_ptr = cu_info_start + offset;
if (next_die_ptr <= die_info_ptr) {
/* This is a fix for ossfuzz 57562 */
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
"DW_DLE_SIBLING_OFFSET_WRONG "
"the DW_AT_sibling offset (%u) puts "
"the sibling DIE ptr "
"equal to or less then the current DIE ptr. "
"Corrupt dwarf",offset);
_dwarf_error_string(dbg, error,
DW_DLE_SIBLING_OFFSET_WRONG,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
*next_die_ptr_out = next_die_ptr;
return DW_DLV_OK;
}
no_sibling_attr:
if (attr_form != 0 && attr_form != DW_FORM_implicit_const) {
Dwarf_Unsigned sizeofval = 0;
Dwarf_Unsigned ssize = 0;
res = _dwarf_get_size_of_val(cu_context->cc_dbg,
attr_form,
cu_context->cc_version_stamp,
cu_context->cc_address_size,
info_ptr,
cu_context->cc_length_size,
&sizeofval,
die_info_end,
error);
if (res != DW_DLV_OK) {
return res;
}
/* It is ok for info_ptr == die_info_end, as we
will test later before using a too-large info_ptr */
/* ptrdiff_t is generated but not named */
ssize = (die_info_end >= info_ptr)?
(die_info_end - info_ptr): 0;
if (sizeofval > ssize) {
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
"DW_DLE_NEXT_DIE_PAST_END:"
" the DIE value just checked is %u"
" bytes long, and that would extend"
" past the end of the section.",
sizeofval);
_dwarf_error_string(dbg, error,
DW_DLE_NEXT_DIE_PAST_END,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
info_ptr += sizeofval;
if (info_ptr > die_info_end) {
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
"DW_DLE_NEXT_DIE_PAST_END:"
" the DIE value just checked is %u"
" bytes long, and puts us past"
" the end of the section",
sizeofval);
dwarfstring_append_printf_u(&m,
" which is 0x%x",
(Dwarf_Unsigned)(uintptr_t)die_info_end);
_dwarf_error_string(dbg, error,
DW_DLE_NEXT_DIE_PAST_END,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
/* More than one-past-end indicates a bug somewhere,
likely bad dwarf generation. */
return DW_DLV_ERROR;
}
}
}
*next_die_ptr_out = info_ptr;
return DW_DLV_OK;
}
/* Multiple TAGs are in fact compile units.
Allow them all.
Return non-zero if a CU tag.
Else return 0.
*/
static int
is_cu_tag(int t)
{
if (t == DW_TAG_compile_unit ||
t == DW_TAG_partial_unit ||
t == DW_TAG_skeleton_unit ||
t == DW_TAG_type_unit) {
return 1;
}
return 0;
}
/* Given a Dwarf_Debug dbg, and a Dwarf_Die die, it returns
a Dwarf_Die for the sibling of die. In case die is NULL,
it returns (thru ptr) a Dwarf_Die for the first die in the current
cu in dbg. Returns DW_DLV_ERROR on error.
It is assumed that every sibling chain including those with
only one element is terminated with a NULL die, except a
chain with only a NULL die.
The algorithm moves from one die to the adjacent one. It
returns when the depth of children it sees equals the number
of sibling chain terminations. A single count, child_depth
is used to track the depth of children and sibling terminations
encountered. Child_depth is incremented when a die has the
Has-Child flag set unless the child happens to be a NULL die.
Child_depth is decremented when a die has Has-Child FALSE,
and the adjacent die is NULL. Algorithm returns when
child_depth is 0.
**NOTE: Do not modify input die, since it is used at the end.
* This is the correct form. On calling with 'die' NULL,
we cannot tell if this is debug_info or debug_types, so
we must be informed!. */
int
dwarf_siblingof_b(Dwarf_Debug dbg,
Dwarf_Die die,
Dwarf_Bool is_info,
Dwarf_Die *caller_ret_die,
Dwarf_Error *error)
{
int res = 0;
Dwarf_CU_Context context = 0;
CHECK_DBG(dbg,error,"dwarf_siblingof_b()");
if (die) {
CHECK_DIE(die,DW_DLV_ERROR);
context = die->di_cu_context;
/* Ignore is_info passed-in, we have the correct
value in cu_context. */
is_info = die->di_cu_context->cc_is_info;
} else {
/* This is the pre-0.9.0 way, and is assuming
that the 'dis' has the correct cu context.
Which might not be TRUE if a caller
used dwarf_next_cu_header_d() twice in a
row before calling dwarf_siblingof_b().
Use dwarf_next_cu_header_e() instead of
dwarf_next_cu_header_d() */
context = is_info? dbg->de_info_reading.de_cu_context:
dbg->de_types_reading.de_cu_context;
}
res = _dwarf_siblingof_internal(dbg,die,
context, is_info,caller_ret_die,error);
return res;
}
int
dwarf_siblingof_c(Dwarf_Die die,
Dwarf_Die * caller_ret_die, Dwarf_Error * error)
{
int res = 0;
Dwarf_Debug dbg = 0;
Dwarf_Bool is_info = FALSE;
CHECK_DIE(die,DW_DLV_ERROR);
dbg = die->di_cu_context->cc_dbg;
is_info = die->di_cu_context->cc_is_info;
res = _dwarf_siblingof_internal(dbg,die,
die->di_cu_context, is_info,
caller_ret_die,error);
return res;
}
static int
dw_start_load_root_die(Dwarf_Debug dbg,
Dwarf_CU_Context context,
Dwarf_Bool is_info,
Dwarf_Small *dataptr,
Dwarf_Byte_Ptr *die_info_ptr,
Dwarf_Byte_Ptr *die_info_end,
Dwarf_Error *error)
{
/* Find root die of cu */
/* die_info_end is untouched here, need not be set in this
branch. */
Dwarf_Off off2 = 0;
Dwarf_Unsigned headerlen = 0;
Dwarf_Byte_Ptr cu_info_start = 0;
int cres = 0;
/* If we've not loaded debug_info
context will be NULL. */
if (!context) {
local_dealloc_cu_context(dbg,context);
_dwarf_error_string(dbg,error,
DW_DLE_DBG_NO_CU_CONTEXT,
"DW_DLE_DBG_NO_CU_CONTEXT:"
" Setting up a new CU failed loading root die");
return DW_DLV_ERROR;
}
off2 = context->cc_debug_offset;
cu_info_start = dataptr + off2;
cres = _dwarf_length_of_cu_header(dbg, off2,is_info,
&headerlen,error);
if (cres != DW_DLV_OK) {
return cres;
}
*die_info_ptr = cu_info_start + headerlen;
*die_info_end = _dwarf_calculate_info_section_end_ptr(context);
/* Recording the CU die pointer so we can later access
for special FORMs relating to .debug_str_offsets
and .debug_addr */
context->cc_cu_die_offset_present = TRUE;
context->cc_cu_die_global_sec_offset = off2 + headerlen;
return DW_DLV_OK;
}
static int
_dwarf_siblingof_internal(Dwarf_Debug dbg,
Dwarf_Die die,
Dwarf_CU_Context context,
Dwarf_Bool is_info,
Dwarf_Die * caller_ret_die, Dwarf_Error * error)
{
Dwarf_Die ret_die = 0;
Dwarf_Byte_Ptr die_info_ptr = 0;
Dwarf_Byte_Ptr cu_info_start = 0;
/* die_info_end points 1-past end of die (once set) */
Dwarf_Byte_Ptr die_info_end = 0;
Dwarf_Unsigned abbrev_code = 0;
Dwarf_Unsigned utmp = 0;
Dwarf_Unsigned highest_code = 0;
int lres = 0;
int dieres = 0;
/* Since die may be NULL, we rely on the input argument. */
Dwarf_Small *dataptr = 0;
if (IS_INVALID_DBG(dbg)) {
_dwarf_error(NULL, error, DW_DLE_DBG_NULL);
return DW_DLV_ERROR;
}
dataptr = is_info? dbg->de_debug_info.dss_data:
dbg->de_debug_types.dss_data;
if (!dataptr) {
return DW_DLV_NO_ENTRY;
}
if (!die) {
dieres = dw_start_load_root_die(dbg,context,is_info,
dataptr,&die_info_ptr,&die_info_end,error);
if (dieres != DW_DLV_OK) {
return dieres;
}
} else {
/* Find sibling die. */
Dwarf_Bool has_child = FALSE;
Dwarf_Signed child_depth = 0;
/* We cannot have a legal die unless debug_info
was loaded, so
no need to load debug_info here. */
CHECK_DIE(die, DW_DLV_ERROR);
die_info_ptr = die->di_debug_ptr;
if (*die_info_ptr == 0) {
return DW_DLV_NO_ENTRY;
}
context = die->di_cu_context;
cu_info_start = dataptr+ context->cc_debug_offset;
die_info_end = _dwarf_calculate_info_section_end_ptr(context);
if ((*die_info_ptr) == 0) {
return DW_DLV_NO_ENTRY;
}
child_depth = 0;
do {
int res2 = 0;
Dwarf_Byte_Ptr die_info_ptr2 = 0;
res2 = _dwarf_next_die_info_ptr(die_info_ptr,
context, die_info_end,
cu_info_start, TRUE, &has_child,
&die_info_ptr2,
error);
if (res2 != DW_DLV_OK) {
return res2;
}
if (die_info_ptr2 == die_info_ptr) {
/* There is something very wrong, our die value
unchanged. Bad DWARF. */
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
"DW_DLE_NEXT_DIE_LOW_ERROR: "
"Somehow the next die pointer 0x%x",
(Dwarf_Unsigned)(uintptr_t)die_info_ptr2);
dwarfstring_append_printf_u(&m,
" points before the current die "
"pointer 0x%x so an "
"overflow of some sort happened",
(Dwarf_Unsigned)(uintptr_t)die_info_ptr);
_dwarf_error_string(dbg, error,
DW_DLE_NEXT_DIE_LOW_ERROR,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
if (die_info_ptr2 < die_info_ptr) {
/* There is something very wrong, our die value
decreased. Bad DWARF. */
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
"DW_DLE_NEXT_DIE_LOW_ERROR: "
"Somehow the next die pointer 0x%x",
(Dwarf_Unsigned)(uintptr_t)die_info_ptr2);
dwarfstring_append_printf_u(&m,
" points before the current die "
"pointer 0x%x so an "
"overflow of some sort happened",
(Dwarf_Unsigned)(uintptr_t)die_info_ptr);
_dwarf_error_string(dbg, error,
DW_DLE_NEXT_DIE_LOW_ERROR,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
if (die_info_ptr2 > die_info_end) {
dwarfstring m;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
"DW_DLE_NEXT_DIE_PAST_END: "
"the next DIE at 0x%x",
(Dwarf_Unsigned)(uintptr_t)die_info_ptr2);
dwarfstring_append_printf_u(&m,
" would be past "
" the end of the section (0x%x),"
" which is an error.",
(Dwarf_Unsigned)(uintptr_t)die_info_end);
_dwarf_error_string(dbg, error,
DW_DLE_NEXT_DIE_PAST_END,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
die_info_ptr = die_info_ptr2;
/* die_info_end is one past end. Do not read it!
A test for '!= die_info_end' would work as well,
but perhaps < reads more like the meaning. */
if (die_info_ptr < die_info_end) {
if ((*die_info_ptr) == 0 && has_child) {
die_info_ptr++;
has_child = FALSE;
}
}
/* die_info_ptr can be one-past-end. */
if ((die_info_ptr == die_info_end) ||
((*die_info_ptr) == 0)) {
/* We are at the end of a sibling list.
get back to the next containing
sibling list (looking for a libling
list with more on it).
*/
for (;;) {
if (child_depth == 0) {
/* Meaning there is no outer list,
so stop. */
break;
}
if (die_info_ptr == die_info_end) {
/* September 2016: do not deref
if we are past end.
If we are at end at this point
it means the sibling list
inside this CU is not properly
terminated.
August 2019:
We used to declare an error,
DW_DLE_SIBLING_LIST_IMPROPER but
now we just silently
declare this is the end of the list.
Each level of a sibling nest should
have a single NUL byte, but here
things are wrong, the DWARF
is corrupt. */
return DW_DLV_NO_ENTRY;
}
if (*die_info_ptr) {
/* We have a real sibling. */
break;
}
/* Move out one DIE level.
Move past NUL byte marking end of
this sibling list. */
child_depth--;
die_info_ptr++;
}
} else {
child_depth = has_child ?
child_depth + 1 : child_depth;
}
} while (child_depth != 0);
}
/* die_info_ptr > die_info_end is really a bug (possibly in dwarf
generation)(but we are past end, no more DIEs here), whereas
die_info_ptr == die_info_end means 'one past end, no more DIEs
here'. */
if (die_info_ptr >= die_info_end) {
return DW_DLV_NO_ENTRY;
}
if ((*die_info_ptr) == 0) {
/* We are not at the end of the section, but a
valid DIE will not start with a zero byte.
We will just assume it is a padding byte and is
not an error. An error report will appear
later if actually reading DIEs*/
return DW_DLV_NO_ENTRY;
}
ret_die = (Dwarf_Die) _dwarf_get_alloc(dbg, DW_DLA_DIE, 1);
if (!ret_die) {
_dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);
return DW_DLV_ERROR;
}
ret_die->di_is_info = is_info;
ret_die->di_debug_ptr = die_info_ptr;
ret_die->di_cu_context =
die == NULL ? context : die->di_cu_context;
dieres = _dwarf_leb128_uword_wrapper(dbg,
&die_info_ptr,die_info_end,&utmp,error);
if (dieres == DW_DLV_ERROR) {
dwarf_dealloc_die(ret_die);
return dieres;
}
if (die_info_ptr > die_info_end) {
/* We managed to go past the end of the CU!.
Something is badly wrong. */
dwarf_dealloc_die(ret_die);
_dwarf_error(dbg, error, DW_DLE_ABBREV_DECODE_ERROR);
return DW_DLV_ERROR;
}
abbrev_code = utmp;
if (abbrev_code == 0) {
/* Zero means a null DIE */
dwarf_dealloc_die(ret_die);
return DW_DLV_NO_ENTRY;
}
ret_die->di_abbrev_code = abbrev_code;
lres = _dwarf_get_abbrev_for_code(ret_die->di_cu_context,
abbrev_code,
&ret_die->di_abbrev_list,
&highest_code,error);
if (lres == DW_DLV_ERROR) {
dwarf_dealloc_die(ret_die);
return lres;
}
if (lres == DW_DLV_NO_ENTRY) {
dwarfstring m;
char buf[130];
buf[0] = 0;
dwarfstring_constructor_static(&m,buf,sizeof(buf));
dwarf_dealloc_die(ret_die);
dwarfstring_append_printf_u(&m,
"DW_DLE_DIE_ABBREV_LIST_NULL: "
"There is no abbrev present for code %u"
" in this compilation unit. ",
abbrev_code);
dwarfstring_append_printf_u(&m,
"The highest known code"
" in any compilation unit is %u .",
highest_code);
_dwarf_error_string(dbg, error,
DW_DLE_DIE_ABBREV_LIST_NULL,dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
if (!ret_die->di_abbrev_list->abl_attr) {
int bres = 0;
Dwarf_Byte_Ptr abbrev_ptr =
ret_die->di_abbrev_list->abl_abbrev_ptr;
Dwarf_Byte_Ptr abbrev_end =
_dwarf_calculate_abbrev_section_end_ptr(
ret_die->di_cu_context);
bres = _dwarf_fill_in_attr_form_abtable(
ret_die->di_cu_context,
abbrev_ptr,
abbrev_end,
ret_die->di_abbrev_list,
error);
if (bres != DW_DLV_OK) {
dwarf_dealloc_die(ret_die);
return bres;
}
}
if (die == NULL && !is_cu_tag(ret_die->di_abbrev_list->abl_tag)) {
dwarf_dealloc_die(ret_die);
_dwarf_error(dbg, error, DW_DLE_FIRST_DIE_NOT_CU);
return DW_DLV_ERROR;
}
*caller_ret_die = ret_die;
return DW_DLV_OK;
}
int
dwarf_child(Dwarf_Die die,
Dwarf_Die * caller_ret_die,
Dwarf_Error * error)
{
Dwarf_Byte_Ptr die_info_ptr = 0;
Dwarf_Byte_Ptr die_info_ptr2 = 0;
/* die_info_end points one-past-end of die area. */
Dwarf_Byte_Ptr die_info_end = 0;
Dwarf_Die ret_die = 0;
Dwarf_Bool has_die_child = 0;
Dwarf_Debug dbg;
Dwarf_Unsigned abbrev_code = 0;
Dwarf_Unsigned utmp = 0;
Dwarf_Debug_InfoTypes dis = 0;
int res = 0;
Dwarf_CU_Context context = 0;
int lres = 0;
Dwarf_Unsigned highest_code = 0;
CHECK_DIE(die, DW_DLV_ERROR);
dbg = die->di_cu_context->cc_dbg;
dis = die->di_is_info? &dbg->de_info_reading:
&dbg->de_types_reading;
die_info_ptr = die->di_debug_ptr;
/* We are saving a DIE pointer here, but the pointer
will not be presumed live later, when it is tested. */
dis->de_last_die = die;
dis->de_last_di_ptr = die_info_ptr;
/* NULL die has no child. */
if ((*die_info_ptr) == 0) {
return DW_DLV_NO_ENTRY;
}
context = die->di_cu_context;
die_info_end = _dwarf_calculate_info_section_end_ptr(context);
res = _dwarf_next_die_info_ptr(die_info_ptr,
die->di_cu_context,
die_info_end,
NULL, FALSE,
&has_die_child,
&die_info_ptr2,
error);
if (res != DW_DLV_OK) {
return res;
}
if (die_info_ptr == die_info_end) {
return DW_DLV_NO_ENTRY;
}
die_info_ptr = die_info_ptr2;
dis->de_last_di_ptr = die_info_ptr;
if (!has_die_child) {
/* Look for end of sibling chain. */
while (dis->de_last_di_ptr < die_info_end) {
if (*dis->de_last_di_ptr) {
break;
}
++dis->de_last_di_ptr;
}
return DW_DLV_NO_ENTRY;
}
ret_die = (Dwarf_Die) _dwarf_get_alloc(dbg, DW_DLA_DIE, 1);
if (!ret_die) {
_dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);
return DW_DLV_ERROR;
}
ret_die->di_debug_ptr = die_info_ptr;
ret_die->di_cu_context = die->di_cu_context;
ret_die->di_is_info = die->di_is_info;
res = _dwarf_leb128_uword_wrapper(dbg,&die_info_ptr,
die_info_end, &utmp,error);
if (res != DW_DLV_OK) {
dwarf_dealloc_die(ret_die);
return res;
}
abbrev_code = (Dwarf_Unsigned) utmp;
dis->de_last_di_ptr = die_info_ptr;
if (abbrev_code == 0) {
/* Look for end of sibling chain */
while (dis->de_last_di_ptr < die_info_end) {
if (*dis->de_last_di_ptr) {
break;
}
++dis->de_last_di_ptr;
}
/* We have arrived at a null DIE,
at the end of a CU or the end
of a list of siblings. */
*caller_ret_die = 0;
dwarf_dealloc(dbg, ret_die, DW_DLA_DIE);
ret_die = 0;
return DW_DLV_NO_ENTRY;
}
ret_die->di_abbrev_code = abbrev_code;
lres = _dwarf_get_abbrev_for_code(ret_die->di_cu_context,
abbrev_code,
&ret_die->di_abbrev_list,
&highest_code,error);
if (lres == DW_DLV_ERROR) {
dwarf_dealloc(dbg, ret_die, DW_DLA_DIE);
ret_die = 0;
return lres;
}
if (lres == DW_DLV_NO_ENTRY) {
dwarfstring m;
dwarfstring_constructor(&m);
dwarf_dealloc_die(ret_die);
ret_die = 0;
dwarfstring_append_printf_u(&m,
"DW_DLE_ABBREV_MISSING: the abbrev code not found "
" in dwarf_child() is %u. ",abbrev_code);
dwarfstring_append_printf_u(&m,
"The highest known code"
" in any compilation unit is %u.",
highest_code);
_dwarf_error_string(dbg, error, DW_DLE_ABBREV_MISSING,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
if (!ret_die->di_abbrev_list->abl_attr) {
int bres = 0;
Dwarf_Byte_Ptr abbrev_ptr =
ret_die->di_abbrev_list->abl_abbrev_ptr;
Dwarf_Byte_Ptr abbrev_end =
_dwarf_calculate_abbrev_section_end_ptr(
ret_die->di_cu_context);
bres = _dwarf_fill_in_attr_form_abtable(
ret_die->di_cu_context,
abbrev_ptr,
abbrev_end,
ret_die->di_abbrev_list,
error);
if (bres != DW_DLV_OK) {
dwarf_dealloc_die(ret_die);
return bres;
}
}
*caller_ret_die = ret_die;
return DW_DLV_OK;
}
/* Given a (global, not cu_relative) die offset, this returns
a pointer to a DIE thru *new_die.
It is up to the caller to do a
dwarf_dealloc(dbg,*new_die,DW_DLE_DIE);
The old form only works with debug_info.
The new _b form works with debug_info or debug_types.
*/
int
dwarf_offdie_b(Dwarf_Debug dbg,
Dwarf_Off offset, Dwarf_Bool is_info,
Dwarf_Die * new_die, Dwarf_Error * error)
{
Dwarf_CU_Context cu_context = 0;
Dwarf_Small *dataptr = 0;
Dwarf_Off new_cu_offset = 0;
Dwarf_Die die = 0;
Dwarf_Byte_Ptr info_ptr = 0;
Dwarf_Unsigned abbrev_code = 0;
Dwarf_Unsigned utmp = 0;
int lres = 0;
Dwarf_Debug_InfoTypes dis = 0;
Dwarf_Byte_Ptr die_info_end = 0;
Dwarf_Unsigned highest_code = 0;
struct Dwarf_Section_s * secdp = 0;
CHECK_DBG(dbg,error,"dwarf_offdie_b()");
if (is_info) {
dis =&dbg->de_info_reading;
secdp = &dbg->de_debug_info;
dataptr = dbg->de_debug_info.dss_data;
} else {
dis =&dbg->de_types_reading;
secdp = &dbg->de_debug_types;
dataptr = dbg->de_debug_types.dss_data;
}
if (!dataptr) {
lres = _dwarf_load_die_containing_section(dbg,
is_info, error);
if (lres != DW_DLV_OK) {
return lres;
}
}
cu_context = _dwarf_find_CU_Context(dbg, offset,is_info);
if (cu_context == NULL) {
Dwarf_Unsigned section_size = 0;
if (dis->de_cu_context_list_end != NULL) {
new_cu_offset = _dwarf_calculate_next_cu_context_offset(
dis->de_cu_context_list_end);
}/* Else new_cu_offset remains 0, no CUs on list,
a fresh section setup. */
section_size = secdp->dss_size;
do {
/* We do not want this to return cu_die as
we only want the last one to create DIE,
and that will be done just below. */
lres = _dwarf_create_a_new_cu_context_record_on_list(
dbg, dis,is_info,section_size,new_cu_offset,
&cu_context,NULL,error);
if (lres != DW_DLV_OK) {
return lres;
}
new_cu_offset = _dwarf_calculate_next_cu_context_offset(
cu_context);
/* Not setting dis->de_cu_context, leave
that unchanged. */
} while (offset >= new_cu_offset);
}
/* We have a cu_context for this offset. */
die_info_end = _dwarf_calculate_info_section_end_ptr(cu_context);
die = (Dwarf_Die) _dwarf_get_alloc(dbg, DW_DLA_DIE, 1);
if (!die) {
_dwarf_error(dbg, error, DW_DLE_ALLOC_FAIL);
return DW_DLV_ERROR;
}
die->di_cu_context = cu_context;
die->di_is_info = is_info;
/* dataptr above might be stale if we loaded a section
above. So access dss_data here. */
if (is_info) {
info_ptr = offset + dbg->de_debug_info.dss_data;
} else {
info_ptr = offset + dbg->de_debug_types.dss_data;
}
die->di_debug_ptr = info_ptr;
lres = _dwarf_leb128_uword_wrapper(dbg,&info_ptr,die_info_end,
&utmp,error);
if (lres != DW_DLV_OK) {
dwarf_dealloc_die(die);
return lres;
}
abbrev_code = utmp;
if (abbrev_code == 0) {
/* we are at a null DIE (or there is a bug). */
dwarf_dealloc_die(die);
die = 0;
return DW_DLV_NO_ENTRY;
}
die->di_abbrev_code = abbrev_code;
lres = _dwarf_get_abbrev_for_code(cu_context, abbrev_code,
&die->di_abbrev_list,
&highest_code,error);
if (lres == DW_DLV_ERROR) {
dwarf_dealloc_die(die);
die = 0;
return lres;
}
if (lres == DW_DLV_NO_ENTRY) {
dwarfstring m;
dwarf_dealloc_die(die);
die = 0;
dwarfstring_constructor(&m);
dwarfstring_append_printf_u(&m,
"DW_DLE_DIE_ABBREV_LIST_NULL: "
"There is no abbrev present for code %u"
" in this compilation unit"
" when calling dwarf_offdie_b(). ",
abbrev_code);
dwarfstring_append_printf_u(&m,
"The highest known code "
"in any compilation unit is %u .",
highest_code);
_dwarf_error_string(dbg, error,
DW_DLE_DIE_ABBREV_LIST_NULL,
dwarfstring_string(&m));
dwarfstring_destructor(&m);
return DW_DLV_ERROR;
}
if (!die->di_abbrev_list->abl_attr) {
int bres = 0;
Dwarf_Byte_Ptr abbrev_ptr =
die->di_abbrev_list->abl_abbrev_ptr;
Dwarf_Byte_Ptr abbrev_end =
_dwarf_calculate_abbrev_section_end_ptr(
die->di_cu_context);
bres = _dwarf_fill_in_attr_form_abtable(
die->di_cu_context,
abbrev_ptr,
abbrev_end,
die->di_abbrev_list,
error);
if (bres != DW_DLV_OK) {
dwarf_dealloc_die(die);
return bres;
}
}
*new_die = die;
return DW_DLV_OK;
}
/* New March 2016.
Lets one cross check the abbreviations section and
the DIE information presented by dwarfdump -i -G -v. */
int
dwarf_die_abbrev_global_offset(Dwarf_Die die,
Dwarf_Off * abbrev_goffset,
Dwarf_Unsigned * abbrev_count,
Dwarf_Error* error)
{
Dwarf_Abbrev_List dal = 0;
Dwarf_Debug dbg = 0;
CHECK_DIE(die, DW_DLV_ERROR);
dbg = die->di_cu_context->cc_dbg;
dal = die->di_abbrev_list;
if (!dal) {
_dwarf_error(dbg,error,DW_DLE_DWARF_ABBREV_NULL);
return DW_DLV_ERROR;
}
*abbrev_goffset = dal->abl_goffset;
*abbrev_count = dal->abl_abbrev_count;
return DW_DLV_OK;
}
/* New August 2018.
Because some real compressed sections
have .zdebug instead
of .debug as the leading characters.
actual_sec_name_out points to a static
string so so not free it. */
int
dwarf_get_real_section_name(Dwarf_Debug dbg,
const char *std_section_name,
const char **actual_sec_name_out,
Dwarf_Small *marked_zcompressed, /* zdebug */
Dwarf_Small *marked_zlib_compressed, /* ZLIB string */
Dwarf_Small *marked_shf_compressed, /* SHF_COMPRESSED */
Dwarf_Unsigned *compressed_length,
Dwarf_Unsigned *uncompressed_length,
Dwarf_Error *error)
{
unsigned i = 0;
char tbuf[100] = {0};
size_t std_sec_name_len = 0;
CHECK_DBG(dbg,error,"dwarf_get_real_section_name()");
if (!std_section_name || 0 == std_section_name[0]) {
_dwarf_error_string(dbg,error,DW_DLE_SECTION_NAME_BIG,
"DW_DLE_SECTION_NAME_BIG: Actually the "
"section name is empty, not big.");
return DW_DLV_ERROR;
}
std_sec_name_len = strlen(std_section_name);
/* std_section_name never has the .dwo on the end,
so allow for that and allow one (arbitrarily) more. */
if ((std_sec_name_len + 5) < sizeof(tbuf)) {
_dwarf_safe_strcpy(tbuf,sizeof(tbuf),
std_section_name,std_sec_name_len);
_dwarf_safe_strcpy(tbuf+std_sec_name_len,
sizeof(tbuf)-std_sec_name_len,
".dwo",4);
}
for (i=0; i < dbg->de_debug_sections_total_entries; i++) {
struct Dwarf_dbg_sect_s *sdata = &dbg->de_debug_sections[i];
struct Dwarf_Section_s *section = sdata->ds_secdata;
const char *std = section->dss_standard_name;
if (!strcmp(std,std_section_name) ||
!strcmp(std,tbuf)) {
const char *used = section->dss_name;
*actual_sec_name_out = used;
if (sdata->ds_have_zdebug) {
*marked_zcompressed = TRUE;
}
if (section->dss_ZLIB_compressed) {
*marked_zlib_compressed = TRUE;
if (uncompressed_length) {
*uncompressed_length =
section->dss_uncompressed_length;
}
if (compressed_length) {
*compressed_length =
section->dss_compressed_length;
}
}
if (section->dss_shf_compressed) {
*marked_shf_compressed = TRUE;
if (uncompressed_length) {
*uncompressed_length =
section->dss_uncompressed_length;
}
if (compressed_length) {
*compressed_length =
section->dss_compressed_length;
}
}
return DW_DLV_OK;
}
}
return DW_DLV_NO_ENTRY;
}
/* This is useful when printing DIE data.
The string pointer returned must not be freed.
With non-elf objects it is possible the
string returned might be empty or NULL,
so callers should be prepared for that kind
of return. */
int
dwarf_get_die_section_name(Dwarf_Debug dbg,
Dwarf_Bool is_info,
const char ** sec_name,
Dwarf_Error * error)
{
struct Dwarf_Section_s *sec = 0;
CHECK_DBG(dbg,error,"dwarf_get_die_section_name()");
if (is_info) {
sec = &dbg->de_debug_info;
} else {
sec = &dbg->de_debug_types;
}
if (sec->dss_size == 0) {
/* We don't have such a section at all. */
return DW_DLV_NO_ENTRY;
}
*sec_name = sec->dss_name;
return DW_DLV_OK;
}
/* This one assumes is_info not known to caller but a DIE is known. */
int
dwarf_get_die_section_name_b(Dwarf_Die die,
const char ** sec_name,
Dwarf_Error * error)
{
Dwarf_CU_Context context = 0;
Dwarf_Bool is_info = 0;
Dwarf_Debug dbg = 0;
CHECK_DIE(die, DW_DLV_ERROR);
context = die->di_cu_context;
dbg = context->cc_dbg;
is_info = context->cc_is_info;
return dwarf_get_die_section_name(dbg,is_info,sec_name,error);
}