/* s4u::Engine Simulation Engine and global functions. */
-/* Copyright (c) 2006-2020. 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/Disk.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/instr/instr_private.hpp"
#include "src/kernel/EngineImpl.hpp"
-#include "src/simix/smx_private.hpp" // For access to simix_global->process_list
-#include "src/surf/StorageImpl.hpp"
-#include "src/surf/network_interface.hpp"
-#include "surf/surf.hpp" // routing_platf. FIXME:KILLME. SOON
-#include <simgrid/Exception.hpp>
+#include "src/mc/mc_replay.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()> Engine::on_platform_creation;
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. */
-Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
+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();
- SIMIX_global_init(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::instance_ = this;
+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())
+{
+ initialize(argc, argv);
}
Engine::~Engine()
{
- delete pimpl;
+ kernel::EngineImpl::shutdown();
Engine::instance_ = nullptr;
}
/** @brief Retrieve the engine singleton */
Engine* Engine::get_instance()
+{
+ return get_instance(nullptr, nullptr);
+}
+Engine* Engine::get_instance(int* argc, char** argv)
{
if (Engine::instance_ == nullptr) {
- auto e = new Engine(nullptr, nullptr);
+ auto e = new Engine(argc, argv);
xbt_assert(Engine::instance_ == e);
}
return Engine::instance_;
void Engine::shutdown()
{
delete Engine::instance_;
- Engine::instance_ = nullptr;
}
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 kernel::EngineImpl::get_clock();
+ }
+}
+
+void Engine::add_model(std::shared_ptr<kernel::resource::Model> model,
+ const std::vector<kernel::resource::Model*>& dependencies)
+{
+ kernel::actor::simcall([this, &model, &dependencies] { pimpl->add_model(std::move(model), dependencies); });
+}
+
+const std::vector<simgrid::kernel::resource::Model*>& Engine::get_all_models() const
+{
+ return pimpl->get_all_models();
}
/**
* Creates a new platform, including hosts, links, and the routing table.
*
- * \rst
+ * @beginrst
* See also: :ref:`platform`.
- * \endrst
+ * @endrst
*/
void Engine::load_platform(const std::string& platf) const
{
- double start = xbt_os_time();
- parse_platform_file(platf);
-
- double end = xbt_os_time();
- XBT_DEBUG("PARSE TIME: %g", (end - start));
-}
-
-void Engine::register_function(const std::string& name, int (*code)(int, char**)) // deprecated
-{
- kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
- return xbt::wrap_main(code, std::move(args));
- };
- register_function(name, std::move(code_factory));
-}
-void Engine::register_default(int (*code)(int, char**)) // deprecated
-{
- register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
+ pimpl->load_platform(platf);
}
/** Registers the main function of an actor that will be launched from the deployment file */
kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
return xbt::wrap_main(code, std::move(args));
};
- register_function(name, std::move(code_factory));
+ register_function(name, code_factory);
}
/** 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)
{
- kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
+ 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, std::move(code_factory));
+ register_function(name, code_factory);
}
/** 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/s4u/replay-comms and similar).
+ * It is used for trace-based simulations (see examples/cpp/replay-comms and similar).
*/
void Engine::register_default(const std::function<void(int, char**)>& code)
{
/** Load a deployment file and launch the actors that it contains
*
- * \rst
+ * @beginrst
* See also: :ref:`deploy`.
- * \endrst
+ * @endrst
*/
void Engine::load_deployment(const std::string& deploy) const
{
return link->second->get_iface();
}
+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();
+}
+
/** @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
{
return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
}
+/** @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
+{
+ /* 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::link_register(const std::string& name, const Link* link)
{
pimpl->links_[name] = link->get_impl();
pimpl->links_.erase(name);
}
-/** @brief Returns the amount of storages in the platform */
-size_t Engine::get_storage_count() const
-{
- return pimpl->storages_.size();
-}
-
-/** @brief Returns the list of all storages found in the platform */
-std::vector<Storage*> Engine::get_all_storages() const
-{
- std::vector<Storage*> res;
- for (auto const& kv : pimpl->storages_)
- res.push_back(kv.second->get_iface());
- return res;
-}
-
-/** @brief Find a storage from its name.
- *
- * @throw std::invalid_argument if the searched storage does not exist.
- */
-Storage* Engine::storage_by_name(const std::string& name) const
-{
- auto storage = pimpl->storages_.find(name);
- if (storage == pimpl->storages_.end())
- throw std::invalid_argument(std::string("Storage not found: ") + name);
- return storage->second->get_iface();
-}
-
-/** @brief Find a storage from its name (or nullptr if that storage does not exist) */
-Storage* Engine::storage_by_name_or_null(const std::string& name) const
-{
- auto storage = pimpl->storages_.find(name);
- return storage == pimpl->storages_.end() ? nullptr : storage->second->get_iface();
-}
-
-void Engine::storage_register(const std::string& name, const Storage* storage)
-{
- pimpl->storages_[name] = storage->get_impl();
-}
-
-void Engine::storage_unregister(const std::string& name)
-{
- pimpl->storages_.erase(name);
-}
-
/** @brief Returns the amount of links in the platform */
size_t Engine::get_link_count() const
{
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() const
{
std::vector<ActorPtr> actor_list;
- for (auto const& 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(const std::function<bool(ActorPtr)>& filter) const
{
std::vector<ActorPtr> actor_list;
- for (auto const& 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() 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() 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(const s4u::NetZone* netzone)
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);
+ if (netp == nullptr) {
+ throw std::invalid_argument(std::string("Netpoint not found: %s") + name);
+ }
+ return netp;
+}
+
std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints() const
{
std::vector<kernel::routing::NetPoint*> res;
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 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)
{
return simgrid::s4u::Engine::get_clock();
}
-int simgrid_get_actor_count() // XBT_ATTRIB_DEPRECATED_v330
+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
{
- return simgrid::s4u::Engine::get_instance()->get_actor_count();
+ simgrid_set_maestro(code, data);
}
