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   LocationListEntry(DwarfExpression expression)
  42     : expression_(std::move(expression)), range_({0, UINT64_MAX})
  43   {}
  44
  45   DwarfExpression& expression()
  46   {
  47     return expression_;
  48   }
  49   DwarfExpression const& expression() const
  50   {
  51     return expression_;
  52   }
  53   bool valid_for_ip(unw_word_t ip) const
  54   {
  55     return range_.contain(ip);
  56   }
  57 };
  58
  59 typedef std::vector<LocationListEntry> LocationList;
  60
  61 /** Location of some variable in memory
  62  *
  63  *  The variable is located either in memory of a register.
  64  */
  65 class Location {
  66 private:
  67   void* memory_;
  68   int register_id_;
  69 public:
  70   Location(void* x) :memory_(x) {}
  71   Location(int register_id) :
  72     memory_(nullptr), register_id_(register_id) {}
  73   // Type of location:
  74   bool in_register() const { return memory_ == nullptr; }
  75   bool in_memory()   const { return memory_ != nullptr; }
  76
  77   // Get the location:
  78   void* address()    const { return memory_; }
  79   int register_id()  const { return register_id_;     }
  80 };
  81
  82 XBT_PRIVATE
  83 Location resolve(
  84   simgrid::dwarf::DwarfExpression const& expression,
  85   simgrid::mc::ObjectInformation* object_info, unw_cursor_t* c,
  86   void* frame_pointer_address, simgrid::mc::AddressSpace* address_space,
  87   int process_index);
  88
  89 Location resolve(
  90   simgrid::dwarf::LocationList const& locations,
  91   simgrid::mc::ObjectInformation* object_info,
  92   unw_cursor_t * c,
  93   void *frame_pointer_address,
  94   simgrid::mc::AddressSpace* address_space,
  95   int process_index);
  96
  97 XBT_PRIVATE
  98 simgrid::dwarf::LocationList location_list(
  99   simgrid::mc::ObjectInformation& info,
 100   Dwarf_Attribute& attr);
 101
 102 }
 103 }
 104
 105 #endif