src/surf/network_interface.hpp

   1 /* Copyright (c) 2004-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6 #include "xbt/fifo.h"
   7 #include "surf_interface.hpp"
   8 #include "surf_routing.hpp"
   9
  10 #ifndef SURF_NETWORK_INTERFACE_HPP_
  11 #define SURF_NETWORK_INTERFACE_HPP_
  12
  13 /***********
  14  * Classes *
  15  ***********/
  16 class NetworkModel;
  17 typedef NetworkModel *NetworkModelPtr;
  18
  19 class NetworkLink;
  20 typedef NetworkLink *NetworkLinkPtr;
  21
  22 class NetworkAction;
  23 typedef NetworkAction *NetworkActionPtr;
  24
  25 /*************
  26  * Callbacks *
  27  *************/
  28
  29 /** @ingroup SURF_callbacks
  30  * @brief Callbacks handler which emit the callbacks after NetworkLink creation
  31  * @details Callback functions have the following signature: `void(NetworkLinkPtr)`
  32  */
  33 XBT_PUBLIC_DATA( surf_callback(void, NetworkLinkPtr)) networkLinkCreatedCallbacks;
  34
  35 /** @ingroup SURF_callbacks
  36  * @brief Callbacks handler which emit the callbacks after NetworkLink destruction
  37  * @details Callback functions have the following signature: `void(NetworkLinkPtr)`
  38  */
  39 XBT_PUBLIC_DATA( surf_callback(void, NetworkLinkPtr)) networkLinkDestructedCallbacks;
  40
  41 /** @ingroup SURF_callbacks
  42  * @brief Callbacks handler which emit the callbacks after NetworkLink State changed
  43  * @details Callback functions have the following signature: `void(NetworkLinkActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
  44  */
  45 XBT_PUBLIC_DATA( surf_callback(void, NetworkLinkPtr, e_surf_resource_state_t, e_surf_resource_state_t)) networkLinkStateChangedCallbacks;
  46
  47 /** @ingroup SURF_callbacks
  48  * @brief Callbacks handler which emit the callbacks after NetworkAction State changed
  49  * @details Callback functions have the following signature: `void(NetworkActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)`
  50  */
  51 XBT_PUBLIC_DATA( surf_callback(void, NetworkActionPtr, e_surf_action_state_t, e_surf_action_state_t)) networkActionStateChangedCallbacks;
  52
  53 /** @ingroup SURF_callbacks
  54  * @brief Callbacks handler which emit the callbacks after communication created
  55  * @details Callback functions have the following signature: `void(NetworkActionPtr action, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate)`
  56  */
  57 XBT_PUBLIC_DATA( surf_callback(void, NetworkActionPtr, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate)) networkCommunicateCallbacks;
  58
  59 /*********
  60  * Tools *
  61  *********/
  62 XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link);
  63
  64 XBT_PUBLIC(void) net_add_traces();
  65
  66 /*********
  67  * Model *
  68  *********/
  69 /** @ingroup SURF_network_interface
  70  * @brief SURF network model interface class
  71  * @details A model is an object which handle the interactions between its Resources and its Actions
  72  */
  73 class NetworkModel : public Model {
  74 public:
  75   /**
  76    * @brief NetworkModel constructor
  77    */
  78   NetworkModel() : Model("network") {
  79     f_networkSolve = lmm_solve;
  80   };
  81
  82   /**
  83    * @brief NetworkModel constructor
  84    *
  85    * @param name The name of the NetworkModel
  86    */
  87   NetworkModel(const char *name) : Model(name) {
  88         f_networkSolve = lmm_solve;
  89         m_haveGap = false;
  90   };
  91
  92   /**
  93    * @brief The destructor of the NetworkModel
  94    */
  95   ~NetworkModel() {
  96         if (p_maxminSystem)
  97           lmm_system_free(p_maxminSystem);
  98         if (p_actionHeap)
  99           xbt_heap_free(p_actionHeap);
 100         if (p_modifiedSet)
 101           delete p_modifiedSet;
 102   }
 103
 104   /**
 105    * @brief Create a NetworkLink
 106    *
 107    * @param name The name of the NetworkLink
 108    * @param bw_initial The initial bandwidth of the NetworkLink in bytes per second
 109    * @param bw_trace The trace associated to the NetworkLink bandwidth
 110    * @param lat_initial The initial latency of the NetworkLink in seconds
 111    * @param lat_trace The trace associated to the NetworkLink latency
 112    * @param state_initial The initial NetworkLink (state)[e_surf_resource_state_t]
 113    * @param state_trace The trace associated to the NetworkLink (state)[e_surf_resource_state_t]
 114    * @param policy The sharing policy of the NetworkLink
 115    * @param properties Dictionary of properties associated to this Resource
 116    * @return The created NetworkLink
 117    */
 118   virtual NetworkLinkPtr createNetworkLink(const char *name,
 119                                    double bw_initial,
 120                                    tmgr_trace_t bw_trace,
 121                                    double lat_initial,
 122                                    tmgr_trace_t lat_trace,
 123                                    e_surf_resource_state_t state_initial,
 124                                    tmgr_trace_t state_trace,
 125                                    e_surf_link_sharing_policy_t policy,
 126                                    xbt_dict_t properties)=0;
 127
 128   virtual void gapAppend(double /*size*/, const NetworkLinkPtr /*link*/, NetworkActionPtr /*action*/) {};
 129
 130   /**
 131    * @brief Create a communication between two workstations.
 132    * @details It makes calls to the routing part, and execute the communication
 133    * between the two end points.
 134    *
 135    * @param src The source of the communication
 136    * @param dst The destination of the communication
 137    * @param size The size of the communication in bytes
 138    * @param rate Allows to limit the transfer rate. Negative value means
 139    * unlimited.
 140    * @return The action representing the communication
 141    */
 142   virtual ActionPtr communicate(RoutingEdgePtr src, RoutingEdgePtr dst,
 143                                            double size, double rate)=0;
 144
 145   /**
 146    * @brief Function pointer to the function to use to solve the lmm_system_t
 147    *
 148    * @param system The lmm_system_t to solve
 149    */
 150   void (*f_networkSolve)(lmm_system_t);
 151
 152   /**
 153    * @brief Gets the right multiplicative factor for the latency.
 154    * @details According to the model, the effective latency when sending
 155    * a message might be different from the theoretical latency in function
 156    * of its size. In order to account for this, this function get this factor.
 157    *
 158    * @param size The size of the message.
 159    * @return The latency factor.
 160    */
 161   virtual double latencyFactor(double size);
 162
 163   /**
 164    * @brief Gets the right multiplicative factor for the bandwidth.
 165    * @details According to the model, the effective bandwidth when sending
 166    * a message might be different from the theoretical bandwidth in function
 167    * of its size. In order to account for this, this function get this factor.
 168    *
 169    * @param size The size of the message.
 170    * @return The bandwidth factor.
 171    */
 172   virtual double bandwidthFactor(double size);
 173
 174   /**
 175    * @brief Gets definitive bandwidth.
 176    * @details It gives the minimum bandwidth between the one that would
 177    * occur if no limitation was enforced, and the maximum wanted bandwidth
 178    * @param rate The desired maximum bandwidth.
 179    * @param bound The bandwidth with only the network taken into account.
 180    * @param size The size of the message.
 181    * @return The new bandwidth.
 182    */
 183   virtual double bandwidthConstraint(double rate, double bound, double size);
 184   double shareResourcesFull(double now);
 185   bool m_haveGap;
 186 };
 187
 188 /************
 189  * Resource *
 190  ************/
 191  /** @ingroup SURF_network_interface
 192   * @brief SURF network link interface class
 193   * @details A NetworkLink represent the link between two [Workstations](\ref Workstation)
 194   */
 195 class NetworkLink : public Resource {
 196 public:
 197   /**
 198    * @brief NetworkLink constructor
 199    *
 200    * @param model The CpuModel associated to this NetworkLink
 201    * @param name The name of the NetworkLink
 202    * @param props Dictionary of properties associated to this NetworkLink
 203    */
 204   NetworkLink(NetworkModelPtr model, const char *name, xbt_dict_t props);
 205
 206   /**
 207    * @brief NetworkLink constructor
 208    *
 209    * @param model The CpuModel associated to this NetworkLink
 210    * @param name The name of the NetworkLink
 211    * @param props Dictionary of properties associated to this NetworkLink
 212    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
 213    * @param history [TODO]
 214    * @param state_trace [TODO]
 215    */
 216   NetworkLink(NetworkModelPtr model, const char *name, xbt_dict_t props,
 217                       lmm_constraint_t constraint,
 218                   tmgr_history_t history,
 219                   tmgr_trace_t state_trace);
 220
 221   /**
 222    * @brief NetworkLink destructor
 223    */
 224   ~NetworkLink();
 225
 226   /**
 227    * @brief Get the bandwidth in bytes per second of current NetworkLink
 228    *
 229    * @return The bandwith in bytes per second of the current NetworkLink
 230    */
 231   virtual double getBandwidth();
 232
 233   /**
 234    * @brief Update the bandwidth in bytes per second of current NetworkLink
 235    */
 236   virtual void updateBandwidth(double value, double date=surf_get_clock())=0;
 237
 238   /**
 239    * @brief Get the latency in seconds of current NetworkLink
 240    *
 241    * @return The latency in seconds of the current NetworkLink
 242    */
 243   virtual double getLatency();
 244
 245   /**
 246    * @brief Update the latency in seconds of current NetworkLink
 247    */
 248   virtual void updateLatency(double value, double date=surf_get_clock())=0;
 249
 250   /**
 251    * @brief Check if the NetworkLink is shared
 252    * @details [long description]
 253    *
 254    * @return true if the current NetwokrLink is shared, false otherwise
 255    */
 256   virtual bool isShared();
 257
 258   /**
 259    * @brief Check if the NetworkLink is used
 260    *
 261    * @return true if the current NetwokrLink is used, false otherwise
 262    */
 263   bool isUsed();
 264
 265   void setState(e_surf_resource_state_t state);
 266
 267   /* Using this object with the public part of
 268     model does not make sense */
 269   double m_latCurrent;
 270   tmgr_trace_event_t p_latEvent;
 271
 272   /* LMM */
 273   tmgr_trace_event_t p_stateEvent;
 274   s_surf_metric_t p_power;
 275 };
 276
 277 /**********
 278  * Action *
 279  **********/
 280 /** @ingroup SURF_network_interface
 281  * @brief SURF network action interface class
 282  * @details A NetworkAction represent a communication bettween two [Workstations](\ref Workstation)
 283  */
 284 class NetworkAction : public Action {
 285 public:
 286   /**
 287    * @brief NetworkAction constructor
 288    *
 289    * @param model The NetworkModel associated to this NetworkAction
 290    * @param cost The cost of this  NetworkAction in [TODO]
 291    * @param failed [description]
 292    */
 293   NetworkAction(ModelPtr model, double cost, bool failed)
 294   : Action(model, cost, failed) {}
 295
 296   /**
 297    * @brief NetworkAction constructor
 298    *
 299    * @param model The NetworkModel associated to this NetworkAction
 300    * @param cost The cost of this  NetworkAction in [TODO]
 301    * @param failed [description]
 302    * @param var The lmm variable associated to this Action if it is part of a LMM component
 303    */
 304   NetworkAction(ModelPtr model, double cost, bool failed, lmm_variable_t var)
 305   : Action(model, cost, failed, var) {};
 306
 307   void setState(e_surf_action_state_t state);
 308
 309 #ifdef HAVE_LATENCY_BOUND_TRACKING
 310   /**
 311    * @brief Check if the action is limited by latency.
 312    *
 313    * @return 1 if action is limited by latency, 0 otherwise
 314    */
 315   virtual int getLatencyLimited() {return m_latencyLimited;}
 316 #endif
 317
 318   double m_latency;
 319   double m_latCurrent;
 320   double m_weight;
 321   double m_rate;
 322   const char* p_senderLinkName;
 323   double m_senderGap;
 324   double m_senderSize;
 325   xbt_fifo_item_t p_senderFifoItem;
 326 #ifdef HAVE_LATENCY_BOUND_TRACKING
 327   int m_latencyLimited;
 328 #endif
 329
 330 };
 331
 332 #endif /* SURF_NETWORK_INTERFACE_HPP_ */
 333
 334