* Represents all asynchronous communications, that you can test or wait onto.
*/
class XBT_PUBLIC Comm : public Activity_T<Comm> {
+ friend Mailbox; // Factory of comms
+ /* specified for normal mailbox-based communications*/
Mailbox* mailbox_ = nullptr;
- kernel::actor::ActorImpl* sender_ = nullptr; /* specified for normal mailbox-based communications*/
+ kernel::actor::ActorImpl* sender_ = nullptr;
kernel::actor::ActorImpl* receiver_ = nullptr;
- Host* from_ = nullptr; /* specified only for direct host-to-host communications */
- Host* to_ = 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*);
+
+ /* specified only for direct host-to-host communications */
+ Host* from_ = nullptr;
+ Host* to_ = nullptr;
+
/* FIXME: expose these elements in the API */
bool detached_ = false;
bool (*match_fun_)(void*, void*, kernel::activity::CommImpl*) = nullptr;
Comm() = default;
public:
-#ifndef DOXYGEN
- friend Mailbox; // Factory of comms
-#endif
-
- ~Comm() override;
-
- /*! Creates a communication that bypasses the mailbox mechanism. */
- static CommPtr sendto_init();
- /*! Creates a communication beween the two given hosts, bypassing the mailbox mechanism. */
- static CommPtr sendto_init(Host* from, Host* to);
- /** Do an asynchronous communication between two arbitrary hosts.
- *
- * This initializes a communication that completely bypass the mailbox and actors mechanism.
- * There is really no limit on the hosts involved. In particular, the actor does not have to be on one of the involved
- * hosts.
- */
- static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes);
- /** Do a blocking communication between two arbitrary hosts.
- *
- * This starts a blocking communication right away, bypassing the mailbox and actors mechanism.
- * The calling actor is blocked until the end of the communication; there is really no limit on the hosts involved.
- * In particular, the actor does not have to be on one of the involved hosts. Enjoy the comfort of the simulator :)
- */
- static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes);
-
- static void on_send_cb(const std::function<void(Comm const&)>& cb) { on_send.connect(cb); }
- static void on_recv_cb(const std::function<void(Comm const&)>& cb) { on_recv.connect(cb); }
- static void on_start_cb(const std::function<void(Comm const&)>& cb) { on_start.connect(cb); }
- static void on_completion_cb(const std::function<void(Activity const&)>& cb) { on_completion.connect(cb); }
+ /* signals and related callbacks */
#ifndef DOXYGEN
/* FIXME signals should be private */
static xbt::signal<void(Comm const&)> on_send;
static xbt::signal<void(Comm const&)> on_completion;
#endif
- /*! take a vector s4u::CommPtr and return when one of them is finished.
- * The return value is the rank of the first finished CommPtr. */
- static ssize_t wait_any(const std::vector<CommPtr>& comms) { return wait_any_for(comms, -1); }
- /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
- static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout);
-
- /*! take a vector s4u::CommPtr and return when all of them is finished. */
- static void wait_all(const std::vector<CommPtr>& comms);
- /*! Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if the timeout
- * occurs). */
- static size_t wait_all_for(const std::vector<CommPtr>& comms, double timeout);
- /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
- static ssize_t test_any(const std::vector<CommPtr>& comms);
-
-#ifndef DOXYGEN
- XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
- static int wait_any(const std::vector<CommPtr>* comms) { return static_cast<int>(wait_any_for(*comms, -1)); }
- XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter")
- static int wait_any_for(const std::vector<CommPtr>* comms, double timeout) { return static_cast<int>(wait_any_for(*comms, timeout)); }
- XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
- static void wait_all(const std::vector<CommPtr>* comms) { wait_all(*comms); }
- XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter")
- static int test_any(const std::vector<CommPtr>* comms) { return static_cast<int>(test_any(*comms)); }
-#endif
+ static void on_send_cb(const std::function<void(Comm const&)>& cb) { on_send.connect(cb); }
+ static void on_recv_cb(const std::function<void(Comm const&)>& cb) { on_recv.connect(cb); }
+ static void on_start_cb(const std::function<void(Comm const&)>& cb) { on_start.connect(cb); }
+ static void on_completion_cb(const std::function<void(Activity const&)>& cb) { on_completion.connect(cb); }
+ /* More callbacks */
+ CommPtr set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t));
+ static void copy_buffer_callback(kernel::activity::CommImpl*, void*, size_t);
+ static void copy_pointer_callback(kernel::activity::CommImpl*, void*, size_t);
- Comm* start() override;
- Comm* wait_for(double timeout) override;
+ ~Comm() override;
- /** Start the comm, and ignore its result. It can be completely forgotten after that. */
- Comm* detach();
- /** Start the comm, and ignore its result. It can be completely forgotten after that. */
- Comm* detach(void (*clean_function)(void*))
- {
- clean_fun_ = clean_function;
- return detach();
- }
+ /* "One-sided" communications. This way of communicating bypasses the mailbox and actors mechanism. It creates a
+ * communication (vetoabled, asynchronous, or synchronous) directly between two hosts. There is really no limit on
+ * the hosts involved. In particular, the actor creating such a communication does not have to be on one of the
+ * involved hosts! Enjoy the comfort of the simulator :)
+ */
+ static CommPtr sendto_init(); /* Source and Destination hosts have to be set before the communication can start */
+ static CommPtr sendto_init(Host* from, Host* to);
+ static CommPtr sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes);
+ static void sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes);
- /** Set the source and destination of communications that bypass the mailbox mechanism */
CommPtr set_source(Host* from);
Host* get_source() const { return from_; }
CommPtr set_destination(Host* to);
Host* get_destination() const { return to_; }
- /** Sets the maximal communication rate (in byte/sec). Must be done before start */
- CommPtr set_rate(double rate);
+ /* Mailbox-based communications */
+ CommPtr set_mailbox(Mailbox* mailbox);
+ /** Retrieve the mailbox on which this comm acts */
+ Mailbox* get_mailbox() const { return mailbox_; }
/** Specify the data to send.
*
* @endrst
*/
CommPtr set_src_data_size(size_t size);
-
- /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
- *
- * @beginrst
- * That's the size of the simulated data, that's completely related from the actual data size (given by
- * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
- * @endrst
- */
- CommPtr set_payload_size(uint64_t bytes);
-
/** Specify the data to send and its size (not to be mixed with set_payload_size())
*
* @beginrst
* That's a buffer where the sent data will be copied */
CommPtr set_dst_data(void** buff, size_t size);
/** Retrieve where the data will be copied on the receiver side */
- void* get_dst_data();
-
- /** Retrieve the mailbox on which this comm acts */
- Mailbox* get_mailbox() const;
+ void* get_dst_data() { return dst_buff_; }
/** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */
- size_t get_dst_data_size() const;
+ size_t get_dst_data_size() const { return dst_buff_size_; }
- Actor* get_sender() const;
+ /* Common functions */
+
+ /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
+ *
+ * @beginrst
+ * That's the size of the simulated data, that's completely unrelated from the actual data size (given by
+ * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
+ * @endrst
+ */
+ CommPtr set_payload_size(uint64_t bytes);
+ /** Sets the maximal communication rate (in byte/sec). Must be done before start */
+ CommPtr set_rate(double rate);
bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); }
+ Actor* get_sender() const;
- CommPtr set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t));
- static void copy_buffer_callback(kernel::activity::CommImpl*, void*, size_t);
- static void copy_pointer_callback(kernel::activity::CommImpl*, void*, size_t);
+ /* Comm life cycle */
+ Comm* start() override;
+ /** Start the comm, and ignore its result. It can be completely forgotten after that. */
+ Comm* detach();
+ /** Start the comm, and ignore its result. It can be completely forgotten after that. */
+ Comm* detach(void (*clean_function)(void*))
+ {
+ clean_fun_ = clean_function;
+ return detach();
+ }
+
+ Comm* wait_for(double timeout) override;
+
+ /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
+ static ssize_t test_any(const std::vector<CommPtr>& comms);
+
+ /*! take a vector s4u::CommPtr and return when one of them is finished.
+ * The return value is the rank of the first finished CommPtr. */
+ static ssize_t wait_any(const std::vector<CommPtr>& comms) { return wait_any_for(comms, -1); }
+ /*! Same as wait_any, but with a timeout. Return -1 if the timeout occurs.*/
+ static ssize_t wait_any_for(const std::vector<CommPtr>& comms, double timeout);
+
+ /*! take a vector s4u::CommPtr and return when all of them is finished. */
+ static void wait_all(const std::vector<CommPtr>& comms);
+ /*! Same as wait_all, but with a timeout. Return the number of terminated comm (less than comms.size() if the timeout
+ * occurs). */
+ static size_t wait_all_for(const std::vector<CommPtr>& comms, double timeout);
+
+#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static int wait_any(
+ const std::vector<CommPtr>* comms)
+ {
+ return static_cast<int>(wait_any_for(*comms, -1));
+ }
+ XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for first parameter") static int wait_any_for(
+ const std::vector<CommPtr>* comms, double timeout)
+ {
+ return static_cast<int>(wait_any_for(*comms, timeout));
+ }
+ XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static void wait_all(
+ const std::vector<CommPtr>* comms)
+ {
+ wait_all(*comms);
+ }
+ XBT_ATTRIB_DEPRECATED_v332("Please use a plain vector for parameter") static int test_any(
+ const std::vector<CommPtr>* comms)
+ {
+ return static_cast<int>(test_any(*comms));
+ }
+#endif
};
} // namespace s4u
} // namespace simgrid
xbt::signal<void(Comm const&)> Comm::on_recv;
xbt::signal<void(Comm const&)> Comm::on_completion;
+CommPtr Comm::set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
+{
+ copy_data_function_ = callback;
+ return this;
+}
+
+void Comm::copy_buffer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
+{
+ XBT_DEBUG("Copy the data over");
+ memcpy(comm->dst_buff_, buff, buff_size);
+ if (comm->detached()) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the
+ // original buffer available to the application ASAP
+ xbt_free(buff);
+ comm->src_buff_ = nullptr;
+ }
+}
+
+void Comm::copy_pointer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
+{
+ xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
+ *(void**)(comm->dst_buff_) = buff;
+}
+
Comm::~Comm()
{
if (state_ == State::STARTED && not detached_ &&
}
}
-ssize_t Comm::wait_any_for(const std::vector<CommPtr>& comms, double timeout)
+CommPtr Comm::sendto_init()
{
- std::vector<ActivityPtr> activities;
- for (const auto& comm : comms)
- activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
- ssize_t changed_pos;
- try {
- changed_pos = Activity::wait_any_for(activities, timeout);
- } catch (const NetworkFailureException& e) {
- changed_pos = -1;
- for (auto c : comms) {
- if (c->pimpl_->get_state() == kernel::activity::State::FAILED) {
- c->complete(State::FAILED);
- }
- }
- e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
- }
- return changed_pos;
+ CommPtr res(new Comm());
+ res->sender_ = kernel::actor::ActorImpl::self();
+ return res;
}
-void Comm::wait_all(const std::vector<CommPtr>& comms)
+CommPtr Comm::sendto_init(Host* from, Host* to)
{
- // TODO: this should be a simcall or something
- for (auto& comm : comms)
- comm->wait();
+ auto res = Comm::sendto_init();
+ res->from_ = from;
+ res->to_ = to;
+
+ return res;
}
-size_t Comm::wait_all_for(const std::vector<CommPtr>& comms, double timeout)
+CommPtr Comm::sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes)
{
- if (timeout < 0.0) {
- wait_all(comms);
- return comms.size();
- }
+ auto res = Comm::sendto_init(from, to)->set_payload_size(simulated_size_in_bytes);
+ res->vetoable_start();
+ return res;
+}
- double deadline = Engine::get_clock() + timeout;
- std::vector<CommPtr> waited_comm(1, nullptr);
- for (size_t i = 0; i < comms.size(); i++) {
- double wait_timeout = std::max(0.0, deadline - Engine::get_clock());
- waited_comm[0] = comms[i];
- // Using wait_any_for() here (and not wait_for) because we don't want comms to be invalidated on timeout
- if (wait_any_for(waited_comm, wait_timeout) == -1) {
- XBT_DEBUG("Timeout (%g): i = %zu", wait_timeout, i);
- return i;
- }
- }
- return comms.size();
+void Comm::sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes)
+{
+ sendto_async(from, to, simulated_size_in_bytes)->wait();
}
CommPtr Comm::set_source(Host* from)
return this;
}
+CommPtr Comm::set_mailbox(Mailbox* mailbox)
+{
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
+ __FUNCTION__);
+ mailbox_ = mailbox;
+ return this;
+}
+
CommPtr Comm::set_src_data(void* buff)
{
xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication started (not implemented)",
dst_buff_ = buff;
return this;
}
-void* Comm::get_dst_data()
-{
- return dst_buff_;
-}
-size_t Comm::get_dst_data_size() const
-{
- return dst_buff_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)",
dst_buff_size_ = size;
return this;
}
+
CommPtr Comm::set_payload_size(uint64_t bytes)
{
Activity::set_remaining(bytes);
return this;
}
-CommPtr Comm::sendto_init()
-{
- CommPtr res(new Comm());
- res->sender_ = kernel::actor::ActorImpl::self();
- return res;
-}
-
-CommPtr Comm::sendto_init(Host* from, Host* to)
-{
- auto res = Comm::sendto_init();
- res->from_ = from;
- res->to_ = to;
-
- return res;
-}
-
-CommPtr Comm::sendto_async(Host* from, Host* to, uint64_t simulated_size_in_bytes)
-{
- auto res = Comm::sendto_init(from, to)->set_payload_size(simulated_size_in_bytes);
- res->vetoable_start();
- return res;
-}
-
-void Comm::sendto(Host* from, Host* to, uint64_t simulated_size_in_bytes)
+Actor* Comm::get_sender() const
{
- sendto_async(from, to, simulated_size_in_bytes)->wait();
+ kernel::actor::ActorImplPtr sender = nullptr;
+ if (pimpl_)
+ sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
+ return sender ? sender->get_ciface() : nullptr;
}
Comm* Comm::start()
return this;
}
+Comm* Comm::detach()
+{
+ xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication is %s (not implemented)",
+ __FUNCTION__, get_state_str());
+ xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
+ detached_ = true;
+ vetoable_start();
+ return this;
+}
+
+ssize_t Comm::test_any(const std::vector<CommPtr>& comms)
+{
+ std::vector<ActivityPtr> activities;
+ for (const auto& comm : comms)
+ activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
+ return Activity::test_any(activities);
+}
+
/** @brief Block the calling actor until the communication is finished, or until timeout
*
* On timeout, an exception is thrown and the communication is invalidated.
complete(State::FINISHED);
return this;
}
-
-ssize_t Comm::test_any(const std::vector<CommPtr>& comms)
+ssize_t Comm::wait_any_for(const std::vector<CommPtr>& comms, double timeout)
{
std::vector<ActivityPtr> activities;
for (const auto& comm : comms)
activities.push_back(boost::dynamic_pointer_cast<Activity>(comm));
- return Activity::test_any(activities);
-}
-
-Comm* Comm::detach()
-{
- xbt_assert(state_ == State::INITED, "You cannot use %s() once your communication is %s (not implemented)",
- __FUNCTION__, get_state_str());
- xbt_assert(dst_buff_ == nullptr && dst_buff_size_ == 0, "You can only detach sends, not recvs");
- detached_ = true;
- vetoable_start();
- return this;
-}
-
-Mailbox* Comm::get_mailbox() const
-{
- return mailbox_;
+ ssize_t changed_pos;
+ try {
+ changed_pos = Activity::wait_any_for(activities, timeout);
+ } catch (const NetworkFailureException& e) {
+ changed_pos = -1;
+ for (auto c : comms) {
+ if (c->pimpl_->get_state() == kernel::activity::State::FAILED) {
+ c->complete(State::FAILED);
+ }
+ }
+ e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
+ }
+ return changed_pos;
}
-Actor* Comm::get_sender() const
+void Comm::wait_all(const std::vector<CommPtr>& comms)
{
- kernel::actor::ActorImplPtr sender = nullptr;
- if (pimpl_)
- sender = boost::static_pointer_cast<kernel::activity::CommImpl>(pimpl_)->src_actor_;
- return sender ? sender->get_ciface() : nullptr;
+ // TODO: this should be a simcall or something
+ for (auto& comm : comms)
+ comm->wait();
}
-CommPtr Comm::set_copy_data_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
-{
- copy_data_function_ = callback;
- return this;
-}
-void Comm::copy_buffer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
+size_t Comm::wait_all_for(const std::vector<CommPtr>& comms, double timeout)
{
- XBT_DEBUG("Copy the data over");
- memcpy(comm->dst_buff_, buff, buff_size);
- if (comm->detached()) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the
- // original buffer available to the application ASAP
- xbt_free(buff);
- comm->src_buff_ = nullptr;
+ if (timeout < 0.0) {
+ wait_all(comms);
+ return comms.size();
}
-}
-void Comm::copy_pointer_callback(kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
-{
- xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
- *(void**)(comm->dst_buff_) = buff;
+ double deadline = Engine::get_clock() + timeout;
+ std::vector<CommPtr> waited_comm(1, nullptr);
+ for (size_t i = 0; i < comms.size(); i++) {
+ double wait_timeout = std::max(0.0, deadline - Engine::get_clock());
+ waited_comm[0] = comms[i];
+ // Using wait_any_for() here (and not wait_for) because we don't want comms to be invalidated on timeout
+ if (wait_any_for(waited_comm, wait_timeout) == -1) {
+ XBT_DEBUG("Timeout (%g): i = %zu", wait_timeout, i);
+ return i;
+ }
+ }
+ return comms.size();
}
-
} // namespace s4u
} // namespace simgrid
/* **************************** Public C interface *************************** */
