X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b8dae0fb0df3dd5c66241e88f1f574c687c504f9..901293dfbce6b7e0f555dbdc53358aa347fd1a3d:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 767891b124..fe486f403a 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -27,7 +27,10 @@ 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 */ @@ -46,12 +49,12 @@ public: * 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) + 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)); /** Registers a function as the default main function of actors * @@ -60,7 +63,7 @@ public: */ void register_default(int (*code)(int, char**)); - template void register_actor(const char* name) + template void register_actor(std::string name) { simgrid::simix::register_function(name, [](std::vector args) { return simgrid::simix::ActorCode([args] { @@ -70,7 +73,7 @@ public: }); } - template void register_actor(const char* name, F code) + template void register_actor(std::string name, F code) { simgrid::simix::register_function(name, [code](std::vector args) { return simgrid::simix::ActorCode([code, args] { code(std::move(args)); }); @@ -78,15 +81,19 @@ public: } /** @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::Link; friend s4u::Storage; friend kernel::routing::NetPoint; friend kernel::routing::NetZoneImpl; + friend kernel::resource::LinkImpl; void host_register(std::string name, simgrid::s4u::Host* host); void host_unregister(std::string name); + void link_register(std::string name, simgrid::s4u::Link* link); + void link_unregister(std::string name); void storage_register(std::string name, simgrid::s4u::Storage* storage); void storage_unregister(std::string name); void netpoint_register(simgrid::kernel::routing::NetPoint* card); @@ -101,6 +108,13 @@ public: size_t get_link_count(); std::vector get_all_links(); + std::vector get_filtered_links(std::function filter); + simgrid::s4u::Link* link_by_name(std::string name); + simgrid::s4u::Link* link_by_name_or_null(std::string name); + + size_t get_actor_count(); + std::vector get_all_actors(); + std::vector get_filtered_actors(std::function filter); size_t get_storage_count(); std::vector get_all_storages(); @@ -113,13 +127,15 @@ public: simgrid::s4u::NetZone* get_netzone_root(); void set_netzone_root(s4u::NetZone* netzone); - simgrid::s4u::NetZone* netzone_by_name_or_null(const char* name); + simgrid::s4u::NetZone* netzone_by_name_or_null(std::string name); /** @brief Retrieves all netzones of the type indicated by the template argument */ - template std::vector filter_netzones_by_type() + template std::vector get_filtered_netzones() { + static_assert(std::is_base_of::value, + "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl"); std::vector res; - filter_netzones_by_type_recursive(get_netzone_root(), &res); + get_filtered_netzones_recursive(get_netzone_root(), &res); return res; } @@ -141,104 +157,127 @@ private: //////////////// Deprecated functions public: - XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf) + /** @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 - 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(name); } + /** @deprecated See Engine::register_actor() */ template - 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(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_v322("Engine::getHostList() is deprecated in favor of Engine::get_all_hosts(). Please switch " - "before v3.22") void getHostList(std::vector* whereTo); + /** @deprecated See Engine::get_all_hosts() */ + XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_hosts()") void getHostList(std::vector* whereTo); + /** @deprecated See Engine::get_all_hosts() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector 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(); } - 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); + /** @deprecated See Engine::get_all_links() */ + XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_links()") void getLinkList(std::vector* list); + /** @deprecated See Engine::get_link_list() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector getAllLinks() { return get_all_links(); } + /** @deprecated See Engine::get_all_storages() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector 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* list); - XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()") - simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name) + /** @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(const char* name) + "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 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); + get_filtered_netzones_recursive(get_netzone_root(), whereto); } + /** @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); } }; @@ -256,15 +295,17 @@ extern XBT_PUBLIC xbt::signal on_simulation_end; /** Callback fired when the time jumps into the future */ extern XBT_PUBLIC xbt::signal on_time_advance; -/** Callback fired when the time cannot jump because of inter-actors deadlock */ +/** Callback fired when the time cannot advance because of inter-actors deadlock */ extern XBT_PUBLIC xbt::signal on_deadlock; -template XBT_PRIVATE void filter_netzones_by_type_recursive(s4u::NetZone* current, std::vector* whereto) +template XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector* whereto) { - for (auto const& elem : *(current->getChildren())) { - filter_netzones_by_type_recursive(elem, whereto); - if (elem == dynamic_cast(elem)) - whereto->push_back(dynamic_cast(elem)); + static_assert(std::is_base_of::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(elem->get_impl())) + whereto->push_back(dynamic_cast(elem->get_impl())); } } }