include/simgrid/s4u/Engine.hpp

   1 /* Copyright (c) 2006-2018. 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 <string>
  10 #include <utility>
  11 #include <vector>
  12
  13 #include <xbt/base.h>
  14 #include <xbt/functional.hpp>
  15
  16 #include <simgrid/forward.h>
  17 #include <simgrid/simix.hpp>
  18
  19 #include <simgrid/s4u/NetZone.hpp>
  20
  21 namespace simgrid {
  22 namespace s4u {
  23 /** @brief Simulation engine
  24  *
  25  * This class is an interface to the simulation engine.
  26  */
  27 class XBT_PUBLIC Engine {
  28 public:
  29   /** Constructor, taking the command line parameters of your main function */
  30   Engine(int* argc, char** argv);
  31
  32   ~Engine();
  33   /** Finalize the default engine and all its dependencies */
  34   static void shutdown();
  35
  36   /** @brief Run the simulation */
  37   void run();
  38
  39   /** @brief Retrieve the simulation time */
  40   static double get_clock();
  41   /** @brief Retrieve the engine singleton */
  42   static s4u::Engine* get_instance();
  43
  44   /** @brief Load a platform file describing the environment
  45    *
  46    * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
  47    * Some examples can be found in the directory examples/platforms.
  48    */
  49   void load_platform(const char* platf);
  50
  51   /** Registers the main function of an actor that will be launched from the deployment file */
  52   void register_function(const char* name, int (*code)(int, char**));
  53   // FIXME: provide a register_function(std::string, void (*code)(int, char**)) and deprecate the int returning one
  54   // FIXME: provide a register_function(std::string, std::vector<std::string>)
  55
  56   /** Registers a function as the default main function of actors
  57    *
  58    * It will be used as fallback when the function requested from the deployment file was not registered.
  59    * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
  60    */
  61   void register_default(int (*code)(int, char**));
  62
  63   template <class F> void register_actor(const char* name)
  64   {
  65     simgrid::simix::register_function(name, [](std::vector<std::string> args) {
  66       return simgrid::simix::ActorCode([args] {
  67         F code(std::move(args));
  68         code();
  69       });
  70     });
  71   }
  72
  73   template <class F> void register_actor(const char* name, F code)
  74   {
  75     simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
  76       return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
  77     });
  78   }
  79
  80   /** @brief Load a deployment file and launch the actors that it contains */
  81   void load_deployment(const char* deploy);
  82
  83 protected:
  84   friend s4u::Host;
  85   friend s4u::Storage;
  86   friend kernel::routing::NetPoint;
  87   friend kernel::routing::NetZoneImpl;
  88   void host_register(std::string name, simgrid::s4u::Host* host);
  89   void host_unregister(std::string name);
  90   void storage_register(std::string name, simgrid::s4u::Storage* storage);
  91   void storage_unregister(std::string name);
  92   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
  93   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
  94
  95 public:
  96   size_t get_host_count();
  97   std::vector<Host*> get_all_hosts();
  98   simgrid::s4u::Host* host_by_name(std::string name);
  99   simgrid::s4u::Host* host_by_name_or_null(std::string name);
 100
 101   size_t get_link_count();
 102   std::vector<Link*> get_all_links();
 103
 104   size_t get_storage_count();
 105   std::vector<Storage*> get_all_storages();
 106   simgrid::s4u::Storage* storage_by_name(std::string name);
 107   simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
 108
 109   std::vector<simgrid::kernel::routing::NetPoint*> get_all_netpoints();
 110   simgrid::kernel::routing::NetPoint* netpoint_by_name_or_null(std::string name);
 111
 112   simgrid::s4u::NetZone* get_netzone_root();
 113
 114   simgrid::s4u::NetZone* netzone_by_name_or_null(const char* name);
 115
 116   /** @brief Retrieves all netzones of the type indicated by the template argument */
 117   template <class T> std::vector<T*> filter_netzones_by_type()
 118   {
 119     std::vector<T*> res;
 120     filter_netzones_by_type_recursive(get_netzone_root(), &res);
 121     return res;
 122   }
 123
 124   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 125   static bool is_initialized();
 126   /** @brief set a configuration variable
 127    *
 128    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
 129    * options).
 130    *
 131    * Example:
 132    * e->set_config("host/model:ptask_L07");
 133    */
 134   void set_config(std::string str);
 135
 136   simgrid::kernel::EngineImpl* pimpl;
 137
 138 private:
 139   static s4u::Engine* instance_;
 140
 141   //////////////// Deprecated functions
 142 public:
 143   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf)
 144   {
 145     load_platform(platf);
 146   }
 147   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const char* name,
 148                                                                                              int (*code)(int, char**))
 149   {
 150     register_function(name, code);
 151   }
 152   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
 153   {
 154     register_default(code);
 155   }
 156   template <class F>
 157   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name)
 158   {
 159     register_actor<F>(name);
 160   }
 161   template <class F>
 162   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name, F code)
 163   {
 164     register_actor<F>(name, code);
 165   }
 166
 167   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
 168   {
 169     load_deployment(deploy);
 170   }
 171   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
 172   {
 173     return host_by_name(name);
 174   }
 175   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
 176       std::string name)
 177   {
 178     return host_by_name_or_null(name);
 179   }
 180   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
 181       std::string name)
 182   {
 183     return storage_by_name(name);
 184   }
 185   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
 186       std::string name)
 187   {
 188     return storage_by_name_or_null(name);
 189   }
 190
 191   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
 192   XBT_ATTRIB_DEPRECATED_v322("Engine::getHostList() is deprecated in favor of Engine::get_all_hosts(). Please switch "
 193                              "before v3.22") void getHostList(std::vector<Host*>* whereTo);
 194   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
 195   {
 196     return get_all_hosts();
 197   }
 198   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
 199   XBT_ATTRIB_DEPRECATED_v322("Engine::getLinkList() is deprecated in favor of Engine::get_all_links(). Please "
 200                              "switch before v3.22") void getLinkList(std::vector<Link*>* list);
 201   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
 202   {
 203     return get_all_links();
 204   }
 205   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
 206   {
 207     return get_all_storages();
 208   }
 209   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
 210   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
 211       std::vector<simgrid::kernel::routing::NetPoint*>* list);
 212   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()")
 213       simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name)
 214   {
 215     return netpoint_by_name_or_null(name);
 216   }
 217   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot()
 218   {
 219     return get_netzone_root();
 220   }
 221   XBT_ATTRIB_DEPRECATED_v323(
 222       "Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name)
 223   {
 224     return netzone_by_name_or_null(name);
 225   }
 226   template <class T>
 227   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType(
 228       std::vector<T*>* whereto)
 229   {
 230     filter_netzones_by_type_recursive(get_netzone_root(), whereto);
 231   }
 232
 233   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
 234   {
 235     return get_instance();
 236   }
 237   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
 238   {
 239     return is_initialized();
 240   }
 241   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
 242 };
 243
 244 /** Callback fired when the platform is created (ie, the xml file parsed),
 245  * right before the actual simulation starts. */
 246 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
 247
 248 /** Callback fired when the platform is about to be created
 249  * (ie, after any configuration change and just before the resource creation) */
 250 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
 251
 252 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 253 extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
 254
 255 /** Callback fired when the time jumps into the future */
 256 extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
 257
 258 /** Callback fired when the time cannot jump because of inter-actors deadlock */
 259 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
 260
 261 template <class T> XBT_PRIVATE void filter_netzones_by_type_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
 262 {
 263   for (auto const& elem : *(current->getChildren())) {
 264     filter_netzones_by_type_recursive(elem, whereto);
 265     if (elem == dynamic_cast<T*>(elem))
 266       whereto->push_back(dynamic_cast<T*>(elem));
 267   }
 268 }
 269 }
 270 } // namespace simgrid::s4u
 271
 272 #endif /* SIMGRID_S4U_ENGINE_HPP */