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