Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
obey sonar and make SwappedContext::stack_ private
[simgrid.git] / src / kernel / context / ContextSwapped.cpp
index fc2663e..b550205 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2019. 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. */
@@ -34,41 +34,23 @@ namespace simgrid {
 namespace kernel {
 namespace context {
 
-/* Parallel execution */
-simgrid::xbt::Parmap<smx_actor_t>* SwappedContext::parmap_;
-std::atomic<uintptr_t> SwappedContext::threads_working_;       /* number of threads that have started their work */
+/* rank of the execution thread */
 thread_local uintptr_t SwappedContext::worker_id_;             /* thread-specific storage for the thread id */
-std::vector<SwappedContext*> SwappedContext::workers_context_; /* space to save the worker's context in each thread */
 
 SwappedContextFactory::SwappedContextFactory(std::string name)
     : ContextFactory(name), parallel_(SIMIX_context_is_parallel())
-{
-  SwappedContext::set_maestro(nullptr);
-  SwappedContext::initialize(parallel_);
-}
-SwappedContextFactory::~SwappedContextFactory()
-{
-  SwappedContext::finalize();
-}
-
-void SwappedContext::initialize(bool parallel)
 {
   parmap_ = nullptr; // will be created lazily with the right parameters if needed (ie, in parallel)
-  if (parallel) {
-    workers_context_.clear();
-    workers_context_.resize(SIMIX_context_get_nthreads(), nullptr);
-  }
+  workers_context_.clear();
+  workers_context_.resize(parallel_ ? SIMIX_context_get_nthreads() : 1, nullptr);
 }
-
-void SwappedContext::finalize()
+SwappedContextFactory::~SwappedContextFactory()
 {
   delete parmap_;
   parmap_ = nullptr;
   workers_context_.clear();
 }
 
-SwappedContext* SwappedContext::maestro_context_ = nullptr;
-
 SwappedContext::SwappedContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process,
                                SwappedContextFactory* factory)
     : Context(std::move(code), cleanup_func, process), factory_(factory)
@@ -152,9 +134,21 @@ SwappedContext::~SwappedContext()
   xbt_free(stack_);
 }
 
+void SwappedContext::set_maestro(SwappedContext* ctx)
+{
+  if (factory_->threads_working_ == 0) // Don't save the soul of minions, only the one of maestro
+    factory_->workers_context_[0] = ctx;
+}
+
+void* SwappedContext::get_stack()
+{
+  return stack_;
+}
+
 void SwappedContext::stop()
 {
   Context::stop();
+  /* We must cut the actor execution using an exception to properly free the C++ RAII variables */
   throw StopRequest();
 }
 
@@ -166,12 +160,11 @@ void SwappedContextFactory::run_all()
    * for the ones of the simulated processes that must run.
    */
   if (parallel_) {
-    SwappedContext::threads_working_ = 0;
+    threads_working_ = 0;
 
     // We lazily create the parmap so that all options are actually processed when doing so.
-    if (SwappedContext::parmap_ == nullptr)
-      SwappedContext::parmap_ =
-          new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
+    if (parmap_ == nullptr)
+      parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
 
     // Usually, Parmap::apply() executes the provided function on all elements of the array.
     // Here, the executed function does not return the control to the parmap before all the array is processed:
@@ -179,7 +172,7 @@ void SwappedContextFactory::run_all()
     //     the control to the parmap. Instead, it uses parmap_->next() to steal another work, and does it directly.
     //     It only yields back to worker_context when the work array is exhausted.
     //   - So, resume() is only launched from the parmap for the first job of each minion.
-    SwappedContext::parmap_->apply(
+    parmap_->apply(
         [](smx_actor_t process) {
           SwappedContext* context = static_cast<SwappedContext*>(process->context_);
           context->resume();
@@ -188,6 +181,8 @@ void SwappedContextFactory::run_all()
   } else { // sequential execution
     if (simix_global->process_to_run.empty())
       return;
+
+    /* maestro is already saved in the first slot of workers_context_ */
     smx_actor_t first_actor = simix_global->process_to_run.front();
     process_index_          = 1;
     /* execute the first actor; it will chain to the others when using suspend() */
@@ -205,17 +200,16 @@ void SwappedContext::resume()
 {
   if (factory_->parallel_) {
     // Save the thread number (my body) in an os-thread-specific area
-    worker_id_ = threads_working_.fetch_add(1, std::memory_order_relaxed);
+    worker_id_ = factory_->threads_working_.fetch_add(1, std::memory_order_relaxed);
     // Save my current soul (either maestro, or one of the minions) in a permanent area
     SwappedContext* worker_context = static_cast<SwappedContext*>(self());
-    workers_context_[worker_id_]   = worker_context;
+    factory_->workers_context_[worker_id_] = worker_context;
     // Switch my soul and the actor's one
     Context::set_current(this);
     worker_context->swap_into(this);
     // No body runs that soul anymore at this point, but it is stored in a safe place.
     // When the executed actor will do a blocking action, SIMIX_process_yield() will call suspend(), below.
   } else { // sequential execution
-    // Maestro is always the calling thread of this function (ie, self() == maestro)
     SwappedContext* old = static_cast<SwappedContext*>(self());
     Context::set_current(this);
     old->swap_into(this);
@@ -234,7 +228,7 @@ void SwappedContext::suspend()
 {
   if (factory_->parallel_) {
     // Get some more work to directly swap into the next executable actor instead of yielding back to the parmap
-    boost::optional<smx_actor_t> next_work = parmap_->next();
+    boost::optional<smx_actor_t> next_work = factory_->parmap_->next();
     SwappedContext* next_context;
     if (next_work) {
       // There is a next soul to embody (ie, another executable actor)
@@ -242,15 +236,16 @@ void SwappedContext::suspend()
       next_context = static_cast<SwappedContext*>(next_work.get()->context_);
     } else {
       // All actors were run, go back to the parmap context
-      XBT_DEBUG("No more processes to run");
+      XBT_DEBUG("No more actors to run");
       // worker_id_ is the identity of my body, stored in thread_local when starting the scheduling round
-      next_context = workers_context_[worker_id_];
+      next_context = factory_->workers_context_[worker_id_];
       // When given that soul, the body will wait for the next scheduling round
     }
 
     // Get the next soul to run, either from another actor or the initial minion's one
     Context::set_current(next_context);
     this->swap_into(next_context);
+
   } else { // sequential execution
     /* determine the next context */
     SwappedContext* next_context;
@@ -259,12 +254,12 @@ void SwappedContext::suspend()
 
     if (i < simix_global->process_to_run.size()) {
       /* Actually swap into the next actor directly without transiting to maestro */
-      XBT_DEBUG("Run next process");
+      XBT_DEBUG("Run next actor");
       next_context = static_cast<SwappedContext*>(simix_global->process_to_run[i]->context_);
     } else {
       /* all processes were run, actually return to maestro */
-      XBT_DEBUG("No more process to run");
-      next_context = static_cast<SwappedContext*>(get_maestro());
+      XBT_DEBUG("No more actors to run");
+      next_context = factory_->workers_context_[0];
     }
     Context::set_current(next_context);
     this->swap_into(next_context);