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