Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
e4280f6fd8db21c11092f6ff74bd3840f7ace973
[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 /**************************** Host Extension *********************************/
19 namespace simgrid {
20 class MsgHostExt {
21 public:
22   static simgrid::xbt::Extension<s4u::Host, MsgHostExt> EXTENSION_ID;
23
24   ~MsgHostExt() { delete file_descriptor_table; }
25   std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
26 };
27 }
28 /********************************* Task **************************************/
29
30 struct s_simdata_task_t {
31   ~s_simdata_task_t()
32   {
33     /* parallel tasks only */
34     delete[] this->host_list;
35     /* flops_parallel_amount and bytes_parallel_amount are automatically deleted in ~L07Action */
36   }
37   void setUsed();
38   void setNotUsed() { this->isused = false; }
39
40   simgrid::kernel::activity::ExecImplPtr compute = nullptr; /* SIMIX modeling of computation */
41   simgrid::kernel::activity::CommImplPtr comm    = nullptr; /* SIMIX modeling of communication */
42   double bytes_amount                            = 0.0;     /* Data size */
43   double flops_amount                            = 0.0;     /* Computation size */
44   msg_process_t sender                           = nullptr;
45   msg_process_t receiver                         = nullptr;
46   msg_host_t source                              = nullptr;
47
48   double priority = 1.0;
49   double bound    = 0.0; /* Capping for CPU resource, or 0 for no capping */
50   double rate     = -1;  /* Capping for network resource, or -1 for no capping*/
51
52   bool isused = false; /* Indicates whether the task is used in SIMIX currently */
53   int host_nb = 0;     /* ==0 if sequential task; parallel task if not */
54   /*******  Parallel Tasks Only !!!! *******/
55   sg_host_t* host_list          = nullptr;
56   double* flops_parallel_amount = nullptr;
57   double* bytes_parallel_amount = nullptr;
58
59 private:
60   void reportMultipleUse() const;
61 };
62
63 /******************************* Process *************************************/
64
65 namespace simgrid {
66 namespace msg {
67 class ActorExt {
68 public:
69   explicit ActorExt(void* d) : data(d) {}
70   msg_error_t errno_ = MSG_OK;  /* the last value returned by a MSG_function */
71   void* data         = nullptr; /* user data */
72 };
73
74 class Comm {
75 public:
76   msg_task_t task_sent;        /* task sent (NULL for the receiver) */
77   msg_task_t* task_received;   /* where the task will be received (NULL for the sender) */
78   smx_activity_t s_comm;       /* SIMIX communication object encapsulated (the same for both processes) */
79   msg_error_t status = MSG_OK; /* status of the communication once finished */
80   Comm(msg_task_t sent, msg_task_t* received, smx_activity_t comm)
81       : task_sent(sent), task_received(received), s_comm(std::move(comm))
82   {
83   }
84 };
85 }
86 }
87
88 /************************** Global variables ********************************/
89 struct s_MSG_Global_t {
90   int debug_multiple_use;            /* whether we want an error message when reusing the same Task for 2 things */
91   std::atomic_int_fast32_t sent_msg; /* Total amount of messages sent during the simulation */
92   void (*task_copy_callback)(msg_task_t task, msg_process_t src, msg_process_t dst);
93   void_f_pvoid_t process_data_cleanup;
94 };
95 typedef s_MSG_Global_t* MSG_Global_t;
96
97 XBT_PRIVATE std::string instr_pid(msg_process_t proc);
98 XBT_PRIVATE void TRACE_msg_process_create(std::string process_name, int process_pid, msg_host_t host);
99 XBT_PRIVATE void TRACE_msg_process_destroy(std::string process_name, int process_pid);
100
101 extern "C" {
102
103 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
104
105 /*************************************************************/
106 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_proc);
107 XBT_PRIVATE smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data,
108                                                       sg_host_t host, std::map<std::string, std::string>* properties,
109                                                       smx_actor_t parent_process);
110 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_activity_t comm, void* buff, size_t buff_size);
111
112 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
113 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
114
115 /********** Tracing **********/
116 /* declaration of instrumentation functions from msg_task_instr.c */
117 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char* category);
118 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
119 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
120 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
121 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
122 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
123 XBT_PRIVATE void TRACE_msg_task_get_start();
124 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task); // returns TRUE if the task_put_end must be called
125 XBT_PRIVATE void TRACE_msg_task_put_end();
126
127 /* declaration of instrumentation functions from msg_process_instr.c */
128 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t new_host);
129 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
130 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
131 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
132 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process); // called from msg/gos.c
133 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
134 }
135
136 inline void s_simdata_task_t::setUsed()
137 {
138   if (this->isused)
139     this->reportMultipleUse();
140   if (msg_global->debug_multiple_use) {
141     // TODO, backtrace
142   }
143   this->isused = true;
144 }
145
146 #endif