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/s4u/Host.hpp"
   9 #include "src/kernel/activity/CommImpl.hpp"
  10 #include "src/kernel/context/Context.hpp"
  11 #include "src/surf/surf_interface.hpp"
  12
  13 #include <vector>
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_context, kernel, "Context switching mechanism");
  16
  17 namespace simgrid {
  18 namespace kernel {
  19 namespace context {
  20
  21 ContextFactoryInitializer factory_initializer = nullptr;
  22 static e_xbt_parmap_mode_t parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
  23 static int parallel_contexts                             = 1;
  24 unsigned stack_size;
  25 unsigned guard_size;
  26
  27 /** @brief Returns whether some parallel threads are used for the user contexts. */
  28 bool is_parallel()
  29 {
  30   return parallel_contexts > 1;
  31 }
  32
  33 /**
  34  * @brief Returns the number of parallel threads used for the user contexts.
  35  * @return the number of threads (1 means no parallelism)
  36  */
  37 int get_nthreads()
  38 {
  39   return parallel_contexts;
  40 }
  41
  42 /**
  43  * @brief Sets the number of parallel threads to use  for the user contexts.
  44  *
  45  * This function should be called before initializing SIMIX.
  46  * A value of 1 means no parallelism (1 thread only).
  47  * If the value is greater than 1, the thread support must be enabled.
  48  *
  49  * @param nb_threads the number of threads to use
  50  */
  51 void set_nthreads(int nb_threads)
  52 {
  53   if (nb_threads <= 0) {
  54     nb_threads = std::thread::hardware_concurrency();
  55     XBT_INFO("Auto-setting contexts/nthreads to %d", nb_threads);
  56   }
  57   parallel_contexts = nb_threads;
  58 }
  59
  60 /**
  61  * @brief Sets the synchronization mode to use when actors are run in parallel.
  62  * @param mode how to synchronize threads if actors are run in parallel
  63  */
  64 void set_parallel_mode(e_xbt_parmap_mode_t mode)
  65 {
  66   parallel_synchronization_mode = mode;
  67 }
  68
  69 /**
  70  * @brief Returns the synchronization mode used when actors are run in parallel.
  71  * @return how threads are synchronized if actors are run in parallel
  72  */
  73 e_xbt_parmap_mode_t get_parallel_mode()
  74 {
  75   return parallel_synchronization_mode;
  76 }
  77
  78 ContextFactory::~ContextFactory() = default;
  79
  80 thread_local Context* Context::current_context_ = nullptr;
  81
  82 #ifndef WIN32
  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 #endif
  94
  95 Context* Context::self()
  96 {
  97   return current_context_;
  98 }
  99 void Context::set_current(Context* self)
 100 {
 101   current_context_ = self;
 102 }
 103
 104 void Context::declare_context(std::size_t size)
 105 {
 106 #if SIMGRID_HAVE_MC
 107   /* Store the address of the stack in heap to compare it apart of heap comparison */
 108   if(MC_is_active())
 109     MC_ignore_heap(this, size);
 110 #endif
 111 }
 112
 113 Context* ContextFactory::attach(actor::ActorImpl*)
 114 {
 115   xbt_die("Cannot attach with this ContextFactory.\n"
 116     "Try using --cfg=contexts/factory:thread instead.\n");
 117 }
 118
 119 Context* ContextFactory::create_maestro(std::function<void()>&&, actor::ActorImpl*)
 120 {
 121   xbt_die("Cannot create_maestro with this ContextFactory.\n"
 122     "Try using --cfg=contexts/factory:thread instead.\n");
 123 }
 124
 125 Context::Context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
 126     : code_(std::move(code)), actor_(actor), is_maestro_(maestro)
 127 {
 128   /* If we are creating maestro, we should set it as the current context */
 129   if (maestro)
 130     set_current(this);
 131 }
 132
 133 Context::~Context()
 134 {
 135   if (self() == this)
 136     set_current(nullptr);
 137 }
 138
 139 void Context::stop()
 140 {
 141   this->actor_->cleanup_from_self();
 142 }
 143
 144 void Context::set_wannadie(bool value)
 145 {
 146   XBT_DEBUG("Actor %s gonna die.", actor_->get_cname());
 147   iwannadie_ = value;
 148 }
 149 AttachContext::~AttachContext() = default;
 150
 151 } // namespace context
 152 } // namespace kernel
 153 } // namespace simgrid