1 /* Copyright (c) 2007, 2008, 2009, 2010. 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 #include "smx_private.h"
9 #include "xbt/sysdep.h"
12 #include "xbt/ex.h" /* ex_backtrace_display */
15 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
17 "Logging specific to SIMIX (kernel)");
19 smx_global_t simix_global = NULL;
20 static xbt_heap_t simix_timers = NULL;
22 static void* SIMIX_action_mallocator_new_f(void);
23 static void SIMIX_action_mallocator_free_f(void* action);
24 static void SIMIX_action_mallocator_reset_f(void* action);
26 extern void smx_ctx_raw_new_sr(void);
28 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
31 int _surf_do_verbose_exit = 1;
32 static void _XBT_CALL inthandler(int ignored)
34 if ( _surf_do_verbose_exit ) {
35 XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
36 SIMIX_display_process_status();
39 XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit is disabled");
44 /********************************* SIMIX **************************************/
46 XBT_INLINE double SIMIX_timer_next(void)
48 return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
52 * \brief Initialize SIMIX internal data.
57 void SIMIX_global_init(int *argc, char **argv)
62 simix_global = xbt_new0(s_smx_global_t, 1);
64 simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
65 simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
66 simix_global->process_list =
67 xbt_swag_new(xbt_swag_offset(proc, process_hookup));
68 simix_global->process_to_destroy =
69 xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
71 simix_global->maestro_process = NULL;
72 simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
74 simix_global->create_process_function = SIMIX_process_create;
75 simix_global->kill_process_function = SIMIX_process_kill;
76 simix_global->cleanup_process_function = SIMIX_process_cleanup;
77 simix_global->action_mallocator = xbt_mallocator_new(65536,
78 SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
79 SIMIX_action_mallocator_reset_f);
81 surf_init(argc, argv); /* Initialize SURF structures */
82 SIMIX_context_mod_init();
83 SIMIX_create_maestro_process();
85 /* context exception handlers */
86 __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
87 __xbt_ex_terminate = SIMIX_process_exception_terminate;
89 /* Initialize the SIMIX network module */
92 /* Prepare to display some more info when dying on Ctrl-C pressing */
93 signal(SIGINT, inthandler);
96 simix_timers = xbt_heap_new(8, &free);
99 XBT_DEBUG("ADD SIMIX LEVELS");
100 SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
104 * \brief Clean the SIMIX simulation
106 * This functions remove the memory used by SIMIX
108 void SIMIX_clean(void)
111 smx_ctx_raw_new_sr();
114 /* Kill everyone (except maestro) */
115 SIMIX_process_killall(simix_global->maestro_process);
117 /* Exit the SIMIX network module */
118 SIMIX_network_exit();
120 xbt_heap_free(simix_timers);
122 /* Free the remaining data structures */
123 xbt_dynar_free(&simix_global->process_to_run);
124 xbt_dynar_free(&simix_global->process_that_ran);
125 xbt_swag_free(simix_global->process_to_destroy);
126 xbt_swag_free(simix_global->process_list);
127 simix_global->process_list = NULL;
128 simix_global->process_to_destroy = NULL;
129 xbt_dict_free(&(simix_global->registered_functions));
131 /* Let's free maestro now */
132 SIMIX_context_free(simix_global->maestro_process->context);
133 xbt_free(simix_global->maestro_process->running_ctx);
134 xbt_free(simix_global->maestro_process);
135 simix_global->maestro_process = NULL;
137 /* Restore the default exception setup */
138 __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
139 __xbt_ex_terminate = &__xbt_ex_terminate_default;
141 /* Finish context module and SURF */
142 SIMIX_context_mod_exit();
146 xbt_mallocator_free(simix_global->action_mallocator);
147 xbt_free(simix_global);
155 * \brief A clock (in second).
157 * \return Return the clock.
159 XBT_INLINE double SIMIX_get_clock(void)
162 return MC_process_clock_get(SIMIX_process_self());
164 return surf_get_clock();
168 static int process_syscall_color(void *p)
170 switch ((*(smx_process_t *)p)->simcall.call) {
172 case SIMCALL_PROCESS_KILL:
174 case SIMCALL_PROCESS_RESUME:
184 smx_process_t process;
186 surf_action_t action;
192 XBT_DEBUG("New Schedule Round; size(queue)=%lu",
193 xbt_dynar_length(simix_global->process_to_run));
195 smx_ctx_raw_new_sr();
197 while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
198 XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
199 xbt_dynar_length(simix_global->process_to_run));
201 /* Run all processes that are ready to run, possibly in parallel */
202 SIMIX_process_runall();
204 /* Move all killing processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
205 xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
207 /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
209 /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
211 /* Here, the order is ok because:
212 * - if there is no kill during the simulation, processes remain sorted according by their PID.
213 * rational: This can be proved inductively.
214 * Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
215 * Let's show that it is still so at the end of this round.
216 * - if a process is added when being created, that's from maestro. It can be either at startup
217 * time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
218 * in arbitrary order (inductive hypothesis), we are fine.
219 * - If a process is added because it's getting killed, its subsequent actions shouldn't matter
220 * - If a process gets added to process_to_run because one of their blocking action constituting the meat
221 * of a simcall terminates, we're still good. Proof:
222 * - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
223 * kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
224 * - For communications, this function is called from SIMIX_comm_finish().
225 * This function itself don't mess with the order since simcalls are handled in FIFO order.
226 * The function is called:
227 * - before the comm starts (invalid parameters, or resource already dead or whatever).
228 * The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
229 * - because the communication failed or were canceled after startup. In this case, it's called from the function
230 * we are in, by the chunk:
231 * set = model->states.failed_action_set;
232 * while ((action = xbt_swag_extract(set)))
233 * SIMIX_simcall_post((smx_action_t) action->data);
234 * This order is also fixed because it depends of the order in which the surf actions were
235 * added to the system, and only maestro can add stuff this way, through simcalls.
236 * We thus use the inductive hypothesis once again to conclude that the order in which actions are
237 * poped out of the swag does not depend on the user code's execution order.
238 * - because the communication terminated. In this case, actions are served in the order given by
239 * set = model->states.done_action_set;
240 * while ((action = xbt_swag_extract(set)))
241 * SIMIX_simcall_post((smx_action_t) action->data);
242 * and the argument is very similar to the previous one.
243 * So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
244 * 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.
245 * So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
246 * - If there is some process killings, the order is changed by this decision that comes from user-land
247 * But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
248 * So, even the order change induced by the process killing is perfectly reproducible.
250 * So science works, bitches [http://xkcd.com/54/].
252 * We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
253 * (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
254 * That would thus be a pure waste of time.
257 xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
258 if (process->simcall.call != SIMCALL_NONE) {
259 SIMIX_simcall_pre(&process->simcall, 0);
264 time = SIMIX_timer_next();
265 if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
266 time = surf_solve(time);
268 /* Notify all the hosts that have failed */
269 /* FIXME: iterate through the list of failed host and mark each of them */
270 /* as failed. On each host, signal all the running processes with host_fail */
272 /* Handle any pending timer */
273 while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
274 //FIXME: make the timers being real callbacks
275 // (i.e. provide dispatchers that read and expand the args)
276 timer = xbt_heap_pop(simix_timers);
278 ((void (*)(void*))timer->func)(timer->args);
280 /* Wake up all processes waiting for a Surf action to finish */
281 xbt_dynar_foreach(model_list, iter, model) {
282 set = model->states.failed_action_set;
283 while ((action = xbt_swag_extract(set)))
284 SIMIX_simcall_post((smx_action_t) action->data);
285 set = model->states.done_action_set;
286 while ((action = xbt_swag_extract(set)))
287 SIMIX_simcall_post((smx_action_t) action->data);
290 /* Clean processes to destroy */
291 SIMIX_process_empty_trash();
293 } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
295 if (xbt_swag_size(simix_global->process_list) != 0) {
301 XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
302 SIMIX_display_process_status();
308 * \brief Set the date to execute a function
310 * Set the date to execute the function on the surf.
311 * \param date Date to execute function
312 * \param function Function to be executed
313 * \param arg Parameters of the function
316 XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
318 smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
321 timer->func = function;
323 xbt_heap_push(simix_timers, timer, date);
327 * \brief Registers a function to create a process.
329 * This function registers a function to be called
330 * when a new process is created. The function has
331 * to call SIMIX_process_create().
332 * \param function create process function
334 XBT_INLINE void SIMIX_function_register_process_create(smx_creation_func_t
337 simix_global->create_process_function = function;
341 * \brief Registers a function to kill a process.
343 * This function registers a function to be called when a
344 * process is killed. The function has to call the SIMIX_process_kill().
346 * \param function Kill process function
348 XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_t
351 simix_global->kill_process_function = function;
355 * \brief Registers a function to cleanup a process.
357 * This function registers a user function to be called when
358 * a process ends properly.
360 * \param function cleanup process function
362 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
365 simix_global->cleanup_process_function = function;
369 void SIMIX_display_process_status(void)
371 if (simix_global->process_list == NULL) {
375 smx_process_t process = NULL;
376 int nbprocess = xbt_swag_size(simix_global->process_list);
378 XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
379 /* List the process and their state */
381 ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
382 xbt_swag_foreach(process, simix_global->process_list) {
384 if (process->waiting_action) {
386 const char* action_description = "unknown";
387 switch (process->waiting_action->type) {
389 case SIMIX_ACTION_EXECUTE:
390 action_description = "execution";
393 case SIMIX_ACTION_PARALLEL_EXECUTE:
394 action_description = "parallel execution";
397 case SIMIX_ACTION_COMMUNICATE:
398 action_description = "communication";
401 case SIMIX_ACTION_SLEEP:
402 action_description = "sleeping";
405 case SIMIX_ACTION_SYNCHRO:
406 action_description = "synchronization";
409 case SIMIX_ACTION_IO:
410 action_description = "I/O";
413 XBT_INFO("Process %lu (%s@%s): waiting for %s action %p (%s) in state %d to finish",
414 process->pid, process->name, process->smx_host->name,
415 action_description, process->waiting_action,
416 process->waiting_action->name, (int)process->waiting_action->state);
419 XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, process->smx_host->name);
424 static void* SIMIX_action_mallocator_new_f(void) {
425 smx_action_t action = xbt_new(s_smx_action_t, 1);
426 action->simcalls = xbt_fifo_new();
430 static void SIMIX_action_mallocator_free_f(void* action) {
431 xbt_fifo_free(((smx_action_t) action)->simcalls);
435 static void SIMIX_action_mallocator_reset_f(void* action) {
437 // we also recycle the simcall list
438 xbt_fifo_t fifo = ((smx_action_t) action)->simcalls;
439 xbt_fifo_reset(fifo);
440 memset(action, 0, sizeof(s_smx_action_t));
441 ((smx_action_t) action)->simcalls = fifo;