class XBT_PUBLIC Engine {
public:
/** Constructor, taking the command line parameters of your main function */
- Engine(int* argc, char** argv);
+ explicit Engine(int* argc, char** argv);
+ /** Currently, only one instance is allowed to exist. This is why you can't copy or move it */
+ Engine(const Engine&) = delete;
+ Engine(Engine&&) = delete;
~Engine();
/** Finalize the default engine and all its dependencies */
static void shutdown();
+ /** @brief Run the simulation */
+ void run();
+
+ /** @brief Retrieve the simulation time */
+ static double get_clock();
+ /** @brief Retrieve the engine singleton */
+ static s4u::Engine* get_instance();
+
/** @brief Load a platform file describing the environment
*
* The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
* Some examples can be found in the directory examples/platforms.
*/
- void load_platform(const char* platf);
+ void load_platform(std::string platf);
/** Registers the main function of an actor that will be launched from the deployment file */
- void register_function(const char* name, int (*code)(int, char**));
- // FIXME: provide a register_function(std::string, void (*code)(int, char**)) and deprecate the int returning one
- // FIXME: provide a register_function(std::string, std::vector<std::string>)
+ void register_function(std::string name, int (*code)(int, char**));
+ /** Registers the main function of an actor that will be launched from the deployment file */
+ void register_function(std::string name, void (*code)(std::vector<std::string>));
/** Registers a function as the default main function of actors
*
*/
void register_default(int (*code)(int, char**));
- template <class F> void register_actor(const char* name)
+ template <class F> void register_actor(std::string name)
{
simgrid::simix::register_function(name, [](std::vector<std::string> args) {
return simgrid::simix::ActorCode([args] {
});
}
- template <class F> void register_actor(const char* name, F code)
+ template <class F> void register_actor(std::string name, F code)
{
simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
}
/** @brief Load a deployment file and launch the actors that it contains */
- void load_deployment(const char* deploy);
+ void load_deployment(std::string deploy);
protected:
- friend s4u::Host;
- friend s4u::Storage;
- void add_host(std::string name, simgrid::s4u::Host* host);
- void del_host(std::string name);
- void add_storage(std::string name, simgrid::s4u::Storage* storage);
- void del_storage(std::string name);
+#ifndef DOXYGEN
+ friend Host;
+ friend Link;
+ friend Storage;
+ friend kernel::routing::NetPoint;
+ friend kernel::routing::NetZoneImpl;
+ friend kernel::resource::LinkImpl;
+ void host_register(std::string name, Host* host);
+ void host_unregister(std::string name);
+ void link_register(std::string name, Link* link);
+ void link_unregister(std::string name);
+ void storage_register(std::string name, Storage* storage);
+ void storage_unregister(std::string name);
+ void netpoint_register(simgrid::kernel::routing::NetPoint* card);
+ void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
+#endif /*DOXYGEN*/
public:
- simgrid::s4u::Host* host_by_name(std::string name);
- simgrid::s4u::Host* host_by_name_or_null(std::string name);
- simgrid::s4u::Storage* storage_by_name(std::string name);
- simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
-
size_t get_host_count();
- void get_host_list(std::vector<Host*>* whereTo);
+ /** @brief Returns the list of all hosts found in the platform */
std::vector<Host*> get_all_hosts();
+ std::vector<Host*> get_filtered_hosts(std::function<bool(Host*)> filter);
+ simgrid::s4u::Host* host_by_name(std::string name);
+ simgrid::s4u::Host* host_by_name_or_null(std::string name);
- size_t getLinkCount();
- void getLinkList(std::vector<Link*> * list);
- std::vector<Link*> getAllLinks();
-
- std::vector<Storage*> getAllStorages();
+ size_t get_link_count();
+ std::vector<Link*> get_all_links();
+ std::vector<Link*> get_filtered_links(std::function<bool(Link*)> filter);
+ simgrid::s4u::Link* link_by_name(std::string name);
+ simgrid::s4u::Link* link_by_name_or_null(std::string name);
- /** @brief Run the simulation */
- void run();
+ size_t get_actor_count();
+ std::vector<ActorPtr> get_all_actors();
+ std::vector<ActorPtr> get_filtered_actors(std::function<bool(ActorPtr)> filter);
- /** @brief Retrieve the simulation time */
- static double getClock();
+ size_t get_storage_count();
+ std::vector<Storage*> get_all_storages();
+ simgrid::s4u::Storage* storage_by_name(std::string name);
+ simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
- /** @brief Retrieve the engine singleton */
- static s4u::Engine* getInstance();
+ std::vector<simgrid::kernel::routing::NetPoint*> get_all_netpoints();
+ simgrid::kernel::routing::NetPoint* netpoint_by_name_or_null(std::string name);
- /** @brief Retrieve the root netzone, containing all others */
- simgrid::s4u::NetZone* getNetRoot();
+ simgrid::s4u::NetZone* get_netzone_root();
+ void set_netzone_root(s4u::NetZone* netzone);
- /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
- simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
+ simgrid::s4u::NetZone* netzone_by_name_or_null(std::string name);
- /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */
- template <class T> void getNetzoneByType(std::vector<T*> * whereto) { netzoneByTypeRecursive(getNetRoot(), whereto); }
- /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
- simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
- void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
- void netpointRegister(simgrid::kernel::routing::NetPoint * card);
- void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
+ /** @brief Retrieves all netzones of the type indicated by the template argument */
+ template <class T> std::vector<T*> get_filtered_netzones()
+ {
+ static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
+ "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
+ std::vector<T*> res;
+ get_filtered_netzones_recursive(get_netzone_root(), &res);
+ return res;
+ }
/** Returns whether SimGrid was initialized yet -- mostly for internal use */
- static bool isInitialized();
-
+ static bool is_initialized();
/** @brief set a configuration variable
*
- * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
+ * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
+ * options).
*
* Example:
- * e->setConfig("host/model","ptask_L07");
+ * e->set_config("host/model:ptask_L07");
*/
- void setConfig(std::string str);
+ void set_config(std::string str);
+
+private:
+ simgrid::kernel::EngineImpl* pimpl;
+ static s4u::Engine* instance_;
- XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf)
+ //////////////// Deprecated functions
+public:
+ /** @deprecated See Engine::load_platform() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(std::string platf)
{
load_platform(platf);
}
- XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const char* name,
+ /** @deprecated See Engine::register_function() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(std::string name,
int (*code)(int, char**))
{
register_function(name, code);
}
+ /** @deprecated See Engine::register_default() */
XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_default()") void registerDefault(int (*code)(int, char**))
{
register_default(code);
}
+ /** @deprecated See Engine::register_actor() */
template <class F>
- XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name)
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name)
{
register_actor<F>(name);
}
+ /** @deprecated See Engine::register_actor() */
template <class F>
- XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name, F code)
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name, F code)
{
register_actor<F>(name, code);
}
- XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
+ /** @deprecated See Engine::load_deployment() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(std::string deploy)
{
load_deployment(deploy);
}
+ /** @deprecated See Engine::host_by_name() */
XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
{
return host_by_name(name);
}
+ /** @deprecated See Engine::host_by_name_or_null() */
XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
std::string name)
{
return host_by_name_or_null(name);
}
+ /** @deprecated See Engine::storage_by_name() */
XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
std::string name)
{
return storage_by_name(name);
}
+ /** @deprecated See Engine::storage_by_name_or_null() */
XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
std::string name)
{
return storage_by_name_or_null(name);
}
+ /** @deprecated See Engine::get_host_count() */
XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
- XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_list()") void getHostList(std::vector<Host*>* whereTo)
- {
- get_host_list(whereTo);
- }
+ /** @deprecated See Engine::get_all_hosts() */
XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
{
return get_all_hosts();
}
+ /** @deprecated See Engine::get_link_count() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
+ /** @deprecated See Engine::get_link_list() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
+ {
+ return get_all_links();
+ }
+ /** @deprecated See Engine::get_all_storages() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
+ {
+ return get_all_storages();
+ }
+ /** @deprecated See Engine::get_clock() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
+ /** @deprecated See Engine::get_all_netpoints() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
+ std::vector<simgrid::kernel::routing::NetPoint*>* list);
+ /** @deprecated See Engine::netpoint_by_name_or_null() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()") simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name)
+ {
+ return netpoint_by_name_or_null(name);
+ }
+ /** @deprecated See Engine::get_netzone_root() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot()
+ {
+ return get_netzone_root();
+ }
+ /** @deprecated See Engine::netzone_by_name_or_null() */
+ XBT_ATTRIB_DEPRECATED_v323(
+ "Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(std::string name)
+ {
+ return netzone_by_name_or_null(name);
+ }
+ /** @deprecated See Engine::filter_netzones_by_type() */
+ template <class T>
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType(
+ std::vector<T*>* whereto)
+ {
+ get_filtered_netzones_recursive(get_netzone_root(), whereto);
+ }
- simgrid::kernel::EngineImpl* pimpl;
-
-private:
- static s4u::Engine* instance_;
+ /** @deprecated See Engine::get_instance() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
+ {
+ return get_instance();
+ }
+ /** @deprecated See Engine::is_initialized() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
+ {
+ return is_initialized();
+ }
+ /** @deprecated See Engine::set_config() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
};
/** Callback fired when the platform is created (ie, the xml file parsed),
* right before the actual simulation starts. */
-extern XBT_PUBLIC xbt::signal<void()> onPlatformCreated;
+extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
+
+/** Callback fired when the platform is about to be created
+ * (ie, after any configuration change and just before the resource creation) */
+extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
/** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
-extern XBT_PUBLIC xbt::signal<void()> onSimulationEnd;
+extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
/** Callback fired when the time jumps into the future */
-extern XBT_PUBLIC xbt::signal<void(double)> onTimeAdvance;
+extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
-/** Callback fired when the time cannot jump because of inter-actors deadlock */
-extern XBT_PUBLIC xbt::signal<void(void)> onDeadlock;
+/** Callback fired when the time cannot advance because of inter-actors deadlock */
+extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
-template <class T> XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector<T*>* whereto)
+template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
{
- for (auto const& elem : *(current->getChildren())) {
- netzoneByTypeRecursive(elem, whereto);
- if (elem == dynamic_cast<T*>(elem))
- whereto->push_back(dynamic_cast<T*>(elem));
+ static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
+ "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
+ for (auto const& elem : current->get_children()) {
+ get_filtered_netzones_recursive(elem, whereto);
+ if (elem->get_impl() == dynamic_cast<T*>(elem->get_impl()))
+ whereto->push_back(dynamic_cast<T*>(elem->get_impl()));
}
}
}
