Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove a useless function. The default one does the same thing.
[simgrid.git] / src / simix / smx_context_sysv.c
index fe0f7ac..8bcc0cf 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 "private.h"
-#include "context_sysv_config.h"        /* loads context system definitions */
-#include "portable.h"
-#include <ucontext.h>           /* context relative declarations */
-
-/* lower this if you want to reduce the memory consumption  */
-#define STACK_SIZE 128*1024
+#include "smx_context_sysv_private.h"
+#include "xbt/parmap.h"
+#include "simix/private.h"
+#include "gras_config.h"
 
 #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 {
-  SMX_CTX_BASE_T;
-  ucontext_t uc;                /* the thread that execute the code */
-  char stack[STACK_SIZE];       /* the thread stack size */
-#ifdef HAVE_VALGRIND_VALGRIND_H
-  unsigned int valgrind_stack_id;       /* the valgrind stack id */
-#endif                          
-} s_smx_ctx_sysv_t, *smx_ctx_sysv_t;
+#endif                          /* HAVE_VALGRIND_VALGRIND_H */
 
-static smx_context_t 
-smx_ctx_sysv_factory_create_context(xbt_main_func_t code, int argc, char** argv, 
-    void_f_pvoid_t cleanup_func, void* cleanup_arg);
+#ifdef _XBT_WIN32
+#include "win32_ucontext.h"
+#else
+#include "ucontext.h"
+#endif
 
