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   size_t getHostCount();
  60   void getHostList(std::vector<Host*> * whereTo);
  61
  62   /** @brief Run the simulation */
  63   void run();
  64
  65   /** @brief Retrieve the simulation time */
  66   static double getClock();
  67
  68   /** @brief Retrieve the engine singleton */
  69   static s4u::Engine* getInstance();
  70
  71   /** @brief Retrieve the root netzone, containing all others */
  72   simgrid::s4u::NetZone* getNetRoot();
  73
  74   /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
  75   simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
  76
  77   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
  78   simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(const char* name);
  79   void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
  80   void netpointRegister(simgrid::kernel::routing::NetPoint * card);
  81   void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
  82
  83   template <class F> void registerFunction(const char* name)
  84   {
  85     simgrid::simix::registerFunction(name, [](std::vector<std::string> args) {
  86       return simgrid::simix::ActorCode([args] {
  87         F code(std::move(args));
  88         code();
  89       });
  90     });
  91   }
  92
  93   template <class F> void registerFunction(const char* name, F code)
  94   {
  95     simgrid::simix::registerFunction(name, [code](std::vector<std::string> args) {
  96       return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
  97     });
  98   }
  99
 100   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 101   static bool isInitialized();
 102
 103   /** @brief set a configuration variable
 104    *
 105    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
 106    *
 107    * Example:
 108    * e->setConfig("host/model","ptask_L07");
 109    */
 110   void setConfig(std::string str);
 111
 112   simgrid::kernel::EngineImpl* pimpl;
 113
 114 private:
 115   static s4u::Engine* instance_;
 116 };
 117
 118 /** Callback fired when the platform is created (ie, the xml file parsed),
 119  * right before the actual simulation starts. */
 120 extern XBT_PRIVATE xbt::signal<void()> onPlatformCreated;
 121
 122 /** Callback fired when the main simulation loop ends, just before MSG_run (or similar) ends */
 123 extern XBT_PRIVATE xbt::signal<void()> onSimulationEnd;
 124
 125 /** Callback fired when the time jumps into the future */
 126 extern XBT_PRIVATE xbt::signal<void(double)> onTimeAdvance;
 127 }
 128 } // namespace simgrid::s4u
 129
 130 #endif /* SIMGRID_S4U_ENGINE_HPP */