/* s4u::Engine Simulation Engine and global functions. */
-/* Copyright (c) 2006-2018. 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. */
+#include <simgrid/kernel/routing/NetPoint.hpp>
+#include <simgrid/modelchecker.h>
+#include <simgrid/s4u/Engine.hpp>
+
#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/mc/mc_replay.hpp"
+#include "surf/surf.hpp"
+
+#include <algorithm>
+#include <string>
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 {
-xbt::signal<void()> on_platform_creation;
-xbt::signal<void()> on_platform_created;
-xbt::signal<void()> on_simulation_end;
-xbt::signal<void(double)> on_time_advance;
-xbt::signal<void(void)> on_deadlock;
+xbt::signal<void()> Engine::on_platform_creation;
+xbt::signal<void()> Engine::on_platform_created;
+xbt::signal<void()> Engine::on_simulation_end;
+xbt::signal<void(double)> Engine::on_time_advance;
+xbt::signal<void(void)> Engine::on_deadlock;
-Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
+Engine* Engine::instance_ = nullptr; /* This singleton is awful, but I don't see no other solution right now. */
+
+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);
+ // 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(int* argc, char** argv)
+Engine::Engine(std::string name) : pimpl(new kernel::EngineImpl())
{
- 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);
+ int argc = 1;
+ char* argv = &name[0];
+ initialize(&argc, &argv);
+}
- pimpl = new kernel::EngineImpl();
- s4u::Engine::instance_ = this;
+Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
+{
+ initialize(argc, argv);
}
Engine::~Engine()
{
- delete pimpl;
- s4u::Engine::instance_ = nullptr;
+ kernel::EngineImpl::shutdown();
+ Engine::instance_ = nullptr;
}
/** @brief Retrieve the engine singleton */
Engine* Engine::get_instance()
{
- if (s4u::Engine::instance_ == nullptr)
- return new Engine(0, nullptr);
- else
- return s4u::Engine::instance_;
+ return get_instance(nullptr, nullptr);
+}
+Engine* Engine::get_instance(int* argc, char** argv)
+{
+ if (Engine::instance_ == nullptr) {
+ auto e = new Engine(argc, argv);
+ xbt_assert(Engine::instance_ == e);
+ }
+ return Engine::instance_;
}
void Engine::shutdown()
{
- delete s4u::Engine::instance_;
- s4u::Engine::instance_ = nullptr;
+ delete Engine::instance_;
}
double Engine::get_clock()
{
- return SIMIX_get_clock();
+ if (MC_is_active() || MC_record_replay_is_active()) {
+ return MC_process_clock_get(kernel::actor::ActorImpl::self());
+ } else {
+ return surf_get_clock();
+ }
}
-void Engine::load_platform(const char* platf)
+void Engine::add_model(std::shared_ptr<kernel::resource::Model> model,
+ const std::vector<kernel::resource::Model*>& dependencies)
{
- SIMIX_create_environment(platf);
+ kernel::actor::simcall([this, &model, &dependencies] { pimpl->add_model(std::move(model), dependencies); });
}
-void Engine::register_function(const char* name, int (*code)(int, char**))
+const std::vector<simgrid::kernel::resource::Model*>& Engine::get_all_models() const
{
- SIMIX_function_register(name, code);
+ return pimpl->get_all_models();
}
-void Engine::register_default(int (*code)(int, char**))
+
+/**
+ * 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
{
- SIMIX_function_register_default(code);
+ pimpl->load_platform(platf);
}
-void Engine::load_deployment(const char* deploy)
+
+/** 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<void(int, char**)>& code)
{
- SIMIX_launch_application(deploy);
+ kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
+ return xbt::wrap_main(code, std::move(args));
+ };
+ register_function(name, code_factory);
}
-/** @brief Returns the amount of hosts in the platform */
-size_t Engine::get_host_count()
+
+/** 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<void(std::vector<std::string>)>& code)
{
- return pimpl->hosts_.size();
+ kernel::actor::ActorCodeFactory code_factory = [code{code}](std::vector<std::string> args) mutable {
+ return std::bind(std::move(code), std::move(args));
+ };
+ register_function(name, code_factory);
}
-/** @brief Fills the passed list with all hosts found in the platform
- * @deprecated Please prefer Engine::getAllHosts()
+/** Registers a function as the default main function of actors
+ *
+ * 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).
*/
-void Engine::getHostList(std::vector<Host*>* list)
+void Engine::register_default(const std::function<void(int, char**)>& code)
{
- for (auto const& kv : pimpl->hosts_)
- list->push_back(kv.second);
+ register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
+}
+void Engine::register_default(const kernel::actor::ActorCodeFactory& code)
+{
+ simgrid::kernel::actor::simcall([this, &code]() { pimpl->register_default(code); });
+}
+
+void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code)
+{
+ simgrid::kernel::actor::simcall([this, name, &code]() { pimpl->register_function(name, code); });
+}
+
+/** Load a deployment file and launch the actors that it contains
+ *
+ * @beginrst
+ * See also: :ref:`deploy`.
+ * @endrst
+ */
+void Engine::load_deployment(const std::string& deploy) const
+{
+ pimpl->load_deployment(deploy);
+}
+
+/** Returns the amount of hosts in the platform */
+size_t Engine::get_host_count() const
+{
+ return pimpl->hosts_.size();
}
-/** @brief Returns the list of all hosts found in the platform */
-std::vector<Host*> Engine::get_all_hosts()
+std::vector<Host*> Engine::get_all_hosts() const
{
std::vector<Host*> res;
for (auto const& kv : pimpl->hosts_)
return res;
}
-std::vector<Host*> Engine::get_filtered_hosts(std::function<bool(Host*)> filter)
+std::vector<Host*> Engine::get_filtered_hosts(const std::function<bool(Host*)>& filter) const
{
std::vector<Host*> hosts;
for (auto const& kv : pimpl->hosts_) {
return hosts;
}
-void Engine::host_register(std::string name, simgrid::s4u::Host* host)
+void Engine::host_register(const std::string& name, Host* host)
{
pimpl->hosts_[name] = host;
}
-void Engine::host_unregister(std::string name)
+void Engine::host_unregister(const std::string& name)
{
pimpl->hosts_.erase(name);
}
-simgrid::s4u::Host* Engine::host_by_name(std::string 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
{
- return pimpl->hosts_.at(name); // Will raise a std::out_of_range if the host does not exist
+ 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;
}
-simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
+/** @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;
}
-simgrid::s4u::Link* Engine::link_by_name(std::string name)
-{
- return pimpl->links_.at(name); // Will raise a std::out_of_range if the host does not exist
-}
-
-simgrid::s4u::Link* Engine::link_by_name_or_null(std::string name)
+/** @brief Find a link from its name.
+ *
+ * @throw std::invalid_argument if the searched link does not exist.
+ */
+Link* Engine::link_by_name(const std::string& name) const
{
auto link = pimpl->links_.find(name);
- return link == pimpl->links_.end() ? nullptr : link->second;
+ if (link == pimpl->links_.end())
+ throw std::invalid_argument(std::string("Link not found: ") + name);
+ return link->second->get_iface();
}
-void Engine::link_register(std::string name, simgrid::s4u::Link* link)
+SplitDuplexLink* Engine::split_duplex_link_by_name(const std::string& name) const
{
- pimpl->links_[name] = link;
+ 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();
}
-void Engine::link_unregister(std::string name)
+/** @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->links_.erase(name);
-}
-
-/** @brief Returns the amount of storages in the platform */
-size_t Engine::get_storage_count()
-{
- return pimpl->storages_.size();
-}
-
-/** @brief Returns the list of all storages found in the platform */
-std::vector<Storage*> Engine::get_all_storages()
-{
- std::vector<Storage*> res;
- for (auto const& kv : pimpl->storages_)
- res.push_back(kv.second);
- return res;
-}
-
-simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
-{
- return pimpl->storages_.at(name); // Will raise a std::out_of_range if the host does not exist
+ auto link = pimpl->links_.find(name);
+ return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
}
-simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name)
+/** @brief Find a mailox from its name or create one if it does not exist) */
+Mailbox* Engine::mailbox_by_name_or_create(const std::string& name) const
{
- auto storage = pimpl->storages_.find(name);
- return storage == pimpl->storages_.end() ? nullptr : storage->second;
+ /* two actors may have pushed the same mbox_create simcall at the same time */
+ kernel::activity::MailboxImpl* mbox = kernel::actor::simcall([&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());
+ }
+ return m.first->second;
+ });
+ return mbox->get_iface();
}
-void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage)
+void Engine::link_register(const std::string& name, const Link* link)
{
- pimpl->storages_[name] = storage;
+ pimpl->links_[name] = link->get_impl();
}
-void Engine::storage_unregister(std::string name)
+void Engine::link_unregister(const std::string& name)
{
- pimpl->storages_.erase(name);
+ pimpl->links_.erase(name);
}
/** @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();
}
/** @brief Returns the list of all links found in the platform */
-std::vector<Link*> Engine::get_all_links()
+std::vector<Link*> Engine::get_all_links() const
{
std::vector<Link*> res;
for (auto const& kv : pimpl->links_)
- res.push_back(kv.second);
+ res.push_back(kv.second->get_iface());
return res;
}
-std::vector<Link*> Engine::get_filtered_links(std::function<bool(Link*)> filter)
+std::vector<Link*> Engine::get_filtered_links(const std::function<bool(Link*)>& filter) const
{
std::vector<Link*> filtered_list;
- for (auto const& kv : pimpl->links_)
- if (filter(kv.second))
- filtered_list.push_back(kv.second);
+ for (auto const& kv : pimpl->links_) {
+ Link* l = kv.second->get_iface();
+ if (filter(l))
+ filtered_list.push_back(l);
+ }
return filtered_list;
}
-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<ActorPtr> Engine::get_all_actors()
+std::vector<ActorPtr> Engine::get_all_actors() const
{
std::vector<ActorPtr> 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& kv : pimpl->get_actor_list()) {
+ actor_list.push_back(kv.second->get_iface());
}
return actor_list;
}
-std::vector<ActorPtr> Engine::get_filtered_actors(std::function<bool(ActorPtr)> filter)
+std::vector<ActorPtr> Engine::get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const
{
std::vector<ActorPtr> actor_list;
- for (auto& kv : simix_global->process_list) {
- if (filter(kv.second->iface()))
- actor_list.push_back(kv.second->iface());
+ for (auto const& kv : pimpl->get_actor_list()) {
+ if (filter(kv.second->get_iface()))
+ actor_list.push_back(kv.second->get_iface());
}
return actor_list;
}
-void Engine::run()
+void Engine::run() const
{
+ /* sealing resources before run: links */
+ for (auto* link : get_all_links())
+ link->seal();
+ /* seal netzone root, recursively seal children netzones, hosts and disks */
+ get_netzone_root()->seal();
+
+ /* Clean IO before the run */
+ fflush(stdout);
+ fflush(stderr);
+
if (MC_is_active()) {
MC_run();
} else {
- SIMIX_run();
+ pimpl->run();
}
}
/** @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_;
+ 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_ = static_cast<kernel::routing::NetZoneImpl*>(netzone);
+ pimpl->netzone_root_ = netzone->get_impl();
}
-static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, const char* name)
+static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name)
{
- if (not strcmp(current->get_cname(), name))
+ if (current->get_name() == name)
return current;
- for (auto const& elem : *(current->getChildren())) {
- simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name);
+ for (auto const& elem : current->get_children()) {
+ NetZone* tmp = netzone_by_name_recursive(elem, name);
if (tmp != nullptr) {
return tmp;
}
}
/** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
-NetZone* Engine::netzone_by_name_or_null(const char* 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<simgrid::kernel::routing::NetPoint*>* 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(std::string("Netpoint not found: %s") + name);
+ }
+ return netp;
}
-std::vector<simgrid::kernel::routing::NetPoint*> Engine::get_all_netpoints()
+
+std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints() const
{
- std::vector<simgrid::kernel::routing::NetPoint*> res;
+ std::vector<kernel::routing::NetPoint*> res;
for (auto const& kv : pimpl->netpoints_)
res.push_back(kv.second);
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([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([this, point] {
pimpl->netpoints_.erase(point->get_name());
delete point;
});
{
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)
{
- simgrid::config::set_parse(std::move(str));
+ config::set_value(name.c_str(), value);
}
+void Engine::set_config(const std::string& name, bool value)
+{
+ config::set_value(name.c_str(), value);
+}
+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(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
+{
+ kernel::activity::CommImpl::set_copy_data_callback(callback);
+ return this;
+}
+
} // namespace s4u
} // namespace simgrid
+double SIMIX_get_clock() // XBT_ATTRIB_DEPRECATED_v332
+{
+ return simgrid::s4u::Engine::get_clock();
+}
+
/* **************************** Public C interface *************************** */
-void sg_engine_load_platform(const char* file)
+void simgrid_init(int* argc, char** argv)
+{
+ static simgrid::s4u::Engine e(argc, argv);
+}
+void simgrid_load_platform(const char* file)
{
simgrid::s4u::Engine::get_instance()->load_platform(file);
}
-void sg_engine_load_deployment(const char* file)
+void simgrid_load_deployment(const char* file)
{
simgrid::s4u::Engine::get_instance()->load_deployment(file);
}
-
-void sg_engine_register_function(const char* name, int (*code)(int, char**))
+void simgrid_run()
+{
+ simgrid::s4u::Engine::get_instance()->run();
+}
+void simgrid_register_function(const char* name, void (*code)(int, char**))
{
simgrid::s4u::Engine::get_instance()->register_function(name, code);
}
-void sg_engine_register_default(int (*code)(int, char**))
+void simgrid_register_default(void (*code)(int, char**))
{
simgrid::s4u::Engine::get_instance()->register_default(code);
}
-double sg_engine_get_clock()
+double simgrid_get_clock()
{
return simgrid::s4u::Engine::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);
+}