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