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