From e00d6cb185bdcc30f0a380611c98d9a5baffbdb3 Mon Sep 17 00:00:00 2001
From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Tue, 23 Feb 2016 15:36:44 +0100
Subject: [PATCH 1/1] [mc] Move remote_ptr in its own file

---
 src/mc/AddressSpace.hpp          |  99 +------------------------
 src/mc/remote_ptr.hpp            | 120 +++++++++++++++++++++++++++++++
 tools/cmake/DefinePackages.cmake |   1 +
 3 files changed, 122 insertions(+), 98 deletions(-)
 create mode 100644 src/mc/remote_ptr.hpp

diff --git a/src/mc/AddressSpace.hpp b/src/mc/AddressSpace.hpp
index 7c75d44bcd..8d370bd502 100644
--- a/src/mc/AddressSpace.hpp
+++ b/src/mc/AddressSpace.hpp
@@ -14,108 +14,11 @@
 #include <xbt/misc.h>
 
 #include "src/mc/mc_forward.hpp"
+#include "src/mc/remote_ptr.hpp"
 
 namespace simgrid {
 namespace mc {
 
-/** Pointer to a remote address-space (process, snapshot)
- *
- *  With this we can clearly identify the expected type of an address in the
- *  remote process while avoiding to use native local pointers.
- *
- *  Some operators (+/-) assume use the size of the underlying element. This
- *  only works if the target applications is using the same target: it won't
- *  work for example, when inspecting a 32 bit application from a 64 bit
- *  model-checker.
- */
-template<class T> class remote_ptr {
-  std::uint64_t address_;
-public:
-  remote_ptr() : address_(0) {}
-  remote_ptr(std::uint64_t address) : address_(address) {}
-  remote_ptr(T* address) : address_((std::uintptr_t)address) {}
-  std::uint64_t address() const { return address_; }
-
-  operator bool() const
-  {
-    return address_;
-  }
-  bool operator!() const
-  {
-    return !address_;
-  }
-  operator remote_ptr<void>() const
-  {
-    return remote_ptr<void>(address_);
-  }
-  remote_ptr<T> operator+(std::uint64_t n) const
-  {
-    return remote_ptr<T>(address_ + n * sizeof(T));
-  }
-  remote_ptr<T> operator-(std::uint64_t n) const
-  {
-    return remote_ptr<T>(address_ - n * sizeof(T));
-  }
-  remote_ptr<T>& operator+=(std::uint64_t n)
-  {
-    address_ += n * sizeof(T);
-    return *this;
-  }
-  remote_ptr<T>& operator-=(std::uint64_t n)
-  {
-    address_ -= n * sizeof(T);
-    return *this;
-  }
-};
-
-template<class X, class Y>
-bool operator<(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() < y.address();
-}
-
-template<class X, class Y>
-bool operator>(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() > y.address();
-}
-
-template<class X, class Y>
-bool operator>=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() >= y.address();
-}
-
-template<class X, class Y>
-bool operator<=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() <= y.address();
-}
-
-template<class X, class Y>
-bool operator==(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() == y.address();
-}
-
-template<class X, class Y>
-bool operator!=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() != y.address();
-}
-
-template<class T> inline
-remote_ptr<T> remote(T *p)
-{
-  return remote_ptr<T>(p);
-}
-
-template<class T=void> inline
-remote_ptr<T> remote(uint64_t p)
-{
-  return remote_ptr<T>(p);
-}
-
 /** Process index used when no process is available
  *
  *  The expected behaviour is that if a process index is needed it will fail.
diff --git a/src/mc/remote_ptr.hpp b/src/mc/remote_ptr.hpp
new file mode 100644
index 0000000000..9e0d85dbe4
--- /dev/null
+++ b/src/mc/remote_ptr.hpp
@@ -0,0 +1,120 @@
+/* Copyright (c) 2008-2015. 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_REMOTE_PTR_HPP
+#define SIMGRID_MC_REMOTE_PTR_HPP
+
+#include <cstdint>
+
+namespace simgrid {
+namespace mc {
+
+/** Pointer to a remote address-space (process, snapshot)
+ *
+ *  With this we can clearly identify the expected type of an address in the
+ *  remote process while avoiding to use native local pointers.
+ *
+ *  Some operators (+/-) assume use the size of the underlying element. This
+ *  only works if the target applications is using the same target: it won't
+ *  work for example, when inspecting a 32 bit application from a 64 bit
+ *  model-checker.
+ *
+ *  We do not actually store the target address space because we can
+ *  always detect it in context. This way `remote_ptr` is as efficient
+ *  as a `uint64_t`.
+ */
+template<class T> class remote_ptr {
+  std::uint64_t address_;
+public:
+  remote_ptr() : address_(0) {}
+  remote_ptr(std::uint64_t address) : address_(address) {}
+  remote_ptr(T* address) : address_((std::uintptr_t)address) {}
+  std::uint64_t address() const { return address_; }
+
+  operator bool() const
+  {
+    return address_;
+  }
+  bool operator!() const
+  {
+    return !address_;
+  }
+  operator remote_ptr<void>() const
+  {
+    return remote_ptr<void>(address_);
+  }
+  remote_ptr<T> operator+(std::uint64_t n) const
+  {
+    return remote_ptr<T>(address_ + n * sizeof(T));
+  }
+  remote_ptr<T> operator-(std::uint64_t n) const
+  {
+    return remote_ptr<T>(address_ - n * sizeof(T));
+  }
+  remote_ptr<T>& operator+=(std::uint64_t n)
+  {
+    address_ += n * sizeof(T);
+    return *this;
+  }
+  remote_ptr<T>& operator-=(std::uint64_t n)
+  {
+    address_ -= n * sizeof(T);
+    return *this;
+  }
+};
+
+template<class X, class Y>
+bool operator<(remote_ptr<X> const& x, remote_ptr<Y> const& y)
+{
+  return x.address() < y.address();
+}
+
+template<class X, class Y>
+bool operator>(remote_ptr<X> const& x, remote_ptr<Y> const& y)
+{
+  return x.address() > y.address();
+}
+
+template<class X, class Y>
+bool operator>=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
+{
+  return x.address() >= y.address();
+}
+
+template<class X, class Y>
+bool operator<=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
+{
+  return x.address() <= y.address();
+}
+
+template<class X, class Y>
+bool operator==(remote_ptr<X> const& x, remote_ptr<Y> const& y)
+{
+  return x.address() == y.address();
+}
+
+template<class X, class Y>
+bool operator!=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
+{
+  return x.address() != y.address();
+}
+
+template<class T> inline
+remote_ptr<T> remote(T *p)
+{
+  return remote_ptr<T>(p);
+}
+
+template<class T=void> inline
+remote_ptr<T> remote(uint64_t p)
+{
+  return remote_ptr<T>(p);
+}
+
+}
+}
+
+#endif
diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake
index 2243e9c065..d5465fcd0e 100644
--- a/tools/cmake/DefinePackages.cmake
+++ b/tools/cmake/DefinePackages.cmake
@@ -563,6 +563,7 @@ set(MC_SRC_BASE
   )
 
 set(MC_SRC
+  src/mc/remote_ptr.hpp
   src/mc/AddressSpace.hpp
   src/mc/AddressSpace.cpp
   src/mc/Frame.hpp
-- 
2.20.1