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   void addHost(std::string name, simgrid::s4u::Host * host);
  60   void delHost(std::string name);
  61
  62 public:
  63   simgrid::s4u::Host* hostByName(std::string name);
  64   simgrid::s4u::Host* hostByNameOrNull(std::string name);
  65
  66   size_t getHostCount();
  67   void getHostList(std::vector<Host*> * whereTo);
  68   std::vector<Host*> getAllHosts();
  69
  70   size_t getLinkCount();
  71   void getLinkList(std::vector<Link*> * list);
  72   std::vector<Link*> getAllLinks();
  73
  74   /** @brief Run the simulation */
  75   void run();
  76
  77   /** @brief Retrieve the simulation time */
  78   static double getClock();
  79
  80   /** @brief Retrieve the engine singleton */
  81   static s4u::Engine* getInstance();
  82
  83   /** @brief Retrieve the root netzone, containing all others */
  84   simgrid::s4u::NetZone* getNetRoot();
  85
  86   /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
  87   simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
  88
  89   /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */
  90   template <class T> void getNetzoneByType(std::vector<T*> * whereto) { netzoneByTypeRecursive(getNetRoot(), whereto); }
  91   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
  92   simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
  93   void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
  94   void netpointRegister(simgrid::kernel::routing::NetPoint * card);
  95   void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
  96
  97   template <class F> void registerFunction(const char* name)
  98   {
  99     simgrid::simix::registerFunction(name, [](std::vector<std::string> args) {
 100       return simgrid::simix::ActorCode([args] {
 101         F code(std::move(args));
 102         code();
 103       });
 104     });
 105   }
 106
 107   template <class F> void registerFunction(const char* name, F code)
 108   {
 109     simgrid::simix::registerFunction(name, [code](std::vector<std::string> args) {
 110       return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
 111     });
 112   }
 113
 114   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 115   static bool isInitialized();
 116
 117   /** @brief set a configuration variable
 118    *
 119    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
 120    *
 121    * Example:
 122    * e->setConfig("host/model","ptask_L07");
 123    */
 124   void setConfig(std::string str);
 125
 126   simgrid::kernel::EngineImpl* pimpl;
 127
 128 private:
 129   static s4u::Engine* instance_;
 130 };
 131
 132 /** Callback fired when the platform is created (ie, the xml file parsed),
 133  * right before the actual simulation starts. */
 134 extern XBT_PUBLIC(xbt::signal<void()>) onPlatformCreated;
 135
 136 /** Callback fired when the main simulation loop ends, just before MSG_run (or similar) ends */
 137 extern XBT_PUBLIC(xbt::signal<void()>) onSimulationEnd;
 138
 139 /** Callback fired when the time jumps into the future */
 140 extern XBT_PUBLIC(xbt::signal<void(double)>) onTimeAdvance;
 141
 142 /** Callback fired when the time cannot jump because of inter-actors deadlock */
 143 extern XBT_PUBLIC(xbt::signal<void(void)>) onDeadlock;
 144
 145 template <class T> XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector<T*>* whereto)
 146 {
 147   for (auto const& elem : *(current->getChildren())) {
 148     netzoneByTypeRecursive(elem, whereto);
 149     if (elem == dynamic_cast<T*>(elem))
 150       whereto->push_back(dynamic_cast<T*>(elem));
 151   }
 152 }
 153 }
 154 } // namespace simgrid::s4u
 155
 156 #endif /* SIMGRID_S4U_ENGINE_HPP */