1 /* Copyright (c) 2006-2016. 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
11 #include <simgrid/forward.h>
12 #include <simgrid/s4u/Activity.hpp>
13 #include <simgrid/s4u/forward.hpp>
16 /** @brief Communication async
18 * Represents all asynchronous communications, that you can test or wait onto.
20 XBT_PUBLIC_CLASS Comm : public Activity
22 Comm() : Activity() {}
24 friend void intrusive_ptr_release(simgrid::s4u::Comm * c);
25 friend void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
29 /*! take a range of s4u::Comm* (last excluded) and return when one of them is finished. The return value is an
30 * iterator on the finished Comms. */
31 template <class I> static I wait_any(I first, I last)
33 // Map to dynar<Synchro*>:
34 xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), NULL);
35 for (I iter = first; iter != last; iter++) {
37 if (comm.state_ == inited)
39 xbt_assert(comm.state_ == started);
40 xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, comm.pimpl_);
42 // Call the underlying simcall:
43 int idx = simcall_comm_waitany(comms, -1);
44 xbt_dynar_free(&comms);
48 // Lift the index to the corresponding iterator:
49 auto res = std::next(first, idx);
50 (*res)->state_ = finished;
53 /*! Same as wait_any, but with a timeout. If wait_any_for return because of the timeout last is returned.*/
54 template <class I> static I wait_any_for(I first, I last, double timeout)
56 // Map to dynar<Synchro*>:
57 xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), NULL);
58 for (I iter = first; iter != last; iter++) {
60 if (comm.state_ == inited)
62 xbt_assert(comm.state_ == started);
63 xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, comm.pimpl_);
65 // Call the underlying simcall:
66 int idx = simcall_comm_waitany(comms, timeout);
67 xbt_dynar_free(&comms);
71 // Lift the index to the corresponding iterator:
72 auto res = std::next(first, idx);
73 (*res)->state_ = finished;
76 /** Creates (but don't start) an async send to the mailbox @p dest */
77 static CommPtr send_init(MailboxPtr dest);
78 /** Creates and start an async send to the mailbox @p dest */
79 static CommPtr send_async(MailboxPtr dest, void* data, int simulatedByteAmount);
80 /** Creates (but don't start) an async recv onto the mailbox @p from */
81 static CommPtr recv_init(MailboxPtr from);
82 /** Creates and start an async recv to the mailbox @p from */
83 static CommPtr recv_async(MailboxPtr from, void** data);
84 /** Creates and start a detached send to the mailbox @p dest
85 * TODO: make it possible to detach an already created comm */
86 static void send_detached(MailboxPtr dest, void* data, int simulatedSize);
88 void start() override;
90 void wait(double timeout) override;
92 /** Sets the maximal communication rate (in byte/sec). Must be done before start */
93 void setRate(double rate);
95 /** Specify the data to send */
96 void setSrcData(void* buff);
97 /** Specify the size of the data to send */
98 void setSrcDataSize(size_t size);
99 /** Specify the data to send and its size */
100 void setSrcData(void* buff, size_t size);
102 /** Specify where to receive the data */
103 void setDstData(void** buff);
104 /** Specify the buffer in which the data should be received */
105 void setDstData(void** buff, size_t size);
106 /** Retrieve the size of the received data */
107 size_t getDstDataSize();
114 void* dstBuff_ = nullptr;
115 size_t dstBuffSize_ = 0;
116 void* srcBuff_ = nullptr;
117 size_t srcBuffSize_ = sizeof(void*);
119 /* FIXME: expose these elements in the API */
121 int (*matchFunction_)(void*, void*, smx_activity_t) = nullptr;
122 void (*cleanFunction_)(void*) = nullptr;
123 void (*copyDataFunction_)(smx_activity_t, void*, size_t) = nullptr;
125 smx_actor_t sender_ = nullptr;
126 smx_actor_t receiver_ = nullptr;
127 MailboxPtr mailbox_ = nullptr;
129 std::atomic_int_fast32_t refcount_{0};
132 } // namespace simgrid::s4u
134 #endif /* SIMGRID_S4U_COMM_HPP */