1 /* Copyright (c) 2004-2017. 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 MSG_PRIVATE_HPP
7 #define MSG_PRIVATE_HPP
9 #include "simgrid/msg.h"
11 #include "src/kernel/activity/CommImpl.hpp"
12 #include "src/kernel/activity/ExecImpl.hpp"
13 #include "xbt/Extendable.hpp"
17 /**************** datatypes **********************************/
18 /**************************** Host Extension *********************************/
22 static simgrid::xbt::Extension<s4u::Host, MsgHostExt> EXTENSION_ID;
24 ~MsgHostExt() { delete file_descriptor_table; }
25 std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
28 /********************************* Task **************************************/
30 struct s_simdata_task_t {
31 ~s_simdata_task_t() { delete[] this->host_list; /* parallel tasks only */ }
33 void setNotUsed() { this->isused = false; }
35 simgrid::kernel::activity::ExecImplPtr compute = nullptr; /* SIMIX modeling of computation */
36 simgrid::kernel::activity::CommImplPtr comm = nullptr; /* SIMIX modeling of communication */
37 double bytes_amount = 0.0; /* Data size */
38 double flops_amount = 0.0; /* Computation size */
39 msg_process_t sender = nullptr;
40 msg_process_t receiver = nullptr;
41 msg_host_t source = nullptr;
43 double priority = 1.0;
44 double bound = 0.0; /* Capping for CPU resource, or 0 for no capping */
45 double rate = -1; /* Capping for network resource, or -1 for no capping*/
47 bool isused = false; /* Indicates whether the task is used in SIMIX currently */
48 int host_nb = 0; /* ==0 if sequential task; parallel task if not */
49 /******* Parallel Tasks Only !!!! *******/
50 sg_host_t* host_list = nullptr;
51 double* flops_parallel_amount = nullptr;
52 double* bytes_parallel_amount = nullptr;
55 void reportMultipleUse() const;
58 /******************************* Process *************************************/
64 explicit ActorExt(void* d) : data(d) {}
65 msg_error_t errno_ = MSG_OK; /* the last value returned by a MSG_function */
66 void* data = nullptr; /* user data */
71 msg_task_t task_sent; /* task sent (NULL for the receiver) */
72 msg_task_t* task_received; /* where the task will be received (NULL for the sender) */
73 smx_activity_t s_comm; /* SIMIX communication object encapsulated (the same for both processes) */
74 msg_error_t status = MSG_OK; /* status of the communication once finished */
75 Comm(msg_task_t sent, msg_task_t* received, smx_activity_t comm)
76 : task_sent(sent), task_received(received), s_comm(std::move(comm))
83 /************************** Global variables ********************************/
84 struct s_MSG_Global_t {
85 int debug_multiple_use; /* whether we want an error message when reusing the same Task for 2 things */
86 std::atomic_int_fast32_t sent_msg; /* Total amount of messages sent during the simulation */
87 void (*task_copy_callback)(msg_task_t task, msg_process_t src, msg_process_t dst);
88 void_f_pvoid_t process_data_cleanup;
90 typedef s_MSG_Global_t* MSG_Global_t;
94 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
96 /*************************************************************/
97 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_proc);
98 XBT_PRIVATE smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data,
99 sg_host_t host, std::map<std::string, std::string>* properties,
100 smx_actor_t parent_process);
101 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_activity_t comm, void* buff, size_t buff_size);
103 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
104 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
106 /********** Tracing **********/
107 /* declaration of instrumentation functions from msg_task_instr.c */
108 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char* category);
109 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
110 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
111 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
112 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
113 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
114 XBT_PRIVATE void TRACE_msg_task_get_start();
115 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task); // returns TRUE if the task_put_end must be called
116 XBT_PRIVATE void TRACE_msg_task_put_end();
118 /* declaration of instrumentation functions from msg_process_instr.c */
119 XBT_PRIVATE char* instr_process_id(msg_process_t proc, char* str, int len);
120 XBT_PRIVATE char* instr_process_id_2(const char* process_name, int process_pid, char* str, int len);
121 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t new_host);
122 XBT_PRIVATE void TRACE_msg_process_create(const char* process_name, int process_pid, msg_host_t host);
123 XBT_PRIVATE void TRACE_msg_process_destroy(const char* process_name, int process_pid);
124 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
125 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
126 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
127 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process); // called from msg/gos.c
128 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
131 inline void s_simdata_task_t::setUsed()
134 this->reportMultipleUse();
135 if (msg_global->debug_multiple_use) {