gas/dwarf2dbg.h

   1 /* dwarf2dbg.h - DWARF2 debug support
   2    Copyright 1999, 2000, 2002, 2003, 2005, 2006, 2007, 2009
   3    Free Software Foundation, Inc.
   4
   5    This file is part of GAS, the GNU Assembler.
   6
   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 3, or (at your option)
  10    any later version.
  11
  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.
  16
  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, 51 Franklin Street - Fifth Floor, Boston, MA
  20    02110-1301, USA.  */
  21
  22 #ifndef AS_DWARF2DBG_H
  23 #define AS_DWARF2DBG_H
  24
  25 #include "as.h"
  26
  27 #define DWARF2_FLAG_IS_STMT             (1 << 0)
  28 #define DWARF2_FLAG_BASIC_BLOCK         (1 << 1)
  29 #define DWARF2_FLAG_PROLOGUE_END        (1 << 2)
  30 #define DWARF2_FLAG_EPILOGUE_BEGIN      (1 << 3)
  31
  32 struct dwarf2_line_info {
  33   unsigned int filenum;
  34   unsigned int line;
  35   unsigned int column;
  36   unsigned int isa;
  37   unsigned int flags;
  38   unsigned int discriminator;
  39 };
  40
  41 /* Implements the .file FILENO "FILENAME" directive.  FILENO can be 0
  42    to indicate that no file number has been assigned.  All real file
  43    number must be >0.  */
  44 extern char *dwarf2_directive_file (int dummy);
  45
  46 /* Implements the .loc FILENO LINENO [COLUMN] directive.  FILENO is
  47    the file number, LINENO the line number and the (optional) COLUMN
  48    the column of the source code that the following instruction
  49    corresponds to.  FILENO can be 0 to indicate that the filename
  50    specified by the textually most recent .file directive should be
  51    used.  */
  52 extern void dwarf2_directive_loc (int dummy);
  53
  54 /* Implements the .loc_mark_labels {0,1} directive.  */
  55 extern void dwarf2_directive_loc_mark_labels (int dummy);
  56
  57 /* Returns the current source information.  If .file directives have
  58    been encountered, the info for the corresponding source file is
  59    returned.  Otherwise, the info for the assembly source file is
  60    returned.  */
  61 extern void dwarf2_where (struct dwarf2_line_info *l);
  62
  63 /* A hook to allow the target backend to inform the line number state
  64    machine of isa changes when assembler debug info is enabled.  */
  65 extern void dwarf2_set_isa (unsigned int isa);
  66
  67 /* This function generates .debug_line info based on the address and
  68    source information passed in the arguments.  ADDR should be the
  69    frag-relative offset of the instruction the information is for and
  70    L is the source information that should be associated with that
  71    address.  */
  72 extern void dwarf2_gen_line_info (addressT addr, struct dwarf2_line_info *l);
  73
  74 /* Must be called for each generated instruction.  */
  75 extern void dwarf2_emit_insn (int);
  76
  77 /* Reset the state of the line number information to reflect that
  78    it has been used.  */
  79 extern void dwarf2_consume_line_info (void);
  80
  81 /* Should be called for each code label.  */
  82 extern void dwarf2_emit_label (symbolS *);
  83
  84 /* True when we've seen a .loc directive recently.  Used to avoid
  85    doing work when there's nothing to do.  */
  86 bfd_boolean dwarf2_loc_directive_seen;
  87
  88 /* True when we're supposed to set the basic block mark whenever a label
  89    is seen.  Unless the target is doing Something Weird, just call
  90    dwarf2_emit_label.  */
  91 extern bfd_boolean dwarf2_loc_mark_labels;
  92
  93 extern void dwarf2_finish (void);
  94
  95 extern int dwarf2dbg_estimate_size_before_relax (fragS *);
  96 extern int dwarf2dbg_relax_frag (fragS *);
  97 extern void dwarf2dbg_convert_frag (fragS *);
  98
  99 /* An enumeration which describes the sizes of offsets (to DWARF sections)
 100    and the mechanism by which the size is indicated.  */
 101 enum dwarf2_format {
 102   /* 32-bit format: the initial length field is 4 bytes long.  */
 103   dwarf2_format_32bit,
 104   /* DWARF3 64-bit format: the representation of the initial length
 105      (of a DWARF section) is 0xffffffff (4 bytes) followed by eight
 106      bytes indicating the actual length.  */
 107   dwarf2_format_64bit,
 108   /* SGI extension to DWARF2: The initial length is eight bytes.  */
 109   dwarf2_format_64bit_irix
 110 };
 111
 112 #endif /* AS_DWARF2DBG_H */