1 /* Copyright (c) 2006-2017. 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/Mailbox.hpp> // DEPRECATED 3.20
14 #include <simgrid/s4u/forward.hpp>
20 /** @brief Communication async
22 * Represents all asynchronous communications, that you can test or wait onto.
24 XBT_PUBLIC_CLASS Comm : public Activity
26 Comm() : Activity() {}
28 friend void intrusive_ptr_release(simgrid::s4u::Comm * c);
29 friend void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
30 friend Mailbox; // Factory of comms
34 /*! take a range of s4u::CommPtr (last excluded) and return when one of them is finished. The return value is an
35 * iterator on the finished Comms. */
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 // Map to dynar<Synchro*>:
41 xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), [](void*ptr){
42 intrusive_ptr_release(*(simgrid::kernel::activity::ActivityImpl**)ptr);
44 for (auto const& comm : *comms_in) {
45 if (comm->state_ == inited)
47 xbt_assert(comm->state_ == started);
48 simgrid::kernel::activity::ActivityImpl* ptr = comm->pimpl_.get();
49 intrusive_ptr_add_ref(ptr);
50 xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, ptr);
52 // Call the underlying simcall:
53 int idx = simcall_comm_waitany(comms, timeout);
54 xbt_dynar_free(&comms);
57 /** Creates (but don't start) an async send to the mailbox @p dest */
58 static CommPtr XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_init(): v3.20 will turn this warning into an error.")
59 send_init(MailboxPtr dest)
61 return dest->put_init();
63 /** Creates (but don't start) an async send to the mailbox @p dest */
64 static CommPtr XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_init(): v3.20 will turn this warning into an error.")
65 send_init(MailboxPtr dest, void* data, int simulatedByteAmount)
67 return dest->put_init(data, simulatedByteAmount);
69 /** Creates and start an async send to the mailbox @p dest */
70 static CommPtr XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.")
71 send_async(MailboxPtr dest, void* data, int simulatedByteAmount)
73 return dest->put_async(data, simulatedByteAmount);
75 /** Creates (but don't start) an async recv onto the mailbox @p from */
76 static CommPtr XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get_init(): v3.20 will turn this warning into an error.")
77 recv_init(MailboxPtr from)
79 return from->get_init();
81 /** Creates and start an async recv to the mailbox @p from */
82 static CommPtr XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get_async(): v3.20 will turn this warning into an error.")
83 recv_async(MailboxPtr from, void** data)
85 return from->get_async(data);
88 void start() override;
90 void wait(double timeout) override;
92 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
95 /** Sets the maximal communication rate (in byte/sec). Must be done before start */
96 void setRate(double rate);
98 /** Specify the data to send */
99 void setSrcData(void* buff);
100 /** Specify the size of the data to send */
101 void setSrcDataSize(size_t size);
102 /** Specify the data to send and its size */
103 void setSrcData(void* buff, size_t size);
105 /** Specify where to receive the data */
106 void setDstData(void** buff);
107 /** Specify the buffer in which the data should be received */
108 void setDstData(void** buff, size_t size);
109 /** Retrieve the size of the received data */
110 size_t getDstDataSize();
115 /** Retrieve the mailbox on which this comm acts */
116 MailboxPtr getMailbox();
120 void* dstBuff_ = nullptr;
121 size_t dstBuffSize_ = 0;
122 void* srcBuff_ = nullptr;
123 size_t srcBuffSize_ = sizeof(void*);
125 /* FIXME: expose these elements in the API */
127 int (*matchFunction_)(void*, void*, simgrid::kernel::activity::CommImpl*) = nullptr;
128 void (*cleanFunction_)(void*) = nullptr;
129 void (*copyDataFunction_)(smx_activity_t, void*, size_t) = nullptr;
131 smx_actor_t sender_ = nullptr;
132 smx_actor_t receiver_ = nullptr;
133 MailboxPtr mailbox_ = nullptr;
135 std::atomic_int_fast32_t refcount_{0};
138 } // namespace simgrid::s4u
140 #endif /* SIMGRID_S4U_COMM_HPP */