Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
greatly improve the documentation of the parallel execution in simix
[simgrid.git] / src / simix / smx_context_sysv.c
index 9acbbd1..c3e5eca 100644 (file)
@@ -1,10 +1,10 @@
-/* context_sysv - context switching with ucontextes from System V           */
+/* context_sysv - context switching with ucontexts from System V           */
 
-/* Copyright (c) 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2009-2014. 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. */
+/* 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 <stdarg.h>
 
 #include "mc/mc.h"
 
 #ifdef _XBT_WIN32
-#  include <win32_ucontext.h>     /* context relative declarations */
+#  include <xbt/win32_ucontext.h>     /* context relative declarations */
 #else
 #  include <ucontext.h>           /* context relative declarations */
 #endif
 
-#ifdef HAVE_VALGRIND_VALGRIND_H
-#  include <valgrind/valgrind.h>
-#endif                          /* HAVE_VALGRIND_VALGRIND_H */
-
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
 typedef struct s_smx_ctx_sysv {
   s_smx_ctx_base_t super;       /* Fields of super implementation */
   ucontext_t uc;                /* the ucontext that executes the code */
-#ifdef HAVE_VALGRIND_VALGRIND_H
-  unsigned int valgrind_stack_id;       /* the valgrind stack id */
-#endif
-  char stack[0];                /* the thread stack (must remain the last element of the structure) */
+  char *stack;                  /* the thread stack */
 } s_smx_ctx_sysv_t, *smx_ctx_sysv_t;
 
 #ifdef CONTEXT_THREADS
 static xbt_parmap_t sysv_parmap;
-static ucontext_t* sysv_workers_stacks;        /* space to save the worker's stack in each thread */
+static smx_ctx_sysv_t* sysv_workers_context;   /* space to save the worker's context in each thread */
 static unsigned long sysv_threads_working;     /* number of threads that have started their work */
 static xbt_os_thread_key_t sysv_worker_id_key; /* thread-specific storage for the thread id */
 #endif
@@ -46,16 +39,10 @@ static unsigned long sysv_process_index = 0;   /* index of the next process to r
 static smx_ctx_sysv_t sysv_maestro_context;
 
 static int smx_ctx_sysv_factory_finalize(smx_context_factory_t *factory);
-static smx_context_t
-smx_ctx_sysv_create_context_sized(size_t structure_size,
-                                  xbt_main_func_t code, int argc,
-                                  char **argv,
-                                  void_pfn_smxprocess_t cleanup_func,
-                                  void *data);
 static void smx_ctx_sysv_free(smx_context_t context);
 static smx_context_t
 smx_ctx_sysv_create_context(xbt_main_func_t code, int argc, char **argv,
-    void_pfn_smxprocess_t cleanup_func, void* data);
+    void_pfn_smxprocess_t cleanup_func, smx_process_t process);
 
 static void smx_ctx_sysv_wrapper(int count, ...);
 
@@ -90,7 +77,8 @@ void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory)
 #ifdef CONTEXT_THREADS  /* To use parallel ucontexts a thread pool is needed */
     int nthreads = SIMIX_context_get_nthreads();
     sysv_parmap = xbt_parmap_new(nthreads, SIMIX_context_get_parallel_mode());
-    sysv_workers_stacks = xbt_new(ucontext_t, nthreads);
+    sysv_workers_context = xbt_new(smx_ctx_sysv_t, nthreads);
+    sysv_maestro_context = NULL;
     xbt_os_thread_key_create(&sysv_worker_id_key);
     (*factory)->stop = smx_ctx_sysv_stop_parallel;
     (*factory)->suspend = smx_ctx_sysv_suspend_parallel;
@@ -110,46 +98,41 @@ static int smx_ctx_sysv_factory_finalize(smx_context_factory_t *factory)
 #ifdef CONTEXT_THREADS
   if (sysv_parmap)
     xbt_parmap_destroy(sysv_parmap);
-  xbt_free(sysv_workers_stacks);
+  xbt_free(sysv_workers_context);
 #endif
   return smx_ctx_base_factory_finalize(factory);
 }
 
 static smx_context_t
