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 XBT_PUBLIC_CLASS Engine
  28 {
  29 public:
  30   /** Constructor, taking the command line parameters of your main function */
  31   Engine(int* argc, char** argv);
  32
  33   ~Engine();
  34   /** Finalize the default engine and all its dependencies */
  35   static void shutdown();
  36
  37   /** @brief Load a platform file describing the environment
  38    *
  39    * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
  40    * Some examples can be found in the directory examples/platforms.
  41    */
  42   void loadPlatform(const char* platf);
  43
  44   /** Registers the main function of an actor that will be launched from the deployment file */
  45   void registerFunction(const char* name, int (*code)(int, char**));
  46
  47   /** Registers a function as the default main function of actors
  48    *
  49    * It will be used as fallback when the function requested from the deployment file was not registered.
  50    * It is used for trace-based simulations (see examples/msg/actions).
  51    */
  52   void registerDefault(int (*code)(int, char**));
  53
  54   /** @brief Load a deployment file and launch the actors that it contains */
  55   void loadDeployment(const char* deploy);
  56
  57 protected:
  58   friend s4u::Host;
  59   friend s4u::Storage;
  60   void addHost(std::string name, simgrid::s4u::Host * host);
  61   void delHost(std::string name);
  62
  63 public:
  64   void addStorage(std::string name, simgrid::s4u::Storage * storage);
  65   void delStorage(std::string name);
  66   simgrid::s4u::Host* hostByName(std::string name);
  67   simgrid::s4u::Host* hostByNameOrNull(std::string name);
  68   simgrid::s4u::Storage* storageByName(std::string name);
  69   simgrid::s4u::Storage* storageByNameOrNull(std::string name);
  70
  71   size_t getHostCount();
  72   void getHostList(std::vector<Host*> * whereTo);
  73   std::vector<Host*> getAllHosts();
  74
  75   size_t getLinkCount();
  76   void getLinkList(std::vector<Link*> * list);
  77   std::vector<Link*> getAllLinks();
  78
  79   std::vector<Storage*> getAllStorages();
  80
  81   /** @brief Run the simulation */
  82   void run();
  83
  84   /** @brief Retrieve the simulation time */
  85   static double getClock();
  86
  87   /** @brief Retrieve the engine singleton */
  88   static s4u::Engine* getInstance();
  89
  90   /** @brief Retrieve the root netzone, containing all others */
  91   simgrid::s4u::NetZone* getNetRoot();
  92
  93   /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
  94   simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
  95
  96   /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */
  97   template <class T> void getNetzoneByType(std::vector<T*> * whereto) { netzoneByTypeRecursive(getNetRoot(), whereto); }
  98   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
  99   simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
 100   void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
 101   void netpointRegister(simgrid::kernel::routing::NetPoint * card);
 102   void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
 103
 104   template <class F> void registerFunction(const char* name)
 105   {
 106     simgrid::simix::registerFunction(name, [](std::vector<std::string> args) {
 107       return simgrid::simix::ActorCode([args] {
 108         F code(std::move(args));
 109         code();
 110       });
 111     });
 112   }
 113
 114   template <class F> void registerFunction(const char* name, F code)
 115   {
 116     simgrid::simix::registerFunction(name, [code](std::vector<std::string> args) {
 117       return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
 118     });
 119   }
 120
 121   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 122   static bool isInitialized();
 123
 124   /** @brief set a configuration variable
 125    *
 126    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
 127    *
 128    * Example:
 129    * e->setConfig("host/model","ptask_L07");
 130    */
 131   void setConfig(std::string str);
 132
 133   simgrid::kernel::EngineImpl* pimpl;
 134
 135 private:
 136   static s4u::Engine* instance_;
 137 };
 138
 139 /** Callback fired when the platform is created (ie, the xml file parsed),
 140  * right before the actual simulation starts. */
 141 extern XBT_PUBLIC(xbt::signal<void()>) onPlatformCreated;
 142
 143 /** Callback fired when the main simulation loop ends, just before MSG_run (or similar) ends */
 144 extern XBT_PUBLIC(xbt::signal<void()>) onSimulationEnd;
 145
 146 /** Callback fired when the time jumps into the future */
 147 extern XBT_PUBLIC(xbt::signal<void(double)>) onTimeAdvance;
 148
 149 /** Callback fired when the time cannot jump because of inter-actors deadlock */
 150 extern XBT_PUBLIC(xbt::signal<void(void)>) onDeadlock;
 151
 152 template <class T> XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector<T*>* whereto)
 153 {
 154   for (auto const& elem : *(current->getChildren())) {
 155     netzoneByTypeRecursive(elem, whereto);
 156     if (elem == dynamic_cast<T*>(elem))
 157       whereto->push_back(dynamic_cast<T*>(elem));
 158   }
 159 }
 160 }
 161 } // namespace simgrid::s4u
 162
 163 #endif /* SIMGRID_S4U_ENGINE_HPP */