X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4ba85316ab090c9e1fb26e988dc80dd5c4535bd8..a769d0bfd8cf7d4e8f9ae4dfbcf69d8a851508da:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index c4e7d2b0e9..0d4aee070e 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-2019. 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. */ @@ -24,140 +24,301 @@ namespace s4u { * * This class is an interface to the simulation engine. */ -XBT_PUBLIC_CLASS Engine -{ +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 (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 loadPlatform(const char* platf); + void load_platform(const std::string& platf); /** Registers the main function of an actor that will be launched from the deployment file */ - void registerFunction(const char* name, int (*code)(int, char**)); + void register_function(const 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(const std::string& name, void (*code)(std::vector)); /** 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/msg/actions). + * It is used for trace-based simulations (see examples/s4u/replay-comms and similar). */ - void registerDefault(int (*code)(int, char**)); - - /** @brief Load a deployment file and launch the actors that it contains */ - void loadDeployment(const char* deploy); - -protected: - friend s4u::Host; - friend s4u::Storage; - void addHost(std::string name, simgrid::s4u::Host * host); - void delHost(std::string name); + void register_default(int (*code)(int, char**)); -public: - void addStorage(std::string name, simgrid::s4u::Storage * storage); - void delStorage(std::string name); - simgrid::s4u::Host* hostByName(std::string name); - simgrid::s4u::Host* hostByNameOrNull(std::string name); - simgrid::s4u::Storage* storageByName(std::string name); - simgrid::s4u::Storage* storageByNameOrNull(std::string name); - - size_t getHostCount(); - void getHostList(std::vector * whereTo); - std::vector getAllHosts(); - - size_t getLinkCount(); - void getLinkList(std::vector * list); - std::vector getAllLinks(); - - std::vector getAllStorages(); - - /** @brief Run the simulation */ - void run(); - - /** @brief Retrieve the simulation time */ - static double getClock(); - - /** @brief Retrieve the engine singleton */ - static s4u::Engine* getInstance(); - - /** @brief Retrieve the root netzone, containing all others */ - simgrid::s4u::NetZone* getNetRoot(); - - /** @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); - void netpointRegister(simgrid::kernel::routing::NetPoint * card); - void netpointUnregister(simgrid::kernel::routing::NetPoint * card); - - template void registerFunction(const char* name) + template void register_actor(const std::string& name) { - simgrid::simix::registerFunction(name, [](std::vector args) { - return simgrid::simix::ActorCode([args] { + simix::register_function(name, [](std::vector args) { + return simix::ActorCode([args] { F code(std::move(args)); code(); }); }); } - template void registerFunction(const char* name, F code) + template void register_actor(const std::string& name, F code) { - simgrid::simix::registerFunction(name, [code](std::vector args) { - return simgrid::simix::ActorCode([code, args] { code(std::move(args)); }); + simix::register_function(name, [code](std::vector args) { + return simix::ActorCode([code, args] { code(std::move(args)); }); }); } - /** Returns whether SimGrid was initialized yet -- mostly for internal use */ - static bool isInitialized(); + /** @brief Load a deployment file and launch the actors that it contains */ + void load_deployment(const std::string& deploy); + +protected: +#ifndef DOXYGEN + friend Host; + friend Link; + friend Storage; + friend kernel::routing::NetPoint; + friend kernel::routing::NetZoneImpl; + friend kernel::resource::LinkImpl; + void host_register(const std::string& name, Host* host); + void host_unregister(const std::string& name); + void link_register(const std::string& name, Link* link); + void link_unregister(const std::string& name); + void storage_register(const std::string& name, 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: + size_t get_host_count(); + /** @brief Returns the list of all hosts found in the platform */ + std::vector get_all_hosts(); + 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(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(const std::function& filter); + + size_t get_storage_count(); + std::vector get_all_storages(); + Storage* storage_by_name(const std::string& name); + Storage* storage_by_name_or_null(const std::string& name); + + std::vector get_all_netpoints(); + kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name); + + NetZone* get_netzone_root(); + void set_netzone_root(NetZone* netzone); + + 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() + { + static_assert(std::is_base_of::value, + "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl"); + std::vector res; + get_filtered_netzones_recursive(get_netzone_root(), &res); + return res; + } + /** Returns whether SimGrid was initialized yet -- mostly for internal use */ + 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); - - simgrid::kernel::EngineImpl* pimpl; + void set_config(const std::string& str); private: - static s4u::Engine* instance_; + kernel::EngineImpl* const pimpl; + static Engine* instance_; + + //////////////// Deprecated functions +#ifndef DOXYGEN +public: + /** @deprecated See Engine::load_platform() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const std::string& platf) + { + load_platform(platf); + } + /** @deprecated See Engine::register_function() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const 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 std::string& name) + { + register_actor(name); + } + /** @deprecated See Engine::register_actor() */ + template + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const std::string& name, + F code) + { + register_actor(name, code); + } + + /** @deprecated See Engine::load_deployment() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const 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( + const 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( + const 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( + const 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( + const 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_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_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(const 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 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); + } + + /** @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(const std::string& str) + { + set_config(str); + } +#endif }; /** 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 main simulation loop ends, just before MSG_run (or similar) ends */ -extern XBT_PUBLIC(xbt::signal) onSimulationEnd; +/** 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 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; +/** Callback fired when the time cannot advance because of inter-actors deadlock */ +extern XBT_PUBLIC xbt::signal on_deadlock; -template XBT_PRIVATE void netzoneByTypeRecursive(s4u::NetZone* current, std::vector* whereto) +#ifndef DOXYGEN /* Internal use only, no need to expose it */ +template XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector* whereto) { - for (auto const& elem : *(current->getChildren())) { - netzoneByTypeRecursive(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); + 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 */