X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fe82649110018df8a61effc7a91453506b45a9f5..0c586d7f087b772253980cafd92796edcbd58c50:/include/simgrid/s4u/Engine.hpp diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 9397c3feab..43be0eba37 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-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. */ @@ -13,6 +13,7 @@ #include #include +#include #include #include #include @@ -24,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 */ @@ -37,24 +42,23 @@ public: #endif /** Finalize the default engine and all its dependencies */ - static void shutdown(); + 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; } void load_platform(const std::string& platf) 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 + void seal_platform() const; void register_function(const std::string& name, const std::function& code); void register_function(const std::string& name, const std::function)>& code); @@ -81,6 +85,9 @@ 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; + void load_deployment(const std::string& deploy) const; protected: @@ -90,7 +97,8 @@ protected: friend Disk; 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); @@ -116,14 +124,28 @@ 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; 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); @@ -133,16 +155,14 @@ public: /** * @brief Add a model to engine list * - * @param type Model type (network, disk, etc) - * @param model Pointer to model + * @param model Pointer to model + * @param dependencies List of dependencies for this model (optional) */ - void add_model(simgrid::kernel::resource::Model::Type type, std::shared_ptr model); - - /** @brief Get list of models created for a resource type */ - const std::vector& get_model_list(simgrid::kernel::resource::Model::Type type); + 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 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 @@ -154,6 +174,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 @@ -172,29 +194,42 @@ 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(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. 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_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)