Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
argument why parallel execution don't jeopardize reproducibility even if we never...
[simgrid.git] / src / simix / smx_global.c
index f640d4b..eb2a141 100644 (file)
@@ -4,7 +4,7 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "private.h"
+#include "smx_private.h"
 #include "xbt/heap.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 #include "xbt/ex.h"             /* ex_backtrace_display */
 #include "mc/mc.h"
 
-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_CATEGORY(simix, "All SIMIX categories");
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix,
                                 "Logging specific to SIMIX (kernel)");
 
@@ -30,13 +23,21 @@ static void* SIMIX_action_mallocator_new_f(void);
 static void SIMIX_action_mallocator_free_f(void* action);
 static void SIMIX_action_mallocator_reset_f(void* action);
 
+extern void smx_ctx_raw_new_sr(void);
+
 /* FIXME: Yeah, I'll do it in a portable maner one day [Mt] */
 #include <signal.h>
 
+int _surf_do_verbose_exit = 1;
 static void _XBT_CALL inthandler(int ignored)
 {
-  INFO0("CTRL-C pressed. Displaying status and bailing out");
-  SIMIX_display_process_status();
+  if ( _surf_do_verbose_exit ) {
+     XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
+     SIMIX_display_process_status();
+  }
+  else {
+     XBT_INFO("CTRL-C pressed. bailing out without displaying because verbose-exit is disabled");
+  }
   exit(1);
 }
 
@@ -58,30 +59,20 @@ void SIMIX_global_init(int *argc, char **argv)
   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_smx_global_t, 1);
 
-    simix_global->host = xbt_dict_new();
-    simix_global->process_to_run = xbt_dynar_new(sizeof(void *), NULL);
+    simix_global->process_to_run = xbt_dynar_new(sizeof(smx_process_t), NULL);
+    simix_global->process_that_ran = xbt_dynar_new(sizeof(smx_process_t), NULL);
     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->maestro_process = NULL;
-    simix_global->registered_functions = xbt_dict_new();
+    simix_global->registered_functions = xbt_dict_new_homogeneous(NULL);
 
-    simix_global->create_process_function = NULL;
-    simix_global->kill_process_function = NULL;
+    simix_global->create_process_function = SIMIX_process_create;
+    simix_global->kill_process_function = SIMIX_process_kill;
     simix_global->cleanup_process_function = SIMIX_process_cleanup;
     simix_global->action_mallocator = xbt_mallocator_new(65536,
         SIMIX_action_mallocator_new_f, SIMIX_action_mallocator_free_f,
@@ -95,9 +86,6 @@ void SIMIX_global_init(int *argc, char **argv)
     __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
     __xbt_ex_terminate = SIMIX_process_exception_terminate;
 
-    /* Initialize request mechanism */
-    SIMIX_request_init();
-
     /* Initialize the SIMIX network module */
     SIMIX_network_init();
 
@@ -107,6 +95,9 @@ void SIMIX_global_init(int *argc, char **argv)
   if (!simix_timers) {
     simix_timers = xbt_heap_new(8, &free);
   }
+
+  XBT_DEBUG("ADD SIMIX LEVELS");
+  SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,SIMIX_host_destroy);
 }
 
 /**
@@ -116,24 +107,26 @@ void SIMIX_global_init(int *argc, char **argv)
  */
 void SIMIX_clean(void)
 {
+#ifdef TIME_BENCH
+  smx_ctx_raw_new_sr();
+#endif
+
   /* Kill everyone (except maestro) */
-  SIMIX_process_killall();
+  SIMIX_process_killall(simix_global->maestro_process);
 
   /* Exit the SIMIX network module */
   SIMIX_network_exit();
 
-  /* Exit request mechanism */
-  SIMIX_request_destroy();
-
   xbt_heap_free(simix_timers);
+  simix_timers = NULL;
   /* Free the remaining data structures */
   xbt_dynar_free(&simix_global->process_to_run);
+  xbt_dynar_free(&simix_global->process_that_ran);
   xbt_swag_free(simix_global->process_to_destroy);
   xbt_swag_free(simix_global->process_list);
   simix_global->process_list = NULL;
   simix_global->process_to_destroy = NULL;
   xbt_dict_free(&(simix_global->registered_functions));
-  xbt_dict_free(&(simix_global->host));
 
   /* Let's free maestro now */
   SIMIX_context_free(simix_global->maestro_process->context);
@@ -150,6 +143,7 @@ void SIMIX_clean(void)
 
   surf_exit();
 
+  xbt_mallocator_free(simix_global->action_mallocator);
   xbt_free(simix_global);
   simix_global = NULL;
 
@@ -171,10 +165,23 @@ XBT_INLINE double SIMIX_get_clock(void)
   }
 }
 
