rename the plugins from the command line, and document it

[simgrid.git] / src / s4u / s4u_Engine.cpp

diff --git a/src/s4u/s4u_Engine.cpp b/src/s4u/s4u_Engine.cpp
index 4daf853..ab520f2 100644 (file)
--- a/src/s4u/s4u_Engine.cpp
+++ b/src/s4u/s4u_Engine.cpp
@@ -25,9 +25,9 @@ namespace simgrid {
 namespace s4u {
 xbt::signal<void()> on_platform_creation;
 xbt::signal<void()> on_platform_created;
-xbt::signal<void()> onSimulationEnd;
-xbt::signal<void(double)> onTimeAdvance;
-xbt::signal<void(void)> onDeadlock;
+xbt::signal<void()> on_simulation_end;
+xbt::signal<void(double)> on_time_advance;
+xbt::signal<void(void)> on_deadlock;
 
 Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
 
@@ -48,7 +48,8 @@ Engine::~Engine()
   s4u::Engine::instance_ = nullptr;
 }
 
-Engine* Engine::getInstance()
+/** @brief Retrieve the engine singleton */
+Engine* Engine::get_instance()
 {
   if (s4u::Engine::instance_ == nullptr)
     return new Engine(0, nullptr);
@@ -187,18 +188,25 @@ void Engine::run()
   }
 }
 
-s4u::NetZone* Engine::getNetRoot()
+/** @brief Retrieve the root netzone, containing all others */
+s4u::NetZone* Engine::get_netzone_root()
 {
-  return pimpl->netRoot_;
+  return pimpl->netzone_root_;
+}
+/** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
+void Engine::set_netzone_root(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);
 }
 
-static s4u::NetZone* netzoneByNameRecursive(s4u::NetZone* current, const char* name)
+static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, const char* name)
 {
   if (not strcmp(current->get_cname(), name))
     return current;
 
   for (auto const& elem : *(current->getChildren())) {
-    simgrid::s4u::NetZone* tmp = netzoneByNameRecursive(elem, name);
+    simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name);
     if (tmp != nullptr) {
       return tmp;
     }
@@ -207,13 +215,13 @@ static s4u::NetZone* netzoneByNameRecursive(s4u::NetZone* current, const char* n
 }
 
 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
-NetZone* Engine::getNetzoneByNameOrNull(const char* name)
+NetZone* Engine::netzone_by_name_or_null(const char* name)
 {
-  return netzoneByNameRecursive(getNetRoot(), 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::getNetpointByNameOrNull(std::string name)
+simgrid::kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(std::string name)
 {
   auto netp = pimpl->netpoints_.find(name);
   return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
@@ -225,29 +233,61 @@ void Engine::getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*>* l
   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;
+  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)
 {
-  // simgrid::simix::kernelImmediate([&]{ FIXME: this segfaults in set_thread
+  // simgrid::simix::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)
 {
-  simgrid::simix::kernelImmediate([this, point] {
+  simgrid::simix::simcall([this, point] {
     pimpl->netpoints_.erase(point->get_name());
     delete point;
   });
 }
 
-bool Engine::isInitialized()
+bool Engine::is_initialized()
 {
   return Engine::instance_ != nullptr;
 }
-void Engine::setConfig(std::string str)
+void Engine::set_config(std::string str)
 {
   simgrid::config::set_parse(std::move(str));
 }
 } // namespace s4u
 } // namespace simgrid
+
+/* **************************** Public C interface *************************** */
+void sg_engine_load_platform(const char* file)
+{
+  simgrid::s4u::Engine::get_instance()->load_platform(file);
+}
+
+void sg_engine_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**))
+{
+  simgrid::s4u::Engine::get_instance()->register_function(name, code);
+}
+void sg_engine_register_default(int (*code)(int, char**))
+{
+  simgrid::s4u::Engine::get_instance()->register_default(code);
+}
+double sg_engine_get_clock()
+{
+  return simgrid::s4u::Engine::get_clock();
+}