Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make SIMIX_context_self() useless and use Context::self() instead
[simgrid.git] / src / kernel / context / Context.hpp
index 373df85..6271a8b 100644 (file)
@@ -6,32 +6,14 @@
 #ifndef SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
 #define SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
 
-#include <functional>
-#include <memory>
-#include <unordered_map>
-#include <vector>
-
-#include <xbt/functional.hpp>
-
-#include "simgrid/simix.h"
-#include "src/instr/instr_private.hpp"
+#include "simgrid/forward.h"
 #include "src/internal_config.h"
-#include "src/simix/popping_private.hpp"
-#include "src/simix/smx_host_private.hpp"
-#include "src/simix/smx_io_private.hpp"
-#include "src/simix/smx_network_private.hpp"
-#include "src/simix/smx_synchro_private.hpp"
-#include "surf/surf.hpp"
-#include "xbt/base.h"
-#include "xbt/config.h"
-#include "xbt/function_types.h"
-#include "xbt/mallocator.h"
-#include "xbt/xbt_os_time.h"
-
-#include "src/simix/ActorImpl.hpp"
+#include "src/kernel/activity/ActivityImpl.hpp"
+
 #include <csignal>
 
-#include <simgrid/simix.hpp>
+/* Process creation/destruction callbacks */
+typedef void (*void_pfn_smxprocess_t)(smx_actor_t);
 
 namespace simgrid {
 namespace kernel {
@@ -46,62 +28,74 @@ public:
   virtual ~ContextFactory();
   virtual Context* create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process) = 0;
 
-  // Optional methods for attaching main() as a context:
-
-  /** Creates a context from the current context of execution
-   *
-   *  This will not work on all implementation of `ContextFactory`.
-   */
+  /** Turn the current thread into a simulation context */
   virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
+  /** Turn the current thread into maestro (the old maestro becomes a regular actor) */
   virtual Context* create_maestro(std::function<void()> code, smx_actor_t process);
 
   virtual void run_all() = 0;
-  virtual Context* self();
   std::string const& name() const { return name_; }
-private:
-  void declare_context(void* T, std::size_t size);
 
 protected:
   template <class T, class... Args> T* new_context(Args&&... args)
   {
     T* context = new T(std::forward<Args>(args)...);
-    this->declare_context(context, sizeof(T));
+    context->declare_context(sizeof(T));
     return context;
   }
 };
 
 class XBT_PUBLIC Context {
+  friend ContextFactory;
+
 private:
   std::function<void()> code_;
   void_pfn_smxprocess_t cleanup_func_ = nullptr;
-  smx_actor_t process_                = nullptr;
+  smx_actor_t actor_                  = nullptr;
+  void declare_context(std::size_t size);
 
 public:
-  class StopRequest {
-    /** @brief Exception launched to kill a process, in order to properly unwind its stack and release RAII stuff
-     *
-     * Nope, Sonar, this should not inherit of std::exception.
-     * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
-     */
-  };
-  bool iwannadie;
+  bool iwannadie = false;
 
   Context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
+  Context(const Context&) = delete;
+  Context& operator=(const Context&) = delete;
+  virtual ~Context();
+
   void operator()() { code_(); }
   bool has_code() const { return static_cast<bool>(code_); }
-  smx_actor_t process() { return this->process_; }
+  smx_actor_t process() { return this->actor_; }
   void set_cleanup(void_pfn_smxprocess_t cleanup) { cleanup_func_ = cleanup; }
 
-  // Virtual methods
-  virtual ~Context();
+  // Scheduling methods
   virtual void stop();
   virtual void suspend() = 0;
+
+  // Retrieving the self() context
+  /** @brief Retrives the current context of this thread */
+  static Context* self();
+  /** @brief Sets the current context of this thread */
+  static void set_current(Context* self);
+
+  class StopRequest {
+    /** @brief Exception launched to kill a process, in order to properly unwind its stack and release RAII stuff
+     *
+     * Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
+     * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
+     */
+  public:
+    StopRequest() = default;
+    explicit StopRequest(std::string msg) : msg_(msg) {}
+
+  private:
+    std::string msg_;
+  };
 };
 
 class XBT_PUBLIC AttachContext : public Context {
 public:
-  AttachContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
-      : Context(std::move(code), cleanup_func, process)
+  AttachContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t actor)
+      : Context(std::move(code), cleanup_func, actor)
   {
   }
 
@@ -129,8 +123,6 @@ XBT_PRIVATE ContextFactory* boost_factory();
 
 typedef simgrid::kernel::context::ContextFactory *smx_context_factory_t;
 
-extern "C" {
-
 XBT_PRIVATE void SIMIX_context_mod_init();
 XBT_PRIVATE void SIMIX_context_mod_exit();
 
@@ -153,20 +145,14 @@ XBT_PUBLIC_DATA char sigsegv_stack[SIGSTKSZ];
 
 /** @brief Executes all the processes to run (in parallel if possible). */
 XBT_PRIVATE void SIMIX_context_runall();
-/** @brief returns the current running context */
-XBT_PUBLIC smx_context_t SIMIX_context_self(); // public because it's used in simgrid-java
 
 XBT_PRIVATE void *SIMIX_context_stack_new();
 XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
 
-XBT_PUBLIC void SIMIX_context_set_current(smx_context_t context);
-XBT_PRIVATE smx_context_t SIMIX_context_get_current();
-
 XBT_PUBLIC int SIMIX_process_get_maxpid();
 
 XBT_PRIVATE void SIMIX_post_create_environment();
-}
 
-XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(const char *name);
+XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(std::string name);
 
 #endif