Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Factorize valgrind stuff.
[simgrid.git] / src / simix / smx_context.c
index ec51170..57d84e2 100644 (file)
@@ -1,6 +1,6 @@
 /* a fast and simple context switching library                              */
 
-/* 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
 #include "xbt/log.h"
 #include "xbt/swag.h"
 #include "xbt/xbt_os_thread.h"
-#include "src/simix/private.h"
-#include "simix/context.h"
-#include "gras_config.h"
+#include "smx_private.h"
+#include "simgrid/sg_config.h"
+#include "internal_config.h"
+
+#ifdef HAVE_VALGRIND_VALGRIND_H
+# include <valgrind/valgrind.h>
+#endif
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix,
-                                "Context switching mecanism");
+                                "Context switching mechanism");
 
 char* smx_context_factory_name = NULL; /* factory name specified by --cfg=contexts/factory:value */
 smx_ctx_factory_initializer_t smx_factory_initializer_to_use = NULL;
-int smx_context_stack_size = 128 * 1024;
-
+int smx_context_stack_size;
+int smx_context_stack_size_was_set = 0;
 #ifdef HAVE_THREAD_LOCAL_STORAGE
-__thread smx_context_t smx_current_context;
+static __thread smx_context_t smx_current_context_parallel;
 #else
-smx_context_t smx_current_context; /* define it anyway, will be used in non-parallel mode */
 static xbt_os_thread_key_t smx_current_context_key = 0;
 #endif
-
+static smx_context_t smx_current_context_serial;
 static int smx_parallel_contexts = 1;
 static int smx_parallel_threshold = 2;
+static e_xbt_parmap_mode_t smx_parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
 
 /** 
  * This function is called by SIMIX_global_init() to initialize the context module.
  */
 void SIMIX_context_mod_init(void)
 {
+#if defined(CONTEXT_THREADS) && !defined(HAVE_THREAD_LOCAL_STORAGE)
+  /* the __thread storage class is not available on this platform:
+   * use getspecific/setspecific instead to store the current context in each thread */
+  xbt_os_thread_key_create(&smx_current_context_key);
+#endif
   if (!simix_global->context_factory) {
     /* select the context factory to use to create the contexts */
     if (smx_factory_initializer_to_use) {
@@ -43,41 +52,32 @@ void SIMIX_context_mod_init(void)
     }
     else { /* use the factory specified by --cfg=contexts/factory:value */
 
-    if (smx_context_factory_name == NULL) {
-        /* use the default factory */
-       #ifdef HAVE_RAWCTX
-       SIMIX_ctx_raw_factory_init(&simix_global->context_factory);
-       #elif CONTEXT_UCONTEXT
-               SIMIX_ctx_sysv_factory_init(&simix_global->context_factory);
-       #else
-               SIMIX_ctx_thread_factory_init(&simix_global->context_factory);
-       #endif
-    }
-    else if (!strcmp(smx_context_factory_name, "ucontext")) {
-        /* use ucontext */
+
+      if (!strcmp(smx_context_factory_name, "thread")) {
+        /* use os threads (either pthreads or windows ones) */
+        SIMIX_ctx_thread_factory_init(&simix_global->context_factory);
+      }
 #ifdef CONTEXT_UCONTEXT
+      else if (!strcmp(smx_context_factory_name, "ucontext")) {
+        /* use ucontext */
         SIMIX_ctx_sysv_factory_init(&simix_global->context_factory);
-#else
-        xbt_die("The context factory 'ucontext' unavailable on your system");
-#endif
-      }
-      else if (!strcmp(smx_context_factory_name, "thread")) {
-       /* use os threads (either pthreads or windows ones) */
-        SIMIX_ctx_thread_factory_init(&simix_global->context_factory);
       }
+#endif
+#ifdef HAVE_RAWCTX
       else if (!strcmp(smx_context_factory_name, "raw")) {
-       /* use raw contexts */
-       SIMIX_ctx_raw_factory_init(&simix_global->context_factory);
+        /* use raw contexts */
+        SIMIX_ctx_raw_factory_init(&simix_global->context_factory);
       }
+#endif
       else {
         XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
 #ifdef HAVE_RAWCTX
         XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
 #else
-        XBT_ERROR("  (raw contextes are disabled at compilation time on this machine -- check configure logs for details)");
+        XBT_ERROR("  (raw contexts are disabled at compilation time on this machine -- check configure logs for details)");
 #endif
 #ifdef CONTEXT_UCONTEXT
-        XBT_ERROR("  ucontext: classical system V contextes (implemented with makecontext, swapcontext and friends)");
+        XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
 #else
         XBT_ERROR("  (ucontext is disabled at compilation time on this machine -- check configure logs for details)");
 #endif
@@ -86,16 +86,10 @@ void SIMIX_context_mod_init(void)
       }
     }
   }
-
-#if defined(CONTEXT_THREADS) && !defined(HAVE_THREAD_LOCAL_STORAGE)
-  /* the __thread storage class is not available on this platform:
-   * use getspecific/setspecific instead to store the current context in each thread */
-  xbt_os_thread_key_create(&smx_current_context_key);
-#endif
 }
 
 /**
- * This function is call by SIMIX_clean() to finalize the context module.
+ * This function is called by SIMIX_clean() to finalize the context module.
  */
 void SIMIX_context_mod_exit(void)
 {
@@ -106,30 +100,45 @@ void SIMIX_context_mod_exit(void)
     finalize_factory = simix_global->context_factory->finalize;
     finalize_factory(&simix_global->context_factory);
   }
-  xbt_dict_remove((xbt_dict_t) _surf_cfg_set,"contexts/factory");
+  xbt_dict_remove((xbt_dict_t) _sg_cfg_set,"contexts/factory");
 }
 
