Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
activity::CommImpl: stick to our naming standards for the fields
[simgrid.git] / src / kernel / activity / CommImpl.hpp
1 /* Copyright (c) 2007-2019. 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_KERNEL_ACTIVITY_COMM_HPP
7 #define SIMGRID_KERNEL_ACTIVITY_COMM_HPP
8
9 #include "src/kernel/activity/ActivityImpl.hpp"
10 #include "src/simix/ActorImpl.hpp"
11 #include "surf/surf.hpp"
12
13 enum e_smx_comm_type_t { SIMIX_COMM_SEND, SIMIX_COMM_RECEIVE, SIMIX_COMM_READY, SIMIX_COMM_DONE };
14
15 namespace simgrid {
16 namespace kernel {
17 namespace activity {
18
19 class XBT_PUBLIC CommImpl : public ActivityImpl {
20   ~CommImpl() override;
21
22 public:
23   explicit CommImpl(e_smx_comm_type_t type);
24   void suspend() override;
25   void resume() override;
26   void post() override;
27   void cancel();
28   double remains();
29   void cleanupSurf(); // FIXME: make me protected
30
31   e_smx_comm_type_t type;       /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
32   smx_mailbox_t mbox = nullptr; /* Rendez-vous where the comm is queued */
33
34 #if SIMGRID_HAVE_MC
35   smx_mailbox_t mbox_cpy = nullptr; /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
36                                      (comm.mbox set to nullptr when the communication is removed from the mailbox
37                                      (used as garbage collector)) */
38 #endif
39   bool detached = false; /* If detached or not */
40
41   void (*clean_fun)(void*) = nullptr; /* Function to clean the detached src_buf if something goes wrong */
42   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*) =
43       nullptr; /* Filter function used by the other side. It is used when
44 looking if a given communication matches my needs. For that, myself must match the
45 expectations of the other side, too. See  */
46   void (*copy_data_fun)(smx_activity_t, void*, size_t) = nullptr;
47
48   /* Surf action data */
49   resource::Action* surf_action_ = nullptr; /* The Surf communication action encapsulated */
50   resource::Action* src_timeout_ = nullptr; /* Surf's actions to instrument the timeouts */
51   resource::Action* dst_timeout_ = nullptr; /* Surf's actions to instrument the timeouts */
52   actor::ActorImplPtr src_actor_ = nullptr;
53   actor::ActorImplPtr dst_actor_ = nullptr;
54   double rate_                   = 0.0;
55   double task_size_              = 0.0;
56
57   /* Data to be transfered */
58   void* src_buff_        = nullptr;
59   void* dst_buff_        = nullptr;
60   size_t src_buff_size_  = 0;
61   size_t* dst_buff_size_ = nullptr;
62   bool copied           = false; /* whether the data were already copied */
63
64   void* src_data_ = nullptr; /* User data associated to the communication */
65   void* dst_data_ = nullptr;
66 };
67 }
68 }
69 } // namespace simgrid::kernel::activity
70
71 #endif