1 /* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_ENGINE_HPP
7 #define SIMGRID_S4U_ENGINE_HPP
14 #include <xbt/functional.hpp>
16 #include <simgrid/simix.hpp>
18 #include <simgrid/s4u/forward.hpp>
25 /** @brief Simulation engine
27 * This class is an interface to the simulation engine.
29 XBT_PUBLIC_CLASS Engine
32 /** Constructor, taking the command line parameters of your main function */
33 Engine(int* argc, char** argv);
36 /** Finalize the default engine and all its dependencies */
37 static void shutdown();
39 /** @brief Load a platform file describing the environment
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.
44 void loadPlatform(const char* platf);
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**));
49 /** Registers a function as the default main function of actors
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).
54 void registerDefault(int (*code)(int, char**));
56 /** @brief Load a deployment file and launch the actors that it contains */
57 void loadDeployment(const char* deploy);
60 void hostList(std::vector<Host*> * whereTo);
62 /** @brief Run the simulation */
65 /** @brief Retrieve the simulation time */
66 static double getClock();
68 /** @brief Retrieve the engine singleton */
69 static s4u::Engine* instance();
71 /** @brief Retrieve the root netzone, containing all others */
72 simgrid::s4u::NetZone* netRoot();
74 /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
75 simgrid::s4u::NetZone* netzoneByNameOrNull(const char* name);
77 /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
78 simgrid::kernel::routing::NetPoint* netpointByNameOrNull(const char* name);
79 void netpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
80 void netpointRegister(simgrid::kernel::routing::NetPoint * card);
81 void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
83 template <class F> void registerFunction(const char* name)
85 simgrid::simix::registerFunction(name, [](std::vector<std::string> args) {
86 return simgrid::simix::ActorCode([args] {
87 F code(std::move(args));
93 template <class F> void registerFunction(const char* name, F code)
95 simgrid::simix::registerFunction(name, [code](std::vector<std::string> args) {
96 return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
100 /** Returns whether SimGrid was initialized yet -- mostly for internal use */
101 static bool isInitialized();
103 simgrid::kernel::EngineImpl* pimpl;
106 static s4u::Engine* instance_;
109 /** Callback fired when the platform is created (ie, the xml file parsed),
110 * right before the actual simulation starts. */
111 extern XBT_PRIVATE xbt::signal<void()> onPlatformCreated;
113 /** Callback fired when the main simulation loop ends, just before MSG_run (or similar) ends */
114 extern XBT_PRIVATE xbt::signal<void()> onSimulationEnd;
116 /** Callback fired when the time jumps into the future */
117 extern XBT_PRIVATE xbt::signal<void(double)> onTimeAdvance;
119 } // namespace simgrid::s4u
121 #endif /* SIMGRID_S4U_ENGINE_HPP */