src/kernel/context/Context.hpp

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