1 # Copyright 2010-2016 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 # Return true if the target supports DWARF-2 and uses gas.
17 # For now pick a sampling of likely targets.
18 proc dwarf2_support {} {
19 if {[istarget *-*-linux*]
20 || [istarget *-*-gnu*]
21 || [istarget *-*-elf*]
22 || [istarget *-*-openbsd*]
23 || [istarget arm*-*-eabi*]
24 || [istarget arm*-*-symbianelf*]
25 || [istarget powerpc-*-eabi*]} {
32 # Build an executable from a fission-based .S file.
33 # This handles the extra work of splitting the .o into non-dwo and dwo
34 # pieces, making sure the .dwo is available if we're using cc-with-tweaks.sh
35 # to build a .dwp file.
36 # The arguments and results are the same as for build_executable.
38 # Current restrictions:
39 # - only supports one source file
40 # - cannot be run on remote hosts
42 proc build_executable_from_fission_assembler { testname executable sources options } {
43 verbose -log "build_executable_from_fission_assembler $testname $executable $sources $options"
44 if { [llength $sources] != 1 } {
45 error "Only one source file supported."
48 error "Remote hosts are not supported."
52 set source_file ${srcdir}/${subdir}/${sources}
53 set root_name [file rootname [file tail $source_file]]
54 set output_base [standard_output_file $root_name]
55 set object_file ${output_base}.o
56 set dwo_file ${output_base}.dwo
57 set object_options "object $options"
58 set objcopy [gdb_find_objcopy]
60 set result [gdb_compile $source_file $object_file object $options]
61 if { "$result" != "" } {
65 set command "$objcopy --extract-dwo $object_file $dwo_file"
66 verbose -log "Executing $command"
67 set result [catch "exec $command" output]
68 verbose -log "objcopy --extract-dwo output: $output"
73 set command "$objcopy --strip-dwo $object_file"
74 verbose -log "Executing $command"
75 set result [catch "exec $command" output]
76 verbose -log "objcopy --strip-dwo output: $output"
81 set result [gdb_compile $object_file $executable executable {nodebug}]
82 if { "$result" != "" } {
89 # Return a list of expressions about function FUNC's address and length.
90 # The first expression is the address of function FUNC, and the second
91 # one is FUNC's length. SRC is the source file having function FUNC.
92 # An internal label ${func}_label must be defined inside FUNC:
96 # asm ("main_label: .globl main_label");
100 # This label is needed to compute the start address of function FUNC.
101 # If the compiler is gcc, we can do the following to get function start
102 # and end address too:
104 # asm ("func_start: .globl func_start");
105 # static void func (void) {}
106 # asm ("func_end: .globl func_end");
108 # however, this isn't portable, because other compilers, such as clang,
109 # may not guarantee the order of global asms and function. The code
112 # asm ("func_start: .globl func_start");
113 # asm ("func_end: .globl func_end");
114 # static void func (void) {}
117 proc function_range { func src } {
118 global decimal gdb_prompt
120 set exe [standard_temp_file func_addr[pid].x]
122 gdb_compile $src $exe executable {debug}
128 # Compute the label offset, and we can get the function start address
129 # by "${func}_label - $func_label_offset".
130 set func_label_offset ""
131 set test "p ${func}_label - ${func}"
132 gdb_test_multiple $test $test {
133 -re ".* = ($decimal)\r\n$gdb_prompt $" {
134 set func_label_offset $expect_out(1,string)
138 # Compute the function length.
141 set test "disassemble $func"
142 gdb_test_multiple $test $test {
143 -re ".*$hex <\\+($decimal)>:\[^\r\n\]+\r\nEnd of assembler dump\.\r\n$gdb_prompt $" {
144 set func_length $expect_out(1,string)
148 # Compute the size of the last instruction.
149 if { $func_length == 0 } then {
150 set func_pattern "$func"
152 set func_pattern "$func\\+$func_length"
154 set test "x/2i $func+$func_length"
155 gdb_test_multiple $test $test {
156 -re ".*($hex) <$func_pattern>:\[^\r\n\]+\r\n\[ \]+($hex).*\.\r\n$gdb_prompt $" {
157 set start $expect_out(1,string)
158 set end $expect_out(2,string)
160 set func_length [expr $func_length + $end - $start]
164 return [list "${func}_label - $func_label_offset" $func_length]
169 # All the variables in this namespace are private to the
170 # implementation. Also, any procedure whose name starts with "_" is
171 # private as well. Do not use these.
173 # Exported functions are documented at their definition.
175 # In addition to the hand-written functions documented below, this
176 # module automatically generates a function for each DWARF tag. For
177 # most tags, two forms are made: a full name, and one with the
178 # "DW_TAG_" prefix stripped. For example, you can use either
179 # 'DW_TAG_compile_unit' or 'compile_unit' interchangeably.
181 # There are two exceptions to this rule: DW_TAG_variable and
182 # DW_TAG_namespace. For these, the full name must always be used,
183 # as the short name conflicts with Tcl builtins. (Should future
184 # versions of Tcl or DWARF add more conflicts, this list will grow.
185 # If you want to be safe you should always use the full names.)
187 # Each tag procedure is defined like:
189 # proc DW_TAG_mumble {{attrs {}} {children {}}} { ... }
191 # ATTRS is an optional list of attributes.
192 # It is run through 'subst' in the caller's context before processing.
194 # Each attribute in the list has one of two forms:
196 # 2. { NAME VALUE FORM }
198 # In each case, NAME is the attribute's name.
199 # This can either be the full name, like 'DW_AT_name', or a shortened
200 # name, like 'name'. These are fully equivalent.
202 # Besides DWARF standard attributes, assembler supports 'macro' attribute
203 # which will be substituted by one or more standard or macro attributes.
204 # supported macro attributes are:
206 # - MACRO_AT_range { FUNC FILE }
207 # It is substituted by DW_AT_low_pc and DW_AT_high_pc with the start and
208 # end address of function FUNC in file FILE.
210 # - MACRO_AT_func { FUNC FILE }
211 # It is substituted by DW_AT_name with FUNC and MACRO_AT_range.
213 # If FORM is given, it should name a DW_FORM_ constant.
214 # This can either be the short form, like 'DW_FORM_addr', or a
215 # shortened version, like 'addr'. If the form is given, VALUE
216 # is its value; see below. In some cases, additional processing
217 # is done; for example, DW_FORM_strp manages the .debug_str
218 # section automatically.
220 # If FORM is 'SPECIAL_expr', then VALUE is treated as a location
221 # expression. The effective form is then DW_FORM_block, and VALUE
222 # is passed to the (internal) '_location' proc to be translated.
223 # This proc implements a miniature DW_OP_ assembler.
225 # If FORM is not given, it is guessed:
226 # * If VALUE starts with the "@" character, the rest of VALUE is
227 # looked up as a DWARF constant, and DW_FORM_sdata is used. For
228 # example, '@DW_LANG_c89' could be used.
229 # * If VALUE starts with the ":" character, then it is a label
230 # reference. The rest of VALUE is taken to be the name of a label,
231 # and DW_FORM_ref4 is used. See 'new_label' and 'define_label'.
232 # * Otherwise, VALUE is taken to be a string and DW_FORM_string is
233 # used. In order to prevent bugs where a numeric value is given but
234 # no form is specified, it is an error if the value looks like a number
235 # (using Tcl's "string is integer") and no form is provided.
236 # More form-guessing functionality may be added.
238 # CHILDREN is just Tcl code that can be used to define child DIEs. It
239 # is evaluated in the caller's context.
241 # Currently this code is missing nice support for CFA handling, and
242 # probably other things as well.
244 namespace eval Dwarf {
245 # True if the module has been initialized.
246 variable _initialized 0
248 # Constants from dwarf2.h.
252 # DW_FORM short names.
257 # The current output file.
258 variable _output_file
260 # Note: The _cu_ values here also apply to type units (TUs).
261 # Think of a TU as a special kind of CU.
266 # The current CU's base label.
269 # The current CU's version.
272 # The current CU's address size.
273 variable _cu_addr_size
274 # The current CU's offset size.
275 variable _cu_offset_size
277 # Label generation number.
280 # The deferred output array. The index is the section name; the
281 # contents hold the data for that section.
282 variable _deferred_output
284 # If empty, we should write directly to the output file.
285 # Otherwise, this is the name of a section to write to.
288 # The abbrev section. Typically .debug_abbrev but can be .debug_abbrev.dwo
290 variable _abbrev_section
292 # The next available abbrev number in the current CU's abbrev
296 # The string table for this assembly. The key is the string; the
297 # value is the label for that string.
300 # Current .debug_line unit count.
303 # Whether a file_name entry was seen.
304 variable _line_saw_file
306 # Whether a line table program has been seen.
307 variable _line_saw_program
309 # A Label for line table header generation.
310 variable _line_header_end_label
312 # The address size for debug ranges section.
313 variable _debug_ranges_64_bit
315 proc _process_one_constant {name value} {
321 set _constants($name) $value
323 if {![regexp "^DW_(\[A-Z\]+)_(\[A-Za-z0-9_\]+)$" $name \
324 ignore prefix name2]} {
325 error "non-matching name: $name"
328 if {$name2 == "lo_user" || $name2 == "hi_user"} {
332 # We only try to shorten some very common things.
334 switch -exact -- $prefix {
336 # Create two procedures for the tag. These call
337 # _handle_DW_TAG with the full tag name baked in; this
338 # does all the actual work.
339 proc $name {{attrs {}} {children {}}} \
340 "_handle_DW_TAG $name \$attrs \$children"
342 # Filter out ones that are known to clash.
343 if {$name2 == "variable" || $name2 == "namespace"} {
344 set name2 "tag_$name2"
347 if {[info commands $name2] != {}} {
348 error "duplicate proc name: from $name"
351 proc $name2 {{attrs {}} {children {}}} \
352 "_handle_DW_TAG $name \$attrs \$children"
356 set _AT($name2) $name
360 set _FORM($name2) $name
364 set _OP($name2) $name
373 proc _read_constants {} {
374 global srcdir hex decimal
377 # DWARF name-matching regexp.
378 set dwrx "DW_\[a-zA-Z0-9_\]+"
382 set fd [open [file join $srcdir .. .. include dwarf2.h]]
385 if {[regexp -- "^${ws}($dwrx)${ws}=${ws}($hex|$decimal),?$" \
386 $line ignore name value ignore2]} {
387 _process_one_constant $name $value
392 set fd [open [file join $srcdir .. .. include dwarf2.def]]
396 "^DW_\[A-Z_\]+${ws}\\(($dwrx),${ws}($hex|$decimal)\\)$" \
397 $line ignore name value ignore2]} {
398 _process_one_constant $name $value
403 set _constants(SPECIAL_expr) $_constants(DW_FORM_block)
406 proc _quote {string} {
408 return "\"${string}\\0\""
411 proc _nz_quote {string} {
412 # For now, no quoting is done.
413 return "\"${string}\""
416 proc _handle_DW_FORM {form value} {
417 switch -exact -- $form {
419 _op .ascii [_quote $value]
422 DW_FORM_flag_present {
423 # We don't need to emit anything.
432 variable _cu_offset_size
434 variable _cu_addr_size
436 if {$_cu_version == 2} {
437 set size $_cu_addr_size
439 set size $_cu_offset_size
442 _op .${size}byte $value
446 variable _cu_offset_size
447 _op .${_cu_offset_size}byte $value
466 variable _cu_addr_size
468 _op .${_cu_addr_size}byte $value
484 variable _cu_offset_size
486 if {![info exists _strings($value)]} {
487 set _strings($value) [new_label strp]
488 _defer_output .debug_string {
489 define_label $_strings($value)
490 _op .ascii [_quote $value]
494 _op .${_cu_offset_size}byte $_strings($value) "strp: $value"
498 set l1 [new_label "expr_start"]
499 set l2 [new_label "expr_end"]
500 _op .uleb128 "$l2 - $l1" "expression"
507 set len [string length $value]
509 error "DW_FORM_block1 length too long"
512 _op .ascii [_nz_quote $value]
524 DW_FORM_GNU_addr_index -
525 DW_FORM_GNU_str_index -
526 DW_FORM_GNU_ref_alt -
527 DW_FORM_GNU_strp_alt -
530 error "unhandled form $form"
535 proc _guess_form {value varname} {
536 upvar $varname new_value
538 switch -exact -- [string range $value 0 0] {
540 # Constant reference.
543 set new_value $_constants([string range $value 1 end])
552 set new_value "[string range $value 1 end] - $_cu_label"
558 return DW_FORM_string
563 # Map NAME to its canonical form.
564 proc _map_name {name ary} {
567 if {[info exists ${ary}($name)]} {
568 set name [set ${ary}($name)]
574 proc _handle_attribute { attr_name attr_value attr_form } {
575 variable _abbrev_section
578 _handle_DW_FORM $attr_form $attr_value
580 _defer_output $_abbrev_section {
581 _op .uleb128 $_constants($attr_name) $attr_name
582 _op .uleb128 $_constants($attr_form) $attr_form
586 # Handle macro attribute MACRO_AT_range.
588 proc _handle_macro_at_range { attr_value } {
589 if {[llength $attr_value] != 2} {
590 error "usage: MACRO_AT_range { func file }"
593 set func [lindex $attr_value 0]
594 set src [lindex $attr_value 1]
595 set result [function_range $func $src]
597 _handle_attribute DW_AT_low_pc [lindex $result 0] \
599 _handle_attribute DW_AT_high_pc \
600 "[lindex $result 0] + [lindex $result 1]" DW_FORM_addr
603 # Handle macro attribute MACRO_AT_func.
605 proc _handle_macro_at_func { attr_value } {
606 if {[llength $attr_value] != 2} {
607 error "usage: MACRO_AT_func { func file }"
609 _handle_attribute DW_AT_name [lindex $attr_value 0] DW_FORM_string
610 _handle_macro_at_range $attr_value
613 proc _handle_DW_TAG {tag_name {attrs {}} {children {}}} {
614 variable _abbrev_section
618 set has_children [expr {[string length $children] > 0}]
619 set my_abbrev [incr _abbrev_num]
621 # We somewhat wastefully emit a new abbrev entry for each tag.
622 # There's no reason for this other than laziness.
623 _defer_output $_abbrev_section {
624 _op .uleb128 $my_abbrev "Abbrev start"
625 _op .uleb128 $_constants($tag_name) $tag_name
626 _op .byte $has_children "has_children"
629 _op .uleb128 $my_abbrev "Abbrev ($tag_name)"
631 foreach attr $attrs {
632 set attr_name [_map_name [lindex $attr 0] _AT]
634 # When the length of ATTR is greater than 2, the last
635 # element of the list must be a form. The second through
636 # the penultimate elements are joined together and
637 # evaluated using subst. This allows constructs such as
638 # [gdb_target_symbol foo] to be used.
640 if {[llength $attr] > 2} {
641 set attr_value [uplevel 2 [list subst [join [lrange $attr 1 end-1]]]]
643 set attr_value [uplevel 2 [list subst [lindex $attr 1]]]
646 if { [string equal "MACRO_AT_func" $attr_name] } {
647 _handle_macro_at_func $attr_value
648 } elseif { [string equal "MACRO_AT_range" $attr_name] } {
649 _handle_macro_at_range $attr_value
651 if {[llength $attr] > 2} {
652 set attr_form [lindex $attr end]
654 # If the value looks like an integer, a form is required.
655 if [string is integer $attr_value] {
656 error "Integer value requires a form"
658 set attr_form [_guess_form $attr_value attr_value]
660 set attr_form [_map_name $attr_form _FORM]
662 _handle_attribute $attr_name $attr_value $attr_form
666 _defer_output $_abbrev_section {
668 _op .byte 0x0 Terminator
669 _op .byte 0x0 Terminator
675 # Terminate children.
676 _op .byte 0x0 "Terminate children"
680 proc _emit {string} {
681 variable _output_file
683 variable _deferred_output
686 puts $_output_file $string
688 append _deferred_output($_defer) ${string}\n
692 proc _section {name {flags ""} {type ""}} {
693 if {$flags == "" && $type == ""} {
694 _emit " .section $name"
695 } elseif {$type == ""} {
696 _emit " .section $name, \"$flags\""
698 _emit " .section $name, \"$flags\", %$type"
702 # SECTION_SPEC is a list of arguments to _section.
703 proc _defer_output {section_spec body} {
705 variable _deferred_output
707 set old_defer $_defer
708 set _defer [lindex $section_spec 0]
710 if {![info exists _deferred_output($_defer)]} {
711 set _deferred_output($_defer) ""
712 eval _section $section_spec
717 set _defer $old_defer
720 proc _defer_to_string {body} {
722 variable _deferred_output
724 set old_defer $_defer
727 set _deferred_output($_defer) ""
731 set result $_deferred_output($_defer)
732 unset _deferred_output($_defer)
734 set _defer $old_defer
738 proc _write_deferred_output {} {
739 variable _output_file
740 variable _deferred_output
742 foreach section [array names _deferred_output] {
743 # The data already has a newline.
744 puts -nonewline $_output_file $_deferred_output($section)
748 unset _deferred_output
751 proc _op {name value {comment ""}} {
752 set text " ${name} ${value}"
753 if {$comment != ""} {
754 # Try to make stuff line up nicely.
755 while {[string length $text] < 40} {
758 append text "/* ${comment} */"
763 proc _compute_label {name} {
767 # Return a name suitable for use as a label. If BASE_NAME is
768 # specified, it is incorporated into the label name; this is to
769 # make debugging the generated assembler easier. If BASE_NAME is
770 # not specified a generic default is used. This proc does not
771 # define the label; see 'define_label'. 'new_label' attempts to
772 # ensure that label names are unique.
773 proc new_label {{base_name label}} {
776 return [_compute_label ${base_name}[incr _label_num]]
779 # Define a label named NAME. Ordinarily, NAME comes from a call
780 # to 'new_label', but this is not required.
781 proc define_label {name} {
785 # Declare a global label. This is typically used to refer to
786 # labels defined in other files, for example a function defined in
794 # A higher-level interface to label handling.
796 # ARGS is a list of label descriptors. Each one is either a
797 # single element, or a list of two elements -- a name and some
798 # text. For each descriptor, 'new_label' is invoked. If the list
799 # form is used, the second element in the list is passed as an
800 # argument. The label name is used to define a variable in the
801 # enclosing scope; this can be used to refer to the label later.
802 # The label name is also used to define a new proc whose name is
803 # the label name plus a trailing ":". This proc takes a body as
804 # an argument and can be used to define the label at that point;
805 # then the body, if any, is evaluated in the caller's context.
809 # declare_labels int_label
810 # something { ... $int_label } ;# refer to the label
811 # int_label: constant { ... } ;# define the label
812 proc declare_labels {args} {
814 set name [lindex $arg 0]
815 set text [lindex $arg 1]
817 upvar $name label_var
819 set label_var [new_label]
821 set label_var [new_label $text]
824 proc ${name}: {args} [format {
831 # This is a miniature assembler for location expressions. It is
832 # suitable for use in the attributes to a DIE. Its output is
833 # prefixed with "=" to make it automatically use DW_FORM_block.
834 # BODY is split by lines, and each line is taken to be a list.
835 # (FIXME should use 'info complete' here.)
836 # Each list's first element is the opcode, either short or long
837 # forms are accepted.
838 # FIXME argument handling
840 proc _location {body} {
843 variable _cu_addr_size
844 variable _cu_offset_size
846 foreach line [split $body \n] {
847 # Ignore blank lines, and allow embedded comments.
848 if {[lindex $line 0] == "" || [regexp -- {^[ \t]*#} $line]} {
851 set opcode [_map_name [lindex $line 0] _OP]
852 _op .byte $_constants($opcode) $opcode
854 switch -exact -- $opcode {
856 _op .${_cu_addr_size}byte [lindex $line 1]
860 _op .uleb128 [lindex $line 1]
866 _op .byte [lindex $line 1]
871 _op .2byte [lindex $line 1]
876 _op .4byte [lindex $line 1]
881 _op .8byte [lindex $line 1]
885 _op .uleb128 [lindex $line 1]
888 _op .sleb128 [lindex $line 1]
892 _op .uleb128 [lindex $line 1]
896 _op .uleb128 [lindex $line 1]
900 _op .uleb128 [lindex $line 1]
901 _op .uleb128 [lindex $line 2]
906 _op .2byte [lindex $line 1]
909 DW_OP_GNU_implicit_pointer {
910 if {[llength $line] != 3} {
911 error "usage: DW_OP_GNU_implicit_pointer LABEL OFFSET"
914 # Here label is a section offset.
915 set label [lindex $line 1]
916 _op .${_cu_offset_size}byte $label
917 _op .sleb128 [lindex $line 2]
921 if {[llength $line] != 2} {
922 error "usage: DW_OP_deref_size SIZE"
925 _op .byte [lindex $line 1]
929 _op .uleb128 [lindex $line 1]
930 _op .sleb128 [lindex $line 2]
934 if {[llength $line] > 1} {
935 error "Unimplemented: operands in location for $opcode"
943 # OPTIONS is a list with an even number of elements containing
944 # option-name and option-value pairs.
945 # Current options are:
946 # is_64 0|1 - boolean indicating if you want to emit 64-bit DWARF
947 # default = 0 (32-bit)
948 # version n - DWARF version number to emit
950 # addr_size n - the size of addresses, 32, 64, or default
952 # fission 0|1 - boolean indicating if generating Fission debug info
954 # BODY is Tcl code that emits the DIEs which make up the body of
955 # the CU. It is evaluated in the caller's context.
956 proc cu {options body} {
958 variable _abbrev_section
962 variable _cu_addr_size
963 variable _cu_offset_size
965 # Establish the defaults.
968 set _cu_addr_size default
970 set section ".debug_info"
971 set _abbrev_section ".debug_abbrev"
973 foreach { name value } $options {
974 switch -exact -- $name {
975 is_64 { set is_64 $value }
976 version { set _cu_version $value }
977 addr_size { set _cu_addr_size $value }
978 fission { set fission $value }
979 default { error "unknown option $name" }
982 if {$_cu_addr_size == "default"} {
983 if {[is_64_target]} {
989 set _cu_offset_size [expr { $is_64 ? 8 : 4 }]
991 set section ".debug_info.dwo"
992 set _abbrev_section ".debug_abbrev.dwo"
997 set cu_num [incr _cu_count]
998 set my_abbrevs [_compute_label "abbrev${cu_num}_begin"]
1001 set _cu_label [_compute_label "cu${cu_num}_begin"]
1002 set start_label [_compute_label "cu${cu_num}_start"]
1003 set end_label [_compute_label "cu${cu_num}_end"]
1005 define_label $_cu_label
1007 _op .4byte 0xffffffff
1008 _op .8byte "$end_label - $start_label"
1010 _op .4byte "$end_label - $start_label"
1012 define_label $start_label
1013 _op .2byte $_cu_version Version
1014 _op .${_cu_offset_size}byte $my_abbrevs Abbrevs
1015 _op .byte $_cu_addr_size "Pointer size"
1017 _defer_output $_abbrev_section {
1018 define_label $my_abbrevs
1023 _defer_output $_abbrev_section {
1024 # Emit the terminator.
1025 _op .byte 0x0 Terminator
1026 _op .byte 0x0 Terminator
1029 define_label $end_label
1033 # OPTIONS is a list with an even number of elements containing
1034 # option-name and option-value pairs.
1035 # Current options are:
1036 # is_64 0|1 - boolean indicating if you want to emit 64-bit DWARF
1037 # default = 0 (32-bit)
1038 # version n - DWARF version number to emit
1040 # addr_size n - the size of addresses, 32, 64, or default
1042 # fission 0|1 - boolean indicating if generating Fission debug info
1044 # SIGNATURE is the 64-bit signature of the type.
1045 # TYPE_LABEL is the label of the type defined by this TU,
1046 # or "" if there is no type (i.e., type stubs in Fission).
1047 # BODY is Tcl code that emits the DIEs which make up the body of
1048 # the TU. It is evaluated in the caller's context.
1049 proc tu {options signature type_label body} {
1051 variable _abbrev_section
1052 variable _abbrev_num
1054 variable _cu_version
1055 variable _cu_addr_size
1056 variable _cu_offset_size
1058 # Establish the defaults.
1061 set _cu_addr_size default
1063 set section ".debug_types"
1064 set _abbrev_section ".debug_abbrev"
1066 foreach { name value } $options {
1067 switch -exact -- $name {
1068 is_64 { set is_64 $value }
1069 version { set _cu_version $value }
1070 addr_size { set _cu_addr_size $value }
1071 fission { set fission $value }
1072 default { error "unknown option $name" }
1075 if {$_cu_addr_size == "default"} {
1076 if {[is_64_target]} {
1082 set _cu_offset_size [expr { $is_64 ? 8 : 4 }]
1084 set section ".debug_types.dwo"
1085 set _abbrev_section ".debug_abbrev.dwo"
1090 set cu_num [incr _cu_count]
1091 set my_abbrevs [_compute_label "abbrev${cu_num}_begin"]
1094 set _cu_label [_compute_label "cu${cu_num}_begin"]
1095 set start_label [_compute_label "cu${cu_num}_start"]
1096 set end_label [_compute_label "cu${cu_num}_end"]
1098 define_label $_cu_label
1100 _op .4byte 0xffffffff
1101 _op .8byte "$end_label - $start_label"
1103 _op .4byte "$end_label - $start_label"
1105 define_label $start_label
1106 _op .2byte $_cu_version Version
1107 _op .${_cu_offset_size}byte $my_abbrevs Abbrevs
1108 _op .byte $_cu_addr_size "Pointer size"
1109 _op .8byte $signature Signature
1110 if { $type_label != "" } {
1111 uplevel declare_labels $type_label
1112 upvar $type_label my_type_label
1114 _op .8byte "$my_type_label - $_cu_label"
1116 _op .4byte "$my_type_label - $_cu_label"
1126 _defer_output $_abbrev_section {
1127 define_label $my_abbrevs
1132 _defer_output $_abbrev_section {
1133 # Emit the terminator.
1134 _op .byte 0x0 Terminator
1135 _op .byte 0x0 Terminator
1138 define_label $end_label
1141 # Emit a DWARF .debug_ranges unit.
1142 # OPTIONS is a list with an even number of elements containing
1143 # option-name and option-value pairs.
1144 # Current options are:
1145 # is_64 0|1 - boolean indicating if you want to emit 64-bit DWARF
1146 # default = 0 (32-bit)
1148 # BODY is Tcl code that emits the content of the .debug_ranges
1149 # unit, it is evaluated in the caller's context.
1150 proc ranges {options body} {
1151 variable _debug_ranges_64_bit
1153 foreach { name value } $options {
1154 switch -exact -- $name {
1155 is_64 { set _debug_ranges_64_bit [subst $value] }
1156 default { error "unknown option $name" }
1160 set section ".debug_ranges"
1163 proc sequence {{ranges {}}} {
1164 variable _debug_ranges_64_bit
1166 # Emit the sequence of addresses.
1168 foreach range $ranges {
1169 set range [uplevel 1 "subst \"$range\""]
1170 set type [lindex $range 0]
1171 switch -exact -- $type {
1173 set base [lrange $range 1 end]
1175 if { $_debug_ranges_64_bit } then {
1176 _op .8byte 0xffffffffffffffff "Base Marker"
1177 _op .8byte $base "Base Address"
1179 _op .4byte 0xffffffff "Base Marker"
1180 _op .4byte $base "Base Address"
1184 set start [lindex $range 1]
1185 set end [lrange $range 2 end]
1187 if { $_debug_ranges_64_bit } then {
1188 _op .8byte $start "Start Address"
1189 _op .8byte $end "End Address"
1191 _op .4byte $start "Start Address"
1192 _op .4byte $end "End Address"
1195 default { error "unknown range type: $type " }
1199 # End of the sequence.
1200 if { $_debug_ranges_64_bit } then {
1201 _op .8byte 0x0 "End of Sequence Marker (Part 1)"
1202 _op .8byte 0x0 "End of Sequence Marker (Part 2)"
1204 _op .4byte 0x0 "End of Sequence Marker (Part 1)"
1205 _op .4byte 0x0 "End of Sequence Marker (Part 2)"
1213 # Emit a DWARF .debug_line unit.
1214 # OPTIONS is a list with an even number of elements containing
1215 # option-name and option-value pairs.
1216 # Current options are:
1217 # is_64 0|1 - boolean indicating if you want to emit 64-bit DWARF
1218 # default = 0 (32-bit)
1219 # version n - DWARF version number to emit
1221 # addr_size n - the size of addresses, 32, 64, or default
1224 # LABEL is the label of the current unit (which is probably
1225 # referenced by a DW_AT_stmt_list), or "" if there is no such
1228 # BODY is Tcl code that emits the parts which make up the body of
1229 # the line unit. It is evaluated in the caller's context. The
1230 # following commands are available for the BODY section:
1232 # include_dir "dirname" -- adds a new include directory
1234 # file_name "file.c" idx -- adds a new file name. IDX is a
1235 # 1-based index referencing an include directory or 0 for
1236 # current directory.
1238 proc lines {options label body} {
1239 variable _line_count
1240 variable _line_saw_file
1241 variable _line_saw_program
1242 variable _line_header_end_label
1244 # Establish the defaults.
1247 set _unit_addr_size default
1249 foreach { name value } $options {
1250 switch -exact -- $name {
1251 is_64 { set is_64 $value }
1252 version { set _unit_version $value }
1253 addr_size { set _unit_addr_size $value }
1254 default { error "unknown option $name" }
1257 if {$_unit_addr_size == "default"} {
1258 if {[is_64_target]} {
1259 set _unit_addr_size 8
1261 set _unit_addr_size 4
1265 set unit_num [incr _line_count]
1267 set section ".debug_line"
1270 if { "$label" != "" } {
1271 # Define the user-provided label at this point.
1275 set unit_len_label [_compute_label "line${_line_count}_start"]
1276 set unit_end_label [_compute_label "line${_line_count}_end"]
1277 set header_len_label [_compute_label "line${_line_count}_header_start"]
1278 set _line_header_end_label [_compute_label "line${_line_count}_header_end"]
1281 _op .4byte 0xffffffff
1282 _op .8byte "$unit_end_label - $unit_len_label" "unit_length"
1284 _op .4byte "$unit_end_label - $unit_len_label" "unit_length"
1287 define_label $unit_len_label
1289 _op .2byte $_unit_version version
1292 _op .8byte "$_line_header_end_label - $header_len_label" "header_length"
1294 _op .4byte "$_line_header_end_label - $header_len_label" "header_length"
1297 define_label $header_len_label
1299 _op .byte 1 "minimum_instruction_length"
1300 _op .byte 1 "default_is_stmt"
1301 _op .byte 1 "line_base"
1302 _op .byte 1 "line_range"
1303 _op .byte 10 "opcode_base"
1305 # The standard_opcode_lengths table. The number of arguments
1306 # for each of the standard opcodes. Generating 9 entries here
1307 # matches the use of 10 in the opcode_base above. These 9
1308 # entries match the 9 standard opcodes for DWARF2, making use
1309 # of only 9 should be fine, even if we are generating DWARF3
1311 _op .byte 0 "standard opcode 1"
1312 _op .byte 1 "standard opcode 2"
1313 _op .byte 1 "standard opcode 3"
1314 _op .byte 1 "standard opcode 4"
1315 _op .byte 1 "standard opcode 5"
1316 _op .byte 0 "standard opcode 6"
1317 _op .byte 0 "standard opcode 7"
1318 _op .byte 0 "standard opcode 8"
1319 _op .byte 1 "standard opcode 9"
1321 proc include_dir {dirname} {
1322 _op .ascii [_quote $dirname]
1325 proc file_name {filename diridx} {
1326 variable _line_saw_file
1327 if "! $_line_saw_file" {
1328 # Terminate the dir list.
1329 _op .byte 0 "Terminator."
1330 set _line_saw_file 1
1333 _op .ascii [_quote $filename]
1334 _op .sleb128 $diridx
1335 _op .sleb128 0 "mtime"
1336 _op .sleb128 0 "length"
1339 proc program {statements} {
1340 variable _line_saw_program
1341 variable _line_header_end_label
1343 if "! $_line_saw_program" {
1344 # Terminate the file list.
1345 _op .byte 0 "Terminator."
1346 define_label $_line_header_end_label
1347 set _line_saw_program 1
1350 proc DW_LNE_set_address {addr} {
1352 set start [new_label "set_address_start"]
1353 set end [new_label "set_address_end"]
1354 _op .uleb128 "${end} - ${start}"
1355 define_label ${start}
1357 if {[is_64_target]} {
1365 proc DW_LNE_end_sequence {} {
1371 proc DW_LNS_copy {} {
1375 proc DW_LNS_advance_pc {offset} {
1377 _op .uleb128 ${offset}
1380 proc DW_LNS_advance_line {offset} {
1382 _op .sleb128 ${offset}
1385 foreach statement $statements {
1386 uplevel 1 $statement
1392 rename include_dir ""
1395 # Terminate dir list if we saw no files.
1396 if "! $_line_saw_file" {
1397 _op .byte 0 "Terminator."
1400 # Terminate the file list.
1401 if "! $_line_saw_program" {
1402 _op .byte 0 "Terminator."
1403 define_label $_line_header_end_label
1406 define_label $unit_end_label
1409 proc _empty_array {name} {
1410 upvar $name the_array
1412 catch {unset the_array}
1417 # Emit a .gnu_debugaltlink section with the given file name and
1418 # build-id. The buildid should be represented as a hexadecimal
1419 # string, like "ffeeddcc".
1420 proc gnu_debugaltlink {filename buildid} {
1421 _defer_output .gnu_debugaltlink {
1422 _op .ascii [_quote $filename]
1423 foreach {a b} [split $buildid {}] {
1429 proc _note {type name hexdata} {
1430 set namelen [expr [string length $name] + 1]
1435 _op .4byte [expr [string length $hexdata] / 2]
1439 _op .ascii [_quote $name]
1442 set total [expr {($namelen + (1 << $align) - 1) & -(1 << $align)}]
1443 for {set i $namelen} {$i < $total} {incr i} {
1447 foreach {a b} [split $hexdata {}] {
1452 # Emit a note section holding the given build-id.
1453 proc build_id {buildid} {
1454 _defer_output {.note.gnu.build-id a note} {
1455 # From elf/common.h.
1456 set NT_GNU_BUILD_ID 3
1458 _note $NT_GNU_BUILD_ID GNU $buildid
1462 # The top-level interface to the DWARF assembler.
1463 # FILENAME is the name of the file where the generated assembly
1465 # BODY is Tcl code to emit the assembly. It is evaluated via
1466 # "eval" -- not uplevel as you might expect, because it is
1467 # important to run the body in the Dwarf namespace.
1469 # A typical invocation is something like:
1470 # Dwarf::assemble $file {
1480 proc assemble {filename body} {
1481 variable _initialized
1482 variable _output_file
1483 variable _deferred_output
1488 variable _line_count
1489 variable _line_saw_file
1490 variable _line_saw_program
1491 variable _line_header_end_label
1492 variable _debug_ranges_64_bit
1494 if {!$_initialized} {
1499 set _output_file [open $filename w]
1501 _empty_array _deferred_output
1504 _empty_array _strings
1507 set _line_saw_file 0
1508 set _line_saw_program 0
1509 set _debug_ranges_64_bit [is_64_target]
1511 # Not "uplevel" here, because we want to evaluate in this
1512 # namespace. This is somewhat bad because it means we can't
1513 # readily refer to outer variables.
1516 _write_deferred_output
1518 catch {close $_output_file}