Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove deprecated features for next release (3.32).
[simgrid.git] / src / s4u / s4u_Engine.cpp
index 04f5166..9f4dd40 100644 (file)
@@ -1,27 +1,21 @@
 /* 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>
+
+#define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v333)
+#include <simgrid/simix.h>
+
 #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/kernel/actor/ActorImpl.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>
@@ -35,6 +29,7 @@ namespace simgrid {
 namespace s4u {
 xbt::signal<void()> Engine::on_platform_creation;
 xbt::signal<void()> Engine::on_platform_created;
+xbt::signal<void()> Engine::on_simulation_start;
 xbt::signal<void()> Engine::on_simulation_end;
 xbt::signal<void(double)> Engine::on_time_advance;
 xbt::signal<void(void)> Engine::on_deadlock;
@@ -52,28 +47,30 @@ void Engine::initialize(int* argc, char** argv)
   kernel::actor::create_maestro(maestro_code);
 }
 
-Engine::Engine(std::string name) : pimpl(new kernel::EngineImpl(nullptr, nullptr))
+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(argc, argv))
+Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
 {
   initialize(argc, argv);
 }
 
 Engine::~Engine()
 {
-  pimpl->shutdown();
+  kernel::EngineImpl::shutdown();
   Engine::instance_ = nullptr;
 }
 
 /** @brief Retrieve the engine singleton */
 Engine* Engine::get_instance()
 {
-  return get_instance(nullptr, nullptr);
+  int argc   = 0;
+  char* argv = nullptr;
+  return get_instance(&argc, &argv);
 }
 Engine* Engine::get_instance(int* argc, char** argv)
 {
@@ -84,7 +81,7 @@ Engine* Engine::get_instance(int* argc, char** argv)
   return Engine::instance_;
 }
 
-void Engine::shutdown()
+void Engine::shutdown() // XBT_ATTRIB_DEPRECATED_v335
 {
   delete Engine::instance_;
 }
@@ -92,16 +89,16 @@ void Engine::shutdown()
 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_answered([this, &model, &dependencies] { pimpl->add_model(std::move(model), dependencies); });
 }
 
 const std::vector<simgrid::kernel::resource::Model*>& Engine::get_all_models() const
@@ -121,16 +118,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 */
@@ -161,12 +156,12 @@ void Engine::register_default(const std::function<void(int, char**)>& code)
 }
 void Engine::register_default(const kernel::actor::ActorCodeFactory& code)
 {
-  simgrid::kernel::actor::simcall([this, &code]() { pimpl->register_default(code); });
+  simgrid::kernel::actor::simcall_answered([this, &code]() { pimpl->register_default(code); });
 }
 
 void Engine::register_function(const std::string& name, const kernel::actor::ActorCodeFactory& code)
 {
-  simgrid::kernel::actor::simcall([this, name, &code]() { pimpl->register_function(name, code); });
+  simgrid::kernel::actor::simcall_answered([this, name, &code]() { pimpl->register_function(name, code); });
 }
 
 /** Load a deployment file and launch the actors that it contains
@@ -265,7 +260,7 @@ Link* Engine::link_by_name_or_null(const std::string& name) const
 Mailbox* Engine::mailbox_by_name_or_create(const std::string& name) const
 {
   /* two actors may have pushed the same mbox_create simcall at the same time */
-  kernel::activity::MailboxImpl* mbox = kernel::actor::simcall([&name, this] {
+  kernel::activity::MailboxImpl* mbox = kernel::actor::simcall_answered([&name, this] {
     auto m = pimpl->mailboxes_.emplace(name, nullptr);
     if (m.second) {
       m.first->second = new kernel::activity::MailboxImpl(name);
@@ -338,21 +333,25 @@ 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
+{
+  static bool callback_called = false;
+  if (not callback_called) {
+    on_simulation_start();
+    callback_called = true;
+  }
   /* Clean IO before the run */
   fflush(stdout);
   fflush(stderr);
 
-  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 */
@@ -416,13 +415,13 @@ std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints() const
 /** @brief Register a new netpoint to the system */
 void Engine::netpoint_register(kernel::routing::NetPoint* point)
 {
-  simgrid::kernel::actor::simcall([this, point] { pimpl->netpoints_[point->get_name()] = point; });
+  simgrid::kernel::actor::simcall_answered([this, point] { pimpl->netpoints_[point->get_name()] = point; });
 }
 
 /** @brief Unregister a given netpoint */
 void Engine::netpoint_unregister(kernel::routing::NetPoint* point)
 {
-  kernel::actor::simcall([this, point] {
+  kernel::actor::simcall_answered([this, point] {
     pimpl->netpoints_.erase(point->get_name());
     delete point;
   });
@@ -453,11 +452,13 @@ void Engine::set_config(const std::string& name, const std::string& value)
   config::set_value(name.c_str(), value);
 }
 
-Engine* Engine::set_default_comm_data_copy_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t))
+Engine* Engine::set_default_comm_data_copy_callback(
+    const std::function<void(kernel::activity::CommImpl*, void*, size_t)>& callback)
 {
   kernel::activity::CommImpl::set_copy_data_callback(callback);
   return this;
 }
+
 } // namespace s4u
 } // namespace simgrid
 
@@ -479,6 +480,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);
@@ -492,15 +497,10 @@ 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();
-}
-
 void simgrid_set_maestro(void (*code)(void*), void* data)
 {
 #ifdef _WIN32
-  XBT_INFO("WARNING, SIMIX_set_maestro is believed to not work on windows. Please help us investigating this issue if "
+  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);