Open64: osprey/common/com/dwarf

00001 /*
00002  * Copyright 2003, 2004, 2005, 2006 PathScale, Inc.  All Rights Reserved.
00003  */
00004 
00005 /*
00006 
00007   Copyright (C) 2000, 2001 Silicon Graphics, Inc.  All Rights Reserved.
00008 
00009   This program is free software; you can redistribute it and/or modify it
00010   under the terms of version 2 of the GNU General Public License as
00011   published by the Free Software Foundation.
00012 
00013   This program is distributed in the hope that it would be useful, but
00014   WITHOUT ANY WARRANTY; without even the implied warranty of
00015   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
00016 
00017   Further, this software is distributed without any warranty that it is
00018   free of the rightful claim of any third person regarding infringement 
00019   or the like.  Any license provided herein, whether implied or 
00020   otherwise, applies only to this software file.  Patent licenses, if 
00021   any, provided herein do not apply to combinations of this program with 
00022   other software, or any other product whatsoever.  
00023 
00024   You should have received a copy of the GNU General Public License along
00025   with this program; if not, write the Free Software Foundation, Inc., 59
00026   Temple Place - Suite 330, Boston MA 02111-1307, USA.
00027 
00028   Contact information:  Silicon Graphics, Inc., 1600 Amphitheatre Pky,
00029   Mountain View, CA 94043, or:
00030 
00031   http://www.sgi.com
00032 
00033   For further information regarding this notice, see:
00034 
00035   http://oss.sgi.com/projects/GenInfo/NoticeExplan
00036 
00037 */
00038 
00039 
00040 #ifndef dwarf_DST_INCLUDED
00041 #define dwarf_DST_INCLUDED
00042 
00043 
00044 #ifdef _KEEP_RCS_ID
00045 static char *dwarf_DST_rcs_id = "$Source: common/com/SCCS/s.dwarf_DST.h $ $Revision: 1.15 $";
00046 #endif /* _KEEP_RCS_ID */
00047 
00048 /* The version number will be accessible through the routines in
00049  * dwarf_DST_mem.c and is passed through the .B file.  This will
00050  * permit a compatibility check on the consumer side in the compiler
00051  * back-end.
00052  *
00053  * Version 0 : Initial version of the DST data structure!
00054  */
00055 #define dwarf_DST_version 0x0
00056 
00057 
00058 #include "dwarf_stuff.h"
00059 #include "dwarf_DST_mem.h"
00060 #include "symtab_idx.h" /* defines ST_IDX */
00061 #include "srcpos.h"  /* defines USRCPOS */
00062 
00063 #ifdef __cplusplus
00064 extern "C" {
00065 #endif
00066 
00067                       /*----------------------------*
00068                       * Basic types and definitions *
00069                       *-----------------------------*/
00070 
00071 
00072 /* General purpose flags, both representing explicit and implicit 
00073  * attributes of DST_info objects.
00074 */
00075 #define DST_no_flag                0x00000000 /* No flag values are set */
00076 #define DST_flag_external          0x00000001 /* AT_external = TRUE */
00077 #define DST_flag_declaration       0x00000002 /* AT_declaration = TRUE */
00078 #define DST_flag_prototyped        0x00000008 /* AT_prototyped = TRUE */
00079 #define DST_flag_memdef            0x00000010 /* Has an AT_specification */
00080 #define DST_flag_const             0x00000020 /* Has an AT_const_value */
00081 #define DST_flag_automatic         0x00000040 /* Is a local variable */
00082 #define DST_flag_optional_parm     0x00000080 /* AT_is_optional = TRUE */
00083 #define DST_flag_variable_parm     0x00000100 /* AT_variable_parameter=TRUE */
00084 #define DST_flag_bitfield          0x00000200 /* TRUE when a bitfield member */
00085 #define DST_flag_comm      0x00000400 /* TRUE if variable is part of a common block */
00086 #define DST_flag_lb_cval     0x00000800 /* true if lower bound of subrange is constant */
00087 #define DST_flag_ub_cval     0x00001000 /* true if upper bound of subrange is constant */
00088 #define DST_flag_cval        0x00002000 /* true if it is a constant */
00089 #define DST_flag_artificial    0x00004000 /* true if it is an artificial entity */
00090 #define DST_flag_deref       0x00008000 /* true if symbol should be dereferenced */
00091 #define DST_flag_base_deref    0x00010000 /* true if symbol's base should be dereferenced */
00092 #define DST_flag_count       0x00020000 /* true if subrange contains extent(ie: !upper bound) */
00093 #define DST_flag_stride_1byte      0x00040000 /* true if DW_AT_stride is in byte increments   */
00094 #define DST_flag_stride_2byte      0x00080000 /* true if DW_AT_stride is in 2 byte increments */ 
00095 #define DST_flag_f90_pointer       0x00100000 /* true if symbol is a pointer */
00096 #define DST_flag_allocatable       0x00200000 /* true if symbol is allocatable*/
00097 #define DST_flag_assumed_shape     0x00400000 /* true if symbol is assumed shape*/
00098 #define DST_flag_assumed_size      0x00800000 /* true if symbol is assumed size*/
00099 #if !defined(TARG_NVISA)
00100 //Obsolete
00101 #define DST_flag_assoc_fe          0x10000000 /* pointer to front-end entity */
00102 #define DST_flag_assoc_be          0x20000000 /* pointer to back-end entity */
00103 #define DST_flag_assoc_idx         0x40000000 /* index to back-end entity */
00104 #endif
00105 
00106 #define DST_flag_info_mark         0x80000000 /* DST_info mark for traversal */
00107 #define DST_flag_static      0x100000000LL /* Has no AT_data_member_location */
00108 #ifdef TARG_X8664
00109 #define DST_flag_GNU_vector        0x200000000LL /* GNU vector extension */
00110 #endif
00111 #define DST_flag_mask              0xffffffff
00112 
00113 #define DST_SET_external(flag) (flag |= DST_flag_external)
00114 #define DST_SET_declaration(flag) (flag |= DST_flag_declaration)
00115 #define DST_SET_prototyped(flag) (flag |= DST_flag_prototyped)
00116 #define DST_SET_memdef(flag) (flag |= DST_flag_memdef)
00117 #define DST_SET_const(flag) (flag |= DST_flag_const)
00118 #define DST_SET_comm(flag) (flag |= DST_flag_comm)
00119 #define DST_SET_lb_cval(flag) (flag |= DST_flag_lb_cval)
00120 #define DST_SET_ub_cval(flag) (flag |= DST_flag_ub_cval)
00121 #define DST_SET_cval(flag) (flag |= DST_flag_cval)
00122 #define DST_SET_count(flag) (flag |= DST_flag_count)
00123 #define DST_SET_stride_1byte(flag) (flag |= DST_flag_stride_1byte)
00124 #define DST_SET_stride_2byte(flag) (flag |= DST_flag_stride_2byte)
00125 #define DST_SET_artificial(flag) (flag |= DST_flag_artificial)
00126 #define DST_SET_deref(flag) (flag |= DST_flag_deref)
00127 #define DST_SET_base_deref(flag) (flag |= DST_flag_base_deref)
00128 #define DST_SET_automatic(flag) (flag |= DST_flag_automatic)
00129 #define DST_SET_optional_parm(flag) (flag |= DST_flag_optional_parm)
00130 #define DST_SET_variable_parm(flag) (flag |= DST_flag_variable_parm)
00131 #define DST_SET_bitfield(flag) (flag |= DST_flag_bitfield)
00132 #define DST_SET_f90_pointer(flag) (flag |= DST_flag_f90_pointer)
00133 #define DST_SET_allocatable(flag) (flag |= DST_flag_allocatable)
00134 #define DST_SET_assumed_shape(flag) (flag |= DST_flag_assumed_shape)
00135 #define DST_SET_assumed_size(flag) (flag |= DST_flag_assumed_size)
00136 #if !defined(TARG_NVISA)
00137 #define DST_SET_assoc_fe(flag) (flag |= DST_flag_assoc_fe)
00138 #define DST_SET_assoc_be(flag) (flag |= DST_flag_assoc_be)
00139 #define DST_SET_assoc_idx(flag) (flag |= DST_flag_assoc_idx)
00140 #endif
00141 #define DST_SET_info_mark(flag) (flag |= DST_flag_info_mark)
00142 #define DST_SET_static(flag) (flag |= DST_flag_static)
00143 #ifdef TARG_X8664
00144 #define DST_SET_GNU_vector(flag) (flag |= DST_flag_GNU_vector)
00145 #endif
00146 
00147 #define DST_RESET_all(flag) (flag &= ~DST_flag_mask)
00148 #define DST_RESET_external(flag) (flag &= ~DST_flag_external)
00149 #define DST_RESET_declaration(flag) (flag &= ~DST_flag_declaration)
00150 #define DST_RESET_prototyped(flag) (flag &= ~DST_flag_prototyped)
00151 #define DST_RESET_memdef(flag) (flag &= ~DST_flag_memdef)
00152 #define DST_RESET_const(flag) (flag &= ~DST_flag_const)
00153 #define DST_RESET_comm(flag) (flag &= ~DST_flag_comm)
00154 #define DST_RESET_lb_cval(flag) (flag &= ~DST_flag_lb_cval)
00155 #define DST_RESET_ub_cval(flag) (flag &= ~DST_flag_ub_cval)
00156 #define DST_RESET_cval(flag) (flag &= ~DST_flag_cval)
00157 #define DST_RESET_count(flag) (flag &= ~DST_flag_count)
00158 #define DST_RESET_stride_1byte(flag) (flag &= ~DST_flag_stride_1byte)
00159 #define DST_RESET_stride_2byte(flag) (flag &= ~DST_flag_stride_2byte)
00160 #define DST_RESET_artificial(flag) (flag &= ~DST_flag_artificial)
00161 #define DST_RESET_deref(flag) (flag &= ~DST_flag_deref)
00162 #define DST_RESET_base_deref(flag) (flag &= ~DST_flag_base_deref)
00163 #define DST_RESET_automatic(flag) (flag &= ~DST_flag_automatic)
00164 #define DST_RESET_optional_parm(flag) (flag &= ~DST_flag_optional_parm)
00165 #define DST_RESET_variable_parm(flag) (flag &= ~DST_flag_variable_parm)
00166 #define DST_RESET_bitfield(flag) (flag &= ~DST_flag_bitfield)
00167 #define DST_RESET_f90_pointer(flag) (flag &= ~DST_flag_f90_pointer)
00168 #define DST_RESET_allocatable(flag) (flag &= ~DST_flag_allocatable)
00169 #define DST_RESET_assumed_shape(flag) (flag &= ~DST_flag_assumed_shape)
00170 #define DST_RESET_assumed_size(flag) (flag &= ~DST_flag_assumed_size)
00171 #if !defined(TARG_NVISA)
00172 #define DST_RESET_assoc_fe(flag) (flag &= ~DST_flag_assoc_fe)
00173 #define DST_RESET_assoc_be(flag) (flag &= ~DST_flag_assoc_be)
00174 #define DST_RESET_assoc_idx(flag) (flag &= ~DST_flag_assoc_idx)
00175 #endif
00176 #define DST_RESET_info_mark(flag) (flag &= ~DST_flag_info_mark)
00177 #define DST_RESET_static(flag) (flag &= ~DST_flag_static)
00178 #ifdef TARG_X8664
00179 #define DST_RESET_GNU_vector(flag) (flag &= ~DST_flag_GNU_vector)
00180 #endif
00181 
00182 #define DST_IS_external(flag) (flag & DST_flag_external)
00183 #define DST_IS_declaration(flag) (flag & DST_flag_declaration)
00184 #define DST_IS_prototyped(flag) (flag & DST_flag_prototyped)
00185 #define DST_IS_memdef(flag) (flag & DST_flag_memdef)
00186 #define DST_IS_const(flag) (flag & DST_flag_const)
00187 #define DST_IS_comm(flag) (flag & DST_flag_comm)
00188 #define DST_IS_lb_cval(flag) (flag & DST_flag_lb_cval)
00189 #define DST_IS_ub_cval(flag) (flag & DST_flag_ub_cval)
00190 #define DST_IS_cval(flag) (flag & DST_flag_cval)
00191 #define DST_IS_count(flag) (flag & DST_flag_count)
00192 #define DST_IS_stride_1byte(flag) (flag & DST_flag_stride_1byte)
00193 #define DST_IS_stride_2byte(flag) (flag & DST_flag_stride_2byte)
00194 #define DST_IS_artificial(flag) (flag & DST_flag_artificial)
00195 #define DST_IS_deref(flag) (flag & DST_flag_deref)
00196 #define DST_IS_base_deref(flag) (flag & DST_flag_base_deref)
00197 #define DST_IS_automatic(flag) (flag & DST_flag_automatic)
00198 #define DST_IS_optional_parm(flag) (flag & DST_flag_optional_parm)
00199 #define DST_IS_variable_parm(flag) (flag & DST_flag_variable_parm)
00200 #define DST_IS_bitfield(flag) (flag & DST_flag_bitfield)
00201 #define DST_IS_f90_pointer(flag) (flag & DST_flag_f90_pointer)
00202 #define DST_IS_allocatable(flag) (flag & DST_flag_allocatable)
00203 #define DST_IS_assumed_shape(flag) (flag & DST_flag_assumed_shape)
00204 #define DST_IS_assumed_size(flag) (flag & DST_flag_assumed_size)
00205 #if !defined(TARG_NVISA)
00206 #define DST_IS_assoc_fe(flag) (flag & DST_flag_assoc_fe)
00207 #define DST_IS_assoc_be(flag) (flag & DST_flag_assoc_be)
00208 #define DST_IS_assoc_idx(flag) (flag & DST_flag_assoc_idx)
00209 #endif
00210 #define DST_IS_info_mark(flag) (flag & DST_flag_info_mark)
00211 #define DST_IS_static(flag) (flag & DST_flag_static)
00212 #ifdef TARG_X8664
00213 #define DST_IS_GNU_vector(flag) (flag & DST_flag_GNU_vector)
00214 #endif
00215 
00216 
00217 /* Attribute types, used to hold the values defined in "dwarf.h"
00218 */
00219 typedef UINT64 DST_flag;          /* DST_flag value (see above definitions) */
00220 typedef UINT16 DST_DW_tag;        /* DW_TAG value */
00221 typedef UINT8  DST_ATE_encoding;  /* AT_encoding codes (basetypes) */
00222 typedef UINT8  DST_addr_class;    /* AT_address_class codes. */
00223 typedef UINT16 DST_language;      /* AT_language codes */
00224 typedef UINT16 DST_identifier_case; /* AT_identifier codes */
00225 typedef UINT8  DST_inline;        /* AT_inline (INL_not_inlined if absent) */
00226 typedef UINT8  DST_virtuality;    /* AT_virtuality (member functions and bases */
00227 #ifdef KEY
00228 typedef UINT8  DST_accessibility; /* AT_accessibility 
00229                                      (member functions and bases */
00230 #endif
00231 typedef UINT16 DST_vtable_elem_location;
00232           /* Used for index of function in vtable */
00233 typedef UINT8  DST_bitsize;       /* Used for bit_offset and bit_size */
00234 typedef UINT64 DST_size_t;        /* Used for byte_size of types */
00235 typedef INT64  DST_bounds_t;    /* Used to hold array bounds */
00236 typedef void  *DST_die_ptr;   /* Used in backend for die ptr. */
00237 
00238 
00239 /* Different types of indices to DST entries.  Note that when accessing
00240  * an entry through DST_IDX_TO_PTR(), the second argument must be of a
00241  * type as reflected by the form of index.
00242 */
00243 typedef DST_IDX DST_INFO_IDX; /* Index to a DST_INFO entry */
00244 typedef DST_IDX DST_ATTR_IDX; /* Index to an attribute struct */
00245 typedef DST_IDX DST_FILE_IDX; /* Index to a DST_FILE_NAME entry */
00246 typedef DST_IDX DST_DIR_IDX;  /* Index to a DST_INCLUDE_DIR entry */
00247 typedef DST_IDX DST_MACR_IDX; /* Index to macro info (not yet defined) */
00248 typedef DST_IDX DST_STR_IDX;  /* Index to a string (char*) */
00249 
00250 
00251                  /*-------------------------------*
00252                   * Pointers to back-end entities *
00253                   *-------------------------------*/
00254 
00255 class ST;
00256 
00257 typedef union DST_assoc_info
00258 {
00259    ST_IDX  st_idx;  /* idx to symbol table */
00260    ST     *st_ptr;  /* A temporary ptr used by fe */
00261 #if !defined(TARG_NVISA)
00262    /* obsolete */
00263    union 
00264    {
00265      void *fe_ptr;
00266      UINTPS fe_uint;
00267    } st_u;
00268 #endif
00269 } DST_ASSOC_INFO;
00270 #define DST_ASSOC_INFO_st_idx(p) ((p).st_idx)
00271 #define DST_ASSOC_INFO_st_level(p) (ST_IDX_level((p).st_idx))
00272 #define DST_ASSOC_INFO_st_index(p) (ST_IDX_index((p).st_idx))
00273 #define DST_ASSOC_INFO_st_ptr(p) ((p).st_ptr)
00274 #if !defined(TARG_NVISA)
00275 #define DST_ASSOC_INFO_fe_ptr(p) ((p).st_u.fe_ptr)
00276 #endif
00277 
00278 #define pDST_ASSOC_INFO_st_idx(p) ((p)->st_idx)
00279 #define pDST_ASSOC_INFO_st_level(p) (ST_IDX_level((p)->st_idx))
00280 #define pDST_ASSOC_INFO_st_index(p) (ST_IDX_index((p)->st_idx))
00281 #define pDST_ASSOC_INFO_st_ptr(p) ((p)->st_ptr)
00282 #if !defined(TARG_NVISA)
00283 #define pDST_ASSOC_INFO_fe_ptr(p) ((p)->st_u.fe_ptr)
00284 #endif
00285 
00286 
00287                   /*--------------------*
00288                    * Data Representation *
00289                    *---------------------*/
00290 
00291 
00292 /* Forms of constant values.
00293 */
00294 typedef enum DST_const_form
00295 {
00296    DST_FORM_STRING, 
00297    DST_FORM_DATA1, 
00298    DST_FORM_DATA2, 
00299    DST_FORM_DATA4, 
00300 #ifndef KEY
00301    DST_FORM_DATA8
00302 #else
00303    DST_FORM_DATA8, 
00304    DST_FORM_DATAC4,
00305    DST_FORM_DATAC8
00306 #endif // KEY
00307 } DST_CONST_FORM;
00308 
00309 typedef struct DST_const_value
00310 {
00311    DST_CONST_FORM form;
00312    union 
00313    {
00314       DST_IDX form_string;
00315       UINT8   form_data1;
00316       UINT16  form_data2;
00317       UINT32  form_data4;
00318       UINT64  form_data8;
00319 #ifdef KEY
00320       struct {
00321   UINT32 form_crdata4;
00322   UINT32 form_cidata4;
00323       } cdata4;
00324       struct {
00325   UINT64 form_crdata8;
00326   UINT64 form_cidata8;
00327       } cdata8;
00328 #endif // KEY
00329    } value;
00330 } DST_CONST_VALUE;
00331 
00332 #define DST_CONST_VALUE_form(c) ((c).form)
00333 #define DST_CONST_VALUE_form_string(c) ((c).value.form_string)
00334 #define DST_CONST_VALUE_form_data1(c) ((c).value.form_data1)
00335 #define DST_CONST_VALUE_form_data2(c) ((c).value.form_data2)
00336 #define DST_CONST_VALUE_form_data4(c) ((c).value.form_data4)
00337 #define DST_CONST_VALUE_form_data8(c) ((c).value.form_data8)
00338 #ifdef KEY
00339 #define DST_CONST_VALUE_form_crdata4(c) ((c).value.cdata4.form_crdata4)
00340 #define DST_CONST_VALUE_form_cidata4(c) ((c).value.cdata4.form_cidata4)
00341 #define DST_CONST_VALUE_form_crdata8(c) ((c).value.cdata8.form_crdata8)
00342 #define DST_CONST_VALUE_form_cidata8(c) ((c).value.cdata8.form_cidata8)
00343 #endif // KEY
00344 
00345 
00346 
00347 /* Holds info necessary for the "include_directories" part of the
00348  * .debug_line section as a list of DST_INCLUDE_DIR records.
00349 */
00350 typedef struct DST_include_dir
00351 {
00352    DST_STR_IDX path;  /* a string */
00353    DST_DIR_IDX next;  /* next include dir */
00354 }  DST_INCLUDE_DIR;
00355 
00356 #define DST_INCLUDE_DIR_path(dir) ((dir)->path)
00357 #define DST_INCLUDE_DIR_next(dir) ((dir)->next)
00358 
00359 
00360 /* Holds info necessary for the "file_names" part of the
00361  * .debug_line section as a list of DST_FILE_NAME records.
00362 */
00363 typedef struct DST_file_name
00364 {
00365    DST_STR_IDX  name;  /* a string */
00366    UINT16       dir;   /* Ordinal number of DST_INCLUDE_DIR (0 if none) */
00367    UINT64       size;  /* size in bytes; zero if unknown */
00368    UINT64       modt;  /* last mod time_t (<sys/time.h>); zero if unknown */
00369    DST_FILE_IDX next;  /* next file name */
00370 }  DST_FILE_NAME;
00371 
00372 #define DST_FILE_NAME_name(f) ((f)->name)
00373 #define DST_FILE_NAME_dir(f) ((f)->dir)
00374 #define DST_FILE_NAME_size(f) ((f)->size)
00375 #define DST_FILE_NAME_modt(f) ((f)->modt)
00376 #define DST_FILE_NAME_next(f) ((f)->next)
00377 
00378 
00379 #ifdef KEY
00380 /* Holds info necessary for the macros.
00381  */
00382 typedef struct DST_macinfo
00383 {
00384   DST_STR_IDX macro;
00385   UINT fileno;
00386   UINT lineno;
00387   DST_DW_tag tag;
00388   DST_MACR_IDX next;
00389 } DST_MACR;
00390 
00391 #define DST_MACR_fileno(attr) ((attr)->fileno)
00392 #define DST_MACR_lineno(attr) ((attr)->lineno)
00393 #define DST_MACR_macro(attr)  ((attr)->macro)
00394 #define DST_MACR_tag(attr)    ((attr)->tag)
00395 #define DST_MACR_next(attr)   ((attr)->next)
00396 #endif
00397 
00398 /* This structure definition encapsulates the information kept for each
00399  * type of .debug_info entry.  The "attributes" can be any of the records
00400  * defined below, while the tag determines the form of entry and, hence,
00401  * which attribute record pointed to.  Most entries can have siblings.
00402  * The flag values that apply to each form of DW_TAG are indicated in a
00403  * comment for each form of attribute struct (no comment when no flag value
00404  * applies).
00405 */
00406 typedef struct DST_info
00407 {
00408    DST_DW_tag   tag;         /* DW_TAG value */
00409    DST_flag     flag;        /* A set of flags */
00410    DST_INFO_IDX sibling;     /* dwarf sibling ptr */
00411    DST_ATTR_IDX attributes;  /* Ptr to attribute struct */
00412    DST_die_ptr  dieptr;      /* ptr to the die for this DST (used in be)  */
00413 } DST_INFO;
00414 
00415 #define DST_INFO_tag(info) ((info)->tag)
00416 #define DST_INFO_flag(info) ((info)->flag)
00417 #define DST_INFO_sibling(info) ((info)->sibling)
00418 #define DST_INFO_attributes(info) ((info)->attributes)
00419 #define DST_INFO_dieptr(info) ((info)->dieptr)
00420 
00421 
00422 /* The children of a DST entry are linked through the "sibling" indices
00423  * in DST_INFO, and the parent will have indices to the first and last
00424  * child in the list.
00425  */
00426 typedef struct DST_CHILDREN
00427 {
00428    DST_INFO_IDX  first;
00429    DST_INFO_IDX last;
00430 } DST_CHILDREN;
00431 
00432    
00433 /* [tag==DW_TAG_compile_unit]: Back-end must supply low/high pc, 
00434  * as well as relocation info for the low/high pc, statement list 
00435  * and macro information.
00436 */
00437 typedef struct DST_compile_unit
00438 {
00439    DST_STR_IDX   name;        /* Relative path of first source file */
00440    DST_STR_IDX   comp_dir;    /* cwd when issuing compilation command */
00441    DST_STR_IDX   producer;    /* Info about compiler */
00442    DST_language  language;    /* The DW_LANG code */
00443    DST_identifier_case identifier_case; /* The DW_ID code */
00444    DST_CHILDREN  child;       /* The file-scope decls/defs */
00445 } DST_COMPILE_UNIT;
00446 
00447 #define DST_COMPILE_UNIT_name(attr) ((attr)->name)
00448 #define DST_COMPILE_UNIT_comp_dir(attr) ((attr)->comp_dir)
00449 #define DST_COMPILE_UNIT_producer(attr) ((attr)->producer)
00450 #define DST_COMPILE_UNIT_language(attr) ((attr)->language)
00451 #define DST_COMPILE_UNIT_identifier_case(attr) ((attr)->identifier_case)
00452 #define DST_COMPILE_UNIT_first_child(attr) ((attr)->child.first)
00453 #define DST_COMPILE_UNIT_last_child(attr) ((attr)->child.last)
00454 
00455 
00456 
00457 /* [tag==DW_TAG_inlined_subroutine]:  Back-end must supply 
00458  * low/high pc (and their reloc info ) and AT_address_class (2.10).
00459 */
00460 typedef struct DST_inlined_subroutine
00461 {
00462    DST_ASSOC_INFO low_pc;    /* Get pc value through back-end LABEL   */
00463    DST_ASSOC_INFO high_pc;     /* Get pc value through back-end LABEL   */
00464    DST_INFO_IDX   abstract_origin; /* The abstract version of this instance */
00465    DST_CHILDREN   child;           /* Formal parameters, and local scope*/
00466    USRCPOS    decl;      /* so can check if cross-file */
00467    DST_STR_IDX    abstract_name;   /* "name" for cross-file matching */
00468 } DST_INLINED_SUBROUTINE;
00469 
00470 #define DST_INLINED_SUBROUTINE_low_pc(attr) ((attr)->low_pc)
00471 #define DST_INLINED_SUBROUTINE_high_pc(attr) ((attr)->high_pc)
00472 #define DST_INLINED_SUBROUTINE_abstract_origin(attr)\
00473    ((attr)->abstract_origin)
00474 #define DST_INLINED_SUBROUTINE_first_child(attr) ((attr)->child.first)
00475 #define DST_INLINED_SUBROUTINE_last_child(attr) ((attr)->child.last)
00476 #define DST_INLINED_SUBROUTINE_decl(attr) ((attr)->decl)
00477 #define DST_INLINED_SUBROUTINE_abstract_name(attr) ((attr)->abstract_name)
00478 
00479 
00480 
00481 /* [tag==DW_TAG_subprogram]: We here explicitly distinguish between four
00482  * types of subprogram symbol-table entries.  Back-end must supply 
00483  * low/high pc (and their reloc info ) and AT_address_class (2.10) for 
00484  * all forms of subprogram, except decls, and AT_calling_convention for 
00485  * defs.
00486 */
00487 
00488 typedef struct DST_subpr_decl
00489 {
00490    USRCPOS        decl;       /* Source location */
00491    DST_STR_IDX    name;       /* Unmangled name of subroutine */
00492    DST_STR_IDX    linkage_name;  /* Mangled name of subroutine */
00493    DST_INFO_IDX   type;       /* Return type, DST_INVALID_IDX if void */
00494    DST_inline     inlin;      /* AT_inline codes (page 24 in V2, Draft 5) */
00495    DST_virtuality virtuality; /* AT_virtuality codes (page 17 in V2, Draft 5) */
00496    DST_vtable_elem_location vtable_elem_location;  /* index into virtual table */
00497    DST_CHILDREN   child;      /* Formal parameter types */
00498    DST_INFO_IDX   origin;     /* if weak name, point to original dst */
00499 } DST_SUBPR_DECL;
00500    
00501 typedef struct DST_subpr_def
00502 {
00503    USRCPOS        decl;    /* Source location */
00504    DST_STR_IDX    name;    /* Name of subroutine */
00505    DST_STR_IDX    linkage_name;  /* Mangled name of subroutine */
00506    DST_STR_IDX    pubname; /* pubnames name of subroutine (for member fns) */
00507    DST_INFO_IDX   type;    /* Return type, DST_INVALID_IDX if void */
00508    DST_ASSOC_INFO st;      /* low/high pc values through ST entry */
00509    DST_inline     inlin;   /* AT_inline codes (page 24 in V2, Draft 5) */
00510    DST_virtuality virtuality; /* AT_virtuality code (page 27 in V2, Draft 5) */
00511    DST_vtable_elem_location vtable_elem_location;  /* index into virtual table */
00512    DST_INFO_IDX   specification; /* for member function, pointer from def to
00513           * decl */
00514    DST_CHILDREN   child;   /* Formal parameter types */
00515    DST_INFO_IDX   origin;  /* for clone origin */
00516 } DST_SUBPR_DEF;
00517 
00518 typedef struct DST_subpr_memdef
00519 {
00520    USRCPOS        decl;       /* Source location */
00521    DST_INFO_IDX   spec;       /* Ptr to class/struct member */
00522    DST_ASSOC_INFO st;         /* low/high pc values through ST entry */
00523    DST_CHILDREN   child;      /* Formal parameters, and local scope */
00524 } DST_SUBPR_MEMDEF;
00525 
00526 /* "flag" is subset of 
00527  * [external, declaration, memdef, prototyped]
00528 */
00529 typedef union DST_subprogram
00530 {
00531    DST_SUBPR_MEMDEF   memdef;   /* DST_IS_memdef(flag) */
00532    DST_SUBPR_DECL     decl;     /* DST_IS_declaration(flag) */
00533    DST_SUBPR_DEF      def;      /* !DST_IS_declaration(flag) */
00534 } DST_SUBPROGRAM;
00535 
00536 #define DST_SUBPROGRAM_memdef_decl(attr) ((attr)->memdef.decl)
00537 #define DST_SUBPROGRAM_memdef_spec(attr) ((attr)->memdef.spec)
00538 #define DST_SUBPROGRAM_memdef_st(attr) ((attr)->memdef.st)
00539 #define DST_SUBPROGRAM_memdef_first_child(attr) ((attr)->memdef.child.first)
00540 #define DST_SUBPROGRAM_memdef_last_child(attr) ((attr)->memdef.child.last)
00541 
00542 #define DST_SUBPROGRAM_decl_decl(attr) ((attr)->decl.decl)
00543 #define DST_SUBPROGRAM_decl_name(attr) ((attr)->decl.name)
00544 #define DST_SUBPROGRAM_decl_linkage_name(attr) ((attr)->decl.linkage_name)
00545 #define DST_SUBPROGRAM_decl_type(attr) ((attr)->decl.type)
00546 #define DST_SUBPROGRAM_decl_inline(attr) ((attr)->decl.inlin)
00547 #define DST_SUBPROGRAM_decl_virtuality(attr) ((attr)->decl.virtuality)
00548 #define DST_SUBPROGRAM_decl_vtable_elem_location(attr) \
00549           ((attr)->decl.vtable_elem_location)
00550 #define DST_SUBPROGRAM_decl_first_child(attr) ((attr)->decl.child.first)
00551 #define DST_SUBPROGRAM_decl_last_child(attr) ((attr)->decl.child.last)
00552 #define DST_SUBPROGRAM_decl_origin(attr) ((attr)->decl.origin)
00553 
00554 #define DST_SUBPROGRAM_def_decl(attr) ((attr)->def.decl)
00555 #define DST_SUBPROGRAM_def_name(attr) ((attr)->def.name)
00556 #define DST_SUBPROGRAM_def_linkage_name(attr) ((attr)->def.linkage_name)
00557 #define DST_SUBPROGRAM_def_pubname(attr) ((attr)->def.pubname)
00558 #define DST_SUBPROGRAM_def_type(attr) ((attr)->def.type)
00559 #define DST_SUBPROGRAM_def_st(attr) ((attr)->def.st)
00560 #define DST_SUBPROGRAM_def_inline(attr) ((attr)->def.inlin)
00561 #define DST_SUBPROGRAM_def_virtuality(attr) ((attr)->def.virtuality)
00562 #define DST_SUBPROGRAM_def_vtable_elem_location(attr) \
00563         ((attr)->def.vtable_elem_location)
00564 #define DST_SUBPROGRAM_def_specification(attr) ((attr)->def.specification)
00565 #define DST_SUBPROGRAM_def_first_child(attr) ((attr)->def.child.first)
00566 #define DST_SUBPROGRAM_def_last_child(attr) ((attr)->def.child.last)
00567 #define DST_SUBPROGRAM_def_clone_origin(attr) ((attr)->def.origin)
00568 
00569 
00570 /* [tag==DW_TAG_entry_point]:  Back-end must supply 
00571 * low pc (and their reloc info )
00572 */
00573 typedef struct DST_entry_point
00574 {
00575    USRCPOS        decl;    /* Source location */
00576    DST_STR_IDX    name;    /* Name of subroutine */
00577    DST_INFO_IDX   type;    /* Return type, DST_INVALID_IDX if void */
00578    DST_ASSOC_INFO st;      /* low pc values through ST entry */
00579    DST_CHILDREN   child;   /* Formal parameter types */
00580 } DST_ENTRY_POINT; 
00581 
00582 #define DST_ENTRY_POINT_decl(attr) ((attr)->decl)
00583 #define DST_ENTRY_POINT_name(attr) ((attr)->name)
00584 #define DST_ENTRY_POINT_type(attr) ((attr)->type)
00585 #define DST_ENTRY_POINT_st(attr) ((attr)->st)
00586 #define DST_ENTRY_POINT_first_child(attr) ((attr)->child.first)
00587 #define DST_ENTRY_POINT_last_child(attr) ((attr)->child.last)
00588 
00589 /* [tag==DW_TAG_common_block]: back end supplies location
00590  * 
00591 */
00592 typedef struct DST_common_block
00593 {
00594    DST_STR_IDX    name;    /* name of common block */
00595    DST_ASSOC_INFO st;    /* for getting at_location attribute */
00596    DST_CHILDREN   child;   /* children within common block */
00597 } DST_COMMON_BLOCK;
00598 
00599 #define DST_COMMON_BLOCK_name(attr)  ((attr)->name)
00600 #define DST_COMMON_BLOCK_st(attr)  ((attr)->st)
00601 #define DST_COMMON_BLOCK_first_child(attr)  ((attr)->child.first)
00602 #define DST_COMMON_BLOCK_last_child(attr) ((attr)->child.last)
00603 
00604 
00605 /* [tag=DW_TAG_common_inclusion]: back end supplies location 
00606  *
00607 */
00608 typedef struct DST_common_incl
00609 {
00610    USRCPOS        decl;    /* Source decl location */
00611    DST_INFO_IDX   com_blk;  /* reference to common block die */
00612 } DST_COMMON_INCL;
00613 
00614 #define DST_COMMON_INCL_decl(attr) ((attr)->decl)
00615 #define DST_COMMON_INCL_com_blk(attr) ((attr)->com_blk)
00616 
00617 #ifdef KEY /* Bug 3507 */
00618 typedef struct DST_imported_decl
00619 {
00620    DST_ASSOC_INFO import;  /* Get offset into .debuginfo via back-end LABEL */
00621    DST_STR_IDX    name;    /* name of included declaration (e.g. module) */
00622 } DST_IMPORTED_DECL;
00623 #define DST_IMPORTED_DECL_import(attr)  ((attr)->import)
00624 #define DST_IMPORTED_DECL_name(attr)  ((attr)->name)
00625 
00626 typedef struct DST_module
00627 {
00628    USRCPOS        decl;       /* Source location */
00629    DST_STR_IDX    name;       /* Name of module */
00630    DST_CHILDREN   child;      /* Members of module */
00631 } DST_MODULE;
00632 #define DST_MODULE_decl(attr) ((attr)->decl)
00633 #define DST_MODULE_name(attr) ((attr)->name)
00634 #define DST_MODULE_first_child(attr) ((attr)->child.first)
00635 #define DST_MODULE_last_child(attr) ((attr)->child.last)
00636 #endif /* KEY Bug 3507 */
00637 
00638 /* [tag==DW_TAG_lexical_block]: Back-end must supply low/high pc and 
00639  * pc reloc info.
00640 */
00641 typedef struct DST_lexical_block
00642 {
00643    DST_STR_IDX    name;            /* For named blocks */
00644    DST_ASSOC_INFO low_pc;          /* Get pc value through back-end LABEL */
00645    DST_ASSOC_INFO high_pc;         /* Get pc value through back-end LABEL */
00646    DST_INFO_IDX   abstract_origin; /* When part of an inlined subroutine */
00647    DST_CHILDREN   child;           /* Local decls and inner blocks */
00648 } DST_LEXICAL_BLOCK;
00649 
00650 #define DST_LEXICAL_BLOCK_name(attr) ((attr)->name)
00651 #define DST_LEXICAL_BLOCK_low_pc(attr) ((attr)->low_pc)
00652 #define DST_LEXICAL_BLOCK_high_pc(attr) ((attr)->high_pc)
00653 #define DST_LEXICAL_BLOCK_abstract_origin(attr) ((attr)->abstract_origin)
00654 #define DST_LEXICAL_BLOCK_first_child(attr) ((attr)->child.first)
00655 #define DST_LEXICAL_BLOCK_last_child(attr) ((attr)->child.last)
00656 
00657 
00658 
00659 /* [tag==DW_TAG_label]: Back-end must supply low pc and 
00660  * pc reloc info.
00661 */
00662 typedef struct DST_label
00663 {
00664    DST_STR_IDX    name;            /* For named blocks */
00665    DST_ASSOC_INFO low_pc;          /* Get pc value through back-end LABEL */
00666    DST_INFO_IDX   abstract_origin; /* When part of an inlined subroutine */
00667 } DST_LABEL;
00668 
00669 #define DST_LABEL_name(attr) ((attr)->name)
00670 #define DST_LABEL_low_pc(attr) ((attr)->low_pc)
00671 #define DST_LABEL_abstract_origin(attr) ((attr)->abstract_origin)
00672 
00673 
00674 
00675 /* [tag==DW_TAG_variable]:  Back-end must supply start_scope offset and
00676  * location of variable (BLOCKn, REF) for automatic or defining non-const 
00677  * declarations.  We distinguish between four types of variables.
00678 */
00679 typedef struct DST_var_decl
00680 {
00681    USRCPOS      decl;  /* Source location */
00682    DST_STR_IDX  name;  /* Name of variable */
00683    DST_INFO_IDX type;  /* Type of variable */
00684 #ifdef KEY
00685    DST_STR_IDX    linkage_name;  /* Mangled name of variable */
00686 #endif
00687 } DST_VAR_DECL;
00688 
00689 typedef struct DST_var_def
00690 {
00691    USRCPOS        decl;   /* Source location */
00692    DST_STR_IDX    name;   /* Name of variable */
00693    DST_INFO_IDX   type;   /* Type of variable */
00694    DST_ASSOC_INFO st;     /* Location of variable (through back-end ST) */
00695    UINT64   offs;   /* offset of variable from st */
00696    DST_INFO_IDX   specification; /* for data member, pointer from def to
00697           * field decl */
00698    DST_INFO_IDX abstract_origin;
00699    DST_INFO_IDX dopetype;   /* Type of dope vector */
00700 #ifdef KEY
00701    DST_STR_IDX    linkage_name;  /* Mangled name of variable */
00702 #endif
00703 }  DST_VAR_DEF;
00704 
00705 typedef struct DST_var_const
00706 {
00707    USRCPOS         decl; /* Source location */
00708    DST_STR_IDX     name; /* Name of const variable */
00709    DST_INFO_IDX    type; /* Type of const variable */
00710    DST_CONST_VALUE cval; /* Constant value */
00711 } DST_VAR_CONST;
00712 
00713 typedef struct DST_var_comm
00714 {
00715    USRCPOS     decl; /* Source location */
00716    DST_STR_IDX     name; /* name of variable in common block */
00717    DST_INFO_IDX    type; /* Type of variable */
00718    DST_ASSOC_INFO  st;   /* Location of enclosing common block */
00719    UINT64      offs; /* Constant offset from base of common block */
00720    DST_INFO_IDX    dopetype;   /* Type of dope vector */
00721 } DST_VAR_COMM;
00722 
00723 
00724 typedef struct DST_var_memdef
00725 { 
00726    USRCPOS        decl;   /* Source location */
00727    DST_ASSOC_INFO st;     /* Location of variable (through back-end ST) */
00728    DST_INFO_IDX   spec;   /* Ptr to C++ class member decl */
00729 } DST_VAR_MEMDEF;
00730 
00731 
00732 /* "flag" is subset of [automatic, external, declaration, const, memdef]
00733 */
00734 typedef union DST_variable
00735 {
00736    DST_VAR_DECL   decl;      /* DST_IS_declaration(flag) */
00737    DST_VAR_DEF    def;       /* !DST_IS_declaration(flag) */
00738    DST_VAR_CONST  constant;  /* DST_IS_const(flag) */
00739    DST_VAR_COMM   comm;      /* DST_IS_comm(flag) */
00740    DST_VAR_MEMDEF memdef;    /* DST_IS_memdef(flag) */
00741 } DST_VARIABLE;
00742 
00743 #define DST_VARIABLE_decl_decl(attr) ((attr)->decl.decl)
00744 #define DST_VARIABLE_decl_name(attr) ((attr)->decl.name)
00745 #define DST_VARIABLE_decl_type(attr) ((attr)->decl.type)
00746 #ifdef KEY
00747 #define DST_VARIABLE_decl_linkage_name(attr) ((attr)->decl.linkage_name)
00748 #endif
00749 
00750 #define DST_VARIABLE_def_decl(attr) ((attr)->def.decl)
00751 #define DST_VARIABLE_def_name(attr) ((attr)->def.name)
00752 #define DST_VARIABLE_def_type(attr) ((attr)->def.type)
00753 #define DST_VARIABLE_def_st(attr) ((attr)->def.st)
00754 #define DST_VARIABLE_def_offs(attr) ((attr)->def.offs)
00755 #define DST_VARIABLE_def_specification(attr) ((attr)->def.specification)
00756 #ifdef KEY
00757 #define DST_VARIABLE_def_linkage_name(attr) ((attr)->def.linkage_name)
00758 #endif
00759 #define DST_VARIABLE_def_abstract_origin(attr) ((attr)->def.abstract_origin)
00760 #define DST_VARIABLE_def_dopetype(attr) ((attr)->def.dopetype)
00761 
00762 #define DST_VARIABLE_constant_decl(attr) ((attr)->constant.decl)
00763 #define DST_VARIABLE_constant_name(attr) ((attr)->constant.name)
00764 #define DST_VARIABLE_constant_type(attr) ((attr)->constant.type)
00765 #define DST_VARIABLE_constant_cval(attr) ((attr)->constant.cval)
00766 
00767 #define DST_VARIABLE_comm_decl(attr) ((attr)->comm.decl)
00768 #define DST_VARIABLE_comm_name(attr) ((attr)->comm.name)
00769 #define DST_VARIABLE_comm_type(attr) ((attr)->comm.type)
00770 #define DST_VARIABLE_comm_st(attr) ((attr)->comm.st)
00771 #define DST_VARIABLE_comm_offs(attr) ((attr)->comm.offs)
00772 #define DST_VARIABLE_comm_dopetype(attr) ((attr)->comm.dopetype)
00773 
00774 #define DST_VARIABLE_memdef_decl(attr) ((attr)->memdef.decl)
00775 #define DST_VARIABLE_memdef_st(attr) ((attr)->memdef.st)
00776 #define DST_VARIABLE_memdef_spec(attr) ((attr)->memdef.spec)
00777 
00778 
00779 
00780 /* [tag==DW_TAG_formal_parameter]: Back-end must supply run-time
00781  * location of variable (BLOCKn, REF) if belonging to a definition.
00782  *
00783  * "flag" is subset of [optional, variable_parameter]
00784 */
00785 typedef struct DST_formal_parameter
00786 {
00787    USRCPOS      decl;             /* Source location */
00788    DST_STR_IDX  name;             /* Name of parameter */
00789    DST_INFO_IDX type;             /* Type of parameter */
00790    DST_ASSOC_INFO st;         /* Location of variable (through back-end ST) */
00791    DST_INFO_IDX abstract_origin;  /* When part of an inlined subroutine */
00792    DST_INFO_IDX default_val;      /* Default value of (C++) parameter */
00793    DST_INFO_IDX dopetype;         /* Type of dope vector */
00794 } DST_FORMAL_PARAMETER;
00795 
00796 #define DST_FORMAL_PARAMETER_decl(attr) ((attr)->decl)
00797 #define DST_FORMAL_PARAMETER_name(attr) ((attr)->name)
00798 #define DST_FORMAL_PARAMETER_type(attr) ((attr)->type)
00799 #define DST_FORMAL_PARAMETER_st(attr) ((attr)->st)
00800 #define DST_FORMAL_PARAMETER_abstract_origin(attr) ((attr)->abstract_origin)
00801 #define DST_FORMAL_PARAMETER_default_val(attr) ((attr)->default_val)
00802 #define DST_FORMAL_PARAMETER_dopetype(attr) ((attr)->dopetype)
00803 
00804 
00805 
00806 /* [tag==DW_TAG_unspecified_parameters]
00807 */
00808 typedef struct DST_unspecified_parameters
00809 {
00810    USRCPOS      decl;             /* Source location */
00811    DST_INFO_IDX abstract_origin;  /* When part of an inlined subroutine */
00812 } DST_UNSPECIFIED_PARAMETERS;
00813 
00814 #define DST_UNSPECIFIED_PARAMETERS_decl(attr) ((attr)->decl)
00815 #define DST_UNSPECIFIED_PARAMETERS_abstract_origin(attr)\
00816    ((attr)->abstract_origin)
00817 
00818 
00819 
00820 /* [tag==DW_TAG_constant]
00821  * "flag" is subset of [declaration, external]
00822 */
00823 typedef struct DST_const_def
00824 {
00825    USRCPOS         decl;  /* Source location */
00826    DST_STR_IDX     name;  /* Name of constant */
00827    DST_INFO_IDX    type;  /* Type of constant */
00828    DST_CONST_VALUE cval;  /* Constant value, only if not declaration */
00829 } DST_CONST_DEF;
00830 
00831 typedef struct DST_const_decl
00832 {
00833    USRCPOS         decl;  /* Source location */
00834    DST_INFO_IDX    name;  /* Name of constant */
00835    DST_INFO_IDX    type;  /* Type of constant */
00836 } DST_CONST_DECL;
00837 
00838 typedef union DST_constant
00839 {
00840    DST_CONST_DECL  decl;  /* Non-defining declaration */
00841    DST_CONST_DEF   def;   /* Defining declaration */
00842 } DST_CONSTANT;
00843 
00844 #define DST_CONSTANT_decl_decl(attr) ((attr)->decl.decl)
00845 #define DST_CONSTANT_decl_name(attr) ((attr)->decl.name)
00846 #define DST_CONSTANT_decl_type(attr) ((attr)->decl.type)
00847 
00848 #define DST_CONSTANT_def_decl(attr) ((attr)->def.decl)
00849 #define DST_CONSTANT_def_name(attr) ((attr)->def.name)
00850 #define DST_CONSTANT_def_type(attr) ((attr)->def.type)
00851 #define DST_CONSTANT_def_cval(attr) ((attr)->def.cval)
00852 
00853 
00854 
00855 /* [tag==DW_TAG_base_type]
00856 */
00857 typedef struct DST_basetype
00858 {
00859    DST_STR_IDX      name;      /* Name of type */
00860    DST_ATE_encoding encoding;  /* How to encode/interpret these objects */
00861    DST_size_t       byte_size; /* Size of object of this type */
00862 } DST_BASETYPE;
00863 
00864 #define DST_BASETYPE_name(attr) ((attr)->name)
00865 #define DST_BASETYPE_encoding(attr) ((attr)->encoding)
00866 #define DST_BASETYPE_byte_size(attr) ((attr)->byte_size)
00867 
00868 
00869 
00870 /* [tag==DW_TAG_const_type]: The back-end must supply the AT_start_scope
00871  * attribute.
00872 */
00873 typedef struct DST_qualified_type
00874 {
00875    DST_INFO_IDX type;    /* Type that is qualified */
00876 } DST_QUALIFIED_TYPE;
00877 
00878 typedef DST_QUALIFIED_TYPE DST_CONST_TYPE;
00879 #define DST_CONST_TYPE_type(attr) ((attr)->type)
00880 
00881 
00882 
00883 /* [tag==DW_TAG_volatile_type]: The back-end must supply the AT_start_scope
00884  * attribute.
00885 */
00886 typedef DST_QUALIFIED_TYPE DST_VOLATILE_TYPE;
00887 #define DST_VOLATILE_TYPE_type(attr) ((attr)->type)
00888 
00889 
00890 
00891 /* [tag==DW_TAG_pointer_type]:  The back-end must supply the AT_start_scope
00892  * attribute.  The AT_address_class attribute would normally be DW_ADDR_none!
00893 */
00894 typedef struct DST_pointer_type
00895 {
00896    DST_INFO_IDX   type;
00897       /* Type that is pointed to, DST_INVALID_IDX if void */
00898 
00899    DST_addr_class address_class;
00900       /* How to dereference objects of this type */
00901 
00902    DST_size_t     byte_size;
00903       /* Size of pointer type (4 or 8 bytes) */
00904 } DST_POINTER_TYPE;
00905 
00906 #define DST_POINTER_TYPE_type(attr) ((attr)->type)
00907 #define DST_POINTER_TYPE_address_class(attr) ((attr)->address_class)
00908 #define DST_POINTER_TYPE_byte_size(attr) ((attr)->byte_size)
00909 
00910 
00911 
00912 /* [tag==DW_TAG_reference_type]:  The back-end must supply the AT_start_scope
00913  * attribute.  The AT_address_class attribute would normally be DW_ADDR_none!
00914 */
00915 typedef DST_POINTER_TYPE DST_REFERENCE_TYPE;
00916 
00917 #define DST_REFERENCE_TYPE_type(attr) ((attr)->type)
00918 #define DST_REFERENCE_TYPE_address_class(attr) ((attr)->address_class)
00919 #define DST_REFERENCE_TYPE_byte_size(attr) ((attr)->byte_size)
00920 
00921 
00922 
00923 /* [tag==DW_TAG_typedef]:  The back-end must supply the AT_start_scope
00924  * attribute.
00925 */
00926 typedef struct DST_typedef
00927 {
00928    USRCPOS      decl; /* Source location */
00929    DST_STR_IDX  name; /* Name of type */
00930    DST_INFO_IDX type; /* Defining type, NULL for incomplete declaration */
00931    DST_INFO_IDX abstract_origin; /* Defined inside inlined proc */
00932 } DST_TYPEDEF;
00933 
00934 #define DST_TYPEDEF_decl(attr) ((attr)->decl)
00935 #define DST_TYPEDEF_name(attr) ((attr)->name)
00936 #define DST_TYPEDEF_type(attr) ((attr)->type)
00937 #define DST_TYPEDEF_abstract_origin(attr) ((attr)->abstract_origin)
00938 
00939 
00940 
00941 /* [tag==DW_TAG_array_type]:  The back-end must supply the AT_start_scope
00942  * attribute.  "flags" in [declaration].
00943 */
00944 typedef struct DST_array_type   /* Assume row-major order for multi-dim. */
00945 {
00946    USRCPOS      decl;      /* Source location */
00947    DST_STR_IDX  name;      /* Name of type */
00948    DST_INFO_IDX type;      /* Element type */
00949    DST_size_t   byte_size; /* Size of array, if known at compile time */
00950    DST_INFO_IDX abstract_origin; /* Defined inside inlined proc */
00951    DST_CHILDREN child;     /* Bounds for each dimension (DST_subrange_type) */
00952 } DST_ARRAY_TYPE;
00953 
00954 #define DST_ARRAY_TYPE_decl(attr) ((attr)->decl)
00955 #define DST_ARRAY_TYPE_name(attr) ((attr)->name)
00956 #define DST_ARRAY_TYPE_type(attr) ((attr)->type)
00957 #define DST_ARRAY_TYPE_byte_size(attr) ((attr)->byte_size)
00958 #define DST_ARRAY_TYPE_abstract_origin(attr) ((attr)->abstract_origin)
00959 #define DST_ARRAY_TYPE_first_child(attr) ((attr)->child.first)
00960 #define DST_ARRAY_TYPE_last_child(attr) ((attr)->child.last)
00961 
00962 
00963 
00964 /* [tag==DW_TAG_subrange_type]: Represents array bounds (child of 
00965  * array_type).
00966 */
00967 typedef union 
00968 {
00969    DST_bounds_t cval;
00970    DST_INFO_IDX ref;
00971 } DST_cval_ref;
00972 
00973 typedef struct DST_subrange_type
00974 {
00975    DST_cval_ref lower;    /* lower bound */
00976    DST_cval_ref upper;    /* upper bound */
00977    DST_cval_ref stride;   /* stride - for non-contiguous sections (F90) */
00978 } DST_SUBRANGE_TYPE;
00979 
00980 #define DST_SUBRANGE_TYPE_count(attr) ((attr)->upper.cval - (attr)->lower.cval + 1)
00981 #define DST_SUBRANGE_TYPE_lower_cval(attr) ((attr)->lower.cval)
00982 #define DST_SUBRANGE_TYPE_upper_cval(attr) ((attr)->upper.cval)
00983 #define DST_SUBRANGE_TYPE_lower_ref(attr) ((attr)->lower.ref)
00984 #define DST_SUBRANGE_TYPE_upper_ref(attr) ((attr)->upper.ref)
00985 #define DST_SUBRANGE_TYPE_stride_ref(attr) ((attr)->stride.ref)
00986 
00987 
00988 /* [tag==DW_TAG_string_type]: Represents FORTRAN or pascal string 
00989  * type.
00990 */
00991 typedef struct DST_string_type
00992 {
00993    USRCPOS  decl;    /* Source location */
00994    DST_STR_IDX  name;      /* Name of type */
00995    DST_cval_ref len;     /* length of string */
00996 } DST_STRING_TYPE;
00997 
00998 #define DST_STRING_TYPE_decl(attr) ((attr)->decl)
00999 #define DST_STRING_TYPE_name(attr) ((attr)->name)
01000 #define DST_STRING_TYPE_len_cval(attr) ((attr)->len.cval)
01001 #define DST_STRING_TYPE_len_ref(attr) ((attr)->len.ref)
01002 
01003 
01004 /* [tag==DW_TAG_structure_type]:  The back-end must supply the AT_start_scope
01005  * attribute.  "flag" is subset of [declaration]
01006 */
01007 typedef struct DST_structure_type
01008 {
01009    USRCPOS      decl;      /* Source location */
01010    DST_STR_IDX  name;      /* Name of type */
01011    DST_size_t   byte_size; /* Size of struct, if known at compile time */
01012    DST_INFO_IDX abstract_origin; /* Inside inlined instance of proc. */
01013    DST_INFO_IDX inheritance; /* Inheritance entries (DW_TAG_inheritance) */
01014    DST_CHILDREN child;     /* Struct members (DW_TAG_member) */
01015 } DST_STRUCTURE_TYPE;
01016 
01017 #define DST_STRUCTURE_TYPE_decl(attr) ((attr)->decl)
01018 #define DST_STRUCTURE_TYPE_name(attr) ((attr)->name)
01019 #define DST_STRUCTURE_TYPE_byte_size(attr) ((attr)->byte_size)
01020 #define DST_STRUCTURE_TYPE_abstract_origin(attr) ((attr)->abstract_origin)
01021 #define DST_STRUCTURE_TYPE_inheritance(attr) ((attr)->inheritance)
01022 #define DST_STRUCTURE_TYPE_first_child(attr) ((attr)->child.first)
01023 #define DST_STRUCTURE_TYPE_last_child(attr) ((attr)->child.last)
01024 
01025 
01026 
01027 /* [tag==DW_TAG_union_type]:  The back-end must supply the AT_start_scope
01028  * attribute.
01029 */
01030 typedef DST_STRUCTURE_TYPE DST_UNION_TYPE;
01031 
01032 #define DST_UNION_TYPE_decl(attr) ((attr)->decl)
01033 #define DST_UNION_TYPE_name(attr) ((attr)->name)
01034 #define DST_UNION_TYPE_byte_size(attr) ((attr)->byte_size)
01035 #define DST_UNION_TYPE_abstract_origin(attr) ((attr)->abstract_origin)
01036 #define DST_UNION_TYPE_inheritance(attr) ((attr)->inheritance)
01037 #define DST_UNION_TYPE_first_child(attr) ((attr)->child.first)
01038 #define DST_UNION_TYPE_last_child(attr) ((attr)->child.last)
01039 
01040 
01041 
01042 /* [tag==DW_TAG_class_type]:  The back-end must supply the AT_start_scope
01043  * attribute.
01044 */
01045 typedef DST_STRUCTURE_TYPE DST_CLASS_TYPE;
01046 
01047 #define DST_CLASS_TYPE_decl(attr) ((attr)->decl)
01048 #define DST_CLASS_TYPE_name(attr) ((attr)->name)
01049 #define DST_CLASS_TYPE_byte_size(attr) ((attr)->byte_size)
01050 #define DST_CLASS_TYPE_abstract_origin(attr) ((attr)->abstract_origin)
01051 #define DST_CLASS_TYPE_inheritance(attr) ((attr)->inheritance)
01052 #define DST_CLASS_TYPE_first_child(attr) ((attr)->child.first)
01053 #define DST_CLASS_TYPE_last_child(attr) ((attr)->child.last)
01054 
01055 
01056 /* [tag==DW_TAG_member]
01057  *
01058  * "flag" is subset of [declaration bitfield]
01059 */
01060 typedef struct DST_member
01061 {
01062    USRCPOS      decl;      /* Source location */
01063    DST_STR_IDX  name;         /* Name of member */
01064    DST_INFO_IDX type;         /* Type of member */
01065    DST_size_t   memb_loc;     /* Offset of member (data-block) within
01066                struct/class  (0 for union) */
01067    DST_size_t   byte_size;    /* Size of bitfield data-block */
01068    DST_bitsize  bit_offset;   /* Offset of bitfield within block */
01069    DST_bitsize  bit_size;     /* Size of bitfield */
01070    DST_INFO_IDX dopetype;     /* Type of dope vector */
01071 #ifdef KEY
01072    DST_accessibility accessibility; /* AT_accessibility */
01073 #endif
01074 } DST_MEMBER;
01075 
01076 #define DST_MEMBER_decl(attr) ((attr)->decl)
01077 #define DST_MEMBER_name(attr) ((attr)->name)
01078 #define DST_MEMBER_type(attr) ((attr)->type)
01079 #define DST_MEMBER_memb_loc(attr) ((attr)->memb_loc)
01080 #define DST_MEMBER_byte_size(attr) ((attr)->byte_size)
01081 #define DST_MEMBER_bit_offset(attr) ((attr)->bit_offset)
01082 #define DST_MEMBER_bit_size(attr) ((attr)->bit_size)
01083 #define DST_MEMBER_dopetype(attr) ((attr)->dopetype)
01084 #ifdef KEY
01085 #define DST_MEMBER_accessibility(attr) ((attr)->accessibility)
01086 #endif
01087 
01088 
01089 
01090 /* [tag==DW_TAG_inheritance]
01091  *
01092 */
01093 typedef struct DST_inheritance
01094 {
01095    USRCPOS        decl;         /* Source location */
01096    DST_INFO_IDX   type;         /* Type of member */
01097    DST_virtuality virtuality;   /* AT_virtuality codes (Page 17, V2, Draft 5) */
01098    DST_size_t     memb_loc;     /* Offset of member (data-block) within
01099                struct/class  (0 for union) */
01100 #ifdef KEY
01101    DST_accessibility  accessibility;/* Accessibility for C++ */ 
01102 #endif
01103 } DST_INHERITANCE;
01104 
01105 #define DST_INHERITANCE_decl(attr)      ((attr)->decl)
01106 #define DST_INHERITANCE_type(attr)      ((attr)->type)
01107 #define DST_INHERITANCE_virtuality(attr) ((attr)->virtuality)
01108 #define DST_INHERITANCE_memb_loc(attr)  ((attr)->memb_loc)
01109 #ifdef KEY
01110 #define DST_INHERITANCE_accessibility(attr) ((attr)->accessibility)
01111 #endif
01112 
01113 
01114 
01115 /* [tag==DW_TAG_template_type_parameter]
01116  *
01117 */
01118 typedef struct DST_template_type_parameter
01119 {
01120    USRCPOS      decl;         /* Source location */
01121    DST_STR_IDX  name;         /* Name of formal type parameter */
01122    DST_INFO_IDX type;         /* Actual parameter type */
01123 } DST_TEMPLATE_TYPE_PARAMETER;
01124 
01125 #define DST_TEMPLATE_TYPE_PARAMETER_decl(attr) ((attr)->decl)
01126 #define DST_TEMPLATE_TYPE_PARAMETER_name(attr) ((attr)->name)
01127 #define DST_TEMPLATE_TYPE_PARAMETER_type(attr) ((attr)->type)
01128 
01129 
01130 
01131 /* [tag==DW_TAG_template_value_parameter]
01132  *
01133 */
01134 typedef struct DST_template_value_parameter
01135 {
01136    USRCPOS         decl;         /* Source location */
01137    DST_STR_IDX     name;         /* Name of formal type parameter */
01138    DST_INFO_IDX    type;         /* Actual parameter type */
01139    DST_CONST_VALUE cval;         /* Constant value, only if not declaration */
01140 } DST_TEMPLATE_VALUE_PARAMETER;
01141 
01142 #define DST_TEMPLATE_VALUE_PARAMETER_decl(attr) ((attr)->decl)
01143 #define DST_TEMPLATE_VALUE_PARAMETER_name(attr) ((attr)->name)
01144 #define DST_TEMPLATE_VALUE_PARAMETER_type(attr) ((attr)->type)
01145 #define DST_TEMPLATE_VALUE_PARAMETER_cval(attr) ((attr)->cval)
01146 
01147 
01148 
01149 /* [tag==DW_TAG_enumeration_type]:  The back-end must supply the 
01150  * AT_start_scope attribute.
01151  *
01152  * "flag" is subset of [declaration]
01153 */
01154 typedef struct DST_enumeration_type
01155 {
01156    USRCPOS      decl;      /* Source location */
01157    DST_STR_IDX  name;      /* Name of type */
01158    DST_size_t   byte_size; /* Size of enumeration objects */
01159    DST_INFO_IDX abstract_origin; /* Declared in inlined instance of proc. */
01160    DST_CHILDREN child;     /* enumerators (DW_TAG_enumerator entries) */
01161 } DST_ENUMERATION_TYPE;
01162 
01163 #define DST_ENUMERATION_TYPE_decl(attr) ((attr)->decl)
01164 #define DST_ENUMERATION_TYPE_name(attr) ((attr)->name)
01165 #define DST_ENUMERATION_TYPE_byte_size(attr) ((attr)->byte_size)
01166 #define DST_ENUMERATION_TYPE_abstract_origin(attr) ((attr)->abstract_origin)
01167 #define DST_ENUMERATION_TYPE_first_child(attr) ((attr)->child.first)
01168 #define DST_ENUMERATION_TYPE_last_child(attr) ((attr)->child.last)
01169 
01170 
01171 
01172 /* [tag==DW_TAG_enumerator]
01173 */
01174 typedef struct DST_enumerator
01175 {
01176    USRCPOS         decl;    /* Source location */
01177    DST_STR_IDX     name;    /* Name of type */
01178    DST_CONST_VALUE cval;    /* Enumeration value */
01179 } DST_ENUMERATOR;
01180 
01181 #define DST_ENUMERATOR_decl(attr) ((attr)->decl)
01182 #define DST_ENUMERATOR_name(attr) ((attr)->name)
01183 #define DST_ENUMERATOR_cval(attr) ((attr)->cval)
01184 
01185 
01186 
01187 /* [tag==DW_TAG_subroutine_type]
01188  *
01189  * "flag" is subset of [prototyped]
01190 */
01191 typedef struct DST_subroutine_type
01192 {
01193    USRCPOS      decl;   /* Source location */
01194    DST_STR_IDX  name;   /* Name of type */
01195    DST_INFO_IDX type;   /* Return type, DST_INVALID_IDX if void */
01196    DST_INFO_IDX abstract_origin; /* In inlined proc. instance */
01197    DST_CHILDREN child;  /* Parameters (may have unspecified param) */
01198 } DST_SUBROUTINE_TYPE;
01199 
01200 #define DST_SUBROUTINE_TYPE_decl(attr) ((attr)->decl)
01201 #define DST_SUBROUTINE_TYPE_name(attr) ((attr)->name)
01202 #define DST_SUBROUTINE_TYPE_type(attr) ((attr)->type)
01203 #define DST_SUBROUTINE_TYPE_abstract_origin(attr) ((attr)->abstract_origin)
01204 #define DST_SUBROUTINE_TYPE_first_child(attr) ((attr)->child.first)
01205 #define DST_SUBROUTINE_TYPE_last_child(attr) ((attr)->child.last)
01206 
01207 
01208 /* [tag==DW_TAG_ptr_to_member_type]: Back-end must supply run-time location
01209  * of member pointed to (.debug_loc offset).
01210 */
01211 typedef struct DST_ptr_to_member_type
01212 {
01213    DST_STR_IDX  name;       /* Name of member pointed to */
01214    DST_INFO_IDX type;       /* Type of member pointed to */
01215    DST_INFO_IDX class_type; /* Type of class of member pointed to */
01216 } DST_PTR_TO_MEMBER_TYPE;
01217 
01218 #define DST_PTR_TO_MEMBER_TYPE_name(attr) ((attr)->name)
01219 #define DST_PTR_TO_MEMBER_TYPE_type(attr) ((attr)->type)
01220 #define DST_PTR_TO_MEMBER_TYPE_class_type(attr) ((attr)->class_type)
01221 
01222 
01223 
01224       /*--------------------------------*
01225       * General purpose routines/macros *
01226       *--------------------------------*/
01227 
01228 
01229 /* Converts an index to a pointer to an object of the given type.
01230 */
01231 #define DST_IDX_TO_PTR(i, btype) ((btype *)DST_idx_to_string(i))
01232 #define DST_INFO_IDX_TO_PTR(i) ((DST_INFO *)DST_idx_to_string(i))
01233 #define DST_ATTR_IDX_TO_PTR(i, attr_struct) DST_IDX_TO_PTR(i, attr_struct)
01234 #define DST_FILE_IDX_TO_PTR(i) ((DST_FILE_NAME *)DST_idx_to_string(i))
01235 #define DST_DIR_IDX_TO_PTR(i) ((DST_INCLUDE_DIR *)DST_idx_to_string(i))
01236 #define DST_STR_IDX_TO_PTR(i) ((char *)DST_idx_to_string(i))
01237 #ifdef KEY
01238 #define DST_MACR_IDX_TO_PTR(i) ((DST_MACR *)DST_idx_to_string(i))
01239 #endif
01240 
01241 #ifdef KEY
01242 /* [tag==DW_TAG_namelist]
01243 */
01244 typedef struct DST_namelist
01245 {
01246    USRCPOS      decl;      /* Source location */
01247    DST_STR_IDX  name;      /* Name of type */
01248    DST_CHILDREN child;     /* namelist items (DW_TAG_namelist_item entries) */
01249 } DST_NAMELIST;
01250 
01251 #define DST_NAMELIST_decl(attr) ((attr)->decl)
01252 #define DST_NAMELIST_name(attr) ((attr)->name)
01253 #define DST_NAMELIST_first_child(attr) ((attr)->child.first)
01254 #define DST_NAMELIST_last_child(attr) ((attr)->child.last)
01255 
01256 /* [tag==DW_TAG_namelist_item]
01257 */
01258 typedef struct DST_namelist_item
01259 {
01260    USRCPOS      decl;      /* Source location */
01261    DST_STR_IDX  name;      /* Name of type */
01262 } DST_NAMELIST_ITEM;
01263 
01264 #define DST_NAMELIST_ITEM_decl(attr) ((attr)->decl)
01265 #define DST_NAMELIST_ITEM_name(attr) ((attr)->name)
01266 #endif
01267 
01268 
01269 
01270     /*-----------------------------------------------------------------
01271     * Routines for traversing the child/sibling structure of DST nodes 
01272     *------------------------------------------------------------------*/
01273 
01274 
01275 /* When the entry has no child attribute or the child attribute is null 
01276  * (DST_IS_NULL) then an invalid idx is returned (DST_INVALID_IDX),
01277  * otherwise an index to the first child is returned.
01278 */
01279 extern DST_INFO_IDX DST_first_child(DST_INFO_IDX parent);
01280 extern DST_INFO_IDX DST_last_child(DST_INFO_IDX parent);
01281 
01282 
01283 
01284 /* Appends a child to the end of the list of children (linked by sibling 
01285  * indices) of the "parent".  The child may be the first child of the
01286  * parent.
01287 */
01288 extern void
01289 DST_append_child(DST_INFO_IDX parent, DST_INFO_IDX child);
01290 
01291 
01292 
01293 /* Used to traverse the DST subgraph rooted at "i".  Note that we
01294  * only follow child/sibling pointers, and the graph will therefore
01295  * appear as a tree (a node can only be the child of at most one parent,
01296  * and the sibling of at most one predecessor).  The parameters are the 
01297  * root of the tree to be traversed ("i"), an initial value to be used in
01298  * visiting the root of the tree ("init_val"), and an action to be
01299  * performed on each tree-node encountered in the pre-order tree-walk
01300  * ("action"). The action takes the value returned from the action on the
01301  * parent, as well as the tag, flag, attribute, and index of the node
01302  * currently visited.
01303 */
01304 extern void
01305 DST_preorder_visit(
01306    DST_INFO_IDX i,
01307    INT32        init_val, 
01308    INT32 (*action)(INT32, DST_DW_tag, DST_flag, DST_ATTR_IDX, DST_INFO_IDX));
01309 
01310 
01311 #ifdef __cplusplus
01312 }
01313 #endif
01314 #endif /* dwarf_DST_INCLUDED */
01315
osprey/common/com/dwarf_DST.h
