#include "private.h"
#include "xbt/sysdep.h"
#include "xbt/log.h"
-#include "xbt/ex.h" /* ex_backtrace_display */
+#include "xbt/str.h"
+#include "xbt/ex.h" /* ex_backtrace_display */
+XBT_LOG_EXTERNAL_CATEGORY(simix);
+XBT_LOG_EXTERNAL_CATEGORY(simix_action);
+XBT_LOG_EXTERNAL_CATEGORY(simix_deployment);
+XBT_LOG_EXTERNAL_CATEGORY(simix_environment);
+XBT_LOG_EXTERNAL_CATEGORY(simix_host);
+XBT_LOG_EXTERNAL_CATEGORY(simix_process);
+XBT_LOG_EXTERNAL_CATEGORY(simix_synchro);
+XBT_LOG_EXTERNAL_CATEGORY(simix_context);
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
- "Logging specific to SIMIX (kernel)");
-
-int __stop_time = -1.0 ;
+ "Logging specific to SIMIX (kernel)");
SIMIX_Global_t simix_global = NULL;
-/** \defgroup simix_simulation SIMIX simulation Functions
- * \brief This section describes the functions you need to know to
- * set up a simulation. You should have a look at \ref SIMIX_examples
- * to have an overview of their usage.
- * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Simulation functions" --> \endhtmlonly
- */
-
-/********************************* SIMIX **************************************/
+/* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
+#include <signal.h>
-/** \ingroup simix_simulation
- * \brief Initialize some SIMIX internal data.
- */
-void SIMIX_global_init_args(int *argc, char **argv)
+static void _XBT_CALL inthandler(int ignored)
{
- SIMIX_global_init(argc,argv);
+ INFO0("CTRL-C pressed. Displaying status and bailing out");
+ SIMIX_display_process_status();
+ exit(1);
}
-/** \ingroup simix_simulation
- * \brief Initialize some SIMIX internal data.
+/********************************* SIMIX **************************************/
+
+/**
+ * \brief Initialize SIMIX internal data.
+ *
+ * \param argc Argc
+ * \param argv Argv
*/
void SIMIX_global_init(int *argc, char **argv)
{
- s_smx_process_t proc;
-
- if (!simix_global) {
- surf_init(argc, argv); /* Initialize some common structures. Warning, it sets msg_global=NULL */
-
- simix_global = xbt_new0(s_SIMIX_Global_t,1);
-
- xbt_context_init();
- simix_global->host = xbt_fifo_new();
- simix_global->process_to_run = xbt_swag_new(xbt_swag_offset(proc,process_hookup));
- simix_global->process_list = xbt_swag_new(xbt_swag_offset(proc,process_hookup));
- simix_global->current_process = NULL;
- simix_global->registered_functions = xbt_dict_new();
- }
+ s_smx_process_t proc;
+
+ if (!simix_global) {
+ /* Connect our log channels: that must be done manually under windows */
+ XBT_LOG_CONNECT(simix_action, simix);
+ XBT_LOG_CONNECT(simix_deployment, simix);
+ XBT_LOG_CONNECT(simix_environment, simix);
+ XBT_LOG_CONNECT(simix_host, simix);
+ XBT_LOG_CONNECT(simix_kernel, simix);
+ XBT_LOG_CONNECT(simix_process, simix);
+ XBT_LOG_CONNECT(simix_synchro, simix);
+ XBT_LOG_CONNECT(simix_context, simix);
+
+ simix_global = xbt_new0(s_SIMIX_Global_t, 1);
+
+ simix_global->host = xbt_dict_new();
+ simix_global->process_to_run =
+ xbt_swag_new(xbt_swag_offset(proc, synchro_hookup));
+ simix_global->process_list =
+ xbt_swag_new(xbt_swag_offset(proc, process_hookup));
+ simix_global->process_to_destroy =
+ xbt_swag_new(xbt_swag_offset(proc, destroy_hookup));
+
+ simix_global->current_process = NULL;
+ simix_global->maestro_process = NULL;
+ simix_global->registered_functions = xbt_dict_new();
+
+ simix_global->create_process_function = NULL;
+ simix_global->kill_process_function = NULL;
+ simix_global->cleanup_process_function = SIMIX_process_cleanup;
+
+ SIMIX_context_mod_init();
+ __SIMIX_create_maestro_process();
+
+ /* Prepare to display some more info when dying on Ctrl-C pressing */
+ signal(SIGINT, inthandler);
+ surf_init(argc, argv); /* Initialize SURF structures */
+ }
}
/* Debug purpose, incomplete */
-void __SIMIX_display_process_status(void)
+void SIMIX_display_process_status(void)
{
- smx_process_t process = NULL;
- //xbt_fifo_item_t item = NULL;
- //int i;
- int nbprocess=xbt_swag_size(simix_global->process_list);
-
- INFO1("SIMIX: %d processes are still running, waiting for something.",
- nbprocess);
- /* List the process and their state */
- INFO0("SIMIX: <process> on <host>: <status>.");
- xbt_swag_foreach(process, simix_global->process_list) {
- simdata_process_t p_simdata = (simdata_process_t) process->simdata;
- // simdata_host_t h_simdata=(simdata_host_t)p_simdata->host->simdata;
- char *who;
-
- asprintf(&who,"SIMIX: %s on %s: %s",
- process->name,
- p_simdata->host->name,
- (process->simdata->blocked)?"[blocked] "
- :((process->simdata->suspended)?"[suspended] ":""));
-
+ smx_process_t process = NULL;
+ xbt_fifo_item_t item = NULL;
+ smx_action_t act;
+ int nbprocess = xbt_swag_size(simix_global->process_list);
+
+ INFO1("%d processes are still running, waiting for something.", nbprocess);
+ /* List the process and their state */
+ INFO0
+ ("Legend of the following listing: \"<process> on <host>: <status>.\"");
+ xbt_swag_foreach(process, simix_global->process_list) {
+ char *who, *who2;
+
+ asprintf(&who, "%s on %s: %s",
+ process->name,
+ process->smx_host->name,
+ (process->blocked) ? "[BLOCKED] "
+ : ((process->suspended) ? "[SUSPENDED] " : ""));
+
+ if (process->mutex) {
+ who2 =
+ bprintf("%s Blocked on mutex %p", who,
+ (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
+ process->mutex : (void *) 0xdead);
+ free(who);
+ who = who2;
+ } else if (process->cond) {
+ who2 =
+ bprintf
+ ("%s Blocked on condition %p; Waiting for the following actions:",
+ who,
+ (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
+ process->cond : (void *) 0xdead);
free(who);
- }
+ who = who2;
+ xbt_fifo_foreach(process->cond->actions, item, act, smx_action_t) {
+ who2 =
+ bprintf("%s '%s'(%p)", who, act->name,
+ (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose))
+ ? act : (void *) 0xdead);
+ free(who);
+ who = who2;
+ }
+ } else {
+ who2 =
+ bprintf
+ ("%s Blocked in an unknown status (please report this bug)", who);
+ free(who);
+ who = who2;
+ }
+ INFO1("%s.", who);
+ free(who);
+ }
}
-/* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
-#include <signal.h>
-
-static void _XBT_CALL inthandler(int ignored)
-{
- INFO0("CTRL-C pressed. Displaying status and bailing out");
- __SIMIX_display_process_status();
- exit(1);
-}
-/** \ingroup msg_simulation
- * \brief Launch the SIMIX simulation
+/**
+ * \brief Launch the SIMIX simulation, debug purpose
*/
-SIMIX_error_t SIMIX_main(void)
+void __SIMIX_main(void)
{
- smx_process_t process = NULL;
- smx_cond_t cond = NULL;
- int i;
- double elapsed_time = 0.0;
- int state_modifications = 1;
-
- /* Prepare to display some more info when dying on Ctrl-C pressing */
- signal(SIGINT,inthandler);
-
- /* Clean IO before the run */
- fflush(stdout);
- fflush(stderr);
-
- surf_solve(); /* Takes traces into account. Returns 0.0 */
- /* xbt_fifo_size(msg_global->process_to_run) */
- while (1) {
- xbt_context_empty_trash();
- if(xbt_swag_size(simix_global->process_to_run) && (elapsed_time>0)) {
- DEBUG0("**************************************************");
- }
-
- if((__stop_time>0) && (SIMIX_get_clock() >= __stop_time)) {
- DEBUG0("Let's stop here!");
- }
-
- while ((process = xbt_swag_extract(simix_global->process_to_run))) {
- DEBUG2("Scheduling %s on %s",
- process->name,
- process->simdata->host->name);
- simix_global->current_process = process;
- xbt_context_schedule(process->simdata->context);
- /* fflush(NULL); */
- simix_global->current_process = NULL;
- }
-
- {
- surf_action_t action = NULL;
- surf_resource_t resource = NULL;
- smx_action_t smx_action = NULL;
-
- void *fun = NULL;
- void *arg = NULL;
-
- xbt_dynar_foreach(resource_list, i, resource) {
- if(xbt_swag_size(resource->common_public->states.failed_action_set) ||
- xbt_swag_size(resource->common_public->states.done_action_set))
- state_modifications = 1;
- }
-
- if(!state_modifications) {
- DEBUG1("%f : Calling surf_solve",SIMIX_get_clock());
- elapsed_time = surf_solve();
- DEBUG1("Elapsed_time %f",elapsed_time);
-
- if (elapsed_time<0.0) {
- /* fprintf(stderr, "We're done %g\n",elapsed_time); */
- break;
- }
- }
-
- while (surf_timer_resource->extension_public->get(&fun,(void*)&arg)) {
- DEBUG2("got %p %p", fun, arg);
- if(fun==SIMIX_process_create_with_arguments) {
- process_arg_t args = arg;
- DEBUG2("Launching %s on %s", args->name, args->host->name);
- process = SIMIX_process_create_with_arguments(args->name, args->code,
- args->data, args->host,
- args->argc,args->argv);
- if(args->kill_time > SIMIX_get_clock()) {
- surf_timer_resource->extension_public->set(args->kill_time,
- (void*) &SIMIX_process_kill,
- (void*) process);
- }
- xbt_free(args);
- }
- if(fun==SIMIX_process_kill) {
- process = arg;
- DEBUG2("Killing %s on %s", process->name,
- process->simdata->host->name);
- SIMIX_process_kill(process);
- }
- }
-
- /* Wake up all process waiting for the action finish */
- xbt_dynar_foreach(resource_list, i, resource) {
- while ((action =
- xbt_swag_extract(resource->common_public->states.
- failed_action_set))) {
- smx_action = action->data;
- if (smx_action) {
- xbt_fifo_item_t _cursor;
-
- DEBUG1("** %s failed **",smx_action->name);
- xbt_fifo_foreach(smx_action->simdata->cond_list,_cursor,cond,smx_cond_t) {
- SIMIX_cond_broadcast(cond);
- xbt_swag_foreach(process,cond->sleeping) {
- DEBUG2("\t preparing to wake up %s on %s",
- process->name, process->simdata->host->name);
- }
- }
- process=NULL;
- }
- }
- while ((action =
- xbt_swag_extract(resource->common_public->states.
- done_action_set))) {
- smx_action = action->data;
- if (smx_action) {
- xbt_fifo_item_t _cursor;
-
- DEBUG1("** %s done **",smx_action->name);
- xbt_fifo_foreach(smx_action->simdata->cond_list,_cursor,cond,smx_cond_t) {
- SIMIX_cond_broadcast(cond);
- xbt_swag_foreach(process,cond->sleeping) {
- DEBUG2("\t preparing to wake up %s on %s",
- process->name, process->simdata->host->name);
- }
- }
- process=NULL;
- }
-
- }
- }
- }
- state_modifications = 0;
- }
-
- if (xbt_swag_size(simix_global->process_list) == 0) {
- INFO0("Congratulations ! Simulation terminated : all processes are over");
- return SIMIX_OK;
- } else {
- INFO0("Oops ! Deadlock or code not perfectly clean.");
- __SIMIX_display_process_status();
- if(XBT_LOG_ISENABLED(simix, xbt_log_priority_debug) ||
- XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
- DEBUG0("Aborting!");
- xbt_abort();
- }
-
- INFO0("Return a Warning.");
- return SIMIX_WARNING;
- }
+ smx_process_t process = NULL;
+ smx_cond_t cond = NULL;
+ smx_action_t smx_action;
+ xbt_fifo_t actions_done = xbt_fifo_new();
+ xbt_fifo_t actions_failed = xbt_fifo_new();
+
+ /* Clean IO before the run */
+ fflush(stdout);
+ fflush(stderr);
+
+ //surf_solve(); /* Takes traces into account. Returns 0.0 */
+ /* xbt_fifo_size(msg_global->process_to_run) */
+
+ while (SIMIX_solve(actions_done, actions_failed) != -1.0) {
+
+ while ((smx_action = xbt_fifo_pop(actions_failed))) {
+
+ xbt_fifo_item_t _cursor;
+
+ DEBUG1("** %s failed **", smx_action->name);
+ xbt_fifo_foreach(smx_action->cond_list, _cursor, cond, smx_cond_t) {
+ xbt_swag_foreach(process, cond->sleeping) {
+ DEBUG2("\t preparing to wake up %s on %s",
+ process->name, process->smx_host->name);
+ }
+ SIMIX_cond_broadcast(cond);
+ /* remove conditional from action */
+ SIMIX_unregister_action_to_condition(smx_action, cond);
+ }
+ }
+
+ while ((smx_action = xbt_fifo_pop(actions_done))) {
+ xbt_fifo_item_t _cursor;
+
+ DEBUG1("** %s done **", smx_action->name);
+ xbt_fifo_foreach(smx_action->cond_list, _cursor, cond, smx_cond_t) {
+ xbt_swag_foreach(process, cond->sleeping) {
+ DEBUG2("\t preparing to wake up %s on %s",
+ process->name, process->smx_host->name);
+ }
+ SIMIX_cond_broadcast(cond);
+ /* remove conditional from action */
+ SIMIX_unregister_action_to_condition(smx_action, cond);
+ }
+ }
+ }
+ return;
}
-/** \ingroup msg_simulation
+/**
* \brief Kill all running process
-
- * \param reset_PIDs should we reset the PID numbers. A negative
- * number means no reset and a positive number will be used to set the PID
- * of the next newly created process.
+ *
*/
void SIMIX_process_killall()
{
smx_process_t p = NULL;
smx_process_t self = SIMIX_process_self();
- while((p=xbt_swag_extract(simix_global->process_list))) {
- if(p!=self) SIMIX_process_kill(p);
+ while ((p = xbt_swag_extract(simix_global->process_list))) {
+ if (p != self)
+ SIMIX_process_kill(p);
}
- xbt_context_empty_trash();
+ SIMIX_process_empty_trash();
- if(self) {
- xbt_context_yield();
+ if (self != simix_global->maestro_process) {
+ __SIMIX_process_yield();
}
return;
}
-/** \ingroup msg_simulation
+/**
* \brief Clean the SIMIX simulation
+ *
+ * This functions remove the memory used by SIMIX
*/
-SIMIX_error_t SIMIX_clean(void)
+void SIMIX_clean(void)
{
- xbt_fifo_item_t i = NULL;
- smx_host_t h = NULL;
- smx_process_t p = NULL;
+ /* Kill everyone (except maestro) */
+ SIMIX_process_killall();
-
- while((p=xbt_swag_extract(simix_global->process_list))) {
- SIMIX_process_kill(p);
- }
- xbt_context_exit();
-
- xbt_fifo_foreach(simix_global->host,i,h,smx_host_t) {
- __SIMIX_host_destroy(h);
- }
- xbt_fifo_free(simix_global->host);
+ /* Free the remaining data structures*/
xbt_swag_free(simix_global->process_to_run);
+ xbt_swag_free(simix_global->process_to_destroy);
xbt_swag_free(simix_global->process_list);
+ simix_global->process_list = NULL;
xbt_dict_free(&(simix_global->registered_functions));
- simix_config_finalize();
- free(simix_global);
+ xbt_dict_free(&(simix_global->host));
+
+ /* Let's free maestro now */
+ SIMIX_context_free(simix_global->maestro_process->context);
+ free(simix_global->maestro_process);
+
+ /* Finish context module and SURF */
+ SIMIX_context_mod_exit();
surf_exit();
- return SIMIX_OK;
+ free(simix_global);
+ simix_global = NULL;
+
+ return;
}
-/** \ingroup msg_easier_life
+/**
* \brief A clock (in second).
+ *
+ * \return Return the clock.
*/
-double SIMIX_get_clock(void) {
+double SIMIX_get_clock(void)
+{
return surf_get_clock();
}
+
+/**
+ * \brief Finish the simulation initialization
+ *
+ * Must be called before the first call to SIMIX_solve()
+ */
+void SIMIX_init(void)
+{
+ surf_presolve();
+}
+
+/**
+ * \brief Does a turn of the simulation
+ *
+ * Executes a step in the surf simulation, adding to the two lists all the actions that finished on this turn. Schedules all processus in the process_to_run list.
+ * \param actions_done List of actions done
+ * \param actions_failed List of actions failed
+ * \return The time spent to execute the simulation or -1 if the simulation ended
+ */
+double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
+{
+
+ smx_process_t process = NULL;
+ unsigned int iter;
+ double elapsed_time = 0.0;
+ static int state_modifications = 1;
+
+ SIMIX_process_empty_trash();
+ if (xbt_swag_size(simix_global->process_to_run) && (elapsed_time > 0)) {
+ DEBUG0("**************************************************");
+ }
+
+ while ((process = xbt_swag_extract(simix_global->process_to_run))) {
+ DEBUG2("Scheduling %s on %s", process->name, process->smx_host->name);
+ __SIMIX_process_schedule(process);
+ }
+
+ {
+ surf_action_t action = NULL;
+ surf_model_t model = NULL;
+ smx_action_t smx_action = NULL;
+
+ void *fun = NULL;
+ void *arg = NULL;
+
+ xbt_dynar_foreach(model_list, iter, model) {
+ if (xbt_swag_size(model->states.failed_action_set)
+ || xbt_swag_size(model->states.done_action_set)) {
+ state_modifications = 1;
+ break;
+ }
+ }
+
+ if (!state_modifications) {
+ DEBUG1("%f : Calling surf_solve", SIMIX_get_clock());
+ elapsed_time = surf_solve();
+ DEBUG1("Elapsed_time %f", elapsed_time);
+ }
+
+ while (surf_timer_model->extension.timer.get(&fun, (void *) &arg)) {
+ DEBUG2("got %p %p", fun, arg);
+ if (fun == SIMIX_process_create) {
+ smx_process_arg_t args = arg;
+ DEBUG2("Launching %s on %s", args->name, args->hostname);
+ process = SIMIX_process_create(args->name, args->code,
+ args->data, args->hostname,
+ args->argc, args->argv,
+ args->properties);
+ if (process && args->kill_time > SIMIX_get_clock()) {
+ surf_timer_model->extension.timer.set(args->kill_time, (void *)
+ &SIMIX_process_kill,
+ (void *) process);
+ }
+ xbt_free(args);
+ }
+ if (fun == SIMIX_process_kill) {
+ process = arg;
+ DEBUG2("Killing %s on %s", process->name,
+ process->smx_host->name);
+ SIMIX_process_kill(process);
+ }
+ }
+
+ /* Wake up all process waiting for the action finish */
+ xbt_dynar_foreach(model_list, iter, model) {
+ while ((action = xbt_swag_extract(model->states.failed_action_set))) {
+ smx_action = action->data;
+ if (smx_action) {
+ xbt_fifo_unshift(actions_failed, smx_action);
+ }
+ }
+ while ((action = xbt_swag_extract(model->states.done_action_set))) {
+ smx_action = action->data;
+ if (smx_action) {
+ xbt_fifo_unshift(actions_done, smx_action);
+ }
+ }
+ }
+ }
+ state_modifications = 0;
+
+ if (elapsed_time == -1) {
+ if (xbt_swag_size(simix_global->process_list) == 0) {
+/* INFO0("Congratulations ! Simulation terminated : all processes are over"); */
+ } else {
+ INFO0("Oops ! Deadlock or code not perfectly clean.");
+ SIMIX_display_process_status();
+ if (XBT_LOG_ISENABLED(simix, xbt_log_priority_debug) ||
+ XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_debug)) {
+ DEBUG0("Aborting!");
+ xbt_abort();
+ }
+ INFO0("Return a Warning.");
+ }
+ }
+ return elapsed_time;
+}
+
+/**
+ * \brief Set the date to execute a function
+ *
+ * Set the date to execute the function on the surf.
+ * \param date Date to execute function
+ * \param function Function to be executed
+ * \param arg Parameters of the function
+ *
+ */
+void SIMIX_timer_set(double date, void *function, void *arg)
+{
+ surf_timer_model->extension.timer.set(date, function, arg);
+}
+
+int SIMIX_timer_get(void **function, void **arg)
+{
+ return surf_timer_model->extension.timer.get(function, arg);
+}
+
+/**
+ * \brief Registers a function to create a process.
+ *
+ * This function registers an user function to be called when a new process is created. The user function have to call the SIMIX_create_process function.
+ * \param function Create process function
+ *
+ */
+void SIMIX_function_register_process_create(smx_creation_func_t function)
+{
+ xbt_assert0((simix_global->create_process_function == NULL),
+ "Data already set");
+
+ simix_global->create_process_function = function;
+}
+
+/**
+ * \brief Registers a function to kill a process.
+ *
+ * This function registers an user function to be called when a new process is killed. The user function have to call the SIMIX_kill_process function.
+ * \param function Kill process function
+ *
+ */
+void SIMIX_function_register_process_kill(void_f_pvoid_t function)
+{
+ xbt_assert0((simix_global->kill_process_function == NULL),
+ "Data already set");
+
+ simix_global->kill_process_function = function;
+}
+
+/**
+ * \brief Registers a function to cleanup a process.
+ *
+ * This function registers an user function to be called when a new process ends properly.
+ * \param function cleanup process function
+ *
+ */
+void SIMIX_function_register_process_cleanup(void_f_pvoid_t function)
+{
+ simix_global->cleanup_process_function = function;
+}
