Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
implement getter s4u::Comm::mailbox()
[simgrid.git] / include / simgrid / s4u / Comm.hpp
1 /* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef SIMGRID_S4U_COMM_HPP
7 #define SIMGRID_S4U_COMM_HPP
8
9 #include <xbt/base.h>
10
11 #include <simgrid/forward.h>
12 #include <simgrid/s4u/Activity.hpp>
13 #include <simgrid/s4u/Mailbox.hpp> // DEPRECATED 3.17
14 #include <simgrid/s4u/forward.hpp>
15
16 #include <vector>
17
18 namespace simgrid {
19 namespace s4u {
20 /** @brief Communication async
21  *
22  * Represents all asynchronous communications, that you can test or wait onto.
23  */
24 XBT_PUBLIC_CLASS Comm : public Activity
25 {
26   Comm() : Activity() {}
27 public:
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
31
32   virtual ~Comm();
33
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)
39   {
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);
43     });
44     for (auto comm : *comms_in) {
45       if (comm->state_ == inited)
46         comm->start();
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);
51     }
52     // Call the underlying simcall:
53     int idx = simcall_comm_waitany(comms, timeout);
54     xbt_dynar_free(&comms);
55     return idx;
56   }
57   /** Creates (but don't start) an async send to the mailbox @p dest */
58   static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_init") // 3.17
59       send_init(MailboxPtr dest)
60   {
61     return dest->put_init();
62   }
63   /** Creates (but don't start) an async send to the mailbox @p dest */
64   static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_init") // 3.17
65       send_init(MailboxPtr dest, void* data, int simulatedByteAmount)
66   {
67     return dest->put_init(data, simulatedByteAmount);
68   }
69   /** Creates and start an async send to the mailbox @p dest */
70   static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_async") // 3.17
71       send_async(MailboxPtr dest, void* data, int simulatedByteAmount)
72   {
73     return dest->put_async(data, simulatedByteAmount);
74   }
75   /** Creates (but don't start) an async recv onto the mailbox @p from */
76   static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::get_init") // 3.17
77       recv_init(MailboxPtr from)
78   {
79     return from->get_init();
80   }
81   /** Creates and start an async recv to the mailbox @p from */
82   static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::get_async") // 3.17
83       recv_async(MailboxPtr from, void** data)
84   {
85     return from->get_async(data);
86   }
87
88   void start() override;
89   void wait() override;
90   void wait(double timeout) override;
91
92   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
93   void detach();
94
95   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
96   void setRate(double rate);
97
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);
104
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();
111
112   bool test();
113   void cancel();
114
115   /** Retrieve the mailbox on which this comm acts */
116   MailboxPtr mailbox();
117
118 private:
119   double rate_        = -1;
120   void* dstBuff_      = nullptr;
121   size_t dstBuffSize_ = 0;
122   void* srcBuff_      = nullptr;
123   size_t srcBuffSize_ = sizeof(void*);
124
125   /* FIXME: expose these elements in the API */
126   int detached_ = 0;
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;
130
131   smx_actor_t sender_   = nullptr;
132   smx_actor_t receiver_ = nullptr;
133   MailboxPtr mailbox_   = nullptr;
134
135   std::atomic_int_fast32_t refcount_{0};
136 };
137 }
138 } // namespace simgrid::s4u
139
140 #endif /* SIMGRID_S4U_COMM_HPP */