Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[SIMIX] Updated error messages for contexts
[simgrid.git] / src / simix / smx_context.c
index 01de34b..a801c04 100644 (file)
@@ -1,41 +1,66 @@
 /* a fast and simple context switching library                              */
 
-/* Copyright (c) 2009 - 2011. The SimGrid Team.
+/* Copyright (c) 2009-2015. 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 "portable.h"
+#include "src/portable.h"
 #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 "src/internal_config.h"
+#include "simgrid/modelchecker.h"
+
+
+#ifdef _WIN32
+#include <windows.h>
+#include <malloc.h>
+#else
+#include <sys/mman.h>
+#endif
+
+#ifdef __MINGW32__ 
+#define _aligned_malloc __mingw_aligned_malloc 
+#define _aligned_free  __mingw_aligned_free 
+#endif //MINGW
+
+#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;
+int smx_context_guard_size;
+int smx_context_guard_size_was_set = 0;
 #ifdef HAVE_THREAD_LOCAL_STORAGE
-static __thread smx_context_t smx_current_context_parallel;
+static XBT_THREAD_LOCAL smx_context_t smx_current_context_parallel;
 #else
 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_FUTEX;
+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,59 +68,55 @@ 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
+#ifdef HAVE_BOOST_CONTEXT
+      else if (!strcmp(smx_context_factory_name, "boost")) {
+        /* use Boost.Context */
+        SIMIX_ctx_boost_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 were 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 was disabled at compilation time on this machine -- check configure logs for details)");
+#endif
+#ifdef HAVE_BOOST_CONTEXT
+        XBT_ERROR("  boost: this uses the boost libraries context implementation");
 #else
-        XBT_ERROR("  (ucontext is disabled at compilation time on this machine -- check configure logs for details)");
+        XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you install the libboost-context-dev package?)");
 #endif
         XBT_ERROR("  thread: slow portability layer using system threads (pthreads on UNIX, CreateThread() on windows)");
         xbt_die("Please use a valid factory.");
       }
     }
   }
-
-#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,7 +127,92 @@ 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");
+}
+
+void *SIMIX_context_stack_new(void)
+{
+  void *stack;
+
+  /* FIXME: current code for stack overflow protection assumes that stacks are
+   * growing downward (PTH_STACKGROWTH == -1).  Protected pages need to be put
+   * after the stack when PTH_STACKGROWTH == 1. */
+
+  if (smx_context_guard_size > 0 && !MC_is_active()) {
+
+#if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
+    static int warned_once = 0;
+    if (!warned_once) {
+      XBT_WARN("Stack overflow protection is known to be broken on your system.  Either you're on Windows or PTH_STACKGROWTH != -1 (current value is %d).",
+               PTH_STACKGROWTH);
+      warned_once = 1;
+    }
+#endif
+
+    size_t size = smx_context_stack_size + smx_context_guard_size;
+#ifdef HAVE_MC
+    /* Cannot use posix_memalign when HAVE_MC. Align stack by hand, and save the
+     * pointer returned by xbt_malloc0. */
+    char *alloc = xbt_malloc0(size + xbt_pagesize);
+    stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
+    *((void **)stack - 1) = alloc;
+#elif !defined(_XBT_WIN32)
+    if (posix_memalign(&stack, xbt_pagesize, size) != 0)
+      xbt_die("Failed to allocate stack.");
+#else
+    stack = _aligned_malloc(size, xbt_pagesize);
+#endif
+
+#ifndef _XBT_WIN32
+    if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
+      xbt_die("Failed to protect stack: %s", strerror(errno));
+      /* This is fatal. We are going to fail at some point when
+         we tryi reusing this. */
+    }
+#endif
+    stack = (char *)stack + smx_context_guard_size;
+  } else {
+    stack = xbt_malloc0(smx_context_stack_size);
+  }
+
+#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
+
+  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
+
+#ifndef WIN32
+  if (smx_context_guard_size > 0 && !MC_is_active()) {
+    stack = (char *)stack - smx_context_guard_size;
+    if (mprotect(stack, smx_context_guard_size,
+                 PROT_READ | PROT_WRITE) == -1) {
+      XBT_WARN("Failed to remove page protection: %s", strerror(errno));
+      /* try to pursue anyway */
+    }
+#ifdef HAVE_MC
+    /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
+    stack = *((void **)stack - 1);
+#endif
+  }
+#endif
+
+  xbt_free(stack);
 }
 
 /**
@@ -132,30 +238,22 @@ XBT_INLINE int SIMIX_context_get_nthreads(void) {
  * for the user contexts.
  *
  * This function should be called before initializing SIMIX.
- * A value of 1 means no parallelism.
+ * 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 void SIMIX_context_set_nthreads(char* str_nb_threads) {
-
-  int nb_threads;
-
-  if(!strcmp(str_nb_threads,"auto")){
-      nb_threads = PROCESSOR_COUNT;
-      XBT_DEBUG("Auto-setting threads to %d",nb_threads);
-  }
-  else
-    nb_threads = atoi(str_nb_threads);
-
-  xbt_assert(nb_threads > 0, "Invalid number of parallel threads: %d", nb_threads);
-
+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;
 }
 
@@ -238,4 +336,3 @@ XBT_INLINE void SIMIX_context_set_current(smx_context_t context)
     smx_current_context_serial = context;
   }
 }
-