gdb/dwarf2loc.h

   1 /* DWARF 2 location expression support for GDB.
   2
   3    Copyright (C) 2003, 2005, 2007-2012 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program 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 of the License, or
  10    (at your option) any later version.
  11
  12    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #if !defined (DWARF2LOC_H)
  21 #define DWARF2LOC_H
  22
  23 #include "dwarf2expr.h"
  24
  25 struct symbol_computed_ops;
  26 struct objfile;
  27 struct dwarf2_per_cu_data;
  28 struct dwarf2_loclist_baton;
  29 struct agent_expr;
  30 struct axs_value;
  31
  32 /* This header is private to the DWARF-2 reader.  It is shared between
  33    dwarf2read.c and dwarf2loc.c.  */
  34
  35 /* `set debug entry-values' setting.  */
  36 extern int entry_values_debug;
  37
  38 /* Return the OBJFILE associated with the compilation unit CU.  If CU
  39    came from a separate debuginfo file, then the master objfile is
  40    returned.  */
  41 struct objfile *dwarf2_per_cu_objfile (struct dwarf2_per_cu_data *cu);
  42
  43 /* Return the address size given in the compilation unit header for CU.  */
  44 int dwarf2_per_cu_addr_size (struct dwarf2_per_cu_data *cu);
  45
  46 /* Return the DW_FORM_ref_addr size given in the compilation unit header for
  47    CU.  */
  48 int dwarf2_per_cu_ref_addr_size (struct dwarf2_per_cu_data *cu);
  49
  50 /* Return the offset size given in the compilation unit header for CU.  */
  51 int dwarf2_per_cu_offset_size (struct dwarf2_per_cu_data *cu);
  52
  53 /* Return the text offset of the CU.  The returned offset comes from
  54    this CU's objfile.  If this objfile came from a separate debuginfo
  55    file, then the offset may be different from the corresponding
  56    offset in the parent objfile.  */
  57 CORE_ADDR dwarf2_per_cu_text_offset (struct dwarf2_per_cu_data *cu);
  58
  59 /* Find a particular location expression from a location list.  */
  60 const gdb_byte *dwarf2_find_location_expression
  61   (struct dwarf2_loclist_baton *baton,
  62    size_t *locexpr_length,
  63    CORE_ADDR pc);
  64
  65 struct dwarf2_locexpr_baton dwarf2_fetch_die_location_block
  66   (cu_offset offset_in_cu, struct dwarf2_per_cu_data *per_cu,
  67    CORE_ADDR (*get_frame_pc) (void *baton),
  68    void *baton);
  69
  70 struct type *dwarf2_get_die_type (cu_offset die_offset,
  71                                   struct dwarf2_per_cu_data *per_cu);
  72
  73 /* Evaluate a location description, starting at DATA and with length
  74    SIZE, to find the current location of variable of TYPE in the context
  75    of FRAME.  */
  76
  77 struct value *dwarf2_evaluate_loc_desc (struct type *type,
  78                                         struct frame_info *frame,
  79                                         const gdb_byte *data,
  80                                         unsigned short size,
  81                                         struct dwarf2_per_cu_data *per_cu);
  82
  83 /* The symbol location baton types used by the DWARF-2 reader (i.e.
  84    SYMBOL_LOCATION_BATON for a LOC_COMPUTED symbol).  "struct
  85    dwarf2_locexpr_baton" is for a symbol with a single location
  86    expression; "struct dwarf2_loclist_baton" is for a symbol with a
  87    location list.  */
  88
  89 struct dwarf2_locexpr_baton
  90 {
  91   /* Pointer to the start of the location expression.  Valid only if SIZE is
  92      not zero.  */
  93   const gdb_byte *data;
  94
  95   /* Length of the location expression.  For optimized out expressions it is
  96      zero.  */
  97   unsigned long size;
  98
  99   /* The compilation unit containing the symbol whose location
 100      we're computing.  */
 101   struct dwarf2_per_cu_data *per_cu;
 102 };
 103
 104 struct dwarf2_loclist_baton
 105 {
 106   /* The initial base address for the location list, based on the compilation
 107      unit.  */
 108   CORE_ADDR base_address;
 109
 110   /* Pointer to the start of the location list.  */
 111   const gdb_byte *data;
 112
 113   /* Length of the location list.  */
 114   unsigned long size;
 115
 116   /* The compilation unit containing the symbol whose location
 117      we're computing.  */
 118   struct dwarf2_per_cu_data *per_cu;
 119 };
 120
 121 extern const struct symbol_computed_ops dwarf2_locexpr_funcs;
 122 extern const struct symbol_computed_ops dwarf2_loclist_funcs;
 123
 124 /* Compile a DWARF location expression to an agent expression.
 125
 126    EXPR is the agent expression we are building.
 127    LOC is the agent value we modify.
 128    ARCH is the architecture.
 129    ADDR_SIZE is the size of addresses, in bytes.
 130    OP_PTR is the start of the location expression.
 131    OP_END is one past the last byte of the location expression.
 132
 133    This will throw an exception for various kinds of errors -- for
 134    example, if the expression cannot be compiled, or if the expression
 135    is invalid.  */
 136
 137 extern void dwarf2_compile_expr_to_ax (struct agent_expr *expr,
 138                                        struct axs_value *loc,
 139                                        struct gdbarch *arch,
 140                                        unsigned int addr_size,
 141                                        const gdb_byte *op_ptr,
 142                                        const gdb_byte *op_end,
 143                                        struct dwarf2_per_cu_data *per_cu);
 144
 145 /* Determined tail calls for constructing virtual tail call frames.  */
 146
 147 struct call_site_chain
 148   {
 149     /* Initially CALLERS == CALLEES == LENGTH.  For partially ambiguous result
 150        CALLERS + CALLEES < LENGTH.  */
 151     int callers, callees, length;
 152
 153     /* Variably sized array with LENGTH elements.  Later [0..CALLERS-1] contain
 154        top (GDB "prev") sites and [LENGTH-CALLEES..LENGTH-1] contain bottom
 155        (GDB "next") sites.  One is interested primarily in the PC field.  */
 156     struct call_site *call_site[1];
 157   };
 158
 159 struct call_site_stuff;
 160 extern struct call_site_chain *call_site_find_chain (struct gdbarch *gdbarch,
 161                                                      CORE_ADDR caller_pc,
 162                                                      CORE_ADDR callee_pc);
 163
 164 #endif /* dwarf2loc.h */