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
10 #include "simgrid/msg.h"
11 #include "simgrid/simix.h"
12 #include "src/include/surf/surf.h"
15 #include "xbt/dynar.h"
18 #include "xbt/config.h"
19 #include "src/instr/instr_private.h"
22 /**************** datatypes **********************************/
24 /********************************* Task **************************************/
27 #define MSG_BT(ptr, m) \
28 do {xbt_ex_t *_xbt_ex_t = xbt_new0(xbt_ex_t, 1); \
29 /* build the exception */ \
30 _xbt_ex_t->msg = (bprintf(m)); \
31 _xbt_ex_t->category = (xbt_errcat_t)(0); \
32 _xbt_ex_t->value = (0); \
33 _xbt_ex_t->procname = (char*)xbt_procname(); \
34 _xbt_ex_t->pid = xbt_getpid(); \
35 _xbt_ex_t->file = (char*)__FILE__; \
36 _xbt_ex_t->line = __LINE__; \
37 _xbt_ex_t->func = (char*)_XBT_FUNCTION; \
38 _xbt_ex_t->bt_strings = NULL; \
39 xbt_backtrace_current(_xbt_ex_t); \
40 ptr = _xbt_ex_t; } while(0)
42 typedef struct simdata_task {
43 smx_synchro_t compute; /* SIMIX modeling of computation */
44 smx_synchro_t comm; /* SIMIX modeling of communication */
45 double bytes_amount; /* Data size */
46 double flops_amount; /* Computation size */
48 msg_process_t receiver;
51 double bound; /* Capping for CPU resource */
52 double rate; /* Capping for network resource */
54 /* CPU affinity database of this task */
55 xbt_dict_t affinity_mask_db; /* smx_host_t host => unsigned long mask */
57 void *isused; /* Indicates whether the task is used in SIMIX currently */
58 int host_nb; /* ==0 if sequential task; parallel task if not */
59 /******* Parallel Tasks Only !!!! *******/
61 double *flops_parallel_amount;
62 double *bytes_parallel_amount;
65 /********************************* File **************************************/
66 typedef struct simdata_file {
70 XBT_PRIVATE int __MSG_host_get_file_descriptor_id(msg_host_t host);
71 XBT_PRIVATE void __MSG_host_release_file_descriptor_id(msg_host_t host, int id);
73 /*************** Begin GPU ***************/
74 typedef struct simdata_gpu_task {
75 double flops_amount; /* Computation size */
76 double dispatch_latency;
77 double collect_latency;
78 int isused; /* Indicates whether the task is used in SIMIX currently */
79 } s_simdata_gpu_task_t;
80 /*************** End GPU ***************/
82 /******************************* Process *************************************/
84 typedef struct simdata_process {
85 msg_host_t m_host; /* the host on which the process is running */
86 msg_host_t put_host; /* used for debugging purposes */
87 #ifdef MSG_USE_DEPRECATED
88 m_channel_t put_channel; /* used for debugging purposes */
90 smx_synchro_t waiting_action;
91 msg_task_t waiting_task;
92 char **argv; /* arguments table if any */
93 int argc; /* arguments number if any */
94 msg_error_t last_errno; /* the last value returned by a MSG_function */
96 void* data; /* user data */
97 } s_simdata_process_t, *simdata_process_t;
99 typedef struct process_arg {
101 xbt_main_func_t code;
107 } s_process_arg_t, *process_arg_t;
109 typedef struct msg_comm {
110 smx_synchro_t s_comm; /* SIMIX communication object encapsulated (the same for both processes) */
111 msg_task_t task_sent; /* task sent (NULL for the receiver) */
112 msg_task_t *task_received; /* where the task will be received (NULL for the sender) */
113 msg_error_t status; /* status of the communication once finished */
117 /******************************* VM *************************************/
118 typedef struct dirty_page {
120 double prev_remaining;
122 } s_dirty_page, *dirty_page_t;
124 XBT_PUBLIC_DATA(const char*) MSG_vm_get_property_value(msg_vm_t vm, const char *name);
125 XBT_PUBLIC_DATA(xbt_dict_t) MSG_vm_get_properties(msg_vm_t vm);
126 XBT_PUBLIC_DATA(void) MSG_vm_set_property_value(msg_vm_t vm, const char *name, void *value, void_f_pvoid_t free_ctn);
127 XBT_PUBLIC_DATA(msg_vm_t) MSG_vm_get_by_name(const char *name);
128 XBT_PUBLIC_DATA(const char*) MSG_vm_get_name(msg_vm_t vm);
130 /************************** Global variables ********************************/
131 typedef struct MSG_Global {
133 #ifdef MSG_USE_DEPRECATED
137 int debug_multiple_use;
138 unsigned long int sent_msg; /* Total amount of messages sent during the simulation */
139 void (*task_copy_callback) (msg_task_t task, msg_process_t src, msg_process_t dst);
140 void_f_pvoid_t process_data_cleanup;
141 } s_MSG_Global_t, *MSG_Global_t;
143 /*extern MSG_Global_t msg_global;*/
144 XBT_PUBLIC_DATA(MSG_Global_t) msg_global;
147 /*************************************************************/
149 #ifdef MSG_USE_DEPRECATED
150 # define PROCESS_SET_ERRNO(val) \
151 (((simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()))->last_errno=val)
152 # define PROCESS_GET_ERRNO() \
153 (((simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self()))->last_errno)
154 #define MSG_RETURN(val) do {PROCESS_SET_ERRNO(val);return(val);} while(0)
155 /* #define CHECK_ERRNO() ASSERT((PROCESS_GET_ERRNO()!=MSG_HOST_FAILURE),"Host failed, you cannot call this function.") */
158 # define MSG_RETURN(val) return(val)
161 XBT_PRIVATE msg_host_t __MSG_host_create(sg_host_t host);
162 XBT_PRIVATE msg_storage_t __MSG_storage_create(smx_storage_t storage);
163 XBT_PRIVATE void __MSG_host_priv_free(msg_host_priv_t priv);
164 XBT_PRIVATE void __MSG_storage_destroy(msg_storage_priv_t host);
165 XBT_PRIVATE void __MSG_file_destroy(msg_file_priv_t host);
167 XBT_PRIVATE void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc);
168 XBT_PRIVATE smx_process_t MSG_process_create_from_SIMIX(const char *name,
169 xbt_main_func_t code, void *data,
170 const char *hostname, double kill_time,
171 int argc, char **argv,
172 xbt_dict_t properties, int auto_restart,
173 smx_process_t parent_process);
174 XBT_PRIVATE void MSG_comm_copy_data_from_SIMIX(smx_synchro_t comm, void* buff, size_t buff_size);
176 XBT_PRIVATE void MSG_post_create_environment(void);
178 XBT_PRIVATE void MSG_host_add_task(msg_host_t host, msg_task_t task);
179 XBT_PRIVATE void MSG_host_del_task(msg_host_t host, msg_task_t task);
181 /********** Tracing **********/
182 /* declaration of instrumentation functions from msg_task_instr.c */
183 XBT_PRIVATE void TRACE_msg_set_task_category(msg_task_t task, const char *category);
184 XBT_PRIVATE void TRACE_msg_task_create(msg_task_t task);
185 XBT_PRIVATE void TRACE_msg_task_execute_start(msg_task_t task);
186 XBT_PRIVATE void TRACE_msg_task_execute_end(msg_task_t task);
187 XBT_PRIVATE void TRACE_msg_task_destroy(msg_task_t task);
188 XBT_PRIVATE void TRACE_msg_task_get_end(double start_time, msg_task_t task);
189 XBT_PRIVATE void TRACE_msg_task_get_start(void);
190 XBT_PRIVATE int TRACE_msg_task_put_start(msg_task_t task); //returns TRUE if the task_put_end must be called
191 XBT_PRIVATE void TRACE_msg_task_put_end(void);
193 /* declaration of instrumentation functions from msg_process_instr.c */
194 XBT_PRIVATE char *instr_process_id (msg_process_t proc, char *str, int len);
195 XBT_PRIVATE char *instr_process_id_2 (const char *process_name, int process_pid, char *str, int len);
196 XBT_PRIVATE void TRACE_msg_process_change_host(msg_process_t process, msg_host_t old_host,
197 msg_host_t new_host);
198 XBT_PRIVATE void TRACE_msg_process_create (const char *process_name, int process_pid, msg_host_t host);
199 XBT_PRIVATE void TRACE_msg_process_destroy (const char *process_name, int process_pid);
200 XBT_PRIVATE void TRACE_msg_process_kill(smx_process_exit_status_t status, msg_process_t process);
201 XBT_PRIVATE void TRACE_msg_process_suspend(msg_process_t process);
202 XBT_PRIVATE void TRACE_msg_process_resume(msg_process_t process);
203 XBT_PRIVATE void TRACE_msg_process_sleep_in(msg_process_t process); //called from msg/gos.c
204 XBT_PRIVATE void TRACE_msg_process_sleep_out(msg_process_t process);
206 /* declaration of instrumentation functions from instr_msg_vm.c */
207 XBT_PRIVATE char *instr_vm_id(msg_vm_t vm, char *str, int len);
208 XBT_PRIVATE char *instr_vm_id_2(const char *vm_name, char *str, int len);
209 XBT_PRIVATE void TRACE_msg_vm_change_host(msg_vm_t vm, msg_host_t old_host,
210 msg_host_t new_host);
211 XBT_PRIVATE void TRACE_msg_vm_start(msg_vm_t vm);
212 XBT_PRIVATE void TRACE_msg_vm_create(const char *vm_name, msg_host_t host);
213 XBT_PRIVATE void TRACE_msg_vm_kill(msg_vm_t process);
214 XBT_PRIVATE void TRACE_msg_vm_suspend(msg_vm_t vm);
215 XBT_PRIVATE void TRACE_msg_vm_resume(msg_vm_t vm);
216 XBT_PRIVATE void TRACE_msg_vm_save(msg_vm_t vm);
217 XBT_PRIVATE void TRACE_msg_vm_restore(msg_vm_t vm);
218 XBT_PRIVATE void TRACE_msg_vm_end(msg_vm_t vm);