X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5089a0a98b27f5eeee62321dff4f025f1648f025..efa3d5379cb7bfc5d64c839af8b6d036d86460c1:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 1741d9a19c..58e0e8f3a7 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-2020. 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. */ @@ -22,49 +22,62 @@ 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. */ class XBT_PUBLIC Engine { + friend simgrid::kernel::EngineImpl; + public: /** 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 */ + /* 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(); - /** @brief Run the simulation after initialization */ - void run(); + /** Run the simulation after initialization */ + 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; + + 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**)); - 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_function(const std::string& name, const std::function& code); + void register_function(const std::string& name, const std::function)>& code); + XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_default( + int (*code)(int, char**)); + void register_default(const std::function& code); + void register_default(const kernel::actor::ActorCodeFactory& factory); + + void register_function(const std::string& name, 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] { F code(std::move(args)); code(); }); - }); + }; + register_function(name, std::move(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] { code(std::move(args)); }); + }; + register_function(name, std::move(code_factory)); } void load_deployment(const std::string& deploy); @@ -80,47 +93,54 @@ protected: 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_register(const std::string& name, const Link* link); void link_unregister(const std::string& name); - void storage_register(const std::string& name, Storage* storage); + 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); + /** 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(); - 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_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; + 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); + size_t get_actor_count() const; + std::vector get_all_actors() const; + std::vector get_filtered_actors(const std::function& filter) const; - 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); +#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(); - 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; - NetZone* get_netzone_root(); - void set_netzone_root(NetZone* netzone); + 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 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,13 +153,19 @@ public: 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"); */ void set_config(const std::string& str); + void set_config(const std::string& name, int value); + void set_config(const std::string& name, bool value); + void set_config(const std::string& name, double value); + 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. */ @@ -155,7 +181,8 @@ 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: @@ -164,7 +191,8 @@ private: }; #ifndef DOXYGEN /* Internal use only, no need to expose it */ -template XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector* whereto) +template +XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector* whereto) { static_assert(std::is_base_of::value, "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");