Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2023.
[simgrid.git] / src / kernel / activity / CommImpl.hpp
index 3ba48de..8e18d1e 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2023. 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. */
@@ -8,54 +8,76 @@
 
 #include "src/kernel/activity/ActivityImpl.hpp"
 #include "src/kernel/actor/ActorImpl.hpp"
-#include "surf/surf.hpp"
+#include "src/kernel/actor/CommObserver.hpp"
 
+namespace simgrid::kernel::activity {
 
-namespace simgrid {
-namespace kernel {
-namespace activity {
+enum class CommImplType { SEND, RECEIVE };
 
 class XBT_PUBLIC CommImpl : public ActivityImpl_T<CommImpl> {
   ~CommImpl() override;
-  void cleanupSurf();
+  void cleanup_surf();
 
-  double rate_ = 0.0;
-  double size_ = 0.0;
+  static std::function<void(CommImpl*, void*, size_t)> copy_data_callback_;
+
+  double rate_       = -1.0;
+  double size_       = 0.0;
+  bool detached_     = false;   /* If detached or not */
+  bool copied_       = false;   /* whether the data were already copied */
+  MailboxImpl* mbox_ = nullptr; /* Rendez-vous where the comm is queued. nullptr once the comm is matched with both a
+                                   sender and receiver */
+  long mbox_id_      = -1;      /* ID of the rendez-vous where the comm was first queued (for MC) */
+  s4u::Host* from_   = nullptr; /* Pre-determined only for direct host-to-host communications */
+  s4u::Host* to_     = nullptr; /* Otherwise, computed at start() time from the actors */
+  CommImplType type_ = CommImplType::SEND; /* Type of the communication (SEND or RECEIVE) */
 
 public:
-  enum class Type { SEND = 0, RECEIVE, READY, DONE };
+  CommImpl() = default;
+
+  static void set_copy_data_callback(const std::function<void(CommImpl*, void*, size_t)>& callback);
 
-  CommImpl& set_type(CommImpl::Type type);
+  CommImpl& set_type(CommImplType type);
+  CommImplType get_type() const { return type_; }
+  CommImpl& set_source(s4u::Host* from);
+  s4u::Host* get_source() const { return from_; }
+  CommImpl& set_destination(s4u::Host* to);
+  s4u::Host* get_destination() const { return to_; }
   CommImpl& set_size(double size);
-  double get_rate() { return rate_; }
+  CommImpl& set_src_buff(unsigned char* buff, size_t size);
+  CommImpl& set_dst_buff(unsigned char* buff, size_t* size);
   CommImpl& set_rate(double rate);
-  CommImpl& set_src_buff(void* buff, size_t size);
-  CommImpl& set_dst_buff(void* buff, size_t* size);
+  CommImpl& set_mailbox(MailboxImpl* mbox);
+  CommImpl& detach();
 
-  CommImpl* start();
+  double get_rate() const { return rate_; }
+  MailboxImpl* get_mailbox() const { return mbox_; }
+  long get_mailbox_id() const { return mbox_id_; }
+  bool is_detached() const { return detached_; }
+  bool is_assigned() const { return (to_ != nullptr && from_ != nullptr); }
+
+  std::vector<s4u::Link*> get_traversed_links() const;
   void copy_data();
+
+  static ActivityImplPtr isend(actor::CommIsendSimcall* observer);
+  static ActivityImplPtr irecv(actor::CommIrecvSimcall* observer);
+
+  bool test(actor::ActorImpl* issuer) override;
+  void wait_for(actor::ActorImpl* issuer, double timeout) override;
+  static void wait_any_for(actor::ActorImpl* issuer, const std::vector<CommImpl*>& comms, double timeout);
+
+  CommImpl* start();
   void suspend() override;
   void resume() override;
+  void cancel() override;
   void post() override;
+  void set_exception(actor::ActorImpl* issuer) override;
   void finish() override;
-  void cancel();
-  double remains();
-
-  CommImpl::Type type_;        /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
-  MailboxImpl* mbox = nullptr; /* Rendez-vous where the comm is queued */
-
-#if SIMGRID_HAVE_MC
-  MailboxImpl* mbox_cpy = nullptr; /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
-                                     (comm.mbox set to nullptr when the communication is removed from the mailbox
-                                     (used as garbage collector)) */
-#endif
-  bool detached_ = false; /* If detached or not */
 
-  void (*clean_fun)(void*) = nullptr; /* Function to clean the detached src_buf if something goes wrong */
-  int (*match_fun)(void*, void*, CommImpl*) = nullptr; /* Filter function used by the other side. It is used when
+  std::function<void(void*)> clean_fun; /* Function to clean the detached src_buf if something goes wrong */
+  std::function<bool(void*, void*, CommImpl*)> match_fun; /* Filter function used by the other side. It is used when
 looking if a given communication matches my needs. For that, myself must match the
 expectations of the other side, too. See  */
-  void (*copy_data_fun)(CommImpl*, void*, size_t) = nullptr;
+  std::function<void(CommImpl*, void*, size_t)> copy_data_fun;
 
   /* Surf action data */
   resource::Action* src_timeout_ = nullptr; /* Surf's actions to instrument the timeouts */
@@ -63,18 +85,17 @@ expectations of the other side, too. See  */
   actor::ActorImplPtr src_actor_ = nullptr;
   actor::ActorImplPtr dst_actor_ = nullptr;
 
-  /* Data to be transfered */
-  void* src_buff_        = nullptr;
-  void* dst_buff_        = nullptr;
-  size_t src_buff_size_  = 0;
-  size_t* dst_buff_size_ = nullptr;
-  bool copied           = false; /* whether the data were already copied */
+  /* Data to be transferred */
+  unsigned char* src_buff_ = nullptr;
+  unsigned char* dst_buff_ = nullptr;
+  size_t src_buff_size_    = 0;
+  size_t* dst_buff_size_   = nullptr;
 
   void* src_data_ = nullptr; /* User data associated to the communication */
   void* dst_data_ = nullptr;
+  static xbt::signal<void(CommImpl const&)> on_start;
+  static xbt::signal<void(CommImpl const&)> on_completion;
 };
-} // namespace activity
-} // namespace kernel
-} // namespace simgrid
+} // namespace simgrid::kernel::activity
 
 #endif