gdb/compile/compile-object-load.h

   1 /* Header file to load module for 'compile' command.
   2    Copyright (C) 2014-2025 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 #ifndef GDB_COMPILE_COMPILE_OBJECT_LOAD_H
  18 #define GDB_COMPILE_COMPILE_OBJECT_LOAD_H
  19
  20 #include "compile-internal.h"
  21 #include "compile.h"
  22 #include <list>
  23
  24 struct munmap_list
  25 {
  26 public:
  27
  28   munmap_list () = default;
  29   ~munmap_list ();
  30
  31   DISABLE_COPY_AND_ASSIGN (munmap_list);
  32
  33   munmap_list &operator= (munmap_list &&) = default;
  34   munmap_list (munmap_list &&) = default;
  35
  36   /* Add a region to the list.  */
  37   void add (CORE_ADDR addr, CORE_ADDR size);
  38
  39 private:
  40
  41   /* Track inferior memory reserved by inferior mmap.  */
  42
  43   struct munmap_item
  44   {
  45     CORE_ADDR addr, size;
  46   };
  47
  48   std::vector<munmap_item> items;
  49 };
  50
  51 struct compile_module
  52 {
  53   compile_module () = default;
  54
  55   DISABLE_COPY_AND_ASSIGN (compile_module);
  56
  57   compile_module &operator= (compile_module &&other) = default;
  58   compile_module (compile_module &&other) = default;
  59
  60   /* objfile for the compiled module.  */
  61   struct objfile *objfile;
  62
  63   /* .c file OBJFILE was built from.  */
  64   std::string source_file;
  65
  66   /* Inferior function GCC_FE_WRAPPER_FUNCTION.  */
  67   struct symbol *func_sym;
  68
  69   /* Inferior registers address or NULL if the inferior function does not
  70      require any.  */
  71   CORE_ADDR regs_addr;
  72
  73   /* The "scope" of this compilation.  */
  74   enum compile_i_scope_types scope;
  75
  76   /* User data for SCOPE in use.  */
  77   void *scope_data;
  78
  79   /* Inferior parameter out value type or NULL if the inferior function does not
  80      have one.  */
  81   struct type *out_value_type;
  82
  83   /* If the inferior function has an out value, this is its address.
  84      Otherwise it is zero.  */
  85   CORE_ADDR out_value_addr;
  86
  87   /* Track inferior memory reserved by inferior mmap.  */
  88   struct munmap_list munmap_list;
  89 };
  90
  91 /* A unique pointer for a compile_module.  */
  92 typedef std::unique_ptr<compile_module> compile_module_up;
  93
  94 extern compile_module_up compile_object_load
  95   (const compile_file_names &fnames,
  96    enum compile_i_scope_types scope, void *scope_data);
  97
  98 #endif /* GDB_COMPILE_COMPILE_OBJECT_LOAD_H */