1 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_S4U_COMM_HPP
7 #define SIMGRID_S4U_COMM_HPP
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Activity.hpp>
17 /** @brief Communication async
19 * Represents all asynchronous communications, that you can test or wait onto.
21 class XBT_PUBLIC Comm : public Activity {
22 Comm() : Activity() {}
24 friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c);
25 friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
26 friend simgrid::s4u::Mailbox; // Factory of comms
30 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_sender_start;
31 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_receiver_start;
32 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_completion;
34 /*! take a vector s4u::CommPtr and return when one of them is finished.
35 * The return value is the rank of the first finished CommPtr. */
36 static int wait_any(std::vector<CommPtr> * comms) { return wait_any_for(comms, -1); }
37 /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
38 static int wait_any_for(std::vector<CommPtr>* comms_in, double timeout);
40 /*! take a vector s4u::CommPtr and return when all of them is finished. */
41 static void wait_all(std::vector<CommPtr>* comms);
42 /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
43 static int test_any(std::vector<CommPtr> * comms);
45 Activity* start() override;
46 Activity* wait() override;
47 Activity* wait(double timeout) override;
49 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
51 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
52 Activity* detach(void (*clean_function)(void*))
54 clean_fun_ = clean_function;
58 /** Sets the maximal communication rate (in byte/sec). Must be done before start */
59 Activity* set_rate(double rate);
61 /** Specify the data to send */
62 Activity* set_src_data(void* buff);
63 /** Specify the size of the data to send */
64 Activity* set_src_data_size(size_t size);
65 /** Specify the data to send and its size */
66 Activity* set_src_data(void* buff, size_t size);
68 /** Specify where to receive the data */
69 Activity* set_dst_data(void** buff);
70 /** Specify the buffer in which the data should be received */
71 Activity* set_dst_data(void** buff, size_t size);
72 /** Retrieve the size of the received data */
73 size_t get_dst_data_size();
76 Activity* cancel() override;
78 /** Retrieve the mailbox on which this comm acts */
79 MailboxPtr get_mailbox();
81 /** @deprecated See Comm::set_rate() */
82 XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate) { return set_rate(rate); }
83 /** @deprecated See Comm::set_src_data() */
84 XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff)
86 return set_src_data(buff);
88 /** @deprecated See Comm::set_src_data() */
89 XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size)
91 return set_src_data(buff, size);
93 /** @deprecated See Comm::set_src_data_size() */
94 XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size)
96 return set_src_data_size(size);
98 /** @deprecated See Comm::set_dst_data() */
99 XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff)
101 return set_dst_data(buff);
103 /** @deprecated See Comm::set_dst_data() */
104 XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size)
106 return set_dst_data(buff, size);
108 /** @deprecated See Comm::get_dst_data_size() */
109 XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize()
111 return get_dst_data_size();
113 /** @deprecated See Comm::get_mailbox() */
114 XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); }
118 void* dst_buff_ = nullptr;
119 size_t dst_buff_size_ = 0;
120 void* src_buff_ = nullptr;
121 size_t src_buff_size_ = sizeof(void*);
123 /* FIXME: expose these elements in the API */
125 int (*match_fun_)(void*, void*, simgrid::kernel::activity::CommImpl*) = nullptr;
126 void (*clean_fun_)(void*) = nullptr;
127 void (*copy_data_function_)(smx_activity_t, void*, size_t) = nullptr;
129 smx_actor_t sender_ = nullptr;
130 smx_actor_t receiver_ = nullptr;
131 MailboxPtr mailbox_ = nullptr;
133 std::atomic_int_fast32_t refcount_{0};
136 } // namespace simgrid
138 #endif /* SIMGRID_S4U_COMM_HPP */