Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
89346d1a585cf541dc137fe6c8d9b7c3359e587a
[simgrid.git] / src / msg / msg_private.hpp
1 /* Copyright (c) 2004-2017. 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 MSG_PRIVATE_HPP
7 #define MSG_PRIVATE_HPP
8
9 #include "simgrid/msg.h"
10
11 #include "src/kernel/activity/CommImpl.hpp"
12 #include "src/kernel/activity/ExecImpl.hpp"
13 #include "xbt/Extendable.hpp"
14
15 #include <atomic>
16
17 /**************** datatypes **********************************/
18 /********************************* Task **************************************/
19
20 struct s_simdata_task_t {
21   ~s_simdata_task_t()
22   {
23     /* parallel tasks only */
24     delete[] this->host_list;
25     /* flops_parallel_amount and bytes_parallel_amount are automatically deleted in ~L07Action */
26   }
27   void setUsed();
28   void setNotUsed() { this->isused = false; }
29
30   simgrid::kernel::activity::ExecImplPtr compute = nullptr; /* SIMIX modeling of computation */
31   simgrid::kernel::activity::CommImplPtr comm    = nullptr; /* SIMIX modeling of communication */
32   double bytes_amount                            = 0.0;     /* Data size */
33   double flops_amount                            = 0.0;     /* Computation size */
34   msg_process_t sender                           = nullptr;
35   msg_process_t receiver                         = nullptr;
36   msg_host_t source                              = nullptr;
37
38   double priority = 1.0;
39   double bound    = 0.0; /* Capping for CPU resource, or 0 for no capping */
40   double rate     = -1;  /* Capping for network resource, or -1 for no capping*/
41
42   bool isused = false; /* Indicates whether the task is used in SIMIX currently */
43   int host_nb = 0;     /* ==0 if sequential task; parallel task if not */
44   /*******  Parallel Tasks Only !!!! *******/
45   sg_host_t* host_list          = nullptr;
46   double* flops_parallel_amount = nullptr;
47   double* bytes_parallel_amount = nullptr;
48
49 private:
50   void reportMultipleUse() const;
51 };
52
53 /******************************* Process *************************************/
54
55 namespace simgrid {
56 namespace msg {
57 class ActorExt {
58 public:
59   explicit ActorExt(void* d) : data(d) {}
60   msg_error_t errno_ = MSG_OK;  /* the last value returned by a MSG_function */
61   void* data         = nullptr; /* user data */
62 };
63
64 class Comm {
65 public:
66   msg_task_t task_sent;        /* task sent (NULL for the receiver) */
67   msg_task_t* task_received;   /* where the task will be received (NULL for the sender) */
68   smx_activity_t s_comm;       /* SIMIX communication object encapsulated (the same for both processes) */
69   msg_error_t status = MSG_OK; /* status of the communication once finished */
70   Comm(msg_task_t sent, msg_task_t* received, smx_activity_t comm)
71       : task_sent(sent), task_received(received), s_comm(std::move(comm))
72   {
73   }
74 };
75 }
76 }
77
78 /************************** Global variables ********************************/
79 struct s_MSG_Global_t {
80   int debug_multiple_use;            /* whether we want an error message when reusing the same Task for 2 things */
81   std::atomic_int_fast32_t sent_msg; /* Total amount of messages sent during the simulation */
82   void (*task_copy_callback)(msg_task_t task, msg_process_t src, msg_process_t dst);
83   void_f_pvoid_t process_data_cleanup;
84 };
85 typedef s_MSG_Global_t* MSG_Global_t;
86
87 extern "C" {
88
89 XBT_PUBLIC_DATA MSG_Global_t msg_global;
90
91 /*************************************************************/
92 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_proc);
93 XBT_PRIVATE smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data,
94                                                       sg_host_t host, std::map<std::string, std::string>* properties,
95                                                       smx_actor_t parent_process);
96 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_activity_t comm, void* buff, size_t buff_size);
97
98 /********** Tracing **********/
99 /* declaration of instrumentation functions from msg_task_instr.c */
100 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char* category);
101 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
102 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
103 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
104 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
105 XBT_PRIVATE void TRACE_msg_task_get_end(msg_task_t task);
106 XBT_PRIVATE void TRACE_msg_task_get_start();
107 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task); // returns TRUE if the task_put_end must be called
108 XBT_PRIVATE void TRACE_msg_task_put_end();
109
110 /* declaration of instrumentation functions from msg_process_instr.c */
111 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
112 }
113
114 inline void s_simdata_task_t::setUsed()
115 {
116   if (this->isused)
117     this->reportMultipleUse();
118   this->isused = true;
119 }
120
121 #endif