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