X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5e22c862d29ac2455672f2bc7f50bbcc9ade21c2..8535ee1c8c2c9fa3bb09e2ef3e5eafab5e9d4565:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 52f96c5d13..eabfef26d9 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -27,12 +27,23 @@ namespace s4u { 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. @@ -87,6 +98,7 @@ protected: public: size_t get_host_count(); std::vector get_all_hosts(); + std::vector get_filtered_hosts(std::function filter); simgrid::s4u::Host* host_by_name(std::string name); simgrid::s4u::Host* host_by_name_or_null(std::string name); @@ -98,39 +110,40 @@ public: simgrid::s4u::Storage* storage_by_name(std::string name); simgrid::s4u::Storage* storage_by_name_or_null(std::string name); - /** @brief Run the simulation */ - void run(); - - /** @brief Retrieve the simulation time */ - static double get_clock(); + std::vector get_all_netpoints(); + simgrid::kernel::routing::NetPoint* netpoint_by_name_or_null(std::string name); - /** @brief Retrieve the engine singleton */ - static s4u::Engine* getInstance(); + simgrid::s4u::NetZone* get_netzone_root(); + void set_netzone_root(s4u::NetZone* netzone); - /** @brief Retrieve the root netzone, containing all others */ - simgrid::s4u::NetZone* getNetRoot(); + simgrid::s4u::NetZone* netzone_by_name_or_null(const char* name); - /** @brief Retrieve the netzone of the given name (or nullptr if not found) */ - simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name); - - /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */ - template void getNetzoneByType(std::vector * 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 * list); + /** @brief Retrieves all netzones of the type indicated by the template argument */ + template std::vector filter_netzones_by_type() + { + std::vector res; + filter_netzones_by_type_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_; + + //////////////// Deprecated functions +public: XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf) { load_platform(platf); @@ -187,9 +200,8 @@ public: return get_all_hosts(); } XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") - XBT_ATTRIB_DEPRECATED_v322("Engine::getLinkList() is deprecated in favor of Engine::get_all_links(). Please " - "switch before v3.22") void getLinkList(std::vector* list); + XBT_ATTRIB_DEPRECATED_v322("Engine::getLinkList() is deprecated in favor of Engine::get_all_links(). Please " + "switch before v3.22") void getLinkList(std::vector* list); XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector getAllLinks() { return get_all_links(); @@ -199,30 +211,61 @@ public: return get_all_storages(); } XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); } + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList( + std::vector* list); + 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); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_netzone_root()") simgrid::s4u::NetZone* getNetRoot() + { + return get_netzone_root(); + } + XBT_ATTRIB_DEPRECATED_v323( + "Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name) + { + return netzone_by_name_or_null(name); + } + template + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType( + std::vector* whereto) + { + filter_netzones_by_type_recursive(get_netzone_root(), whereto); + } - simgrid::kernel::EngineImpl* pimpl; - -private: - static s4u::Engine* instance_; + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance() + { + return get_instance(); + } + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized() + { + return is_initialized(); + } + 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 onPlatformCreated; +extern XBT_PUBLIC xbt::signal 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 on_platform_creation; /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */ -extern XBT_PUBLIC xbt::signal onSimulationEnd; +extern XBT_PUBLIC xbt::signal on_simulation_end; /** Callback fired when the time jumps into the future */ -extern XBT_PUBLIC xbt::signal onTimeAdvance; +extern XBT_PUBLIC xbt::signal on_time_advance; /** Callback fired when the time cannot jump because of inter-actors deadlock */ -extern XBT_PUBLIC xbt::signal onDeadlock; +extern XBT_PUBLIC xbt::signal on_deadlock; -template XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector* whereto) +template XBT_PRIVATE void filter_netzones_by_type_recursive(s4u::NetZone* current, std::vector* whereto) { for (auto const& elem : *(current->getChildren())) { - netzoneByTypeRecursive(elem, whereto); + filter_netzones_by_type_recursive(elem, whereto); if (elem == dynamic_cast(elem)) whereto->push_back(dynamic_cast(elem)); }