+static int process_syscall_color(void *p)
+{
+  switch ((*(smx_process_t *)p)->simcall.call) {
+  case SIMCALL_NONE:
+  case SIMCALL_PROCESS_KILL:
+    return 2;
+  case SIMCALL_PROCESS_RESUME:
+    return 1;
+  default:
+    return 0;
+  }
+}
+
 void SIMIX_run(void)
 {
   double time = 0;
-  smx_req_t req;
+  smx_process_t process;
   xbt_swag_t set;
   surf_action_t action;
   smx_timer_t timer;
@@ -182,17 +189,81 @@ void SIMIX_run(void)
   unsigned int iter;
 
   do {
-    do {
-      DEBUG1("New Schedule Round; size(queue)=%lu",
-          xbt_dynar_length(simix_global->process_to_run));
-      SIMIX_context_runall(simix_global->process_to_run);
-      while ((req = SIMIX_request_pop())) {
-        DEBUG1("Handling request %p", req);
-        SIMIX_request_pre(req, 0);
+    XBT_DEBUG("New Schedule Round; size(queue)=%lu",
+        xbt_dynar_length(simix_global->process_to_run));
+#ifdef TIME_BENCH
+    smx_ctx_raw_new_sr();
+#endif
+    while (!xbt_dynar_is_empty(simix_global->process_to_run)) {
+      XBT_DEBUG("New Sub-Schedule Round; size(queue)=%lu",
+              xbt_dynar_length(simix_global->process_to_run));
+
+      /* Run all processes that are ready to run, possibly in parallel */
+      SIMIX_process_runall();
+
+      /* Move all killing processes to the end of the list, because killing a process that have an ongoing simcall is a bad idea */
+      xbt_dynar_three_way_partition(simix_global->process_that_ran, process_syscall_color);
+
+      /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
+
+      /* WARNING, the order *must* be fixed or you'll jeopardize the simulation reproducibility (see RR-7653) */
+
+      /* Here, the order is ok because:
+       *   - if there is no kill during the simulation, processes remain sorted according by their PID.
+       *     rational: This can be proved inductively.
+       *        Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file is parsed linearly).
+       *        Let's show that it is still so at the end of this round.
+       *        - if a process is added when being created, that's from maestro. It can be either at startup
+       *          time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
+       *          in arbitrary order (inductive hypothesis), we are fine.
+       *        - If a process is added because it's getting killed, its subsequent actions shouldn't matter
+       *        - If a process gets added to process_to_run because one of their blocking action constituting the meat
+       *          of a simcall terminates, we're still good. Proof:
+       *          - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
+       *            kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an example.
+       *          - For communications, this function is called from SIMIX_comm_finish().
+       *            This function itself don't mess with the order since simcalls are handled in FIFO order.
+       *            The function is called:
+       *            - before the comm starts (invalid parameters, or resource already dead or whatever).
+       *              The order then trivial holds since maestro didn't interrupt its handling of the simcall yet
+       *            - because the communication failed or were canceled after startup. In this case, it's called from the function
+       *              we are in, by the chunk:
+       *                       set = model->states.failed_action_set;
+       *                       while ((action = xbt_swag_extract(set)))
+       *                          SIMIX_simcall_post((smx_action_t) action->data);
+       *              This order is also fixed because it depends of the order in which the surf actions were
+       *              added to the system, and only maestro can add stuff this way, through simcalls.
+       *              We thus use the inductive hypothesis once again to conclude that the order in which actions are
+       *              poped out of the swag does not depend on the user code's execution order.
+       *            - because the communication terminated. In this case, actions are served in the order given by
+       *                       set = model->states.done_action_set;
+       *                       while ((action = xbt_swag_extract(set)))
+       *                          SIMIX_simcall_post((smx_action_t) action->data);
+       *              and the argument is very similar to the previous one.
+       *            So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user processes are executed.
+       *          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.
+       *     So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
+       *   - If there is some process killings, the order is changed by this decision that comes from user-land
+       *     But this decision may not have been motivated by a situation that were different because the simulation is not reproducible.
+       *     So, even the order change induced by the process killing is perfectly reproducible.
+       *
+       *   So science works, bitches [http://xkcd.com/54/].
+       *
+       *   We could sort the process_that_ran array completely so that we can describe the order in which simcalls are handled
+       *   (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if unfriendly).
+       *   That would thus be a pure waste of time.
+       */
+
+      xbt_dynar_foreach(simix_global->process_that_ran, iter, process) {
+        if (process->simcall.call != SIMCALL_NONE) {
+          SIMIX_simcall_pre(&process->simcall, 0);
+        }
       }
-    } while (xbt_dynar_length(simix_global->process_to_run));
+    }
 
-    time = surf_solve(SIMIX_timer_next());
+    time = SIMIX_timer_next();
+    if (time != -1.0 || xbt_swag_size(simix_global->process_list) != 0)
+      time = surf_solve(time);
 
     /* Notify all the hosts that have failed */
     /* FIXME: iterate through the list of failed host and mark each of them */
@@ -206,22 +277,28 @@ void SIMIX_run(void)
        if (timer->func)
          ((void (*)(void*))timer->func)(timer->args);
     }
-    /* Wake up all process waiting for the action finish */
+    /* Wake up all processes waiting for a Surf action to finish */
     xbt_dynar_foreach(model_list, iter, model) {
-      for (set = model->states.failed_action_set;
-           set;
-           set = (set == model->states.failed_action_set)
-                 ? model->states.done_action_set
-                 : NULL) {
-        while ((action = xbt_swag_extract(set)))
-          SIMIX_request_post((smx_action_t) action->data);
-      }
+      set = model->states.failed_action_set;
+      while ((action = xbt_swag_extract(set)))
+        SIMIX_simcall_post((smx_action_t) action->data);
+      set = model->states.done_action_set;
+      while ((action = xbt_swag_extract(set)))
+        SIMIX_simcall_post((smx_action_t) action->data);
     }
-  } while (time != -1.0);
+
+    /* Clean processes to destroy */
+    SIMIX_process_empty_trash();
+
+  } while (time != -1.0 || !xbt_dynar_is_empty(simix_global->process_to_run));
 
   if (xbt_swag_size(simix_global->process_list) != 0) {
 
-    WARN0("Oops ! Deadlock or code not perfectly clean.");
+#ifdef HAVE_TRACING
+    TRACE_end();
+#endif
+
+    XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
     SIMIX_display_process_status();
     xbt_abort();
   }
