Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Alternative implementation or parmap with busy waits instead of futexes
[simgrid.git] / src / simix / smx_context_sysv.c
index 0638d97..437db9f 100644 (file)
-/* $Id$ */
+/* context_sysv - context switching with ucontextes from System V           */
 
-/* context_sysv - implementation of context switching with ucontextes from Sys V */
+/* Copyright (c) 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
-/* Copyright (c) 2004-2008 the SimGrid team. All right 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 "xbt/ex_interface.h"
-#include "private.h"
+#include "xbt/parmap.h"
+#include "simix/private.h"
+#include "gras_config.h"
+#include "context_sysv_config.h"        /* loads context system definitions */
+
+#ifdef _XBT_WIN32
+#  include <win32_ucontext.h>     /* context relative declarations */
+#else
+#  include <ucontext.h>           /* context relative declarations */
+#endif
 
-#include "context_sysv_config.h"        /* loads context system definitions                             */
-#include "portable.h"
-#include <ucontext.h>           /* context relative declarations                                */
-#define STACK_SIZE 128*1024     /* lower this if you want to reduce the memory consumption      */
 #ifdef HAVE_VALGRIND_VALGRIND_H
 #  include <valgrind/valgrind.h>
-#endif /* HAVE_VALGRIND_VALGRIND_H */
+#endif                          /* HAVE_VALGRIND_VALGRIND_H */
 
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(smx_context);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
 typedef struct s_smx_ctx_sysv {
-  SMX_CTX_BASE_T;
-  ucontext_t uc;                /* the thread that execute the code */
-  char stack[STACK_SIZE];       /* the thread stack size */
-  smx_process_t prev;           /* the previous process */
+  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                          
+#endif
+  char stack[0];                /* the thread stack (must remain the last element of the structure) */
 } 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 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
+static unsigned long sysv_process_index = 0;   /* index of the next process to run in the
+                                                * list of runnable processes */
+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_self_parallel(void);
+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);
+
+static void smx_ctx_sysv_wrapper(int count, ...);
+
+static void smx_ctx_sysv_stop_serial(smx_context_t context);
+static void smx_ctx_sysv_suspend_serial(smx_context_t context);
+static void smx_ctx_sysv_resume_serial(smx_process_t first_process);
+static void smx_ctx_sysv_runall_serial(void);
+
+static void smx_ctx_sysv_stop_parallel(smx_context_t context);
+static void smx_ctx_sysv_suspend_parallel(smx_context_t context);
+static void smx_ctx_sysv_resume_parallel(smx_process_t first_process);
+static void smx_ctx_sysv_runall_parallel(void);
+
+/* This is a bit paranoid about SIZEOF_VOIDP not being a multiple of SIZEOF_INT,
+ * but it doesn't harm. */
+#define CTX_ADDR_LEN (SIZEOF_VOIDP / SIZEOF_INT + !!(SIZEOF_VOIDP % SIZEOF_INT))
+union u_ctx_addr {
+  void *addr;
+  int intv[CTX_ADDR_LEN];
+};
+#if (CTX_ADDR_LEN == 1)
+#  define CTX_ADDR_SPLIT(u) (u).intv[0]
+#elif (CTX_ADDR_LEN == 2)
+#  define CTX_ADDR_SPLIT(u) (u).intv[0], (u).intv[1]
+#else
+#  error Your architecture is not supported yet
+#endif
+
+void SIMIX_ctx_sysv_factory_init(smx_context_factory_t *factory)
+{
+  smx_ctx_base_factory_init(factory);
+  XBT_VERB("Activating SYSV context factory");
 
-/* callback: context fetching */
-static ex_ctx_t *xbt_jcontext_ex_ctx(void);
-
-/* callback: termination */
-static void xbt_jcontext_ex_terminate(xbt_ex_t * e);
-
-static int
-smx_ctx_sysv_factory_create_context(smx_process_t *smx_process, xbt_main_func_t code);
-
-static int smx_ctx_sysv_factory_finalize(smx_context_factory_t * factory);
-
-static int smx_ctx_sysv_factory_create_maestro_context(smx_process_t * maestro);
-
-static void smx_ctx_sysv_free(smx_process_t process);
-
-static void smx_ctx_sysv_kill(smx_process_t process);
-
-static void smx_ctx_sysv_schedule(smx_process_t process);
-
-static void smx_ctx_sysv_yield(void);
-
-static void smx_ctx_sysv_start(smx_process_t process);
-
-static void smx_ctx_sysv_stop(int exit_code);
-
-static void smx_ctx_sysv_swap(smx_process_t process);
-
-static void smx_ctx_sysv_schedule(smx_process_t process);
-
-static void smx_ctx_sysv_yield(void);
-
-static void smx_ctx_sysv_suspend(smx_process_t process);
-
-static void smx_ctx_sysv_resume(smx_process_t process);
-
-static void smx_ctx_sysv_wrapper(void);
+  (*factory)->finalize = smx_ctx_sysv_factory_finalize;
+  (*factory)->create_context = smx_ctx_sysv_create_context;
+  /* Do not overload that method (*factory)->finalize */
+  (*factory)->free = smx_ctx_sysv_free;
+  (*factory)->name = "smx_sysv_context_factory";
 
-/* callback: context fetching */
-static ex_ctx_t *xbt_ctx_sysv_ex_ctx(void)
-{
-  return simix_global->current_process->context->exception;
+  if (SIMIX_context_is_parallel()) {
+#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);
+    xbt_os_thread_key_create(&sysv_worker_id_key);
+    (*factory)->stop = smx_ctx_sysv_stop_parallel;
+    (*factory)->suspend = smx_ctx_sysv_suspend_parallel;
+    (*factory)->runall = smx_ctx_sysv_runall_parallel;
+#else
+    THROWF(arg_error, 0, "No thread support for parallel context execution");
+#endif
+  } else {
+    (*factory)->stop = smx_ctx_sysv_stop_serial;
+    (*factory)->suspend = smx_ctx_sysv_suspend_serial;
+    (*factory)->runall = smx_ctx_sysv_runall_serial;
+  }    
 }
 
-/* callback: termination */
-static void xbt_ctx_sysv_ex_terminate(xbt_ex_t * e)
-{
-  xbt_ex_display(e);
-  abort();
+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);
+#endif
+  return smx_ctx_base_factory_finalize(factory);
 }
 
