src/mc/LocationList.hpp

   1 /* Copyright (c) 2004-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_OBJECT_LOCATION_H
   8 #define SIMGRID_MC_OBJECT_LOCATION_H
   9
  10 #include <cstdint>
  11
  12 #include <vector>
  13
  14 #include <libunwind.h>
  15 #include <dwarf.h>
  16 #include <elfutils/libdw.h>
  17
  18 #include "xbt/base.h"
  19 #include "xbt/range.hpp"
  20
  21 #include "src/mc/mc_base.h"
  22 #include "src/mc/mc_forward.hpp"
  23 #include "src/mc/DwarfExpression.hpp"
  24
  25 namespace simgrid {
  26 namespace dwarf {
  27
  28 /** A DWARF expression with optional validity constraints */
  29 class LocationListEntry {
  30 public:
  31   typedef simgrid::xbt::Range<std::uint64_t> range_type;
  32 private:
  33   DwarfExpression expression_;
  34   // By default, the expression is always valid:
  35   range_type range_ = {0, UINT64_MAX};
  36 public:
  37   LocationListEntry() {}
  38   LocationListEntry(DwarfExpression expression, range_type range)
  39     : expression_(std::move(expression)), range_(range)
  40   {}
  41   explicit LocationListEntry(DwarfExpression expression) : expression_(std::move(expression)), range_({0, UINT64_MAX})
  42   {}
  43
  44   DwarfExpression& expression()
  45   {
  46     return expression_;
  47   }
  48   DwarfExpression const& expression() const
  49   {
  50     return expression_;
  51   }
  52   bool valid_for_ip(unw_word_t ip) const
  53   {
  54     return range_.contain(ip);
  55   }
  56 };
  57
  58 typedef std::vector<LocationListEntry> LocationList;
  59
  60 /** Location of some variable in memory
  61  *
  62  *  The variable is located either in memory of a register.
  63  */
  64 class Location {
  65 private:
  66   void* memory_;
  67   int register_id_;
  68 public:
  69   explicit Location(void* x) : memory_(x) {}
  70   explicit Location(int register_id) : memory_(nullptr), register_id_(register_id) {}
  71   // Type of location:
  72   bool in_register() const { return memory_ == nullptr; }
  73   bool in_memory()   const { return memory_ != nullptr; }
  74
  75   // Get the location:
  76   void* address()    const { return memory_; }
  77   int register_id()  const { return register_id_;     }
  78 };
  79
  80 XBT_PRIVATE
  81 Location resolve(
  82   simgrid::dwarf::DwarfExpression const& expression,
  83   simgrid::mc::ObjectInformation* object_info, unw_cursor_t* c,
  84   void* frame_pointer_address, simgrid::mc::AddressSpace* address_space,
  85   int process_index);
  86
  87 Location resolve(
  88   simgrid::dwarf::LocationList const& locations,
  89   simgrid::mc::ObjectInformation* object_info,
  90   unw_cursor_t * c,
  91   void *frame_pointer_address,
  92   simgrid::mc::AddressSpace* address_space,
  93   int process_index);
  94
  95 XBT_PRIVATE
  96 simgrid::dwarf::LocationList location_list(
  97   simgrid::mc::ObjectInformation& info,
  98   Dwarf_Attribute& attr);
  99
 100 }
 101 }
 102
 103 #endif