X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1ff58d7a8f46e07cdc902f96b99bb47d0a077932..af75444cb236cd53e4406b393bd5add0e7aca5dc:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index c4e7d2b0e9..0c3774068d 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-2023. 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,158 +6,279 @@ #ifndef SIMGRID_S4U_ENGINE_HPP #define SIMGRID_S4U_ENGINE_HPP -#include -#include -#include - #include -#include #include -#include +#include #include +#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. */ -XBT_PUBLIC_CLASS Engine -{ +class XBT_PUBLIC Engine { +#ifndef DOXYGEN + friend simgrid::kernel::EngineImpl; +#endif + public: + /** Constructor, taking only the name of your main function */ + explicit Engine(std::string name); /** 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 */ +#ifndef DOXYGEN + Engine(const Engine&) = delete; + Engine(Engine&&) = delete; ~Engine(); +#endif + /** Finalize the default engine and all its dependencies */ - static void shutdown(); + XBT_ATTRIB_DEPRECATED_v335("Users are not supposed to shutdown the Engine") void shutdown(); - /** @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); + /** Run the simulation until its end */ + void run() const; - /** Registers the main function of an actor that will be launched from the deployment file */ - void registerFunction(const char* name, int (*code)(int, char**)); + /** Run the simulation until the specified date */ + void run_until(double max_date) const; - /** Registers a function as the default main function of actors + /** @brief Retrieve the simulation time (in seconds) */ + static double get_clock(); + /** @brief Retrieve the engine singleton */ + static s4u::Engine* get_instance(); + static s4u::Engine* get_instance(int* argc, char** argv); + static bool has_instance() { return instance_ != nullptr; } + const std::vector& get_cmdline() const; + + /** + * Creates a new platform, including hosts, links, and the routing table. + * + * @beginrst + * See also: :ref:`platform`. + * @endrst + */ + void load_platform(const std::string& platf) const; + /** + * @brief Seals the platform, finishing the creation of its resources. * - * 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). + * This method is optional. The seal() is done automatically when you call Engine::run. */ - void registerDefault(int (*code)(int, char**)); + void seal_platform() const; + /** @brief Get a debug output of the platform. + * + * It looks like a XML platform file, but it may be very different from the input platform file: All netzones are + * flatified into a unique zone. This representation is mostly useful to debug your platform configuration and ensure + * that your assumptions over your configuration hold. This enables you to verify the exact list of links traversed + * between any two hosts, and the characteristics of every host and link. But you should not use the resulting file as + * an input platform file: it is very verbose, and thus much less efficient (in parsing time and runtime performance) + * than a regular platform file with the sufficient amount of intermediary netzones. Even if you use one zone only, + * specialized zones (such as clusters) are more efficient than the one with fully explicit routing used here. + */ + std::string flatify_platform() const; - /** @brief Load a deployment file and launch the actors that it contains */ - void loadDeployment(const char* deploy); + /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking classical argc/argv parameters. See the :ref:`example `. @endverbatim */ + void register_function(const std::string& name, const std::function& code); + /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking a vector of strings as a parameter. See the :ref:`example `. @endverbatim */ + void register_function(const std::string& name, const std::function)>& code); + void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory); -protected: - friend s4u::Host; - friend s4u::Storage; - void addHost(std::string name, simgrid::s4u::Host * host); - void delHost(std::string name); + /** @verbatim embed:rst:inline Provide a default function to be used when the name used in a :ref:`pf_tag_actor` tag was not binded with ``register_function`` nor ``register_actor``. @endverbatim */ + void register_default(const std::function& code); + void register_default(const kernel::actor::ActorCodeFactory& factory); -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); + /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a class name passed as a template parameter. See the :ref:`example `. @endverbatim */ + template void register_actor(const std::string& name) + { + kernel::actor::ActorCodeFactory code_factory = [](std::vector args) { + return kernel::actor::ActorCode([args = std::move(args)]() mutable { + F code(std::move(args)); + code(); + }); + }; + register_function(name, code_factory); + } + /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function name passed as a parameter. See the :ref:`example `. @endverbatim */ + template void register_actor(const std::string& name, F code) + { + kernel::actor::ActorCodeFactory code_factory = [code](std::vector args) { + return kernel::actor::ActorCode([code, args = std::move(args)]() mutable { code(std::move(args)); }); + }; + register_function(name, code_factory); + } - size_t getHostCount(); - void getHostList(std::vector * whereTo); - std::vector getAllHosts(); + /** If non-null, the provided set will be filled with all activities that fail to start because of a veto */ + void track_vetoed_activities(std::set* vetoed_activities) const; - size_t getLinkCount(); - void getLinkList(std::vector * list); - std::vector getAllLinks(); + /** @verbatim embed:rst:inline Load a deployment file. See:ref:`deploy` and the :ref:`example `. @endverbatim */ + void load_deployment(const std::string& deploy) const; - std::vector getAllStorages(); +protected: +#ifndef DOXYGEN + friend Host; + friend Link; + friend Disk; + friend kernel::routing::NetPoint; + friend kernel::routing::NetZoneImpl; + friend kernel::resource::HostImpl; + friend kernel::resource::StandardLinkImpl; + void netpoint_register(simgrid::kernel::routing::NetPoint* card); + void netpoint_unregister(simgrid::kernel::routing::NetPoint* card); + void set_netzone_root(const NetZone* netzone); +#endif /*DOXYGEN*/ - /** @brief Run the simulation */ - void run(); +public: + /** Returns the amount of hosts existing in the platform. */ + size_t get_host_count() const; + /** 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() const; + std::vector get_filtered_hosts(const std::function& filter) const; + Host* host_by_name(const std::string& name) const; + Host* host_by_name_or_null(const std::string& name) const; + + size_t get_link_count() const; + std::vector get_all_links() const; + std::vector get_filtered_links(const std::function& filter) const; + Link* link_by_name(const std::string& name) const; + /** + * @brief Find a split-duplex link from its name. + * @throw std::invalid_argument if the searched link does not exist. + */ + SplitDuplexLink* split_duplex_link_by_name(const std::string& name) const; + Link* link_by_name_or_null(const std::string& name) const; - /** @brief Retrieve the simulation time */ - static double getClock(); + Mailbox* mailbox_by_name_or_create(const std::string& name) const; - /** @brief Retrieve the engine singleton */ - static s4u::Engine* getInstance(); + size_t get_actor_count() const; + std::vector get_all_actors() const; + std::vector get_filtered_actors(const std::function& filter) const; - /** @brief Retrieve the root netzone, containing all others */ - simgrid::s4u::NetZone* getNetRoot(); + std::vector get_all_netpoints() const; + kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name) const; + /** + * @brief Get netpoint by its name + * + * @param name Netpoint name + * @throw std::invalid_argument if netpoint doesn't exist + */ + kernel::routing::NetPoint* netpoint_by_name(const std::string& name) const; - /** @brief Retrieve the netzone of the given name (or nullptr if not found) */ - simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name); + NetZone* get_netzone_root() const; - /** @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); + NetZone* netzone_by_name_or_null(const std::string& name) const; - template void registerFunction(const char* name) - { - simgrid::simix::registerFunction(name, [](std::vector args) { - return simgrid::simix::ActorCode([args] { - F code(std::move(args)); - code(); - }); - }); - } + /** + * @brief Add a model to engine list + * + * @param model Pointer to model + * @param dependencies List of dependencies for this model (optional) + */ + void add_model(std::shared_ptr model, + const std::vector& dependencies = {}); - template void registerFunction(const char* name, F code) + /** @brief Get list of all models managed by this engine */ + const std::vector& get_all_models() const; + + /** @brief Retrieves all netzones of the type indicated by the template argument */ + template std::vector get_filtered_netzones() const { - simgrid::simix::registerFunction(name, [code](std::vector args) { - return simgrid::simix::ActorCode([code, args] { code(std::move(args)); }); - }); + 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 isInitialized(); + kernel::EngineImpl* get_impl() const { return pimpl; } + /** 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). + * @beginrst + * Do --help on any simgrid binary to see the list of currently existing configuration variables + * (see also :ref:`options`). + * @endrst * * Example: - * e->setConfig("host/model","ptask_L07"); + * simgrid::s4u::Engine::set_config("host/model:ptask_L07"); */ - void setConfig(std::string str); + static void set_config(const std::string& str); + static void set_config(const std::string& name, int value); + static void set_config(const std::string& name, bool value); + static void set_config(const std::string& name, double value); + static void set_config(const std::string& name, const std::string& value); + + Engine* + set_default_comm_data_copy_callback(const std::function& callback); + + /** Add a callback fired when the platform is created (ie, the xml file parsed), + * right before the actual simulation starts. */ + static void on_platform_created_cb(const std::function& cb) { on_platform_created.connect(cb); } + /** Add a callback fired when the platform is about to be created + * (ie, after any configuration change and just before the resource creation) */ + static void on_platform_creation_cb(const std::function& cb) { on_platform_creation.connect(cb); } + /** Add a callback fired when the main simulation loop starts, at the beginning of the first call to Engine::run() */ + static void on_simulation_start_cb(const std::function& cb) { on_simulation_start.connect(cb); } + /** Add a callback fired when the main simulation loop ends, just before the end of Engine::run() */ + static void on_simulation_end_cb(const std::function& cb) { on_simulation_end.connect(cb); } + + /** Add a callback fired when the time jumps into the future. + * + * It is fired right after the time change (use get_clock() to get the new timestamp). + * The callback parameter is the time delta since previous timestamp. */ + static void on_time_advance_cb(const std::function& cb) { on_time_advance.connect(cb); } + + /** Add a callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each + * actor is also executed on deadlock. */ + static void on_deadlock_cb(const std::function& cb) { on_deadlock.connect(cb); } - simgrid::kernel::EngineImpl* pimpl; +#ifndef DOXYGEN + /* FIXME signals should be private */ + static xbt::signal on_platform_created; + static xbt::signal on_platform_creation; +#endif private: - static s4u::Engine* instance_; + static xbt::signal on_simulation_start; + static xbt::signal on_time_advance; + static xbt::signal on_deadlock; + static xbt::signal on_simulation_end; + + kernel::EngineImpl* const pimpl; + static Engine* instance_; + void initialize(int* argc, char** argv); }; -/** Callback fired when the platform is created (ie, the xml file parsed), - * right before the actual simulation starts. */ -extern XBT_PUBLIC(xbt::signal) onPlatformCreated; - -/** Callback fired when the main simulation loop ends, just before MSG_run (or similar) ends */ -extern XBT_PUBLIC(xbt::signal) onSimulationEnd; +std::vector create_DAG_from_dot(const std::string& filename); +std::vector create_DAG_from_DAX(const std::string& filename); -/** Callback fired when the time jumps into the future */ -extern XBT_PUBLIC(xbt::signal) onTimeAdvance; - -/** Callback fired when the time cannot jump because of inter-actors deadlock */ -extern XBT_PUBLIC(xbt::signal) onDeadlock; - -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(const 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); + auto* 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 */