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