2004-03-05 H.J. Lu <hongjiu.lu@intel.com>
[external/binutils.git] / gas / dwarf2dbg.h
1 /* dwarf2dbg.h - DWARF2 debug support
2    Copyright 1999, 2000 Free Software Foundation, Inc.
3
4    This file is part of GAS, the GNU Assembler.
5
6    GAS is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2, or (at your option)
9    any later version.
10
11    GAS is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with GAS; see the file COPYING.  If not, write to the Free
18    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
19    02111-1307, USA.  */
20
21 #ifndef AS_DWARF2DBG_H
22 #define AS_DWARF2DBG_H
23
24 #include "as.h"
25
26 #define DWARF2_FLAG_BEGIN_STMT  (1 << 0)        /* beginning of statement */
27 #define DWARF2_FLAG_BEGIN_BLOCK (1 << 1)        /* beginning of basic block */
28
29 struct dwarf2_line_info {
30   unsigned int filenum;
31   unsigned int line;
32   unsigned int column;
33   unsigned int flags;
34 };
35
36 /* Implements the .file FILENO "FILENAME" directive.  FILENO can be 0
37    to indicate that no file number has been assigned.  All real file
38    number must be >0.  */
39 extern char *dwarf2_directive_file (int dummy);
40
41 /* Implements the .loc FILENO LINENO [COLUMN] directive.  FILENO is
42    the file number, LINENO the line number and the (optional) COLUMN
43    the column of the source code that the following instruction
44    corresponds to.  FILENO can be 0 to indicate that the filename
45    specified by the textually most recent .file directive should be
46    used.  */
47 extern void dwarf2_directive_loc (int dummy);
48
49 /* Returns the current source information.  If .file directives have
50    been encountered, the info for the corresponding source file is
51    returned.  Otherwise, the info for the assembly source file is
52    returned.  */
53 extern void dwarf2_where (struct dwarf2_line_info *l);
54
55 /* This function generates .debug_line info based on the address and
56    source information passed in the arguments.  ADDR should be the
57    frag-relative offset of the instruction the information is for and
58    L is the source information that should be associated with that
59    address.  */
60 extern void dwarf2_gen_line_info (addressT addr, struct dwarf2_line_info *l);
61
62 /* Must be called for each generated instruction.  */
63 extern void dwarf2_emit_insn (int);
64
65 extern void dwarf2_finish (void);
66
67 extern int dwarf2dbg_estimate_size_before_relax (fragS *);
68 extern int dwarf2dbg_relax_frag (fragS *);
69 extern void dwarf2dbg_convert_frag (fragS *);
70
71 /* An enumeration which describes the sizes of offsets (to DWARF sections)
72    and the mechanism by which the size is indicated.  */
73 enum dwarf2_format {
74   /* 32-bit format: the initial length field is 4 bytes long.  */
75   dwarf2_format_32bit,
76   /* DWARF3 64-bit format: the representation of the initial length
77      (of a DWARF section) is 0xffffffff (4 bytes) followed by eight
78      bytes indicating the actual length.  */
79   dwarf2_format_64bit,
80   /* SGI extension to DWARF2: The initial length is eight bytes.  */
81   dwarf2_format_64bit_irix
82 };
83
84 #endif /* AS_DWARF2DBG_H */