gas/dwarf2dbg.h

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