1 /* Copyright (c) 2007-2023. 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_KERNEL_ACTIVITY_COMM_HPP
7 #define SIMGRID_KERNEL_ACTIVITY_COMM_HPP
9 #include "src/kernel/activity/ActivityImpl.hpp"
10 #include "src/kernel/actor/ActorImpl.hpp"
11 #include "src/kernel/actor/CommObserver.hpp"
13 namespace simgrid::kernel::activity {
15 enum class CommImplType { SEND, RECEIVE };
17 class XBT_PUBLIC CommImpl : public ActivityImpl_T<CommImpl> {
21 static std::function<void(CommImpl*, void*, size_t)> copy_data_callback_;
25 bool detached_ = false; /* If detached or not */
26 bool copied_ = false; /* whether the data were already copied */
27 MailboxImpl* mbox_ = nullptr; /* Rendez-vous where the comm is queued. nullptr once the comm is matched with both a
28 sender and receiver */
29 long mbox_id_ = -1; /* ID of the rendez-vous where the comm was first queued (for MC) */
30 s4u::Host* from_ = nullptr; /* Pre-determined only for direct host-to-host communications */
31 s4u::Host* to_ = nullptr; /* Otherwise, computed at start() time from the actors */
32 CommImplType type_ = CommImplType::SEND; /* Type of the communication (SEND or RECEIVE) */
37 static void set_copy_data_callback(const std::function<void(CommImpl*, void*, size_t)>& callback);
39 CommImpl& set_type(CommImplType type);
40 CommImplType get_type() const { return type_; }
41 CommImpl& set_source(s4u::Host* from);
42 s4u::Host* get_source() const { return from_; }
43 CommImpl& set_destination(s4u::Host* to);
44 s4u::Host* get_destination() const { return to_; }
45 CommImpl& set_size(double size);
46 CommImpl& set_src_buff(unsigned char* buff, size_t size);
47 CommImpl& set_dst_buff(unsigned char* buff, size_t* size);
48 CommImpl& set_rate(double rate);
49 CommImpl& set_mailbox(MailboxImpl* mbox);
52 double get_rate() const { return rate_; }
53 MailboxImpl* get_mailbox() const { return mbox_; }
54 long get_mailbox_id() const { return mbox_id_; }
55 bool is_detached() const { return detached_; }
56 bool is_assigned() const { return (to_ != nullptr && from_ != nullptr); }
58 std::vector<s4u::Link*> get_traversed_links() const;
61 static ActivityImplPtr isend(actor::CommIsendSimcall* observer);
62 static ActivityImplPtr irecv(actor::CommIrecvSimcall* observer);
64 bool test(actor::ActorImpl* issuer) override;
65 void wait_for(actor::ActorImpl* issuer, double timeout) override;
66 static void wait_any_for(actor::ActorImpl* issuer, const std::vector<CommImpl*>& comms, double timeout);
69 void suspend() override;
70 void resume() override;
71 void cancel() override;
73 void set_exception(actor::ActorImpl* issuer) override;
74 void finish() override;
76 std::function<void(void*)> clean_fun; /* Function to clean the detached src_buf if something goes wrong */
77 std::function<bool(void*, void*, CommImpl*)> match_fun; /* Filter function used by the other side. It is used when
78 looking if a given communication matches my needs. For that, myself must match the
79 expectations of the other side, too. See */
80 std::function<void(CommImpl*, void*, size_t)> copy_data_fun;
82 /* Surf action data */
83 resource::Action* src_timeout_ = nullptr; /* Surf's actions to instrument the timeouts */
84 resource::Action* dst_timeout_ = nullptr; /* Surf's actions to instrument the timeouts */
85 actor::ActorImplPtr src_actor_ = nullptr;
86 actor::ActorImplPtr dst_actor_ = nullptr;
88 /* Data to be transferred */
89 unsigned char* src_buff_ = nullptr;
90 unsigned char* dst_buff_ = nullptr;
91 size_t src_buff_size_ = 0;
92 size_t* dst_buff_size_ = nullptr;
94 void* src_data_ = nullptr; /* User data associated to the communication */
95 void* dst_data_ = nullptr;
96 static xbt::signal<void(CommImpl const&)> on_start;
97 static xbt::signal<void(CommImpl const&)> on_completion;
99 } // namespace simgrid::kernel::activity