-static int smx_ctx_sysv_factory_finalize(smx_context_factory_t *factory);
-
-static void smx_ctx_sysv_free(smx_context_t context);
-static void smx_ctx_sysv_stop(smx_context_t context);
-static void smx_ctx_sysv_suspend(smx_context_t context);
-static void smx_ctx_sysv_resume(smx_context_t new_context);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
-static void smx_ctx_sysv_wrapper(void);
+#ifdef CONTEXT_THREADS
+static xbt_parmap_t smx_ctx_sysv_parmap;
+static ucontext_t* smx_ctx_sysv_local_maestro_uc;    /* space to save maestro's stack in each thread */
+#endif
+static unsigned long smx_ctx_sysv_process_index = 0; /* index of the next process to run in the
+                                                      * list of runnable processes */
+static smx_ctx_sysv_t smx_ctx_sysv_maestro_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);
+
+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)
 {
-  *factory = xbt_new0(s_smx_context_factory_t, 1);
+  smx_ctx_base_factory_init(factory);
+  XBT_VERB("Activating SYSV context factory");
 
-  (*factory)->create_context = smx_ctx_sysv_factory_create_context;
   (*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)->stop = smx_ctx_sysv_stop;
-  (*factory)->suspend = smx_ctx_sysv_suspend;
-  (*factory)->resume = smx_ctx_sysv_resume;
   (*factory)->name = "smx_sysv_context_factory";
+
+  if (SIMIX_context_is_parallel()) {
+#ifdef CONTEXT_THREADS /* To use parallel ucontexts a thread pool is needed */
+    int nthreads = SIMIX_context_get_nthreads();
+    smx_ctx_sysv_parmap = xbt_parmap_new(nthreads);
+    smx_ctx_sysv_local_maestro_uc = xbt_new(ucontext_t, nthreads);
+    (*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;
+  }    
 }
 
-static int smx_ctx_sysv_factory_finalize(smx_context_factory_t * factory)
-{
-  free(*factory);
-  *factory = NULL;
-  return 0;
+int smx_ctx_sysv_factory_finalize(smx_context_factory_t *factory)
+{ 
+#ifdef CONTEXT_THREADS
+  if (smx_ctx_sysv_parmap)
+    xbt_parmap_destroy(smx_ctx_sysv_parmap);
+  xbt_free(smx_ctx_sysv_local_maestro_uc);
+#endif
+  return smx_ctx_base_factory_finalize(factory);
 }
 
-static smx_context_t 
-smx_ctx_sysv_factory_create_context(xbt_main_func_t code, int argc, char** argv, 
-    void_f_pvoid_t cleanup_func, void* cleanup_arg)
+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_t context = xbt_new0(s_smx_ctx_sysv_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);
 
-  /* If the user provided a function for the process then use it
-     otherwise is the context for maestro */
-  if(code){
-    context->code = code;
+  /* if the user provided a function for the process then use it,
+     otherwise it is the context for maestro */
+  if (code) {
 
-    xbt_assert2(getcontext(&(context->uc)) == 0,
-        "Error in context saving: %d (%s)", errno, strerror(errno));
+    getcontext(&(context->uc));
 
     context->uc.uc_link = NULL;
 
     context->uc.uc_stack.ss_sp =
-        pth_skaddr_makecontext(context->stack, STACK_SIZE);
+        pth_skaddr_makecontext(context->stack, smx_context_stack_size);
 
     context->uc.uc_stack.ss_size =
-        pth_sksize_makecontext(context->stack, STACK_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 */
+                                ((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 {
+    smx_ctx_sysv_maestro_context = context;
+  }
 
-    context->argc = argc;
-    context->argv = argv;
-    context->cleanup_func = cleanup_func;
-    context->cleanup_arg = cleanup_arg;
+  return (smx_context_t) context;
+}
 
-    makecontext(&((smx_ctx_sysv_t)context)->uc, smx_ctx_sysv_wrapper, 0);
-  }
+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);
 
-  return (smx_context_t)context;
 }
 
-static void smx_ctx_sysv_free(smx_context_t pcontext)
+void smx_ctx_sysv_free(smx_context_t context)
 {
-  int i;
-  smx_ctx_sysv_t context = (smx_ctx_sysv_t)pcontext;   
-  if (context){
 
-#ifdef HAVE_VALGRIND_VALGRIND_H
-    VALGRIND_STACK_DEREGISTER(((smx_ctx_sysv_t) context)->valgrind_stack_id);
-#endif /* HAVE_VALGRIND_VALGRIND_H */
+  if (context) {
 
-    /* free argv */
-    if (context->argv) {
-      for (i = 0; i < context->argc; i++)
-        if (context->argv[i])
-          free(context->argv[i]);
+#ifdef HAVE_VALGRIND_VALGRIND_H
+    VALGRIND_STACK_DEREGISTER(((smx_ctx_sysv_t)
+                               context)->valgrind_stack_id);
+#endif                          /* HAVE_VALGRIND_VALGRIND_H */
 
-      free(context->argv);
-    }
+  }
+  smx_ctx_base_free(context);
+}
 
-    /* destroy the context */
-    free(context);
+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);
+
+  simix_global->context_factory->stop((smx_context_t) context);
 }
 
-static void smx_ctx_sysv_stop(smx_context_t pcontext)
+static void smx_ctx_sysv_stop_serial(smx_context_t context)
 {
-  smx_ctx_sysv_t context = (smx_ctx_sysv_t)pcontext;
-
-  if (context->cleanup_func)
-    (*context->cleanup_func) (context->cleanup_arg);
+  smx_ctx_base_stop(context);
+  smx_ctx_sysv_suspend_serial(context);
+}
 
-  smx_ctx_sysv_suspend(pcontext);
+static void smx_ctx_sysv_suspend_serial(smx_context_t context)
+{
+  /* determine the next context */
+  smx_context_t next_context;
+  unsigned long int i = smx_ctx_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) smx_ctx_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_wrapper()
+static void smx_ctx_sysv_resume_serial(smx_process_t first_process)
 {
-  /*FIXME: I would like to avoid accessing simix_global to get the current
-    context by passing it as an argument of the wrapper function. The problem
-    is that this function is called from smx_ctx_sysv_start, and uses
-    makecontext for calling it, and the stupid posix specification states that
-    all the arguments of the function should be int(32 bits), making it useless
-    in 64-bit architectures where pointers are 64 bit long.
-   */
-  smx_ctx_sysv_t context = 
-      (smx_ctx_sysv_t)simix_global->current_process->context;
-
-  (context->code) (context->argc, context->argv);
-
-  smx_ctx_sysv_stop((smx_context_t)context);
+  smx_context_t context = first_process->context;
+  SIMIX_context_set_current(context);
+  swapcontext(&smx_ctx_sysv_maestro_context->uc,
+      &((smx_ctx_sysv_t) context)->uc);
 }
 
-static void smx_ctx_sysv_suspend(smx_context_t context) {
-  int rv;
-  ucontext_t maestro_ctx = ((smx_ctx_sysv_t)simix_global->maestro_process->context)->uc;
+static void smx_ctx_sysv_runall_serial(void)
+{
+  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);
+    smx_ctx_sysv_process_index = 1;
 
-  rv = swapcontext(&((smx_ctx_sysv_t) context)->uc, &maestro_ctx);
+    /* execute the first process */
+    smx_ctx_sysv_resume_serial(first_process);
+  }
+}
 
-  xbt_assert0((rv == 0), "Context swapping failure");
+static void smx_ctx_sysv_stop_parallel(smx_context_t context)
+{
+  smx_ctx_base_stop(context);
+  smx_ctx_sysv_suspend_parallel(context);
 }
 
-static void 
-smx_ctx_sysv_resume(smx_context_t new_context) {
-  int rv;
-  smx_ctx_sysv_t maestro = (smx_ctx_sysv_t)simix_global->maestro_process->context;
+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(smx_ctx_sysv_parmap);
+  smx_context_t next_context;
+  ucontext_t* next_uc;
+
+  if (next_work != NULL) {
+    /* there is a next process to resume */
+    XBT_DEBUG("Run next process");
+    next_context = next_work->context;
+    next_uc = &((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) smx_ctx_sysv_maestro_context;
+    unsigned long worker_id = xbt_parmap_get_worker_id(smx_ctx_sysv_parmap);
+    next_uc = &smx_ctx_sysv_local_maestro_uc[worker_id];
+  }
 
-  rv = swapcontext(&(maestro->uc), &((smx_ctx_sysv_t)new_context)->uc);
+  SIMIX_context_set_current(next_context);
+  swapcontext(&((smx_ctx_sysv_t) context)->uc, next_uc);
+#endif
+}
 
-  xbt_assert0((rv == 0), "Context swapping failure");
+static void smx_ctx_sysv_resume_parallel(smx_process_t first_process)
+{
+#ifdef CONTEXT_THREADS
+  unsigned long worker_id = xbt_parmap_get_worker_id(smx_ctx_sysv_parmap);
+  ucontext_t* local_maestro_uc = &smx_ctx_sysv_local_maestro_uc[worker_id];
+
+  smx_context_t context = first_process->context;
+  SIMIX_context_set_current(context);
+  swapcontext(local_maestro_uc, &((smx_ctx_sysv_t) context)->uc);
+#endif
+}
+
+static void smx_ctx_sysv_runall_parallel(void)
+{
+#ifdef CONTEXT_THREADS
+  xbt_parmap_apply(smx_ctx_sysv_parmap, (void_f_pvoid_t) smx_ctx_sysv_resume_parallel,
+      simix_global->process_to_run);
+#endif
 }