src/kernel/context/ContextSwapped.hpp

   1 /* Copyright (c) 2009-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_SWAPPED_CONTEXT_HPP
   7 #define SIMGRID_KERNEL_CONTEXT_SWAPPED_CONTEXT_HPP
   8
   9 #include "src/internal_config.h" // HAVE_SANITIZER_*
  10 #include "src/kernel/context/Context.hpp"
  11
  12 #include <memory>
  13
  14 namespace simgrid::kernel::context {
  15 class SwappedContext;
  16 } // namespace simgrid::kernel::context
  17
  18 /* Use extern "C" to make sure that this symbol is easy to recognize by name, even on exotic platforms */
  19 extern "C" XBT_ATTRIB_NORETURN void smx_ctx_wrapper(simgrid::kernel::context::SwappedContext* context);
  20
  21 namespace simgrid::kernel::context {
  22
  23 class SwappedContextFactory : public ContextFactory {
  24   friend SwappedContext; // Reads whether we are in parallel mode
  25 public:
  26   SwappedContextFactory()                             = default;
  27   SwappedContextFactory(const SwappedContextFactory&) = delete;
  28   SwappedContextFactory& operator=(const SwappedContextFactory&) = delete;
  29   void run_all(std::vector<actor::ActorImpl*> const& actors) override;
  30
  31 private:
  32   /* For the sequential execution */
  33   unsigned long process_index_     = 0;       // next actor to execute
  34   SwappedContext* maestro_context_ = nullptr; // save maestro's context
  35
  36   /* For the parallel execution, will be created lazily with the right parameters if needed (ie, in parallel) */
  37   std::unique_ptr<simgrid::xbt::Parmap<actor::ActorImpl*>> parmap_{nullptr};
  38 };
  39
  40 class SwappedContext : public Context {
  41   friend void ::smx_ctx_wrapper(simgrid::kernel::context::SwappedContext*);
  42
  43 public:
  44   SwappedContext(std::function<void()>&& code, actor::ActorImpl* get_actor, SwappedContextFactory* factory);
  45   SwappedContext(const SwappedContext&) = delete;
  46   SwappedContext& operator=(const SwappedContext&) = delete;
  47   ~SwappedContext() override;
  48
  49   void suspend() override;
  50   virtual void resume();
  51
  52   void swap_into(SwappedContext* to);
  53
  54 protected:
  55   unsigned char* get_stack() const { return stack_; }
  56   unsigned char* get_stack_bottom() const; // Depending on the stack direction, its bottom (that Boost::make_fcontext
  57                                            // needs) may be the lower or higher end
  58
  59   // With ASan, after a context switch, check that the originating context is the expected one (see BoostContext)
  60   void verify_previous_context(const SwappedContext* context) const;
  61
  62 private:
  63   static thread_local SwappedContext* worker_context_;
  64
  65   unsigned char* stack_ = nullptr; // the thread stack
  66   SwappedContextFactory& factory_; // for sequential and parallel run_all()
  67
  68 #if HAVE_VALGRIND_H
  69   unsigned int valgrind_stack_id_ = 0;
  70 #endif
  71 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
  72   const void* asan_stack_   = nullptr;
  73   size_t asan_stack_size_   = 0;
  74   SwappedContext* asan_ctx_ = nullptr;
  75   bool asan_stop_           = false;
  76 #endif
  77 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
  78   void* tsan_fiber_;
  79 #endif
  80
  81   virtual void swap_into_for_real(SwappedContext* to) = 0; // Defined in Raw, Boost and UContext subclasses
  82 };
  83
  84 inline void SwappedContext::verify_previous_context(XBT_ATTRIB_UNUSED const SwappedContext* context) const
  85 {
  86 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
  87   xbt_assert(this->asan_ctx_ == context);
  88 #endif
  89 }
  90
  91 } // namespace simgrid::kernel::context
  92 #endif