gdb/jit.h

   1 /* JIT declarations for GDB, the GNU Debugger.
   2
   3    Copyright (C) 2009, 2010 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 #ifndef JIT_H
  21 #define JIT_H
  22
  23 /* When the JIT breakpoint fires, the inferior wants us to take one of these
  24    actions.  These values are used by the inferior, so the values of these enums
  25    cannot be changed.  */
  26
  27 typedef enum
  28 {
  29   JIT_NOACTION = 0,
  30   JIT_REGISTER,
  31   JIT_UNREGISTER
  32 } jit_actions_t;
  33
  34 /* This struct describes a single symbol file in a linked list of symbol files
  35    describing generated code.  As the inferior generates code, it adds these
  36    entries to the list, and when we attach to the inferior, we read them all.
  37    For the first element prev_entry should be NULL, and for the last element
  38    next_entry should be NULL.  */
  39
  40 struct jit_code_entry
  41 {
  42   CORE_ADDR next_entry;
  43   CORE_ADDR prev_entry;
  44   CORE_ADDR symfile_addr;
  45   uint64_t symfile_size;
  46 };
  47
  48 /* This is the global descriptor that the inferior uses to communicate
  49    information to the debugger.  To alert the debugger to take an action, the
  50    inferior sets the action_flag to the appropriate enum value, updates
  51    relevant_entry to point to the relevant code entry, and calls the function at
  52    the well-known symbol with our breakpoint.  We then read this descriptor from
  53    another global well-known symbol.  */
  54
  55 struct jit_descriptor
  56 {
  57   uint32_t version;
  58   /* This should be jit_actions_t, but we want to be specific about the
  59      bit-width.  */
  60   uint32_t action_flag;
  61   CORE_ADDR relevant_entry;
  62   CORE_ADDR first_entry;
  63 };
  64
  65 /* Looks for the descriptor and registration symbols and breakpoints the
  66    registration function.  If it finds both, it registers all the already JITed
  67    code.  If it has already found the symbols, then it doesn't try again.  */
  68
  69 extern void jit_inferior_created_hook (void);
  70
  71 /* Re-establish the jit breakpoint(s).  */
  72
  73 extern void jit_breakpoint_re_set (void);
  74
  75 /* This function is called by handle_inferior_event when it decides that the JIT
  76    event breakpoint has fired.  */
  77
  78 extern void jit_event_handler (struct gdbarch *gdbarch);
  79
  80 #endif /* JIT_H */