Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add levels to lib host_lib, link_lib and as_router_lib
[simgrid.git] / src / simix / smx_global.c
index fc1094e..a486e41 100644 (file)
@@ -1,16 +1,17 @@
-/*     $Id$     */
-
-/* Copyright (c) 2007 Arnaud Legrand, Bruno Donassolo.
-   All rights reserved.                                          */
+/* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* 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 "xbt/heap.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 #include "xbt/str.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);
@@ -18,24 +19,36 @@ 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)");
 
-SIMIX_Global_t simix_global = NULL;
+smx_global_t simix_global = NULL;
+static xbt_heap_t simix_timers = NULL;
+
+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>
 
 static void _XBT_CALL inthandler(int ignored)
 {
-  INFO0("CTRL-C pressed. Displaying status and bailing out");
+  XBT_INFO("CTRL-C pressed. Displaying status and bailing out");
   SIMIX_display_process_status();
   exit(1);
 }
 
 /********************************* SIMIX **************************************/
 
+XBT_INLINE double SIMIX_timer_next(void)
+{
+  return xbt_heap_size(simix_timers) > 0 ? xbt_heap_maxkey(simix_timers) : -1.0;
+}
+
 /**
  * \brief Initialize SIMIX internal data.
  *
@@ -55,187 +68,101 @@ void SIMIX_global_init(int *argc, char **argv)
     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 = xbt_new0(s_smx_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_to_run = xbt_dynar_new(sizeof(void *), NULL);
     simix_global->process_list =
-      xbt_swag_new(xbt_swag_offset(proc, process_hookup));
-    simix_global->current_process = NULL;
+        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->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,
+        SIMIX_action_mallocator_reset_f);
 
-    /* Prepare to display some more info when dying on Ctrl-C pressing */
-    signal(SIGINT, inthandler);
     surf_init(argc, argv);      /* Initialize SURF structures */
-  }
-}
+    SIMIX_context_mod_init();
+    SIMIX_create_maestro_process();
 
-/* Debug purpose, incomplete */
-void SIMIX_display_process_status(void)
-{
-  smx_process_t process = NULL;
-  xbt_fifo_item_t item = NULL;
-  smx_action_t act;
-  int nbprocess = xbt_swag_size(simix_global->process_list);
+    /* context exception handlers */
+    __xbt_running_ctx_fetch = SIMIX_process_get_running_context;
+    __xbt_ex_terminate = SIMIX_process_exception_terminate;
 
-  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) {
-    smx_simdata_process_t p_simdata =
-      (smx_simdata_process_t) process->simdata;
-    // simdata_host_t h_simdata=(simdata_host_t)p_simdata->host->simdata;
-    char *who, *who2;
-
-    asprintf(&who, "%s on %s: %s",
-             process->name,
-             p_simdata->smx_host->name,
-             (process->simdata->blocked) ? "[BLOCKED] "
-             : ((process->simdata->suspended) ? "[SUSPENDED] " : ""));
-
-    if (p_simdata->mutex) {
-      who2 =
-        bprintf("%s Blocked on mutex %p", who,
-                (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
-                p_simdata->mutex : (void *) 0xdead);
-      free(who);
-      who = who2;
-    } else if (p_simdata->cond) {
-      who2 =
-        bprintf
-        ("%s Blocked on condition %p; Waiting for the following actions:",
-         who,
-         (XBT_LOG_ISENABLED(simix_kernel, xbt_log_priority_verbose)) ?
-         p_simdata->cond : (void *) 0xdead);
-      free(who);
-      who = who2;
-      xbt_fifo_foreach(p_simdata->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);
-  }
-}
-
-
-/**
- * \brief Launch the SIMIX simulation, debug purpose
- */
-void __SIMIX_main(void)
-{
-  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);
+    /* Initialize request mechanism */
+    SIMIX_request_init();
 
-  //surf_solve(); /* Takes traces into account. Returns 0.0 */
-  /* xbt_fifo_size(msg_global->process_to_run) */
+    /* Initialize the SIMIX network module */
+    SIMIX_network_init();
 
-  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->simdata->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->simdata->smx_host->name);
-        }
-        SIMIX_cond_broadcast(cond);
-        /* remove conditional from action */
-        SIMIX_unregister_action_to_condition(smx_action, cond);
-      }
-    }
-  }
-  return;
-}
-
-/**
- * \brief Kill all running 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);
+    /* Prepare to display some more info when dying on Ctrl-C pressing */
+    signal(SIGINT, inthandler);
   }