-/**
- * \brief Sets the number of parallel threads to use
- * for the user contexts.
- *
- * This function should be called before initializing SIMIX.
- * A value of 1 means no parallelism.
- * If the value is greater than 1, the thread support must be enabled.
- *
- * \param nb_threads the number of threads to use
- */
-XBT_INLINE void SIMIX_context_set_nthreads(int nb_threads) {
+void *SIMIX_context_stack_new(void)
+{
+  void *stack = xbt_malloc0(smx_context_stack_size);
 
-  xbt_assert(nb_threads > 0, "Invalid number of parallel threads: %d", nb_threads);
+#ifdef HAVE_VALGRIND_VALGRIND_H
+  unsigned int valgrind_stack_id =
+    VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
+  memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id,
+         sizeof valgrind_stack_id);
+#endif
 
-  if (nb_threads > 1) {
-#ifndef CONTEXT_THREADS
-    THROWF(arg_error, 0, "No thread support for parallel context execution");
+  return stack;
+}
+
+void SIMIX_context_stack_delete(void *stack)
+{
+  if (!stack)
+    return;
+
+#ifdef HAVE_VALGRIND_VALGRIND_H
+  unsigned int valgrind_stack_id;
+  memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size,
+         sizeof valgrind_stack_id);
+  VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
 #endif
-  }
 
-  smx_parallel_contexts = nb_threads;
+  xbt_free(stack);
+}
+
+/**
+ * \brief Returns whether some parallel threads are used
+ * for the user contexts.
+ * \return 1 if parallelism is used
+ */
+XBT_INLINE int SIMIX_context_is_parallel(void) {
+  return smx_parallel_contexts > 1;
 }
 
 /**
@@ -142,38 +151,71 @@ XBT_INLINE int SIMIX_context_get_nthreads(void) {
 }
 
 /**
- * \brief Returns whether some parallel threads are used
+ * \brief Sets the number of parallel threads to use
  * for the user contexts.
- * \return 1 if parallelism is used
+ *
+ * This function should be called before initializing SIMIX.
+ * A value of 1 means no parallelism (1 thread only).
+ * If the value is greater than 1, the thread support must be enabled.
+ *
+ * \param nb_threads the number of threads to use
  */
