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(std::string platf);
  53
  54   /** Registers the main function of an actor that will be launched from the deployment file */
  55   void register_function(std::string name, int (*code)(int, char**));
  56   /** Registers the main function of an actor that will be launched from the deployment file */
  57   void register_function(std::string name, void (*code)(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(std::string 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(std::string 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(std::string deploy);
  85
  86 protected:
  87   friend s4u::Host;
  88   friend s4u::Link;
  89   friend s4u::Storage;
  90   friend kernel::routing::NetPoint;
  91   friend kernel::routing::NetZoneImpl;
  92   friend kernel::resource::LinkImpl;
  93   void host_register(std::string name, simgrid::s4u::Host* host);
  94   void host_unregister(std::string name);
  95   void link_register(std::string name, simgrid::s4u::Link* link);
  96   void link_unregister(std::string name);
  97   void storage_register(std::string name, simgrid::s4u::Storage* storage);
  98   void storage_unregister(std::string name);
  99   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
 100   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
 101
 102 public:
 103   size_t get_host_count();
 104   std::vector<Host*> get_all_hosts();
 105   std::vector<Host*> get_filtered_hosts(std::function<bool(Host*)> filter);
 106   simgrid::s4u::Host* host_by_name(std::string name);
 107   simgrid::s4u::Host* host_by_name_or_null(std::string name);
 108
 109   size_t get_link_count();
 110   std::vector<Link*> get_all_links();
 111   std::vector<Link*> get_filtered_links(std::function<bool(Link*)> filter);
 112   simgrid::s4u::Link* link_by_name(std::string name);
 113   simgrid::s4u::Link* link_by_name_or_null(std::string name);
 114
 115   size_t get_actor_count();
 116   std::vector<ActorPtr> get_all_actors();
 117   std::vector<ActorPtr> get_filtered_actors(std::function<bool(ActorPtr)> filter);
 118
 119   size_t get_storage_count();
 120   std::vector<Storage*> get_all_storages();
 121   simgrid::s4u::Storage* storage_by_name(std::string name);
 122   simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
 123
 124   std::vector<simgrid::kernel::routing::NetPoint*> get_all_netpoints();
 125   simgrid::kernel::routing::NetPoint* netpoint_by_name_or_null(std::string name);
 126
 127   simgrid::s4u::NetZone* get_netzone_root();
 128   void set_netzone_root(s4u::NetZone* netzone);
 129
 130   simgrid::s4u::NetZone* netzone_by_name_or_null(std::string name);
 131
 132   /** @brief Retrieves all netzones of the type indicated by the template argument */
 133   template <class T> std::vector<T*> get_filtered_netzones()
 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    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
 147    * options).
 148    *
 149    * Example:
 150    * e->set_config("host/model:ptask_L07");
 151    */
 152   void set_config(std::string str);
 153
 154 private:
 155   simgrid::kernel::EngineImpl* pimpl;
 156   static s4u::Engine* instance_;
 157
 158   //////////////// Deprecated functions
 159 public:
 160   /** @deprecated See Engine::load_platform() */
 161   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(std::string platf)
 162   {
 163     load_platform(platf);
 164   }
 165   /** @deprecated See Engine::register_function() */
 166   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(std::string name,
 167                                                                                              int (*code)(int, char**))
 168   {
 169     register_function(name, code);
 170   }
 171   /** @deprecated See Engine::register_default() */
 172   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
 173   {
 174     register_default(code);
 175   }
 176   /** @deprecated See Engine::register_actor() */
 177   template <class F>
 178   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name)
 179   {
 180     register_actor<F>(name);
 181   }
 182   /** @deprecated See Engine::register_actor() */
 183   template <class F>
 184   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name, F code)
 185   {
 186     register_actor<F>(name, code);
 187   }
 188
 189   /** @deprecated See Engine::load_deployment() */
 190   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(std::string deploy)
 191   {
 192     load_deployment(deploy);
 193   }
 194   /** @deprecated See Engine::host_by_name() */
 195   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
 196   {
 197     return host_by_name(name);
 198   }
 199   /** @deprecated See Engine::host_by_name_or_null() */
 200   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
 201       std::string name)
 202   {
 203     return host_by_name_or_null(name);
 204   }
 205   /** @deprecated See Engine::storage_by_name() */
 206   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
 207       std::string name)
 208   {
 209     return storage_by_name(name);
 210   }
 211   /** @deprecated See Engine::storage_by_name_or_null() */
 212   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
 213       std::string name)
 214   {
 215     return storage_by_name_or_null(name);
 216   }
 217
 218   /** @deprecated See Engine::get_host_count() */
 219   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
 220   /** @deprecated See Engine::get_all_hosts() */
 221   XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_hosts()") void getHostList(std::vector<Host*>* whereTo);
 222   /** @deprecated See Engine::get_all_hosts() */
 223   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
 224   {
 225     return get_all_hosts();
 226   }
 227   /** @deprecated See Engine::get_link_count() */
 228   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
 229   /** @deprecated See Engine::get_all_links() */
 230   XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_links()") void getLinkList(std::vector<Link*>* list);
 231   /** @deprecated See Engine::get_link_list() */
 232   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
 233   {
 234     return get_all_links();
 235   }
 236   /** @deprecated See Engine::get_all_storages() */
 237   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
 238   {
 239     return get_all_storages();
 240   }
 241   /** @deprecated See Engine::get_clock() */
 242   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
 243   /** @deprecated See Engine::get_all_netpoints() */
 244   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
 245       std::vector<simgrid::kernel::routing::NetPoint*>* list);
 246   /** @deprecated See Engine::netpoint_by_name_or_null() */
 247   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()") simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name)
 248   {
 249     return netpoint_by_name_or_null(name);
 250   }
 251   /** @deprecated See Engine::get_netzone_root() */
 252   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot()
 253   {
 254     return get_netzone_root();
 255   }
 256   /** @deprecated See Engine::netzone_by_name_or_null() */
 257   XBT_ATTRIB_DEPRECATED_v323(
 258       "Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(std::string name)
 259   {
 260     return netzone_by_name_or_null(name);
 261   }
 262   /** @deprecated See Engine::filter_netzones_by_type() */
 263   template <class T>
 264   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType(
 265       std::vector<T*>* whereto)
 266   {
 267     get_filtered_netzones_recursive(get_netzone_root(), whereto);
 268   }
 269
 270   /** @deprecated See Engine::get_instance() */
 271   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
 272   {
 273     return get_instance();
 274   }
 275   /** @deprecated See Engine::is_initialized() */
 276   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
 277   {
 278     return is_initialized();
 279   }
 280   /** @deprecated See Engine::set_config() */
 281   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
 282 };
 283
 284 /** Callback fired when the platform is created (ie, the xml file parsed),
 285  * right before the actual simulation starts. */
 286 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
 287
 288 /** Callback fired when the platform is about to be created
 289  * (ie, after any configuration change and just before the resource creation) */
 290 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
 291
 292 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 293 extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
 294
 295 /** Callback fired when the time jumps into the future */
 296 extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
 297
 298 /** Callback fired when the time cannot advance because of inter-actors deadlock */
 299 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
 300
 301 template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
 302 {
 303   static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 304                 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 305   for (auto const& elem : current->get_children()) {
 306     get_filtered_netzones_recursive(elem, whereto);
 307     if (elem->get_impl() == dynamic_cast<T*>(elem->get_impl()))
 308       whereto->push_back(dynamic_cast<T*>(elem->get_impl()));
 309   }
 310 }
 311 }
 312 } // namespace simgrid::s4u
 313
 314 #endif /* SIMGRID_S4U_ENGINE_HPP */