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 ba829aa..4cb6b80 100644 (file)
@@ -1,60 +1,49 @@
-/* Copyright (c) 2004-2014. The SimGrid Team.
+/* Copyright (c) 2004-2015. 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. */
+
+#ifndef SURF_NETWORK_INTERFACE_HPP_
+#define SURF_NETWORK_INTERFACE_HPP_
+
+#include <xbt/base.h>
+
+#include <boost/unordered_map.hpp>
+
 #include "xbt/fifo.h"
+#include "xbt/dict.h"
 #include "surf_interface.hpp"
 #include "surf_routing.hpp"
+#include "src/surf/PropertyHolder.hpp"
 
-#ifndef SURF_NETWORK_INTERFACE_HPP_
-#define SURF_NETWORK_INTERFACE_HPP_
+#include "simgrid/link.h"
 
 /***********
  * Classes *
  ***********/
-class NetworkModel;
-typedef NetworkModel *NetworkModelPtr;
 
-class Link;
-typedef Link *LinkPtr;
+namespace simgrid {
+namespace surf {
 
+class NetworkModel;
 class NetworkAction;
-typedef NetworkAction *NetworkActionPtr;
 
 /*************
  * Callbacks *
  *************/
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after Link creation
- * @details Callback functions have the following signature: `void(LinkPtr)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, LinkPtr)) networkLinkCreatedCallbacks;
 
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emits the callbacks after Link destruction
- * @details Callback functions have the following signature: `void(LinkPtr)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, LinkPtr)) 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(LinkActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, LinkPtr, 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(NetworkActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, NetworkActionPtr, 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(NetworkActionPtr action, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate)`
- */
-XBT_PUBLIC_DATA( surf_callback(void, NetworkActionPtr, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate)) networkCommunicateCallbacks;
+}
+}
 
 /*********
  * Tools *
@@ -66,23 +55,20 @@ 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
  */
 class NetworkModel : public Model {
 public:
-  /** @brief NetworkModel constructor */
-  NetworkModel() : Model("network") {
-    f_networkSolve = lmm_solve;
-  };
-
-  /** @brief NetworkModel constructor */
-  NetworkModel(const char *name) : Model(name) {
-       f_networkSolve = lmm_solve;
-  };
+  /** @brief Constructor */
+  NetworkModel() : Model() { }
 
-  /** @brief The destructor of the NetworkModel */
+  /** @brief Destructor */
   ~NetworkModel() {
        if (p_maxminSystem)
          lmm_system_free(p_maxminSystem);
@@ -106,7 +92,7 @@ public:
    * @param properties Dictionary of properties associated to this Resource
    * @return The created Link
    */
-  virtual LinkPtr createLink(const char *name,
+  virtual Link* createLink(const char *name,
                                    double bw_initial,
                                    tmgr_trace_t bw_trace,
                                    double lat_initial,
@@ -116,8 +102,6 @@ public:
                                    e_surf_link_sharing_policy_t policy,
                                    xbt_dict_t properties)=0;
 
-  virtual void gapAppend(double /*size*/, const LinkPtr /*link*/, NetworkActionPtr /*action*/) {};
-
   /**
    * @brief Create a communication between two hosts.
    * @details It makes calls to the routing part, and execute the communication
@@ -130,15 +114,14 @@ public:
    * unlimited.
    * @return The action representing the communication
    */
-  virtual ActionPtr communicate(RoutingEdgePtr src, RoutingEdgePtr 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
+  /** @brief Function pointer to the function to use to solve the lmm_system_t
    *
    * @param system The lmm_system_t to solve
    */
-  void (*f_networkSolve)(lmm_system_t);
+  void (*f_networkSolve)(lmm_system_t) = lmm_solve;
 
   /**
    * @brief Get the right multiplicative factor for the latency.
@@ -175,7 +158,6 @@ public:
    */
   virtual double bandwidthConstraint(double rate, double bound, double size);
   double shareResourcesFull(double now);
-  bool m_haveGap = false;
 };
 
 /************
@@ -185,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
@@ -194,7 +178,7 @@ public:
    * @param name The name of the Link
    * @param props Dictionary of properties associated to this Link
    */
-  Link(NetworkModelPtr model, const char *name, xbt_dict_t props);
+  Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props);
 
   /**
    * @brief Link constructor
@@ -206,13 +190,33 @@ public:
    * @param history [TODO]
    * @param state_trace [TODO]
    */
-  Link(NetworkModelPtr 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();
@@ -226,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();
@@ -240,12 +240,28 @@ 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;
-  s_surf_metric_t p_power;
+  tmgr_trace_event_t p_stateEvent = NULL;
+  s_surf_metric_t p_speed;
+
+  /* User data */
+public:
+  void *getData()        { return userData;}
+  void  setData(void *d) { userData=d;}
+private:
+  void *userData = NULL;
+
+  /* List of all links */
+private:
+  static boost::unordered_map<std::string, Link *> *links;
+public:
+  static Link *byName(const char* name);
+  static int linksAmount();
+  static Link **linksList();
+  static void linksExit();
 };
 
 /**********
@@ -255,17 +271,16 @@ 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 NetworkAction constructor
+  /** @brief Constructor
    *
    * @param model The NetworkModel associated to this NetworkAction
    * @param cost The cost of this  NetworkAction in [TODO]
    * @param failed [description]
    */
-  NetworkAction(ModelPtr 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
@@ -276,8 +291,8 @@ public:
    * @param var The lmm variable associated to this Action if it is part of a
    * LMM component
    */
-  NetworkAction(ModelPtr 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);
 
@@ -295,7 +310,6 @@ public:
   double m_weight;
   double m_rate;
   const char* p_senderLinkName;
-  double m_senderGap;
   double m_senderSize;
   xbt_fifo_item_t p_senderFifoItem;
 #ifdef HAVE_LATENCY_BOUND_TRACKING
@@ -304,6 +318,9 @@ public:
 
 };
 
+}
+}
+
 #endif /* SURF_NETWORK_INTERFACE_HPP_ */