-smx_ctx_sysv_create_context_sized(size_t size, xbt_main_func_t code,
-                                  int argc, char **argv,
-                                  void_pfn_smxprocess_t cleanup_func,
-                                  void *data)
+smx_ctx_sysv_create_context(xbt_main_func_t code, int argc, char **argv,
+                            void_pfn_smxprocess_t cleanup_func,
+                            smx_process_t process)
 {
   int ctx_addr[CTX_ADDR_LEN];
   smx_ctx_sysv_t context =
-      (smx_ctx_sysv_t) smx_ctx_base_factory_create_context_sized(size,
-                                                                 code,
-                                                                 argc,
-                                                                 argv,
-                                                                 cleanup_func,
-                                                                 data);
+    (smx_ctx_sysv_t) smx_ctx_base_factory_create_context_sized(
+      sizeof(s_smx_ctx_sysv_t),
+      code,
+      argc,
+      argv,
+      cleanup_func,
+      process);
 
   /* if the user provided a function for the process then use it,
      otherwise it is the context for maestro */
   if (code) {
 
+    context->stack = SIMIX_context_stack_new();
     getcontext(&(context->uc));
 
     context->uc.uc_link = NULL;
 
     context->uc.uc_stack.ss_sp =
-        pth_skaddr_makecontext(context->stack, smx_context_stack_size);
+        pth_skaddr_makecontext(context->stack, smx_context_usable_stack_size);
 
     context->uc.uc_stack.ss_size =
-        pth_sksize_makecontext(context->stack, smx_context_stack_size);
-
-#ifdef HAVE_VALGRIND_VALGRIND_H
-    context->valgrind_stack_id =
-        VALGRIND_STACK_REGISTER(context->uc.uc_stack.ss_sp,
-                                ((char *) context->uc.uc_stack.ss_sp) +
-                                context->uc.uc_stack.ss_size);
-#endif                          /* HAVE_VALGRIND_VALGRIND_H */
+        pth_sksize_makecontext(context->stack, smx_context_usable_stack_size);
+
     memcpy(ctx_addr, &context, sizeof(smx_ctx_sysv_t));
     switch (CTX_ADDR_LEN) {
     case 1:
@@ -165,37 +148,22 @@ smx_ctx_sysv_create_context_sized(size_t size, xbt_main_func_t code,
               sizeof(smx_ctx_sysv_t), sizeof(int), CTX_ADDR_LEN);
     }
   } else {
-    sysv_maestro_context = context;
+    if (process != NULL && sysv_maestro_context == NULL)
+      sysv_maestro_context = context;
   }
 
   if(MC_is_active() && code)
-    MC_new_stack_area(context, ((smx_process_t)((smx_context_t)context)->data)->name, &(context->uc), size);
+    MC_new_stack_area(context->stack, ((smx_context_t)context)->process->name,
+                      &(context->uc), smx_context_usable_stack_size);
 
   return (smx_context_t) context;
 }
 
-static smx_context_t
-smx_ctx_sysv_create_context(xbt_main_func_t code, int argc, char **argv,
-    void_pfn_smxprocess_t cleanup_func,
-    void *data)
-{
-
-  return smx_ctx_sysv_create_context_sized(sizeof(s_smx_ctx_sysv_t) + smx_context_stack_size,
-                                           code, argc, argv, cleanup_func,
-                                           data);
-
-}
-
 static void smx_ctx_sysv_free(smx_context_t context)
 {
 
   if (context) {
-
-#ifdef HAVE_VALGRIND_VALGRIND_H
-    VALGRIND_STACK_DEREGISTER(((smx_ctx_sysv_t)
-                               context)->valgrind_stack_id);
-#endif                          /* HAVE_VALGRIND_VALGRIND_H */
-
+    SIMIX_context_stack_delete(((smx_ctx_sysv_t)context)->stack);
   }
   smx_ctx_base_free(context);
 }
@@ -232,11 +200,6 @@ static void smx_ctx_sysv_suspend_serial(smx_context_t context)
   smx_context_t next_context;
   unsigned long int i = sysv_process_index++;
 
