2 /*--------------------------------------------------------------------*/
3 /*--- Basic definitions and helper functions for DWARF3. ---*/
5 /*--------------------------------------------------------------------*/
8 This file is part of Valgrind, a dynamic binary instrumentation
11 Copyright (C) 2008-2017 OpenWorks LLP
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation; either version 2 of the
17 License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful, but
20 WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 General Public License for more details.
24 You should have received a copy of the GNU General Public License
25 along with this program; if not, write to the Free Software
26 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
29 The GNU General Public License is contained in the file COPYING.
31 Neither the names of the U.S. Department of Energy nor the
32 University of California nor the names of its contributors may be
33 used to endorse or promote products derived from this software
34 without prior written permission.
37 #include "pub_core_basics.h"
38 #include "pub_core_debuginfo.h"
39 #include "pub_core_libcassert.h"
40 #include "pub_core_libcprint.h"
41 #include "pub_core_libcbase.h"
42 #include "pub_core_options.h"
43 #include "pub_core_xarray.h"
45 #include "pub_core_vki.h" /* VKI_PROT_READ */
46 #include "pub_core_aspacemgr.h" /* VG_(is_valid_for_client) */
48 #include "priv_misc.h"
49 #include "priv_image.h"
50 #include "priv_d3basics.h" /* self */
51 #include "priv_storage.h"
53 const HChar
* ML_(pp_DW_children
) ( DW_children hashch
)
56 case DW_children_no
: return "no children";
57 case DW_children_yes
: return "has children";
59 return "DW_children_???";
62 const HChar
* ML_(pp_DW_TAG
) ( DW_TAG tag
)
65 case DW_TAG_padding
: return "DW_TAG_padding";
66 case DW_TAG_array_type
: return "DW_TAG_array_type";
67 case DW_TAG_class_type
: return "DW_TAG_class_type";
68 case DW_TAG_entry_point
: return "DW_TAG_entry_point";
69 case DW_TAG_enumeration_type
: return "DW_TAG_enumeration_type";
70 case DW_TAG_formal_parameter
: return "DW_TAG_formal_parameter";
71 case DW_TAG_imported_declaration
:
72 return "DW_TAG_imported_declaration";
73 case DW_TAG_label
: return "DW_TAG_label";
74 case DW_TAG_lexical_block
: return "DW_TAG_lexical_block";
75 case DW_TAG_member
: return "DW_TAG_member";
76 case DW_TAG_pointer_type
: return "DW_TAG_pointer_type";
77 case DW_TAG_reference_type
: return "DW_TAG_reference_type";
78 case DW_TAG_compile_unit
: return "DW_TAG_compile_unit";
79 case DW_TAG_string_type
: return "DW_TAG_string_type";
80 case DW_TAG_structure_type
: return "DW_TAG_structure_type";
81 case DW_TAG_subroutine_type
: return "DW_TAG_subroutine_type";
82 case DW_TAG_typedef
: return "DW_TAG_typedef";
83 case DW_TAG_union_type
: return "DW_TAG_union_type";
84 case DW_TAG_unspecified_parameters
:
85 return "DW_TAG_unspecified_parameters";
86 case DW_TAG_variant
: return "DW_TAG_variant";
87 case DW_TAG_common_block
: return "DW_TAG_common_block";
88 case DW_TAG_common_inclusion
: return "DW_TAG_common_inclusion";
89 case DW_TAG_inheritance
: return "DW_TAG_inheritance";
90 case DW_TAG_inlined_subroutine
:
91 return "DW_TAG_inlined_subroutine";
92 case DW_TAG_module
: return "DW_TAG_module";
93 case DW_TAG_ptr_to_member_type
: return "DW_TAG_ptr_to_member_type";
94 case DW_TAG_set_type
: return "DW_TAG_set_type";
95 case DW_TAG_subrange_type
: return "DW_TAG_subrange_type";
96 case DW_TAG_with_stmt
: return "DW_TAG_with_stmt";
97 case DW_TAG_access_declaration
: return "DW_TAG_access_declaration";
98 case DW_TAG_base_type
: return "DW_TAG_base_type";
99 case DW_TAG_catch_block
: return "DW_TAG_catch_block";
100 case DW_TAG_const_type
: return "DW_TAG_const_type";
101 case DW_TAG_constant
: return "DW_TAG_constant";
102 case DW_TAG_enumerator
: return "DW_TAG_enumerator";
103 case DW_TAG_file_type
: return "DW_TAG_file_type";
104 case DW_TAG_friend
: return "DW_TAG_friend";
105 case DW_TAG_namelist
: return "DW_TAG_namelist";
106 case DW_TAG_namelist_item
: return "DW_TAG_namelist_item";
107 case DW_TAG_packed_type
: return "DW_TAG_packed_type";
108 case DW_TAG_subprogram
: return "DW_TAG_subprogram";
109 case DW_TAG_template_type_param
:
110 return "DW_TAG_template_type_param";
111 case DW_TAG_template_value_param
:
112 return "DW_TAG_template_value_param";
113 case DW_TAG_thrown_type
: return "DW_TAG_thrown_type";
114 case DW_TAG_try_block
: return "DW_TAG_try_block";
115 case DW_TAG_variant_part
: return "DW_TAG_variant_part";
116 case DW_TAG_variable
: return "DW_TAG_variable";
117 case DW_TAG_volatile_type
: return "DW_TAG_volatile_type";
119 case DW_TAG_dwarf_procedure
: return "DW_TAG_dwarf_procedure";
120 case DW_TAG_restrict_type
: return "DW_TAG_restrict_type";
121 case DW_TAG_interface_type
: return "DW_TAG_interface_type";
122 case DW_TAG_namespace
: return "DW_TAG_namespace";
123 case DW_TAG_imported_module
: return "DW_TAG_imported_module";
124 case DW_TAG_unspecified_type
: return "DW_TAG_unspecified_type";
125 case DW_TAG_partial_unit
: return "DW_TAG_partial_unit";
126 case DW_TAG_imported_unit
: return "DW_TAG_imported_unit";
127 case DW_TAG_condition
: return "DW_TAG_condition";
128 case DW_TAG_shared_type
: return "DW_TAG_shared_type";
130 case DW_TAG_type_unit
: return "DW_TAG_type_unit";
131 case DW_TAG_rvalue_reference_type
: return "DW_TAG_rvalue_reference_type";
132 case DW_TAG_template_alias
: return "DW_TAG_template_alias";
133 /* SGI/MIPS Extensions. */
134 case DW_TAG_MIPS_loop
: return "DW_TAG_MIPS_loop";
135 /* HP extensions. See:
136 ftp://ftp.hp.com/pub/lang/tools/WDB/wdb-4.0.tar.gz . */
137 case DW_TAG_HP_array_descriptor
:
138 return "DW_TAG_HP_array_descriptor";
139 /* GNU extensions. */
140 case DW_TAG_format_label
: return "DW_TAG_format_label";
141 case DW_TAG_function_template
: return "DW_TAG_function_template";
142 case DW_TAG_class_template
: return "DW_TAG_class_template";
143 case DW_TAG_GNU_BINCL
: return "DW_TAG_GNU_BINCL";
144 case DW_TAG_GNU_EINCL
: return "DW_TAG_GNU_EINCL";
145 /* Extensions for UPC. See: http://upc.gwu.edu/~upc. */
146 case DW_TAG_upc_shared_type
: return "DW_TAG_upc_shared_type";
147 case DW_TAG_upc_strict_type
: return "DW_TAG_upc_strict_type";
148 case DW_TAG_upc_relaxed_type
: return "DW_TAG_upc_relaxed_type";
149 /* PGI (STMicroelectronics) extensions. No documentation available. */
150 case DW_TAG_PGI_kanji_type
: return "DW_TAG_PGI_kanji_type";
151 case DW_TAG_PGI_interface_block
:
152 return "DW_TAG_PGI_interface_block";
157 const HChar
* ML_(pp_DW_FORM
) ( DW_FORM form
)
160 case DW_FORM_addr
: return "DW_FORM_addr";
161 case DW_FORM_block2
: return "DW_FORM_block2";
162 case DW_FORM_block4
: return "DW_FORM_block4";
163 case DW_FORM_data2
: return "DW_FORM_data2";
164 case DW_FORM_data4
: return "DW_FORM_data4";
165 case DW_FORM_data8
: return "DW_FORM_data8";
166 case DW_FORM_string
: return "DW_FORM_string";
167 case DW_FORM_block
: return "DW_FORM_block";
168 case DW_FORM_block1
: return "DW_FORM_block1";
169 case DW_FORM_data1
: return "DW_FORM_data1";
170 case DW_FORM_flag
: return "DW_FORM_flag";
171 case DW_FORM_sdata
: return "DW_FORM_sdata";
172 case DW_FORM_strp
: return "DW_FORM_strp";
173 case DW_FORM_udata
: return "DW_FORM_udata";
174 case DW_FORM_ref_addr
: return "DW_FORM_ref_addr";
175 case DW_FORM_ref1
: return "DW_FORM_ref1";
176 case DW_FORM_ref2
: return "DW_FORM_ref2";
177 case DW_FORM_ref4
: return "DW_FORM_ref4";
178 case DW_FORM_ref8
: return "DW_FORM_ref8";
179 case DW_FORM_ref_udata
: return "DW_FORM_ref_udata";
180 case DW_FORM_indirect
: return "DW_FORM_indirect";
181 case DW_FORM_sec_offset
:return "DW_FORM_sec_offset";
182 case DW_FORM_exprloc
: return "DW_FORM_exprloc";
183 case DW_FORM_flag_present
:return "DW_FORM_flag_present";
184 case DW_FORM_ref_sig8
: return "DW_FORM_ref_sig8";
185 case DW_FORM_GNU_ref_alt
:return "DW_FORM_GNU_ref_alt";
186 case DW_FORM_GNU_strp_alt
:return "DW_FORM_GNU_strp_alt";
188 return "DW_FORM_???";
191 const HChar
* ML_(pp_DW_AT
) ( DW_AT attr
)
194 case DW_AT_sibling
: return "DW_AT_sibling";
195 case DW_AT_location
: return "DW_AT_location";
196 case DW_AT_name
: return "DW_AT_name";
197 case DW_AT_ordering
: return "DW_AT_ordering";
198 case DW_AT_subscr_data
: return "DW_AT_subscr_data";
199 case DW_AT_byte_size
: return "DW_AT_byte_size";
200 case DW_AT_bit_offset
: return "DW_AT_bit_offset";
201 case DW_AT_bit_size
: return "DW_AT_bit_size";
202 case DW_AT_element_list
: return "DW_AT_element_list";
203 case DW_AT_stmt_list
: return "DW_AT_stmt_list";
204 case DW_AT_low_pc
: return "DW_AT_low_pc";
205 case DW_AT_high_pc
: return "DW_AT_high_pc";
206 case DW_AT_language
: return "DW_AT_language";
207 case DW_AT_member
: return "DW_AT_member";
208 case DW_AT_discr
: return "DW_AT_discr";
209 case DW_AT_discr_value
: return "DW_AT_discr_value";
210 case DW_AT_visibility
: return "DW_AT_visibility";
211 case DW_AT_import
: return "DW_AT_import";
212 case DW_AT_string_length
: return "DW_AT_string_length";
213 case DW_AT_common_reference
: return "DW_AT_common_reference";
214 case DW_AT_comp_dir
: return "DW_AT_comp_dir";
215 case DW_AT_const_value
: return "DW_AT_const_value";
216 case DW_AT_containing_type
: return "DW_AT_containing_type";
217 case DW_AT_default_value
: return "DW_AT_default_value";
218 case DW_AT_inline
: return "DW_AT_inline";
219 case DW_AT_is_optional
: return "DW_AT_is_optional";
220 case DW_AT_lower_bound
: return "DW_AT_lower_bound";
221 case DW_AT_producer
: return "DW_AT_producer";
222 case DW_AT_prototyped
: return "DW_AT_prototyped";
223 case DW_AT_return_addr
: return "DW_AT_return_addr";
224 case DW_AT_start_scope
: return "DW_AT_start_scope";
225 case DW_AT_stride_size
: return "DW_AT_stride_size";
226 case DW_AT_upper_bound
: return "DW_AT_upper_bound";
227 case DW_AT_abstract_origin
: return "DW_AT_abstract_origin";
228 case DW_AT_accessibility
: return "DW_AT_accessibility";
229 case DW_AT_address_class
: return "DW_AT_address_class";
230 case DW_AT_artificial
: return "DW_AT_artificial";
231 case DW_AT_base_types
: return "DW_AT_base_types";
232 case DW_AT_calling_convention
: return "DW_AT_calling_convention";
233 case DW_AT_count
: return "DW_AT_count";
234 case DW_AT_data_member_location
: return "DW_AT_data_member_location";
235 case DW_AT_decl_column
: return "DW_AT_decl_column";
236 case DW_AT_decl_file
: return "DW_AT_decl_file";
237 case DW_AT_decl_line
: return "DW_AT_decl_line";
238 case DW_AT_declaration
: return "DW_AT_declaration";
239 case DW_AT_discr_list
: return "DW_AT_discr_list";
240 case DW_AT_encoding
: return "DW_AT_encoding";
241 case DW_AT_external
: return "DW_AT_external";
242 case DW_AT_frame_base
: return "DW_AT_frame_base";
243 case DW_AT_friend
: return "DW_AT_friend";
244 case DW_AT_identifier_case
: return "DW_AT_identifier_case";
245 case DW_AT_macro_info
: return "DW_AT_macro_info";
246 case DW_AT_namelist_items
: return "DW_AT_namelist_items";
247 case DW_AT_priority
: return "DW_AT_priority";
248 case DW_AT_segment
: return "DW_AT_segment";
249 case DW_AT_specification
: return "DW_AT_specification";
250 case DW_AT_static_link
: return "DW_AT_static_link";
251 case DW_AT_type
: return "DW_AT_type";
252 case DW_AT_use_location
: return "DW_AT_use_location";
253 case DW_AT_variable_parameter
: return "DW_AT_variable_parameter";
254 case DW_AT_virtuality
: return "DW_AT_virtuality";
255 case DW_AT_vtable_elem_location
: return "DW_AT_vtable_elem_location";
256 /* DWARF 3 values. */
257 case DW_AT_allocated
: return "DW_AT_allocated";
258 case DW_AT_associated
: return "DW_AT_associated";
259 case DW_AT_data_location
: return "DW_AT_data_location";
260 case DW_AT_stride
: return "DW_AT_stride";
261 case DW_AT_entry_pc
: return "DW_AT_entry_pc";
262 case DW_AT_use_UTF8
: return "DW_AT_use_UTF8";
263 case DW_AT_extension
: return "DW_AT_extension";
264 case DW_AT_ranges
: return "DW_AT_ranges";
265 case DW_AT_trampoline
: return "DW_AT_trampoline";
266 case DW_AT_call_column
: return "DW_AT_call_column";
267 case DW_AT_call_file
: return "DW_AT_call_file";
268 case DW_AT_call_line
: return "DW_AT_call_line";
269 case DW_AT_description
: return "DW_AT_description";
270 case DW_AT_binary_scale
: return "DW_AT_binary_scale";
271 case DW_AT_decimal_scale
: return "DW_AT_decimal_scale";
272 case DW_AT_small
: return "DW_AT_small";
273 case DW_AT_decimal_sign
: return "DW_AT_decimal_sign";
274 case DW_AT_digit_count
: return "DW_AT_digit_count";
275 case DW_AT_picture_string
: return "DW_AT_picture_string";
276 case DW_AT_mutable
: return "DW_AT_mutable";
277 case DW_AT_threads_scaled
: return "DW_AT_threads_scaled";
278 case DW_AT_explicit
: return "DW_AT_explicit";
279 case DW_AT_object_pointer
: return "DW_AT_object_pointer";
280 case DW_AT_endianity
: return "DW_AT_endianity";
281 case DW_AT_elemental
: return "DW_AT_elemental";
282 case DW_AT_pure
: return "DW_AT_pure";
283 case DW_AT_recursive
: return "DW_AT_recursive";
284 /* DWARF 4 values. */
285 case DW_AT_signature
: return "DW_AT_signature";
286 case DW_AT_main_subprogram
: return "DW_AT_main_subprogram";
287 case DW_AT_data_bit_offset
: return "DW_AT_data_bit_offset";
288 case DW_AT_const_expr
: return "DW_AT_const_expr";
289 case DW_AT_enum_class
: return "DW_AT_enum_class";
290 case DW_AT_linkage_name
: return "DW_AT_linkage_name";
291 /* SGI/MIPS extensions. */
292 /* case DW_AT_MIPS_fde: return "DW_AT_MIPS_fde"; */
293 /* DW_AT_MIPS_fde == DW_AT_HP_unmodifiable */
294 case DW_AT_MIPS_loop_begin
: return "DW_AT_MIPS_loop_begin";
295 case DW_AT_MIPS_tail_loop_begin
: return "DW_AT_MIPS_tail_loop_begin";
296 case DW_AT_MIPS_epilog_begin
: return "DW_AT_MIPS_epilog_begin";
297 case DW_AT_MIPS_loop_unroll_factor
: return "DW_AT_MIPS_loop_unroll_factor";
298 case DW_AT_MIPS_software_pipeline_depth
: return "DW_AT_MIPS_software_pipeline_depth";
299 case DW_AT_MIPS_linkage_name
: return "DW_AT_MIPS_linkage_name";
300 case DW_AT_MIPS_stride
: return "DW_AT_MIPS_stride";
301 case DW_AT_MIPS_abstract_name
: return "DW_AT_MIPS_abstract_name";
302 case DW_AT_MIPS_clone_origin
: return "DW_AT_MIPS_clone_origin";
303 case DW_AT_MIPS_has_inlines
: return "DW_AT_MIPS_has_inlines";
305 case DW_AT_HP_block_index
: return "DW_AT_HP_block_index";
306 case DW_AT_HP_unmodifiable
: return "DW_AT_HP_unmodifiable";
307 case DW_AT_HP_actuals_stmt_list
: return "DW_AT_HP_actuals_stmt_list";
308 case DW_AT_HP_proc_per_section
: return "DW_AT_HP_proc_per_section";
309 case DW_AT_HP_raw_data_ptr
: return "DW_AT_HP_raw_data_ptr";
310 case DW_AT_HP_pass_by_reference
: return "DW_AT_HP_pass_by_reference";
311 case DW_AT_HP_opt_level
: return "DW_AT_HP_opt_level";
312 case DW_AT_HP_prof_version_id
: return "DW_AT_HP_prof_version_id";
313 case DW_AT_HP_opt_flags
: return "DW_AT_HP_opt_flags";
314 case DW_AT_HP_cold_region_low_pc
: return "DW_AT_HP_cold_region_low_pc";
315 case DW_AT_HP_cold_region_high_pc
: return "DW_AT_HP_cold_region_high_pc";
316 case DW_AT_HP_all_variables_modifiable
: return "DW_AT_HP_all_variables_modifiable";
317 case DW_AT_HP_linkage_name
: return "DW_AT_HP_linkage_name";
318 case DW_AT_HP_prof_flags
: return "DW_AT_HP_prof_flags";
319 /* GNU extensions. */
320 case DW_AT_sf_names
: return "DW_AT_sf_names";
321 case DW_AT_src_info
: return "DW_AT_src_info";
322 case DW_AT_mac_info
: return "DW_AT_mac_info";
323 case DW_AT_src_coords
: return "DW_AT_src_coords";
324 case DW_AT_body_begin
: return "DW_AT_body_begin";
325 case DW_AT_body_end
: return "DW_AT_body_end";
326 case DW_AT_GNU_vector
: return "DW_AT_GNU_vector";
327 case DW_AT_GNU_all_tail_call_sites
: return "DW_AT_GNU_all_tail_call_sites";
328 case DW_AT_GNU_all_call_sites
: return "DW_AT_GNU_all_call_sites";
329 /* VMS extensions. */
330 case DW_AT_VMS_rtnbeg_pd_address
: return "DW_AT_VMS_rtnbeg_pd_address";
332 case DW_AT_upc_threads_scaled
: return "DW_AT_upc_threads_scaled";
333 /* PGI (STMicroelectronics) extensions. */
334 case DW_AT_PGI_lbase
: return "DW_AT_PGI_lbase";
335 case DW_AT_PGI_soffset
: return "DW_AT_PGI_soffset";
336 case DW_AT_PGI_lstride
: return "DW_AT_PGI_lstride";
342 /* ------ To do with evaluation of Dwarf expressions ------ */
344 /* FIXME: duplicated in readdwarf.c */
346 ULong
read_leb128 ( const UChar
* data
, Int
* length_return
, Int sign
)
353 vg_assert(sign
== 0 || sign
== 1);
360 result
|= ((ULong
)(byte
& 0x7f)) << shift
;
367 if (length_return
!= NULL
)
368 * length_return
= num_read
;
370 if (sign
&& (shift
< 64) && (byte
& 0x40))
371 result
|= -(1ULL << shift
);
376 /* Small helper functions easier to use
377 * value is returned and the given pointer is
378 * moved past end of leb128 data */
379 /* FIXME: duplicated in readdwarf.c */
380 static ULong
read_leb128U( const UChar
**data
)
383 ULong val
= read_leb128( *data
, &len
, 0 );
388 /* Same for signed data */
389 /* FIXME: duplicated in readdwarf.c */
390 static Long
read_leb128S( const UChar
**data
)
393 ULong val
= read_leb128( *data
, &len
, 1 );
398 /* FIXME: duplicates logic in readdwarf.c: copy_convert_CfiExpr_tree
399 and {FP,SP}_REG decls */
400 static Bool
get_Dwarf_Reg( /*OUT*/Addr
* a
, Word regno
, const RegSummary
* regs
)
403 # if defined(VGP_x86_linux) || defined(VGP_x86_darwin) \
404 || defined(VGP_x86_solaris)
405 if (regno
== 5/*EBP*/) { *a
= regs
->fp
; return True
; }
406 if (regno
== 4/*ESP*/) { *a
= regs
->sp
; return True
; }
407 # elif defined(VGP_amd64_linux) || defined(VGP_amd64_darwin) \
408 || defined(VGP_amd64_solaris)
409 if (regno
== 6/*RBP*/) { *a
= regs
->fp
; return True
; }
410 if (regno
== 7/*RSP*/) { *a
= regs
->sp
; return True
; }
411 # elif defined(VGP_ppc32_linux)
412 if (regno
== 1/*SP*/) { *a
= regs
->sp
; return True
; }
413 # elif defined(VGP_ppc64be_linux) || defined(VGP_ppc64le_linux)
414 if (regno
== 1/*SP*/) { *a
= regs
->sp
; return True
; }
415 # elif defined(VGP_arm_linux)
416 if (regno
== 13) { *a
= regs
->sp
; return True
; }
417 if (regno
== 11) { *a
= regs
->fp
; return True
; }
418 # elif defined(VGP_s390x_linux)
419 if (regno
== 15) { *a
= regs
->sp
; return True
; }
420 if (regno
== 11) { *a
= regs
->fp
; return True
; }
421 # elif defined(VGP_mips32_linux)
422 if (regno
== 29) { *a
= regs
->sp
; return True
; }
423 if (regno
== 30) { *a
= regs
->fp
; return True
; }
424 # elif defined(VGP_mips64_linux)
425 if (regno
== 29) { *a
= regs
->sp
; return True
; }
426 if (regno
== 30) { *a
= regs
->fp
; return True
; }
427 # elif defined(VGP_arm64_linux)
428 if (regno
== 31) { *a
= regs
->sp
; return True
; }
430 # error "Unknown platform"
435 /* Convert a stated address to an actual address */
436 static Bool
bias_address( Addr
* a
, const DebugInfo
* di
)
440 && *a
>= di
->text_debug_svma
&& *a
< di
->text_debug_svma
+ di
->text_size
) {
441 *a
+= di
->text_debug_bias
;
443 else if (di
->data_present
445 && *a
>= di
->data_debug_svma
&& *a
< di
->data_debug_svma
+ di
->data_size
) {
446 *a
+= di
->data_debug_bias
;
448 else if (di
->sdata_present
449 && di
->sdata_size
> 0
450 && *a
>= di
->sdata_debug_svma
&& *a
< di
->sdata_debug_svma
+ di
->sdata_size
) {
451 *a
+= di
->sdata_debug_bias
;
453 else if (di
->rodata_present
454 && di
->rodata_size
> 0
455 && *a
>= di
->rodata_debug_svma
&& *a
< di
->rodata_debug_svma
+ di
->rodata_size
) {
456 *a
+= di
->rodata_debug_bias
;
458 else if (di
->bss_present
460 && *a
>= di
->bss_debug_svma
&& *a
< di
->bss_debug_svma
+ di
->bss_size
) {
461 *a
+= di
->bss_debug_bias
;
463 else if (di
->sbss_present
465 && *a
>= di
->sbss_debug_svma
&& *a
< di
->sbss_debug_svma
+ di
->sbss_size
) {
466 *a
+= di
->sbss_debug_bias
;
476 /* Evaluate a standard DWARF3 expression. See detailed description in
477 priv_d3basics.h. Doesn't handle DW_OP_piece/DW_OP_bit_piece yet. */
478 GXResult
ML_(evaluate_Dwarf3_Expr
) ( const UChar
* expr
, UWord exprszB
,
479 const GExpr
* fbGX
, const RegSummary
* regs
,
481 Bool push_initial_zero
)
483 # define N_EXPR_STACK 20
485 # define FAIL(_str) \
487 res.kind = GXR_Failure; \
488 res.word = (UWord)(_str); \
492 # define PUSH(_arg) \
494 vg_assert(sp >= -1 && sp < N_EXPR_STACK); \
495 if (sp == N_EXPR_STACK-1) \
496 FAIL("evaluate_Dwarf3_Expr: stack overflow(1)"); \
498 stack[sp] = (_arg); \
501 # define POP(_lval) \
503 vg_assert(sp >= -1 && sp < N_EXPR_STACK); \
505 FAIL("evaluate_Dwarf3_Expr: stack underflow(1)"); \
512 Int sp
; /* # of top element: valid is -1 .. N_EXPR_STACK-1 */
513 Addr stack
[N_EXPR_STACK
]; /* stack of addresses, as per D3 spec */
522 vg_assert(exprszB
>= 0);
523 limit
= expr
+ exprszB
;
525 /* Deal with the case where the entire expression is a single
526 Register Name Operation (D3 spec sec 2.6.1). Then the
527 denotation of the expression as a whole is a register name. */
529 && expr
[0] >= DW_OP_reg0
&& expr
[0] <= DW_OP_reg31
) {
530 res
.kind
= GXR_RegNo
;
531 res
.word
= (UWord
)(expr
[0] - DW_OP_reg0
);
535 && expr
[0] == DW_OP_regx
) {
536 /* JRS: 2008Feb20: I believe the following is correct, but would
537 like to see a test case show up before enabling it. */
539 res
.kind
= GXR_RegNo
;
540 res
.word
= (UWord
)read_leb128U( &expr
);
542 FAIL("evaluate_Dwarf3_Expr: DW_OP_regx*: invalid expr size");
548 /* Evidently this expression denotes a value, not a register name.
549 So evaluate it accordingly. */
551 if (push_initial_zero
)
556 vg_assert(sp
>= -1 && sp
< N_EXPR_STACK
);
559 /* overrun - something's wrong */
560 FAIL("evaluate_Dwarf3_Expr: ran off end of expr");
563 /* end of expr - return expr on the top of stack. */
565 /* stack empty. Bad. */
566 FAIL("evaluate_Dwarf3_Expr: stack empty at end of expr");
574 /* Presumably what is given in the Dwarf3 is a SVMA (how
575 could it be otherwise?) So we add the appropriate bias
576 on before pushing the result. */
577 a1
= ML_(read_Addr
)(expr
);
578 if (bias_address(&a1
, di
)) {
580 expr
+= sizeof(Addr
);
583 FAIL("evaluate_Dwarf3_Expr: DW_OP_addr with address "
584 "in unknown section");
589 FAIL("evaluate_Dwarf3_Expr: DW_OP_fbreg with "
590 "no expr for fbreg present");
591 fbval
= ML_(evaluate_GX
)(fbGX
, NULL
, regs
, di
);
592 /* Convert fbval into something we can use. If we got a
593 Value, no problem. However, as per D3 spec sec 3.3.5
594 (Low Level Information) sec 2, we could also get a
595 RegNo, and that is taken to mean the value in the
596 indicated register. So we have to manually
599 switch (fbval
.kind
) {
601 return fbval
; /* propagate failure */
603 a1
= fbval
.word
; break; /* use as-is */
605 ok
= get_Dwarf_Reg( &a1
, fbval
.word
, regs
);
606 if (!ok
) return fbval
; /* propagate failure */
609 FAIL("evaluate_Dwarf3_Expr: DW_OP_{implicit,stack}_value "
610 "in DW_AT_frame_base");
614 sw1
= (Word
)read_leb128S( &expr
);
617 /* DW_OP_breg* denotes 'contents of specified register, plus
618 constant offset'. So provided we know what the register's
619 value is, we can evaluate this. Contrast DW_OP_reg*,
620 which indicates that denoted location is in a register
621 itself. If DW_OP_reg* shows up here the expression is
622 malformed, since we are evaluating for value now, and
623 DW_OP_reg* denotes a register location, not a value. See
624 D3 Spec sec 2.6.1 ("Register Name Operations") for
626 case DW_OP_breg0
... DW_OP_breg31
:
628 FAIL("evaluate_Dwarf3_Expr: DW_OP_breg* but no reg info");
630 if (!get_Dwarf_Reg( &a1
, opcode
- DW_OP_breg0
, regs
))
631 FAIL("evaluate_Dwarf3_Expr: unhandled DW_OP_breg*");
632 sw1
= (Word
)read_leb128S( &expr
);
638 FAIL("evaluate_Dwarf3_Expr: DW_OP_bregx but no reg info");
640 uw1
= (UWord
)read_leb128U( &expr
);
641 if (!get_Dwarf_Reg( &a1
, uw1
, regs
))
642 FAIL("evaluate_Dwarf3_Expr: unhandled DW_OP_bregx reg value");
643 sw1
= (Word
)read_leb128S( &expr
);
647 /* As per comment on DW_OP_breg*, the following denote that
648 the value in question is in a register, not in memory. So
649 we simply return failure. (iow, the expression is
651 case DW_OP_reg0
... DW_OP_reg31
:
653 FAIL("evaluate_Dwarf3_Expr: DW_OP_reg* "
654 "whilst evaluating for a value");
656 case DW_OP_plus_uconst
:
658 uw1
+= (UWord
)read_leb128U( &expr
);
661 case DW_OP_GNU_push_tls_address
:
662 /* GDB contains the following cryptic comment: */
663 /* Variable is at a constant offset in the thread-local
664 storage block into the objfile for the current thread and
665 the dynamic linker module containing this expression. Here
666 we return returns the offset from that base. The top of the
667 stack has the offset from the beginning of the thread
668 control block at which the variable is located. Nothing
669 should follow this operator, so the top of stack would be
671 /* But no spec resulting from Googling. Punt for now. */
672 FAIL("warning: evaluate_Dwarf3_Expr: unhandled "
673 "DW_OP_GNU_push_tls_address");
677 if (VG_(am_is_valid_for_client
)( (Addr
)uw1
, sizeof(Addr
),
679 uw1
= ML_(read_UWord
)((void *)uw1
);
682 FAIL("warning: evaluate_Dwarf3_Expr: DW_OP_deref: "
683 "address not valid for client");
686 case DW_OP_deref_size
:
689 if (VG_(am_is_valid_for_client
)( (Addr
)uw1
, uw2
,
692 case 1: uw1
= ML_(read_UChar
)((void*)uw1
); break;
693 case 2: uw1
= ML_(read_UShort
)((void*)uw1
); break;
694 case 4: uw1
= ML_(read_UInt
)((void*)uw1
); break;
695 case 8: uw1
= ML_(read_ULong
)((void*)uw1
); break;
697 FAIL("warning: evaluate_Dwarf3_Expr: unhandled "
698 "DW_OP_deref_size size");
702 FAIL("warning: evaluate_Dwarf3_Expr: DW_OP_deref_size: "
703 "address not valid for client");
706 case DW_OP_lit0
... DW_OP_lit31
:
707 PUSH(opcode
- DW_OP_lit0
);
714 uw1
= ML_(read_UShort
)(expr
);
719 uw1
= ML_(read_UInt
)(expr
);
724 uw1
= ML_(read_ULong
)(expr
);
729 uw1
= read_leb128U( &expr
);
733 uw1
= *(const Char
*)expr
;
738 uw1
= ML_(read_Short
)(expr
);
743 uw1
= ML_(read_Int
)(expr
);
748 uw1
= ML_(read_Long
)(expr
);
753 uw1
= read_leb128S( &expr
);
771 FAIL("evaluate_Dwarf3_Expr: stack underflow");
772 uw1
= stack
[sp
- uw1
];
777 FAIL("evaluate_Dwarf3_Expr: stack underflow");
779 stack
[sp
] = stack
[sp
- 1];
784 FAIL("evaluate_Dwarf3_Expr: stack underflow");
786 stack
[sp
] = stack
[sp
- 1];
787 stack
[sp
- 1] = stack
[sp
- 2];
799 FAIL("evaluate_Dwarf3_Expr: division by zero");
807 FAIL("evaluate_Dwarf3_Expr: division by zero");
812 #define BINARY(name, op, s) \
816 s##w1 = s##w1 op s##w2; \
819 #define UNARY(name, op, s) \
826 BINARY (minus
, -, u
);
834 BINARY (shra
, >>, s
);
845 sw1
= ML_(read_Short
)(expr
);
847 if (expr
+ sw1
< limit
- exprszB
)
848 FAIL("evaluate_Dwarf3_Expr: DW_OP_skip before start of expr");
849 if (expr
+ sw1
>= limit
)
850 FAIL("evaluate_Dwarf3_Expr: DW_OP_skip after end of expr");
854 sw1
= ML_(read_Short
)(expr
);
856 if (expr
+ sw1
< limit
- exprszB
)
857 FAIL("evaluate_Dwarf3_Expr: DW_OP_bra before start of expr");
858 if (expr
+ sw1
>= limit
)
859 FAIL("evaluate_Dwarf3_Expr: DW_OP_bra after end of expr");
866 case DW_OP_call_frame_cfa
:
868 FAIL("evaluate_Dwarf3_Expr: "
869 "DW_OP_call_frame_cfa but no reg info");
870 #if defined(VGP_ppc32_linux) || defined(VGP_ppc64be_linux) \
871 || defined(VGP_ppc64le_linux)
872 /* Valgrind on ppc32/ppc64 currently doesn't use unwind info. */
873 uw1
= ML_(read_Addr
)((UChar
*)regs
->sp
);
875 uw1
= ML_(get_CFA
)(regs
->ip
, regs
->sp
, regs
->fp
, 0, ~(UWord
) 0);
877 /* we expect this to fail on arm-linux, since ML_(get_CFA)
878 always returns zero at present. */
880 FAIL("evaluate_Dwarf3_Expr: Could not resolve "
881 "DW_OP_call_frame_cfa");
884 case DW_OP_implicit_value
:
885 sw1
= (Word
)read_leb128S( &expr
);
889 uw1
= ML_(read_UChar
)(expr
);
893 uw1
= ML_(read_UShort
)(expr
);
897 uw1
= ML_(read_UInt
)(expr
);
901 uw1
= ML_(read_ULong
)(expr
);
905 FAIL("evaluate_Dwarf3_Expr: Unhandled "
906 "DW_OP_implicit_value size");
909 FAIL("evaluate_Dwarf3_Expr: DW_OP_implicit_value "
910 "does not terminate expression");
912 res
.kind
= GXR_Value
;
914 case DW_OP_stack_value
:
917 res
.kind
= GXR_Value
;
919 FAIL("evaluate_Dwarf3_Expr: DW_OP_stack_value "
920 "does not terminate expression");
924 VG_(message
)(Vg_DebugMsg
,
925 "warning: evaluate_Dwarf3_Expr: unhandled "
926 "DW_OP_ 0x%x\n", (Int
)opcode
);
927 FAIL("evaluate_Dwarf3_Expr: unhandled DW_OP_");
933 vg_assert(sp
>= 0 && sp
< N_EXPR_STACK
);
934 res
.word
= stack
[sp
];
945 /* Evaluate a so-called Guarded (DWARF3) expression. See detailed
946 description in priv_d3basics.h. */
947 GXResult
ML_(evaluate_GX
)( const GExpr
* gx
, const GExpr
* fbGX
,
948 const RegSummary
* regs
, const DebugInfo
* di
)
955 const UChar
* p
= &gx
->payload
[0];
956 uc
= *p
++; /*biasMe*/
957 vg_assert(uc
== 0 || uc
== 1);
958 /* in fact it's senseless to evaluate if the guards need biasing.
963 if (uc
== 1) { /*isEnd*/
964 /* didn't find any matching range. */
965 res
.kind
= GXR_Failure
;
966 res
.word
= (UWord
)"no matching range";
970 aMin
= ML_(read_Addr
)(p
); p
+= sizeof(Addr
);
971 aMax
= ML_(read_Addr
)(p
); p
+= sizeof(Addr
);
972 nbytes
= ML_(read_UShort
)(p
); p
+= sizeof(UShort
);
974 if (0) VG_(printf
)(" guard %lu: %#lx %#lx\n",
977 vg_assert(aMin
== (Addr
)0);
978 vg_assert(aMax
== ~(Addr
)0);
979 /* Assert this is the first guard. */
980 vg_assert(nGuards
== 1);
981 res
= ML_(evaluate_Dwarf3_Expr
)(
982 p
, (UWord
)nbytes
, fbGX
, regs
, di
,
983 False
/*push_initial_zero*/ );
984 /* Now check there are no more guards. */
986 vg_assert(*p
== 1); /*isEnd*/
989 if (aMin
<= regs
->ip
&& regs
->ip
<= aMax
) {
990 /* found a matching range. Evaluate the expression. */
991 return ML_(evaluate_Dwarf3_Expr
)(
992 p
, (UWord
)nbytes
, fbGX
, regs
, di
,
993 False
/*push_initial_zero*/ );
996 /* else keep searching */
1002 /* Evaluate a very simple Guarded (DWARF3) expression. The expression
1003 is expected to denote a constant, with no reference to any
1004 registers nor to any frame base expression. The expression is
1005 expected to have at least one guard. If there is more than one
1006 guard, all the sub-expressions are evaluated and compared. The
1007 address ranges on the guards are ignored. GXR_Failure is returned
1008 in the following circumstances:
1010 * any of the subexpressions require a frame base expression
1011 * any of the subexpressions denote a register location
1012 * any of the subexpressions do not produce a manifest constant
1013 * there's more than one subexpression, all of which successfully
1014 evaluate to a constant, but they don't all produce the same constant.
1015 JRS 23Jan09: the special-casing in this function is a nasty kludge.
1016 Really it ought to be pulled out and turned into a general
1017 constant- expression evaluator.
1019 GXResult
ML_(evaluate_trivial_GX
)( const GExpr
* gx
, const DebugInfo
* di
)
1026 MaybeULong
*mul
, *mul2
;
1028 const HChar
* badness
= NULL
;
1029 const UChar
* p
= &gx
->payload
[0]; /* must remain unsigned */
1030 XArray
* results
= VG_(newXA
)( ML_(dinfo_zalloc
), "di.d3basics.etG.1",
1032 sizeof(MaybeULong
) );
1034 uc
= *p
++; /*biasMe*/
1035 vg_assert(uc
== 0 || uc
== 1);
1036 /* in fact it's senseless to evaluate if the guards need biasing.
1042 MaybeULong thisResult
;
1044 if (uc
== 1) /*isEnd*/
1047 aMin
= ML_(read_Addr
)(p
); p
+= sizeof(Addr
);
1048 aMax
= ML_(read_Addr
)(p
); p
+= sizeof(Addr
);
1049 nbytes
= ML_(read_UShort
)(p
); p
+= sizeof(UShort
);
1051 if (0) VG_(printf
)(" guard %ld: %#lx %#lx\n",
1052 nGuards
, aMin
,aMax
);
1054 thisResult
.b
= False
;
1057 /* Peer at this particular subexpression, to see if it's
1058 obviously a constant. */
1059 if (nbytes
== 1 + sizeof(Addr
) && *p
== DW_OP_addr
) {
1061 Addr a
= ML_(read_Addr
)((p
+1));
1062 if (bias_address(&a
, di
)) {
1063 thisResult
.b
= True
;
1064 thisResult
.ul
= (ULong
)a
;
1067 badness
= "trivial GExpr denotes constant address "
1068 "in unknown section (1)";
1072 if (nbytes
== 1 + sizeof(Addr
) + 1 + 1
1073 /* 11 byte block: 3 c0 b6 2b 0 0 0 0 0 23 4
1074 (DW_OP_addr: 2bb6c0; DW_OP_plus_uconst: 4)
1075 This is really a nasty kludge - only matches if the
1076 trailing ULEB denotes a number in the range 0 .. 127
1078 && p
[0] == DW_OP_addr
1079 && p
[1 + sizeof(Addr
)] == DW_OP_plus_uconst
1080 && p
[1 + sizeof(Addr
) + 1] < 0x80 /*1-byte ULEB*/) {
1081 Addr a
= ML_(read_Addr
)(&p
[1]);
1082 if (bias_address(&a
, di
)) {
1083 thisResult
.b
= True
;
1084 thisResult
.ul
= (ULong
)a
+ (ULong
)p
[1 + sizeof(Addr
) + 1];
1087 badness
= "trivial GExpr denotes constant address "
1088 "in unknown section (2)";
1092 if (nbytes
== 2 + sizeof(Addr
)
1094 && *(p
+ 1 + sizeof(Addr
)) == DW_OP_GNU_push_tls_address
) {
1096 badness
= "trivial GExpr is DW_OP_addr plus trailing junk";
1098 else if (nbytes
>= 1 && *p
>= DW_OP_reg0
&& *p
<= DW_OP_reg31
) {
1100 badness
= "trivial GExpr denotes register (1)";
1102 else if (nbytes
>= 1 && *p
== DW_OP_fbreg
) {
1104 badness
= "trivial GExpr requires fbGX";
1106 else if (nbytes
>= 1 && *p
>= DW_OP_breg0
&& *p
<= DW_OP_breg31
) {
1108 badness
= "trivial GExpr requires register value";
1110 else if (nbytes
>= 1 && *p
== DW_OP_regx
) {
1112 badness
= "trivial GExpr denotes register (2)";
1115 VG_(printf
)(" ML_(evaluate_trivial_GX): unhandled:\n ");
1122 badness
= "non-trivial GExpr";
1124 VG_(addToXA
)( results
, &thisResult
);
1129 res
.kind
= GXR_Failure
;
1131 vg_assert(nGuards
== VG_(sizeXA
)( results
));
1132 vg_assert(nGuards
>= 0);
1134 vg_assert(!badness
);
1135 res
.word
= (UWord
)"trivial GExpr has no guards (!)";
1136 VG_(deleteXA
)( results
);
1140 for (i
= 0; i
< nGuards
; i
++) {
1141 mul
= VG_(indexXA
)( results
, i
);
1142 if (mul
->b
== False
)
1146 vg_assert(i
>= 0 && i
<= nGuards
);
1148 /* at least one subexpression failed to produce a manifest constant. */
1150 res
.word
= (UWord
)badness
;
1151 VG_(deleteXA
)( results
);
1155 /* All the subexpressions produced a constant, but did they all produce
1157 mul
= VG_(indexXA
)( results
, 0 );
1158 vg_assert(mul
->b
== True
); /* we just established that all exprs are ok */
1160 for (i
= 1; i
< nGuards
; i
++) {
1161 mul2
= VG_(indexXA
)( results
, i
);
1162 vg_assert(mul2
->b
== True
);
1163 if (mul2
->ul
!= mul
->ul
) {
1164 res
.word
= (UWord
)"trivial GExpr: subexpressions disagree";
1165 VG_(deleteXA
)( results
);
1170 /* Well, we have success. All subexpressions evaluated, and
1171 they all agree. Hurrah. */
1172 res
.kind
= GXR_Addr
;
1173 res
.word
= (UWord
)mul
->ul
; /* NB: narrowing from ULong */
1174 VG_(deleteXA
)( results
);
1179 void ML_(pp_GXResult
) ( GXResult res
)
1183 VG_(printf
)("GXR_Failure(%s)", (HChar
*)res
.word
); break;
1185 VG_(printf
)("GXR_Addr(0x%lx)", res
.word
); break;
1187 VG_(printf
)("GXR_Value(0x%lx)", res
.word
); break;
1189 VG_(printf
)("GXR_RegNo(%lu)", res
.word
); break;
1191 VG_(printf
)("GXR_???"); break;
1196 void ML_(pp_GX
) ( const GExpr
* gx
)
1201 const UChar
* p
= &gx
->payload
[0];
1203 VG_(printf
)("GX(%s){", uc
== 0 ? "final" : "Breqd" );
1204 vg_assert(uc
== 0 || uc
== 1);
1210 aMin
= ML_(read_Addr
)(p
); p
+= sizeof(Addr
);
1211 aMax
= ML_(read_Addr
)(p
); p
+= sizeof(Addr
);
1212 nbytes
= ML_(read_UShort
)(p
); p
+= sizeof(UShort
);
1213 VG_(printf
)("[%#lx,%#lx]=", aMin
, aMax
);
1214 while (nbytes
> 0) {
1215 VG_(printf
)("%02x", (UInt
)*p
++);
1225 /*--------------------------------------------------------------------*/
1226 /*--- end d3basics.c ---*/
1227 /*--------------------------------------------------------------------*/