gdb/dwarf2expr.h

   1 /* DWARF 2 Expression Evaluator.
   2
   3    Copyright (C) 2001-2003, 2005, 2007-2012 Free Software Foundation,
   4    Inc.
   5
   6    Contributed by Daniel Berlin <dan@dberlin.org>.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 #if !defined (DWARF2EXPR_H)
  24 #define DWARF2EXPR_H
  25
  26 struct dwarf_expr_context;
  27
  28 /* Virtual method table for struct dwarf_expr_context below.  */
  29
  30 struct dwarf_expr_context_funcs
  31 {
  32   /* Return the value of register number REGNUM.  */
  33   CORE_ADDR (*read_reg) (void *baton, int regnum);
  34
  35   /* Read LENGTH bytes at ADDR into BUF.  */
  36   void (*read_mem) (void *baton, gdb_byte *buf, CORE_ADDR addr, size_t length);
  37
  38   /* Return the location expression for the frame base attribute, in
  39      START and LENGTH.  The result must be live until the current
  40      expression evaluation is complete.  */
  41   void (*get_frame_base) (void *baton, const gdb_byte **start, size_t *length);
  42
  43   /* Return the CFA for the frame.  */
  44   CORE_ADDR (*get_frame_cfa) (void *baton);
  45
  46   /* Return the PC for the frame.  */
  47   CORE_ADDR (*get_frame_pc) (void *baton);
  48
  49   /* Return the thread-local storage address for
  50      DW_OP_GNU_push_tls_address.  */
  51   CORE_ADDR (*get_tls_address) (void *baton, CORE_ADDR offset);
  52
  53   /* Execute DW_AT_location expression for the DWARF expression subroutine in
  54      the DIE at DIE_OFFSET in the CU from CTX.  Do not touch STACK while it
  55      being passed to and returned from the called DWARF subroutine.  */
  56   void (*dwarf_call) (struct dwarf_expr_context *ctx, size_t die_offset);
  57
  58   /* Return the base type given by the indicated DIE.  This can throw
  59      an exception if the DIE is invalid or does not represent a base
  60      type.  If can also be NULL in the special case where the
  61      callbacks are not performing evaluation, and thus it is
  62      meaningful to substitute a stub type of the correct size.  */
  63   struct type *(*get_base_type) (struct dwarf_expr_context *ctx, size_t die);
  64
  65   /* Push on DWARF stack an entry evaluated for DW_TAG_GNU_call_site's
  66      DWARF_REG/FB_OFFSET at the caller of specified BATON.  If DWARF register
  67      number DWARF_REG specifying the push_dwarf_reg_entry_value parameter is
  68      not -1 FB_OFFSET is ignored.  Otherwise FB_OFFSET specifies stack
  69      parameter offset against caller's stack pointer (which equals the callee's
  70      frame base).  If DEREF_SIZE is not -1 then use
  71      DW_AT_GNU_call_site_data_value instead of DW_AT_GNU_call_site_value.  */
  72   void (*push_dwarf_reg_entry_value) (struct dwarf_expr_context *ctx,
  73                                       int dwarf_reg, CORE_ADDR fb_offset,
  74                                       int deref_size);
  75
  76 #if 0
  77   /* Not yet implemented.  */
  78
  79   /* Return the `object address' for DW_OP_push_object_address.  */
  80   CORE_ADDR (*get_object_address) (void *baton);
  81 #endif
  82 };
  83
  84 /* The location of a value.  */
  85 enum dwarf_value_location
  86 {
  87   /* The piece is in memory.
  88      The value on the dwarf stack is its address.  */
  89   DWARF_VALUE_MEMORY,
  90
  91   /* The piece is in a register.
  92      The value on the dwarf stack is the register number.  */
  93   DWARF_VALUE_REGISTER,
  94
  95   /* The piece is on the dwarf stack.  */
  96   DWARF_VALUE_STACK,
  97
  98   /* The piece is a literal.  */
  99   DWARF_VALUE_LITERAL,
 100
 101   /* The piece was optimized out.  */
 102   DWARF_VALUE_OPTIMIZED_OUT,
 103
 104   /* The piece is an implicit pointer.  */
 105   DWARF_VALUE_IMPLICIT_POINTER
 106 };
 107
 108 /* The dwarf expression stack.  */
 109
 110 struct dwarf_stack_value
 111 {
 112   struct value *value;
 113
 114   /* Non-zero if the piece is in memory and is known to be
 115      on the program's stack.  It is always ok to set this to zero.
 116      This is used, for example, to optimize memory access from the target.
 117      It can vastly speed up backtraces on long latency connections when
 118      "set stack-cache on".  */
 119   int in_stack_memory;
 120 };
 121
 122 /* The expression evaluator works with a dwarf_expr_context, describing
 123    its current state and its callbacks.  */
 124 struct dwarf_expr_context
 125 {
 126   /* The stack of values, allocated with xmalloc.  */
 127   struct dwarf_stack_value *stack;
 128
 129   /* The number of values currently pushed on the stack, and the
 130      number of elements allocated to the stack.  */
 131   int stack_len, stack_allocated;
 132
 133   /* Target architecture to use for address operations.  */
 134   struct gdbarch *gdbarch;
 135
 136   /* Target address size in bytes.  */
 137   int addr_size;
 138
 139   /* DW_FORM_ref_addr size in bytes.  If -1 DWARF is executed from a frame
 140      context and operations depending on DW_FORM_ref_addr are not allowed.  */
 141   int ref_addr_size;
 142
 143   /* Offset used to relocate DW_OP_addr argument.  */
 144   CORE_ADDR offset;
 145
 146   /* An opaque argument provided by the caller, which will be passed
 147      to all of the callback functions.  */
 148   void *baton;
 149
 150   /* Callback functions.  */
 151   const struct dwarf_expr_context_funcs *funcs;
 152
 153   /* The current depth of dwarf expression recursion, via DW_OP_call*,
 154      DW_OP_fbreg, DW_OP_push_object_address, etc., and the maximum
 155      depth we'll tolerate before raising an error.  */
 156   int recursion_depth, max_recursion_depth;
 157
 158   /* Location of the value.  */
 159   enum dwarf_value_location location;
 160
 161   /* For DWARF_VALUE_LITERAL, the current literal value's length and
 162      data.  For DWARF_VALUE_IMPLICIT_POINTER, LEN is the offset of the
 163      target DIE.  */
 164   ULONGEST len;
 165   const gdb_byte *data;
 166
 167   /* Initialization status of variable: Non-zero if variable has been
 168      initialized; zero otherwise.  */
 169   int initialized;
 170
 171   /* An array of pieces.  PIECES points to its first element;
 172      NUM_PIECES is its length.
 173
 174      Each time DW_OP_piece is executed, we add a new element to the
 175      end of this array, recording the current top of the stack, the
 176      current location, and the size given as the operand to
 177      DW_OP_piece.  We then pop the top value from the stack, reset the
 178      location, and resume evaluation.
 179
 180      The Dwarf spec doesn't say whether DW_OP_piece pops the top value
 181      from the stack.  We do, ensuring that clients of this interface
 182      expecting to see a value left on the top of the stack (say, code
 183      evaluating frame base expressions or CFA's specified with
 184      DW_CFA_def_cfa_expression) will get an error if the expression
 185      actually marks all the values it computes as pieces.
 186
 187      If an expression never uses DW_OP_piece, num_pieces will be zero.
 188      (It would be nice to present these cases as expressions yielding
 189      a single piece, so that callers need not distinguish between the
 190      no-DW_OP_piece and one-DW_OP_piece cases.  But expressions with
 191      no DW_OP_piece operations have no value to place in a piece's
 192      'size' field; the size comes from the surrounding data.  So the
 193      two cases need to be handled separately.)  */
 194   int num_pieces;
 195   struct dwarf_expr_piece *pieces;
 196 };
 197
 198
 199 /* A piece of an object, as recorded by DW_OP_piece or DW_OP_bit_piece.  */
 200 struct dwarf_expr_piece
 201 {
 202   enum dwarf_value_location location;
 203
 204   union
 205   {
 206     struct
 207     {
 208       /* This piece's address, for DWARF_VALUE_MEMORY pieces.  */
 209       CORE_ADDR addr;
 210       /* Non-zero if the piece is known to be in memory and on
 211          the program's stack.  */
 212       int in_stack_memory;
 213     } mem;
 214
 215     /* The piece's register number, for DWARF_VALUE_REGISTER pieces.  */
 216     int regno;
 217
 218     /* The piece's literal value, for DWARF_VALUE_STACK pieces.  */
 219     struct value *value;
 220
 221     struct
 222     {
 223       /* A pointer to the data making up this piece,
 224          for DWARF_VALUE_LITERAL pieces.  */
 225       const gdb_byte *data;
 226       /* The length of the available data.  */
 227       ULONGEST length;
 228     } literal;
 229
 230     /* Used for DWARF_VALUE_IMPLICIT_POINTER.  */
 231     struct
 232     {
 233       /* The referent DIE from DW_OP_GNU_implicit_pointer.  */
 234       ULONGEST die;
 235       /* The byte offset into the resulting data.  */
 236       LONGEST offset;
 237     } ptr;
 238   } v;
 239
 240   /* The length of the piece, in bits.  */
 241   ULONGEST size;
 242   /* The piece offset, in bits.  */
 243   ULONGEST offset;
 244 };
 245
 246 struct dwarf_expr_context *new_dwarf_expr_context (void);
 247 void free_dwarf_expr_context (struct dwarf_expr_context *ctx);
 248 struct cleanup *
 249     make_cleanup_free_dwarf_expr_context (struct dwarf_expr_context *ctx);
 250
 251 void dwarf_expr_push_address (struct dwarf_expr_context *ctx,
 252                               CORE_ADDR value,
 253                               int in_stack_memory);
 254 void dwarf_expr_eval (struct dwarf_expr_context *ctx, const gdb_byte *addr,
 255                       size_t len);
 256 struct value *dwarf_expr_fetch (struct dwarf_expr_context *ctx, int n);
 257 CORE_ADDR dwarf_expr_fetch_address (struct dwarf_expr_context *ctx, int n);
 258 int dwarf_expr_fetch_in_stack_memory (struct dwarf_expr_context *ctx, int n);
 259
 260
 261 const gdb_byte *read_uleb128 (const gdb_byte *buf, const gdb_byte *buf_end,
 262                               ULONGEST * r);
 263 const gdb_byte *read_sleb128 (const gdb_byte *buf, const gdb_byte *buf_end,
 264                               LONGEST * r);
 265
 266 const char *dwarf_stack_op_name (unsigned int);
 267
 268 void dwarf_expr_require_composition (const gdb_byte *, const gdb_byte *,
 269                                      const char *);
 270
 271 /* Stub dwarf_expr_context_funcs implementations.  */
 272
 273 void ctx_no_get_frame_base (void *baton, const gdb_byte **start,
 274                             size_t *length);
 275 CORE_ADDR ctx_no_get_frame_cfa (void *baton);
 276 CORE_ADDR ctx_no_get_frame_pc (void *baton);
 277 CORE_ADDR ctx_no_get_tls_address (void *baton, CORE_ADDR offset);
 278 void ctx_no_dwarf_call (struct dwarf_expr_context *ctx, size_t die_offset);
 279 struct type *ctx_no_get_base_type (struct dwarf_expr_context *ctx, size_t die);
 280 void ctx_no_push_dwarf_reg_entry_value (struct dwarf_expr_context *ctx,
 281                                         int dwarf_reg, CORE_ADDR fb_offset,
 282                                         int deref_size);
 283
 284 int dwarf_block_to_dwarf_reg (const gdb_byte *buf, const gdb_byte *buf_end);
 285
 286 int dwarf_block_to_dwarf_reg_deref (const gdb_byte *buf,
 287                                     const gdb_byte *buf_end,
 288                                     CORE_ADDR *deref_size_return);
 289
 290 int dwarf_block_to_fb_offset (const gdb_byte *buf, const gdb_byte *buf_end,
 291                               CORE_ADDR *fb_offset_return);
 292
 293 int dwarf_block_to_sp_offset (struct gdbarch *gdbarch, const gdb_byte *buf,
 294                               const gdb_byte *buf_end,
 295                               CORE_ADDR *sp_offset_return);
 296
 297 #endif /* dwarf2expr.h */