-/* Copyright (c) 2008-2014. The SimGrid Team.
+/* 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 MC_ADDRESS_SPACE_H
-#define MC_ADDRESS_SPACE_H
+#ifndef SIMGRID_MC_ADDRESS_SPACE_H
+#define SIMGRID_MC_ADDRESS_SPACE_H
+#include <cstddef>
#include <cstdint>
#include <type_traits>
#include <xbt/misc.h>
-#include <stdint.h>
-
-#include "mc_forward.h"
+#include "src/mc/mc_forward.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.
*/
const int ProcessIndexAny = 0;
+/** Options for read operations
+ *
+ * This is a set of flags managed with bitwise operators. Only the
+ * meaningful operations are defined: addition, conversions to/from
+ * integers are not allowed.
+ */
+class ReadOptions {
+ std::uint32_t value_;
+ constexpr explicit ReadOptions(std::uint32_t value) : value_(value) {}
+public:
+ constexpr ReadOptions() : value_(0) {}
+
+ constexpr operator bool() const { return value_ != 0; }
+ constexpr bool operator!() const { return value_ == 0; }
+
+ constexpr ReadOptions operator|(ReadOptions const& that) const
+ {
+ return ReadOptions(value_ | that.value_);
+ }
+ constexpr ReadOptions operator&(ReadOptions const& that) const
+ {
+ return ReadOptions(value_ & that.value_);
+ }
+ constexpr ReadOptions operator^(ReadOptions const& that) const
+ {
+ return ReadOptions(value_ ^ that.value_);
+ }
+ constexpr ReadOptions operator~() const
+ {
+ return ReadOptions(~value_);
+ }
+
+ ReadOptions& operator|=(ReadOptions const& that)
+ {
+ value_ |= that.value_;
+ return *this;
+ }
+ ReadOptions& operator&=(ReadOptions const& that)
+ {
+ value_ &= that.value_;
+ return *this;
+ }
+ ReadOptions& operator^=(ReadOptions const& that)
+ {
+ value_ &= that.value_;
+ return *this;
+ }
+
+ /** Copy the data to the given buffer */
+ static constexpr ReadOptions none() { return ReadOptions(0); }
+
+ /** Allows to return a pointer to another buffer where the data is
+ * available instead of copying the data into the buffer
+ */
+ static constexpr ReadOptions lazy() { return ReadOptions(1); }
+};
+
+/** A given state of a given process (abstract base class)
+ *
+ * Currently, this might either be:
+ *
+ * * the current state of an existing process;
+ *
+ * * a snapshot.
+ */
class AddressSpace {
+private:
+ Process* process_;
public:
- enum ReadMode {
- Normal,
- /** Allows the `read_bytes` to return a pointer to another buffer
- * where the data ins available instead of copying the data into the buffer
- */
- Lazy
- };
+ AddressSpace(Process* process) : process_(process) {}
virtual ~AddressSpace();
+
+ simgrid::mc::Process* process() const { return process_; }
+
+ /** Read data from the address space
+ *
+ * @param buffer target buffer for the data
+ * @param size number of bytes
+ * @param address remote source address of the data
+ * @param process_index which process (used for SMPI privatization)
+ * @param options
+ */
virtual const void* read_bytes(void* buffer, std::size_t size,
- std::uint64_t address, int process_index = ProcessIndexAny,
- ReadMode mode = Normal) = 0;
- template<class T>
- T read(uint64_t address, int process_index = ProcessIndexMissing)
+ remote_ptr<void> address, int process_index = ProcessIndexAny,
+ ReadOptions options = ReadOptions::none()) const = 0;
+
+ /** Read a given data structure from the address space */
+ template<class T> inline
+ void read(T *buffer, remote_ptr<T> ptr, int process_index = ProcessIndexAny)
+ {
+ this->read_bytes(buffer, sizeof(T), ptr, process_index);
+ }
+
+ /** Read a given data structure from the address space */
+ template<class T> inline
+ T read(remote_ptr<T> ptr, int process_index = ProcessIndexMissing)
{
static_assert(std::is_trivial<T>::value, "Cannot read a non-trivial type");
T res;
- return *(T*)this->read_bytes(&res, sizeof(T), address, process_index);
+ return *(T*)this->read_bytes(&res, sizeof(T), ptr, process_index);
}
};
