include/simgrid/s4u/Engine.hpp

   1 /* Copyright (c) 2006-2023. 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 <set>
  17 #include <string>
  18 #include <utility>
  19 #include <vector>
  20
  21 namespace simgrid::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   XBT_ATTRIB_DEPRECATED_v335("Users are not supposed to shutdown the Engine") 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   const std::vector<std::string>& get_cmdline() const;
  59
  60   /**
  61    * Creates a new platform, including hosts, links, and the routing table.
  62    *
  63    * @beginrst
  64    * See also: :ref:`platform`.
  65    * @endrst
  66    */
  67   void load_platform(const std::string& platf) const;
  68   /**
  69    * @brief Seals the platform, finishing the creation of its resources.
  70    *
  71    * This method is optional. The seal() is done automatically when you call Engine::run.
  72    */
  73   void seal_platform() const;
  74   /** @brief Get a debug output of the platform.
  75    *
  76    * It looks like a XML platform file, but it may be very different from the input platform file: All netzones are
  77    * flatified into a unique zone. This representation is mostly useful to debug your platform configuration and ensure
  78    * that your assumptions over your configuration hold. This enables you to verify the exact list of links traversed
  79    * between any two hosts, and the characteristics of every host and link. But you should not use the resulting file as
  80    * an input platform file: it is very verbose, and thus much less efficient (in parsing time and runtime performance)
  81    * than a regular platform file with the sufficient amount of intermediary netzones. Even if you use one zone only,
  82    * specialized zones (such as clusters) are more efficient than the one with fully explicit routing used here.
  83    */
  84   std::string flatify_platform() const;
  85
  86   /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking classical argc/argv parameters. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
  87   void register_function(const std::string& name, const std::function<void(int, char**)>& code);
  88   /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking a vector of strings as a parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
  89   void register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code);
  90   void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
  91
  92   /** @verbatim embed:rst:inline Provide a default function to be used when the name used in a :ref:`pf_tag_actor` tag was not binded with ``register_function`` nor ``register_actor``. @endverbatim */
  93   void register_default(const std::function<void(int, char**)>& code);
  94   void register_default(const kernel::actor::ActorCodeFactory& factory);
  95
  96   /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a class name passed as a template parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
  97   template <class F> void register_actor(const std::string& name)
  98   {
  99     kernel::actor::ActorCodeFactory code_factory = [](std::vector<std::string> args) {
 100       return kernel::actor::ActorCode([args = std::move(args)]() mutable {
 101         F code(std::move(args));
 102         code();
 103       });
 104     };
 105     register_function(name, code_factory);
 106   }
 107   /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function name passed as a parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
 108   template <class F> void register_actor(const std::string& name, F code)
 109   {
 110     kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
 111       return kernel::actor::ActorCode([code, args = std::move(args)]() mutable { code(std::move(args)); });
 112     };
 113     register_function(name, code_factory);
 114   }
 115
 116   /** If non-null, the provided set will be filled with all activities that fail to start because of a veto */
 117   void track_vetoed_activities(std::set<Activity*>* vetoed_activities) const;
 118
 119   /** @verbatim embed:rst:inline Load a deployment file. See:ref:`deploy` and the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
 120   void load_deployment(const std::string& deploy) const;
 121
 122 protected:
 123 #ifndef DOXYGEN
 124   friend Host;
 125   friend Link;
 126   friend Disk;
 127   friend kernel::routing::NetPoint;
 128   friend kernel::routing::NetZoneImpl;
 129   friend kernel::resource::HostImpl;
 130   friend kernel::resource::StandardLinkImpl;
 131   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
 132   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
 133   void set_netzone_root(const NetZone* netzone);
 134 #endif /*DOXYGEN*/
 135
 136 public:
 137   /** Returns the amount of hosts existing in the platform. */
 138   size_t get_host_count() const;
 139   /** Returns a vector of all hosts found in the platform.
 140    *
 141    * The order is generally different from the creation/declaration order in the XML platform because we use a hash
 142    * table internally.
 143    */
 144   std::vector<Host*> get_all_hosts() const;
 145   std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter) const;
 146   Host* host_by_name(const std::string& name) const;
 147   Host* host_by_name_or_null(const std::string& name) const;
 148
 149   size_t get_link_count() const;
 150   std::vector<Link*> get_all_links() const;
 151   std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter) const;
 152   Link* link_by_name(const std::string& name) const;
 153   /**
 154    * @brief Find a split-duplex link from its name.
 155    * @throw std::invalid_argument if the searched link does not exist.
 156    */
 157   SplitDuplexLink* split_duplex_link_by_name(const std::string& name) const;
 158   Link* link_by_name_or_null(const std::string& name) const;
 159
 160   Mailbox* mailbox_by_name_or_create(const std::string& name) const;
 161
 162   size_t get_actor_count() const;
 163   std::vector<ActorPtr> get_all_actors() const;
 164   std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const;
 165
 166   std::vector<kernel::routing::NetPoint*> get_all_netpoints() const;
 167   kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name) const;
 168   /**
 169    * @brief Get netpoint by its name
 170    *
 171    * @param name Netpoint name
 172    * @throw std::invalid_argument if netpoint doesn't exist
 173    */
 174   kernel::routing::NetPoint* netpoint_by_name(const std::string& name) const;
 175
 176   NetZone* get_netzone_root() const;
 177
 178   NetZone* netzone_by_name_or_null(const std::string& name) const;
 179
 180   /**
 181    * @brief Add a model to engine list
 182    *
 183    * @param model        Pointer to model
 184    * @param dependencies List of dependencies for this model (optional)
 185    */
 186   void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
 187                  const std::vector<kernel::resource::Model*>& dependencies = {});
 188
 189   /** @brief Get list of all models managed by this engine */
 190   const std::vector<simgrid::kernel::resource::Model*>& get_all_models() const;
 191
 192   /** @brief Retrieves all netzones of the type indicated by the template argument */
 193   template <class T> std::vector<T*> get_filtered_netzones() const
 194   {
 195     static_assert(std::is_base_of_v<kernel::routing::NetZoneImpl, T>,
 196                   "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 197     std::vector<T*> res;
 198     get_filtered_netzones_recursive(get_netzone_root(), &res);
 199     return res;
 200   }
 201
 202   kernel::EngineImpl* get_impl() const
 203   {
 204     return pimpl_;
 205   }
 206
 207   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 208   static bool is_initialized();
 209   /** @brief set a configuration variable
 210    *
 211    * @beginrst
 212    * Do --help on any simgrid binary to see the list of currently existing configuration variables
 213    * (see also :ref:`options`).
 214    * @endrst
 215    *
 216    * Example:
 217    * simgrid::s4u::Engine::set_config("host/model:ptask_L07");
 218    */
 219   static void set_config(const std::string& str);
 220   static void set_config(const std::string& name, int value);
 221   static void set_config(const std::string& name, bool value);
 222   static void set_config(const std::string& name, double value);
 223   static void set_config(const std::string& name, const std::string& value);
 224
 225   Engine*
 226   set_default_comm_data_copy_callback(const std::function<void(kernel::activity::CommImpl*, void*, size_t)>& callback);
 227
 228   /** Add a callback fired when the platform is created (ie, the xml file parsed),
 229    * right before the actual simulation starts. */
 230   static void on_platform_created_cb(const std::function<void()>& cb) { on_platform_created.connect(cb); }
 231   /** Add a callback fired when the platform is about to be created
 232    * (ie, after any configuration change and just before the resource creation) */
 233   static void on_platform_creation_cb(const std::function<void()>& cb) { on_platform_creation.connect(cb); }
 234   /** Add a callback fired when the main simulation loop starts, at the beginning of the first call to Engine::run() */
 235   static void on_simulation_start_cb(const std::function<void()>& cb) { on_simulation_start.connect(cb); }
 236   /** Add a callback fired when the main simulation loop ends, just before the end of Engine::run() */
 237   static void on_simulation_end_cb(const std::function<void()>& cb) { on_simulation_end.connect(cb); }
 238
 239   /** Add a callback fired when the time jumps into the future.
 240    *
 241    * It is fired right after the time change (use get_clock() to get the new timestamp).
 242    * The callback parameter is the time delta since previous timestamp. */
 243   static void on_time_advance_cb(const std::function<void(double)>& cb) { on_time_advance.connect(cb); }
 244
 245   /** Add a callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each
 246    * actor is also executed on deadlock. */
 247   static void on_deadlock_cb(const std::function<void(void)>& cb) { on_deadlock.connect(cb); }
 248
 249 #ifndef DOXYGEN
 250   /* FIXME signals should be private */
 251   static xbt::signal<void()> on_platform_created;
 252   static xbt::signal<void()> on_platform_creation;
 253 #endif
 254
 255 private:
 256   static xbt::signal<void()> on_simulation_start;
 257   static xbt::signal<void(double)> on_time_advance;
 258   static xbt::signal<void(void)> on_deadlock;
 259   static xbt::signal<void()> on_simulation_end;
 260
 261   kernel::EngineImpl* const pimpl_;
 262   static Engine* instance_;
 263   void initialize(int* argc, char** argv);
 264 };
 265
 266 std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
 267 std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
 268 std::vector<ActivityPtr> create_DAG_from_json(const std::string& filename);
 269
 270 #ifndef DOXYGEN /* Internal use only, no need to expose it */
 271 template <class T>
 272 XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector<T*>* whereto)
 273 {
 274   static_assert(std::is_base_of_v<kernel::routing::NetZoneImpl, T>,
 275                 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 276   for (auto const& elem : current->get_children()) {
 277     get_filtered_netzones_recursive(elem, whereto);
 278     auto* elem_impl = dynamic_cast<T*>(elem->get_impl());
 279     if (elem_impl != nullptr)
 280       whereto->push_back(elem_impl);
 281   }
 282 }
 283 #endif
 284 } // namespace simgrid::s4u
 285
 286 #endif /* SIMGRID_S4U_ENGINE_HPP */