X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f290b76551f7120a2f5c1f4778613ea4e4b32717..16f1630ae434e729cbe0b24fe2f19c8f67f774cd:/src/s4u/s4u_Engine.cpp

diff --git a/src/s4u/s4u_Engine.cpp b/src/s4u/s4u_Engine.cpp
index aa28e1a034..ba96fac442 100644
--- a/src/s4u/s4u_Engine.cpp
+++ b/src/s4u/s4u_Engine.cpp
@@ -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"
@@ -28,44 +29,43 @@ 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(s4u::Engine::instance_ == nullptr,
-             "It is currently forbidden to create more than one instance of s4u::Engine");
+  xbt_assert(Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine");
   TRACE_global_init();
   SIMIX_global_init(argc, argv);
 
-  s4u::Engine::instance_ = this;
+  Engine::instance_ = this;
 }
 
 Engine::~Engine()
 {
   delete pimpl;
-  s4u::Engine::instance_ = nullptr;
+  Engine::instance_ = nullptr;
 }
 
 /** @brief Retrieve the engine singleton */
 Engine* Engine::get_instance()
 {
-  if (s4u::Engine::instance_ == nullptr) {
+  if (Engine::instance_ == nullptr) {
     auto e = new Engine(0, nullptr);
-    xbt_assert(s4u::Engine::instance_ == e);
+    xbt_assert(Engine::instance_ == e);
   }
-  return s4u::Engine::instance_;
+  return Engine::instance_;
 }
 
 void Engine::shutdown()
 {
-  delete s4u::Engine::instance_;
-  s4u::Engine::instance_ = nullptr;
+  delete Engine::instance_;
+  Engine::instance_ = nullptr;
 }
 
 double Engine::get_clock()
@@ -74,23 +74,18 @@ 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(std::string platf)
+void Engine::load_platform(const std::string& platf)
 {
   double start = xbt_os_time();
   try {
     parse_platform_file(platf);
-  } catch (xbt_ex& e) {
+  } catch (const Exception& e) {
     xbt_die("Error while loading %s: %s", platf.c_str(), e.what());
   }
 
@@ -98,23 +93,36 @@ void Engine::load_platform(std::string platf)
   XBT_DEBUG("PARSE TIME: %g", (end - start));
 }
 
-void Engine::register_function(std::string name, int (*code)(int, char**))
+/** 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**))
 {
   SIMIX_function_register(name, code);
 }
-void Engine::register_function(std::string name, void (*code)(std::vector<std::string>))
+/** 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>))
 {
   SIMIX_function_register(name, code);
 }
+/** 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(int (*code)(int, char**))
 {
   SIMIX_function_register_default(code);
 }
-void Engine::load_deployment(std::string deploy)
+/** 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)
 {
   SIMIX_launch_application(deploy);
 }
-/** @brief Returns the amount of hosts in the platform */
+/** Returns the amount of hosts in the platform */
 size_t Engine::get_host_count()
 {
   return pimpl->hosts_.size();
@@ -128,7 +136,7 @@ std::vector<Host*> Engine::get_all_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)
 {
   std::vector<Host*> hosts;
   for (auto const& kv : pimpl->hosts_) {
@@ -139,12 +147,12 @@ std::vector<Host*> Engine::get_filtered_hosts(std::function<bool(Host*)> filter)
   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);
 }
@@ -153,7 +161,7 @@ void Engine::host_unregister(std::string name)
  *
  *  @throw std::invalid_argument if the searched host does not exist.
  */
-simgrid::s4u::Host* Engine::host_by_name(std::string name)
+Host* Engine::host_by_name(const std::string& name)
 {
   if (pimpl->hosts_.find(name) == pimpl->hosts_.end())
     throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
@@ -161,7 +169,7 @@ simgrid::s4u::Host* Engine::host_by_name(std::string name)
 }
 
 /** @brief Find a host from its name (or nullptr if that host does not exist) */
-simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
+Host* Engine::host_by_name_or_null(const std::string& name)
 {
   auto host = pimpl->hosts_.find(name);
   return host == pimpl->hosts_.end() ? nullptr : host->second;
@@ -171,7 +179,7 @@ simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
  *
  *  @throw std::invalid_argument if the searched link does not exist.
  */
-simgrid::s4u::Link* Engine::link_by_name(std::string name)
+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);
@@ -180,18 +188,18 @@ simgrid::s4u::Link* Engine::link_by_name(std::string name)
 }
 
 /** @brief Find an link from its name (or nullptr if that link does not exist) */
