Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make ActorImpl::context_ a std::unique_ptr.
[simgrid.git] / src / simix / ActorImpl.hpp
index e4517b9..785e25b 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2016. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2019. 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. */
 #define SIMIX_ACTORIMPL_H
 
 #include "simgrid/s4u/Actor.hpp"
-#include "src/simix/popping_private.h"
-#include "xbt/swag.h"
+#include "src/simix/popping_private.hpp"
+#include "src/surf/PropertyHolder.hpp"
+#include <boost/intrusive/list.hpp>
+#include <functional>
 #include <list>
+#include <map>
+#include <memory>
 
-typedef struct s_smx_process_exit_fun {
-  int_f_pvoid_pvoid_t fun;
+struct s_smx_process_exit_fun_t {
+  std::function<void(bool, void*)> fun;
   void *arg;
-} s_smx_process_exit_fun_t;
-typedef s_smx_process_exit_fun_t* smx_process_exit_fun_t;
+};
 
 namespace simgrid {
-namespace simix {
+namespace kernel {
+namespace actor {
 
-class ProcessArg {
-public:
-  std::string name;
-  std::function<void()> code;
-  void *data            = nullptr;
-  sg_host_t host        = nullptr;
-  double kill_time      = 0.0;
-  xbt_dict_t properties = nullptr;
-  bool auto_restart     = false;
-};
+class XBT_PUBLIC ActorImpl : public surf::PropertyHolder {
+  s4u::Host* host_   = nullptr; /* the host on which the actor is running */
+  void* userdata_    = nullptr; /* kept for compatibility, it should be replaced with moddata */
+  aid_t pid_         = 0;
+  aid_t ppid_        = -1;
+  bool daemon_       = false; /* Daemon actors are automatically killed when the last non-daemon leaves */
+  bool auto_restart_ = false;
 
-class ActorImpl {
 public:
-  ActorImpl() : piface_(this) {}
+  xbt::string name_;
+  ActorImpl(xbt::string name, s4u::Host* host);
+  ActorImpl(const ActorImpl&) = delete;
+  ActorImpl& operator=(const ActorImpl&) = delete;
   ~ActorImpl();
 
-  // TODO, replace with boost intrusive container hooks
-  s_xbt_swag_hookup_t process_hookup   = { nullptr, nullptr }; /* simix_global->process_list */
-  s_xbt_swag_hookup_t synchro_hookup   = { nullptr, nullptr }; /* {mutex,cond,sem}->sleeping */
-  s_xbt_swag_hookup_t host_proc_hookup = { nullptr, nullptr }; /* smx_host->process_lis */
-  s_xbt_swag_hookup_t destroy_hookup   = { nullptr, nullptr }; /* simix_global->process_to_destroy */
-
-  aid_t pid  = 0;
-  aid_t ppid = -1;
-  simgrid::xbt::string name;
-  const char* cname() { return name.c_str(); }
-  s4u::Host* host       = nullptr; /* the host on which the process is running */
-  smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
-
-  // TODO, pack them
-  std::exception_ptr exception;
-  bool finished     = false;
-  bool blocked      = false;
-  bool suspended    = false;
-  bool auto_restart = false;
-
-  sg_host_t new_host             = nullptr; /* if not null, the host on which the process must migrate to */
-  smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
-  std::list<smx_activity_t> comms;          /* the current non-blocking communication synchros */
-  xbt_dict_t properties         = nullptr;
-  s_smx_simcall_t simcall;
-  void *data          = nullptr; /* kept for compatibility, it should be replaced with moddata */
+  double get_kill_time();
+  void set_kill_time(double kill_time);
+  boost::intrusive::list_member_hook<> host_process_list_hook; /* simgrid::simix::Host::process_list */
+  boost::intrusive::list_member_hook<> smx_destroy_list_hook;  /* simix_global->actors_to_destroy */
+  boost::intrusive::list_member_hook<> smx_synchro_hook;       /* {mutex,cond,sem}->sleeping */
+
+  const xbt::string& get_name() const { return name_; }
+  const char* get_cname() const { return name_.c_str(); }
+
+  // Accessors to private fields
+  s4u::Host* get_host() { return host_; }
+  void set_host(s4u::Host* dest);
+  void* get_user_data() { return userdata_; }
+  void set_user_data(void* data) { userdata_ = data; }
+  aid_t get_pid() const { return pid_; }
+  aid_t get_ppid() const { return ppid_; }
+  void set_ppid(aid_t ppid) { ppid_ = ppid; }
+  bool is_daemon() { return daemon_; } /** Whether this actor has been daemonized */
+  bool has_to_auto_restart() { return auto_restart_; }
+  void set_auto_restart(bool autorestart) { auto_restart_ = autorestart; }
+
+  std::unique_ptr<context::Context> context_; /* the context (uctx/raw/thread) that executes the user function */
+
+  std::exception_ptr exception_;
+  bool finished_  = false;
+  bool blocked_   = false; /* FIXME this field is never set to true. Either use it or remove it. */
+  bool suspended_ = false;
+
+  activity::ActivityImplPtr waiting_synchro = nullptr; /* the current blocking synchro if any */
+  std::list<activity::ActivityImplPtr> comms;          /* the current non-blocking communication synchros */
+  s_smx_simcall simcall;
   std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
 
   std::function<void()> code;
-  smx_timer_t kill_timer = nullptr;
-  int segment_index = -1; /* Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
+  simix::Timer* kill_timer = nullptr;
 
-  /* Refcounting */
 private:
+  /* Refcounting */
   std::atomic_int_fast32_t refcount_{0};
 
 public:
-  friend void intrusive_ptr_add_ref(ActorImpl* process)
+  friend void intrusive_ptr_add_ref(ActorImpl* actor)
   {
     // std::memory_order_relaxed ought to be enough here instead of std::memory_order_seq_cst
     // But then, we have a threading issue when an actor commits a suicide:
     //  it seems that in this case, the worker thread kills the last occurrence of the actor
     //  while usually, the maestro does so. FIXME: we should change how actors suicide
-    process->refcount_.fetch_add(1, std::memory_order_seq_cst);
+    actor->refcount_.fetch_add(1, std::memory_order_seq_cst);
   }
-  friend void intrusive_ptr_release(ActorImpl* process)
+  friend void intrusive_ptr_release(ActorImpl* actor)
   {
     // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
-    if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
+    if (actor->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
       // Make sure that any changes done on other threads before their acquire are committed before our delete
       // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
       std::atomic_thread_fence(std::memory_order_acquire);
-      delete process;
+      delete actor;
     }
   }
 
   /* S4U/implem interfaces */
 private:
-  simgrid::s4u::Actor piface_; // Our interface is part of ourselves
-public:
-  simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
-  simgrid::s4u::Actor* ciface() { return &piface_; }
-
-  /* Daemon actors are automatically killed when the last non-daemon leaves */
-private:
-  bool daemon = false;
+  s4u::Actor piface_; // Our interface is part of ourselves
 public:
+  s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
+  s4u::Actor* ciface() { return &piface_; }
+
+  ActorImplPtr init(std::string name, s4u::Host* host);
+  ActorImpl* start(const simix::ActorCode& code);
+
+  static ActorImplPtr create(std::string name, const simix::ActorCode& code, void* data, s4u::Host* host,
+                             std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor);
+  static ActorImplPtr attach(std::string name, void* data, s4u::Host* host,
+                             std::unordered_map<std::string, std::string>* properties);
+  static void detach();
+  void cleanup();
+  void exit();
+  void kill(ActorImpl* actor);
+  void kill_all();
+
+  void yield();
   void daemonize();
-  bool isDaemon() { return daemon; } /** Whether this actor has been daemonized */
-  bool isSuspended() { return suspended; }
-  ActorImpl* restart(ActorImpl* issuer);
-  smx_activity_t suspend(ActorImpl* issuer);
+  bool is_suspended() { return suspended_; }
+  s4u::Actor* restart();
+  activity::ActivityImplPtr suspend(ActorImpl* issuer);
   void resume();
-  smx_activity_t sleep(double duration);
+  activity::ActivityImplPtr join(ActorImpl* actor, double timeout);
+  activity::ActivityImplPtr sleep(double duration);
+  /** Ask the actor to throw an exception right away */
+  void throw_exception(std::exception_ptr e);
 };
 
-}
-}
-
-typedef simgrid::simix::ProcessArg *smx_process_arg_t;
-
-typedef simgrid::simix::ActorImpl* smx_actor_t;
-
-SG_BEGIN_DECL()
-
-XBT_PRIVATE smx_actor_t SIMIX_process_create(
-                          const char *name,
-                          std::function<void()> code,
-                          void *data,
-                          sg_host_t host,
-                          xbt_dict_t properties,
-                          smx_actor_t parent_process);
+class ProcessArg {
+public:
+  std::string name;
+  std::function<void()> code;
+  void* data                                                               = nullptr;
+  s4u::Host* host                                                          = nullptr;
+  double kill_time                                                         = 0.0;
+  std::shared_ptr<std::unordered_map<std::string, std::string>> properties = nullptr;
+  bool auto_restart                                                        = false;
+  bool daemon_                                                             = false;
+  ProcessArg()                                                             = default;
+
+  explicit ProcessArg(std::string name, const std::function<void()>& code, void* data, s4u::Host* host,
+                      double kill_time, std::shared_ptr<std::unordered_map<std::string, std::string>> properties,
+                      bool auto_restart)
+      : name(name)
+      , code(code)
+      , data(data)
+      , host(host)
+      , kill_time(kill_time)
+      , properties(properties)
+      , auto_restart(auto_restart)
+  {
+  }
 
-XBT_PRIVATE void SIMIX_process_runall();
-XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
-XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer, int reset_pid);
-XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
-XBT_PRIVATE void SIMIX_process_empty_trash();
-XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
-XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
-XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
-XBT_PRIVATE void SIMIX_process_set_data(smx_actor_t process, void *data);
-XBT_PRIVATE smx_actor_t SIMIX_process_get_by_name(const char* name);
+  explicit ProcessArg(s4u::Host* host, ActorImpl* actor)
+      : name(actor->get_name())
+      , code(actor->code)
+      , data(actor->get_user_data())
+      , host(host)
+      , kill_time(actor->get_kill_time())
+      , auto_restart(actor->has_to_auto_restart())
+      , daemon_(actor->is_daemon())
+  {
+    properties.reset(actor->get_properties(), [](decltype(actor->get_properties())) {});
+  }
+};
 
-XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
+/* Used to keep the list of actors blocked on a synchro  */
+typedef boost::intrusive::list<ActorImpl, boost::intrusive::member_hook<ActorImpl, boost::intrusive::list_member_hook<>,
+                                                                        &ActorImpl::smx_synchro_hook>>
+    SynchroList;
 
-extern void (*SMPI_switch_data_segment)(int dest);
+XBT_PUBLIC void create_maestro(const std::function<void()>& code);
+} // namespace actor
+} // namespace kernel
+} // namespace simgrid
 
-SG_END_DECL()
+extern void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr actor);
 
 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
-XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);
 
 #endif