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::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(const char* 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     std::vector<T*> res;
 136     get_filtered_netzones_recursive(get_netzone_root(), &res);
 137     return res;
 138   }
 139
 140   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 141   static bool is_initialized();
 142   /** @brief set a configuration variable
 143    *
 144    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
 145    * options).
 146    *
 147    * Example:
 148    * e->set_config("host/model:ptask_L07");
 149    */
 150   void set_config(std::string str);
 151
 152 private:
 153   simgrid::kernel::EngineImpl* pimpl;
 154   static s4u::Engine* instance_;
 155
 156   //////////////// Deprecated functions
 157 public:
 158   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf)
 159   {
 160     load_platform(platf);
 161   }
 162   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const char* name,
 163                                                                                              int (*code)(int, char**))
 164   {
 165     register_function(name, code);
 166   }
 167   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
 168   {
 169     register_default(code);
 170   }
 171   template <class F>
 172   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name)
 173   {
 174     register_actor<F>(name);
 175   }
 176   template <class F>
 177   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name, F code)
 178   {
 179     register_actor<F>(name, code);
 180   }
 181
 182   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
 183   {
 184     load_deployment(deploy);
 185   }
 186   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
 187   {
 188     return host_by_name(name);
 189   }
 190   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
 191       std::string name)
 192   {
 193     return host_by_name_or_null(name);
 194   }
 195   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
 196       std::string name)
 197   {
 198     return storage_by_name(name);
 199   }
 200   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
 201       std::string name)
 202   {
 203     return storage_by_name_or_null(name);
 204   }
 205
 206   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
 207   XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_hosts()") void getHostList(std::vector<Host*>* whereTo);
 208   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
 209   {
 210     return get_all_hosts();
 211   }
 212   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
 213   XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_links()") void getLinkList(std::vector<Link*>* list);
 214   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
 215   {
 216     return get_all_links();
 217   }
 218   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
 219   {
 220     return get_all_storages();
 221   }
 222   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
 223   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
 224       std::vector<simgrid::kernel::routing::NetPoint*>* list);
 225   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()") simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name)
 226   {
 227     return netpoint_by_name_or_null(name);
 228   }
 229   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot()
 230   {
 231     return get_netzone_root();
 232   }
 233   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name)
 234   {
 235     return netzone_by_name_or_null(name);
 236   }
 237   template <class T>
 238   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType(
 239       std::vector<T*>* whereto)
 240   {
 241     get_filtered_netzones_recursive(get_netzone_root(), whereto);
 242   }
 243
 244   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
 245   {
 246     return get_instance();
 247   }
 248   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
 249   {
 250     return is_initialized();
 251   }
 252   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
 253 };
 254
 255 /** Callback fired when the platform is created (ie, the xml file parsed),
 256  * right before the actual simulation starts. */
 257 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
 258
 259 /** Callback fired when the platform is about to be created
 260  * (ie, after any configuration change and just before the resource creation) */
 261 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
 262
 263 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 264 extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
 265
 266 /** Callback fired when the time jumps into the future */
 267 extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
 268
 269 /** Callback fired when the time cannot advance because of inter-actors deadlock */
 270 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
 271
 272 template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
 273 {
 274   for (auto const& elem : *(current->get_children())) {
 275     get_filtered_netzones_recursive(elem, whereto);
 276     if (elem == dynamic_cast<T*>(elem))
 277       whereto->push_back(dynamic_cast<T*>(elem));
 278   }
 279 }
 280 }
 281 } // namespace simgrid::s4u
 282
 283 #endif /* SIMGRID_S4U_ENGINE_HPP */