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