@@ -247,43 +324,40 @@ XBT_INLINE void SIMIX_timer_set(double date, void *function, void *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
+ * \brief Registers a function to create a process.
  *
+ * This function registers a function to be called
+ * when a new process is created. The function has
+ * to call SIMIX_process_create().
+ * \param function create process function
  */
 XBT_INLINE 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.
+ * \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
+ * This function registers a function to be called when a
+ * process is killed. The function has to call the SIMIX_process_kill().
  *
+ * \param function Kill process function
  */
-XBT_INLINE void SIMIX_function_register_process_kill(void_f_pvoid_t
+XBT_INLINE void SIMIX_function_register_process_kill(void_pfn_smxprocess_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.
+ * \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
+ * This function registers a user function to be called when
+ * a process ends properly.
  *
+ * \param function cleanup process function
  */
 XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
                                                         function)
@@ -301,10 +375,10 @@ void SIMIX_display_process_status(void)
   smx_process_t process = NULL;
   int nbprocess = xbt_swag_size(simix_global->process_list);
 
-  INFO1("%d processes are still running, waiting for something.", nbprocess);
+  XBT_INFO("%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_INFO
+    ("Legend of the following listing: \"Process <pid> (<name>@<host>): <status>\"");
   xbt_swag_foreach(process, simix_global->process_list) {
 
     if (process->waiting_action) {
@@ -312,51 +386,57 @@ void SIMIX_display_process_status(void)
       const char* action_description = "unknown";
       switch (process->waiting_action->type) {
 
-       case SIMIX_ACTION_EXECUTE:
-         action_description = "execution";
-         break;
+      case SIMIX_ACTION_EXECUTE:
+        action_description = "execution";
+        break;
 
-       case SIMIX_ACTION_PARALLEL_EXECUTE:
-         action_description = "parallel execution";
-         break;
+      case SIMIX_ACTION_PARALLEL_EXECUTE:
+        action_description = "parallel execution";
+        break;
 
-       case SIMIX_ACTION_COMMUNICATE:
-         action_description = "communication";
-         break;
+      case SIMIX_ACTION_COMMUNICATE:
+        action_description = "communication";
+        break;
 
-       case SIMIX_ACTION_SLEEP:
-         action_description = "sleeping";
-         break;
+      case SIMIX_ACTION_SLEEP:
+        action_description = "sleeping";
+        break;
 
-       case SIMIX_ACTION_SYNCHRO:
-         action_description = "synchronization";
-         break;
+      case SIMIX_ACTION_SYNCHRO:
+        action_description = "synchronization";
+        break;
 
-       case SIMIX_ACTION_IO:
-         action_description = "I/O";
-         break;
+      case SIMIX_ACTION_IO:
+        action_description = "I/O";
+        break;
       }
-      INFO2("Waiting for %s action %p to finish", action_description, process->waiting_action);
+      XBT_INFO("Process %lu (%s@%s): waiting for %s action %p (%s) in state %d to finish",
+          process->pid, process->name, process->smx_host->name,
+          action_description, process->waiting_action,
+          process->waiting_action->name, (int)process->waiting_action->state);
+    }
+    else {
+      XBT_INFO("Process %lu (%s@%s)", process->pid, process->name, process->smx_host->name);
     }
   }
 }
 
 static void* SIMIX_action_mallocator_new_f(void) {
   smx_action_t action = xbt_new(s_smx_action_t, 1);
-  action->request_list = xbt_fifo_new();
+  action->simcalls = xbt_fifo_new();
   return action;
 }
 
 static void SIMIX_action_mallocator_free_f(void* action) {
-  xbt_fifo_free(((smx_action_t) action)->request_list);
+  xbt_fifo_free(((smx_action_t) action)->simcalls);
   xbt_free(action);
 }
 
 static void SIMIX_action_mallocator_reset_f(void* action) {
 
-  // we also recycle the request list
-  xbt_fifo_t fifo = ((smx_action_t) action)->request_list;
+  // we also recycle the simcall list
+  xbt_fifo_t fifo = ((smx_action_t) action)->simcalls;
   xbt_fifo_reset(fifo);
   memset(action, 0, sizeof(s_smx_action_t));
-  ((smx_action_t) action)->request_list = fifo;
+  ((smx_action_t) action)->simcalls = fifo;
 }