-/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2021. 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. */
#include <simgrid/forward.h>
#include <simgrid/s4u/Activity.hpp>
-#include <atomic>
+#include <string>
#include <vector>
namespace simgrid {
*
* Represents all asynchronous communications, that you can test or wait onto.
*/
-class XBT_PUBLIC Comm : public Activity {
- Comm() : Activity() {}
+class XBT_PUBLIC Comm : public Activity_T<Comm> {
+ Mailbox* mailbox_ = nullptr;
+ kernel::actor::ActorImpl* sender_ = nullptr; /* specified for normal mailbox-based communications*/
+ 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*);
+ /* FIXME: expose these elements in the API */
+ bool detached_ = false;
+ bool (*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() = default;
+
+protected:
+ void complete(Activity::State state) override;
+
public:
- friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c);
- friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
- friend simgrid::s4u::Mailbox; // Factory of comms
+#ifndef DOXYGEN
+ friend Mailbox; // Factory of comms
+#endif
+
+ ~Comm() override;
- virtual ~Comm();
+ /*! 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, double 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, double simulated_size_in_bytes);
- 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(Comm const&, bool is_sender)> on_start;
+ static xbt::signal<void(Comm const&)> 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. */
- static int wait_any(std::vector<CommPtr> * comms) { return wait_any_for(comms, -1); }
- /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
- static int wait_any_for(std::vector<CommPtr>* comms_in, double timeout);
+ 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(std::vector<CommPtr>* comms);
+ 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 int test_any(std::vector<CommPtr> * comms);
+ static ssize_t test_any(const std::vector<CommPtr>& comms);
+
+ 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)); }
Comm* start() override;
- Comm* wait() override;
Comm* wait_for(double timeout) override;
bool test() override;
}
/** 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.
*
+ * @beginrst
* This is way will get actually copied over to the receiver.
- * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
+ * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
* you can send a short buffer in your simulator, that represents a very large message
* in the simulated world, or the opposite.
+ * @endrst
*/
- Comm* set_src_data(void* buff);
- /** Specify the size of the data to send. Not to be mixed with @ref Activity::set_remaining()
+ CommPtr set_src_data(void* buff);
+ /** Specify the size of the data to send (not to be mixed with set_payload_size())
*
- * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()).
- * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
- * you can send a short buffer in your simulator, that represents a very large message
- * in the simulated world, or the opposite.
+ * @beginrst
+ * That's the size of the data to actually copy in the simulator (ie, the data passed with
+ * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
+ * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
+ * a very large message in the simulated world, or the opposite.
+ * @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
*/
- Comm* 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()
+ CommPtr set_payload_size(double bytes);
+
+ /** Specify the data to send and its size (not to be mixed with set_payload_size())
*
+ * @beginrst
* This is way will get actually copied over to the receiver.
- * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
+ * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
* you can send a short buffer in your simulator, that represents a very large message
* in the simulated world, or the opposite.
+ * @endrst
*/
- 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 where the data will be copied on the receiver side */
+ void* get_dst_data();
/** Retrieve the mailbox on which this comm acts */
- MailboxPtr get_mailbox();
-
-#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_src_data()") Activity* setSrcData(void* buff)
- {
- return set_src_data(buff);
- }
- XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size)
- {
- return set_src_data(buff, size);
- }
- XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size)
- {
- return set_src_data_size(size);
- }
- XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff)
- {
- return set_dst_data(buff);
- }
- XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size)
- {
- return set_dst_data(buff, size);
- }
- XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize()
- {
- return get_dst_data_size();
- }
- 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;
+ Mailbox* get_mailbox() const;
+ /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */
+ size_t get_dst_data_size() const;
- smx_actor_t sender_ = nullptr;
- smx_actor_t receiver_ = nullptr;
- MailboxPtr mailbox_ = nullptr;
+ Actor* get_sender() const;
- std::atomic_int_fast32_t refcount_{0};
+ bool is_assigned() const override { return (to_ != nullptr && from_ != nullptr) || (mailbox_ != nullptr); }
};
} // namespace s4u
} // namespace simgrid
