src/mc/inspect/Frame.hpp

   1 /* Copyright (c) 2007-2019. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef SIMGRID_MC_FRAME_HPP
   8 #define SIMGRID_MC_FRAME_HPP
   9
  10 #include <cstdint>
  11 #include <string>
  12
  13 #include "xbt/base.h"
  14 #include "xbt/range.hpp"
  15
  16 #include "src/mc/inspect/LocationList.hpp"
  17 #include "src/mc/inspect/Variable.hpp"
  18 #include "src/mc/mc_forward.hpp"
  19
  20 namespace simgrid {
  21 namespace mc {
  22
  23 /** Debug information about a given function or scope within a function */
  24 class Frame {
  25 public:
  26   /** Kind of scope (DW_TAG_subprogram, DW_TAG_inlined_subroutine, etc.) */
  27   int tag = DW_TAG_invalid;
  28
  29   /** Name of the function (if it is a function) */
  30   std::string name;
  31
  32   /** Range of instruction addresses for which this scope is valid */
  33   simgrid::xbt::Range<std::uint64_t> range{0, 0};
  34
  35   simgrid::dwarf::LocationList frame_base_location;
  36
  37   /** List of the variables (sorted by name) */
  38   std::vector<Variable> variables;
  39
  40   /* Unique identifier for this scope (in the object_info)
  41    *
  42    * This is the global DWARF offset of the DIE. */
  43   unsigned long int id = 0;
  44
  45   std::vector<Frame> scopes;
  46
  47   /** Value of `DW_AT_abstract_origin`
  48    *
  49    *  For inlined subprograms, this is the ID of the
  50    *  parent function.
  51    */
  52   unsigned long int abstract_origin_id = 0;
  53
  54   simgrid::mc::ObjectInformation* object_info = nullptr;
  55
  56   void* frame_base(unw_cursor_t& unw_cursor) const;
  57   void remove_variable(char* name);
  58 };
  59 } // namespace mc
  60 } // namespace simgrid
  61
  62 #endif