gdb/dwarf2loc.h

   1 /* DWARF 2 location expression support for GDB.
   2
   3    Copyright (C) 2003, 2005, 2007, 2008, 2009, 2010, 2011
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #if !defined (DWARF2LOC_H)
  22 #define DWARF2LOC_H
  23
  24 struct symbol_computed_ops;
  25 struct objfile;
  26 struct dwarf2_per_cu_data;
  27 struct dwarf2_loclist_baton;
  28 struct agent_expr;
  29 struct axs_value;
  30
  31 /* This header is private to the DWARF-2 reader.  It is shared between
  32    dwarf2read.c and dwarf2loc.c.  */
  33
  34 /* Return the OBJFILE associated with the compilation unit CU.  If CU
  35    came from a separate debuginfo file, then the master objfile is
  36    returned.  */
  37 struct objfile *dwarf2_per_cu_objfile (struct dwarf2_per_cu_data *cu);
  38
  39 /* Return the address size given in the compilation unit header for CU.  */
  40 CORE_ADDR dwarf2_per_cu_addr_size (struct dwarf2_per_cu_data *cu);
  41
  42 /* Return the DW_FORM_ref_addr size given in the compilation unit header for
  43    CU.  */
  44 int dwarf2_per_cu_ref_addr_size (struct dwarf2_per_cu_data *cu);
  45
  46 /* Return the offset size given in the compilation unit header for CU.  */
  47 int dwarf2_per_cu_offset_size (struct dwarf2_per_cu_data *cu);
  48
  49 /* Return the text offset of the CU.  The returned offset comes from
  50    this CU's objfile.  If this objfile came from a separate debuginfo
  51    file, then the offset may be different from the corresponding
  52    offset in the parent objfile.  */
  53 CORE_ADDR dwarf2_per_cu_text_offset (struct dwarf2_per_cu_data *cu);
  54
  55 /* Find a particular location expression from a location list.  */
  56 const gdb_byte *dwarf2_find_location_expression
  57   (struct dwarf2_loclist_baton *baton,
  58    size_t *locexpr_length,
  59    CORE_ADDR pc);
  60
  61 struct dwarf2_locexpr_baton dwarf2_fetch_die_location_block
  62   (unsigned int offset, struct dwarf2_per_cu_data *per_cu,
  63    CORE_ADDR (*get_frame_pc) (void *baton),
  64    void *baton);
  65
  66 struct type *dwarf2_get_die_type (unsigned int die_offset,
  67                                   struct dwarf2_per_cu_data *per_cu);
  68
  69 /* Evaluate a location description, starting at DATA and with length
  70    SIZE, to find the current location of variable of TYPE in the context
  71    of FRAME.  */
  72
  73 struct value *dwarf2_evaluate_loc_desc (struct type *type,
  74                                         struct frame_info *frame,
  75                                         const gdb_byte *data,
  76                                         unsigned short size,
  77                                         struct dwarf2_per_cu_data *per_cu);
  78
  79 /* The symbol location baton types used by the DWARF-2 reader (i.e.
  80    SYMBOL_LOCATION_BATON for a LOC_COMPUTED symbol).  "struct
  81    dwarf2_locexpr_baton" is for a symbol with a single location
  82    expression; "struct dwarf2_loclist_baton" is for a symbol with a
  83    location list.  */
  84
  85 struct dwarf2_locexpr_baton
  86 {
  87   /* Pointer to the start of the location expression.  */
  88   const gdb_byte *data;
  89
  90   /* Length of the location expression.  */
  91   unsigned long size;
  92
  93   /* The compilation unit containing the symbol whose location
  94      we're computing.  */
  95   struct dwarf2_per_cu_data *per_cu;
  96 };
  97
  98 struct dwarf2_loclist_baton
  99 {
 100   /* The initial base address for the location list, based on the compilation
 101      unit.  */
 102   CORE_ADDR base_address;
 103
 104   /* Pointer to the start of the location list.  */
 105   const gdb_byte *data;
 106
 107   /* Length of the location list.  */
 108   unsigned long size;
 109
 110   /* The compilation unit containing the symbol whose location
 111      we're computing.  */
 112   struct dwarf2_per_cu_data *per_cu;
 113 };
 114
 115 extern const struct symbol_computed_ops dwarf2_locexpr_funcs;
 116 extern const struct symbol_computed_ops dwarf2_loclist_funcs;
 117
 118 /* Compile a DWARF location expression to an agent expression.
 119
 120    EXPR is the agent expression we are building.
 121    LOC is the agent value we modify.
 122    ARCH is the architecture.
 123    ADDR_SIZE is the size of addresses, in bytes.
 124    OP_PTR is the start of the location expression.
 125    OP_END is one past the last byte of the location expression.
 126
 127    This will throw an exception for various kinds of errors -- for
 128    example, if the expression cannot be compiled, or if the expression
 129    is invalid.  */
 130
 131 extern void dwarf2_compile_expr_to_ax (struct agent_expr *expr,
 132                                        struct axs_value *loc,
 133                                        struct gdbarch *arch,
 134                                        unsigned int addr_size,
 135                                        const gdb_byte *op_ptr,
 136                                        const gdb_byte *op_end,
 137                                        struct dwarf2_per_cu_data *per_cu);
 138
 139 #endif /* dwarf2loc.h */