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