1 /* dwarf2dbg.c - DWARF2 debug support
2 Copyright (C) 1999, 2000 Free Software Foundation, Inc.
3 Contributed by David Mosberger-Tang <davidm@hpl.hp.com>
5 This file is part of GAS, the GNU Assembler.
7 GAS is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GAS is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GAS; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
22 /* Logical line numbers can be controlled by the compiler via the
23 following two directives:
26 .loc FILENO LINENO [COLUMN]
28 FILENO is the filenumber. */
33 #include "dwarf2dbg.h"
36 #include "elf/dwarf2.h"
38 /* Since we can't generate the prolog until the body is complete, we
39 use three different subsegments for .debug_line: one holding the
40 prolog, one for the directory and filename info, and one for the
41 body ("statement program"). */
46 /* First special line opcde - leave room for the standard opcodes.
47 Note: If you want to change this, you'll have to update the
48 "standard_opcode_lengths" table that is emitted below in
50 #define DWARF2_LINE_OPCODE_BASE 10
52 #ifndef DWARF2_LINE_BASE
53 /* Minimum line offset in a special line info. opcode. This value
54 was chosen to give a reasonable range of values. */
55 # define DWARF2_LINE_BASE -5
58 /* Range of line offsets in a special line info. opcode. */
59 #ifndef DWARF2_LINE_RANGE
60 # define DWARF2_LINE_RANGE 14
63 #ifndef DWARF2_LINE_MIN_INSN_LENGTH
64 /* Define the architecture-dependent minimum instruction length (in
65 bytes). This value should be rather too small than too big. */
66 # define DWARF2_LINE_MIN_INSN_LENGTH 1
69 /* Flag that indicates the initial value of the is_stmt_start flag.
70 In the present implementation, we do not mark any lines as
71 the beginning of a source statement, because that information
72 is not made available by the GCC front-end. */
73 #define DWARF2_LINE_DEFAULT_IS_STMT 1
75 /* Flag that indicates the initial value of the is_stmt_start flag.
76 In the present implementation, we do not mark any lines as
77 the beginning of a source statement, because that information
78 is not made available by the GCC front-end. */
79 #define DWARF2_LINE_DEFAULT_IS_STMT 1
81 /* Given a special op, return the line skip amount. */
82 #define SPECIAL_LINE(op) \
83 (((op) - DWARF2_LINE_OPCODE_BASE)%DWARF2_LINE_RANGE + DWARF2_LINE_BASE)
85 /* Given a special op, return the address skip amount (in units of
86 DWARF2_LINE_MIN_INSN_LENGTH. */
87 #define SPECIAL_ADDR(op) (((op) - DWARF2_LINE_OPCODE_BASE)/DWARF2_LINE_RANGE)
89 /* The maximum address skip amount that can be encoded with a special op. */
90 #define MAX_SPECIAL_ADDR_DELTA SPECIAL_ADDR(255)
92 #define INITIAL_STATE \
93 /* Initialize as per DWARF2.0 standard. */ \
98 DWARF2_LINE_DEFAULT_IS_STMT, /* is_stmt */ \
99 0, /* basic_block */ \
100 1 /* empty_sequence */
103 /* state machine state as per DWARF2 manual: */
106 unsigned int filenum
;
112 empty_sequence
: 1; /* current code sequence has no DWARF2 directives? */
116 any_dwarf2_directives
: 1; /* did we emit any DWARF2 line debug directives? */
118 fragS
* frag
; /* frag that "addr" is relative to */
119 segT text_seg
; /* text segment "addr" is relative to */
121 segT line_seg
; /* ".debug_line" segment */
122 int last_filename
; /* index of last filename that was used */
123 int num_filenames
; /* index of last filename in use */
124 int filename_len
; /* length of the filename array */
126 int dir
; /* valid after gen_dir_list() only */
127 char *name
; /* full path before gen_dir_list(), filename afterwards */
130 struct dwarf2_line_info current
; /* current source info */
132 /* counters for statistical purposes */
133 unsigned int num_line_entries
;
134 unsigned int opcode_hist
[256]; /* histogram of opcode frequencies */
148 { NULL
, 0, 0, 0, 0 },
151 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
152 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
153 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
154 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
155 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
156 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
157 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
158 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
159 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
160 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
161 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
162 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
163 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
164 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
165 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
166 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
170 /* Function prototypes. */
171 static void out_uleb128
PARAMS ((addressT
));
172 static void out_sleb128
PARAMS ((offsetT
));
173 static void gen_addr_line
PARAMS ((int, addressT
));
174 static void reset_state_machine
PARAMS ((void));
175 static void out_set_addr
PARAMS ((addressT
));
176 static void out_end_sequence
PARAMS ((void));
177 static int get_filenum
PARAMS ((int, char *));
178 static void gen_dir_list
PARAMS ((void));
179 static void gen_file_list
PARAMS ((void));
180 static void print_stats
PARAMS ((unsigned long));
181 static addressT now_subseg_size
PARAMS ((void));
183 #define out_byte(byte) FRAG_APPEND_1_CHAR(byte)
184 #define out_opcode(opc) (out_byte ((opc)), ++ls.opcode_hist[(opc) & 0xff])
186 /* Output an unsigned "little-endian base 128" number. */
192 unsigned char byte
, more
= 0x80;
200 out_byte (more
| byte
);
205 /* Output a signed "little-endian base 128" number. */
211 unsigned char byte
, more
= 0x80;
217 if (((value
== 0) && ((byte
& 0x40) == 0))
218 || ((value
== -1) && ((byte
& 0x40) != 0)))
220 out_byte (more
| byte
);
225 /* Encode a pair of line and address skips as efficiently as possible.
226 Note that the line skip is signed, whereas the address skip is
230 gen_addr_line (line_delta
, addr_delta
)
234 unsigned int tmp
, opcode
;
236 tmp
= line_delta
- DWARF2_LINE_BASE
;
238 if (tmp
>= DWARF2_LINE_RANGE
)
240 out_opcode (DW_LNS_advance_line
);
241 out_sleb128 (line_delta
);
242 tmp
= 0 - DWARF2_LINE_BASE
;
246 tmp
+= DWARF2_LINE_OPCODE_BASE
;
248 /* Try using a special opcode. */
249 opcode
= tmp
+ addr_delta
* DWARF2_LINE_RANGE
;
256 /* Try using DW_LNS_const_add_pc followed by special op. */
257 opcode
= tmp
+ (addr_delta
- MAX_SPECIAL_ADDR_DELTA
) * DWARF2_LINE_RANGE
;
260 out_opcode (DW_LNS_const_add_pc
);
265 out_opcode (DW_LNS_advance_pc
);
266 out_uleb128 (addr_delta
);
269 /* Output line-delta. */
272 /* Append new row with current info. */
273 out_opcode (DW_LNS_copy
);
277 reset_state_machine ()
279 static const struct dwarf2_sm initial_state
= { INITIAL_STATE
};
281 ls
.sm
= initial_state
;
284 /* Set an absolute address (may results in a relocation entry). */
290 subsegT saved_subseg
;
294 int bytes_per_address
;
297 saved_subseg
= now_subseg
;
299 subseg_set (ls
.text_seg
, ls
.text_subseg
);
300 sym
= symbol_new (".L0\001", now_seg
, addr
, frag_now
);
302 subseg_set (saved_seg
, saved_subseg
);
305 bytes_per_address
= bfd_arch_bits_per_address (stdoutput
) / 8;
308 bytes_per_address
= 4;
311 out_opcode (DW_LNS_extended_op
);
312 out_uleb128 (bytes_per_address
+ 1);
314 out_opcode (DW_LNE_set_address
);
315 expr
.X_op
= O_symbol
;
316 expr
.X_add_symbol
= sym
;
317 expr
.X_add_number
= 0;
318 emit_expr (&expr
, bytes_per_address
);
321 /* Emit DW_LNS_end_sequence and reset state machine. Does not
322 preserve the current segment/sub-segment! */
327 addressT addr
, delta
;
332 subseg_set (ls
.text_seg
, ls
.text_subseg
);
333 #ifdef md_current_text_addr
334 addr
= md_current_text_addr ();
336 addr
= frag_now_fix ();
338 text_frag
= frag_now
;
339 subseg_set (ls
.line_seg
, DL_BODY
);
340 if (text_frag
!= ls
.frag
)
348 delta
= (addr
- ls
.sm
.addr
) / DWARF2_LINE_MIN_INSN_LENGTH
;
351 /* Advance address without updating the line-debug
352 matrix---the end_sequence entry is used only to tell
353 the debugger the end of the sequence. */
354 out_opcode (DW_LNS_advance_pc
);
360 subseg_set (ls
.line_seg
, DL_BODY
);
362 out_opcode (DW_LNS_extended_op
);
364 out_byte (DW_LNE_end_sequence
);
366 reset_state_machine ();
369 /* Look up a filenumber either by filename or by filenumber. If both
370 a filenumber and a filename are specified, lookup by filename takes
371 precedence. If the filename cannot be found, it is added to the
372 filetable and the filenumber for the new entry is returned. */
375 get_filenum (filenum
, file
)
379 int i
, last
= filenum
- 1;
380 char char0
= file
[0];
382 /* If filenum is out of range of the filename table, then try using the
383 table entry returned from the previous call. */
384 if (last
>= ls
.num_filenames
|| last
< 0)
385 last
= ls
.last_filename
;
387 /* Do a quick check against the specified or previously used filenum. */
388 if (ls
.num_filenames
> 0 && ls
.file
[last
].name
[0] == char0
389 && strcmp (ls
.file
[last
].name
+ 1, file
+ 1) == 0)
392 /* No match, fall back to simple linear scan. */
393 for (i
= 0; i
< ls
.num_filenames
; ++i
)
395 if (ls
.file
[i
].name
[0] == char0
396 && strcmp (ls
.file
[i
].name
+ 1, file
+ 1) == 0)
398 ls
.last_filename
= i
;
403 /* No match, enter new filename. */
404 if (ls
.num_filenames
>= ls
.filename_len
)
406 ls
.filename_len
+= 13;
407 ls
.file
= xrealloc (ls
.file
, ls
.filename_len
* sizeof (ls
.file
[0]));
409 ls
.file
[ls
.num_filenames
].dir
= 0;
410 ls
.file
[ls
.num_filenames
].name
= file
;
411 ls
.last_filename
= ls
.num_filenames
;
412 return ++ls
.num_filenames
;
415 /* Emit an entry in the line number table if the address or line has changed.
416 ADDR is relative to the current frag in the text section. */
419 dwarf2_gen_line_info (addr
, l
)
421 struct dwarf2_line_info
*l
;
423 unsigned int filenum
= l
->filenum
;
424 unsigned int any_output
= 0;
425 subsegT saved_subseg
;
430 fprintf (stderr
, "line: addr %lx file `%s' line %u col %u flags %x\n",
431 (unsigned long) addr
, l
->filename
, l
->line
, l
->column
, l
->flags
);
433 if (filenum
> 0 && !l
->filename
)
435 if (filenum
>= (unsigned int) ls
.num_filenames
)
437 as_warn ("Encountered bad file number in line number debug info!");
441 else if (l
->filename
)
442 filenum
= get_filenum (filenum
, l
->filename
);
444 /* No filename, no filnum => no play. */
447 /* Must save these before the subseg_new call, as that call will change
450 saved_subseg
= now_subseg
;
451 saved_frag
= frag_now
;
459 ls
.line_seg
= subseg_new (".debug_line", 0);
462 bfd_set_section_flags (stdoutput
, ls
.line_seg
, SEC_READONLY
);
464 /* We're going to need this symbol. */
465 secsym
= symbol_find (".debug_line");
467 symbol_set_bfdsym (secsym
, ls
.line_seg
->symbol
);
469 symbol_table_insert (section_symbol (ls
.line_seg
));
473 subseg_set (ls
.line_seg
, DL_BODY
);
475 if (ls
.text_seg
!= saved_seg
|| ls
.text_subseg
!= saved_subseg
)
477 if (!ls
.sm
.empty_sequence
)
479 /* Terminate previous sequence. */
481 ls
.sm
.empty_sequence
= 1;
484 ls
.text_seg
= saved_seg
;
485 ls
.text_subseg
= saved_subseg
;
488 ls
.frag
= saved_frag
;
491 if (ls
.sm
.filenum
!= filenum
)
494 out_opcode (DW_LNS_set_file
);
495 out_uleb128 (filenum
);
496 ls
.sm
.filenum
= filenum
;
499 if (ls
.sm
.column
!= l
->column
)
502 out_opcode (DW_LNS_set_column
);
503 out_uleb128 (l
->column
);
504 ls
.sm
.column
= l
->column
;
507 if (((l
->flags
& DWARF2_FLAG_BEGIN_STMT
) != 0) != ls
.sm
.is_stmt
)
510 out_opcode (DW_LNS_negate_stmt
);
513 if (l
->flags
& DWARF2_FLAG_BEGIN_BLOCK
)
516 out_opcode (DW_LNS_set_basic_block
);
519 if (ls
.sm
.line
!= l
->line
)
522 if (saved_frag
!= ls
.frag
)
524 /* If a new frag got allocated (for whatever reason), then
525 deal with it by generating a reference symbol. Note: no
526 end_sequence needs to be generated because the address did
527 not really decrease (only the reference point changed). */
530 ls
.frag
= saved_frag
;
532 gen_addr_line (l
->line
- ls
.sm
.line
,
533 (addr
- ls
.sm
.addr
) / DWARF2_LINE_MIN_INSN_LENGTH
);
534 ls
.sm
.basic_block
= 0;
535 ls
.sm
.line
= l
->line
;
539 subseg_set (saved_seg
, saved_subseg
);
541 ls
.num_line_entries
+= any_output
;
543 ls
.sm
.empty_sequence
= 0;
549 char *str
, *slash
, *dir_list
, *dp
, *cp
;
552 dir_list
= frag_more (0);
555 for (i
= 0; i
< ls
.num_filenames
; ++i
)
557 str
= ls
.file
[i
].name
;
558 slash
= strrchr (str
, '/');
562 for (j
= 0, dp
= dir_list
; j
< num_dirs
; ++j
)
564 if (strcmp (str
, dp
) == 0)
566 ls
.file
[i
].dir
= j
+ 1;
573 /* Didn't find this directory: append it to the list. */
574 size_t size
= strlen (str
) + 1;
575 cp
= frag_more (size
);
576 memcpy (cp
, str
, size
);
577 ls
.file
[i
].dir
= ++num_dirs
;
580 ls
.file
[i
].name
= slash
+ 1;
584 /* Terminate directory list. */
595 for (i
= 0; i
< ls
.num_filenames
; ++i
)
597 size
= strlen (ls
.file
[i
].name
) + 1;
598 cp
= frag_more (size
);
599 memcpy (cp
, ls
.file
[i
].name
, size
);
601 out_uleb128 (ls
.file
[i
].dir
); /* directory number */
602 out_uleb128 (0); /* last modification timestamp */
603 out_uleb128 (0); /* filesize */
606 /* Terminate filename list. */
611 print_stats (total_size
)
612 unsigned long total_size
;
614 static const char *opc_name
[] = {
615 "extended", "copy", "advance_pc", "advance_line", "set_file",
616 "set_column", "negate_stmt", "set_basic_block", "const_add_pc",
622 fprintf (stderr
, "Average size: %g bytes/line\n",
623 total_size
/ (double) ls
.num_line_entries
);
625 fprintf (stderr
, "\nStandard opcode histogram:\n");
627 for (i
= 0; i
< sizeof (opc_name
) / sizeof (opc_name
[0]); ++i
)
629 fprintf (stderr
, "%s", opc_name
[i
]);
630 for (j
= strlen (opc_name
[i
]); j
< 16; ++j
)
631 fprintf (stderr
, " ");
632 fprintf (stderr
, ": %u\n", ls
.opcode_hist
[i
]);
635 fprintf (stderr
, "\nSpecial opcodes:\naddr\t\t\t\tline skip\n");
637 fprintf (stderr
, "skip: ");
638 for (j
= DWARF2_LINE_BASE
; j
< DWARF2_LINE_BASE
+ DWARF2_LINE_RANGE
; ++j
)
639 fprintf (stderr
, "%3d", j
);
640 fprintf (stderr
, "\n-----");
644 j
= SPECIAL_LINE (i
);
645 if (j
== DWARF2_LINE_BASE
)
646 fprintf (stderr
, "\n%4u: ",
647 (unsigned int) (DWARF2_LINE_MIN_INSN_LENGTH
648 * SPECIAL_ADDR (i
)));
649 fprintf (stderr
, " %2u", ls
.opcode_hist
[i
]);
651 fprintf (stderr
, "\n");
654 /* Compute the size of the current subsegment, taking all fragments
655 into account. Note that we don't generate variant frags, so the
656 fixed portion is all we need to consider. */
664 for (f
= frchain_now
->frch_root
; f
; f
= f
->fr_next
)
667 return size
+ frag_now_fix_octets ();
673 addressT body_size
, total_size
, prolog_size
;
674 subsegT saved_subseg
;
679 /* No .debug_line segment, no work to do. */
683 saved_subseg
= now_subseg
;
685 if (!ls
.sm
.empty_sequence
)
687 subseg_set (ls
.line_seg
, DL_BODY
);
688 total_size
= body_size
= now_subseg_size ();
690 /* Now generate the directory and file lists. */
691 subseg_set (ls
.line_seg
, DL_FILES
);
694 total_size
+= now_subseg_size ();
696 /* And now the header ("statement program prolog", in DWARF2 lingo...). */
697 subseg_set (ls
.line_seg
, DL_PROLOG
);
699 cp
= frag_more (15 + DWARF2_LINE_OPCODE_BASE
- 1);
701 total_size
+= now_subseg_size ();
702 prolog_size
= total_size
- body_size
- 10;
704 #define STUFF(val,size) \
706 md_number_to_chars (cp, val, size); \
710 STUFF (total_size
- 4, 4); /* length */
711 STUFF (2, 2); /* version */
712 STUFF (prolog_size
, 4); /* prologue_length */
713 STUFF (DWARF2_LINE_MIN_INSN_LENGTH
, 1);
714 STUFF (DWARF2_LINE_DEFAULT_IS_STMT
, 1);
715 STUFF (DWARF2_LINE_BASE
, 1);
716 STUFF (DWARF2_LINE_RANGE
, 1);
717 STUFF (DWARF2_LINE_OPCODE_BASE
, 1);
719 /* standard_opcode_lengths: */
720 STUFF (0, 1); /* DW_LNS_copy */
721 STUFF (1, 1); /* DW_LNS_advance_pc */
722 STUFF (1, 1); /* DW_LNS_advance_line */
723 STUFF (1, 1); /* DW_LNS_set_file */
724 STUFF (1, 1); /* DW_LNS_set_column */
725 STUFF (0, 1); /* DW_LNS_negate_stmt */
726 STUFF (0, 1); /* DW_LNS_set_basic_block */
727 STUFF (0, 1); /* DW_LNS_const_add_pc */
728 STUFF (1, 1); /* DW_LNS_fixed_advance_pc */
732 /* If this is assembler generated line info, add a .debug_info
734 if (debug_type
== DEBUG_DWARF2
)
736 segT info_seg
= subseg_new (".debug_info", 0);
737 segT abbrev_seg
= subseg_new (".debug_abbrev", 0);
741 bfd_set_section_flags (stdoutput
, info_seg
, SEC_READONLY
);
742 bfd_set_section_flags (stdoutput
, abbrev_seg
, SEC_READONLY
);
745 subseg_set (info_seg
, 0);
748 #define STUFF(val, size) \
750 cp = frag_more (size); \
751 md_number_to_chars (cp, (val), (size)); \
754 STUFF (2, 2); /* Dwarf version */
755 STUFF (0, 4); /* Offset into (final!) .debug_abbrev. */
759 STUFF (bfd_arch_bits_per_address (stdoutput
) / 8, 1);
764 /* FIXME: Add a DW_TAG_compile_unit DIE. The line info cannot
765 even be seen without it. */
767 /* Set size of debug_info. */
768 md_number_to_chars (len
, now_subseg_size () - 4, 4);
771 subseg_set (saved_seg
, saved_subseg
);
774 print_stats (total_size
);
778 dwarf2_directive_file (dummy
)
779 int dummy ATTRIBUTE_UNUSED
;
783 /* Continue to accept a bare string and pass it off. */
785 if (*input_line_pointer
== '"')
791 ls
.any_dwarf2_directives
= 1;
793 ls
.current
.filenum
= get_absolute_expression ();
794 ls
.current
.filename
= demand_copy_C_string (&len
);
796 demand_empty_rest_of_line ();
800 dwarf2_directive_loc (dummy
)
801 int dummy ATTRIBUTE_UNUSED
;
803 ls
.any_dwarf2_directives
= 1;
805 ls
.current
.filenum
= get_absolute_expression ();
807 ls
.current
.line
= get_absolute_expression ();
809 ls
.current
.column
= get_absolute_expression ();
810 demand_empty_rest_of_line ();
812 ls
.current
.flags
= DWARF2_FLAG_BEGIN_STMT
;
816 listing_source_line (ls
.current
.line
);
822 struct dwarf2_line_info
*line
;
824 if (debug_type
== DEBUG_DWARF2
)
826 as_where (&line
->filename
, &line
->line
);
829 line
->flags
= DWARF2_FLAG_BEGIN_STMT
;
835 /* Called for each machine instruction, or relatively atomic group of
836 machine instructions (ie built-in macro). The instruction or group
837 is SIZE bytes in length. If dwarf2 line number generation is called
838 for, emit a line statement appropriately. */
841 dwarf2_emit_insn (size
)
845 struct dwarf2_line_info debug_line
;
847 if (debug_type
!= DEBUG_DWARF2
&& ! ls
.any_dwarf2_directives
)
850 /* Reset any_dwarf2_directives so that we won't waste time
851 determining that no information has changed between insns. */
852 ls
.any_dwarf2_directives
= 0;
854 /* First update the notion of the current source line. */
855 dwarf2_where (&debug_line
);
857 /* We want the offset of the start of this
858 instruction within the the current frag. */
859 addr
= frag_now_fix () - size
;
861 /* And record the information. */
862 dwarf2_gen_line_info (addr
, &debug_line
);