Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ContextUnix: add header file with class definitions.
[simgrid.git] / src / kernel / context / ContextUnix.cpp
index 02b3a6e..c0d29fb 100644 (file)
-/* Copyright (c) 2009-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2009-2017. 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. */
 
-/* \file UContext.cpp Context switching with ucontexts from System V         */
+/* \file UContext.cpp Context switching with ucontexts from System V        */
 
-#include <stdarg.h>
+#include "ContextUnix.hpp"
 
-#include <functional>
-#include <ucontext.h>           /* context relative declarations */
-
-#include "xbt/parmap.h"
-#include "src/simix/smx_private.h"
-#include "src/internal_config.h"
 #include "mc/mc.h"
+#include "src/mc/mc_ignore.h"
+#include "src/simix/ActorImpl.hpp"
+
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
 /** Many integers are needed to store a pointer
  *
- * This is a bit paranoid about sizeof(smx_ctx_sysv_t) not being a multiple
- * of sizeof(int), but it doesn't harm. */
-#define CTX_ADDR_LEN                            \
-  (sizeof(void*) / sizeof(int) +       \
-   !!(sizeof(void*) % sizeof(int)))
+ * Support up to two ints. */
+constexpr int CTX_ADDR_LEN = 2;
+
+static_assert(sizeof(simgrid::kernel::context::UContext*) <= CTX_ADDR_LEN * sizeof(int),
+              "Ucontexts are not supported on this arch yet");
 
 /** A better makecontext
  *
  * Makecontext expects integer arguments, we the context
  * variable is decomposed into a serie of integers and
  * each integer is passed as argument to makecontext. */
-static void simgrid_makecontext(ucontext_t* ucp, void (*func)(int first, ...), void* arg)
+static void simgrid_makecontext(ucontext_t* ucp, void (*func)(int, int), simgrid::kernel::context::UContext* arg)
 {
-  int ctx_addr[CTX_ADDR_LEN];
-  memcpy(ctx_addr, &arg, sizeof(void*));
-  switch (CTX_ADDR_LEN) {
-  case 1:
-    makecontext(ucp, (void (*)())func, 1, ctx_addr[0]);
-    break;
-  case 2:
-    makecontext(ucp, (void (*)()) func, 2, ctx_addr[0], ctx_addr[1]);
-    break;
-  default:
-    xbt_die("Ucontexts are not supported on this arch yet (addr len = %zu/%zu = %zu)", sizeof(void*), sizeof(int), CTX_ADDR_LEN);
-  }
-}
-
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
-
-namespace simgrid {
-namespace simix {
-  class UContext;
-  class SerialUContext;
-  class ParallelUContext;
-  class UContextFactory;
-}
+  int ctx_addr[CTX_ADDR_LEN]{};
+  memcpy(ctx_addr, &arg, sizeof arg);
+  makecontext(ucp, (void (*)())func, 2, ctx_addr[0], ctx_addr[1]);
 }
 
 #if HAVE_THREAD_CONTEXTS
-static xbt_parmap_t sysv_parmap;
-static simgrid::simix::ParallelUContext** sysv_workers_context;   /* space to save the worker's context in each thread */
+static simgrid::xbt::Parmap<smx_actor_t>* sysv_parmap;
+static simgrid::kernel::context::UContext** sysv_workers_context; /* space to save the worker's context
+                                                                   * in each thread */
 static uintptr_t 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 simgrid::simix::UContext* sysv_maestro_context;
+static simgrid::kernel::context::UContext* sysv_maestro_context;
 static bool sysv_parallel;
 
 // The name of this function is currently hardcoded in the code (as string).
 // Do not change it without fixing those references as well.
