src/surf/network_interface.hpp

   1 /* Copyright (c) 2004-2015. 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
   7 #ifndef SURF_NETWORK_INTERFACE_HPP_
   8 #define SURF_NETWORK_INTERFACE_HPP_
   9
  10 #include <xbt/base.h>
  11
  12 #include <boost/unordered_map.hpp>
  13
  14 #include "xbt/fifo.h"
  15 #include "xbt/dict.h"
  16 #include "surf_interface.hpp"
  17 #include "surf_routing.hpp"
  18 #include "src/surf/PropertyHolder.hpp"
  19
  20 #include "simgrid/link.h"
  21
  22 /***********
  23  * Classes *
  24  ***********/
  25
  26 namespace simgrid {
  27 namespace surf {
  28
  29 class NetworkModel;
  30 class NetworkAction;
  31
  32 /*************
  33  * Callbacks *
  34  *************/
  35
  36
  37 /** @brief Callback signal fired when the state of a NetworkAction changes
  38  *  Signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)` */
  39 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)>) networkActionStateChangedCallbacks;
  40
  41 /** @brief Callback signal fired when a NetworkAction is created (when a communication starts)
  42  *  Signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)` */
  43 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst, double size, double rate)>) networkCommunicateCallbacks;
  44
  45 }
  46 }
  47
  48 /*********
  49  * Tools *
  50  *********/
  51 XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link);
  52
  53 /*********
  54  * Model *
  55  *********/
  56
  57 namespace simgrid {
  58 namespace surf {
  59
  60 /** @ingroup SURF_network_interface
  61  * @brief SURF network model interface class
  62  * @details A model is an object which handles the interactions between its Resources and its Actions
  63  */
  64 class NetworkModel : public Model {
  65 public:
  66   /** @brief Constructor */
  67   NetworkModel() : Model() { }
  68
  69   /** @brief Destructor */
  70   ~NetworkModel() {
  71         if (p_maxminSystem)
  72           lmm_system_free(p_maxminSystem);
  73         if (p_actionHeap)
  74           xbt_heap_free(p_actionHeap);
  75         if (p_modifiedSet)
  76           delete p_modifiedSet;
  77   }
  78
  79   /**
  80    * @brief Create a Link
  81    *
  82    * @param name The name of the Link
  83    * @param bw_initial The initial bandwidth of the Link in bytes per second
  84    * @param bw_trace The trace associated to the Link bandwidth
  85    * @param lat_initial The initial latency of the Link in seconds
  86    * @param lat_trace The trace associated to the Link latency
  87    * @param state_initial The initial Link (state)[e_surf_resource_state_t]
  88    * @param state_trace The trace associated to the Link (state)[e_surf_resource_state_t]
  89    * @param policy The sharing policy of the Link
  90    * @param properties Dictionary of properties associated to this Resource
  91    * @return The created Link
  92    */
  93   virtual Link* createLink(const char *name,
  94                                    double bw_initial,
  95                                    tmgr_trace_t bw_trace,
  96                                    double lat_initial,
  97                                    tmgr_trace_t lat_trace,
  98                                    int initiallyOn,
  99                                    tmgr_trace_t state_trace,
 100                                    e_surf_link_sharing_policy_t policy,
 101                                    xbt_dict_t properties)=0;
 102
 103   /**
 104    * @brief Create a communication between two hosts.
 105    * @details It makes calls to the routing part, and execute the communication
 106    * between the two end points.
 107    *
 108    * @param src The source of the communication
 109    * @param dst The destination of the communication
 110    * @param size The size of the communication in bytes
 111    * @param rate Allows to limit the transfer rate. Negative value means
 112    * unlimited.
 113    * @return The action representing the communication
 114    */
 115   virtual Action *communicate(NetCard *src, NetCard *dst,
 116                                            double size, double rate)=0;
 117
 118   /** @brief Function pointer to the function to use to solve the lmm_system_t
 119    *
 120    * @param system The lmm_system_t to solve
 121    */
 122   void (*f_networkSolve)(lmm_system_t) = lmm_solve;
 123
 124   /**
 125    * @brief Get the right multiplicative factor for the latency.
 126    * @details Depending on the model, the effective latency when sending
 127    * a message might be different from the theoretical latency of the link,
 128    * in function of the message size. In order to account for this, this
 129    * function gets this factor.
 130    *
 131    * @param size The size of the message.
 132    * @return The latency factor.
 133    */
 134   virtual double latencyFactor(double size);
 135
 136   /**
 137    * @brief Get the right multiplicative factor for the bandwidth.
 138    * @details Depending on the model, the effective bandwidth when sending
 139    * a message might be different from the theoretical bandwidth of the link,
 140    * in function of the message size. In order to account for this, this
 141    * function gets this factor.
 142    *
 143    * @param size The size of the message.
 144    * @return The bandwidth factor.
 145    */
 146   virtual double bandwidthFactor(double size);
 147
 148   /**
 149    * @brief Get definitive bandwidth.
 150    * @details It gives the minimum bandwidth between the one that would
 151    * occur if no limitation was enforced, and the one arbitrary limited.
 152    * @param rate The desired maximum bandwidth.
 153    * @param bound The bandwidth with only the network taken into account.
 154    * @param size The size of the message.
 155    * @return The new bandwidth.
 156    */
 157   virtual double bandwidthConstraint(double rate, double bound, double size);
 158   double shareResourcesFull(double now);
 159 };
 160
 161 /************
 162  * Resource *
 163  ************/
 164  /** @ingroup SURF_network_interface
 165   * @brief SURF network link interface class
 166   * @details A Link represents the link between two [hosts](\ref Host)
 167   */
 168 class Link :
 169                 public simgrid::surf::Resource,
 170                 public simgrid::surf::PropertyHolder {
 171 public:
 172   /**
 173    * @brief Link constructor
 174    *
 175    * @param model The NetworkModel associated to this Link
 176    * @param name The name of the Link
 177    * @param props Dictionary of properties associated to this Link
 178    */
 179   Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props);
 180
 181   /**
 182    * @brief Link constructor
 183    *
 184    * @param model The NetworkModel associated to this Link
 185    * @param name The name of the Link
 186    * @param props Dictionary of properties associated to this Link
 187    * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
 188    * @param history [TODO]
 189    * @param state_trace [TODO]
 190    */
 191   Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props,
 192               lmm_constraint_t constraint,
 193               tmgr_history_t history,
 194               tmgr_trace_t state_trace);
 195
 196   /* Link destruction logic */
 197   /**************************/
 198 protected:
 199   ~Link();
 200 public:
 201         void destroy(); // Must be called instead of the destructor
 202 private:
 203         bool currentlyDestroying_ = false;
 204
 205 public:
 206   /** @brief Callback signal fired when a new Link is created.
 207    *  Signature: void(Link*) */
 208   static simgrid::xbt::signal<void(simgrid::surf::Link*)> onCreation;
 209
 210   /** @brief Callback signal fired when a Link is destroyed.
 211    *  Signature: void(Link*) */
 212   static simgrid::xbt::signal<void(simgrid::surf::Link*)> onDestruction;
 213
 214   /** @brief Callback signal fired when the state of a Link changes
 215    *  Signature: `void(LinkAction *action, int previouslyOn, int currentlyOn)` */
 216   static simgrid::xbt::signal<void(simgrid::surf::Link*, int, int)> onStateChange;
 217
 218
 219   /** @brief Get the bandwidth in bytes per second of current Link */
 220   virtual double getBandwidth();
 221
 222   /** @brief Update the bandwidth in bytes per second of current Link */
 223   virtual void updateBandwidth(double value, double date=surf_get_clock())=0;
 224
 225   /** @brief Get the latency in seconds of current Link */
 226   virtual double getLatency();
 227
 228   /** @brief Update the latency in seconds of current Link */
 229   virtual void updateLatency(double value, double date=surf_get_clock())=0;
 230
 231   /** @brief The sharing policy is a @{link #e_surf_link_sharing_policy_t} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
 232   virtual int sharingPolicy();
 233
 234   /** @brief Check if the Link is used */
 235   bool isUsed() override;
 236
 237   void turnOn() override;
 238   void turnOff() override;
 239
 240   /* Using this object with the public part of
 241     model does not make sense */
 242   double m_latCurrent = 0;
 243   tmgr_trace_event_t p_latEvent = NULL;
 244
 245   /* LMM */
 246   tmgr_trace_event_t p_stateEvent = NULL;
 247   s_surf_metric_t p_speed;
 248
 249   /* User data */
 250 public:
 251   void *getData()        { return userData;}
 252   void  setData(void *d) { userData=d;}
 253 private:
 254   void *userData = NULL;
 255
 256   /* List of all links */
 257 private:
 258   static boost::unordered_map<std::string, Link *> *links;
 259 public:
 260   static Link *byName(const char* name);
 261   static int linksCount();
 262   static Link **linksList();
 263   static void linksExit();
 264 };
 265
 266 /**********
 267  * Action *
 268  **********/
 269 /** @ingroup SURF_network_interface
 270  * @brief SURF network action interface class
 271  * @details A NetworkAction represents a communication between two [hosts](\ref Host)
 272  */
 273 class NetworkAction : public simgrid::surf::Action {
 274 public:
 275   /** @brief Constructor
 276    *
 277    * @param model The NetworkModel associated to this NetworkAction
 278    * @param cost The cost of this  NetworkAction in [TODO]
 279    * @param failed [description]
 280    */
 281   NetworkAction(simgrid::surf::Model *model, double cost, bool failed)
 282   : simgrid::surf::Action(model, cost, failed) {}
 283
 284   /**
 285    * @brief NetworkAction constructor
 286    *
 287    * @param model The NetworkModel associated to this NetworkAction
 288    * @param cost The cost of this  NetworkAction in [TODO]
 289    * @param failed [description]
 290    * @param var The lmm variable associated to this Action if it is part of a
 291    * LMM component
 292    */
 293   NetworkAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
 294   : simgrid::surf::Action(model, cost, failed, var) {};
 295
 296   void setState(e_surf_action_state_t state);
 297
 298 #ifdef HAVE_LATENCY_BOUND_TRACKING
 299   /**
 300    * @brief Check if the action is limited by latency.
 301    *
 302    * @return 1 if action is limited by latency, 0 otherwise
 303    */
 304   virtual int getLatencyLimited() {return m_latencyLimited;}
 305 #endif
 306
 307   double m_latency;
 308   double m_latCurrent;
 309   double m_weight;
 310   double m_rate;
 311   const char* p_senderLinkName;
 312   double m_senderSize;
 313   xbt_fifo_item_t p_senderFifoItem;
 314 #ifdef HAVE_LATENCY_BOUND_TRACKING
 315   int m_latencyLimited;
 316 #endif
 317
 318 };
 319
 320 }
 321 }
 322
 323 #endif /* SURF_NETWORK_INTERFACE_HPP_ */
 324
 325