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, simgrid::surf::Action::State old, simgrid::surf::Action::State current)` */
  39     XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::Action::State, simgrid::surf::Action::State)>) networkActionStateChangedCallbacks;
  40
  41       }
  42 }
  43
  44 /*********
  45  * Tools *
  46  *********/
  47 XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link);
  48
  49 /*********
  50  * Model *
  51  *********/
  52
  53 namespace simgrid {
  54   namespace surf {
  55
  56     /** @ingroup SURF_network_interface
  57      * @brief SURF network model interface class
  58      * @details A model is an object which handles the interactions between its Resources and its Actions
  59      */
  60     class NetworkModel : public Model {
  61     public:
  62       /** @brief Constructor */
  63       NetworkModel() : Model() { }
  64
  65       /** @brief Destructor */
  66       ~NetworkModel() {
  67         if (maxminSystem_)
  68           lmm_system_free(maxminSystem_);
  69         if (actionHeap_)
  70           xbt_heap_free(actionHeap_);
  71         delete modifiedSet_;
  72       }
  73
  74       /**
  75        * @brief Create a Link
  76        *
  77        * @param name The name of the Link
  78        * @param bandwidth The initial bandwidth of the Link in bytes per second
  79        * @param latency The initial latency of the Link in seconds
  80        * @param policy The sharing policy of the Link
  81        * @param properties Dictionary of properties associated to this Resource
  82        * @return The created Link
  83        */
  84       virtual Link* createLink(const char *name, double bandwidth, double latency,
  85           e_surf_link_sharing_policy_t policy, xbt_dict_t properties)=0;
  86
  87       /**
  88        * @brief Create a communication between two hosts.
  89        * @details It makes calls to the routing part, and execute the communication
  90        * between the two end points.
  91        *
  92        * @param src The source of the communication
  93        * @param dst The destination of the communication
  94        * @param size The size of the communication in bytes
  95        * @param rate Allows to limit the transfer rate. Negative value means
  96        * unlimited.
  97        * @return The action representing the communication
  98        */
  99       virtual Action *communicate(NetCard *src, NetCard *dst, double size, double rate)=0;
 100
 101       /** @brief Function pointer to the function to use to solve the lmm_system_t
 102        *
 103        * @param system The lmm_system_t to solve
 104        */
 105       void (*f_networkSolve)(lmm_system_t) = lmm_solve;
 106
 107       /**
 108        * @brief Get the right multiplicative factor for the latency.
 109        * @details Depending on the model, the effective latency when sending
 110        * a message might be different from the theoretical latency of the link,
 111        * in function of the message size. In order to account for this, this
 112        * function gets this factor.
 113        *
 114        * @param size The size of the message.
 115        * @return The latency factor.
 116        */
 117       virtual double latencyFactor(double size);
 118
 119       /**
 120        * @brief Get the right multiplicative factor for the bandwidth.
 121        * @details Depending on the model, the effective bandwidth when sending
 122        * a message might be different from the theoretical bandwidth of the link,
 123        * in function of the message size. In order to account for this, this
 124        * function gets this factor.
 125        *
 126        * @param size The size of the message.
 127        * @return The bandwidth factor.
 128        */
 129       virtual double bandwidthFactor(double size);
 130
 131       /**
 132        * @brief Get definitive bandwidth.
 133        * @details It gives the minimum bandwidth between the one that would
 134        * occur if no limitation was enforced, and the one arbitrary limited.
 135        * @param rate The desired maximum bandwidth.
 136        * @param bound The bandwidth with only the network taken into account.
 137        * @param size The size of the message.
 138        * @return The new bandwidth.
 139        */
 140       virtual double bandwidthConstraint(double rate, double bound, double size);
 141       double next_occuring_event_full(double now) override;
 142     };
 143
 144     /************
 145      * Resource *
 146      ************/
 147     /** @ingroup SURF_network_interface
 148      * @brief SURF network link interface class
 149      * @details A Link represents the link between two [hosts](\ref Host)
 150      */
 151     class Link :
 152         public simgrid::surf::Resource,
 153         public simgrid::surf::PropertyHolder {
 154         public:
 155       /**
 156        * @brief Link constructor
 157        *
 158        * @param model The NetworkModel associated to this Link
 159        * @param name The name of the Link
 160        * @param props Dictionary of properties associated to this Link
 161        */
 162       Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props);
 163
 164       /**
 165        * @brief Link constructor
 166        *
 167        * @param model The NetworkModel associated to this Link
 168        * @param name The name of the Link
 169        * @param props Dictionary of properties associated to this Link
 170        * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
 171        */
 172       Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
 173
 174       /* Link destruction logic */
 175       /**************************/
 176         protected:
 177       ~Link();
 178         public:
 179       void destroy(); // Must be called instead of the destructor
 180         private:
 181       bool currentlyDestroying_ = false;
 182
 183         public:
 184       /** @brief Callback signal fired when a new Link is created.
 185        *  Signature: void(Link*) */
 186       static simgrid::xbt::signal<void(simgrid::surf::Link*)> onCreation;
 187
 188       /** @brief Callback signal fired when a Link is destroyed.
 189        *  Signature: void(Link*) */
 190       static simgrid::xbt::signal<void(simgrid::surf::Link*)> onDestruction;
 191
 192       /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off)
 193        *  Signature: `void(Link*)` */
 194       static simgrid::xbt::signal<void(simgrid::surf::Link*)> onStateChange;
 195
 196       /** @brief Callback signal fired when a communication starts
 197        *  Signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst)` */
 198       static simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst)> onCommunicate;
 199
 200
 201
 202       /** @brief Get the bandwidth in bytes per second of current Link */
 203       virtual double getBandwidth();
 204
 205       /** @brief Update the bandwidth in bytes per second of current Link */
 206       virtual void updateBandwidth(double value)=0;
 207
 208       /** @brief Get the latency in seconds of current Link */
 209       virtual double getLatency();
 210
 211       /** @brief Update the latency in seconds of current Link */
 212       virtual void updateLatency(double value)=0;
 213
 214       /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
 215       virtual int sharingPolicy();
 216
 217       /** @brief Check if the Link is used */
 218       bool isUsed() override;
 219
 220       void turnOn() override;
 221       void turnOff() override;
 222
 223       virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain boolean values. */
 224       virtual void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to external load). Trace must contain percentages (value between 0 and 1). */
 225       virtual void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to external load). Trace must contain absolute values */
 226
 227       tmgr_trace_iterator_t m_stateEvent = NULL;
 228       s_surf_metric_t m_latency = {1.0,0,NULL};
 229       s_surf_metric_t m_bandwidth = {1.0,0,NULL};
 230
 231       /* User data */
 232         public:
 233       void *getData()        { return userData;}
 234       void  setData(void *d) { userData=d;}
 235         private:
 236       void *userData = NULL;
 237
 238       /* List of all links */
 239         private:
 240       static boost::unordered_map<std::string, Link *> *links;
 241         public:
 242       static Link *byName(const char* name);
 243       static int linksCount();
 244       static Link **linksList();
 245       static void linksExit();
 246     };
 247
 248     /**********
 249      * Action *
 250      **********/
 251     /** @ingroup SURF_network_interface
 252      * @brief SURF network action interface class
 253      * @details A NetworkAction represents a communication between two [hosts](\ref Host)
 254      */
 255     class NetworkAction : public simgrid::surf::Action {
 256     public:
 257       /** @brief Constructor
 258        *
 259        * @param model The NetworkModel associated to this NetworkAction
 260        * @param cost The cost of this  NetworkAction in [TODO]
 261        * @param failed [description]
 262        */
 263       NetworkAction(simgrid::surf::Model *model, double cost, bool failed)
 264     : simgrid::surf::Action(model, cost, failed) {}
 265
 266       /**
 267        * @brief NetworkAction constructor
 268        *
 269        * @param model The NetworkModel associated to this NetworkAction
 270        * @param cost The cost of this  NetworkAction in [TODO]
 271        * @param failed [description]
 272        * @param var The lmm variable associated to this Action if it is part of a
 273        * LMM component
 274        */
 275       NetworkAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
 276       : simgrid::surf::Action(model, cost, failed, var) {};
 277
 278       void setState(simgrid::surf::Action::State state) override;
 279
 280       double latency_;
 281       double latCurrent_;
 282       double weight_;
 283       double rate_;
 284       const char* senderLinkName_;
 285       double senderSize_;
 286       xbt_fifo_item_t senderFifoItem_;
 287     };
 288   }
 289 }
 290
 291 #endif /* SURF_NETWORK_INTERFACE_HPP_ */
 292
 293