mc: move some files related to ELF, DWARF or unwind reading into their own directory

[simgrid.git] / src / mc / inspect / LocationList.hpp

diff --git a/src/mc/inspect/LocationList.hpp b/src/mc/inspect/LocationList.hpp
new file mode 100644 (file)
index 0000000..b937ef4
--- /dev/null
+++ b/src/mc/inspect/LocationList.hpp
@@ -0,0 +1,82 @@
+/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
+#ifndef SIMGRID_MC_OBJECT_LOCATION_H
+#define SIMGRID_MC_OBJECT_LOCATION_H
+
+#include "xbt/base.h"
+#include "xbt/range.hpp"
+
+#include "src/mc/inspect/DwarfExpression.hpp"
+#include "src/mc/mc_base.h"
+#include "src/mc/mc_forward.hpp"
+
+#include <cstdint>
+#include <vector>
+
+namespace simgrid {
+namespace dwarf {
+
+/** A DWARF expression with optional validity constraints */
+class LocationListEntry {
+public:
+  typedef simgrid::xbt::Range<std::uint64_t> range_type;
+
+private:
+  DwarfExpression expression_;
+  // By default, the expression is always valid:
+  range_type range_ = {0, UINT64_MAX};
+
+public:
+  LocationListEntry() = default;
+  LocationListEntry(DwarfExpression expression, range_type range) : expression_(std::move(expression)), range_(range) {}
+  explicit LocationListEntry(DwarfExpression expression) : expression_(std::move(expression)), range_({0, UINT64_MAX})
+  {
+  }
+
+  DwarfExpression& expression() { return expression_; }
+  DwarfExpression const& expression() const { return expression_; }
+  bool valid_for_ip(unw_word_t ip) const { return range_.contain(ip); }
+};
+
+typedef std::vector<LocationListEntry> LocationList;
+
+/** Location of some variable in memory
+ *
+ *  The variable is located either in memory of a register.
+ */
+class Location {
+private:
+  void* memory_;
+  int register_id_ = 0;
+
+public:
+  explicit Location(void* x) : memory_(x) {}
+  explicit Location(int register_id) : memory_(nullptr), register_id_(register_id) {}
+  // Type of location:
+  bool in_register() const { return memory_ == nullptr; }
+  bool in_memory() const { return memory_ != nullptr; }
+
+  // Get the location:
+  void* address() const { return memory_; }
+  int register_id() const { return register_id_; }
+};
+
+XBT_PRIVATE
+Location resolve(simgrid::dwarf::DwarfExpression const& expression, simgrid::mc::ObjectInformation* object_info,
+                 unw_cursor_t* c, void* frame_pointer_address, simgrid::mc::AddressSpace* address_space,
+                 int process_index);
+
+Location resolve(simgrid::dwarf::LocationList const& locations, simgrid::mc::ObjectInformation* object_info,
+                 unw_cursor_t* c, void* frame_pointer_address, simgrid::mc::AddressSpace* address_space,
+                 int process_index);
+
+XBT_PRIVATE
+simgrid::dwarf::LocationList location_list(simgrid::mc::ObjectInformation& info, Dwarf_Attribute& attr);
+
+} // namespace dwarf
+} // namespace simgrid
+
+#endif