X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9b4039c4e39984806de45eaa25ecb9dd1568a8bf..af75444cb236cd53e4406b393bd5add0e7aca5dc:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 8e7a74b5b2..0c3774068d 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2021. 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. */ @@ -10,8 +10,10 @@ #include +#include #include +#include #include #include #include @@ -23,9 +25,13 @@ namespace s4u { * This is a singleton containing all the main functions of the simulation. */ 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 */ explicit Engine(int* argc, char** argv); /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */ @@ -36,32 +42,59 @@ public: #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(); - /** Run the simulation after initialization */ + /** Run the simulation until its end */ void run() const; + /** Run the simulation until the specified date */ + void run_until(double max_date) const; + /** @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. + * + * This method is optional. The seal() is done automatically when you call Engine::run. + */ + 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; -#ifndef DOXYGEN - 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**)); - XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_default( - int (*code)(int, char**)); -#endif - + /** @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); + /** @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); + /** @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) { @@ -72,6 +105,7 @@ public: }; 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) { @@ -80,6 +114,10 @@ public: register_function(name, code_factory); } + /** 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; + + /** @verbatim embed:rst:inline Load a deployment file. See:ref:`deploy` and the :ref:`example `. @endverbatim */ void load_deployment(const std::string& deploy) const; protected: @@ -87,18 +125,13 @@ protected: friend Host; friend Link; friend Disk; - 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, 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); + 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*/ public: @@ -118,27 +151,45 @@ public: 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; + Mailbox* mailbox_by_name_or_create(const std::string& name) const; + size_t get_actor_count() const; std::vector get_all_actors() const; std::vector get_filtered_actors(const std::function& filter) const; -#ifndef DOXYGEN - size_t get_storage_count() const; - std::vector get_all_storages() const; - Storage* storage_by_name(const std::string& name) const; - Storage* storage_by_name_or_null(const std::string& name) const; -#endif - 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; NetZone* get_netzone_root() const; - void set_netzone_root(const NetZone* netzone); NetZone* netzone_by_name_or_null(const std::string& name) const; + /** + * @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 = {}); + + /** @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 { @@ -149,6 +200,8 @@ public: return res; } + 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 @@ -167,29 +220,50 @@ public: static void set_config(const std::string& name, double value); static void set_config(const std::string& name, const std::string& value); - /** Callback fired when the platform is created (ie, the xml file parsed), - * right before the actual simulation starts. */ - static xbt::signal on_platform_created; + Engine* + set_default_comm_data_copy_callback(const std::function& callback); - /** Callback fired when the platform is about to be created + /** 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 xbt::signal on_platform_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); } - /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */ - static xbt::signal on_simulation_end; + /** 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); } - /** Callback fired when the time jumps into the future */ - static xbt::signal on_time_advance; + /** 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); } - /** 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 xbt::signal on_deadlock; +#ifndef DOXYGEN + /* FIXME signals should be private */ + static xbt::signal on_platform_created; + static xbt::signal on_platform_creation; +#endif private: + 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); }; +std::vector create_DAG_from_dot(const std::string& filename); +std::vector create_DAG_from_DAX(const std::string& filename); + #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)