Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
deprecate Engine::shutdown()
[simgrid.git] / src / s4u / s4u_Engine.cpp
index 7ec9933..5fc537a 100644 (file)
@@ -1,26 +1,18 @@
 /* s4u::Engine Simulation Engine and global functions. */
 
-/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2022. 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/simix.h"
 #include "src/instr/instr_private.hpp"
 #include "src/kernel/EngineImpl.hpp"
-#include "src/kernel/activity/CommImpl.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>
@@ -28,6 +20,8 @@
 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;
@@ -42,9 +36,11 @@ 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;
-  kernel::EngineImpl::instance_ = pimpl;
   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::Engine(std::string name) : pimpl(new kernel::EngineImpl())
@@ -61,39 +57,44 @@ Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
 
 Engine::~Engine()
 {
-  delete pimpl;
+  kernel::EngineImpl::shutdown();
   Engine::instance_ = nullptr;
 }
 
 /** @brief Retrieve the engine singleton */
 Engine* Engine::get_instance()
+{
+  int argc   = 0;
+  char* argv = nullptr;
+  return get_instance(&argc, &argv);
+}
+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()
+void Engine::shutdown() // XBT_ATTRIB_DEPRECATED_v335
 {
   delete Engine::instance_;
-  Engine::instance_ = nullptr;
 }
 
 double Engine::get_clock()
 {
   if (MC_is_active() || MC_record_replay_is_active()) {
-    return MC_process_clock_get(SIMIX_process_self());
+    return MC_process_clock_get(kernel::actor::ActorImpl::self());
   } else {
-    return surf_get_clock();
+    return kernel::EngineImpl::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); });
+  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
@@ -113,16 +114,14 @@ void Engine::load_platform(const std::string& platf) const
   pimpl->load_platform(platf);
 }
 
-void Engine::register_function(const std::string& name, int (*code)(int, char**)) // XBT_ATTRIB_DEPRECATED_v330
-{
-  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_v330
+/**
+ * @brief Seals the platform, finishing the creation of its resources.
+ *
+ * This method is optional. The seal() is done automatically when you call Engine::run.
+ */
+void Engine::seal_platform() const
 {
-  register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
+  pimpl->seal_platform();
 }
 
 /** Registers the main function of an actor that will be launched from the deployment file */
@@ -330,12 +329,10 @@ std::vector<ActorPtr> Engine::get_filtered_actors(const std::function<bool(Actor
 
 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();
-
+  run_until(-1);
+}
+void Engine::run_until(double max_date) const
+{
   /* Clean IO before the run */
   fflush(stdout);
   fflush(stderr);
@@ -343,10 +340,15 @@ void Engine::run() const
   if (MC_is_active()) {
     MC_run();
   } else {
-    pimpl->run();
+    pimpl->run(max_date);
   }
 }
 
+void Engine::track_vetoed_activities(std::set<Activity*>* vetoed_activities) const
+{
+  Activity::set_vetoed_activities(vetoed_activities);
+}
+
 /** @brief Retrieve the root netzone, containing all others */
 s4u::NetZone* Engine::get_netzone_root() const
 {
@@ -450,13 +452,19 @@ Engine* Engine::set_default_comm_data_copy_callback(void (*callback)(kernel::act
   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)
 {
@@ -471,6 +479,10 @@ void simgrid_run()
 {
   simgrid::s4u::Engine::get_instance()->run();
 }
+void simgrid_run_until(double max_date)
+{
+  simgrid::s4u::Engine::get_instance()->run_until(max_date);
+}
 void simgrid_register_function(const char* name, void (*code)(int, char**))
 {
   simgrid::s4u::Engine::get_instance()->register_function(name, code);
@@ -484,7 +496,15 @@ double simgrid_get_clock()
   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);
 }