Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Split-Duplex: new management
[simgrid.git] / src / s4u / s4u_Engine.cpp
index ad5327c..47b512e 100644 (file)
@@ -1,6 +1,6 @@
 /* s4u::Engine Simulation Engine and global functions. */
 
-/* Copyright (c) 2006-2019. 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/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/mc/mc_replay.hpp"
 #include "src/surf/network_interface.hpp"
 #include "surf/surf.hpp" // routing_platf. FIXME:KILLME. SOON
 #include <simgrid/Exception.hpp>
 
+#include <algorithm>
 #include <string>
 
 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
@@ -38,13 +37,24 @@ 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(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");
-  TRACE_global_init();
+  Engine::instance_ = this;
+  instr::init();
   SIMIX_global_init(argc, argv);
+}
 
-  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()
@@ -57,7 +67,7 @@ Engine::~Engine()
 Engine* Engine::get_instance()
 {
   if (Engine::instance_ == nullptr) {
-    auto e = new Engine(0, nullptr);
+    auto e = new Engine(nullptr, nullptr);
     xbt_assert(Engine::instance_ == e);
   }
   return Engine::instance_;
@@ -71,64 +81,102 @@ void Engine::shutdown()
 
 double Engine::get_clock()
 {
-  return SIMIX_get_clock();
+  if (MC_is_active() || MC_record_replay_is_active()) {
+    return MC_process_clock_get(SIMIX_process_self());
+  } else {
+    return surf_get_clock();
+  }
+}
+
+void Engine::add_model(std::shared_ptr<kernel::resource::Model> model,
+                       const std::vector<kernel::resource::Model*>& dependencies)
+{
+  simgrid::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)
+void Engine::load_platform(const std::string& platf) const
 {
-  double start = xbt_os_time();
-  parse_platform_file(platf);
+  pimpl->load_platform(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**)) // XBT_ATTRIB_DEPRECATED_v329
+{
+  kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
+    return xbt::wrap_main(code, std::move(args));
+  };
+  register_function(name, code_factory);
+}
+void Engine::register_default(int (*code)(int, char**)) // XBT_ATTRIB_DEPRECATED_v329
+{
+  register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
 }
 
 /** Registers the main function of an actor that will be launched from the deployment file */
-void Engine::register_function(const std::string& name, int (*code)(int, char**))
+void Engine::register_function(const std::string& name, const std::function<void(int, char**)>& code)
 {
-  pimpl->register_function(name, code);
+  kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
+    return xbt::wrap_main(code, std::move(args));
+  };
+  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, void (*code)(std::vector<std::string>))
+void Engine::register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code)
 {
-  pimpl->register_function(name, code);
+  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);
 }
 /** 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(int (*code)(int, char**))
+void Engine::register_default(const std::function<void(int, char**)>& code)
+{
+  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)
 {
-  pimpl->register_default(code);
+  simgrid::kernel::actor::simcall([this, name, &code]() { pimpl->register_function(name, 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)
+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()
+size_t Engine::get_host_count() const
 {
   return pimpl->hosts_.size();
 }
 
-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_)
@@ -136,7 +184,7 @@ std::vector<Host*> Engine::get_all_hosts()
   return res;
 }
 
-std::vector<Host*> Engine::get_filtered_hosts(const 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_) {
@@ -161,15 +209,16 @@ void Engine::host_unregister(const std::string& name)
  *
  *  @throw std::invalid_argument if the searched host does not exist.
  */
-Host* Engine::host_by_name(const std::string& name)
+Host* Engine::host_by_name(const std::string& name) const
 {
-  if (pimpl->hosts_.find(name) == pimpl->hosts_.end())
+  auto host = pimpl->hosts_.find(name);
+  if (host == pimpl->hosts_.end())
     throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
-  return pimpl->hosts_.at(name);
+  return host->second;
 }
 
 /** @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)
+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;
@@ -179,83 +228,62 @@ Host* Engine::host_by_name_or_null(const std::string& name)
  *
  *  @throw std::invalid_argument if the searched link does not exist.
  */