-simgrid::s4u::Link* Engine::link_by_name_or_null(std::string name)
+Link* Engine::link_by_name_or_null(const std::string& name)
 {
   auto link = pimpl->links_.find(name);
   return link == pimpl->links_.end() ? nullptr : link->second;
 }
 
-void Engine::link_register(std::string name, simgrid::s4u::Link* link)
+void Engine::link_register(const std::string& name, Link* link)
 {
   pimpl->links_[name] = link;
 }
 
-void Engine::link_unregister(std::string name)
+void Engine::link_unregister(const std::string& name)
 {
   pimpl->links_.erase(name);
 }
@@ -215,7 +223,7 @@ std::vector<Storage*> Engine::get_all_storages()
  *
  *  @throw std::invalid_argument if the searched storage does not exist.
  */
-simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
+Storage* Engine::storage_by_name(const std::string& name)
 {
   if (pimpl->storages_.find(name) == pimpl->storages_.end())
     throw std::invalid_argument(std::string("Storage not found: ") + name);
@@ -224,18 +232,18 @@ simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
 }
 
 /** @brief Find a storage from its name (or nullptr if that storage does not exist) */
-simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name)
+Storage* Engine::storage_by_name_or_null(const std::string& name)
 {
   auto storage = pimpl->storages_.find(name);
   return storage == pimpl->storages_.end() ? nullptr : storage->second;
 }
 
-void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage)
+void Engine::storage_register(const std::string& name, Storage* storage)
 {
   pimpl->storages_[name] = storage;
 }
 
-void Engine::storage_unregister(std::string name)
+void Engine::storage_unregister(const std::string& name)
 {
   pimpl->storages_.erase(name);
 }
@@ -255,7 +263,7 @@ std::vector<Link*> Engine::get_all_links()
   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)
 {
   std::vector<Link*> filtered_list;
   for (auto const& kv : pimpl->links_)
@@ -279,7 +287,7 @@ std::vector<ActorPtr> Engine::get_all_actors()
   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)
 {
   std::vector<ActorPtr> actor_list;
   for (auto& kv : simix_global->process_list) {
@@ -314,13 +322,13 @@ void Engine::set_netzone_root(s4u::NetZone* netzone)
   pimpl->netzone_root_ = netzone->get_impl();
 }
 
-static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, std::string name)
+static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name)
 {
   if (current->get_name() == name)
     return current;
 
   for (auto const& elem : current->get_children()) {
-    simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name);
+    NetZone* tmp = netzone_by_name_recursive(elem, name);
     if (tmp != nullptr) {
       return tmp;
     }
@@ -329,43 +337,38 @@ static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, std::strin
 }
 
 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
-NetZone* Engine::netzone_by_name_or_null(std::string name)
+NetZone* Engine::netzone_by_name_or_null(const std::string& name)
 {
   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)
 {
   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)
+std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints()
 {
-  for (auto const& kv : pimpl->netpoints_)
-    list->push_back(kv.second);
-}
-std::vector<simgrid::kernel::routing::NetPoint*> Engine::get_all_netpoints()
-{
-  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
+  // simgrid::kernel::actor::simcall([&]{ FIXME: this segfaults in set_thread
   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;
   });
@@ -375,9 +378,9 @@ bool Engine::is_initialized()
 {
   return Engine::instance_ != nullptr;
 }
-void Engine::set_config(std::string str)
+void Engine::set_config(const std::string& str)
 {
-  simgrid::config::set_parse(std::move(str));
+  config::set_parse(str);
 }
 } // namespace s4u
 } // namespace simgrid
@@ -412,3 +415,7 @@ double simgrid_get_clock()
 {
   return simgrid::s4u::Engine::get_clock();
 }
+int simgrid_get_actor_count()
+{
+  return simgrid::s4u::Engine::get_instance()->get_actor_count();
+}