src/mc/Frame.hpp

   1 /* Copyright (c) 2007-2015. 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 <string>
  11 #include <cstdint>
  12
  13 #include <xbt/base.h>
  14 #include <xbt/range.hpp>
  15
  16 #include "src/mc/mc_forward.hpp"
  17 #include "src/mc/LocationList.hpp"
  18 #include "src/mc/Variable.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   Frame();
  27
  28   /** Kind of scope (DW_TAG_subprogram, DW_TAG_inlined_subroutine, etc.) */
  29   int tag = DW_TAG_invalid;
  30
  31   /** Name of the function (if it is a function) */
  32   std::string name;
  33
  34   /** Range of instruction addresses for which this scope is valid */
  35   simgrid::xbt::Range<std::uint64_t> range;
  36
  37   simgrid::dwarf::LocationList frame_base_location;
  38
  39   /** List of the variables (sorted by name) */
  40   std::vector<Variable> variables;
  41
  42   /* Unique identifier for this scope (in the object_info)
  43    *
  44    * This is the global DWARF offset of the DIE. */
  45   unsigned long int id = 0;
  46
  47   std::vector<Frame> scopes;
  48
  49   /** Value of `DW_AT_abstract_origin`
  50    *
  51    *  For inlined subprograms, this is the ID of the
  52    *  parent function.
  53    */
  54   unsigned long int abstract_origin_id = 0;
  55
  56   simgrid::mc::ObjectInformation* object_info = nullptr;
  57
  58   void* frame_base(unw_cursor_t& unw_cursor) const;
  59   void remove_variable(char* name);
  60 };
  61
  62 inline
  63 Frame::Frame()
  64 {
  65   this->tag = 0;
  66   this->range = {0, 0};
  67   this->id = 0;
  68   this->abstract_origin_id = 0;
  69   this->object_info = nullptr;
  70 }
  71
  72 }
  73 }
  74
  75 #endif