Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2023.
[simgrid.git] / src / kernel / context / ContextSwapped.hpp
index 6e56bb1..939e281 100644 (file)
@@ -1,65 +1,92 @@
-/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#ifndef SIMGRID_SIMIX_SWAPPED_CONTEXT_HPP
-#define SIMGRID_SIMIX_SWAPPED_CONTEXT_HPP
+#ifndef SIMGRID_KERNEL_CONTEXT_SWAPPED_CONTEXT_HPP
+#define SIMGRID_KERNEL_CONTEXT_SWAPPED_CONTEXT_HPP
 
+#include "src/internal_config.h" // HAVE_SANITIZER_*
 #include "src/kernel/context/Context.hpp"
 
-#include <vector>
+#include <memory>
 
-namespace simgrid {
-namespace kernel {
-namespace context {
+namespace simgrid::kernel::context {
 class SwappedContext;
+} // namespace simgrid::kernel::context
+
+/* Use extern "C" to make sure that this symbol is easy to recognize by name, even on exotic platforms */
+extern "C" XBT_ATTRIB_NORETURN void smx_ctx_wrapper(simgrid::kernel::context::SwappedContext* context);
+
+namespace simgrid::kernel::context {
 
 class SwappedContextFactory : public ContextFactory {
   friend SwappedContext; // Reads whether we are in parallel mode
 public:
-  SwappedContextFactory(std::string name);
-  ~SwappedContextFactory() override;
-  void run_all() override;
+  SwappedContextFactory()                             = default;
+  SwappedContextFactory(const SwappedContextFactory&) = delete;
+  SwappedContextFactory& operator=(const SwappedContextFactory&) = delete;
+  void run_all(std::vector<actor::ActorImpl*> const& actors) override;
 
 private:
-  bool parallel_;
+  /* For the sequential execution */
+  unsigned long process_index_     = 0;       // next actor to execute
+  SwappedContext* maestro_context_ = nullptr; // save maestro's context
 
-  unsigned long process_index_ = 0; // Next actor to execute during sequential run_all()
-
-  /* For the parallel execution */
-  simgrid::xbt::Parmap<smx_actor_t>* parmap_;
-  std::vector<SwappedContext*> workers_context_; /* space to save the worker's context in each thread */
-  std::atomic<uintptr_t> threads_working_;       /* number of threads that have started their work */
+  /* For the parallel execution, will be created lazily with the right parameters if needed (ie, in parallel) */
+  std::unique_ptr<simgrid::xbt::Parmap<actor::ActorImpl*>> parmap_{nullptr};
 };
 
 class SwappedContext : public Context {
+  friend void ::smx_ctx_wrapper(simgrid::kernel::context::SwappedContext*);
+
 public:
-  SwappedContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process,
-                 SwappedContextFactory* factory);
-  virtual ~SwappedContext();
+  SwappedContext(std::function<void()>&& code, actor::ActorImpl* get_actor, SwappedContextFactory* factory);
+  SwappedContext(const SwappedContext&) = delete;
+  SwappedContext& operator=(const SwappedContext&) = delete;
+  ~SwappedContext() override;
 
   void suspend() override;
   virtual void resume();
-  void stop() override;
 
-  virtual void swap_into(SwappedContext* to) = 0; // Defined in Raw, Boost and UContext subclasses
-
-  static SwappedContext* get_maestro() { return maestro_context_; }
-  static void set_maestro(SwappedContext* maestro) { maestro_context_ = maestro; }
-
-  // FIXME: Killme
-  static thread_local uintptr_t worker_id_;
+  void swap_into(SwappedContext* to);
 
 protected:
-  void* stack_ = nullptr; /* the thread stack */
+  unsigned char* get_stack() const { return stack_; }
+  unsigned char* get_stack_bottom() const; // Depending on the stack direction, its bottom (that Boost::make_fcontext
+                                           // needs) may be the lower or higher end
+
+  // With ASan, after a context switch, check that the originating context is the expected one (see BoostContext)
+  void verify_previous_context(const SwappedContext* context) const;
 
 private:
-  static SwappedContext* maestro_context_;
-  SwappedContextFactory* factory_; // for sequential and parallel run_all()
+  static thread_local SwappedContext* worker_context_;
+
+  unsigned char* stack_ = nullptr; // the thread stack
+  SwappedContextFactory& factory_; // for sequential and parallel run_all()
+
+#if HAVE_VALGRIND_H
+  unsigned int valgrind_stack_id_ = 0;
+#endif
+#if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
+  const void* asan_stack_   = nullptr;
+  size_t asan_stack_size_   = 0;
+  SwappedContext* asan_ctx_ = nullptr;
+  bool asan_stop_           = false;
+#endif
+#if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
+  void* tsan_fiber_;
+#endif
+
+  virtual void swap_into_for_real(SwappedContext* to) = 0; // Defined in Raw, Boost and UContext subclasses
 };
 
-} // namespace context
-} // namespace kernel
-} // namespace simgrid
+inline void SwappedContext::verify_previous_context(XBT_ATTRIB_UNUSED const SwappedContext* context) const
+{
+#if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
+  xbt_assert(this->asan_ctx_ == context);
+#endif
+}
+
+} // namespace simgrid::kernel::context
 #endif