X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/19e4a01d6e38e856dafa1a08942143a8ec7f5e34..5ab070a2054636f5dcf5f0b56d691b089c5d16e4:/include/simgrid/s4u/Engine.hpp

diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp
index 805a309301..ea53d1c8e4 100644
--- a/include/simgrid/s4u/Engine.hpp
+++ b/include/simgrid/s4u/Engine.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2019. 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. */
@@ -6,127 +6,191 @@
 #ifndef SIMGRID_S4U_ENGINE_HPP
 #define SIMGRID_S4U_ENGINE_HPP
 
-#include <string>
-#include <utility>
-#include <vector>
-
 #include <xbt/base.h>
 #include <xbt/functional.hpp>
 
+#include <simgrid/forward.h>
 #include <simgrid/simix.hpp>
 
-#include <simgrid/s4u/forward.hpp>
+#include <simgrid/s4u/NetZone.hpp>
+
+#include <string>
+#include <utility>
+#include <vector>
 
 namespace simgrid {
-namespace kernel {
-class EngineImpl;
-}
 namespace s4u {
 /** @brief Simulation engine
  *
  * This class is an interface to the simulation engine.
  */
-XBT_PUBLIC_CLASS Engine
-{
+class XBT_PUBLIC Engine {
 public:
   /** Constructor, taking the command line parameters of your main function */
-  Engine(int* argc, char** argv);
+  explicit Engine(int* argc, char** argv);
+  /** Currently, only one instance is allowed to exist. This is why you can't copy or move it */
+  Engine(const Engine&) = delete;
+  Engine(Engine&&)      = delete;
 
   ~Engine();
   /** Finalize the default engine and all its dependencies */
   static void shutdown();
 
+  /** @brief Run the simulation */
+  void run();
+
+  /** @brief Retrieve the simulation time (in seconds) */
+  static double get_clock();
+  /** @brief Retrieve the engine singleton */
+  static s4u::Engine* get_instance();
+
   /** @brief Load a platform file describing the environment
    *
    * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
    * Some examples can be found in the directory examples/platforms.
    */
-  void loadPlatform(const char* platf);
+  void load_platform(const std::string& platf);
 
   /** Registers the main function of an actor that will be launched from the deployment file */
-  void registerFunction(const char* name, int (*code)(int, char**));
+  void register_function(const std::string& name, int (*code)(int, char**));
+  /** Registers the main function of an actor that will be launched from the deployment file */
+  void register_function(const std::string& name, void (*code)(std::vector<std::string>));
 
   /** Registers a function as the default main function of actors
    *
    * It will be used as fallback when the function requested from the deployment file was not registered.
-   * It is used for trace-based simulations (see examples/msg/actions).
+   * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
    */
-  void registerDefault(int (*code)(int, char**));
-
-  /** @brief Load a deployment file and launch the actors that it contains */
-  void loadDeployment(const char* deploy);
-
-  size_t getHostCount();
-  void getHostList(std::vector<Host*> * whereTo);
-  size_t getLinkCount();
-  void getLinkList(std::vector<Link*> * list);
-
-  /** @brief Run the simulation */
-  void run();
+  void register_default(int (*code)(int, char**));
 
-  /** @brief Retrieve the simulation time */
-  static double getClock();
-
-  /** @brief Retrieve the engine singleton */
-  static s4u::Engine* getInstance();
-
-  /** @brief Retrieve the root netzone, containing all others */
-  simgrid::s4u::NetZone* getNetRoot();
-
-  /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
-  simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
-
-  /** @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 registerFunction(const char* name)
+  template <class F> void register_actor(const std::string& name)
   {
-    simgrid::simix::registerFunction(name, [](std::vector<std::string> args) {
-      return simgrid::simix::ActorCode([args] {
+    simix::register_function(name, [](std::vector<std::string> args) {
+      return simix::ActorCode([args] {
         F code(std::move(args));
         code();
       });
     });
   }
 
-  template <class F> void registerFunction(const char* name, F code)
+  template <class F> void register_actor(const std::string& name, F code)
   {
-    simgrid::simix::registerFunction(name, [code](std::vector<std::string> args) {
-      return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
+    simix::register_function(name, [code](std::vector<std::string> args) {
+      return simix::ActorCode([code, args] { code(std::move(args)); });
     });
   }
 
-  /** Returns whether SimGrid was initialized yet -- mostly for internal use */
-  static bool isInitialized();
+  /** @brief Load a deployment file and launch the actors that it contains */
+  void load_deployment(const std::string& deploy);
+
+protected:
+#ifndef DOXYGEN
+  friend Host;
+  friend Link;
+  friend Disk;
+  friend Storage;
+  friend kernel::routing::NetPoint;
+  friend kernel::routing::NetZoneImpl;
+  friend kernel::resource::LinkImpl;
+  void host_register(const std::string& name, Host* host);
+  void host_unregister(const std::string& name);
+  void link_register(const std::string& name, Link* link);
+  void link_unregister(const std::string& name);
+  void storage_register(const std::string& name, Storage* storage);
+  void storage_unregister(const std::string& name);
+  void netpoint_register(simgrid::kernel::routing::NetPoint* card);
+  void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
+#endif /*DOXYGEN*/
 
+public:
+  size_t get_host_count();
+  /** @brief Returns the list of all hosts found in the platform */
+  std::vector<Host*> get_all_hosts();
+  std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter);
+  Host* host_by_name(const std::string& name);
+  Host* host_by_name_or_null(const std::string& name);
+
+  size_t get_link_count();
+  std::vector<Link*> get_all_links();
+  std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter);
+  Link* link_by_name(const std::string& name);
+  Link* link_by_name_or_null(const std::string& name);
+
+  size_t get_actor_count();
+  std::vector<ActorPtr> get_all_actors();
+  std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter);
+
+  size_t get_storage_count();
+  std::vector<Storage*> get_all_storages();
+  Storage* storage_by_name(const std::string& name);
+  Storage* storage_by_name_or_null(const std::string& name);
+
+  std::vector<kernel::routing::NetPoint*> get_all_netpoints();
+  kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name);
+
+  NetZone* get_netzone_root();
+  void set_netzone_root(NetZone* netzone);
+
+  NetZone* netzone_by_name_or_null(const std::string& name);
+
+  /** @brief Retrieves all netzones of the type indicated by the template argument */
+  template <class T> std::vector<T*> get_filtered_netzones()
+  {
+    static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
+                  "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
+    std::vector<T*> res;
+    get_filtered_netzones_recursive(get_netzone_root(), &res);
+    return res;
+  }
+
+  /** Returns whether SimGrid was initialized yet -- mostly for internal use */
+  static bool is_initialized();
   /** @brief set a configuration variable
    *
-   * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
+   * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
+   * options).
    *
    * Example:
-   * e->setConfig("host/model","ptask_L07");
+   * e->set_config("host/model:ptask_L07");
    */
