1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef METASIMGRID_PRIVATE_H
8 #define METASIMGRID_PRIVATE_H
13 #include "simgrid/msg.h"
14 #include "simgrid/simix.h"
15 #include "src/include/surf/surf.h"
18 #include "xbt/dynar.h"
21 #include "xbt/config.h"
22 #include "src/instr/instr_private.h"
24 #include "src/kernel/activity/SynchroExec.hpp"
25 #include "src/kernel/activity/SynchroComm.hpp"
29 /**************** datatypes **********************************/
31 /********************************* Task **************************************/
33 typedef struct simdata_task {
37 this->compute->unref();
39 /* parallel tasks only */
40 xbt_free(this->host_list);
48 simgrid::kernel::activity::Exec *compute = nullptr; /* SIMIX modeling of computation */
49 simgrid::kernel::activity::Comm *comm = nullptr; /* SIMIX modeling of communication */
50 double bytes_amount = 0.0; /* Data size */
51 double flops_amount = 0.0; /* Computation size */
52 msg_process_t sender = nullptr;
53 msg_process_t receiver = nullptr;
54 msg_host_t source = nullptr;
55 double priority = 0.0;
56 double bound = 0.0; /* Capping for CPU resource */
57 double rate = 0.0; /* Capping for network resource */
59 bool isused = false; /* Indicates whether the task is used in SIMIX currently */
60 int host_nb = 0; /* ==0 if sequential task; parallel task if not */
61 /******* Parallel Tasks Only !!!! *******/
62 sg_host_t *host_list = nullptr;
63 double *flops_parallel_amount = nullptr;
64 double *bytes_parallel_amount = nullptr;
67 void reportMultipleUse() const;
70 /********************************* File **************************************/
71 typedef struct simdata_file {
75 XBT_PRIVATE int __MSG_host_get_file_descriptor_id(msg_host_t host);
76 XBT_PRIVATE void __MSG_host_release_file_descriptor_id(msg_host_t host, int id);
78 /******************************* Process *************************************/
80 typedef struct simdata_process {
81 msg_host_t m_host; /* the host on which the process is running */
82 msg_host_t put_host; /* used for debugging purposes */
83 smx_activity_t waiting_action;
84 msg_task_t waiting_task;
85 msg_error_t last_errno; /* the last value returned by a MSG_function */
87 void* data; /* user data */
88 } s_simdata_process_t, *simdata_process_t;
90 typedef struct process_arg {
98 } s_process_arg_t, *process_arg_t;
100 typedef struct msg_comm {
101 smx_activity_t s_comm; /* SIMIX communication object encapsulated (the same for both processes) */
102 msg_task_t task_sent; /* task sent (NULL for the receiver) */
103 msg_task_t *task_received; /* where the task will be received (NULL for the sender) */
104 msg_error_t status; /* status of the communication once finished */
107 /******************************* VM *************************************/
108 typedef struct dirty_page {
110 double prev_remaining;
112 } s_dirty_page, *dirty_page_t;
114 XBT_PUBLIC_DATA(const char*) MSG_vm_get_property_value(msg_vm_t vm, const char *name);
115 XBT_PUBLIC_DATA(xbt_dict_t) MSG_vm_get_properties(msg_vm_t vm);
116 XBT_PUBLIC_DATA(void) MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value, void_f_pvoid_t free_ctn);
117 XBT_PUBLIC_DATA(msg_vm_t) MSG_vm_get_by_name(const char *name);
118 XBT_PUBLIC_DATA(const char*) MSG_vm_get_name(msg_vm_t vm);
120 /************************** Global variables ********************************/
121 typedef struct MSG_Global {
124 int debug_multiple_use;
125 unsigned long int sent_msg; /* Total amount of messages sent during the simulation */
126 void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
127 void_f_pvoid_t process_data_cleanup;
128 } s_MSG_Global_t, *MSG_Global_t;
130 /*extern MSG_Global_t msg_global;*/
131 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
133 /*************************************************************/
134 XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
135 XBT_PRIVATE msg_storage_t __MSG_storage_create(smx_storage_t storage);
136 XBT_PRIVATE void __MSG_host_priv_free(msg_host_priv_t priv);
137 XBT_PRIVATE void __MSG_storage_destroy(msg_storage_priv_t host);
138 XBT_PRIVATE void __MSG_file_destroy(msg_file_priv_t host);
140 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_proc);
141 XBT_PRIVATE smx_actor_t MSG_process_create_from_SIMIX(const char *name,
142 std::function<void()> code, void *data,
143 const char *hostname, double kill_time,
144 xbt_dict_t properties, int auto_restart,
145 smx_actor_t parent_process);
146 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_activity_t comm, void* buff, size_t buff_size);
148 XBT_PRIVATE void MSG_post_create_environment();
150 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
151 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
153 /********** Tracing **********/
154 /* declaration of instrumentation functions from msg_task_instr.c */
155 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char *category);
156 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
157 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
158 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
159 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
160 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
161 XBT_PRIVATE void TRACE_msg_task_get_start();
162 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task); //returns TRUE if the task_put_end must be called
163 XBT_PRIVATE void TRACE_msg_task_put_end();
165 /* declaration of instrumentation functions from msg_process_instr.c */
166 XBT_PRIVATE char *instr_process_id (msg_process_t proc, char *str, int len);
167 XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
168 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host, msg_host_t new_host);
169 XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
170 XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
171 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
172 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
173 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
174 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process); //called from msg/gos.c
175 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
177 /* declaration of instrumentation functions from instr_msg_vm.c */
178 XBT_PRIVATE char *instr_vm_id(msg_vm_t vm, char *str, int len);
179 XBT_PRIVATE char *instr_vm_id_2(const char *vm_name, char *str, int len);
180 XBT_PRIVATE void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host, msg_host_t new_host);
181 XBT_PRIVATE void TRACE_msg_vm_start(msg_vm_t vm);
182 XBT_PRIVATE void TRACE_msg_vm_create(const char *vm_name, msg_host_t host);
183 XBT_PRIVATE void TRACE_msg_vm_kill(msg_vm_t process);
184 XBT_PRIVATE void TRACE_msg_vm_suspend(msg_vm_t vm);
185 XBT_PRIVATE void TRACE_msg_vm_resume(msg_vm_t vm);
186 XBT_PRIVATE void TRACE_msg_vm_save(msg_vm_t vm);
187 XBT_PRIVATE void TRACE_msg_vm_restore(msg_vm_t vm);
188 XBT_PRIVATE void TRACE_msg_vm_end(msg_vm_t vm);
192 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(
193 const char *name, std::function<void()> code, void *data,
194 msg_host_t host, xbt_dict_t properties);
196 inline void simdata_task::setUsed()
199 this->reportMultipleUse();
200 if (msg_global->debug_multiple_use) {