Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cosmetics.
[simgrid.git] / src / s4u / s4u_Engine.cpp
index 70e3043..7737a2b 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-2020. 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. */
@@ -8,6 +8,7 @@
 #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 "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 <algorithm>
 #include <string>
 
 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
@@ -28,18 +31,18 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_engine, s4u, "Logging specific to S4U (engin
 
 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(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
 {
   xbt_assert(Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine");
-  TRACE_global_init();
+  instr::init();
   SIMIX_global_init(argc, argv);
 
   Engine::instance_ = this;
@@ -55,7 +58,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_;
@@ -73,53 +76,87 @@ double Engine::get_clock()
 }
 
 /**
- * @brief A platform loader.
+ * Creates a new platform, including hosts, links, and the routing table.
  *
- * Creates a new platform, including hosts, links, and the routing_table.
- * @param platf a filename of the XML description of a platform. This file follows this DTD :
- *
- *     @include src/surf/xml/simgrid.dtd
- *
- * Here is a small example of such a platform
- *
- *     @include examples/platforms/small_platform.xml
+ * \rst
+ * See also: :ref:`platform`.
+ * \endrst
  */
-void Engine::load_platform(const std::string& platf)
+void Engine::load_platform(const std::string& platf) const
 {
   double start = xbt_os_time();
-  try {
-    parse_platform_file(platf);
-  } catch (xbt_ex& e) {
-    xbt_die("Error while loading %s: %s", platf.c_str(), e.what());
-  }
+  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**))
+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, std::move(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, const std::function<void(int, char**)>& code)
+{
+  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));
+}
+
+/** 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)
 {
-  SIMIX_function_register(name, code);
+  kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
+    return std::bind(std::move(code), std::move(args));
+  };
+  register_function(name, std::move(code_factory));
 }
-void Engine::register_function(const std::string& name, void (*code)(std::vector<std::string>))
+/** 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).
+ */
+void Engine::register_default(const std::function<void(int, char**)>& code)
 {
-  SIMIX_function_register(name, code);
+  register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
 }
-void Engine::register_default(int (*code)(int, char**))
+void Engine::register_default(const kernel::actor::ActorCodeFactory& code)
 {
-  SIMIX_function_register_default(code);
+  simgrid::kernel::actor::simcall([this, &code]() { pimpl->register_default(code); });
 }
-void Engine::load_deployment(const std::string& deploy)
+
+void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code)
 {
-  SIMIX_launch_application(deploy);
+  simgrid::kernel::actor::simcall([this, name, &code]() { pimpl->register_function(name, code); });
 }
-/** @brief Returns the amount of hosts in the platform */
-size_t Engine::get_host_count()
+
+/** Load a deployment file and launch the actors that it contains
+ *
+ * \rst
+ * 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();
 }
 
-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_)
@@ -127,7 +164,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_) {
@@ -152,15 +189,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;
@@ -170,24 +208,24 @@ 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)
+Link* Engine::link_by_name(const std::string& name) const
 {
-  if (pimpl->links_.find(name) == pimpl->links_.end())
+  auto link = pimpl->links_.find(name);
+  if (link == pimpl->links_.end())
     throw std::invalid_argument(std::string("Link not found: ") + name);
-
-  return pimpl->links_.at(name);
+  return link->second->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)
+/** @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;
+  return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
 }
 
-void Engine::link_register(const std::string& name, Link* link)
+void Engine::link_register(const std::string& name, const Link* link)
 {
-  pimpl->links_[name] = link;
+  pimpl->links_[name] = link->get_impl();
 }
 
 void Engine::link_unregister(const std::string& name)
@@ -196,17 +234,17 @@ void Engine::link_unregister(const std::string& name)
 }
 
 /** @brief Returns the amount of storages in the platform */
-size_t Engine::get_storage_count()
+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()
+std::vector<Storage*> Engine::get_all_storages() const
 {
   std::vector<Storage*> res;
   for (auto const& kv : pimpl->storages_)
-    res.push_back(kv.second);
+    res.push_back(kv.second->get_iface());
   return res;
 }
 
@@ -214,24 +252,24 @@ std::vector<Storage*> Engine::get_all_storages()
  *
  *  @throw std::invalid_argument if the searched storage does not exist.
  */
-Storage* Engine::storage_by_name(const std::string& name)
+Storage* Engine::storage_by_name(const std::string& name) const
 {
-  if (pimpl->storages_.find(name) == pimpl->storages_.end())
+  auto storage = pimpl->storages_.find(name);
+  if (storage == pimpl->storages_.end())
     throw std::invalid_argument(std::string("Storage not found: ") + name);
-
-  return pimpl->storages_.at(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)
+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;
+  return storage == pimpl->storages_.end() ? nullptr : storage->second->get_iface();
 }
 
-void Engine::storage_register(const std::string& name, Storage* storage)
+void Engine::storage_register(const std::string& name, const Storage* storage)
 {
-  pimpl->storages_[name] = storage;
+  pimpl->storages_[name] = storage->get_impl();
 }
 
 void Engine::storage_unregister(const std::string& name)
@@ -240,55 +278,56 @@ void Engine::storage_unregister(const std::string& 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(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_)
-    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();
 }
 
-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 : simix_global->process_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& kv : simix_global->process_list) {
-    if (filter(kv.second->iface()))
-      actor_list.push_back(kv.second->iface());
+  for (auto const& kv : simix_global->process_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
 {
   /* Clean IO before the run */
   fflush(stdout);
@@ -302,12 +341,12 @@ void Engine::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();
 }
 /** @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();
@@ -328,19 +367,19 @@ 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()
+std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints() const
 {
   std::vector<kernel::routing::NetPoint*> res;
   for (auto const& kv : pimpl->netpoints_)
@@ -351,15 +390,13 @@ 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::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(kernel::routing::NetPoint* point)
 {
-  simix::simcall([this, point] {
+  kernel::actor::simcall([this, point] {
     pimpl->netpoints_.erase(point->get_name());
     delete point;
   });
@@ -373,6 +410,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
 
@@ -394,11 +448,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);
 }
@@ -406,3 +460,8 @@ double simgrid_get_clock()
 {
   return simgrid::s4u::Engine::get_clock();
 }
+
+int simgrid_get_actor_count() // XBT_ATTRIB_DEPRECATED_v330
+{
+  return simgrid::s4u::Engine::get_instance()->get_actor_count();
+}