X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a882344bc908a258a991701e226556ec23fd7cd6..6e0d0f6c1580aceb13c060bbf95cbe9000cf6bbd:/src/s4u/s4u_Engine.cpp diff --git a/src/s4u/s4u_Engine.cpp b/src/s4u/s4u_Engine.cpp index d9da9e108e..094e8311d1 100644 --- a/src/s4u/s4u_Engine.cpp +++ b/src/s4u/s4u_Engine.cpp @@ -1,6 +1,6 @@ /* s4u::Engine Simulation Engine and global functions. */ -/* Copyright (c) 2006-2022. 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. */ @@ -9,25 +9,25 @@ #include #include -#define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v333) -#include - -#include "mc/mc.h" #include "src/instr/instr_private.hpp" #include "src/kernel/EngineImpl.hpp" +#include "src/kernel/resource/HostImpl.hpp" +#include "src/kernel/resource/NetworkModel.hpp" +#include "src/kernel/resource/SplitDuplexLinkImpl.hpp" +#include "src/kernel/resource/StandardLinkImpl.hpp" +#include "src/mc/mc.h" #include "src/mc/mc_replay.hpp" #include "xbt/config.hpp" #include #include -XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface"); +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)"); static simgrid::kernel::actor::ActorCode maestro_code; -namespace simgrid { -namespace s4u { +namespace simgrid::s4u { xbt::signal Engine::on_platform_creation; xbt::signal Engine::on_platform_created; xbt::signal Engine::on_simulation_start; @@ -42,20 +42,20 @@ void Engine::initialize(int* argc, char** argv) 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); + 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); } -Engine::Engine(std::string name) : pimpl(new kernel::EngineImpl()) +Engine::Engine(std::string name) : pimpl_(new kernel::EngineImpl()) { int argc = 1; char* argv = &name[0]; initialize(&argc, &argv); } -Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl()) +Engine::Engine(int* argc, char** argv) : pimpl_(new kernel::EngineImpl()) { initialize(argc, argv); } @@ -76,15 +76,14 @@ Engine* Engine::get_instance() Engine* Engine::get_instance(int* argc, char** argv) { if (Engine::instance_ == nullptr) { - auto e = new Engine(argc, argv); + const auto* e = new Engine(argc, argv); xbt_assert(Engine::instance_ == e); } return Engine::instance_; } - -void Engine::shutdown() // XBT_ATTRIB_DEPRECATED_v335 +const std::vector& Engine::get_cmdline() const { - delete Engine::instance_; + return pimpl_->get_cmdline(); } double Engine::get_clock() @@ -99,34 +98,160 @@ double Engine::get_clock() void Engine::add_model(std::shared_ptr model, const std::vector& dependencies) { - kernel::actor::simcall_answered([this, &model, &dependencies] { pimpl->add_model(std::move(model), dependencies); }); + kernel::actor::simcall_answered([this, &model, &dependencies] { pimpl_->add_model(std::move(model), dependencies); }); } const std::vector& Engine::get_all_models() const { - return pimpl->get_all_models(); + return pimpl_->get_all_models(); } -/** - * 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 { - pimpl->load_platform(platf); + pimpl_->load_platform(platf); } -/** - * @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 { - pimpl->seal_platform(); + pimpl_->seal_platform(); +} + +static void flatify_hosts(Engine const& engine, std::stringstream& ss) +{ + // Regular hosts + std::vector hosts = engine.get_all_hosts(); + + for (auto const* h : hosts) { + ss << " get_name() << "\" speed=\"" << h->get_speed() << "\""; + const std::unordered_map* props = h->get_properties(); + if (h->get_core_count() > 1) + ss << " core=\"" << h->get_core_count() << "\""; + + // Sort the properties before displaying them, so that the tests are perfectly reproducible + std::vector keys; + for (auto const& [key, _] : *props) + keys.push_back(key); + if (not keys.empty()) { + ss << ">\n"; + std::sort(keys.begin(), keys.end()); + for (const std::string& key : keys) + ss << " at(key) << "\"/>\n"; + ss << " \n"; + } else { + ss << "/>\n"; + } + } + + // Routers + std::vector netpoints = engine.get_all_netpoints(); + std::sort(netpoints.begin(), netpoints.end(), + [](const simgrid::kernel::routing::NetPoint* a, const simgrid::kernel::routing::NetPoint* b) { + return a->get_name() < b->get_name(); + }); + + for (auto const& src : netpoints) + if (src->is_router()) + ss << " get_name() << "\"/>\n"; +} + +static void flatify_links(Engine const& engine, std::stringstream& ss) +{ + std::vector links = engine.get_all_links(); + + std::sort(links.begin(), links.end(), [](const Link* a, const Link* b) { return a->get_name() < b->get_name(); }); + + for (auto const* link : links) { + ss << " get_name() << "\""; + ss << " bandwidth=\"" << link->get_bandwidth() << "\""; + ss << " latency=\"" << link->get_latency() << "\""; + if (link->get_concurrency_limit() != -1) + ss << " concurrency=\"" << link->get_concurrency_limit() << "\""; + if (link->is_shared()) { + ss << "/>\n"; + } else { + ss << " sharing_policy=\"FATPIPE\"/>\n"; + } + } +} + +static void flatify_routes(Engine const& engine, std::stringstream& ss) +{ + auto hosts = engine.get_all_hosts(); + auto netpoints = engine.get_all_netpoints(); + std::sort(netpoints.begin(), netpoints.end(), + [](const simgrid::kernel::routing::NetPoint* a, const simgrid::kernel::routing::NetPoint* b) { + return a->get_name() < b->get_name(); + }); + + for (auto const* src_host : hosts) { // Routes from host + const simgrid::kernel::routing::NetPoint* src = src_host->get_netpoint(); + for (auto const* dst_host : hosts) { // Routes to host + std::vector route; + const simgrid::kernel::routing::NetPoint* dst = dst_host->get_netpoint(); + simgrid::kernel::routing::NetZoneImpl::get_global_route(src, dst, route, nullptr); + if (route.empty()) + continue; + ss << " get_name() << "\" dst=\"" << dst_host->get_name() << "\">\n "; + for (auto const& link : route) + ss << "get_name() << "\"/>"; + ss << "\n \n"; + } + + for (auto const& dst : netpoints) { // to router + if (not dst->is_router()) + continue; + ss << " get_name() << "\" dst=\"" << dst->get_name() << "\">\n "; + std::vector route; + simgrid::kernel::routing::NetZoneImpl::get_global_route(src, dst, route, nullptr); + for (auto const& link : route) + ss << "get_name() << "\"/>"; + ss << "\n \n"; + } + } + + for (auto const& value1 : netpoints) { // Routes from router + if (not value1->is_router()) + continue; + for (auto const& value2 : netpoints) { // to router + if (not value2->is_router()) + continue; + std::vector route; + simgrid::kernel::routing::NetZoneImpl::get_global_route(value1, value2, route, nullptr); + if (route.empty()) + continue; + ss << " get_name() << "\" dst=\"" << value2->get_name() << "\">\n "; + for (auto const& link : route) + ss << "get_name() << "\"/>"; + ss << "\n \n"; + } + for (auto const* dst_host : hosts) { // Routes to host + ss << " get_name() << "\" dst=\"" << dst_host->get_name() << "\">\n "; + std::vector route; + const simgrid::kernel::routing::NetPoint* netcardDst = dst_host->get_netpoint(); + simgrid::kernel::routing::NetZoneImpl::get_global_route(value1, netcardDst, route, nullptr); + for (auto const& link : route) + ss << "get_name() << "\"/>"; + ss << "\n \n"; + } + } +} +std::string Engine::flatify_platform() const +{ + std::string version = "4.1"; + std::stringstream ss; + + ss << "\n"; + ss << "\n"; + ss << "\n"; + ss << "get_name() << "\" routing=\"Full\">\n"; + + flatify_hosts(*this, ss); + flatify_links(*this, ss); + flatify_routes(*this, ss); + + ss << "\n"; + ss << "\n"; + return ss.str(); } /** Registers the main function of an actor that will be launched from the deployment file */ @@ -157,12 +282,12 @@ void Engine::register_default(const std::function& code) } void Engine::register_default(const kernel::actor::ActorCodeFactory& code) { - simgrid::kernel::actor::simcall_answered([this, &code]() { pimpl->register_default(code); }); + simgrid::kernel::actor::simcall_answered([this, &code]() { pimpl_->register_default(code); }); } void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code) { - simgrid::kernel::actor::simcall_answered([this, name, &code]() { pimpl->register_function(name, code); }); + simgrid::kernel::actor::simcall_answered([this, name, &code]() { pimpl_->register_function(name, code); }); } /** Load a deployment file and launch the actors that it contains @@ -173,61 +298,55 @@ void Engine::register_function(const std::string& name, const kernel::actor::Act */ void Engine::load_deployment(const std::string& deploy) const { - pimpl->load_deployment(deploy); + pimpl_->load_deployment(deploy); } /** Returns the amount of hosts in the platform */ size_t Engine::get_host_count() const { - return pimpl->hosts_.size(); + return get_all_hosts().size(); } std::vector Engine::get_all_hosts() const { - std::vector res; - for (auto const& kv : pimpl->hosts_) - res.push_back(kv.second); - return res; + return get_filtered_hosts([](const Host*) { return true; }); } std::vector Engine::get_filtered_hosts(const std::function& filter) const { std::vector hosts; - for (auto const& kv : pimpl->hosts_) { - if (filter(kv.second)) - hosts.push_back(kv.second); + 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; } -void Engine::host_register(const std::string& name, Host* host) -{ - pimpl->hosts_[name] = host; -} - -void Engine::host_unregister(const std::string& name) -{ - pimpl->hosts_.erase(name); -} - /** @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 { - auto host = pimpl->hosts_.find(name); - if (host == pimpl->hosts_.end()) - throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'")); - return host->second; + auto* host = host_by_name_or_null(name); + if (not host) + throw std::invalid_argument("Host not found: '" + name + "'"); + return host; } /** @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 { - auto host = pimpl->hosts_.find(name); - return host == pimpl->hosts_.end() ? nullptr : host->second; + 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 link from its name. @@ -236,25 +355,34 @@ Host* Engine::host_by_name_or_null(const std::string& name) const */ Link* Engine::link_by_name(const std::string& name) const { - auto link = pimpl->links_.find(name); - if (link == pimpl->links_.end()) - throw std::invalid_argument(std::string("Link not found: ") + name); - return link->second->get_iface(); + auto* link = link_by_name_or_null(name); + if (not link) + throw std::invalid_argument("Link not found: " + name); + return link; } SplitDuplexLink* Engine::split_duplex_link_by_name(const std::string& name) const { - auto link = pimpl->split_duplex_links_.find(name); - if (link == pimpl->split_duplex_links_.end()) - throw std::invalid_argument(std::string("Link not found: ") + name); - return link->second->get_iface(); + 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(); } /** @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 { - auto link = pimpl->links_.find(name); - return link == pimpl->links_.end() ? nullptr : link->second->get_iface(); + 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; } /** @brief Find a mailbox from its name or create one if it does not exist) */ @@ -262,62 +390,71 @@ Mailbox* Engine::mailbox_by_name_or_create(const std::string& name) const { /* 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 = pimpl->mailboxes_.emplace(name, nullptr); - if (m.second) { - m.first->second = new kernel::activity::MailboxImpl(name); - XBT_DEBUG("Creating a mailbox at %p with name %s", m.first->second, name.c_str()); + 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.first->second; + return m->second; }); return mbox->get_iface(); } -void Engine::link_register(const std::string& name, const Link* link) -{ - pimpl->links_[name] = link->get_impl(); -} - -void Engine::link_unregister(const std::string& name) +MessageQueue* Engine::message_queue_by_name_or_create(const std::string& name) const { - pimpl->links_.erase(name); + /* two actors may have pushed the same mbox_create simcall at the same time */ + kernel::activity::MessageQueueImpl* queue = kernel::actor::simcall_answered([&name, this] { + auto [m, inserted] = pimpl_->mqueues_.try_emplace(name, nullptr); + if (inserted) { + m->second = new kernel::activity::MessageQueueImpl(name); + XBT_DEBUG("Creating a message queue at %p with name %s", m->second, name.c_str()); + } + return m->second; + }); + return queue->get_iface(); } /** @brief Returns the amount of links in the platform */ 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() const { - std::vector res; - for (auto const& kv : pimpl->links_) - res.push_back(kv.second->get_iface()); - return res; + return get_filtered_links([](const Link*) { return true; }); } std::vector Engine::get_filtered_links(const std::function& filter) const { - std::vector filtered_list; - for (auto const& kv : pimpl->links_) { - Link* l = kv.second->get_iface(); - if (filter(l)) - filtered_list.push_back(l); + 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 filtered_list; + return res; } size_t Engine::get_actor_count() const { - return pimpl->get_actor_count(); + return pimpl_->get_actor_count(); } std::vector Engine::get_all_actors() const { std::vector actor_list; - for (auto const& kv : pimpl->get_actor_list()) { - actor_list.push_back(kv.second->get_iface()); + for (auto const& [_, actor] : pimpl_->get_actor_list()) { + actor_list.push_back(actor->get_iface()); } return actor_list; } @@ -325,9 +462,9 @@ std::vector Engine::get_all_actors() const std::vector Engine::get_filtered_actors(const std::function& filter) const { std::vector actor_list; - for (auto const& kv : pimpl->get_actor_list()) { - if (filter(kv.second->get_iface())) - actor_list.push_back(kv.second->get_iface()); + for (auto const& [_, actor] : pimpl_->get_actor_list()) { + if (filter(actor->get_iface())) + actor_list.push_back(actor->get_iface()); } return actor_list; } @@ -338,8 +475,7 @@ void Engine::run() const } void Engine::run_until(double max_date) const { - static bool callback_called = false; - if (not callback_called) { + if (static bool callback_called = false; not callback_called) { on_simulation_start(); callback_called = true; } @@ -347,7 +483,7 @@ void Engine::run_until(double max_date) const fflush(stdout); fflush(stderr); - pimpl->run(max_date); + pimpl_->run(max_date); } void Engine::track_vetoed_activities(std::set* vetoed_activities) const @@ -358,15 +494,15 @@ void Engine::track_vetoed_activities(std::set* vetoed_activities) con /** @brief Retrieve the root netzone, containing all others */ s4u::NetZone* Engine::get_netzone_root() const { - if (pimpl->netzone_root_) - 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(const s4u::NetZone* netzone) { - xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set"); - pimpl->netzone_root_ = netzone->get_impl(); + xbt_assert(pimpl_->netzone_root_ == nullptr, "The root NetZone cannot be changed once set"); + pimpl_->netzone_root_ = netzone->get_impl(); } static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name) @@ -392,15 +528,15 @@ NetZone* Engine::netzone_by_name_or_null(const std::string& name) const /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */ 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; + auto netp = pimpl_->netpoints_.find(name); + return netp == pimpl_->netpoints_.end() ? nullptr : netp->second; } kernel::routing::NetPoint* Engine::netpoint_by_name(const std::string& name) const { - auto netp = netpoint_by_name_or_null(name); + auto* netp = netpoint_by_name_or_null(name); if (netp == nullptr) { - throw std::invalid_argument(std::string("Netpoint not found: %s") + name); + throw std::invalid_argument("Netpoint not found: " + name); } return netp; } @@ -408,22 +544,22 @@ kernel::routing::NetPoint* Engine::netpoint_by_name(const std::string& name) con std::vector Engine::get_all_netpoints() const { std::vector res; - for (auto const& kv : pimpl->netpoints_) - res.push_back(kv.second); + for (auto const& [_, netpoint] : pimpl_->netpoints_) + res.push_back(netpoint); return res; } /** @brief Register a new netpoint to the system */ void Engine::netpoint_register(kernel::routing::NetPoint* point) { - simgrid::kernel::actor::simcall_answered([this, point] { 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(kernel::routing::NetPoint* point) { kernel::actor::simcall_answered([this, point] { - pimpl->netpoints_.erase(point->get_name()); + pimpl_->netpoints_.erase(point->get_name()); delete point; }); } @@ -460,8 +596,7 @@ Engine* Engine::set_default_comm_data_copy_callback( return this; } -} // namespace s4u -} // namespace simgrid +} // namespace simgrid::s4u /* **************************** Public C interface *************************** */ void simgrid_init(int* argc, char** argv) @@ -500,13 +635,5 @@ double simgrid_get_clock() void simgrid_set_maestro(void (*code)(void*), void* data) { -#ifdef _WIN32 - XBT_WARN("simgrid_set_maestro is believed to not work on windows. Please help us investigating this issue if " - "you need that feature"); -#endif maestro_code = std::bind(code, data); } -void SIMIX_set_maestro(void (*code)(void*), void* data) // XBT_ATTRIB_DEPRECATED_v333 -{ - simgrid_set_maestro(code, data); -}