src/kernel/EngineImpl.hpp

   1 /* Copyright (c) 2016-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 #ifndef SIMGRID_KERNEL_ENGINEIMPL_HPP
   7 #define SIMGRID_KERNEL_ENGINEIMPL_HPP
   8
   9 #include <simgrid/kernel/resource/Model.hpp>
  10 #include <simgrid/s4u/Engine.hpp>
  11 #include <simgrid/s4u/NetZone.hpp>
  12 #include <simgrid/simix.hpp>
  13 #include <xbt/dynar.h>
  14 #include <xbt/functional.hpp>
  15
  16 #include "src/kernel/activity/ExecImpl.hpp"
  17 #include "src/kernel/activity/IoImpl.hpp"
  18 #include "src/kernel/activity/MailboxImpl.hpp"
  19 #include "src/kernel/activity/SleepImpl.hpp"
  20 #include "src/kernel/activity/SynchroRaw.hpp"
  21 #include "src/kernel/actor/ActorImpl.hpp"
  22 #include "src/surf/SplitDuplexLinkImpl.hpp"
  23
  24 #include <boost/intrusive/list.hpp>
  25 #include <map>
  26 #include <mutex>
  27 #include <set>
  28 #include <string>
  29 #include <unordered_map>
  30 #include <vector>
  31
  32 namespace simgrid {
  33 namespace kernel {
  34 // In MC mode, the application sends these pointers to the MC
  35 xbt_dynar_t get_actors_addr();
  36 xbt_dynar_t get_dead_actors_addr();
  37
  38 class EngineImpl {
  39   std::map<std::string, s4u::Host*, std::less<>> hosts_;
  40   std::map<std::string, resource::LinkImpl*, std::less<>> links_;
  41   /* save split-duplex links separately, keep links_ with only LinkImpl* seen by the user
  42    * members of a split-duplex are saved in the links_ */
  43   std::map<std::string, std::unique_ptr<resource::SplitDuplexLinkImpl>, std::less<>> split_duplex_links_;
  44   std::unordered_map<std::string, routing::NetPoint*> netpoints_;
  45   std::unordered_map<std::string, activity::MailboxImpl*> mailboxes_;
  46
  47   std::unordered_map<std::string, actor::ActorCodeFactory> registered_functions; // Maps function names to actor code
  48   actor::ActorCodeFactory default_function; // Function to use as a fallback when the provided name matches nothing
  49   std::vector<resource::Model*> models_;
  50   std::unordered_map<std::string, std::shared_ptr<resource::Model>> models_prio_;
  51   routing::NetZoneImpl* netzone_root_ = nullptr;
  52   std::set<actor::ActorImpl*> daemons_;
  53   std::vector<actor::ActorImpl*> actors_to_run_;
  54   std::vector<actor::ActorImpl*> actors_that_ran_;
  55   std::map<aid_t, actor::ActorImpl*> actor_list_;
  56   boost::intrusive::list<actor::ActorImpl,
  57                          boost::intrusive::member_hook<actor::ActorImpl, boost::intrusive::list_member_hook<>,
  58                                                        &actor::ActorImpl::kernel_destroy_list_hook>>
  59       actors_to_destroy_;
  60 #if SIMGRID_HAVE_MC
  61   /* MCer cannot read members actor_list_ and actors_to_destroy_ above in the remote process, so we copy the info it
  62    * needs in a dynar.
  63    * FIXME: This is supposed to be a temporary hack.
  64    * A better solution would be to change the split between MCer and MCed, where the responsibility
  65    *   to compute the list of the enabled transitions goes to the MCed.
  66    * That way, the MCer would not need to have the list of actors on its side.
  67    * These info could be published by the MCed to the MCer in a way inspired of vd.so
  68    */
  69   xbt_dynar_t actors_vector_      = xbt_dynar_new(sizeof(actor::ActorImpl*), nullptr);
  70   xbt_dynar_t dead_actors_vector_ = xbt_dynar_new(sizeof(actor::ActorImpl*), nullptr);
  71 #endif
  72
  73   std::vector<xbt::Task<void()>> tasks;
  74
  75   std::mutex mutex_;
  76   static EngineImpl* instance_;
  77   actor::ActorImpl* maestro_ = nullptr;
  78   context::ContextFactory* context_factory_ = nullptr;
  79
  80   std::unique_ptr<void, std::function<int(void*)>> platf_handle_; //!< handle for platform library
  81   friend s4u::Engine;
  82
  83 public:
  84   EngineImpl() = default;
  85
  86   /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
  87 #ifndef DOXYGEN
  88   EngineImpl(const EngineImpl&) = delete;
  89   EngineImpl& operator=(const EngineImpl&) = delete;
  90   virtual ~EngineImpl();
  91   static void shutdown();
  92 #endif
  93
  94   void initialize(int* argc, char** argv);
  95   void load_platform(const std::string& platf);
  96   void load_deployment(const std::string& file) const;
  97   void register_function(const std::string& name, const actor::ActorCodeFactory& code);
  98   void register_default(const actor::ActorCodeFactory& code);
  99
 100   bool is_maestro(const actor::ActorImpl* actor) const { return actor == maestro_; }
 101   void set_maestro(actor::ActorImpl* actor) { maestro_ = actor; }
 102   actor::ActorImpl* get_maestro() const { return maestro_; }
 103   void destroy_maestro()
 104   {
 105     delete maestro_;
 106     maestro_ = nullptr;
 107   }
 108
 109   context::ContextFactory* get_context_factory() const { return context_factory_; }
 110   void set_context_factory(context::ContextFactory* factory) { context_factory_ = factory; }
 111   bool has_context_factory() const { return context_factory_ != nullptr; }
 112   void destroy_context_factory()
 113   {
 114     delete context_factory_;
 115     context_factory_ = nullptr;
 116   }
 117
 118   void context_mod_init() const;
 119   /**
 120    * @brief Add a model to engine list
 121    *
 122    * @param model Pointer to model
 123    * @param list  List of dependencies for this model
 124    */
 125   void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
 126                  const std::vector<resource::Model*>& dep_models = {});
 127
 128   /** @brief Get list of all models managed by this engine */
 129   const std::vector<resource::Model*>& get_all_models() const { return models_; }
 130
 131   static bool has_instance() { return s4u::Engine::has_instance(); }
 132   static EngineImpl* get_instance() { return s4u::Engine::get_instance()->pimpl; }
 133   static EngineImpl* get_instance(int* argc, char** argv) { return s4u::Engine::get_instance(argc, argv)->pimpl; }
 134
 135   actor::ActorCodeFactory get_function(const std::string& name)
 136   {
 137     auto res = registered_functions.find(name);
 138     if (res == registered_functions.end())
 139       return default_function;
 140     else
 141       return res->second;
 142   }
 143
 144   routing::NetZoneImpl* get_netzone_root() const { return netzone_root_; }
 145
 146   void add_daemon(actor::ActorImpl* d) { daemons_.insert(d); }
 147   void remove_daemon(actor::ActorImpl* d);
 148   void add_actor_to_run_list(actor::ActorImpl* actor);
 149   void add_actor_to_run_list_no_check(actor::ActorImpl* actor);
 150   void add_actor_to_destroy_list(actor::ActorImpl& actor) { actors_to_destroy_.push_back(actor); }
 151
 152   bool has_actors_to_run() const { return not actors_to_run_.empty(); }
 153   const actor::ActorImpl* get_first_actor_to_run() const { return actors_to_run_.front(); }
 154   const actor::ActorImpl* get_actor_to_run_at(unsigned long int i) const { return actors_to_run_[i]; }
 155   unsigned long int get_actor_to_run_count() const { return actors_to_run_.size(); }
 156   size_t get_actor_count() const { return actor_list_.size(); }
 157   actor::ActorImpl* get_actor_by_pid(aid_t pid);
 158   void add_actor(aid_t pid, actor::ActorImpl* actor) { actor_list_[pid] = actor; }
 159   void remove_actor(aid_t pid) { actor_list_.erase(pid); }
 160   void add_split_duplex_link(const std::string& name, std::unique_ptr<resource::SplitDuplexLinkImpl> link);
 161
 162 #if SIMGRID_HAVE_MC
 163   xbt_dynar_t get_actors_vector() const { return actors_vector_; }
 164   xbt_dynar_t get_dead_actors_vector() const { return dead_actors_vector_; }
 165   void reset_actor_dynar() { xbt_dynar_reset(actors_vector_); }
 166   void add_actor_to_dynar(actor::ActorImpl* actor) { xbt_dynar_push_as(actors_vector_, actor::ActorImpl*, actor); }
 167   void add_dead_actor_to_dynar(actor::ActorImpl* actor)
 168   {
 169     xbt_dynar_push_as(dead_actors_vector_, actor::ActorImpl*, actor);
 170   }
 171 #endif
 172
 173   const std::map<aid_t, actor::ActorImpl*>& get_actor_list() const { return actor_list_; }
 174   const std::vector<actor::ActorImpl*>& get_actors_to_run() const { return actors_to_run_; }
 175   const std::vector<actor::ActorImpl*>& get_actors_that_ran() const { return actors_that_ran_; }
 176
 177   std::mutex& get_mutex() { return mutex_; }
 178   bool execute_tasks();
 179   void add_task(xbt::Task<void()>&& t) { tasks.push_back(std::move(t)); }
 180   void wake_all_waiting_actors() const;
 181   /**
 182    * Garbage collection
 183    *
 184    * Should be called some time to time to free the memory allocated for actors that have finished (or killed).
 185    */
 186   void empty_trash();
 187   void display_all_actor_status() const;
 188   void run_all_actors();
 189
 190   /*  @brief Finish simulation initialization
 191    *  This function must be called before the first call to solve()
 192    */
 193   void presolve() const;
 194   /** @brief Performs a part of the simulation
 195    *  @param max_date Maximum date to update the simulation to, or -1
 196    *  @return the elapsed time, or -1.0 if no event could be executed
 197    *
 198    *  This function execute all possible events, update the action states  and returns the time elapsed.
 199    *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
 200    *  when you call solve().
 201    *  Note that the returned elapsed time can be zero.
 202    */
 203   double solve(double max_date) const;
 204
 205   /** @brief Run the main simulation loop. */
 206   void run();
 207
 208   /** @brief Return the current time in milliseconds. */
 209   static double get_clock();
 210 };
 211
 212 } // namespace kernel
 213 } // namespace simgrid
 214
 215 #endif