pro_opaque.h revision 49d3bc91e27cd871b950d56c01398fa2f2e12ab4
/*
Copyright (C) 2000, 2002 Silicon Graphics, Inc. All Rights Reserved.
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., 59 Temple Place - Suite 330, Boston MA 02111-1307,
USA.
Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pky,
Mountain View, CA 94043, or:
For further information regarding this notice, see:
*/
#include <stddef.h>
/*
Sgidefs included to define __uint32_t,
a guaranteed 4-byte quantity.
*/
#include "libdwarfdefs.h"
#define true 1
#define false 0
/* to identify a cie */
#define DW_CIE_ID ~(0x0)
#define DW_CIE_VERSION 1
/*Dwarf_Word is unsigned word usable for index, count in memory */
/*Dwarf_Sword is signed word usable for index, count in memory */
/* The are 32 or 64 bits depending if 64 bit longs or not, which
** fits the ILP32 and LP64 models
** These work equally well with ILP64.
*/
typedef unsigned long Dwarf_Word;
typedef long Dwarf_Sword;
typedef signed char Dwarf_Sbyte;
typedef unsigned char Dwarf_Ubyte;
typedef signed short Dwarf_Shalf;
/*
On any change that makes libdwarf producer
incompatible, increment this number.
1->2->3 ...
*/
#define PRO_VERSION_MAGIC 0xdead1
/* these 2 are fixed sizes which must not vary with the
*/
typedef __uint32_t Dwarf_ufixed;
typedef __int32_t Dwarf_sfixed;
/*
producer:
This struct is used to hold information about all
debug* sections. On creating a new section, section
names and indices are added to this struct
definition in pro_section.h
*/
typedef struct Dwarf_P_Section_Data_s *Dwarf_P_Section_Data;
/*
producer:
This struct is used to hold entries in the include directories
part of statement prologue. Definition in pro_line.h
*/
typedef struct Dwarf_P_Inc_Dir_s *Dwarf_P_Inc_Dir;
/*
producer:
This struct holds file entries for the statement prologue.
Defined in pro_line.h
*/
typedef struct Dwarf_P_F_Entry_s *Dwarf_P_F_Entry;
/*
producer:
This struct holds information for each cie. Defn in pro_frame.h
*/
typedef struct Dwarf_P_Cie_s *Dwarf_P_Cie;
/*
producer:
Struct to hold line number information, different from
Dwarf_Line opaque type.
*/
typedef struct Dwarf_P_Line_s *Dwarf_P_Line;
/*
producer:
Struct to hold information about address ranges.
*/
typedef struct Dwarf_P_Simple_nameentry_s *Dwarf_P_Simple_nameentry;
typedef struct Dwarf_P_Simple_name_header_s *Dwarf_P_Simple_name_header;
typedef struct Dwarf_P_Arange_s *Dwarf_P_Arange;
typedef struct Dwarf_P_Per_Reloc_Sect_s *Dwarf_P_Per_Reloc_Sect;
/* Defined to get at the elf section numbers and section name
indices in symtab for the dwarf sections
Must match .rel.* names in _dwarf_rel_section_names
exactly.
*/
#define DEBUG_INFO 0
#define DEBUG_LINE 1
#define DEBUG_ABBREV 2
#define DEBUG_FRAME 3
#define DEBUG_ARANGES 4
#define DEBUG_PUBNAMES 5
#define DEBUG_STR 6
#define DEBUG_FUNCNAMES 7
#define DEBUG_TYPENAMES 8
#define DEBUG_VARNAMES 9
#define DEBUG_WEAKNAMES 10
#define DEBUG_MACINFO 11
#define DEBUG_LOC 12
/* number of debug_* sections not including the relocations */
struct Dwarf_P_Die_s {
char *di_abbrev; /* abbreviation */
int di_n_attr; /* number of attributes */
};
/* producer fields */
struct Dwarf_P_Attribute_s {
char *ar_data; /* data, format given by form */
relocatable value, holds
index of symbol in SYMTAB */
char ar_reloc_len; /* Number of bytes that relocation
applies to. 4 or 8. Unused and may
be 0 if if ar_rel_type is
R_MIPS_NONE */
};
/* A block of .debug_macinfo data: this forms a series of blocks.
** Each macinfo input is compressed immediately and put into
** the current block if room, else a newblock allocated.
** The space allocation is such that the block and the macinfo
** data are one malloc block: free with a pointer to this and the
** mb_data is freed automatically.
** Like the struct hack, but legal ANSI C.
*/
struct dw_macinfo_block_s {
struct dw_macinfo_block_s *mb_next;
unsigned long mb_avail_len;
unsigned long mb_used_len;
unsigned long mb_macinfo_data_space_len;
char *mb_data; /* original malloc ptr. */
};
/* dwarf_sn_kind is for the array of similarly-treated
name -> cu ties
*/
dwarf_snk_entrycount /* this one must be last */
};
/* The calls to add a varname etc use a list of
these as the list.
*/
struct Dwarf_P_Simple_nameentry_s {
char *sne_name;
int sne_name_len;
};
/* An array of these, each of which heads a list
of Dwarf_P_Simple_nameentry
*/
struct Dwarf_P_Simple_name_header_s {
/* length that will be generated, not counting fixed header or
trailer */
};
typedef int (*_dwarf_pro_reloc_name_func_ptr) (Dwarf_P_Debug dbg, int sec_index, Dwarf_Unsigned offset, /* r_offset
*/
enum Dwarf_Rel_Type type,
int reltarget_length);
typedef int (*_dwarf_pro_reloc_length_func_ptr) (Dwarf_P_Debug dbg, int sec_index, Dwarf_Unsigned offset, /* r_offset
*/
enum Dwarf_Rel_Type
type,
int reltarget_length);
/*
Each slot in a block of slots could be:
a binary stream relocation entry (32 or 64bit relocation data)
a SYMBOLIC relocation entry.
During creation sometimes we create multiple chained blocks,
but sometimes we create a single long block.
Before returning reloc data to caller,
we switch to a single, long-enough,
block.
We make counters here Dwarf_Unsigned so that we
get sufficient alignment. Since we use space after
the struct (at malloc time) for user data which
must have Dwarf_Unsigned alignment, this
struct must have that alignment too.
*/
struct Dwarf_P_Relocation_Block_s {
struct Dwarf_P_Relocation_Block_s *rb_next;
char *rb_where_to_add_next; /* pointer to next slot (might be past
end, depending on
rb_next_slot_to_use) */
char *rb_data; /* data area */
};
/* One of these per potential relocation section
So one per actual dwarf section.
Left zeroed when not used (some sections have
no relocations).
*/
struct Dwarf_P_Per_Reloc_Sect_s {
unsigned long pr_reloc_total_count; /* total number of entries
across all blocks */
unsigned long pr_slots_per_block_to_alloc; /* at Block alloc, this
is the default
number of slots to
use */
int pr_sect_num_of_reloc_sect; /* sect number returned by
de_func() or de_func_b()
call, this is the sect
number of the relocation
section. */
/* singly-linked list. add at and ('last') with count of blocks */
struct Dwarf_P_Relocation_Block_s *pr_first_block;
struct Dwarf_P_Relocation_Block_s *pr_last_block;
unsigned long pr_block_count;
};
#define DEFAULT_SLOTS_PER_BLOCK 3
/* Fields used by producer */
struct Dwarf_P_Debug_s {
/* used to catch dso passing dbg to another DSO with incompatible
version of libdwarf See PRO_VERSION_MAGIC */
/*
Call back function, used to create .debug* sections. Provided
by user. Only of these used per dbg. */
/* Flags from producer_init call */
/* This holds information on debug section stream output, including
the stream data */
/* Pointer to the 'current active' section */
/* Number of debug data streams globs. */
/* File entry information, null terminated singly-linked list */
/* Has the directories used to search for source files */
/* Has all the line number info for the stmt program */
/* List of cie's for the debug unit */
/* Singly-linked list of fde's for the debug unit */
/* First die, leads to all others */
/* Pointer to list of strings */
char *de_strings;
/* Pointer to chain of aranges */
/* macinfo controls. */
/* first points to beginning of the list during creation */
struct dw_macinfo_block_s *de_first_macinfo;
/* current points to the current, unfilled, block */
struct dw_macinfo_block_s *de_current_macinfo;
/* Pointer to the first section, to support reset_section_bytes */
/* handles pubnames, weaknames, etc. See dwarf_sn_kind in
pro_opaque.h */
struct Dwarf_P_Simple_name_header_s
/* relocation data. not all sections will actally have relocation
info, of course */
int de_reloc_next_to_return; /* iterator on reloc sections
(SYMBOLIC output) */
/* used in remembering sections */
elf sect number of
the section itself,
DEBUG_LINE for
example */
name
index
or
handle
for
the
name
of
the
symbol
for
DEBUG_LINE
for
example
*/
int de_offset_reloc; /* offset reloc type, R_MIPS_32 for
example. Specific to the ABI being
produced. Relocates offset size
field */
int de_exc_reloc; /* reloc type specific to exception
table relocs. */
int de_ptr_reloc; /* standard reloc type, R_MIPS_32 for
example. Specific to the ABI being
produced. relocates pointer size
field */
unsigned char de_offset_size; /* section offset. Here to
avoid test of abi in macro
at run time MIPS -n32 4,
-64 8. */
unsigned char de_pointer_size; /* size of pointer in target.
Here to avoid test of abi in
macro at run time MIPS -n32
4, -64 is 8. */
unsigned char de_is_64bit; /* non-zero if is 64bit. Else 32 bit:
used for passing this info as a flag
*/
unsigned char de_relocation_record_size; /* reloc record size
varies by ABI and
relocation-output
method (stream or
symbolic) */
unsigned char de_64bit_extension; /* non-zero if creating 64 bit
offsets using dwarf2-99
extension proposal */
int de_ar_data_attribute_form; /* data8, data4 abi dependent */
int de_ar_ref_attr_form; /* ref8 ref4 , abi dependent */
/* simple name relocations */
/* relocations for a length, requiring a pair of symbols */
/* following used for macro buffers */
unsigned long de_compose_avail;
unsigned long de_compose_used_len;
unsigned char de_same_endian;
void *(*de_copy_word) (void *, const void *, size_t);
/* Add new fields at the END of this struct to preserve some hope
of sensible behavior on dbg passing between DSOs linked with
mismatched libdwarf producer versions. */
};
#define CURRENT_VERSION_STAMP 2
char *entry_name,
enum dwarf_sn_kind
Dwarf_Error * error);