-
-  xbt_context_empty_trash();
-
-  if (self) {
-    xbt_context_yield();
+  if (!simix_timers) {
+    simix_timers = xbt_heap_new(8, &free);
   }
 
-  return;
+  XBT_DEBUG("ADD SIMIX LEVELS");
+  SIMIX_HOST_LEVEL = xbt_lib_add_level(host_lib,free);
 }
 
 /**
  * \brief Clean the SIMIX simulation
  *
- * This functions remove all memories needed to the SIMIX execution
+ * This functions remove the memory used by SIMIX
  */
 void SIMIX_clean(void)
 {
-  smx_process_t p = NULL;
+#ifdef TIME_BENCH
+  smx_ctx_raw_new_sr();
+#endif
 
-  while ((p = xbt_swag_extract(simix_global->process_list))) {
-    SIMIX_process_kill(p);
-  }
+  /* Kill everyone (except maestro) */
+  SIMIX_process_killall(simix_global->maestro_process);
 
-  xbt_dict_free(&(simix_global->host));
-  xbt_swag_free(simix_global->process_to_run);
+  /* Exit the SIMIX network module */
+  SIMIX_network_exit();
+
+  /* Exit request mechanism */
+  SIMIX_request_destroy();
+
+  xbt_heap_free(simix_timers);
+  /* Free the remaining data structures */
+  xbt_dynar_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;
+  simix_global->process_to_destroy = NULL;
   xbt_dict_free(&(simix_global->registered_functions));
-  free(simix_global);
-  simix_global = NULL;
+  xbt_dict_free(&(simix_global->host));
+
+  /* Let's free maestro now */
+  SIMIX_context_free(simix_global->maestro_process->context);
+  xbt_free(simix_global->maestro_process->running_ctx);
+  xbt_free(simix_global->maestro_process);
+  simix_global->maestro_process = NULL;
+
+  /* Restore the default exception setup */
+  __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
+  __xbt_ex_terminate = &__xbt_ex_terminate_default;
+
+  /* Finish context module and SURF */
+  SIMIX_context_mod_exit();
 
   surf_exit();
 
+  xbt_mallocator_free(simix_global->action_mallocator);
+  xbt_free(simix_global);
+  simix_global = NULL;
+
   return;
 }
 
@@ -245,134 +172,74 @@ void SIMIX_clean(void)
  *
  * \return Return the clock.
  */
-double SIMIX_get_clock(void)
+XBT_INLINE 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();
+  if(MC_IS_ENABLED){
+    return MC_process_clock_get(SIMIX_process_self());
+  }else{
+    return surf_get_clock();
+  }
 }
 
-/**
- *     \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)
+void SIMIX_run(void)
 {
-
-  smx_process_t process = NULL;
+  double time = 0;
+  smx_req_t req;
+  xbt_swag_t set;
+  surf_action_t action;
+  smx_timer_t timer;
+  surf_model_t model;
   unsigned int iter;
-  double elapsed_time = 0.0;
-  static int state_modifications = 1;
-
-  xbt_context_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->simdata->smx_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_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->common_public.states.failed_action_set)
-          || xbt_swag_size(model->common_public.states.done_action_set)) {
-        state_modifications = 1;
-        break;
+  do {
+    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
+    do {
+      XBT_DEBUG("New Sub-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())) {
+        XBT_DEBUG("Handling request %p", req);
+        SIMIX_request_pre(req, 0);
       }
-    }
+    } while (xbt_dynar_length(simix_global->process_to_run));
 
-    if (!state_modifications) {
-      DEBUG1("%f : Calling surf_solve", SIMIX_get_clock());
-      elapsed_time = surf_solve();
-      DEBUG1("Elapsed_time %f", elapsed_time);
-    }
+    time = surf_solve(SIMIX_timer_next());
 
-    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->simdata->smx_host->name);
-        SIMIX_process_kill(process);
-      }
-    }
+    /* Notify all the hosts that have failed */
+    /* FIXME: iterate through the list of failed host and mark each of them */
+    /* as failed. On each host, signal all the running processes with host_fail */
 
