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   simgrid::s4u::Host* host_by_name(std::string name);
  85   simgrid::s4u::Host* host_by_name_or_null(std::string name);
  86   simgrid::s4u::Storage* storage_by_name(std::string name);
  87   simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
  88
  89   size_t get_host_count();
  90   void get_host_list(std::vector<Host*>* whereTo);
  91   std::vector<Host*> get_all_hosts();
  92
  93   size_t getLinkCount();
  94   void getLinkList(std::vector<Link*> * list);
  95   std::vector<Link*> getAllLinks();
  96
  97   std::vector<Storage*> getAllStorages();
  98
  99   /** @brief Run the simulation */
 100   void run();
 101
 102   /** @brief Retrieve the simulation time */
 103   static double getClock();
 104
 105   /** @brief Retrieve the engine singleton */
 106   static s4u::Engine* getInstance();
 107
 108   /** @brief Retrieve the root netzone, containing all others */
 109   simgrid::s4u::NetZone* getNetRoot();
 110
 111   /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
 112   simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
 113
 114   /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */
 115   template <class T> void getNetzoneByType(std::vector<T*> * whereto) { netzoneByTypeRecursive(getNetRoot(), whereto); }
 116   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
 117   simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
 118   void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
 119   void netpointRegister(simgrid::kernel::routing::NetPoint * card);
 120   void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
 121
 122   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 123   static bool isInitialized();
 124
 125   /** @brief set a configuration variable
 126    *
 127    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
 128    *
 129    * Example:
 130    * e->setConfig("host/model","ptask_L07");
 131    */
 132   void setConfig(std::string str);
 133
 134   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf)
 135   {
 136     load_platform(platf);
 137   }
 138   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const char* name,
 139                                                                                              int (*code)(int, char**))
 140   {
 141     register_function(name, code);
 142   }
 143   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
 144   {
 145     register_default(code);
 146   }
 147   template <class F>
 148   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name)
 149   {
 150     register_actor<F>(name);
 151   }
 152   template <class F>
 153   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name, F code)
 154   {
 155     register_actor<F>(name, code);
 156   }
 157
 158   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
 159   {
 160     load_deployment(deploy);
 161   }
 162   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
 163   {
 164     return host_by_name(name);
 165   }
 166   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
 167       std::string name)
 168   {
 169     return host_by_name_or_null(name);
 170   }
 171   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
 172       std::string name)
 173   {
 174     return storage_by_name(name);
 175   }
 176   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
 177       std::string name)
 178   {
 179     return storage_by_name_or_null(name);
 180   }
 181
 182   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
 183   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_list()") void getHostList(std::vector<Host*>* whereTo)
 184   {
 185     get_host_list(whereTo);
 186   }
 187   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
 188   {
 189     return get_all_hosts();
 190   }
 191
 192   simgrid::kernel::EngineImpl* pimpl;
 193
 194 private:
 195   static s4u::Engine* instance_;
 196 };
 197
 198 /** Callback fired when the platform is created (ie, the xml file parsed),
 199  * right before the actual simulation starts. */
 200 extern XBT_PUBLIC xbt::signal<void()> onPlatformCreated;
 201
 202 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 203 extern XBT_PUBLIC xbt::signal<void()> onSimulationEnd;
 204
 205 /** Callback fired when the time jumps into the future */
 206 extern XBT_PUBLIC xbt::signal<void(double)> onTimeAdvance;
 207
 208 /** Callback fired when the time cannot jump because of inter-actors deadlock */
 209 extern XBT_PUBLIC xbt::signal<void(void)> onDeadlock;
 210
 211 template <class T> XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector<T*>* whereto)
 212 {
 213   for (auto const& elem : *(current->getChildren())) {
 214     netzoneByTypeRecursive(elem, whereto);
 215     if (elem == dynamic_cast<T*>(elem))
 216       whereto->push_back(dynamic_cast<T*>(elem));
 217   }
 218 }
 219 }
 220 } // namespace simgrid::s4u
 221
 222 #endif /* SIMGRID_S4U_ENGINE_HPP */