src/kernel/context/Context.cpp

   1 /* Copyright (c) 2007-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "mc/mc.h"
   7
   8 #include "simgrid/Exception.hpp"
   9 #include "simgrid/s4u/Host.hpp"
  10 #include "src/kernel/activity/CommImpl.hpp"
  11 #include "src/kernel/context/Context.hpp"
  12 #include "src/surf/surf_interface.hpp"
  13
  14 #include <vector>
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_context, kernel, "Context switching mechanism");
  17
  18 namespace simgrid {
  19 namespace kernel {
  20 namespace context {
  21
  22 std::function<ContextFactory*(void)> ContextFactory::initializer;
  23
  24 static e_xbt_parmap_mode_t parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
  25 static int parallel_contexts                             = 1;
  26 unsigned stack_size;
  27 unsigned guard_size;
  28
  29 /** @brief Returns whether some parallel threads are used for the user contexts. */
  30 bool is_parallel()
  31 {
  32   return parallel_contexts > 1;
  33 }
  34
  35 /**
  36  * @brief Returns the number of parallel threads used for the user contexts.
  37  * @return the number of threads (1 means no parallelism)
  38  */
  39 int get_nthreads()
  40 {
  41   return parallel_contexts;
  42 }
  43
  44 /**
  45  * @brief Sets the number of parallel threads to use  for the user contexts.
  46  *
  47  * This function should be called before initializing SIMIX.
  48  * A value of 1 means no parallelism (1 thread only).
  49  * If the value is greater than 1, the thread support must be enabled.
  50  *
  51  * @param nb_threads the number of threads to use
  52  */
  53 void set_nthreads(int nb_threads)
  54 {
  55   if (nb_threads <= 0) {
  56     nb_threads = std::thread::hardware_concurrency();
  57     XBT_INFO("Auto-setting contexts/nthreads to %d", nb_threads);
  58   }
  59   parallel_contexts = nb_threads;
  60 }
  61
  62 /**
  63  * @brief Sets the synchronization mode to use when actors are run in parallel.
  64  * @param mode how to synchronize threads if actors are run in parallel
  65  */
  66 void set_parallel_mode(e_xbt_parmap_mode_t mode)
  67 {
  68   parallel_synchronization_mode = mode;
  69 }
  70
  71 /**
  72  * @brief Returns the synchronization mode used when actors are run in parallel.
  73  * @return how threads are synchronized if actors are run in parallel
  74  */
  75 e_xbt_parmap_mode_t get_parallel_mode()
  76 {
  77   return parallel_synchronization_mode;
  78 }
  79
  80 ContextFactory::~ContextFactory() = default;
  81
  82 thread_local Context* Context::current_context_ = nullptr;
  83
  84 #ifndef WIN32
  85 /* Install or disable alternate signal stack, for SIGSEGV handler. */
  86 int Context::install_sigsegv_stack(stack_t* old_stack, bool enable)
  87 {
  88   static std::vector<unsigned char> sigsegv_stack(SIGSTKSZ);
  89   stack_t stack;
  90   stack.ss_sp    = sigsegv_stack.data();
  91   stack.ss_size  = sigsegv_stack.size();
  92   stack.ss_flags = enable ? 0 : SS_DISABLE;
  93   return sigaltstack(&stack, old_stack);
  94 }
  95 #endif
  96
  97 Context* Context::self()
  98 {
  99   return current_context_;
 100 }
 101 void Context::set_current(Context* self)
 102 {
 103   current_context_ = self;
 104 }
 105
 106 void Context::declare_context(std::size_t size)
 107 {
 108 #if SIMGRID_HAVE_MC
 109   /* Store the address of the stack in heap to compare it apart of heap comparison */
 110   if(MC_is_active())
 111     MC_ignore_heap(this, size);
 112 #endif
 113 }
 114
 115 Context* ContextFactory::attach(actor::ActorImpl*)
 116 {
 117   xbt_die("Cannot attach with this ContextFactory.\n"
 118     "Try using --cfg=contexts/factory:thread instead.\n");
 119 }
 120
 121 Context* ContextFactory::create_maestro(std::function<void()>&&, actor::ActorImpl*)
 122 {
 123   xbt_die("Cannot create_maestro with this ContextFactory.\n"
 124     "Try using --cfg=contexts/factory:thread instead.\n");
 125 }
 126
 127 Context::Context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
 128     : code_(std::move(code)), actor_(actor), is_maestro_(maestro)
 129 {
 130   /* If we are creating maestro, we should set it as the current context */
 131   if (maestro)
 132     set_current(this);
 133 }
 134
 135 Context::~Context()
 136 {
 137   if (self() == this)
 138     set_current(nullptr);
 139 }
 140
 141 void Context::stop()
 142 {
 143   this->actor_->cleanup_from_self();
 144   throw ForcefulKillException(); // clean RAII variables with the dedicated exception
 145 }
 146 AttachContext::~AttachContext() = default;
 147
 148 } // namespace context
 149 } // namespace kernel
 150 } // namespace simgrid