-Link* Engine::link_by_name(const std::string& name)
-{
-  if (pimpl->links_.find(name) == pimpl->links_.end())
-    throw std::invalid_argument(std::string("Link not found: ") + name);
-
-  return pimpl->links_.at(name)->get_iface();
-}
-
-/** @brief Find an link from its name (or nullptr if that link does not exist) */
-Link* Engine::link_by_name_or_null(const std::string& name)
+Link* Engine::link_by_name(const std::string& name) const
 {
   auto link = pimpl->links_.find(name);
-  return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
-}
-
-void Engine::link_register(const std::string& name, Link* link)
-{
-  pimpl->links_[name] = link->get_impl();
-}
-
-void Engine::link_unregister(const std::string& name)
-{
-  pimpl->links_.erase(name);
-}
-
-/** @brief Returns the amount of storages in the platform */
-size_t Engine::get_storage_count()
-{
-  return pimpl->storages_.size();
+  if (link == pimpl->links_.end())
+    throw std::invalid_argument(std::string("Link not found: ") + name);
+  return link->second->get_iface();
 }
 
-/** @brief Returns the list of all storages found in the platform */
-std::vector<Storage*> Engine::get_all_storages()
+SplitDuplexLink* Engine::split_duplex_link_by_name(const std::string& name) const
 {
-  std::vector<Storage*> res;
-  for (auto const& kv : pimpl->storages_)
-    res.push_back(kv.second->get_iface());
-  return res;
+  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 storage from its name.
- *
- *  @throw std::invalid_argument if the searched storage does not exist.
- */
-Storage* Engine::storage_by_name(const 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
 {
-  if (pimpl->storages_.find(name) == pimpl->storages_.end())
-    throw std::invalid_argument(std::string("Storage not found: ") + name);
-
-  return pimpl->storages_.at(name)->get_iface();
+  auto link = pimpl->links_.find(name);
+  return link == pimpl->links_.end() ? nullptr : link->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)
+/** @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->get_iface();
+  /* 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(const std::string& name, Storage* storage)
+void Engine::link_register(const std::string& name, const Link* link)
 {
-  pimpl->storages_[name] = storage->get_impl();
+  pimpl->links_[name] = link->get_impl();
 }
 
-void Engine::storage_unregister(const 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_)
@@ -263,7 +291,7 @@ std::vector<Link*> Engine::get_all_links()
   return res;
 }
 
-std::vector<Link*> Engine::get_filtered_links(const 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_) {
@@ -274,33 +302,38 @@ std::vector<Link*> Engine::get_filtered_links(const std::function<bool(Link*)>&
   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 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)
+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()
+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);
@@ -308,17 +341,19 @@ void Engine::run()
   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_->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();
@@ -339,19 +374,28 @@ static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& n
 }
 
 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
-NetZone* Engine::netzone_by_name_or_null(const 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) */
-kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(const 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;
 }
 
-std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints()
+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;
   for (auto const& kv : pimpl->netpoints_)
@@ -362,9 +406,7 @@ std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints()
 /** @brief Register a new netpoint to the system */
 void Engine::netpoint_register(kernel::routing::NetPoint* point)
 {
-  // simgrid::kernel::actor::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 */
@@ -384,6 +426,23 @@ 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)
+{
+  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);
+}
+
 } // namespace s4u
 } // namespace simgrid
 
@@ -405,11 +464,11 @@ void simgrid_run()
 {
   simgrid::s4u::Engine::get_instance()->run();
 }
-void simgrid_register_function(const char* name, int (*code)(int, char**))
+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);
 }
@@ -417,7 +476,8 @@ double simgrid_get_clock()
 {
   return simgrid::s4u::Engine::get_clock();
 }
-int simgrid_get_actor_count()
+
+int simgrid_get_actor_count() // XBT_ATTRIB_DEPRECATED_v330
 {
   return simgrid::s4u::Engine::get_instance()->get_actor_count();
 }