Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleanups and uniformization in Activity headers
authorFrederic Suter <frederic.suter@cc.in2p3.fr>
Wed, 20 Feb 2019 14:02:02 +0000 (15:02 +0100)
committerFrederic Suter <frederic.suter@cc.in2p3.fr>
Wed, 20 Feb 2019 14:05:18 +0000 (15:05 +0100)
include/simgrid/s4u/Activity.hpp
include/simgrid/s4u/Comm.hpp
include/simgrid/s4u/Exec.hpp
include/simgrid/s4u/Io.hpp
src/s4u/s4u_Comm.cpp

index d8b4a68..0ae0cbb 100644 (file)
@@ -55,8 +55,6 @@ public:
    * This function is optional: you can call wait() even if you didn't call start()
    */
   virtual Activity* start() = 0;
-  /** Tests whether the given activity is terminated yet. This is a pure function. */
-  //virtual bool test()=0;
   /** Blocks until the activity is terminated */
   virtual Activity* wait() = 0;
   /** Blocks until the activity is terminated, or until the timeout is elapsed
@@ -70,7 +68,7 @@ public:
   virtual Activity* cancel() = 0;
   /** Retrieve the current state of the activity */
   Activity::State get_state() { return state_; }
-  /** Returns whether this activity is completed */
+  /** Tests whether the given activity is terminated yet. This is a pure function. */
   virtual bool test() = 0;
 
   /** Get the remaining amount of work that this Activity entails. When it's 0, it's done. */
@@ -90,7 +88,7 @@ public:
   /** Retrieve the user data of the Activity */
   void* get_user_data() { return user_data_; }
 
-  simgrid::kernel::activity::ActivityImplPtr get_impl() { return pimpl_; }
+  kernel::activity::ActivityImplPtr get_impl() { return pimpl_; }
 
 #ifndef DOXYGEN
   XBT_ATTRIB_DEPRECATED_v324("Please use Activity::wait_for()") virtual void wait(double timeout) = 0;
@@ -108,12 +106,13 @@ public:
 #endif
 
 private:
-  simgrid::kernel::activity::ActivityImplPtr pimpl_ = nullptr;
-  Activity::State state_                            = Activity::State::INITED;
-  double remains_                                   = 0;
-  void* user_data_                                  = nullptr;
-}; // class
-
-}}; // Namespace simgrid::s4u
+  kernel::activity::ActivityImplPtr pimpl_ = nullptr;
+  Activity::State state_                   = Activity::State::INITED;
+  double remains_                          = 0;
+  void* user_data_                         = nullptr;
+};
+
+} // namespace s4u
+} // namespace simgrid
 
 #endif /* SIMGRID_S4U_ACTIVITY_HPP */
