src/kernel/context/Context.cpp

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