gdb/jit.h

   1 /* JIT declarations for GDB, the GNU Debugger.
   2
   3    Copyright (C) 2009-2024 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 struct inferior;
  24 struct objfile;
  25 struct minimal_symbol;
  26
  27 /* When the JIT breakpoint fires, the inferior wants us to take one of
  28    these actions.  These values are used by the inferior, so the
  29    values of these enums cannot be changed.  */
  30
  31 enum jit_actions_t
  32 {
  33   JIT_NOACTION = 0,
  34   JIT_REGISTER,
  35   JIT_UNREGISTER
  36 };
  37
  38 /* This struct describes a single symbol file in a linked list of
  39    symbol files describing generated code.  As the inferior generates
  40    code, it adds these entries to the list, and when we attach to the
  41    inferior, we read them all.  For the first element prev_entry
  42    should be NULL, and for the last element next_entry should be
  43    NULL.  */
  44
  45 struct jit_code_entry
  46 {
  47   CORE_ADDR next_entry;
  48   CORE_ADDR prev_entry;
  49   CORE_ADDR symfile_addr;
  50   ULONGEST symfile_size;
  51 };
  52
  53 /* This is the global descriptor that the inferior uses to communicate
  54    information to the debugger.  To alert the debugger to take an
  55    action, the inferior sets the action_flag to the appropriate enum
  56    value, updates relevant_entry to point to the relevant code entry,
  57    and calls the function at the well-known symbol with our
  58    breakpoint.  We then read this descriptor from another global
  59    well-known symbol.  */
  60
  61 struct jit_descriptor
  62 {
  63   uint32_t version;
  64   /* This should be jit_actions_t, but we want to be specific about the
  65      bit-width.  */
  66   uint32_t action_flag;
  67   CORE_ADDR relevant_entry;
  68   CORE_ADDR first_entry;
  69 };
  70
  71 /* An objfile that defines the required symbols of the JIT interface has an
  72    instance of this type attached to it.  */
  73
  74 struct jiter_objfile_data
  75 {
  76   ~jiter_objfile_data ();
  77
  78   /* Symbol for __jit_debug_register_code.  */
  79   minimal_symbol *register_code = nullptr;
  80
  81   /* Symbol for __jit_debug_descriptor.  */
  82   minimal_symbol *descriptor = nullptr;
  83
  84   /* This is the relocated address of the __jit_debug_register_code function
  85      provided by this objfile.  This is used to detect relocations changes
  86      requiring the breakpoint to be re-created.  */
  87   CORE_ADDR cached_code_address = 0;
  88
  89   /* This is the JIT event breakpoint, or nullptr if it has been deleted.  */
  90   breakpoint *jit_breakpoint = nullptr;
  91 };
  92
  93 /* An objfile that is the product of JIT compilation and was registered
  94    using the JIT interface has an instance of this type attached to it.  */
  95
  96 struct jited_objfile_data
  97 {
  98   jited_objfile_data (CORE_ADDR addr, CORE_ADDR symfile_addr,
  99                       ULONGEST symfile_size)
 100     : addr (addr),
 101       symfile_addr (symfile_addr),
 102       symfile_size (symfile_size)
 103   {}
 104
 105   /* Address of struct jit_code_entry for this objfile.  */
 106   CORE_ADDR addr;
 107
 108   /* Value of jit_code_entry->symfile_addr for this objfile.  */
 109   CORE_ADDR symfile_addr;
 110
 111   /* Value of jit_code_entry->symfile_size for this objfile.  */
 112   ULONGEST symfile_size;
 113 };
 114
 115 /* Re-establish the jit breakpoint(s).  */
 116
 117 extern void jit_breakpoint_re_set (void);
 118
 119 /* This function is called by handle_inferior_event when it decides
 120    that the JIT event breakpoint has fired.  JITER is the objfile
 121    whose JIT event breakpoint has been hit.  */
 122
 123 extern void jit_event_handler (gdbarch *gdbarch, objfile *jiter);
 124
 125 #endif /* JIT_H */