+    /* Handle any pending timer */
+    while (xbt_heap_size(simix_timers) > 0 && SIMIX_get_clock() >= SIMIX_timer_next()) {
+       //FIXME: make the timers being real callbacks
+       // (i.e. provide dispatchers that read and expand the args) 
+       timer = xbt_heap_pop(simix_timers);
+       if (timer->func)
+         ((void (*)(void*))timer->func)(timer->args);
+    }
     /* Wake up all process waiting for the action finish */
     xbt_dynar_foreach(model_list, iter, model) {
-      while ((action =
-              xbt_swag_extract(model->common_public.
-                               states.failed_action_set))) {
-        smx_action = action->data;
-        if (smx_action) {
-          xbt_fifo_unshift(actions_failed, smx_action);
-        }
-      }
-      while ((action =
-              xbt_swag_extract(model->common_public.
-                               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();
+      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);
       }
-      INFO0("Return a Warning.");
     }
+  } while (time != -1.0);
+
+  if (xbt_swag_size(simix_global->process_list) != 0) {
+
+    XBT_WARN("Oops ! Deadlock or code not perfectly clean.");
+    SIMIX_display_process_status();
+    xbt_abort();
   }
-  return elapsed_time;
 }
 
 /**
@@ -384,54 +251,124 @@ double SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed)
  *     \param arg Parameters of the function
  *
  */
-void SIMIX_timer_set(double date, void *function, void *arg)
+XBT_INLINE void SIMIX_timer_set(double date, void *function, void *arg)
 {
-  surf_timer_model->extension.timer.set(date, function, arg);
-}
+  smx_timer_t timer = xbt_new0(s_smx_timer_t, 1);
 
-int SIMIX_timer_get(void **function, void **arg)
-{
-  return surf_timer_model->extension.timer.get(function, arg);
+  timer->date = date;
+  timer->func = function;
+  timer->args = arg;
+  xbt_heap_push(simix_timers, timer, date);
 }
 
 /**
- *     \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
  */
-void SIMIX_function_register_process_create(smx_creation_func_t 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
  */
-void SIMIX_function_register_process_kill(void_f_pvoid_t function)
+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
  */
-void SIMIX_function_register_process_cleanup(void_f_pvoid_t function)
+XBT_INLINE void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t
+                                                        function)
 {
   simix_global->cleanup_process_function = function;
 }
+
+
+void SIMIX_display_process_status(void)
+{
+  if (simix_global->process_list == NULL) {
+    return;
+  }
+
+  smx_process_t process = NULL;
+  int nbprocess = xbt_swag_size(simix_global->process_list);
+
+  XBT_INFO("%d processes are still running, waiting for something.", nbprocess);
+  /*  List the process and their state */
+  XBT_INFO
+    ("Legend of the following listing: \"<process> on <host>: <status>.\"");
+  xbt_swag_foreach(process, simix_global->process_list) {
+
+    if (process->waiting_action) {
+
+      const char* action_description = "unknown";
+      switch (process->waiting_action->type) {
+
+       case SIMIX_ACTION_EXECUTE:
+         action_description = "execution";
+         break;
+
+       case SIMIX_ACTION_PARALLEL_EXECUTE:
+         action_description = "parallel execution";
+         break;
+
+       case SIMIX_ACTION_COMMUNICATE:
+         action_description = "communication";
+         break;
+
+       case SIMIX_ACTION_SLEEP:
+         action_description = "sleeping";
+         break;
+
+       case SIMIX_ACTION_SYNCHRO:
+         action_description = "synchronization";
+         break;
+
+       case SIMIX_ACTION_IO:
+         action_description = "I/O";
+         break;
+      }
+      XBT_INFO("Waiting for %s action %p to finish", action_description, process->waiting_action);
+    }
+  }
+}
+
+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();
+  return action;
+}
+
+static void SIMIX_action_mallocator_free_f(void* action) {
+  xbt_fifo_free(((smx_action_t) action)->request_list);
+  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;
+  xbt_fifo_reset(fifo);
+  memset(action, 0, sizeof(s_smx_action_t));
+  ((smx_action_t) action)->request_list = fifo;
+}