-void SIMIX_ctx_sysv_factory_init(smx_context_factory_t * 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)
 {
-  *factory = xbt_new0(s_smx_context_factory_t, 1);
+  union u_ctx_addr ctx_addr;
+  smx_ctx_sysv_t context =
+      (smx_ctx_sysv_t) smx_ctx_base_factory_create_context_sized(size,
+                                                                 code,
+                                                                 argc,
+                                                                 argv,
+                                                                 cleanup_func,
+                                                                 data);
 
-  (*factory)->create_context = smx_ctx_sysv_factory_create_context;
-  (*factory)->finalize = smx_ctx_sysv_factory_finalize;
-  (*factory)->create_maestro_context = smx_ctx_sysv_factory_create_maestro_context;
-  (*factory)->free = smx_ctx_sysv_free;
-  (*factory)->kill = smx_ctx_sysv_kill;
-  (*factory)->schedule = smx_ctx_sysv_schedule;
-  (*factory)->yield = smx_ctx_sysv_yield;
-  (*factory)->start = smx_ctx_sysv_start;
-  (*factory)->stop = smx_ctx_sysv_stop;
-  (*factory)->name = "smx_sysv_context_factory";
+  /* if the user provided a function for the process then use it,
+     otherwise it is the context for maestro */
+  if (code) {
 
-  /* context exception handlers */
-  __xbt_ex_ctx = xbt_ctx_sysv_ex_ctx;
-  __xbt_ex_terminate = xbt_ctx_sysv_ex_terminate;
-}
+    getcontext(&(context->uc));
 
-static int smx_ctx_sysv_factory_create_maestro_context(smx_process_t *maestro)
-{
-  smx_ctx_sysv_t context = xbt_new0(s_smx_ctx_sysv_t, 1);
+    context->uc.uc_link = NULL;
 
-  context->exception = xbt_new(ex_ctx_t, 1);
-  XBT_CTX_INITIALIZE(context->exception);
+    context->uc.uc_stack.ss_sp =
+        pth_skaddr_makecontext(context->stack, smx_context_stack_size);
 
-  (*maestro)->context = (smx_context_t) context;
+    context->uc.uc_stack.ss_size =
+        pth_sksize_makecontext(context->stack, smx_context_stack_size);
 
-  return 0;
+#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 */
+    ctx_addr.addr = context;
+    makecontext(&context->uc, (void (*)())smx_ctx_sysv_wrapper,
+                CTX_ADDR_LEN, CTX_ADDR_SPLIT(ctx_addr));
+  } else {
+    sysv_maestro_context = context;
+  }
 
+  return (smx_context_t) context;
 }
 
-static int smx_ctx_sysv_factory_finalize(smx_context_factory_t * factory)
+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)
 {
-  /*FIXME free(maestro_context->exception);*/
-  free(*factory);
-  *factory = NULL;
-  return 0;
-}
 
