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/s4u/Activity.hpp>
12 #include <simgrid/s4u/forward.hpp>
13 #include <simgrid/s4u/mailbox.hpp>
14 #include <simgrid/forward.h>
21 /** @brief Communication async
23 * Represents all asynchronous communications, that you can test or wait onto.
25 XBT_PUBLIC_CLASS Comm : public Activity {
26 Comm() : Activity() {}
32 /*! take a range of s4u::Comm* (last excluded) and return when one of them is finished. The return value is an iterator on the finished Comms. */
33 template<class I> static
34 I wait_any(I first, I last)
36 // Map to dynar<Synchro*>:
37 xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::Synchro*), NULL);
38 for(I iter = first; iter != last; iter++) {
40 if (comm.state_ == inited)
42 xbt_assert(comm.state_ == started);
43 xbt_dynar_push_as(comms, simgrid::kernel::activity::Synchro*, comm.pimpl_);
45 // Call the underlying simcall:
46 int idx = simcall_comm_waitany(comms, -1);
47 xbt_dynar_free(&comms);
51 // Lift the index to the corresponding iterator:
52 auto res = std::next(first, idx);
53 (*res)->state_ = finished;
56 /*! Same as wait_any, but with a timeout. If wait_any_for return because of the timeout last is returned.*/
57 template<class I> static
58 I wait_any_for(I first, I last, double timeout)
60 // Map to dynar<Synchro*>:
61 xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::Synchro*), NULL);
62 for(I iter = first; iter != last; iter++) {
64 if (comm.state_ == inited)
66 xbt_assert(comm.state_ == started);
67 xbt_dynar_push_as(comms, simgrid::kernel::activity::Synchro*, comm.pimpl_);
69 // Call the underlying simcall:
70 int idx = simcall_comm_waitany(comms, timeout);
71 xbt_dynar_free(&comms);
75 // Lift the index to the corresponding iterator:
76 auto res = std::next(first, idx);
77 (*res)->state_ = finished;
80 /** Creates (but don't start) an async send to the mailbox @p dest */
81 static Comm &send_init(Mailbox &dest);
82 /** Creates and start an async send to the mailbox @p dest */
83 static Comm &send_async(Mailbox &dest, void *data, int simulatedByteAmount);
84 /** Creates (but don't start) an async recv onto the mailbox @p from */
85 static Comm &recv_init(Mailbox &from);
86 /** Creates and start an async recv to the mailbox @p from */
87 static Comm &recv_async(Mailbox &from, void **data);
89 void start() override;
91 void wait(double timeout) override;
93 /** Sets the maximal communication rate (in byte/sec). Must be done before start */
94 void setRate(double rate);
96 /** Specify the data to send */
97 void setSrcData(void * buff);
98 /** Specify the size of the data to send */
99 void setSrcDataSize(size_t size);
100 /** Specify the data to send and its size */
101 void setSrcData(void * buff, size_t size);
103 /** Specify where to receive the data */
104 void setDstData(void ** buff);
105 /** Specify the buffer in which the data should be received */
106 void setDstData(void ** buff, size_t size);
107 /** Retrieve the size of the received data */
108 size_t getDstDataSize();
115 void *dstBuff_ = nullptr;
116 size_t dstBuffSize_ = 0;
117 void *srcBuff_ = nullptr;
118 size_t srcBuffSize_ = sizeof(void*);
120 /* FIXME: expose these elements in the API */
122 int (*matchFunction_)(void *, void *, smx_synchro_t) = nullptr;
123 void (*cleanFunction_)(void *) = nullptr;
124 void (*copyDataFunction_)(smx_synchro_t, void*, size_t) = nullptr;
126 smx_process_t sender_ = nullptr;
127 smx_process_t receiver_ = nullptr;
128 Mailbox *mailbox_ = nullptr;
131 }} // namespace simgrid::s4u
133 #endif /* SIMGRID_S4U_COMM_HPP */