include/simgrid/s4u/Engine.hpp

   1 /* Copyright (c) 2006-2020. 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   XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_function(
  52       const std::string& name, int (*code)(int, char**));
  53
  54   void register_function(const std::string& name, const std::function<void(int, char**)>& code);
  55   void register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code);
  56
  57   XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_default(
  58       int (*code)(int, char**));
  59   void register_default(const std::function<void(int, char**)>& code);
  60   void register_default(const kernel::actor::ActorCodeFactory& factory);
  61
  62   void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
  63   template <class F> void register_actor(const std::string& name)
  64   {
  65     kernel::actor::ActorCodeFactory code_factory = [](std::vector<std::string> args) {
  66       return kernel::actor::ActorCode([args = std::move(args)]() mutable {
  67         F code(std::move(args));
  68         code();
  69       });
  70     };
  71     register_function(name, code_factory);
  72   }
  73   template <class F> void register_actor(const std::string& name, F code)
  74   {
  75     kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
  76       return kernel::actor::ActorCode([code, args = std::move(args)]() mutable { code(std::move(args)); });
  77     };
  78     register_function(name, code_factory);
  79   }
  80
  81   void load_deployment(const std::string& deploy) const;
  82
  83 protected:
  84 #ifndef DOXYGEN
  85   friend Host;
  86   friend Link;
  87   friend Disk;
  88   friend Storage;
  89   friend kernel::routing::NetPoint;
  90   friend kernel::routing::NetZoneImpl;
  91   friend kernel::resource::LinkImpl;
  92   void host_register(const std::string& name, Host* host);
  93   void host_unregister(const std::string& name);
  94   void link_register(const std::string& name, const Link* link);
  95   void link_unregister(const std::string& name);
  96   void storage_register(const std::string& name, const Storage* storage);
  97   void storage_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 #ifndef DOXYGEN
 126   size_t get_storage_count() const;
 127   std::vector<Storage*> get_all_storages() const;
 128   Storage* storage_by_name(const std::string& name) const;
 129   Storage* storage_by_name_or_null(const std::string& name) const;
 130 #endif
 131
 132   std::vector<kernel::routing::NetPoint*> get_all_netpoints() const;
 133   kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name) const;
 134
 135   NetZone* get_netzone_root() const;
 136   void set_netzone_root(const NetZone* netzone);
 137
 138   NetZone* netzone_by_name_or_null(const std::string& name) const;
 139
 140   /** @brief Retrieves all netzones of the type indicated by the template argument */
 141   template <class T> std::vector<T*> get_filtered_netzones() const
 142   {
 143     static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 144                   "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 145     std::vector<T*> res;
 146     get_filtered_netzones_recursive(get_netzone_root(), &res);
 147     return res;
 148   }
 149
 150   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 151   static bool is_initialized();
 152   /** @brief set a configuration variable
 153    *
 154    * @beginrst
 155    * Do --help on any simgrid binary to see the list of currently existing configuration variables
 156    * (see also :ref:`options`).
 157    * @endrst
 158    *
 159    * Example:
 160    * simgrid::s4u::Engine::set_config("host/model:ptask_L07");
 161    */
 162   static void set_config(const std::string& str);
 163   static void set_config(const std::string& name, int value);
 164   static void set_config(const std::string& name, bool value);
 165   static void set_config(const std::string& name, double value);
 166   static void set_config(const std::string& name, const std::string& value);
 167
 168   /** Callback fired when the platform is created (ie, the xml file parsed),
 169    * right before the actual simulation starts. */
 170   static xbt::signal<void()> on_platform_created;
 171
 172   /** Callback fired when the platform is about to be created
 173    * (ie, after any configuration change and just before the resource creation) */
 174   static xbt::signal<void()> on_platform_creation;
 175
 176   /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 177   static xbt::signal<void()> on_simulation_end;
 178
 179   /** Callback fired when the time jumps into the future */
 180   static xbt::signal<void(double)> on_time_advance;
 181
 182   /** Callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each actor
 183    * is also executed on deadlock. */
 184   static xbt::signal<void(void)> on_deadlock;
 185
 186 private:
 187   kernel::EngineImpl* const pimpl;
 188   static Engine* instance_;
 189 };
 190
 191 #ifndef DOXYGEN /* Internal use only, no need to expose it */
 192 template <class T>
 193 XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector<T*>* whereto)
 194 {
 195   static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 196                 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 197   for (auto const& elem : current->get_children()) {
 198     get_filtered_netzones_recursive(elem, whereto);
 199     auto* elem_impl = dynamic_cast<T*>(elem->get_impl());
 200     if (elem_impl != nullptr)
 201       whereto->push_back(elem_impl);
 202   }
 203 }
 204 #endif
 205 } // namespace s4u
 206 } // namespace simgrid
 207
 208 #endif /* SIMGRID_S4U_ENGINE_HPP */