Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Give a p_netcard to simgrid::Host instead of relying on extensions for that
[simgrid.git] / src / surf / network_interface.hpp
index bfd51b0..4cb6b80 100644 (file)
 #include "xbt/dict.h"
 #include "surf_interface.hpp"
 #include "surf_routing.hpp"
+#include "src/surf/PropertyHolder.hpp"
 
 #include "simgrid/link.h"
 
 /***********
  * Classes *
  ***********/
+
+namespace simgrid {
+namespace surf {
+
 class NetworkModel;
 class NetworkAction;
 
@@ -28,35 +33,17 @@ class NetworkAction;
  * Callbacks *
  *************/
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after Link creation
- * @details Callback functions have the following signature: `void(Link*)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, Link*)) networkLinkCreatedCallbacks;
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after Link destruction
- * @details Callback functions have the following signature: `void(Link*)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, Link*)) networkLinkDestructedCallbacks;
+/** @brief Callback signal fired when the state of a NetworkAction changes
+ *  Signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)` */
+XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)>) networkActionStateChangedCallbacks;
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after Link State changed
- * @details Callback functions have the following signature: `void(LinkAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, Link*, e_surf_resource_state_t, e_surf_resource_state_t)) networkLinkStateChangedCallbacks;
+/** @brief Callback signal fired when a NetworkAction is created (when a communication starts)
+ *  Signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)` */
+XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst, double size, double rate)>) networkCommunicateCallbacks;
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after NetworkAction State changed
- * @details Callback functions have the following signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)) networkActionStateChangedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after communication created
- * @details Callback functions have the following signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, NetworkAction*, RoutingEdge *src, RoutingEdge *dst, double size, double rate)) networkCommunicateCallbacks;
+}
+}
 
 /*********
  * Tools *
@@ -68,6 +55,10 @@ XBT_PUBLIC(void) net_add_traces();
 /*********
  * Model *
  *********/
+
+namespace simgrid {
+namespace surf {
+
 /** @ingroup SURF_network_interface
  * @brief SURF network model interface class
  * @details A model is an object which handles the interactions between its Resources and its Actions
@@ -123,7 +114,7 @@ public:
    * unlimited.
    * @return The action representing the communication
    */
-  virtual Action *communicate(RoutingEdge *src, RoutingEdge *dst,
+  virtual Action *communicate(NetCard *src, NetCard *dst,
                                           double size, double rate)=0;
 
   /** @brief Function pointer to the function to use to solve the lmm_system_t
@@ -176,7 +167,9 @@ public:
   * @brief SURF network link interface class
   * @details A Link represents the link between two [hosts](\ref Host)
   */
-class Link : public Resource {
+class Link :
+               public simgrid::surf::Resource,
+               public simgrid::surf::PropertyHolder {
 public:
   /**
    * @brief Link constructor
@@ -185,7 +178,7 @@ public:
    * @param name The name of the Link
    * @param props Dictionary of properties associated to this Link
    */
-  Link(NetworkModel *model, const char *name, xbt_dict_t props);
+  Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props);
 
   /**
    * @brief Link constructor
@@ -197,13 +190,33 @@ public:
    * @param history [TODO]
    * @param state_trace [TODO]
    */
-  Link(NetworkModel *model, const char *name, xbt_dict_t props,
+  Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props,
               lmm_constraint_t constraint,
               tmgr_history_t history,
               tmgr_trace_t state_trace);
 
-  /** @brief Link destructor */
+  /* Link destruction logic */
+  /**************************/
+protected:
   ~Link();
+public:
+       void destroy(); // Must be called instead of the destructor
+private:
+       bool currentlyDestroying_ = false;
+
+public:
+  /** @brief Callback signal fired when a new Link is created.
+   *  Signature: void(Link*) */
+  static simgrid::surf::signal<void(simgrid::surf::Link*)> onCreation;
+
+  /** @brief Callback signal fired when a Link is destroyed.
+   *  Signature: void(Link*) */
+  static simgrid::surf::signal<void(simgrid::surf::Link*)> onDestruction;
+
+  /** @brief Callback signal fired when the state of a Link changes
+   *  Signature: `void(LinkAction *action, e_surf_resource_state_t oldState, e_surf_resource_state_t currentState)` */
+  static simgrid::surf::signal<void(simgrid::surf::Link*, e_surf_resource_state_t, e_surf_resource_state_t)> onStateChange;
+
 
   /** @brief Get the bandwidth in bytes per second of current Link */
   virtual double getBandwidth();
@@ -217,12 +230,8 @@ public:
   /** @brief Update the latency in seconds of current Link */
   virtual void updateLatency(double value, double date=surf_get_clock())=0;
 
-  /**
-   * @brief Check if the Link is shared
-   *
-   * @return true if the current NetwokrLink is shared, false otherwise
-   */
-  virtual bool isShared();
+  /** @brief The sharing policy is a @{link #e_surf_link_sharing_policy_t} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
+  virtual int sharingPolicy();
 
   /** @brief Check if the Link is used */
   bool isUsed();
@@ -231,12 +240,12 @@ public:
 
   /* Using this object with the public part of
     model does not make sense */
-  double m_latCurrent;
-  tmgr_trace_event_t p_latEvent;
+  double m_latCurrent = 0;
+  tmgr_trace_event_t p_latEvent = NULL;
 
   /* LMM */
   tmgr_trace_event_t p_stateEvent = NULL;
-  s_surf_metric_t p_power;
+  s_surf_metric_t p_speed;
 
   /* User data */
 public:
@@ -262,7 +271,7 @@ public:
  * @brief SURF network action interface class
  * @details A NetworkAction represents a communication between two [hosts](\ref Host)
  */
-class NetworkAction : public Action {
+class NetworkAction : public simgrid::surf::Action {
 public:
   /** @brief Constructor
    *
@@ -270,8 +279,8 @@ public:
    * @param cost The cost of this  NetworkAction in [TODO]
    * @param failed [description]
    */
-  NetworkAction(Model *model, double cost, bool failed)
-  : Action(model, cost, failed) {}
+  NetworkAction(simgrid::surf::Model *model, double cost, bool failed)
+  : simgrid::surf::Action(model, cost, failed) {}
 
   /**
    * @brief NetworkAction constructor
@@ -282,8 +291,8 @@ public:
    * @param var The lmm variable associated to this Action if it is part of a
    * LMM component
    */
-  NetworkAction(Model *model, double cost, bool failed, lmm_variable_t var)
-  : Action(model, cost, failed, var) {};
+  NetworkAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
+  : simgrid::surf::Action(model, cost, failed, var) {};
 
   void setState(e_surf_action_state_t state);
 
@@ -309,6 +318,9 @@ public:
 
 };
 
+}
+}
+
 #endif /* SURF_NETWORK_INTERFACE_HPP_ */