X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/bf2eac918e4a2b27667268c0f4355f0797fd5af4..19e1048a7009c4144b0f361ad85fb9dff44761ea:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 6cc8c60a2f..074a242bc5 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2021. 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,11 +7,10 @@ #define SIMGRID_S4U_ENGINE_HPP #include -#include #include -#include +#include #include #include @@ -25,7 +24,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 */ @@ -39,44 +44,55 @@ public: static void shutdown(); /** Run the simulation after initialization */ - void run(); + void run() const; /** @brief Retrieve the simulation time (in seconds) */ static double get_clock(); /** @brief Retrieve the engine singleton */ static s4u::Engine* get_instance(); - void load_platform(const std::string& platf); + void load_platform(const std::string& platf) const; - 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**)); +#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 + + 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_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); + void load_deployment(const std::string& deploy) const; protected: #ifndef DOXYGEN + friend surf::HostImpl; friend Host; friend Link; friend Disk; - friend Storage; friend kernel::routing::NetPoint; friend kernel::routing::NetZoneImpl; friend kernel::resource::LinkImpl; @@ -84,52 +100,69 @@ protected: 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(); + 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(); - 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); + 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; - size_t get_actor_count(); - std::vector get_all_actors(); - std::vector get_filtered_actors(const std::function& filter); + Mailbox* mailbox_by_name_or_create(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 + size_t get_actor_count() const; + std::vector get_all_actors() const; + std::vector get_filtered_actors(const std::function& filter) const; - std::vector get_all_netpoints(); - kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name); + 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(); + 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"); @@ -148,9 +181,13 @@ public: * @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. */ @@ -166,12 +203,14 @@ public: /** Callback fired when the time jumps into the future */ static xbt::signal on_time_advance; - /** Callback fired when the time cannot advance because of inter-actors deadlock */ + /** 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; private: kernel::EngineImpl* const pimpl; static Engine* instance_; + void initialize(int* argc, char** argv); }; #ifndef DOXYGEN /* Internal use only, no need to expose it */ @@ -182,7 +221,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); }