Cosmetics to please codefactor.io.

[simgrid.git] / include / simgrid / s4u / Engine.hpp

diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp
index 2a88c38..43be0eb 100644 (file)
--- a/include/simgrid/s4u/Engine.hpp
+++ b/include/simgrid/s4u/Engine.hpp
@@ -1,4 +1,4 @@
-/* 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. */
@@ -13,6 +13,7 @@
 #include <simgrid/kernel/resource/Model.hpp>
 #include <simgrid/s4u/NetZone.hpp>
 
+#include <set>
 #include <string>
 #include <utility>
 #include <vector>
@@ -43,9 +44,12 @@ public:
   /** Finalize the default engine and all its dependencies */
   void shutdown();
 
-  /** Run the simulation after initialization */
+  /** Run the simulation until its end */
   void run() const;
 
+  /** Run the simulation until the specified date */
+  void run_until(double max_date) const;
+
   /** @brief Retrieve the simulation time (in seconds) */
   static double get_clock();
   /** @brief Retrieve the engine singleton */
@@ -54,6 +58,7 @@ public:
   static bool has_instance() { return instance_ != nullptr; }
 
   void load_platform(const std::string& platf) const;
+  void seal_platform() const;
 
   void register_function(const std::string& name, const std::function<void(int, char**)>& code);
   void register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code);
@@ -80,6 +85,9 @@ public:
     register_function(name, code_factory);
   }
 
+  /** If non-null, the provided set will be filled with all activities that fail to start because of a veto */
+  void track_vetoed_activities(std::set<Activity*>* vetoed_activities) const;
+
   void load_deployment(const std::string& deploy) const;
 
 protected:
@@ -90,7 +98,7 @@ protected:
   friend kernel::routing::NetPoint;
   friend kernel::routing::NetZoneImpl;
   friend kernel::resource::HostImpl;
-  friend kernel::resource::LinkImpl;
+  friend kernel::resource::StandardLinkImpl;
   void host_register(const std::string& name, Host* host);
   void host_unregister(const std::string& name);
   void link_register(const std::string& name, const Link* link);
@@ -187,30 +195,41 @@ public:
   static void set_config(const std::string& name, const std::string& value);
 
   Engine* set_default_comm_data_copy_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t));
-  /** Callback fired when the platform is created (ie, the xml file parsed),
-   * right before the actual simulation starts. */
-  static xbt::signal<void()> on_platform_created;
 
-  /** Callback fired when the platform is about to be created
+  /** Add a callback fired when the platform is created (ie, the xml file parsed),
+   * right before the actual simulation starts. */
+  static void on_platform_created_cb(const std::function<void()>& cb) { on_platform_created.connect(cb); }
+  /** Add a callback fired when the platform is about to be created
    * (ie, after any configuration change and just before the resource creation) */
-  static xbt::signal<void()> on_platform_creation;
+  static void on_platform_creation_cb(const std::function<void()>& cb) { on_platform_creation.connect(cb); }
+  /** Add a callback fired when the main simulation loop ends, just before the end of Engine::run() */
+  static void on_simulation_end_cb(const std::function<void()>& cb) { on_simulation_end.connect(cb); }
 
-  /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
-  static xbt::signal<void()> on_simulation_end;
+  /** Add a callback fired when the time jumps into the future */
+  static void on_time_advance_cb(const std::function<void(double)>& cb) { on_time_advance.connect(cb); }
 
-  /** Callback fired when the time jumps into the future */
-  static xbt::signal<void(double)> on_time_advance;
+  /** Add a callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each
+   * actor is also executed on deadlock. */
+  static void on_deadlock_cb(const std::function<void(void)>& cb) { on_deadlock.connect(cb); }
 
-  /** Callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each actor
-   * is also executed on deadlock. */
-  static xbt::signal<void(void)> on_deadlock;
+#ifndef DOXYGEN
+  /* FIXME signals should be private */
+  static xbt::signal<void()> on_platform_created;
+  static xbt::signal<void()> on_platform_creation;
+#endif
 
 private:
+  static xbt::signal<void()> on_simulation_end;
+  static xbt::signal<void(double)> on_time_advance;
+  static xbt::signal<void(void)> on_deadlock;
   kernel::EngineImpl* const pimpl;
   static Engine* instance_;
   void initialize(int* argc, char** argv);
 };
 
+std::vector<ActivityPtr> create_DAG_from_dot(const std::string& filename);
+std::vector<ActivityPtr> create_DAG_from_DAX(const std::string& filename);
+
 #ifndef DOXYGEN /* Internal use only, no need to expose it */
 template <class T>
 XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector<T*>* whereto)