X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5cfd78ee13dfd9c06ca703c402d2d8e62cbfec3f..0c586d7f087b772253980cafd92796edcbd58c50:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 025f2e90f5..43be0eba37 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2022. 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. */ @@ -7,13 +7,13 @@ #define SIMGRID_S4U_ENGINE_HPP #include -#include #include -#include +#include #include +#include #include #include #include @@ -25,7 +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,95 +42,130 @@ public: #endif /** Finalize the default engine and all its dependencies */ - static void shutdown(); + void shutdown(); - /** Run the simulation after initialization */ - void run(); + /** 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; } + + void load_platform(const std::string& platf) const; + void seal_platform() const; - void load_platform(const std::string& platf); + void register_function(const std::string& name, const std::function& code); + void register_function(const std::string& name, const std::function)>& code); + void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory); - void register_function(const std::string& name, int (*code)(int, char**)); - void register_function(const std::string& name, void (*code)(std::vector)); - void register_default(int (*code)(int, char**)); + void register_default(const std::function& code); + void register_default(const kernel::actor::ActorCodeFactory& factory); template void register_actor(const std::string& name) { - simix::register_function(name, [](std::vector args) { - return simix::ActorCode([args] { + 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); } - template void register_actor(const std::string& name, F code) { - simix::register_function(name, [code](std::vector args) { - return simix::ActorCode([code, args] { code(std::move(args)); }); - }); + 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); } - void load_deployment(const std::string& deploy); + /** 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; + + void load_deployment(const std::string& deploy) const; protected: #ifndef DOXYGEN friend Host; friend Link; friend Disk; - friend Storage; friend kernel::routing::NetPoint; friend kernel::routing::NetZoneImpl; - friend kernel::resource::LinkImpl; + friend kernel::resource::HostImpl; + friend kernel::resource::StandardLinkImpl; 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: - 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); + /** 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; -#ifndef DOXYGEN - 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); -#endif + Mailbox* mailbox_by_name_or_create(const std::string& name) const; - std::vector get_all_netpoints(); - kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name); + size_t get_actor_count() const; + std::vector get_all_actors() const; + std::vector get_filtered_actors(const std::function& filter) const; - NetZone* get_netzone_root(); + 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); + 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() + template std::vector get_filtered_netzones() const { static_assert(std::is_base_of::value, "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl"); @@ -133,40 +174,62 @@ 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 * - * 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"); + * simgrid::s4u::Engine::set_config("host/model:ptask_L07"); */ - void set_config(const 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); - /** 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(void (*callback)(kernel::activity::CommImpl*, void*, size_t)); - /** 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 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 */ + 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 */ - 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_end; + static xbt::signal on_time_advance; + static xbt::signal on_deadlock; 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) @@ -175,7 +238,7 @@ XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, st "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()); + auto* elem_impl = dynamic_cast(elem->get_impl()); if (elem_impl != nullptr) whereto->push_back(elem_impl); }