index 7a540a9..91f2ab2 100644 (file)
@@ -19,7 +19,24 @@ namespace s4u {
  * Represents all asynchronous communications, that you can test or wait onto.
  */
 class XBT_PUBLIC Comm : public Activity {
+  MailboxPtr mailbox_                 = nullptr;
+  kernel::actor::ActorImpl* sender_   = nullptr;
+  kernel::actor::ActorImpl* receiver_ = nullptr;
+  double rate_                        = -1;
+  void* dst_buff_                     = nullptr;
+  size_t dst_buff_size_               = 0;
+  void* src_buff_                     = nullptr;
+  size_t src_buff_size_               = sizeof(void*);
+  std::atomic_int_fast32_t refcount_{0};
+
+  /* FIXME: expose these elements in the API */
+  int detached_                                                           = 0;
+  int (*match_fun_)(void*, void*, kernel::activity::CommImpl*)            = nullptr;
+  void (*clean_fun_)(void*)                                               = nullptr;
+  void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr;
+
   Comm() : Activity() {}
+
 public:
   friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
@@ -27,9 +44,9 @@ public:
 
   virtual ~Comm();
 
-  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_sender_start;
-  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_receiver_start;
-  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_completion;
+  static xbt::signal<void(ActorPtr)> on_sender_start;
+  static xbt::signal<void(ActorPtr)> on_receiver_start;
+  static xbt::signal<void(ActorPtr)> on_completion;
 
   /*! take a vector s4u::CommPtr and return when one of them is finished.
    * The return value is the rank of the first finished CommPtr. */
@@ -45,6 +62,7 @@ public:
   Comm* start() override;
   Comm* wait() override;
   Comm* wait_for(double timeout) override;
+  Comm* cancel() override;
   bool test() override;
 
   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
@@ -57,7 +75,7 @@ public:
   }
 
   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
-  Comm* set_rate(double rate);
+  CommPtr set_rate(double rate);
 
   /** Specify the data to send.
    *
@@ -66,7 +84,7 @@ public:
    * you can send a short buffer in your simulator, that represents a very large message
    * in the simulated world, or the opposite.
    */
-  Comm* set_src_data(void* buff);
+  CommPtr set_src_data(void* buff);
   /** Specify the size of the data to send. Not to be mixed with @ref Activity::set_remaining()
    *
    * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()).
@@ -74,7 +92,7 @@ public:
    * you can send a short buffer in your simulator, that represents a very large message
    * in the simulated world, or the opposite.
    */
-  Comm* set_src_data_size(size_t size);
+  CommPtr set_src_data_size(size_t size);
   /** Specify the data to send and its size. Don't mix the size with @ref Activity::set_remaining()
    *
    * This is way will get actually copied over to the receiver.
@@ -82,46 +100,47 @@ public:
    * you can send a short buffer in your simulator, that represents a very large message
    * in the simulated world, or the opposite.
    */
-  Comm* set_src_data(void* buff, size_t size);
+  CommPtr set_src_data(void* buff, size_t size);
 
   /** Specify where to receive the data.
    *
    * That's a buffer where the sent data will be copied */
-  Comm* set_dst_data(void** buff);
+  CommPtr set_dst_data(void** buff);
   /** Specify the buffer in which the data should be received
    *
    * That's a buffer where the sent data will be copied  */
-  Comm* set_dst_data(void** buff, size_t size);
-  /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
-  size_t get_dst_data_size();
-
-  Comm* cancel() override;
+  CommPtr set_dst_data(void** buff, size_t size);
 
   /** Retrieve the mailbox on which this comm acts */
   MailboxPtr get_mailbox();
+  /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
+  size_t get_dst_data_size();
 
 #ifndef DOXYGEN
   XBT_ATTRIB_DEPRECATED_v324("Please use Comm::wait_for()") void wait(double t) override { wait_for(t); }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate) { return set_rate(rate); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate)
+  {
+    return set_rate(rate).get();
+  }
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff)
   {
-    return set_src_data(buff);
+    return set_src_data(buff).get();
   }
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size)
   {
-    return set_src_data(buff, size);
+    return set_src_data(buff, size).get();
   }
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size)
   {
-    return set_src_data_size(size);
+    return set_src_data_size(size).get();
   }
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff)
   {
-    return set_dst_data(buff);
+    return set_dst_data(buff).get();
   }
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size)
   {
-    return set_dst_data(buff, size);
+    return set_dst_data(buff, size).get();
   }
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize()
   {
@@ -129,25 +148,6 @@ public:
   }
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); }
 #endif
-
-private:
-  double rate_        = -1;
-  void* dst_buff_       = nullptr;
-  size_t dst_buff_size_ = 0;
-  void* src_buff_       = nullptr;
-  size_t src_buff_size_ = sizeof(void*);
-
-  /* FIXME: expose these elements in the API */
-  int detached_ = 0;
-  int (*match_fun_)(void*, void*, simgrid::kernel::activity::CommImpl*) = nullptr;
-  void (*clean_fun_)(void*)                                             = nullptr;
-  void (*copy_data_function_)(simgrid::kernel::activity::CommImpl*, void*, size_t) = nullptr;
-
-  smx_actor_t sender_   = nullptr;
-  smx_actor_t receiver_ = nullptr;
-  MailboxPtr mailbox_   = nullptr;
-
-  std::atomic_int_fast32_t refcount_{0};
 };
 } // namespace s4u
 } // namespace simgrid
index 0fdf8e3..3be13fc 100644 (file)
@@ -16,22 +16,30 @@ namespace s4u {
 
 /** Computation Activity, representing the asynchronous executions.
  *
- * They are generated from simgrid::s4u::this_actor::exec_init() or simgrid::s4u::Host::execute(),
- * and can be used to model pools of threads or similar mechanisms.
+ * They are generated from this_actor::exec_init() or Host::execute(), and can be used to model pools of threads or
+ * similar mechanisms.
  */
 
 class XBT_PUBLIC Exec : public Activity {
+  Host* host_                   = nullptr;
+  double flops_amount_          = 0.0;
+  double priority_              = 1.0;
+  double bound_                 = 0.0;
+  std::string name_             = "";
+  std::string tracing_category_ = "";
+  std::atomic_int_fast32_t refcount_{0};
+
   explicit Exec(sg_host_t host, double flops_amount);
 
 public:
-  friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Exec * e);
-  friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Exec * e);
+  friend XBT_PUBLIC void intrusive_ptr_release(Exec* e);
+  friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
   friend XBT_PUBLIC ExecPtr this_actor::exec_init(double flops_amount);
 
   ~Exec() = default;
 