-static int
-smx_ctx_sysv_factory_create_context(smx_process_t *smx_process, xbt_main_func_t code)
-{
-  VERB1("Create context %s", (*smx_process)->name);
-  smx_ctx_sysv_t context = xbt_new0(s_smx_ctx_sysv_t, 1);
-
-  context->code = code;
-
-  xbt_assert2(getcontext(&(context->uc)) == 0,
-              "Error in context saving: %d (%s)", errno, strerror(errno));
-  context->uc.uc_link = NULL;
-  context->uc.uc_stack.ss_sp =
-    pth_skaddr_makecontext(context->stack, STACK_SIZE);
-  context->uc.uc_stack.ss_size =
-    pth_sksize_makecontext(context->stack, 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 */
-
-  context->exception = xbt_new(ex_ctx_t, 1);
-  XBT_CTX_INITIALIZE(context->exception);
-  (*smx_process)->context = (smx_context_t)context;
-  (*smx_process)->iwannadie = 0;
-
-  /* FIXME: Check what should return */
-  return 1;
+  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_process_t process)
+static void smx_ctx_sysv_free(smx_context_t context)
 {
-  smx_ctx_sysv_t context = (smx_ctx_sysv_t)process->context;   
-  if (context){
 
-    if (context->exception)
-      free(context->exception);
+  if (context) {
 
 #ifdef HAVE_VALGRIND_VALGRIND_H
-    VALGRIND_STACK_DEREGISTER(((smx_ctx_sysv_t) context)->valgrind_stack_id);
-#endif /* HAVE_VALGRIND_VALGRIND_H */
+    VALGRIND_STACK_DEREGISTER(((smx_ctx_sysv_t)
+                               context)->valgrind_stack_id);
+#endif                          /* HAVE_VALGRIND_VALGRIND_H */
 
-    /* destroy the context */
-    free(context);
   }
+  smx_ctx_base_free(context);
 }
 
-static void smx_ctx_sysv_kill(smx_process_t process)
-{
-  DEBUG2("Kill process '%s' (from '%s')", process->name,
-         simix_global->current_process->name);
-  process->iwannadie = 1;
-  smx_ctx_sysv_swap(process);
-}
+static void smx_ctx_sysv_wrapper(int first, ...)
+{ 
+  union u_ctx_addr ctx_addr;
+  smx_ctx_sysv_t context;
+
+  ctx_addr.intv[0] = first;
+  if (CTX_ADDR_LEN > 1) {
+    va_list ap;
+    int i;
+    va_start(ap, first);
+    for (i = 1; i < CTX_ADDR_LEN; i++)
+      ctx_addr.intv[i] = va_arg(ap, int);
+    va_end(ap);
+  }
+  context = ctx_addr.addr;
+  (context->super.code) (context->super.argc, context->super.argv);
 
-/** 
- * \param context the winner
- *
- * Calling this function blocks the current context and schedule \a context.  
- * When \a context will call xbt_context_yield, it will return
- * to this function as if nothing had happened.
- * 
- * Only the maestro can call this function to run a given process.
- */
-static void smx_ctx_sysv_schedule(smx_process_t process)
-{
-  DEBUG1("Schedule process '%s'", process->name);
-  xbt_assert0((simix_global->current_process == simix_global->maestro_process),
-              "You are not supposed to run this function here!");
-  smx_ctx_sysv_swap(process);
+  simix_global->context_factory->stop((smx_context_t) context);
 }
 
-/** 
- * Calling this function makes the current context yield. The context
- * that scheduled it returns from xbt_context_schedule as if nothing
- * had happened.
- * 
- * Only the processes can call this function, giving back the control
- * to the maestro
- */
-static void smx_ctx_sysv_yield(void)
+static void smx_ctx_sysv_stop_serial(smx_context_t context)
 {
-  DEBUG1("Yielding process '%s'", simix_global->current_process->name);
-  xbt_assert0((simix_global->current_process != simix_global->maestro_process),
-              "You are not supposed to run this function here!");
-  smx_ctx_sysv_swap(simix_global->current_process);
+  smx_ctx_base_stop(context);
+  smx_ctx_sysv_suspend_serial(context);
 }
 
-static void smx_ctx_sysv_start(smx_process_t process)
+static void smx_ctx_sysv_suspend_serial(smx_context_t context)
 {
-  /*DEBUG1("Start context '%s'", context->name);*/
-  makecontext(&(((smx_ctx_sysv_t) process->context)->uc), smx_ctx_sysv_wrapper, 0);
+  /* determine the next context */
+  smx_context_t next_context;
+  unsigned long int i = sysv_process_index++;
+
+  if (i < xbt_dynar_length(simix_global->process_to_run)) {
+    /* execute the next process */
+    XBT_DEBUG("Run next process");
+    next_context = xbt_dynar_get_as(
+        simix_global->process_to_run,i, smx_process_t)->context;
+  }
+  else {
+    /* all processes were run, return to maestro */
+    XBT_DEBUG("No more process to run");
+    next_context = (smx_context_t) sysv_maestro_context;
+  }
+  SIMIX_context_set_current(next_context);
+  swapcontext(&((smx_ctx_sysv_t) context)->uc,
+      &((smx_ctx_sysv_t) next_context)->uc);
 }
 
-static void smx_ctx_sysv_stop(int exit_code)
+static void smx_ctx_sysv_resume_serial(smx_process_t first_process)
 {
-  /* please no debug here: our procdata was already free'd */
-  if (simix_global->current_process->cleanup_func)
-    ((*simix_global->current_process->cleanup_func)) (simix_global->current_process->cleanup_arg);
-
-  smx_ctx_sysv_swap(simix_global->current_process);
+  smx_context_t context = first_process->context;
+  SIMIX_context_set_current(context);
+  swapcontext(&sysv_maestro_context->uc,
+      &((smx_ctx_sysv_t) context)->uc);
 }
 
-static void smx_ctx_sysv_swap(smx_process_t process)
+static void smx_ctx_sysv_runall_serial(void)
 {
-  DEBUG2("Swap context: '%s' -> '%s'", simix_global->current_process->name, process->name);
-  xbt_assert0(simix_global->current_process, "You have to call context_init() first.");
-  xbt_assert0(process, "Invalid argument");
-
-  if (((smx_ctx_sysv_t) process->context)->prev == NULL)
-    smx_ctx_sysv_resume(process);
-  else
-    smx_ctx_sysv_suspend(process);
+  if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
+    smx_process_t first_process =
+        xbt_dynar_get_as(simix_global->process_to_run, 0, smx_process_t);
+    sysv_process_index = 1;
 
-  if (simix_global->current_process->iwannadie)
-    smx_ctx_sysv_stop(1);
+    /* execute the first process */
+    smx_ctx_sysv_resume_serial(first_process);
+  }
 }
 
-static void smx_ctx_sysv_wrapper(void)
+static void smx_ctx_sysv_stop_parallel(smx_context_t context)
 {
-  smx_ctx_sysv_stop((*(simix_global->current_process->context->code))
-                    (simix_global->current_process->argc, simix_global->current_process->argv));
+  smx_ctx_base_stop(context);
+  smx_ctx_sysv_suspend_parallel(context);
 }
 
-static void smx_ctx_sysv_suspend(smx_process_t process)
+static void smx_ctx_sysv_suspend_parallel(smx_context_t context)
 {
-  int rv;
-
-  DEBUG1("Suspend context: '%s'", simix_global->current_process->name);
-  smx_process_t prev_process = ((smx_ctx_sysv_t) process->context)->prev;
-
-  simix_global->current_process = prev_process;
-
-  ((smx_ctx_sysv_t) process->context)->prev = NULL;
-
-  rv = swapcontext(&(((smx_ctx_sysv_t) process->context)->uc), &(((smx_ctx_sysv_t)prev_process->context)->uc));
+#ifdef CONTEXT_THREADS
+  /* determine the next context */
+  smx_process_t next_work = xbt_parmap_next(sysv_parmap);
+  smx_context_t next_context;
+  ucontext_t* next_stack;
+
+  if (next_work != NULL) {
+    /* there is 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) xbt_os_thread_get_specific(sysv_worker_id_key);
+    next_stack = &sysv_workers_stacks[worker_id];
+  }
 
-  xbt_assert0((rv == 0), "Context swapping failure");
+  SIMIX_context_set_current(next_context);
+  swapcontext(&((smx_ctx_sysv_t) context)->uc, next_stack);
+#endif
 }
 
-static void smx_ctx_sysv_resume(smx_process_t process)
+static void smx_ctx_sysv_resume_parallel(smx_process_t first_process)
 {
-  int rv;
-  smx_ctx_sysv_t new_context = (smx_ctx_sysv_t)process->context;
-  smx_ctx_sysv_t prev_context = (smx_ctx_sysv_t)simix_global->current_process->context;
-
-  DEBUG2("Resume context: '%s' (from '%s')", process->name,
-         simix_global->current_process->name);
-
-  ((smx_ctx_sysv_t) process->context)->prev = simix_global->current_process;
-
-  simix_global->current_process = process;
-
-  rv = swapcontext(&prev_context->uc, &new_context->uc);
+#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);
+#endif
+}
 
-  xbt_assert0((rv == 0), "Context swapping failure");
+static void smx_ctx_sysv_runall_parallel(void)
+{
+#ifdef CONTEXT_THREADS
+  sysv_threads_working = 0;
+  xbt_parmap_apply(sysv_parmap, (void_f_pvoid_t) smx_ctx_sysv_resume_parallel,
+      simix_global->process_to_run);
+#endif
 }