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 METASIMGRID_PRIVATE_H
7 #define METASIMGRID_PRIVATE_H
9 #include "simgrid/msg.h"
11 #include "src/kernel/activity/CommImpl.hpp"
12 #include "src/kernel/activity/ExecImpl.hpp"
13 #include "xbt/Extendable.hpp"
15 /**************** datatypes **********************************/
16 /**************************** Host Extension *********************************/
20 static simgrid::xbt::Extension<s4u::Host, MsgHostExt> EXTENSION_ID;
23 delete file_descriptor_table;
25 std::vector<int>* file_descriptor_table = nullptr; // Created lazily on need
28 /********************************* Task **************************************/
30 typedef struct simdata_task {
33 /* parallel tasks only */
34 xbt_free(this->host_list);
42 simgrid::kernel::activity::ExecImplPtr compute = nullptr; /* SIMIX modeling of computation */
43 simgrid::kernel::activity::CommImplPtr comm = nullptr; /* SIMIX modeling of communication */
44 double bytes_amount = 0.0; /* Data size */
45 double flops_amount = 0.0; /* Computation size */
46 msg_process_t sender = nullptr;
47 msg_process_t receiver = nullptr;
48 msg_host_t source = nullptr;
50 double priority = 1.0;
51 double bound = 0.0; /* Capping for CPU resource, or 0 for no capping */
52 double rate = -1; /* Capping for network resource, or -1 for no capping*/
54 bool isused = false; /* Indicates whether the task is used in SIMIX currently */
55 int host_nb = 0; /* ==0 if sequential task; parallel task if not */
56 /******* Parallel Tasks Only !!!! *******/
57 sg_host_t *host_list = nullptr;
58 double *flops_parallel_amount = nullptr;
59 double *bytes_parallel_amount = nullptr;
62 void reportMultipleUse() const;
65 /********************************* File **************************************/
66 typedef struct simdata_file {
70 /******************************* Process *************************************/
75 explicit MsgActorExt(void* d) : data(d) {}
76 msg_error_t errno_ = MSG_OK; /* the last value returned by a MSG_function */
77 void* data = nullptr; /* user data */
81 typedef struct msg_comm {
82 smx_activity_t s_comm; /* SIMIX communication object encapsulated (the same for both processes) */
83 msg_task_t task_sent; /* task sent (NULL for the receiver) */
84 msg_task_t *task_received; /* where the task will be received (NULL for the sender) */
85 msg_error_t status; /* status of the communication once finished */
88 /************************** Global variables ********************************/
89 typedef struct MSG_Global {
90 int debug_multiple_use; /* whether we want an error message when reusing the same Task for 2 things */
91 unsigned long int 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;
95 typedef s_MSG_Global_t* MSG_Global_t;
99 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
101 /*************************************************************/
103 XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
104 XBT_PRIVATE void __MSG_file_destroy(msg_file_t file);
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, xbt_dict_t 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);
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);
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();
127 /* declaration of instrumentation functions from msg_process_instr.c */
128 XBT_PRIVATE char *instr_process_id (msg_process_t proc, char *str, int len);
129 XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
130 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host, msg_host_t new_host);
131 XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
132 XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
133 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
134 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
135 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
136 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process); //called from msg/gos.c
137 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
141 inline void simdata_task::setUsed()
144 this->reportMultipleUse();
145 if (msg_global->debug_multiple_use) {