-static void smx_ctx_sysv_wrapper(int first, ...);
+static void smx_ctx_sysv_wrapper(int, int);
 
 namespace simgrid {
-namespace simix {
-
-class UContext : public Context {
-protected:
-  ucontext_t uc_;         /* the ucontext that executes the code */
-  char *stack_ = nullptr; /* the thread stack */
-public:
-  friend UContextFactory;
-  UContext(std::function<void()>  code,
-    void_pfn_smxprocess_t cleanup_func, smx_process_t process);
-  ~UContext() override;
-};
-
-class SerialUContext : public UContext {
-public:
-  SerialUContext(std::function<void()>  code,
-      void_pfn_smxprocess_t cleanup_func, smx_process_t process)
-    : UContext(std::move(code), cleanup_func, process)
-  {}
-  void stop() override;
-  void suspend() override;
-  void resume();
-};
-
-class ParallelUContext : public UContext {
-public:
-  ParallelUContext(std::function<void()>  code,
-      void_pfn_smxprocess_t cleanup_func, smx_process_t process)
-    : UContext(std::move(code), cleanup_func, process)
-  {}
-  void stop() override;
-  void suspend() override;
-  void resume();
-};
-
-class UContextFactory : public ContextFactory {
-public:
-  friend UContext;
-  friend SerialUContext;
-  friend ParallelUContext;
-
-  UContextFactory();
-  ~UContextFactory() override;
-  Context* create_context(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup, smx_process_t process) override;
-  void run_all() override;
-};
+namespace kernel {
+namespace context {
 
 XBT_PRIVATE ContextFactory* sysv_factory()
 {
@@ -133,7 +66,7 @@ UContextFactory::UContextFactory() : ContextFactory("UContextFactory")
 #if HAVE_THREAD_CONTEXTS  /* To use parallel ucontexts a thread pool is needed */
     int nthreads = SIMIX_context_get_nthreads();
     sysv_parmap = nullptr;
-    sysv_workers_context = xbt_new(ParallelUContext*, nthreads);
+    sysv_workers_context = new UContext*[nthreads];
     sysv_maestro_context = nullptr;
     xbt_os_thread_key_create(&sysv_worker_id_key);
 #else
@@ -147,9 +80,8 @@ UContextFactory::UContextFactory() : ContextFactory("UContextFactory")
 UContextFactory::~UContextFactory()
 {
 #if HAVE_THREAD_CONTEXTS
-  if (sysv_parmap)
-    xbt_parmap_destroy(sysv_parmap);
-  xbt_free(sysv_workers_context);
+  delete sysv_parmap;
+  delete[] sysv_workers_context;
 #endif
 }
 
@@ -160,7 +92,7 @@ UContextFactory::~UContextFactory()
 void UContextFactory::run_all()
 {
   if (sysv_parallel) {
-    #if HAVE_THREAD_CONTEXTS
+#if HAVE_THREAD_CONTEXTS
       sysv_threads_working = 0;
       // Parmap_apply ensures that every working thread get an index in the
       // process_to_run array (through an atomic fetch_and_add),
@@ -170,32 +102,32 @@ void UContextFactory::run_all()
       // with simix_global->context_factory (which might not be initialized
       // when bootstrapping):
       if (sysv_parmap == nullptr)
-        sysv_parmap = xbt_parmap_new(
-          SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
-
-      xbt_parmap_apply(sysv_parmap,
-        [](void* arg) {
-          smx_process_t process = (smx_process_t) arg;
-          ParallelUContext* context = static_cast<ParallelUContext*>(process->context);
-          context->resume();
-        },
-        simix_global->process_to_run);
-    #else
+        sysv_parmap =
+            new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
+
+      sysv_parmap->apply(
+          [](smx_actor_t process) {
+            ParallelUContext* context = static_cast<ParallelUContext*>(process->context);
+            context->resume();
+          },
+          simix_global->process_to_run);
+#else
       xbt_die("You asked for a parallel execution, but you don't have any threads.");
-    #endif
+#endif
   } else {
     // Serial:
-      smx_process_t first_process =
-          xbt_dynar_get_as(simix_global->process_to_run, 0, smx_process_t);
-      sysv_process_index = 1;
-      SerialUContext* context =
-        static_cast<SerialUContext*>(first_process->context);
-      context->resume();
+    if (simix_global->process_to_run.empty())
+      return;
+
+    smx_actor_t first_process = simix_global->process_to_run.front();
+    sysv_process_index = 1;
+    SerialUContext* context = static_cast<SerialUContext*>(first_process->context);
+    context->resume();
   }
 }
 
 Context* UContextFactory::create_context(std::function<void()> code,
-  void_pfn_smxprocess_t cleanup, smx_process_t process)
+  void_pfn_smxprocess_t cleanup, smx_actor_t process)
 {
   if (sysv_parallel)
     return new_context<ParallelUContext>(std::move(code), cleanup, process);
@@ -204,7 +136,7 @@ Context* UContextFactory::create_context(std::function<void()> code,
 }
 
 UContext::UContext(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup_func, smx_process_t process)
+    void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
   : Context(std::move(code), cleanup_func, process)
 {
   /* if the user provided a function for the process then use it, otherwise it is the context for maestro */
@@ -220,7 +152,7 @@ UContext::UContext(std::function<void()> code,
       sysv_maestro_context = this;
   }
 
-#if HAVE_MC
+#if SIMGRID_HAVE_MC
   if (MC_is_active() && has_code()) {
     MC_register_stack_area(this->stack_, process,
                       &(this->uc_), smx_context_usable_stack_size);
@@ -233,56 +165,51 @@ UContext::~UContext()
   SIMIX_context_stack_delete(this->stack_);
 }
 
+void UContext::stop()
+{
+  Context::stop();
+  throw StopRequest();
 }
-}
+}}} // namespace simgrid::kernel::context
 
-static void smx_ctx_sysv_wrapper(int first, ...)
+static void smx_ctx_sysv_wrapper(int i1, int i2)
 {
   // Rebuild the Context* pointer from the integers:
-  int ctx_addr[CTX_ADDR_LEN];
-  simgrid::simix::UContext* context;
-  ctx_addr[0] = first;
-  if (CTX_ADDR_LEN > 1) {
-    va_list ap;
-    va_start(ap, first);
-    for (unsigned i = 1; i < CTX_ADDR_LEN; i++)
-      ctx_addr[i] = va_arg(ap, int);
-    va_end(ap);
+  int ctx_addr[CTX_ADDR_LEN] = {i1, i2};
+  simgrid::kernel::context::UContext* context;
+  memcpy(&context, ctx_addr, sizeof context);
+
+  try {
+    (*context)();
+    context->Context::stop();
+  } catch (simgrid::kernel::context::Context::StopRequest const&) {
+    XBT_DEBUG("Caught a StopRequest");
   }
-  memcpy(&context, ctx_addr, sizeof(simgrid::simix::UContext*));
-
-  (*context)();
-  context->stop();
+  context->suspend();
 }
 
 namespace simgrid {
-namespace simix {
-
-void SerialUContext::stop()
-{
-  Context::stop();
-  this->suspend();
-}
+namespace kernel {
+namespace context {
 
 void SerialUContext::suspend()
 {
   /* determine the next context */
-  SerialUContext* next_context = nullptr;
-  unsigned long int i = sysv_process_index++;
+  UContext* next_context = nullptr;
+  unsigned long int i    = sysv_process_index;
+  sysv_process_index++;
 
-  if (i < xbt_dynar_length(simix_global->process_to_run)) {
+  if (i < simix_global->process_to_run.size()) {
     /* execute the next process */
     XBT_DEBUG("Run next process");
-    next_context = (SerialUContext*) xbt_dynar_get_as(
-        simix_global->process_to_run,i, smx_process_t)->context;
-  }
-  else {
+    next_context = static_cast<UContext*>(simix_global->process_to_run[i]->context);
+  } else {
     /* all processes were run, return to maestro */
     XBT_DEBUG("No more process to run");
-    next_context = (SerialUContext*) sysv_maestro_context;
+    next_context = sysv_maestro_context;
   }
   SIMIX_context_set_current(next_context);
-  swapcontext(&this->uc_, &next_context->uc_);
+  UContext::swap(this, next_context);
 }
 
 // UContextSerial
@@ -290,13 +217,7 @@ void SerialUContext::suspend()
 void SerialUContext::resume()
 {
   SIMIX_context_set_current(this);
-  swapcontext(&((SerialUContext*)sysv_maestro_context)->uc_, &this->uc_);
-}
-
-void ParallelUContext::stop()
-{
-  UContext::stop();
-  this->suspend();
+  UContext::swap(sysv_maestro_context, this);
 }
 
 /** Run one particular simulated process on the current thread. */
@@ -308,15 +229,13 @@ void ParallelUContext::resume()
   // Store the number of my containing body in os-thread-specific area :
   xbt_os_thread_set_specific(sysv_worker_id_key, (void*) worker_id);
   // Get my current soul:
-  ParallelUContext* worker_context = (ParallelUContext*) SIMIX_context_self();
+  UContext* worker_context = static_cast<UContext*>(SIMIX_context_self());
   // Write down that this soul is hosted in that body (for now)
   sysv_workers_context[worker_id] = worker_context;
-  // Retrieve the system-level info that fuels this soul:
-  ucontext_t* worker_stack = &((ParallelUContext*) worker_context)->uc_;
   // Write in simix that I switched my soul
   SIMIX_context_set_current(this);
    // Actually do that using the relevant library call:
-  swapcontext(worker_stack, &this->uc_);
+  UContext::swap(worker_context, this);
   // 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
@@ -346,17 +265,13 @@ void ParallelUContext::suspend()
 #if HAVE_THREAD_CONTEXTS
   /* determine the next context */
   // Get the next soul to embody now:
-  smx_process_t next_work = (smx_process_t) xbt_parmap_next(sysv_parmap);
-  ParallelUContext* next_context = nullptr;
-  // Will contain the next soul to run, either simulated or initial minion's one
-  ucontext_t* next_stack;
-
-  if (next_work != nullptr) {
+  boost::optional<smx_actor_t> next_work = sysv_parmap->next();
+  UContext* next_context;
+  if (next_work) {
     // There is a next soul to embody (ie, a next process to resume)
     XBT_DEBUG("Run next process");
-    next_context = (ParallelUContext*) next_work->context;
-  }
-  else {
+    next_context = static_cast<UContext*>(next_work.get()->context);
+  } else {
     // All processes were run, go to the barrier
     XBT_DEBUG("No more processes to run");
     // Get back the identity of my body that was stored when starting
@@ -364,18 +279,15 @@ void ParallelUContext::suspend()
     uintptr_t worker_id =
         (uintptr_t) xbt_os_thread_get_specific(sysv_worker_id_key);
     // Deduce the initial soul of that body
-    next_context = (ParallelUContext*) sysv_workers_context[worker_id];
+    next_context = sysv_workers_context[worker_id];
     // When given that soul, the body will wait for the next scheduling round
   }
 
-  next_stack = &next_context->uc_;
-
   SIMIX_context_set_current(next_context);
-  // Get that next soul:
-  swapcontext(&this->uc_, next_stack);
+  // Get the next soul to run, either simulated or initial minion's one:
+  UContext::swap(this, next_context);
 #endif
 }
 
-}
-}
+}}} // namespace simgrid::kernel::context