-  if(MC_is_active()){
-    MC_ignore_stack("next_context", "smx_ctx_sysv_suspend_serial");
-    MC_ignore_stack("i", "smx_ctx_sysv_suspend_serial");
-  }
-
   if (i < xbt_dynar_length(simix_global->process_to_run)) {
     /* execute the next process */
     XBT_DEBUG("Run next process");
@@ -281,40 +244,47 @@ static void smx_ctx_sysv_suspend_parallel(smx_context_t context)
 {
 #ifdef CONTEXT_THREADS
   /* determine the next context */
-  smx_process_t next_work = xbt_parmap_next(sysv_parmap);
+  smx_process_t next_work = xbt_parmap_next(sysv_parmap);  // get the next soul to embody now
   smx_context_t next_context;
-  ucontext_t* next_stack;
+  ucontext_t* next_stack;                                  // will contain the next soul to run, either simulated or initial minion's one
 
-  if (next_work != NULL) {
-    /* there is a next process to resume */
+  if (next_work != NULL) {                                 // there is a next soul to embody (ie, a next process to resume)
     XBT_DEBUG("Run next process");
     next_context = next_work->context;
-    next_stack = &((smx_ctx_sysv_t) next_context)->uc;
   }
   else {
     /* all processes were run, go to the barrier */
     XBT_DEBUG("No more processes to run");
-    next_context = (smx_context_t) sysv_maestro_context;
-    unsigned long worker_id =
+    unsigned long worker_id =                             // Get back the identity of my body that was stored when starting the scheduling round
         (unsigned long) xbt_os_thread_get_specific(sysv_worker_id_key);
-    next_stack = &sysv_workers_stacks[worker_id];
+    next_context = (smx_context_t)sysv_workers_context[worker_id];  // deduce the initial soul of that body
+                                                                    // When given that soul, the body will wait for the next scheduling round
   }
 
+  next_stack = &((smx_ctx_sysv_t)next_context)->uc;
+
   SIMIX_context_set_current(next_context);
-  swapcontext(&((smx_ctx_sysv_t) context)->uc, next_stack);
+  swapcontext(&((smx_ctx_sysv_t) context)->uc, next_stack);  // get that next soul
 #endif
 }
 
-static void smx_ctx_sysv_resume_parallel(smx_process_t first_process)
+static void smx_ctx_sysv_resume_parallel(smx_process_t simulated_process_to_run)
 {
 #ifdef CONTEXT_THREADS
-  unsigned long worker_id = __sync_fetch_and_add(&sysv_threads_working, 1);
-  xbt_os_thread_set_specific(sysv_worker_id_key, (void*) worker_id);
-  ucontext_t* worker_stack = &sysv_workers_stacks[worker_id];
-
-  smx_context_t context = first_process->context;
-  SIMIX_context_set_current(context);
-  swapcontext(worker_stack, &((smx_ctx_sysv_t) context)->uc);
+  unsigned long worker_id = __sync_fetch_and_add(&sysv_threads_working, 1); // what is my containing body?
+  xbt_os_thread_set_specific(sysv_worker_id_key, (void*) worker_id);        // Store the number of my containing body in os-thread-specific area
+  smx_ctx_sysv_t worker_context = (smx_ctx_sysv_t)SIMIX_context_self();     // get my current soul
+  sysv_workers_context[worker_id] = worker_context;                         // write down that this soul is hosted in that body (for now)
+  ucontext_t* worker_stack = &worker_context->uc;                           // retrieves the system-level info that fuels this soul
+
+  smx_context_t context = simulated_process_to_run->context;                // That's the first soul that I should become
+  SIMIX_context_set_current(context);                                       // write in simix that I switched my soul
+  swapcontext(worker_stack, &((smx_ctx_sysv_t) context)->uc);               // actually do that using the relevant syscall
+  // No body runs that soul anymore at this point. Instead the current body took the soul of simulated process
+  // The simulated process wakes back after the call to "SIMIX_context_suspend(self->context);" within smx_process.c::SIMIX_process_yield()
+
+  // From now on, the simulated processes will change their soul with the next soul to execute (in suspend_parallel, above).
+  // When nobody is to be executed in this scheduling round, the last simulated process will take back the initial soul of the current working thread
 #endif
 }