1 /* Copyright (c) 2007-2012. 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 #include "smx_private.h"
8 #include "xbt/sysdep.h"
11 #include "xbt/ex.h" /* ex_backtrace_display */
14 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
16 "Logging specific to SIMIX (kernel)");
18 smx_global_t simix_global = NULL;
19 static xbt_heap_t simix_timers = NULL;
21 static void* SIMIX_action_mallocator_new_f(void);
22 static void SIMIX_action_mallocator_free_f(void* action);
23 static void SIMIX_action_mallocator_reset_f(void* action);
25 static void SIMIX_clean(void);
27 SIMCALL_LIST(SIMCALL_RES_GETSET, SIMCALL_SEP_NOTHING)
28 SIMCALL_LIST(SIMCALL_ARG_GETSET, SIMCALL_SEP_NOTHING)
30 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
33 int _surf_do_verbose_exit = 1;
34 static void _XBT_CALL inthandler(int ignored)
36 if ( _surf_do_verbose_exit ) {
37 XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
38 SIMIX_display_process_status();
41 XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit is disabled");
46 /********************************* SIMIX **************************************/
48 XBT_INLINE double SIMIX_timer_next(void)
50 return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
55 * \brief Initialize SIMIX internal data.
60 void SIMIX_global_init(int *argc, char **argv)
65 simix_global = xbt_new0(s_smx_global_t, 1);
67 #ifdef TIME_BENCH_AMDAHL
68 simix_global->timer_seq = xbt_os_timer_new();
69 simix_global->timer_par = xbt_os_timer_new();
70 xbt_os_timer_start(simix_global->timer_seq);
72 simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
73 simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
74 simix_global->process_list =
75 xbt_swag_new(xbt_swag_offset(proc, process_hookup));
76 simix_global->process_to_destroy =
77 xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
79 simix_global->maestro_process = NULL;
80 simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
82 simix_global->create_process_function = SIMIX_process_create;
83 simix_global->kill_process_function = SIMIX_process_kill;
84 simix_global->cleanup_process_function = SIMIX_process_cleanup;
85 simix_global->action_mallocator = xbt_mallocator_new(65536,
86 SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
87 SIMIX_action_mallocator_reset_f);
88 simix_global->autorestart = SIMIX_host_restart_processes;
90 surf_init(argc, argv); /* Initialize SURF structures */
91 SIMIX_context_mod_init();
92 SIMIX_create_maestro_process();
94 /* context exception handlers */
95 __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
96 __xbt_ex_terminate = SIMIX_process_exception_terminate;
100 /* Prepare to display some more info when dying on Ctrl-C pressing */
101 signal(SIGINT, inthandler);
103 /* register a function to be called by SURF after the environment creation */
105 sg_platf_postparse_add_cb(SIMIX_post_create_environment);
109 simix_timers = xbt_heap_new(8, &free);
112 SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
119 * \brief Clean the SIMIX simulation
121 * This functions remove the memory used by SIMIX
123 static void SIMIX_clean(void)
125 #ifdef TIME_BENCH_PER_SR
126 smx_ctx_raw_new_sr();
129 /* Kill everyone (except maestro) */
130 SIMIX_process_killall(simix_global->maestro_process);
132 /* Exit the SIMIX network module */
133 SIMIX_network_exit();
135 xbt_heap_free(simix_timers);
137 /* Free the remaining data structures */
138 xbt_dynar_free(&simix_global->process_to_run);
139 xbt_dynar_free(&simix_global->process_that_ran);
140 xbt_swag_free(simix_global->process_to_destroy);
141 xbt_swag_free(simix_global->process_list);
142 simix_global->process_list = NULL;
143 simix_global->process_to_destroy = NULL;
144 xbt_dict_free(&(simix_global->registered_functions));
146 /* Let's free maestro now */
147 SIMIX_context_free(simix_global->maestro_process->context);
148 xbt_free(simix_global->maestro_process->running_ctx);
149 xbt_free(simix_global->maestro_process);
150 simix_global->maestro_process = NULL;
152 /* Restore the default exception setup */
153 __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
154 __xbt_ex_terminate = &__xbt_ex_terminate_default;
156 /* Finish context module and SURF */
157 SIMIX_context_mod_exit();
161 #ifdef TIME_BENCH_AMDAHL
162 xbt_os_timer_stop(simix_global->timer_seq);
163 XBT_INFO("Amdhal timing informations. Sequential time: %lf; Parallel time: %lf",
164 xbt_os_timer_elapsed(simix_global->timer_seq),
165 xbt_os_timer_elapsed(simix_global->timer_par));
166 xbt_os_timer_free(simix_global->timer_seq);
167 xbt_os_timer_free(simix_global->timer_par);
170 xbt_mallocator_free(simix_global->action_mallocator);
171 xbt_free(simix_global);
180 * \brief A clock (in second).
182 * \return Return the clock.
184 XBT_INLINE double SIMIX_get_clock(void)
187 return MC_process_clock_get(SIMIX_process_self());
189 return surf_get_clock();
193 static int process_syscall_color(void *p)
195 switch ((*(smx_process_t *)p)->simcall.call) {
197 case SIMCALL_PROCESS_KILL:
199 case SIMCALL_PROCESS_RESUME:
208 * \brief Run the main simulation loop.
213 smx_process_t process;
215 surf_action_t action;
221 XBT_DEBUG("New Schedule Round; size(queue)=%lu",
222 xbt_dynar_length(simix_global->process_to_run));
223 #ifdef TIME_BENCH_PER_SR
224 smx_ctx_raw_new_sr();
226 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
227 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
228 xbt_dynar_length(simix_global->process_to_run));
230 /* Run all processes that are ready to run, possibly in parallel */
231 #ifdef TIME_BENCH_AMDAHL
232 xbt_os_timer_stop(simix_global->timer_seq);
233 xbt_os_timer_resume(simix_global->timer_par);
235 SIMIX_process_runall();
236 #ifdef TIME_BENCH_AMDAHL
237 xbt_os_timer_stop(simix_global->timer_par);
238 xbt_os_timer_resume(simix_global->timer_seq);
241 /* Move all killing processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
242 xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
244 /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
246 /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
248 /* Here, the order is ok because:
250 * Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do not impact its order.
252 * Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
254 * - if there is no kill during the simulation, processes remain sorted according by their PID.
255 * rational: This can be proved inductively.
256 * Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
257 * Let's show that it is still so at the end of this round.
258 * - if a process is added when being created, that's from maestro. It can be either at startup
259 * time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
260 * in arbitrary order (inductive hypothesis), we are fine.
261 * - If a process is added because it's getting killed, its subsequent actions shouldn't matter
262 * - If a process gets added to process_to_run because one of their blocking action constituting the meat
263 * of a simcall terminates, we're still good. Proof:
264 * - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
265 * kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
266 * - For communications, this function is called from SIMIX_comm_finish().
267 * This function itself don't mess with the order since simcalls are handled in FIFO order.
268 * The function is called:
269 * - before the comm starts (invalid parameters, or resource already dead or whatever).
270 * The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
271 * - because the communication failed or were canceled after startup. In this case, it's called from the function
272 * we are in, by the chunk:
273 * set = model->states.failed_action_set;
274 * while ((action = xbt_swag_extract(set)))
275 * SIMIX_simcall_post((smx_action_t) action->data);
276 * This order is also fixed because it depends of the order in which the surf actions were
277 * added to the system, and only maestro can add stuff this way, through simcalls.
278 * We thus use the inductive hypothesis once again to conclude that the order in which actions are
279 * poped out of the swag does not depend on the user code's execution order.
280 * - because the communication terminated. In this case, actions are served in the order given by
281 * set = model->states.done_action_set;
282 * while ((action = xbt_swag_extract(set)))
283 * SIMIX_simcall_post((smx_action_t) action->data);
284 * and the argument is very similar to the previous one.
285 * So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
286 * So, in any cases, the orders of processes within process_to_run do not depend on the order in which user processes were executed previously.
287 * So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
288 * - If there is some process killings, the order is changed by this decision that comes from user-land
289 * But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
290 * So, even the order change induced by the process killing is perfectly reproducible.
292 * So science works, bitches [http://xkcd.com/54/].
294 * We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
295 * (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
296 * That would thus be a pure waste of time.
299 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
300 if (process->simcall.call != SIMCALL_NONE) {
301 SIMIX_simcall_pre(&process->simcall, 0);
306 time = SIMIX_timer_next();
307 if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
308 time = surf_solve(time);
310 /* Notify all the hosts that have failed */
311 /* FIXME: iterate through the list of failed host and mark each of them */
312 /* as failed. On each host, signal all the running processes with host_fail */
314 /* Handle any pending timer */
315 while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
316 //FIXME: make the timers being real callbacks
317 // (i.e. provide dispatchers that read and expand the args)
318 timer = xbt_heap_pop(simix_timers);
320 ((void (*)(void*))timer->func)(timer->args);
322 /* Wake up all processes waiting for a Surf action to finish */
323 xbt_dynar_foreach(model_list, iter, model) {
324 set = model->states.failed_action_set;
325 while ((action = xbt_swag_extract(set)))
326 SIMIX_simcall_post((smx_action_t) action->data);
327 set = model->states.done_action_set;
328 while ((action = xbt_swag_extract(set)))
329 SIMIX_simcall_post((smx_action_t) action->data);
332 /* Clean processes to destroy */
333 SIMIX_process_empty_trash();
335 } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
337 if (xbt_swag_size(simix_global->process_list) != 0) {
343 XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
344 SIMIX_display_process_status();
350 * \brief Set the date to execute a function
352 * Set the date to execute the function on the surf.
353 * \param date Date to execute function
354 * \param function Function to be executed
355 * \param arg Parameters of the function
358 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
360 smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
363 timer->func = function;
365 xbt_heap_push(simix_timers, timer, date);
369 * \brief Registers a function to create a process.
371 * This function registers a function to be called
372 * when a new process is created. The function has
373 * to call SIMIX_process_create().
374 * \param function create process function
376 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
379 simix_global->create_process_function = function;
383 * \brief Registers a function to kill a process.
385 * This function registers a function to be called when a
386 * process is killed. The function has to call the SIMIX_process_kill().
388 * \param function Kill process function
390 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t_smxprocess_t
393 simix_global->kill_process_function = function;
397 * \brief Registers a function to cleanup a process.
399 * This function registers a user function to be called when
400 * a process ends properly.
402 * \param function cleanup process function
404 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
407 simix_global->cleanup_process_function = function;
411 void SIMIX_display_process_status(void)
413 if (simix_global->process_list == NULL) {
417 smx_process_t process = NULL;
418 int nbprocess = xbt_swag_size(simix_global->process_list);
420 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
421 /* List the process and their state */
423 ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
424 xbt_swag_foreach(process, simix_global->process_list) {
426 if (process->waiting_action) {
428 const char* action_description = "unknown";
429 switch (process->waiting_action->type) {
431 case SIMIX_ACTION_EXECUTE:
432 action_description = "execution";
435 case SIMIX_ACTION_PARALLEL_EXECUTE:
436 action_description = "parallel execution";
439 case SIMIX_ACTION_COMMUNICATE:
440 action_description = "communication";
443 case SIMIX_ACTION_SLEEP:
444 action_description = "sleeping";
447 case SIMIX_ACTION_SYNCHRO:
448 action_description = "synchronization";
451 case SIMIX_ACTION_IO:
452 action_description = "I/O";
454 /* **************************************/
455 /* TUTORIAL: New API */
456 case SIMIX_ACTION_NEW_API:
457 action_description = "NEW API";
458 /* **************************************/
462 XBT_INFO("Process %lu (%s@%s): waiting for %s action %p (%s) in state %d to finish",
463 process->pid, process->name, process->smx_host->name,
464 action_description, process->waiting_action,
465 process->waiting_action->name, (int)process->waiting_action->state);
468 XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, process->smx_host->name);
473 static void* SIMIX_action_mallocator_new_f(void) {
474 smx_action_t action = xbt_new(s_smx_action_t, 1);
475 action->simcalls = xbt_fifo_new();
479 static void SIMIX_action_mallocator_free_f(void* action) {
480 xbt_fifo_free(((smx_action_t) action)->simcalls);
484 static void SIMIX_action_mallocator_reset_f(void* action) {
486 // we also recycle the simcall list
487 xbt_fifo_t fifo = ((smx_action_t) action)->simcalls;
488 xbt_fifo_reset(fifo);
489 memset(action, 0, sizeof(s_smx_action_t));
490 ((smx_action_t) action)->simcalls = fifo;
493 xbt_dict_t SIMIX_pre_asr_get_properties(smx_simcall_t simcall, const char *name){
494 return SIMIX_asr_get_properties(name);
496 xbt_dict_t SIMIX_asr_get_properties(const char *name)
498 return xbt_lib_get_or_null(as_router_lib, name, ROUTING_PROP_ASR_LEVEL);