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 private:
  32   ~Engine();
  33
  34 public:
  35   /** Constructor, taking the command line parameters of your main function */
  36   Engine(int* argc, char** argv);
  37
  38   /** Finalize the default engine and all its dependencies */
  39   static void shutdown();
  40
  41   /** @brief Load a platform file describing the environment
  42    *
  43    * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
  44    * Some examples can be found in the directory examples/platforms.
  45    */
  46   void loadPlatform(const char* platf);
  47
  48   /** Registers the main function of an actor that will be launched from the deployment file */
  49   void registerFunction(const char* name, int (*code)(int, char**));
  50
  51   /** Registers a function as the default main function of actors
  52    *
  53    * It will be used as fallback when the function requested from the deployment file was not registered.
  54    * It is used for trace-based simulations (see examples/msg/actions).
  55    */
  56   void registerDefault(int (*code)(int, char**));
  57
  58   /** @brief Load a deployment file and launch the actors that it contains */
  59   void loadDeployment(const char* deploy);
  60
  61   size_t hostCount();
  62   void hostList(std::vector<Host*> * whereTo);
  63
  64   /** @brief Run the simulation */
  65   void run();
  66
  67   /** @brief Retrieve the simulation time */
  68   static double getClock();
  69
  70   /** @brief Retrieve the engine singleton */
  71   static s4u::Engine* instance();
  72
  73   /** @brief Retrieve the root netzone, containing all others */
  74   simgrid::s4u::NetZone* netRoot();
  75
  76   /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
  77   simgrid::s4u::NetZone* netzoneByNameOrNull(const char* name);
  78
  79   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
  80   simgrid::kernel::routing::NetPoint* netpointByNameOrNull(const char* name);
  81   void netpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
  82   void netpointRegister(simgrid::kernel::routing::NetPoint * card);
  83   void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
  84
  85   template <class F> void registerFunction(const char* name)
  86   {
  87     simgrid::simix::registerFunction(name, [](std::vector<std::string> args) {
  88       return simgrid::simix::ActorCode([args] {
  89         F code(std::move(args));
  90         code();
  91       });
  92     });
  93   }
  94
  95   template <class F> void registerFunction(const char* name, F code)
  96   {
  97     simgrid::simix::registerFunction(name, [code](std::vector<std::string> args) {
  98       return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
  99     });
 100   }
 101
 102   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 103   static bool isInitialized();
 104
 105   simgrid::kernel::EngineImpl* pimpl;
 106
 107 private:
 108   static s4u::Engine* instance_;
 109 };
 110
 111 /** Callback fired when the platform is created (ie, the xml file parsed),
 112  * right before the actual simulation starts. */
 113 extern XBT_PRIVATE xbt::signal<void()> onPlatformCreated;
 114
 115 /** Callback fired when the main simulation loop ends, just before MSG_run (or similar) ends */
 116 extern XBT_PRIVATE xbt::signal<void()> onSimulationEnd;
 117
 118 /** Callback fired when the time jumps into the future */
 119 extern XBT_PRIVATE xbt::signal<void(double)> onTimeAdvance;
 120 }
 121 } // namespace simgrid::s4u
 122
 123 #endif /* SIMGRID_S4U_ENGINE_HPP */