-  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_start;
-  static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_completion;
+  static xbt::signal<void(ActorPtr)> on_start;
+  static xbt::signal<void(ActorPtr)> on_completion;
 
   Exec* start() override;
   Exec* wait() override;
@@ -64,17 +72,8 @@ public:
     return get_remaining_ratio();
   }
 #endif
-
-private:
-  Host* host_                   = nullptr;
-  double flops_amount_          = 0.0;
-  double priority_              = 1.0;
-  double bound_                 = 0.0;
-  std::string name_             = "";
-  std::string tracing_category_ = "";
-  std::atomic_int_fast32_t refcount_{0};
-}; // class
-}
-}; // Namespace simgrid::s4u
+};
+} // namespace s4u
+} // namespace simgrid
 
 #endif /* SIMGRID_S4U_EXEC_HPP */
index 4fb6b9f..2b82161 100644 (file)
 #include <simgrid/s4u/Activity.hpp>
 
 #include <atomic>
-#include <string>
 
 namespace simgrid {
 namespace s4u {
 
 /** I/O Activity, representing the asynchronous disk access.
  *
- * They are generated from simgrid::s4u::Storage::read() and simgrid::s4u::Storage::write().
+ * They are generated from Storage::io_init() or Storage::read() and Storage::write().
  */
 
 class XBT_PUBLIC Io : public Activity {
 public:
-  friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Io* i);
-  friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Io* i);
-  friend simgrid::s4u::Storage; // Factory of IOs
   enum class OpType { READ, WRITE };
 
 private:
+  Storage* storage_ = nullptr;
+  sg_size_t size_   = 0;
+  OpType type_      = OpType::READ;
+  std::string name_ = "";
+  std::atomic_int_fast32_t refcount_{0};
+
   explicit Io(sg_storage_t storage, sg_size_t size, OpType type);
 
 public:
+  friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Io* i);
+  friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Io* i);
+  friend simgrid::s4u::Storage; // Factory of IOs
+
   ~Io() = default;
 
   Io* start() override;
@@ -47,13 +53,8 @@ public:
 #endif
 
 private:
-  sg_storage_t storage_ = nullptr;
-  sg_size_t size_       = 0;
-  OpType type_          = OpType::READ;
-  std::string name_     = "";
-  std::atomic_int_fast32_t refcount_{0};
 }; // class
-}
-}; // Namespace simgrid::s4u
+} // namespace s4u
+} // namespace simgrid
 
 #endif /* SIMGRID_S4U_IO_HPP */
index 7d3a926..50eaf00 100644 (file)
@@ -47,7 +47,7 @@ void Comm::wait_all(std::vector<CommPtr>* comms)
     comm->wait();
 }
 
-Comm* Comm::set_rate(double rate)
+CommPtr Comm::set_rate(double rate)
 {
   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
              __FUNCTION__);
@@ -55,7 +55,7 @@ Comm* Comm::set_rate(double rate)
   return this;
 }
 
-Comm* Comm::set_src_data(void* buff)
+CommPtr Comm::set_src_data(void* buff)
 {
   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
              __FUNCTION__);
@@ -63,14 +63,16 @@ Comm* Comm::set_src_data(void* buff)
   src_buff_ = buff;
   return this;
 }
-Comm* Comm::set_src_data_size(size_t size)
+
+CommPtr Comm::set_src_data_size(size_t size)
 {
   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
              __FUNCTION__);
   src_buff_size_ = size;
   return this;
 }
-Comm* Comm::set_src_data(void* buff, size_t size)
+
+CommPtr Comm::set_src_data(void* buff, size_t size)
 {
   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
              __FUNCTION__);
@@ -80,7 +82,7 @@ Comm* Comm::set_src_data(void* buff, size_t size)
   src_buff_size_ = size;
   return this;
 }
-Comm* Comm::set_dst_data(void** buff)
+CommPtr Comm::set_dst_data(void** buff)
 {
   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
              __FUNCTION__);
@@ -88,12 +90,13 @@ Comm* Comm::set_dst_data(void** buff)
   dst_buff_ = buff;
   return this;
 }
+
 size_t Comm::get_dst_data_size()
 {
   xbt_assert(state_ == State::FINISHED, "You cannot use %s before your communication terminated", __FUNCTION__);
   return dst_buff_size_;
 }
-Comm* Comm::set_dst_data(void** buff, size_t size)
+CommPtr Comm::set_dst_data(void** buff, size_t size)
 {
   xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
              __FUNCTION__);