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);
61 void addHost(std::string name, simgrid::s4u::Host * host);
62 void delHost(std::string name);
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);
72 /** @brief Run the simulation */
75 /** @brief Retrieve the simulation time */
76 static double getClock();
78 /** @brief Retrieve the engine singleton */
79 static s4u::Engine* getInstance();
81 /** @brief Retrieve the root netzone, containing all others */
82 simgrid::s4u::NetZone* getNetRoot();
84 /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
85 simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
87 /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */
88 template <class T> void getNetzoneByType(std::vector<T*> * whereto);
90 /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
91 simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
92 void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
93 void netpointRegister(simgrid::kernel::routing::NetPoint * card);
94 void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
96 template <class F> void registerFunction(const char* name)
98 simgrid::simix::registerFunction(name, [](std::vector<std::string> args) {
99 return simgrid::simix::ActorCode([args] {
100 F code(std::move(args));
106 template <class F> void registerFunction(const char* name, F code)
108 simgrid::simix::registerFunction(name, [code](std::vector<std::string> args) {
109 return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
113 /** Returns whether SimGrid was initialized yet -- mostly for internal use */
114 static bool isInitialized();
116 /** @brief set a configuration variable
118 * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
121 * e->setConfig("host/model","ptask_L07");
123 void setConfig(std::string str);
125 simgrid::kernel::EngineImpl* pimpl;
128 static s4u::Engine* instance_;
131 /** Callback fired when the platform is created (ie, the xml file parsed),
132 * right before the actual simulation starts. */
133 extern XBT_PUBLIC(xbt::signal<void()>) onPlatformCreated;
135 /** Callback fired when the main simulation loop ends, just before MSG_run (or similar) ends */
136 extern XBT_PUBLIC(xbt::signal<void()>) onSimulationEnd;
138 /** Callback fired when the time jumps into the future */
139 extern XBT_PUBLIC(xbt::signal<void(double)>) onTimeAdvance;
141 /** Callback fired when the time cannot jump because of inter-actors deadlock */
142 extern XBT_PUBLIC(xbt::signal<void(void)>) onDeadlock;
144 } // namespace simgrid::s4u
146 #endif /* SIMGRID_S4U_ENGINE_HPP */