X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d43e84e981024537b56f15f7dcc937b0202cad2b..c97656604936a7d3000ee3c98e0926b80f6f2150:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 6bb6e896ca..e2e0c863f4 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -6,10 +6,6 @@ #ifndef SIMGRID_S4U_ENGINE_HPP #define SIMGRID_S4U_ENGINE_HPP -#include -#include -#include - #include #include @@ -18,119 +14,128 @@ #include +#include +#include +#include + namespace simgrid { namespace s4u { /** @brief Simulation engine * - * This class is an interface to the simulation engine. + * This is a singleton containing all the main functions of the simulation. */ class XBT_PUBLIC Engine { + friend simgrid::kernel::EngineImpl; + public: /** Constructor, taking the command line parameters of your main function */ explicit Engine(int* argc, char** argv); - /** Currently, only one instance is allowed to exist. This is why you can't copy or move it */ + /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */ +#ifndef DOXYGEN Engine(const Engine&) = delete; Engine(Engine&&) = delete; - ~Engine(); +#endif + /** Finalize the default engine and all its dependencies */ static void shutdown(); - /** @brief Run the simulation */ + /** Run the simulation after initialization */ void run(); - /** @brief Retrieve the simulation time */ + /** @brief Retrieve the simulation time (in seconds) */ 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(std::string platf); + void load_platform(const std::string& platf); - /** Registers the main function of an actor that will be launched from the deployment file */ - 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)); + XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_function( + const std::string& name, int (*code)(int, char**)); - /** Registers a function as the default main function of actors - * - * It will be used as fallback when the function requested from the deployment file was not registered. - * It is used for trace-based simulations (see examples/s4u/replay-comms and similar). - */ - void register_default(int (*code)(int, char**)); + void register_function(const std::string& name, void (*code)(int, char**)); + void register_function(const std::string& name, void (*code)(std::vector)); - template void register_actor(std::string name) + XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_default( + int (*code)(int, char**)); + void register_default(void (*code)(int, char**)); + void register_default(kernel::actor::ActorCodeFactory factory); + + void register_function(const std::string& name, kernel::actor::ActorCodeFactory factory); + template void register_actor(const std::string& name) { - simgrid::simix::register_function(name, [](std::vector args) { - return simgrid::simix::ActorCode([args] { + register_function(name, [](std::vector args) { + return kernel::actor::ActorCode([args] { F code(std::move(args)); code(); }); }); } - - template void register_actor(std::string name, F code) + template void register_actor(const std::string& name, F code) { - simgrid::simix::register_function(name, [code](std::vector args) { - return simgrid::simix::ActorCode([code, args] { code(std::move(args)); }); + register_function(name, [code](std::vector args) { + return kernel::actor::ActorCode([code, args] { code(std::move(args)); }); }); } - /** @brief Load a deployment file and launch the actors that it contains */ - void load_deployment(std::string deploy); + void load_deployment(const std::string& deploy); protected: #ifndef DOXYGEN friend Host; friend Link; + friend Disk; 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 host_register(const std::string& name, Host* host); + void host_unregister(const std::string& name); + void link_register(const std::string& name, const Link* link); + void link_unregister(const std::string& name); + void storage_register(const std::string& name, const Storage* storage); + void storage_unregister(const std::string& name); void netpoint_register(simgrid::kernel::routing::NetPoint* card); void netpoint_unregister(simgrid::kernel::routing::NetPoint* card); #endif /*DOXYGEN*/ public: + /** Returns the amount of hosts existing in the platform. */ size_t get_host_count(); - /** @brief Returns the list of all hosts found in the platform */ + /** Returns a vector of all hosts found in the platform. + * + * The order is generally different from the creation/declaration order in the XML platform because we use a hash + * table internally. + */ 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); + std::vector get_filtered_hosts(const std::function& filter); + Host* host_by_name(const std::string& name); + Host* host_by_name_or_null(const std::string& name); 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); + std::vector get_filtered_links(const std::function& filter); + Link* link_by_name(const std::string& name); + Link* link_by_name_or_null(const std::string& name); size_t get_actor_count(); std::vector get_all_actors(); - std::vector get_filtered_actors(std::function filter); + std::vector get_filtered_actors(const std::function& filter); +#ifndef DOXYGEN size_t get_storage_count(); std::vector get_all_storages(); - simgrid::s4u::Storage* storage_by_name(std::string name); - simgrid::s4u::Storage* storage_by_name_or_null(std::string name); + Storage* storage_by_name(const std::string& name); + Storage* storage_by_name_or_null(const std::string& name); +#endif - std::vector get_all_netpoints(); - simgrid::kernel::routing::NetPoint* netpoint_by_name_or_null(std::string name); + std::vector get_all_netpoints(); + kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name); - simgrid::s4u::NetZone* get_netzone_root(); - void set_netzone_root(s4u::NetZone* netzone); + NetZone* get_netzone_root(); + void set_netzone_root(const NetZone* netzone); - simgrid::s4u::NetZone* netzone_by_name_or_null(std::string name); + NetZone* netzone_by_name_or_null(const std::string& name); /** @brief Retrieves all netzones of the type indicated by the template argument */ template std::vector get_filtered_netzones() @@ -146,172 +151,53 @@ public: 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 also @ref - * options). + * @beginrst + * Do --help on any simgrid binary to see the list of currently existing configuration variables + * (see also :ref:`options`). + * @endrst * * Example: * e->set_config("host/model:ptask_L07"); */ - void set_config(std::string str); + void set_config(const std::string& str); -private: - simgrid::kernel::EngineImpl* pimpl; - static s4u::Engine* instance_; + /** Callback fired when the platform is created (ie, the xml file parsed), + * right before the actual simulation starts. */ + static xbt::signal on_platform_created; - //////////////// 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); - } - /** @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(std::string name) - { - register_actor(name); - } - /** @deprecated See Engine::register_actor() */ - template - XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name, F code) - { - register_actor(name, code); - } + /** Callback fired when the platform is about to be created + * (ie, after any configuration change and just before the resource creation) */ + static xbt::signal on_platform_creation; - /** @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(); } - /** @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(); } - /** @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); - /** @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 - XBT_ATTRIB_DEPRECATED_v323("Please use Engine::filter_netzones_by_type()") void getNetzoneByType( - std::vector* whereto) - { - get_filtered_netzones_recursive(get_netzone_root(), whereto); - } + /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */ + static xbt::signal on_simulation_end; - /** @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 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 time jumps into the future */ + static xbt::signal on_time_advance; -/** Callback fired when the main simulation loop ends, just before the end of Engine::run() */ -extern XBT_PUBLIC xbt::signal on_simulation_end; + /** Callback fired when the time cannot advance because of inter-actors deadlock */ + static xbt::signal on_deadlock; -/** Callback fired when the time jumps into the future */ -extern XBT_PUBLIC xbt::signal on_time_advance; - -/** Callback fired when the time cannot advance because of inter-actors deadlock */ -extern XBT_PUBLIC xbt::signal on_deadlock; +private: + kernel::EngineImpl* const pimpl; + static Engine* instance_; +}; -template XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector* whereto) +#ifndef DOXYGEN /* Internal use only, no need to expose it */ +template +XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector* whereto) { 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())); + T* elem_impl = dynamic_cast(elem->get_impl()); + if (elem_impl != nullptr) + whereto->push_back(elem_impl); } } -} -} // namespace simgrid::s4u +#endif +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_ENGINE_HPP */