-  void setConfig(std::string str);
+  void set_config(const std::string& str);
 
-  simgrid::kernel::EngineImpl* pimpl;
+  /** 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;
 
-private:
-  static s4u::Engine* instance_;
-};
+  /** 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;
+
+  /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
+  static xbt::signal<void()> on_simulation_end;
 
-/** Callback fired when the platform is created (ie, the xml file parsed),
- * right before the actual simulation starts. */
-extern XBT_PRIVATE xbt::signal<void()> onPlatformCreated;
+  /** Callback fired when the time jumps into the future */
+  static xbt::signal<void(double)> on_time_advance;
 
-/** Callback fired when the main simulation loop ends, just before MSG_run (or similar) ends */
-extern XBT_PRIVATE xbt::signal<void()> onSimulationEnd;
+  /** Callback fired when the time cannot advance because of inter-actors deadlock */
+  static xbt::signal<void(void)> on_deadlock;
 
-/** Callback fired when the time jumps into the future */
-extern XBT_PRIVATE xbt::signal<void(double)> onTimeAdvance;
+private:
+  kernel::EngineImpl* const pimpl;
+  static Engine* instance_;
+};
+
+#ifndef DOXYGEN /* Internal use only, no need to expose it */
+template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
+{
+  static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
+                "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
+  for (auto const& elem : current->get_children()) {
+    get_filtered_netzones_recursive(elem, whereto);
+    T* elem_impl = dynamic_cast<T*>(elem->get_impl());
+    if (elem_impl != nullptr)
+      whereto->push_back(elem_impl);
+  }
 }
-} // namespace simgrid::s4u
+#endif
+} // namespace s4u
+} // namespace simgrid
 
 #endif /* SIMGRID_S4U_ENGINE_HPP */