Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Constify pointer and reference local variables in src/kernel/.
[simgrid.git] / src / kernel / context / ContextSwapped.cpp
index b550205..e2ca416 100644 (file)
@@ -3,10 +3,11 @@
 /* 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 "simgrid/Exception.hpp"
 #include "simgrid/modelchecker.h"
 #include "src/internal_config.h"
+#include "src/kernel/actor/ActorImpl.hpp"
 #include "src/kernel/context/context_private.hpp"
-#include "src/simix/ActorImpl.hpp"
 #include "src/simix/smx_private.hpp"
 #include "xbt/parmap.hpp"
 
@@ -34,30 +35,19 @@ namespace simgrid {
 namespace kernel {
 namespace context {
 
-/* rank of the execution thread */
-thread_local uintptr_t SwappedContext::worker_id_;             /* thread-specific storage for the thread id */
+/* thread-specific storage for the worker's context */
+thread_local SwappedContext* SwappedContext::worker_context_ = nullptr;
 
-SwappedContextFactory::SwappedContextFactory(std::string name)
-    : ContextFactory(name), parallel_(SIMIX_context_is_parallel())
+SwappedContext::SwappedContext(std::function<void()>&& code, smx_actor_t actor, SwappedContextFactory* factory)
+    : Context(std::move(code), actor), factory_(factory)
 {
-  parmap_ = nullptr; // will be created lazily with the right parameters if needed (ie, in parallel)
-  workers_context_.clear();
-  workers_context_.resize(parallel_ ? SIMIX_context_get_nthreads() : 1, nullptr);
-}
-SwappedContextFactory::~SwappedContextFactory()
-{
-  delete parmap_;
-  parmap_ = nullptr;
-  workers_context_.clear();
-}
+  // Save maestro (=context created first) in preparation for run_all
+  if (not SIMIX_context_is_parallel() && factory->maestro_context_ == nullptr)
+    factory->maestro_context_ = this;
 
-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)
-{
   if (has_code()) {
+    xbt_assert((smx_context_stack_size & 0xf) == 0, "smx_context_stack_size should be multiple of 16");
     if (smx_context_guard_size > 0 && not MC_is_active()) {
-
 #if !defined(PTH_STACKGROWTH) || (PTH_STACKGROWTH != -1)
       xbt_die(
           "Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
@@ -71,14 +61,16 @@ SwappedContext::SwappedContext(std::function<void()> code, void_pfn_smxprocess_t
 #if SIMGRID_HAVE_MC
       /* Cannot use posix_memalign when SIMGRID_HAVE_MC. Align stack by hand, and save the
        * pointer returned by xbt_malloc0. */
-      char* alloc           = (char*)xbt_malloc0(size + xbt_pagesize);
-      stack_                = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
-      *((void**)stack_ - 1) = alloc;
+      unsigned char* alloc = static_cast<unsigned char*>(xbt_malloc0(size + xbt_pagesize));
+      stack_               = alloc - (reinterpret_cast<uintptr_t>(alloc) & (xbt_pagesize - 1)) + xbt_pagesize;
+      reinterpret_cast<unsigned char**>(stack_)[-1] = alloc;
 #elif !defined(_WIN32)
-      if (posix_memalign(&this->stack_, xbt_pagesize, size) != 0)
+      void* alloc;
+      if (posix_memalign(&alloc, xbt_pagesize, size) != 0)
         xbt_die("Failed to allocate stack.");
+      this->stack_ = static_cast<unsigned char*>(alloc);
 #else
-      this->stack_ = _aligned_malloc(size, xbt_pagesize);
+      this->stack_ = static_cast<unsigned char*>(_aligned_malloc(size, xbt_pagesize));
 #endif
 
 #ifndef _WIN32
@@ -87,21 +79,26 @@ SwappedContext::SwappedContext(std::function<void()> code, void_pfn_smxprocess_t
             "Failed to protect stack: %s.\n"
             "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
             "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
-            "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more "
-            "info.",
+            "Please see "
+            "https://simgrid.org/doc/latest/Configuring_SimGrid.html#configuring-the-user-code-virtualization for more "
+            "information.",
             strerror(errno));
         /* This is fatal. We are going to fail at some point when we try reusing this. */
       }
 #endif
-      this->stack_ = (char*)this->stack_ + smx_context_guard_size;
+      this->stack_ = this->stack_ + smx_context_guard_size;
     } else {
-      this->stack_ = xbt_malloc0(smx_context_stack_size);
+      this->stack_ = static_cast<unsigned char*>(xbt_malloc0(smx_context_stack_size));
     }
 
+#if PTH_STACKGROWTH == -1
+    ASAN_ONLY(this->asan_stack_ = this->stack_ + smx_context_stack_size);
+#else
+    ASAN_ONLY(this->asan_stack_ = this->stack_);
+#endif
 #if HAVE_VALGRIND_H
-    unsigned int valgrind_stack_id =
-        VALGRIND_STACK_REGISTER(this->stack_, (char*)this->stack_ + smx_context_stack_size);
-    memcpy((char*)this->stack_ + smx_context_usable_stack_size, &valgrind_stack_id, sizeof valgrind_stack_id);
+    if (RUNNING_ON_VALGRIND)
+      this->valgrind_stack_id_ = VALGRIND_STACK_REGISTER(this->stack_, this->stack_ + smx_context_stack_size);
 #endif
   }
 }
@@ -112,21 +109,20 @@ SwappedContext::~SwappedContext()
     return;
 
 #if HAVE_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);
+  if (RUNNING_ON_VALGRIND)
+    VALGRIND_STACK_DEREGISTER(valgrind_stack_id_);
 #endif
 
 #ifndef _WIN32
   if (smx_context_guard_size > 0 && not MC_is_active()) {
-    stack_ = (char*)stack_ - smx_context_guard_size;
+    stack_ = 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 */
     }
 #if SIMGRID_HAVE_MC
     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
-    stack_ = *((void**)stack_ - 1);
+    stack_ = reinterpret_cast<unsigned char**>(stack_)[-1];
 #endif
   }
 #endif /* not windows */
