include/simgrid/s4u/Engine.hpp

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