src/kernel/context/ContextThread.hpp

   1 /* Copyright (c) 2009-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 /* \file ThreadContext.hpp Context switching with native threads */
   7
   8 #ifndef SIMGRID_KERNEL_CONTEXT_THREAD_CONTEXT_HPP
   9 #define SIMGRID_KERNEL_CONTEXT_THREAD_CONTEXT_HPP
  10
  11 #include "simgrid/simix.hpp"
  12 #include "src/kernel/context/Context.hpp"
  13 #include "src/xbt/OsSemaphore.hpp"
  14
  15 #include <thread>
  16
  17 namespace simgrid {
  18 namespace kernel {
  19 namespace context {
  20
  21 class XBT_PUBLIC ThreadContext : public AttachContext {
  22 public:
  23   ThreadContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro);
  24   ThreadContext(const ThreadContext&) = delete;
  25   ThreadContext& operator=(const ThreadContext&) = delete;
  26   ~ThreadContext() override;
  27   XBT_ATTRIB_NORETURN void stop() override;
  28   void suspend() override;
  29   void attach_start() override;
  30   void attach_stop() override;
  31
  32   void release(); // unblock context's start()
  33   void wait();    // wait for context's yield()
  34
  35 private:
  36   /** A portable thread */
  37   std::thread* thread_ = nullptr;
  38   /** Semaphore used to schedule/yield the actor (not needed when the maestro is in main, but harmless then) */
  39   xbt::OsSemaphore begin_{0};
  40   /** Semaphore used to schedule/unschedule (not needed when the maestro is in main, but harmless then) */
  41   xbt::OsSemaphore end_{0};
  42
  43   void start();                // match a call to release()
  44   void yield();                // match a call to yield()
  45   virtual void start_hook() { /* empty placeholder, called after start(). Used in parallel mode and Java */}
  46   virtual void yield_hook() { /* empty placeholder, called before yield(). Used in parallel mode */}
  47   virtual void stop_hook() { /* empty placeholder, called at stop(). Used in Java */}
  48
  49   static void wrapper(ThreadContext* context);
  50 };
  51
  52 class XBT_PUBLIC SerialThreadContext : public ThreadContext {
  53 public:
  54   SerialThreadContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
  55       : ThreadContext(std::move(code), actor, maestro)
  56   {
  57   }
  58
  59   static void run_all();
  60 };
  61
  62 class ParallelThreadContext : public ThreadContext {
  63 public:
  64   ParallelThreadContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
  65       : ThreadContext(std::move(code), actor, maestro)
  66   {
  67   }
  68
  69   static void initialize();
  70   static void finalize();
  71   static void run_all();
  72
  73 private:
  74   static xbt::OsSemaphore* thread_sem_;
  75
  76   void start_hook() override;
  77   void yield_hook() override;
  78 };
  79
  80 class ThreadContextFactory : public ContextFactory {
  81 public:
  82   ThreadContextFactory();
  83   ThreadContextFactory(const ThreadContextFactory&) = delete;
  84   ThreadContextFactory& operator=(const ThreadContextFactory&) = delete;
  85   ~ThreadContextFactory() override;
  86   ThreadContext* create_context(std::function<void()>&& code, actor::ActorImpl* actor) override
  87   {
  88     bool maestro = not code;
  89     return create_context(std::move(code), actor, maestro);
  90   }
  91   void run_all() override;
  92
  93   // Optional methods:
  94   ThreadContext* attach(actor::ActorImpl* actor) override
  95   {
  96     return create_context(std::function<void()>(), actor, false);
  97   }
  98   ThreadContext* create_maestro(std::function<void()>&& code, actor::ActorImpl* actor) override
  99   {
 100     return create_context(std::move(code), actor, true);
 101   }
 102
 103 private:
 104   ThreadContext* create_context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro);
 105 };
 106 } // namespace context
 107 } // namespace kernel
 108 } // namespace simgrid
 109
 110 #endif