Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
New: Engine::run_until(date) to split the simulation
[simgrid.git] / src / kernel / EngineImpl.hpp
index f770aae..ba9ad2c 100644 (file)
 #include <simgrid/s4u/Engine.hpp>
 #include <simgrid/s4u/NetZone.hpp>
 #include <simgrid/simix.hpp>
+#include <xbt/dynar.h>
+#include <xbt/functional.hpp>
 
+#include "src/kernel/activity/ExecImpl.hpp"
+#include "src/kernel/activity/IoImpl.hpp"
+#include "src/kernel/activity/MailboxImpl.hpp"
+#include "src/kernel/activity/SleepImpl.hpp"
+#include "src/kernel/activity/SynchroRaw.hpp"
+#include "src/kernel/actor/ActorImpl.hpp"
+#include "src/surf/SplitDuplexLinkImpl.hpp"
+
+#include <boost/intrusive/list.hpp>
 #include <map>
+#include <mutex>
+#include <set>
 #include <string>
 #include <unordered_map>
+#include <vector>
 
 namespace simgrid {
 namespace kernel {
+// In MC mode, the application sends these pointers to the MC
+xbt_dynar_t get_actors_addr();
+xbt_dynar_t get_dead_actors_addr();
 
 class EngineImpl {
   std::map<std::string, s4u::Host*, std::less<>> hosts_;
   std::map<std::string, resource::LinkImpl*, std::less<>> links_;
+  /* save split-duplex links separately, keep links_ with only LinkImpl* seen by the user
+   * members of a split-duplex are saved in the links_ */
+  std::map<std::string, std::unique_ptr<resource::SplitDuplexLinkImpl>, std::less<>> split_duplex_links_;
   std::unordered_map<std::string, routing::NetPoint*> netpoints_;
+  std::unordered_map<std::string, activity::MailboxImpl*> mailboxes_;
+
   std::unordered_map<std::string, actor::ActorCodeFactory> registered_functions; // Maps function names to actor code
   actor::ActorCodeFactory default_function; // Function to use as a fallback when the provided name matches nothing
-  std::vector<std::shared_ptr<resource::Model>> models_;
-  std::unordered_map<resource::Model::Type, std::vector<resource::Model*>> models_by_type_;
+  std::vector<resource::Model*> models_;
+  std::unordered_map<std::string, std::shared_ptr<resource::Model>> models_prio_;
+  routing::NetZoneImpl* netzone_root_ = nullptr;
+  std::set<actor::ActorImpl*> daemons_;
+  std::vector<actor::ActorImpl*> actors_to_run_;
+  std::vector<actor::ActorImpl*> actors_that_ran_;
+  std::map<aid_t, actor::ActorImpl*> actor_list_;
+  boost::intrusive::list<actor::ActorImpl,
+                         boost::intrusive::member_hook<actor::ActorImpl, boost::intrusive::list_member_hook<>,
+                                                       &actor::ActorImpl::kernel_destroy_list_hook>>
+      actors_to_destroy_;
+#if SIMGRID_HAVE_MC
+  /* MCer cannot read members actor_list_ and actors_to_destroy_ above in the remote process, so we copy the info it
+   * needs in a dynar.
+   * FIXME: This is supposed to be a temporary hack.
+   * A better solution would be to change the split between MCer and MCed, where the responsibility
+   *   to compute the list of the enabled transitions goes to the MCed.
+   * That way, the MCer would not need to have the list of actors on its side.
+   * These info could be published by the MCed to the MCer in a way inspired of vd.so
+   */
+  xbt_dynar_t actors_vector_      = xbt_dynar_new(sizeof(actor::ActorImpl*), nullptr);
+  xbt_dynar_t dead_actors_vector_ = xbt_dynar_new(sizeof(actor::ActorImpl*), nullptr);
+#endif
 
+  std::vector<xbt::Task<void()>> tasks;
+
+  std::mutex mutex_;
+  static EngineImpl* instance_;
+  actor::ActorImpl* maestro_ = nullptr;
+  context::ContextFactory* context_factory_ = nullptr;
+
+  std::unique_ptr<void, std::function<int(void*)>> platf_handle_; //!< handle for platform library
   friend s4u::Engine;
 
 public:
   EngineImpl() = default;
 
+  /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
+#ifndef DOXYGEN
   EngineImpl(const EngineImpl&) = delete;
   EngineImpl& operator=(const EngineImpl&) = delete;
   virtual ~EngineImpl();
+  static void shutdown();
+#endif
 
+  void initialize(int* argc, char** argv);
+  void load_platform(const std::string& platf);
   void load_deployment(const std::string& file) const;
   void register_function(const std::string& name, const actor::ActorCodeFactory& code);
   void register_default(const actor::ActorCodeFactory& code);
 
+  bool is_maestro(const actor::ActorImpl* actor) const { return actor == maestro_; }
+  void set_maestro(actor::ActorImpl* actor) { maestro_ = actor; }
+  actor::ActorImpl* get_maestro() const { return maestro_; }
+  void destroy_maestro()
+  {
+    delete maestro_;
+    maestro_ = nullptr;
+  }
+
+  context::ContextFactory* get_context_factory() const { return context_factory_; }
+  void set_context_factory(context::ContextFactory* factory) { context_factory_ = factory; }
+  bool has_context_factory() const { return context_factory_ != nullptr; }
+  void destroy_context_factory()
+  {
+    delete context_factory_;
+    context_factory_ = nullptr;
+  }
+
+  void context_mod_init() const;
   /**
    * @brief Add a model to engine list
    *
-   * @param type Model type (network, disk, etc)
    * @param model Pointer to model
-   * @param is_default Is this the default model for this type of resource in this exp
+   * @param list  List of dependencies for this model
    */
-  void add_model(resource::Model::Type type, std::shared_ptr<resource::Model> model, bool is_default = false);
-  /**
-   * @brief Add a model (specific for ptask)
-   *
-   * Ptask is special. The CPU and NETWORK models need to be in the managed
-   * resources by surf_solve (model_by_type) but cannot be in the list of
-   * all models (old all_existing_models global variable)
-   *
-   * This methods does this job while we cannot handle ptask as the remaining models
-   */
-  void add_model_ptask(resource::Model::Type type, resource::Model* model, bool is_default);
-  /** @brief Get current default model for a resource type */
-  resource::Model* get_default_model(resource::Model::Type type);
+  void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
+                 const std::vector<resource::Model*>& dep_models = {});
 
-  /** @brief Get list of models created for a resource type */
-  const std::vector<resource::Model*>& get_model_list(resource::Model::Type type) { return models_by_type_[type]; }
   /** @brief Get list of all models managed by this engine */
-  const std::vector<std::shared_ptr<resource::Model>>& get_all_models() { return models_; }
+  const std::vector<resource::Model*>& get_all_models() const { return models_; }
+
+  static bool has_instance() { return s4u::Engine::has_instance(); }
+  static EngineImpl* get_instance() { return s4u::Engine::get_instance()->pimpl; }
+  static EngineImpl* get_instance(int* argc, char** argv) { return s4u::Engine::get_instance(argc, argv)->pimpl; }
 
-  routing::NetZoneImpl* netzone_root_ = nullptr;
-  static EngineImpl* get_instance() { return simgrid::s4u::Engine::get_instance()->pimpl; }
   actor::ActorCodeFactory get_function(const std::string& name)
   {
     auto res = registered_functions.find(name);
@@ -76,6 +140,73 @@ public:
     else
       return res->second;
   }
+
+  routing::NetZoneImpl* get_netzone_root() const { return netzone_root_; }
+
+  void add_daemon(actor::ActorImpl* d) { daemons_.insert(d); }
+  void remove_daemon(actor::ActorImpl* d);
+  void add_actor_to_run_list(actor::ActorImpl* actor);
+  void add_actor_to_run_list_no_check(actor::ActorImpl* actor);
+  void add_actor_to_destroy_list(actor::ActorImpl& actor) { actors_to_destroy_.push_back(actor); }
+
+  bool has_actors_to_run() const { return not actors_to_run_.empty(); }
+  const actor::ActorImpl* get_first_actor_to_run() const { return actors_to_run_.front(); }
+  const actor::ActorImpl* get_actor_to_run_at(unsigned long int i) const { return actors_to_run_[i]; }
+  unsigned long int get_actor_to_run_count() const { return actors_to_run_.size(); }
+  size_t get_actor_count() const { return actor_list_.size(); }
+  actor::ActorImpl* get_actor_by_pid(aid_t pid);
+  void add_actor(aid_t pid, actor::ActorImpl* actor) { actor_list_[pid] = actor; }
+  void remove_actor(aid_t pid) { actor_list_.erase(pid); }
+  void add_split_duplex_link(const std::string& name, std::unique_ptr<resource::SplitDuplexLinkImpl> link);
+
+#if SIMGRID_HAVE_MC
+  xbt_dynar_t get_actors_vector() const { return actors_vector_; }
+  xbt_dynar_t get_dead_actors_vector() const { return dead_actors_vector_; }
+  void reset_actor_dynar() { xbt_dynar_reset(actors_vector_); }
+  void add_actor_to_dynar(actor::ActorImpl* actor) { xbt_dynar_push_as(actors_vector_, actor::ActorImpl*, actor); }
+  void add_dead_actor_to_dynar(actor::ActorImpl* actor)
+  {
+    xbt_dynar_push_as(dead_actors_vector_, actor::ActorImpl*, actor);
+  }
+#endif
+
+  const std::map<aid_t, actor::ActorImpl*>& get_actor_list() const { return actor_list_; }
+  const std::vector<actor::ActorImpl*>& get_actors_to_run() const { return actors_to_run_; }
+  const std::vector<actor::ActorImpl*>& get_actors_that_ran() const { return actors_that_ran_; }
+
+  std::mutex& get_mutex() { return mutex_; }
+  bool execute_tasks();
+  void add_task(xbt::Task<void()>&& t) { tasks.push_back(std::move(t)); }
+  void wake_all_waiting_actors() const;
+  /**
+   * Garbage collection
+   *
+   * Should be called some time to time to free the memory allocated for actors that have finished (or killed).
+   */
+  void empty_trash();
+  void display_all_actor_status() const;
+  void run_all_actors();
+
+  /*  @brief Finish simulation initialization
+   *  This function must be called before the first call to solve()
+   */
+  void presolve() const;
+  /** @brief Performs a part of the simulation
+   *  @param max_date Maximum date to update the simulation to, or -1
+   *  @return the elapsed time, or -1.0 if no event could be executed
+   *
+   *  This function execute all possible events, update the action states  and returns the time elapsed.
+   *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
+   *  when you call solve().
+   *  Note that the returned elapsed time can be zero.
+   */
+  double solve(double max_date) const;
+
+  /** @brief Run the main simulation loop until the specified date (or infinitly if max_date is negative). */
+  void run(double max_date);
+
+  /** @brief Return the current time in milliseconds. */
+  static double get_clock();
 };
 
 } // namespace kernel