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
  46   /** Registers a function as the default main function of actors
  47    *
  48    * It will be used as fallback when the function requested from the deployment file was not registered.
  49    * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
  50    */
  51   void register_default(int (*code)(int, char**));
  52
  53   /** @brief Load a deployment file and launch the actors that it contains */
  54   void load_deployment(const char* deploy);
  55
  56 protected:
  57   friend s4u::Host;
  58   friend s4u::Storage;
  59   void add_host(std::string name, simgrid::s4u::Host* host);
  60   void del_host(std::string name);
  61   void add_storage(std::string name, simgrid::s4u::Storage* storage);
  62   void del_storage(std::string name);
  63
  64 public:
  65   simgrid::s4u::Host* host_by_name(std::string name);
  66   simgrid::s4u::Host* host_by_name_or_null(std::string name);
  67   simgrid::s4u::Storage* storage_by_name(std::string name);
  68   simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
  69
  70   size_t get_host_count();
  71   void get_host_list(std::vector<Host*>* whereTo);
  72   std::vector<Host*> get_all_hosts();
  73
  74   size_t getLinkCount();
  75   void getLinkList(std::vector<Link*> * list);
  76   std::vector<Link*> getAllLinks();
  77
  78   std::vector<Storage*> getAllStorages();
  79
  80   /** @brief Run the simulation */
  81   void run();
  82
  83   /** @brief Retrieve the simulation time */
  84   static double getClock();
  85
  86   /** @brief Retrieve the engine singleton */
  87   static s4u::Engine* getInstance();
  88
  89   /** @brief Retrieve the root netzone, containing all others */
  90   simgrid::s4u::NetZone* getNetRoot();
  91
  92   /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
  93   simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
  94
  95   /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */
  96   template <class T> void getNetzoneByType(std::vector<T*> * whereto) { netzoneByTypeRecursive(getNetRoot(), whereto); }
  97   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
  98   simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
  99   void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
 100   void netpointRegister(simgrid::kernel::routing::NetPoint * card);
 101   void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
 102
 103   template <class F> void register_actor(const char* name)
 104   {
 105     simgrid::simix::register_function(name, [](std::vector<std::string> args) {
 106       return simgrid::simix::ActorCode([args] {
 107         F code(std::move(args));
 108         code();
 109       });
 110     });
 111   }
 112
 113   template <class F> void register_actor(const char* name, F code)
 114   {
 115     simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
 116       return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
 117     });
 118   }
 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   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
 146   {
 147     load_deployment(deploy);
 148   }
 149   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
 150   {
 151     return host_by_name(name);
 152   }
 153   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
 154       std::string name)
 155   {
 156     return host_by_name_or_null(name);
 157   }
 158   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
 159       std::string name)
 160   {
 161     return storage_by_name(name);
 162   }
 163   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
 164       std::string name)
 165   {
 166     return storage_by_name_or_null(name);
 167   }
 168
 169   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
 170   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_list()") void getHostList(std::vector<Host*>* whereTo)
 171   {
 172     get_host_list(whereTo);
 173   }
 174   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
 175   {
 176     return get_all_hosts();
 177   }
 178
 179   simgrid::kernel::EngineImpl* pimpl;
 180
 181 private:
 182   static s4u::Engine* instance_;
 183 };
 184
 185 /** Callback fired when the platform is created (ie, the xml file parsed),
 186  * right before the actual simulation starts. */
 187 extern XBT_PUBLIC xbt::signal<void()> onPlatformCreated;
 188
 189 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 190 extern XBT_PUBLIC xbt::signal<void()> onSimulationEnd;
 191
 192 /** Callback fired when the time jumps into the future */
 193 extern XBT_PUBLIC xbt::signal<void(double)> onTimeAdvance;
 194
 195 /** Callback fired when the time cannot jump because of inter-actors deadlock */
 196 extern XBT_PUBLIC xbt::signal<void(void)> onDeadlock;
 197
 198 template <class T> XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector<T*>* whereto)
 199 {
 200   for (auto const& elem : *(current->getChildren())) {
 201     netzoneByTypeRecursive(elem, whereto);
 202     if (elem == dynamic_cast<T*>(elem))
 203       whereto->push_back(dynamic_cast<T*>(elem));
 204   }
 205 }
 206 }
 207 } // namespace simgrid::s4u
 208
 209 #endif /* SIMGRID_S4U_ENGINE_HPP */