use signals a bit more to create tracing stuff

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

diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp
index 52224c1..c587b98 100644 (file)
--- a/include/simgrid/s4u/Engine.hpp
+++ b/include/simgrid/s4u/Engine.hpp
@@ -42,6 +42,8 @@ public:
 
   /** Registers the main function of an actor that will be launched from the deployment file */
   void register_function(const char* name, int (*code)(int, char**));
+  // FIXME: provide a register_function(std::string, void (*code)(int, char**)) and deprecate the int returning one
+  // FIXME: provide a register_function(std::string, std::vector<std::string>)
 
   /** Registers a function as the default main function of actors
    *
@@ -50,38 +52,57 @@ public:
    */
   void register_default(int (*code)(int, char**));
 
+  template <class F> void register_actor(const char* name)
+  {
+    simgrid::simix::register_function(name, [](std::vector<std::string> args) {
+      return simgrid::simix::ActorCode([args] {
+        F code(std::move(args));
+        code();
+      });
+    });
+  }
+
+  template <class F> void register_actor(const char* name, F code)
+  {
+    simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
+      return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
+    });
+  }
+
   /** @brief Load a deployment file and launch the actors that it contains */
   void load_deployment(const char* deploy);
 
 protected:
   friend s4u::Host;
   friend s4u::Storage;
-  void add_host(std::string name, simgrid::s4u::Host* host);
-  void del_host(std::string name);
-  void add_storage(std::string name, simgrid::s4u::Storage* storage);
-  void del_storage(std::string name);
+  friend kernel::routing::NetPoint;
+  friend kernel::routing::NetZoneImpl;
+  void host_register(std::string name, simgrid::s4u::Host* host);
+  void host_unregister(std::string name);
+  void storage_register(std::string name, simgrid::s4u::Storage* storage);
+  void storage_unregister(std::string name);
+  void netpoint_register(simgrid::kernel::routing::NetPoint* card);
+  void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
 
 public:
-  simgrid::s4u::Host* host_by_name(std::string name);
-  simgrid::s4u::Host* host_by_name_or_null(std::string name);
-  simgrid::s4u::Storage* storage_by_name(std::string name);
-  simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
-
   size_t get_host_count();
-  void get_host_list(std::vector<Host*>* whereTo);
   std::vector<Host*> get_all_hosts();
+  simgrid::s4u::Host* host_by_name(std::string name);
+  simgrid::s4u::Host* host_by_name_or_null(std::string name);
 
-  size_t getLinkCount();
-  void getLinkList(std::vector<Link*> * list);
-  std::vector<Link*> getAllLinks();
+  size_t get_link_count();
+  std::vector<Link*> get_all_links();
 
-  std::vector<Storage*> getAllStorages();
+  size_t get_storage_count();
+  std::vector<Storage*> get_all_storages();
+  simgrid::s4u::Storage* storage_by_name(std::string name);
+  simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
 
   /** @brief Run the simulation */
   void run();
 
   /** @brief Retrieve the simulation time */
-  static double getClock();
+  static double get_clock();
 
   /** @brief Retrieve the engine singleton */
   static s4u::Engine* getInstance();
@@ -97,25 +118,6 @@ public:
   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
   simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
   void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
-  void netpointRegister(simgrid::kernel::routing::NetPoint * card);
-  void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
-
-  template <class F> void register_actor(const char* name)
-  {
-    simgrid::simix::register_function(name, [](std::vector<std::string> args) {
-      return simgrid::simix::ActorCode([args] {
-        F code(std::move(args));
-        code();
-      });
-    });
-  }
-
-  template <class F> void register_actor(const char* name, F code)
-  {
-    simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
-      return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
-    });
-  }
 
   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
   static bool isInitialized();
@@ -142,6 +144,17 @@ public:
   {
     register_default(code);
   }
+  template <class F>
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name)
+  {
+    register_actor<F>(name);
+  }
+  template <class F>
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const char* name, F code)
+  {
+    register_actor<F>(name, code);
+  }
+
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const char* deploy)
   {
     load_deployment(deploy);
@@ -167,14 +180,25 @@ public:
   }
 
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_count()") size_t getHostCount() { return get_host_count(); }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_host_list()") void getHostList(std::vector<Host*>* whereTo)
-  {
-    get_host_list(whereTo);
-  }
+  XBT_ATTRIB_DEPRECATED_v322("Engine::getHostList() is deprecated in favor of Engine::get_all_hosts(). Please switch "
+                             "before v3.22") void getHostList(std::vector<Host*>* whereTo);
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_hosts()") std::vector<Host*> getAllHosts()
   {
     return get_all_hosts();
   }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_count()") size_t getLinkCount() { return get_link_count(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()")
+      XBT_ATTRIB_DEPRECATED_v322("Engine::getLinkList() is deprecated in favor of Engine::get_all_links(). Please "
+                                 "switch before v3.22") void getLinkList(std::vector<Link*>* list);
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_link_list()") std::vector<Link*> getAllLinks()
+  {
+    return get_all_links();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_storages()") std::vector<Storage*> getAllStorages()
+  {
+    return get_all_storages();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
 
   simgrid::kernel::EngineImpl* pimpl;
 
@@ -184,7 +208,10 @@ private:
 
 /** Callback fired when the platform is created (ie, the xml file parsed),
  * right before the actual simulation starts. */
-extern XBT_PUBLIC xbt::signal<void()> onPlatformCreated;
+extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
+
+/** Callback fired when the platform is about to be created (ie, just before the xml file is parsed) */
+extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
 
 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 extern XBT_PUBLIC xbt::signal<void()> onSimulationEnd;