@@ -134,13 +130,7 @@ 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()
+unsigned char* SwappedContext::get_stack()
 {
   return stack_;
 }
@@ -149,7 +139,7 @@ void SwappedContext::stop()
 {
   Context::stop();
   /* We must cut the actor execution using an exception to properly free the C++ RAII variables */
-  throw StopRequest();
+  throw ForcefulKillException();
 }
 
 /** Maestro wants to run all ready actors */
@@ -159,12 +149,11 @@ void SwappedContextFactory::run_all()
    * stuff It is much easier to understand what happens if you see the working threads as bodies that swap their soul
    * for the ones of the simulated processes that must run.
    */
-  if (parallel_) {
-    threads_working_ = 0;
-
+  if (SIMIX_context_is_parallel()) {
     // We lazily create the parmap so that all options are actually processed when doing so.
     if (parmap_ == nullptr)
-      parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
+      parmap_.reset(
+          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:
@@ -174,19 +163,19 @@ void SwappedContextFactory::run_all()
     //   - So, resume() is only launched from the parmap for the first job of each minion.
     parmap_->apply(
         [](smx_actor_t process) {
-          SwappedContext* context = static_cast<SwappedContext*>(process->context_);
+          SwappedContext* context = static_cast<SwappedContext*>(process->context_.get());
           context->resume();
         },
-        simix_global->process_to_run);
+        simix_global->actors_to_run);
   } else { // sequential execution
-    if (simix_global->process_to_run.empty())
+    if (simix_global->actors_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();
+    const actor::ActorImpl* first_actor = simix_global->actors_to_run.front();
     process_index_          = 1;
     /* execute the first actor; it will chain to the others when using suspend() */
-    static_cast<SwappedContext*>(first_actor->context_)->resume();
+    static_cast<SwappedContext*>(first_actor->context_.get())->resume();
   }
 }
 
@@ -198,17 +187,14 @@ void SwappedContextFactory::run_all()
  */
 void SwappedContext::resume()
 {
-  if (factory_->parallel_) {
-    // Save the thread number (my body) in an os-thread-specific area
-    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());
-    factory_->workers_context_[worker_id_] = worker_context;
+  if (SIMIX_context_is_parallel()) {
+    // Save my current soul (either maestro, or one of the minions) in a thread-specific area
+    worker_context_ = static_cast<SwappedContext*>(self());
     // Switch my soul and the actor's one
     Context::set_current(this);
-    worker_context->swap_into(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.
+    // When the executed actor will do a blocking action, ActorImpl::yield() will call suspend(), below.
   } else { // sequential execution
     SwappedContext* old = static_cast<SwappedContext*>(self());
     Context::set_current(this);
@@ -216,7 +202,7 @@ void SwappedContext::resume()
   }
 }
 
-/** The actor wants to yield back to maestro, because it is blocked in a simcall (ie in SIMIX_process_yield())
+/** The actor wants to yield back to maestro, because it is blocked in a simcall (i.e., in ActorImpl::yield())
  *
  * Actually, it does not really yield back to maestro, but directly into the next executable actor.
  *
@@ -226,19 +212,19 @@ void SwappedContext::resume()
  */
 void SwappedContext::suspend()
 {
-  if (factory_->parallel_) {
+  if (SIMIX_context_is_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 = factory_->parmap_->next();
     SwappedContext* next_context;
     if (next_work) {
       // There is a next soul to embody (ie, another executable actor)
       XBT_DEBUG("Run next process");
-      next_context = static_cast<SwappedContext*>(next_work.get()->context_);
+      next_context = static_cast<SwappedContext*>(next_work.get()->context_.get());
     } else {
       // All actors were run, go back to the parmap context
       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 = factory_->workers_context_[worker_id_];
+      // worker_context_ is my own soul, stored in thread_local when starting the scheduling round
+      next_context = worker_context_;
       // When given that soul, the body will wait for the next scheduling round
     }
 
@@ -252,14 +238,14 @@ void SwappedContext::suspend()
     unsigned long int i = factory_->process_index_;
     factory_->process_index_++;
 
-    if (i < simix_global->process_to_run.size()) {
+    if (i < simix_global->actors_to_run.size()) {
       /* Actually swap into the next actor directly without transiting to maestro */
       XBT_DEBUG("Run next actor");
-      next_context = static_cast<SwappedContext*>(simix_global->process_to_run[i]->context_);
+      next_context = static_cast<SwappedContext*>(simix_global->actors_to_run[i]->context_.get());
     } else {
       /* all processes were run, actually return to maestro */
       XBT_DEBUG("No more actors to run");
-      next_context = factory_->workers_context_[0];
+      next_context = factory_->maestro_context_;
     }
     Context::set_current(next_context);
     this->swap_into(next_context);