src/kernel/context/Context.hpp

   1 /* Copyright (c) 2007-2021. 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 #ifndef SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
   7 #define SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <xbt/parmap.h>
  11
  12 #include "src/kernel/activity/ActivityImpl.hpp"
  13
  14 #include <csignal>
  15 #include <functional>
  16
  17 namespace simgrid {
  18 namespace kernel {
  19 namespace context {
  20 extern unsigned stack_size;
  21 extern unsigned guard_size;
  22
  23 class XBT_PUBLIC ContextFactory {
  24 public:
  25   explicit ContextFactory()             = default;
  26   ContextFactory(const ContextFactory&) = delete;
  27   ContextFactory& operator=(const ContextFactory&) = delete;
  28   virtual ~ContextFactory();
  29   virtual Context* create_context(std::function<void()>&& code, actor::ActorImpl* actor) = 0;
  30
  31   /** Turn the current thread into a simulation context */
  32   virtual Context* attach(actor::ActorImpl* actor);
  33   /** Turn the current thread into maestro (the old maestro becomes a regular actor) */
  34   virtual Context* create_maestro(std::function<void()>&& code, actor::ActorImpl* actor);
  35
  36   virtual void run_all() = 0;
  37
  38 protected:
  39   template <class T, class... Args> T* new_context(Args&&... args)
  40   {
  41     auto* context = new T(std::forward<Args>(args)...);
  42     context->declare_context(sizeof(T));
  43     return context;
  44   }
  45 };
  46
  47 class XBT_PUBLIC Context {
  48   friend ContextFactory;
  49
  50   static thread_local Context* current_context_;
  51
  52   std::function<void()> code_;
  53   actor::ActorImpl* actor_ = nullptr;
  54   bool iwannadie_          = false;
  55   void declare_context(std::size_t size);
  56
  57 public:
  58 #ifndef WIN32
  59   static int install_sigsegv_stack(stack_t* old_stack, bool enable);
  60 #endif
  61
  62   Context(std::function<void()>&& code, actor::ActorImpl* actor);
  63   Context(const Context&) = delete;
  64   Context& operator=(const Context&) = delete;
  65   virtual ~Context();
  66
  67   bool wannadie() const { return iwannadie_; }
  68   void set_wannadie(bool value = true) { iwannadie_ = value; }
  69   void operator()() const { code_(); }
  70   bool has_code() const { return static_cast<bool>(code_); }
  71   actor::ActorImpl* get_actor() const { return this->actor_; }
  72
  73   // Scheduling methods
  74   virtual void stop();
  75   virtual void suspend() = 0;
  76
  77   // Retrieving the self() context
  78   /** @brief Retrieves the current context of this thread */
  79   static Context* self();
  80   /** @brief Sets the current context of this thread */
  81   static void set_current(Context* self);
  82 };
  83
  84 class XBT_PUBLIC AttachContext : public Context {
  85 public:
  86   AttachContext(std::function<void()>&& code, actor::ActorImpl* actor) : Context(std::move(code), actor) {}
  87   AttachContext(const AttachContext&) = delete;
  88   AttachContext& operator=(const AttachContext&) = delete;
  89   ~AttachContext() override;
  90
  91   /** Called by the context when it is ready to give control
  92    *  to the maestro.
  93    */
  94   virtual void attach_start() = 0;
  95
  96   /** Called by the context when it has finished its job */
  97   virtual void attach_stop() = 0;
  98 };
  99
 100
 101 /* This allows Java to hijack the context factory (Java induces factories of factory :) */
 102 using ContextFactoryInitializer = ContextFactory* (*)();
 103 XBT_PUBLIC_DATA ContextFactoryInitializer factory_initializer;
 104
 105 XBT_PRIVATE ContextFactory* thread_factory();
 106 XBT_PRIVATE ContextFactory* sysv_factory();
 107 XBT_PRIVATE ContextFactory* raw_factory();
 108 XBT_PRIVATE ContextFactory* boost_factory();
 109
 110 XBT_PUBLIC int is_parallel();
 111 XBT_PUBLIC int get_nthreads();
 112 XBT_PUBLIC void set_nthreads(int nb_threads);
 113 XBT_PUBLIC void set_parallel_mode(e_xbt_parmap_mode_t mode);
 114 XBT_PUBLIC e_xbt_parmap_mode_t get_parallel_mode();
 115 } // namespace context
 116 } // namespace kernel
 117 } // namespace simgrid
 118
 119 #endif