include/simgrid/s4u/Engine.hpp

   1 /* Copyright (c) 2006-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_S4U_ENGINE_HPP
   7 #define SIMGRID_S4U_ENGINE_HPP
   8
   9 #include <xbt/base.h>
  10
  11 #include <simgrid/forward.h>
  12
  13 #include <simgrid/kernel/resource/Model.hpp>
  14 #include <simgrid/s4u/NetZone.hpp>
  15
  16 #include <string>
  17 #include <utility>
  18 #include <vector>
  19
  20 namespace simgrid {
  21 namespace s4u {
  22 /** @brief Simulation engine
  23  *
  24  * This is a singleton containing all the main functions of the simulation.
  25  */
  26 class XBT_PUBLIC Engine {
  27 #ifndef DOXYGEN
  28   friend simgrid::kernel::EngineImpl;
  29 #endif
  30
  31 public:
  32   /** Constructor, taking only the name of your main function */
  33   explicit Engine(std::string name);
  34   /** Constructor, taking the command line parameters of your main function */
  35   explicit Engine(int* argc, char** argv);
  36   /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
  37 #ifndef DOXYGEN
  38   Engine(const Engine&) = delete;
  39   Engine(Engine&&)      = delete;
  40   ~Engine();
  41 #endif
  42
  43   /** Finalize the default engine and all its dependencies */
  44   void shutdown();
  45
  46   /** Run the simulation until its end */
  47   void run() const;
  48
  49   /** Run the simulation until the specified date */
  50   void run_until(double max_date) const;
  51
  52   /** @brief Retrieve the simulation time (in seconds) */
  53   static double get_clock();
  54   /** @brief Retrieve the engine singleton */
  55   static s4u::Engine* get_instance();
  56   static s4u::Engine* get_instance(int* argc, char** argv);
  57   static bool has_instance() { return instance_ != nullptr; }
  58
  59   void load_platform(const std::string& platf) const;
  60
  61   void register_function(const std::string& name, const std::function<void(int, char**)>& code);
  62   void register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code);
  63   void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
  64
  65   void register_default(const std::function<void(int, char**)>& code);
  66   void register_default(const kernel::actor::ActorCodeFactory& factory);
  67
  68   template <class F> void register_actor(const std::string& name)
  69   {
  70     kernel::actor::ActorCodeFactory code_factory = [](std::vector<std::string> args) {
  71       return kernel::actor::ActorCode([args = std::move(args)]() mutable {
  72         F code(std::move(args));
  73         code();
  74       });
  75     };
  76     register_function(name, code_factory);
  77   }
  78   template <class F> void register_actor(const std::string& name, F code)
  79   {
  80     kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
  81       return kernel::actor::ActorCode([code, args = std::move(args)]() mutable { code(std::move(args)); });
  82     };
  83     register_function(name, code_factory);
  84   }
  85
  86   void load_deployment(const std::string& deploy) const;
  87
  88 protected:
  89 #ifndef DOXYGEN
  90   friend Host;
  91   friend Link;
  92   friend Disk;
  93   friend kernel::routing::NetPoint;
  94   friend kernel::routing::NetZoneImpl;
  95   friend kernel::resource::HostImpl;
  96   friend kernel::resource::LinkImpl;
  97   void host_register(const std::string& name, Host* host);
  98   void host_unregister(const std::string& name);
  99   void link_register(const std::string& name, const Link* link);
 100   void link_unregister(const std::string& name);
 101   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
 102   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
 103 #endif /*DOXYGEN*/
 104
 105 public:
 106   /** Returns the amount of hosts existing in the platform. */
 107   size_t get_host_count() const;
 108   /** Returns a vector of all hosts found in the platform.
 109    *
 110    * The order is generally different from the creation/declaration order in the XML platform because we use a hash
 111    * table internally.
 112    */
 113   std::vector<Host*> get_all_hosts() const;
 114   std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter) const;
 115   Host* host_by_name(const std::string& name) const;
 116   Host* host_by_name_or_null(const std::string& name) const;
 117
 118   size_t get_link_count() const;
 119   std::vector<Link*> get_all_links() const;
 120   std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter) const;
 121   Link* link_by_name(const std::string& name) const;
 122   /**
 123    * @brief Find a split-duplex link from its name.
 124    * @throw std::invalid_argument if the searched link does not exist.
 125    */
 126   SplitDuplexLink* split_duplex_link_by_name(const std::string& name) const;
 127   Link* link_by_name_or_null(const std::string& name) const;
 128
 129   Mailbox* mailbox_by_name_or_create(const std::string& name) const;
 130
 131   size_t get_actor_count() const;
 132   std::vector<ActorPtr> get_all_actors() const;
 133   std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const;
 134
 135   std::vector<kernel::routing::NetPoint*> get_all_netpoints() const;
 136   kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name) const;
 137   /**
 138    * @brief Get netpoint by its name
 139    *
 140    * @param name Netpoint name
 141    * @throw std::invalid_argument if netpoint doesn't exist
 142    */
 143   kernel::routing::NetPoint* netpoint_by_name(const std::string& name) const;
 144
 145   NetZone* get_netzone_root() const;
 146   void set_netzone_root(const NetZone* netzone);
 147
 148   NetZone* netzone_by_name_or_null(const std::string& name) const;
 149
 150   /**
 151    * @brief Add a model to engine list
 152    *
 153    * @param model        Pointer to model
 154    * @param dependencies List of dependencies for this model (optional)
 155    */
 156   void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
 157                  const std::vector<kernel::resource::Model*>& dependencies = {});
 158
 159   /** @brief Get list of all models managed by this engine */
 160   const std::vector<simgrid::kernel::resource::Model*>& get_all_models() const;
 161
 162   /** @brief Retrieves all netzones of the type indicated by the template argument */
 163   template <class T> std::vector<T*> get_filtered_netzones() const
 164   {
 165     static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 166                   "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 167     std::vector<T*> res;
 168     get_filtered_netzones_recursive(get_netzone_root(), &res);
 169     return res;
 170   }
 171
 172   kernel::EngineImpl* get_impl() const { return pimpl; }
 173
 174   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 175   static bool is_initialized();
 176   /** @brief set a configuration variable
 177    *
 178    * @beginrst
 179    * Do --help on any simgrid binary to see the list of currently existing configuration variables
 180    * (see also :ref:`options`).
 181    * @endrst
 182    *
 183    * Example:
 184    * simgrid::s4u::Engine::set_config("host/model:ptask_L07");
 185    */
 186   static void set_config(const std::string& str);
 187   static void set_config(const std::string& name, int value);
 188   static void set_config(const std::string& name, bool value);
 189   static void set_config(const std::string& name, double value);
 190   static void set_config(const std::string& name, const std::string& value);
 191
 192   Engine* set_default_comm_data_copy_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t));
 193   /** Callback fired when the platform is created (ie, the xml file parsed),
 194    * right before the actual simulation starts. */
 195   static xbt::signal<void()> on_platform_created;
 196
 197   /** Callback fired when the platform is about to be created
 198    * (ie, after any configuration change and just before the resource creation) */
 199   static xbt::signal<void()> on_platform_creation;
 200
 201   /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 202   static xbt::signal<void()> on_simulation_end;
 203
 204   /** Callback fired when the time jumps into the future */
 205   static xbt::signal<void(double)> on_time_advance;
 206
 207   /** Callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each actor
 208    * is also executed on deadlock. */
 209   static xbt::signal<void(void)> on_deadlock;
 210
 211 private:
 212   kernel::EngineImpl* const pimpl;
 213   static Engine* instance_;
 214   void initialize(int* argc, char** argv);
 215 };
 216
 217 #ifndef DOXYGEN /* Internal use only, no need to expose it */
 218 template <class T>
 219 XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector<T*>* whereto)
 220 {
 221   static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 222                 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 223   for (auto const& elem : current->get_children()) {
 224     get_filtered_netzones_recursive(elem, whereto);
 225     auto* elem_impl = dynamic_cast<T*>(elem->get_impl());
 226     if (elem_impl != nullptr)
 227       whereto->push_back(elem_impl);
 228   }
 229 }
 230 #endif
 231 } // namespace s4u
 232 } // namespace simgrid
 233
 234 #endif /* SIMGRID_S4U_ENGINE_HPP */