1 /* Copyright (c) 2006-2020. 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_T<Comm> {
22 Mailbox* mailbox_ = nullptr;
23 kernel::actor::ActorImpl* sender_ = nullptr;
24 kernel::actor::ActorImpl* receiver_ = nullptr;
26 void* dst_buff_ = nullptr;
27 size_t dst_buff_size_ = 0;
28 void* src_buff_ = nullptr;
29 size_t src_buff_size_ = sizeof(void*);
30 std::string tracing_category_ = "";
31 /* FIXME: expose these elements in the API */
32 bool detached_ = false;
33 bool (*match_fun_)(void*, void*, kernel::activity::CommImpl*) = nullptr;
34 void (*clean_fun_)(void*) = nullptr;
35 void (*copy_data_function_)(kernel::activity::CommImpl*, void*, size_t) = nullptr;
41 friend Mailbox; // Factory of comms
46 static xbt::signal<void(Actor const&)> on_sender_start;
47 static xbt::signal<void(Actor const&)> on_receiver_start;
48 static xbt::signal<void(Actor const&)> on_completion;
50 /*! take a vector s4u::CommPtr and return when one of them is finished.
51 * The return value is the rank of the first finished CommPtr. */
52 static int wait_any(const std::vector<CommPtr>* comms) { return wait_any_for(comms, -1); }
53 /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
54 static int wait_any_for(const std::vector<CommPtr>* comms_in, double timeout);
56 /*! take a vector s4u::CommPtr and return when all of them is finished. */
57 static void wait_all(const std::vector<CommPtr>* comms);
58 /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
59 static int test_any(const std::vector<CommPtr>* comms);
61 Comm* start() override;
62 Comm* wait() override;
63 Comm* wait_for(double timeout) override;
64 Comm* cancel() override;
67 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
69 /** Start the comm, and ignore its result. It can be completely forgotten after that. */
70 Comm* detach(void (*clean_function)(void*))
72 clean_fun_ = clean_function;
76 /** Sets the maximal communication rate (in byte/sec). Must be done before start */
77 CommPtr set_rate(double rate);
79 /** Specify the data to send.
81 * This is way will get actually copied over to the receiver.
82 * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
83 * you can send a short buffer in your simulator, that represents a very large message
84 * in the simulated world, or the opposite.
86 CommPtr set_src_data(void* buff);
87 /** Specify the size of the data to send. Not to be mixed with @ref Activity::set_remaining()
89 * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()).
90 * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
91 * you can send a short buffer in your simulator, that represents a very large message
92 * in the simulated world, or the opposite.
94 CommPtr set_src_data_size(size_t size);
95 /** Specify the data to send and its size. Don't mix the size with @ref Activity::set_remaining()
97 * This is way will get actually copied over to the receiver.
98 * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
99 * you can send a short buffer in your simulator, that represents a very large message
100 * in the simulated world, or the opposite.
102 CommPtr set_src_data(void* buff, size_t size);
104 /** Specify where to receive the data.
106 * That's a buffer where the sent data will be copied */
107 CommPtr set_dst_data(void** buff);
108 /** Specify the buffer in which the data should be received
110 * That's a buffer where the sent data will be copied */
111 CommPtr set_dst_data(void** buff, size_t size);
113 CommPtr set_tracing_category(const std::string& category);
115 /** Retrieve the mailbox on which this comm acts */
116 Mailbox* get_mailbox();
117 /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining() */
118 size_t get_dst_data_size();
123 } // namespace simgrid
125 #endif /* SIMGRID_S4U_COMM_HPP */