-XBT_INLINE int SIMIX_context_is_parallel(void) {
-  return smx_parallel_contexts > 1;
+void SIMIX_context_set_nthreads(int nb_threads) {
+  if (nb_threads<=0) {  
+     nb_threads = xbt_os_get_numcores();
+     XBT_INFO("Auto-setting contexts/nthreads to %d",nb_threads);
+  }   
+  
+  if (nb_threads > 1) {
+#ifndef CONTEXT_THREADS
+    THROWF(arg_error, 0, "The thread factory cannot be run in parallel");
+#endif
+  }
+  smx_parallel_contexts = nb_threads;
 }
 
 /**
- * \brief Sets the threshold above which user processes are run in parallel.
+ * \brief Returns the threshold above which user processes are run in parallel.
  *
  * If the number of threads is set to 1, there is no parallelism and this
  * threshold has no effect.
  *
- * \param threshold when the number of user processes ready to run is above
+ * \return when the number of user processes ready to run is above
  * this threshold, they are run in parallel
  */
-XBT_INLINE void SIMIX_context_set_parallel_threshold(int threshold) {
-  smx_parallel_threshold = threshold;
+XBT_INLINE int SIMIX_context_get_parallel_threshold(void) {
+  return smx_parallel_threshold;
 }
 
 /**
- * \brief Returns the threshold above which user processes are run in parallel.
+ * \brief Sets the threshold above which user processes are run in parallel.
  *
  * If the number of threads is set to 1, there is no parallelism and this
  * threshold has no effect.
  *
- * \return when the number of user processes ready to run is above
+ * \param threshold when the number of user processes ready to run is above
  * this threshold, they are run in parallel
  */
-XBT_INLINE int SIMIX_context_get_parallel_threshold(void) {
-  return smx_parallel_threshold;
+XBT_INLINE void SIMIX_context_set_parallel_threshold(int threshold) {
+  smx_parallel_threshold = threshold;
+}
+
+/**
+ * \brief Returns the synchronization mode used when processes are run in
+ * parallel.
+ * \return how threads are synchronized if processes are run in parallel
+ */
+XBT_INLINE e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode(void) {
+  return smx_parallel_synchronization_mode;
+}
+
+/**
+ * \brief Sets the synchronization mode to use when processes are run in
+ * parallel.
+ * \param mode how to synchronize threads if processes are run in parallel
+ */
+XBT_INLINE void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
+  smx_parallel_synchronization_mode = mode;
 }
 
 /**
@@ -182,11 +224,16 @@ XBT_INLINE int SIMIX_context_get_parallel_threshold(void) {
  */
 XBT_INLINE smx_context_t SIMIX_context_get_current(void)
 {
+  if (SIMIX_context_is_parallel()) {
 #ifdef HAVE_THREAD_LOCAL_STORAGE
-  return smx_current_context;
+    return smx_current_context_parallel;
 #else
-  return xbt_os_thread_get_specific(smx_current_context_key);
+    return xbt_os_thread_get_specific(smx_current_context_key);
 #endif
+  }
+  else {
+    return smx_current_context_serial;
+  }
 }
 
 /**
@@ -195,10 +242,14 @@ XBT_INLINE smx_context_t SIMIX_context_get_current(void)
  */
 XBT_INLINE void SIMIX_context_set_current(smx_context_t context)
 {
+  if (SIMIX_context_is_parallel()) {
 #ifdef HAVE_THREAD_LOCAL_STORAGE
-  smx_current_context = context;
+    smx_current_context_parallel = context;
 #else
-  xbt_os_thread_set_specific(smx_current_context_key, context);
+    xbt_os_thread_set_specific(smx_current_context_key, context);
 #endif
+  }
+  else {
+    smx_current_context_serial = context;
+  }
 }
-