Logo AND Algorithmique Numérique Distribuée

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