add user friendly wrapper to set priorities on I/Os

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

diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp
index d293c9f5f11323300822b85e0ad3bcb47b263515..7856a1f48e112f889fa0d897b3ef01c92a9bec0b 100644 (file)
--- a/include/simgrid/s4u/Engine.hpp
+++ b/include/simgrid/s4u/Engine.hpp
@@ -24,9 +24,13 @@ namespace s4u {
  * This is a singleton containing all the main functions of the simulation.
  */
 class XBT_PUBLIC Engine {
+#ifndef DOXYGEN
   friend simgrid::kernel::EngineImpl;
+#endif
 
 public:
+  /** Constructor, taking only the name of your main function */
+  explicit Engine(std::string name);
   /** Constructor, taking the command line parameters of your main function */
   explicit Engine(int* argc, char** argv);
   /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
@@ -37,7 +41,7 @@ public:
 #endif
 
   /** Finalize the default engine and all its dependencies */
-  static void shutdown();
+  void shutdown();
 
   /** Run the simulation after initialization */
   void run() const;
@@ -46,16 +50,11 @@ public:
   static double get_clock();
   /** @brief Retrieve the engine singleton */
   static s4u::Engine* get_instance();
+  static s4u::Engine* get_instance(int* argc, char** argv);
+  static bool has_instance() { return instance_ != nullptr; }
 
   void load_platform(const std::string& platf) const;
 
-#ifndef DOXYGEN
-  XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_function(
-      const std::string& name, int (*code)(int, char**));
-  XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_default(
-      int (*code)(int, char**));
-#endif
-
   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);
   void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
@@ -85,6 +84,7 @@ public:
 
 protected:
 #ifndef DOXYGEN
+  friend surf::HostImpl;
   friend Host;
   friend Link;
   friend Disk;
@@ -116,14 +116,28 @@ public:
   std::vector<Link*> get_all_links() const;
   std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter) const;
   Link* link_by_name(const std::string& name) const;
+  /**
+   * @brief Find a split-duplex link from its name.
+   * @throw std::invalid_argument if the searched link does not exist.
+   */
+  SplitDuplexLink* split_duplex_link_by_name(const std::string& name) const;
   Link* link_by_name_or_null(const std::string& name) const;
 
+  Mailbox* mailbox_by_name_or_create(const std::string& name) const;
+
   size_t get_actor_count() const;
   std::vector<ActorPtr> get_all_actors() const;
   std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const;
 
   std::vector<kernel::routing::NetPoint*> get_all_netpoints() const;
   kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name) const;
+  /**
+   * @brief Get netpoint by its name
+   *
+   * @param name Netpoint name
+   * @throw std::invalid_argument if netpoint doesn't exist
+   */
+  kernel::routing::NetPoint* netpoint_by_name(const std::string& name) const;
 
   NetZone* get_netzone_root() const;
   void set_netzone_root(const NetZone* netzone);
@@ -133,10 +147,14 @@ public:
   /**
    * @brief Add a model to engine list
    *
-   * @param type Model type (network, disk, etc)
-   * @param model Pointer to model
+   * @param model        Pointer to model
+   * @param dependencies List of dependencies for this model (optional)
    */
-  void add_model(simgrid::kernel::resource::Model::Type type, std::unique_ptr<simgrid::kernel::resource::Model> model);
+  void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
+                 const std::vector<kernel::resource::Model*>& dependencies = {});
+
+  /** @brief Get list of all models managed by this engine */
+  const std::vector<simgrid::kernel::resource::Model*>& get_all_models() const;
 
   /** @brief Retrieves all netzones of the type indicated by the template argument */
   template <class T> std::vector<T*> get_filtered_netzones() const
@@ -148,6 +166,8 @@ public:
     return res;
   }
 
+  kernel::EngineImpl* get_impl() const { return pimpl; }
+
   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
   static bool is_initialized();
   /** @brief set a configuration variable
@@ -166,6 +186,7 @@ public:
   static void set_config(const std::string& name, double value);
   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;
@@ -187,6 +208,7 @@ public:
 private:
   kernel::EngineImpl* const pimpl;
   static Engine* instance_;
+  void initialize(int* argc, char** argv);
 };
 
 #ifndef DOXYGEN /* Internal use only, no need to expose it */