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