X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5a598c2749e488ca8cbb316241c644fd0671f9eb..5ec2b80b686983f84ebab7c7398a29e73286deee:/src/s4u/s4u_Engine.cpp diff --git a/src/s4u/s4u_Engine.cpp b/src/s4u/s4u_Engine.cpp index 6f5e4d65c8..e808263551 100644 --- a/src/s4u/s4u_Engine.cpp +++ b/src/s4u/s4u_Engine.cpp @@ -1,309 +1,377 @@ /* s4u::Engine Simulation Engine and global functions. */ -/* Copyright (c) 2006-2018. 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. */ +#include +#include +#include + #include "mc/mc.h" -#include "simgrid/kernel/routing/NetPoint.hpp" -#include "simgrid/kernel/routing/NetZoneImpl.hpp" -#include "simgrid/s4u/Engine.hpp" -#include "simgrid/s4u/Host.hpp" -#include "simgrid/s4u/Mailbox.hpp" -#include "simgrid/s4u/NetZone.hpp" -#include "simgrid/s4u/Storage.hpp" -#include "simgrid/simix.h" -#include "src/simix/smx_private.hpp" // For access to simix_global->process_list #include "src/instr/instr_private.hpp" #include "src/kernel/EngineImpl.hpp" -#include "src/surf/network_interface.hpp" -#include "surf/surf.hpp" // routing_platf. FIXME:KILLME. SOON - +#include "src/kernel/resource/NetworkModel.hpp" +#include "src/kernel/resource/SplitDuplexLinkImpl.hpp" +#include "src/kernel/resource/StandardLinkImpl.hpp" +#include "src/mc/mc_replay.hpp" +#include "src/surf/HostImpl.hpp" +#include "xbt/config.hpp" + +#include #include XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface"); +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_engine, s4u, "Logging specific to S4U (engine)"); -namespace simgrid { -namespace s4u { -xbt::signal on_platform_creation; -xbt::signal on_platform_created; -xbt::signal on_simulation_end; -xbt::signal on_time_advance; -xbt::signal on_deadlock; - -Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */ +static simgrid::kernel::actor::ActorCode maestro_code; -Engine::Engine(int* argc, char** argv) -{ - xbt_assert(s4u::Engine::instance_ == nullptr, - "It is currently forbidden to create more than one instance of s4u::Engine"); - TRACE_global_init(); - SIMIX_global_init(argc, argv); +namespace simgrid::s4u { +xbt::signal Engine::on_platform_creation; +xbt::signal Engine::on_platform_created; +xbt::signal Engine::on_simulation_start; +xbt::signal Engine::on_simulation_end; +xbt::signal Engine::on_time_advance; +xbt::signal Engine::on_deadlock; - pimpl = new kernel::EngineImpl(); - s4u::Engine::instance_ = this; -} +Engine* Engine::instance_ = nullptr; /* This singleton is awful, but I don't see no other solution right now. */ -Engine::~Engine() +void Engine::initialize(int* argc, char** argv) { - delete pimpl; - s4u::Engine::instance_ = nullptr; + xbt_assert(Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine"); + Engine::instance_ = this; + instr::init(); + pimpl->initialize(argc, argv); + // Either create a new context with maestro or create + // a context object with the current context maestro): + kernel::actor::create_maestro(maestro_code); } -/** @brief Retrieve the engine singleton */ -Engine* Engine::get_instance() +Engine::Engine(std::string name) : pimpl(new kernel::EngineImpl()) { - if (s4u::Engine::instance_ == nullptr) - return new Engine(0, nullptr); - else - return s4u::Engine::instance_; + int argc = 1; + char* argv = &name[0]; + initialize(&argc, &argv); } -void Engine::shutdown() +Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl()) { - delete s4u::Engine::instance_; - s4u::Engine::instance_ = nullptr; + initialize(argc, argv); } -double Engine::get_clock() +Engine::~Engine() { - return SIMIX_get_clock(); + kernel::EngineImpl::shutdown(); + Engine::instance_ = nullptr; } -void Engine::load_platform(std::string platf) +/** @brief Retrieve the engine singleton */ +Engine* Engine::get_instance() { - SIMIX_create_environment(platf); + int argc = 0; + char* argv = nullptr; + return get_instance(&argc, &argv); } - -void Engine::register_function(std::string name, int (*code)(int, char**)) +Engine* Engine::get_instance(int* argc, char** argv) { - SIMIX_function_register(name, code); + if (Engine::instance_ == nullptr) { + auto e = new Engine(argc, argv); + xbt_assert(Engine::instance_ == e); + } + return Engine::instance_; } -void Engine::register_default(int (*code)(int, char**)) + +void Engine::shutdown() // XBT_ATTRIB_DEPRECATED_v335 { - SIMIX_function_register_default(code); + delete Engine::instance_; } -void Engine::load_deployment(std::string deploy) + +double Engine::get_clock() { - SIMIX_launch_application(deploy); + if (MC_is_active() || MC_record_replay_is_active()) { + return MC_process_clock_get(kernel::actor::ActorImpl::self()); + } else { + return kernel::EngineImpl::get_clock(); + } } -/** @brief Returns the amount of hosts in the platform */ -size_t Engine::get_host_count() + +void Engine::add_model(std::shared_ptr model, + const std::vector& dependencies) { - return pimpl->hosts_.size(); + kernel::actor::simcall_answered([this, &model, &dependencies] { pimpl->add_model(std::move(model), dependencies); }); } -/** @brief Fills the passed list with all hosts found in the platform - * @deprecated Please prefer Engine::getAllHosts() - */ -void Engine::getHostList(std::vector* list) + +const std::vector& Engine::get_all_models() const { - for (auto const& kv : pimpl->hosts_) - list->push_back(kv.second); + return pimpl->get_all_models(); } -/** @brief Returns the list of all hosts found in the platform */ -std::vector Engine::get_all_hosts() +/** + * Creates a new platform, including hosts, links, and the routing table. + * + * @beginrst + * See also: :ref:`platform`. + * @endrst + */ +void Engine::load_platform(const std::string& platf) const { - std::vector res; - for (auto const& kv : pimpl->hosts_) - res.push_back(kv.second); - return res; + pimpl->load_platform(platf); } -std::vector Engine::get_filtered_hosts(std::function filter) +/** + * @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 Engine::seal_platform() const { - std::vector hosts; - for (auto const& kv : pimpl->hosts_) { - if (filter(kv.second)) - hosts.push_back(kv.second); - } - - return hosts; + pimpl->seal_platform(); } -void Engine::host_register(std::string name, simgrid::s4u::Host* host) +/** Registers the main function of an actor that will be launched from the deployment file */ +void Engine::register_function(const std::string& name, const std::function& code) { - pimpl->hosts_[name] = host; + kernel::actor::ActorCodeFactory code_factory = [code](std::vector args) { + return xbt::wrap_main(code, std::move(args)); + }; + register_function(name, code_factory); } -void Engine::host_unregister(std::string name) +/** Registers the main function of an actor that will be launched from the deployment file */ +void Engine::register_function(const std::string& name, const std::function)>& code) { - pimpl->hosts_.erase(name); + kernel::actor::ActorCodeFactory code_factory = [code{code}](std::vector args) mutable { + return std::bind(std::move(code), std::move(args)); + }; + register_function(name, code_factory); } - -/** @brief Find an host from its name. +/** Registers a function as the default main function of actors * - * @throw std::invalid_argument if the searched host does not exist. + * It will be used as fallback when the function requested from the deployment file was not registered. + * It is used for trace-based simulations (see examples/cpp/replay-comms and similar). */ -simgrid::s4u::Host* Engine::host_by_name(std::string name) +void Engine::register_default(const std::function& code) { - if (pimpl->hosts_.find(name) == pimpl->hosts_.end()) - throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'")); - return pimpl->hosts_.at(name); + register_default([code](std::vector args) { return xbt::wrap_main(code, std::move(args)); }); +} +void Engine::register_default(const kernel::actor::ActorCodeFactory& code) +{ + simgrid::kernel::actor::simcall_answered([this, &code]() { pimpl->register_default(code); }); } -/** @brief Find an host from its name (or nullptr if that host does not exist) */ -simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name) +void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code) { - auto host = pimpl->hosts_.find(name); - return host == pimpl->hosts_.end() ? nullptr : host->second; + simgrid::kernel::actor::simcall_answered([this, name, &code]() { pimpl->register_function(name, code); }); } -/** @brief Find a link from its name. +/** Load a deployment file and launch the actors that it contains * - * @throw std::invalid_argument if the searched link does not exist. + * @beginrst + * See also: :ref:`deploy`. + * @endrst */ -simgrid::s4u::Link* Engine::link_by_name(std::string name) +void Engine::load_deployment(const std::string& deploy) const { - if (pimpl->links_.find(name) == pimpl->links_.end()) - throw std::invalid_argument(std::string("Link not found: ") + name); - - return pimpl->links_.at(name); + pimpl->load_deployment(deploy); } -/** @brief Find an link from its name (or nullptr if that link does not exist) */ -simgrid::s4u::Link* Engine::link_by_name_or_null(std::string name) +/** Returns the amount of hosts in the platform */ +size_t Engine::get_host_count() const { - auto link = pimpl->links_.find(name); - return link == pimpl->links_.end() ? nullptr : link->second; + return get_all_hosts().size(); } -void Engine::link_register(std::string name, simgrid::s4u::Link* link) +std::vector Engine::get_all_hosts() const { - pimpl->links_[name] = link; + return get_filtered_hosts([](const Host*) { return true; }); } -void Engine::link_unregister(std::string name) +std::vector Engine::get_filtered_hosts(const std::function& filter) const { - pimpl->links_.erase(name); + std::vector hosts; + if (pimpl->netzone_root_) { + hosts = pimpl->netzone_root_->get_filtered_hosts(filter); + } + /* Sort hosts in lexicographical order: keep same behavior when the hosts were saved on Engine + * Some tests do a get_all_hosts() and selects hosts in this order */ + std::sort(hosts.begin(), hosts.end(), [](const auto* h1, const auto* h2) { return h1->get_name() < h2->get_name(); }); + + return hosts; } -/** @brief Returns the amount of storages in the platform */ -size_t Engine::get_storage_count() +/** @brief Find a host from its name. + * + * @throw std::invalid_argument if the searched host does not exist. + */ +Host* Engine::host_by_name(const std::string& name) const { - return pimpl->storages_.size(); + auto* host = host_by_name_or_null(name); + if (not host) + throw std::invalid_argument("Host not found: '" + name + "'"); + return host; } -/** @brief Returns the list of all storages found in the platform */ -std::vector Engine::get_all_storages() +/** @brief Find a host from its name (or nullptr if that host does not exist) */ +Host* Engine::host_by_name_or_null(const std::string& name) const { - std::vector res; - for (auto const& kv : pimpl->storages_) - res.push_back(kv.second); - return res; + Host* host = nullptr; + if (pimpl->netzone_root_) { + auto* host_impl = pimpl->netzone_root_->get_host_by_name_or_null(name); + if (host_impl) + host = host_impl->get_iface(); + } + return host; } -/** @brief Find a storage from its name. +/** @brief Find a link from its name. * - * @throw std::invalid_argument if the searched storage does not exist. + * @throw std::invalid_argument if the searched link does not exist. */ -simgrid::s4u::Storage* Engine::storage_by_name(std::string name) +Link* Engine::link_by_name(const std::string& name) const { - if (pimpl->storages_.find(name) == pimpl->storages_.end()) - throw std::invalid_argument(std::string("Storage not found: ") + name); - - return pimpl->storages_.at(name); + auto* link = link_by_name_or_null(name); + if (not link) + throw std::invalid_argument("Link not found: " + name); + return link; } -/** @brief Find a storage from its name (or nullptr if that storage does not exist) */ -simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name) +SplitDuplexLink* Engine::split_duplex_link_by_name(const std::string& name) const { - auto storage = pimpl->storages_.find(name); - return storage == pimpl->storages_.end() ? nullptr : storage->second; + auto* link_impl = pimpl->netzone_root_ ? pimpl->netzone_root_->get_split_duplex_link_by_name_or_null(name) : nullptr; + if (not link_impl) + throw std::invalid_argument("Link not found: " + name); + return link_impl->get_iface(); } -void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage) +/** @brief Find a link from its name (or nullptr if that link does not exist) */ +Link* Engine::link_by_name_or_null(const std::string& name) const { - pimpl->storages_[name] = storage; + Link* link = nullptr; + if (pimpl->netzone_root_) { + /* keep behavior where internal __loopback__ link from network model is given to user */ + if (name == "__loopback__") + return pimpl->netzone_root_->get_network_model()->loopback_->get_iface(); + auto* link_impl = pimpl->netzone_root_->get_link_by_name_or_null(name); + if (link_impl) + link = link_impl->get_iface(); + } + return link; } -void Engine::storage_unregister(std::string name) +/** @brief Find a mailbox from its name or create one if it does not exist) */ +Mailbox* Engine::mailbox_by_name_or_create(const std::string& name) const { - pimpl->storages_.erase(name); + /* two actors may have pushed the same mbox_create simcall at the same time */ + kernel::activity::MailboxImpl* mbox = kernel::actor::simcall_answered([&name, this] { + auto [m, inserted] = pimpl->mailboxes_.try_emplace(name, nullptr); + if (inserted) { + m->second = new kernel::activity::MailboxImpl(name); + XBT_DEBUG("Creating a mailbox at %p with name %s", m->second, name.c_str()); + } + return m->second; + }); + return mbox->get_iface(); } /** @brief Returns the amount of links in the platform */ -size_t Engine::get_link_count() +size_t Engine::get_link_count() const { - return pimpl->links_.size(); + int count = 0; + if (pimpl->netzone_root_) { + count += pimpl->netzone_root_->get_link_count(); + /* keep behavior where internal __loopback__ link from network model is given to user */ + count += pimpl->netzone_root_->get_network_model()->loopback_ ? 1 : 0; + } + return count; } /** @brief Returns the list of all links found in the platform */ -std::vector Engine::get_all_links() +std::vector Engine::get_all_links() const { - std::vector res; - for (auto const& kv : pimpl->links_) - res.push_back(kv.second); - return res; + return get_filtered_links([](const Link*) { return true; }); } -std::vector Engine::get_filtered_links(std::function filter) +std::vector Engine::get_filtered_links(const std::function& filter) const { - std::vector filtered_list; - for (auto const& kv : pimpl->links_) - if (filter(kv.second)) - filtered_list.push_back(kv.second); - return filtered_list; + std::vector res; + if (pimpl->netzone_root_) { + res = pimpl->netzone_root_->get_filtered_links(filter); + /* keep behavior where internal __loopback__ link from network model is given to user */ + if (pimpl->netzone_root_->get_network_model()->loopback_ && + filter(pimpl->netzone_root_->get_network_model()->loopback_->get_iface())) + res.push_back(pimpl->netzone_root_->get_network_model()->loopback_->get_iface()); + } + return res; } -size_t Engine::get_actor_count() +size_t Engine::get_actor_count() const { - return simix_global->process_list.size(); + return pimpl->get_actor_count(); } -std::vector Engine::get_all_actors() +std::vector Engine::get_all_actors() const { std::vector actor_list; - actor_list.push_back(simgrid::s4u::Actor::self()); - for (auto& kv : simix_global->process_list) { - actor_list.push_back(kv.second->iface()); + for (auto const& [_, actor] : pimpl->get_actor_list()) { + actor_list.push_back(actor->get_iface()); } return actor_list; } -std::vector Engine::get_filtered_actors(std::function filter) +std::vector Engine::get_filtered_actors(const std::function& filter) const { std::vector actor_list; - for (auto& kv : simix_global->process_list) { - if (filter(kv.second->iface())) - actor_list.push_back(kv.second->iface()); + for (auto const& [_, actor] : pimpl->get_actor_list()) { + if (filter(actor->get_iface())) + actor_list.push_back(actor->get_iface()); } return actor_list; } -void Engine::run() +void Engine::run() const +{ + run_until(-1); +} +void Engine::run_until(double max_date) const { + if (static bool callback_called = false; not callback_called) { + on_simulation_start(); + callback_called = true; + } /* Clean IO before the run */ fflush(stdout); fflush(stderr); - if (MC_is_active()) { - MC_run(); - } else { - SIMIX_run(); - } + pimpl->run(max_date); +} + +void Engine::track_vetoed_activities(std::set* vetoed_activities) const +{ + Activity::set_vetoed_activities(vetoed_activities); } /** @brief Retrieve the root netzone, containing all others */ -s4u::NetZone* Engine::get_netzone_root() +s4u::NetZone* Engine::get_netzone_root() const { - return pimpl->netzone_root_->get_iface(); + if (pimpl->netzone_root_) + return pimpl->netzone_root_->get_iface(); + return nullptr; } /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */ -void Engine::set_netzone_root(s4u::NetZone* netzone) +void Engine::set_netzone_root(const s4u::NetZone* netzone) { xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set"); pimpl->netzone_root_ = netzone->get_impl(); } -static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, std::string name) +static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name) { if (current->get_name() == name) return current; for (auto const& elem : current->get_children()) { - simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name); + NetZone* tmp = netzone_by_name_recursive(elem, name); if (tmp != nullptr) { return tmp; } @@ -312,43 +380,45 @@ static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, std::strin } /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */ -NetZone* Engine::netzone_by_name_or_null(std::string name) +NetZone* Engine::netzone_by_name_or_null(const std::string& name) const { return netzone_by_name_recursive(get_netzone_root(), name); } /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */ -simgrid::kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(std::string name) +kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(const std::string& name) const { auto netp = pimpl->netpoints_.find(name); return netp == pimpl->netpoints_.end() ? nullptr : netp->second; } -/** @brief Fill the provided vector with all existing netpoints */ -void Engine::getNetpointList(std::vector* list) +kernel::routing::NetPoint* Engine::netpoint_by_name(const std::string& name) const { - for (auto const& kv : pimpl->netpoints_) - list->push_back(kv.second); + auto netp = netpoint_by_name_or_null(name); + if (netp == nullptr) { + throw std::invalid_argument("Netpoint not found: " + name); + } + return netp; } -std::vector Engine::get_all_netpoints() + +std::vector Engine::get_all_netpoints() const { - std::vector res; - for (auto const& kv : pimpl->netpoints_) - res.push_back(kv.second); + std::vector res; + for (auto const& [_, netpoint] : pimpl->netpoints_) + res.push_back(netpoint); return res; } /** @brief Register a new netpoint to the system */ -void Engine::netpoint_register(simgrid::kernel::routing::NetPoint* point) +void Engine::netpoint_register(kernel::routing::NetPoint* point) { - // simgrid::simix::simcall([&]{ FIXME: this segfaults in set_thread - pimpl->netpoints_[point->get_name()] = point; - // }); + simgrid::kernel::actor::simcall_answered([this, point] { pimpl->netpoints_[point->get_name()] = point; }); } + /** @brief Unregister a given netpoint */ -void Engine::netpoint_unregister(simgrid::kernel::routing::NetPoint* point) +void Engine::netpoint_unregister(kernel::routing::NetPoint* point) { - simgrid::simix::simcall([this, point] { + kernel::actor::simcall_answered([this, point] { pimpl->netpoints_.erase(point->get_name()); delete point; }); @@ -358,17 +428,40 @@ bool Engine::is_initialized() { return Engine::instance_ != nullptr; } -void Engine::set_config(std::string str) +void Engine::set_config(const std::string& str) +{ + config::set_parse(str); +} +void Engine::set_config(const std::string& name, int value) +{ + config::set_value(name.c_str(), value); +} +void Engine::set_config(const std::string& name, double value) +{ + config::set_value(name.c_str(), value); +} +void Engine::set_config(const std::string& name, bool value) { - simgrid::config::set_parse(std::move(str)); + config::set_value(name.c_str(), value); } -} // namespace s4u -} // namespace simgrid +void Engine::set_config(const std::string& name, const std::string& value) +{ + config::set_value(name.c_str(), value); +} + +Engine* Engine::set_default_comm_data_copy_callback( + const std::function& callback) +{ + kernel::activity::CommImpl::set_copy_data_callback(callback); + return this; +} + +} // namespace simgrid::s4u /* **************************** Public C interface *************************** */ void simgrid_init(int* argc, char** argv) { - simgrid::s4u::Engine e(argc, argv); + static simgrid::s4u::Engine e(argc, argv); } void simgrid_load_platform(const char* file) { @@ -383,11 +476,15 @@ void simgrid_run() { simgrid::s4u::Engine::get_instance()->run(); } -void simgrid_register_function(const char* name, int (*code)(int, char**)) +void simgrid_run_until(double max_date) +{ + simgrid::s4u::Engine::get_instance()->run_until(max_date); +} +void simgrid_register_function(const char* name, void (*code)(int, char**)) { simgrid::s4u::Engine::get_instance()->register_function(name, code); } -void simgrid_register_default(int (*code)(int, char**)) +void simgrid_register_default(void (*code)(int, char**)) { simgrid::s4u::Engine::get_instance()->register_default(code); } @@ -395,3 +492,8 @@ double simgrid_get_clock() { return simgrid::s4u::Engine::get_clock(); } + +void simgrid_set_maestro(void (*code)(void*), void* data) +{ + maestro_code = std::bind(code, data); +}