include/simgrid/s4u/Link.hpp

   1 /* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef S4U_LINK_HPP
   7 #define S4U_LINK_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/kernel/resource/Action.hpp>
  11 #include <simgrid/link.h>
  12 #include <string>
  13 #include <unordered_map>
  14 #include <xbt/Extendable.hpp>
  15 #include <xbt/base.h>
  16 #include <xbt/signal.hpp>
  17
  18 /***********
  19  * Classes *
  20  ***********/
  21
  22 namespace simgrid {
  23
  24 extern template class XBT_PUBLIC xbt::Extendable<s4u::Link>;
  25
  26 namespace s4u {
  27 /**
  28  * @beginrst
  29  * A Link represents the network facilities between :cpp:class:`hosts <simgrid::s4u::Host>`.
  30  * @endrst
  31  */
  32 class XBT_PUBLIC Link : public xbt::Extendable<Link> {
  33 #ifndef DOXYGEN
  34   friend kernel::resource::LinkImpl;
  35 #endif
  36
  37 protected:
  38   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
  39   explicit Link(kernel::resource::LinkImplIntf* pimpl) : pimpl_(pimpl) {}
  40   virtual ~Link() = default;
  41   // The implementation that never changes
  42   kernel::resource::LinkImplIntf* const pimpl_;
  43
  44 public:
  45   enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
  46
  47   kernel::resource::LinkImpl* get_impl() const;
  48
  49   /** @brief Retrieve a link from its name */
  50   static Link* by_name(const std::string& name);
  51   static Link* by_name_or_null(const std::string& name);
  52
  53   /** @brief Retrieves the name of that link as a C++ string */
  54   const std::string& get_name() const;
  55   /** @brief Retrieves the name of that link as a C string */
  56   const char* get_cname() const;
  57
  58   /** Get/Set the bandwidth of the current Link (in bytes per second) */
  59   double get_bandwidth() const;
  60   Link* set_bandwidth(double value);
  61
  62   /** Get/Set the latency of the current Link (in seconds) */
  63   double get_latency() const;
  64   /**
  65    * @brief Set link's latency
  66    *
  67    * @param value New latency value (in s)
  68    */
  69   Link* set_latency(double value);
  70   /**
  71    * @brief Set latency (string version)
  72    *
  73    * Accepts values with units, such as '1s' or '7ms'.
  74    *
  75    * Full list of accepted units: w (week), d (day), h, s, ms, us, ns, ps.
  76    *
  77    * @throw std::invalid_argument if latency format is incorrect.
  78    */
  79   Link* set_latency(const std::string& value);
  80
  81   /** @brief Describes how the link is shared between flows */
  82   Link* set_sharing_policy(SharingPolicy policy);
  83   SharingPolicy get_sharing_policy() const;
  84
  85   /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
  86   Link* set_state_profile(kernel::profile::Profile* profile);
  87   /** Setup the profile with bandwidth events (peak speed changes due to external load).
  88    * The profile must contain percentages (value between 0 and 1). */
  89   Link* set_bandwidth_profile(kernel::profile::Profile* profile);
  90   /** Setup the profile file with latency events (peak latency changes due to external load).
  91    * The profile must contain absolute values */
  92   Link* set_latency_profile(kernel::profile::Profile* profile);
  93
  94   const std::unordered_map<std::string, std::string>* get_properties() const;
  95   const char* get_property(const std::string& key) const;
  96   Link* set_properties(const std::unordered_map<std::string, std::string>& properties);
  97   Link* set_property(const std::string& key, const std::string& value);
  98
  99   /**
 100    * @brief Set the number of communications that can shared this link at the same time
 101    *
 102    * Use this method to serialize communication flows going through this link.
 103    * Use -1 to set no limit.
 104    *
 105    * @param limit  Number of concurrent flows
 106    */
 107   Link* set_concurrency_limit(int limit);
 108
 109   /** @brief Set the level of communication speed of the given host on this wifi link.
 110    *
 111    * The bandwidth of a wifi link for a given host depends on its SNR (signal to noise ratio),
 112    * which ultimately depends on the distance between the host and the station and the material between them.
 113    *
 114    * This is modeled in SimGrid by providing several bandwidths to wifi links, one per SNR level (just provide
 115    * comma-separated values in the XML file). By default, the first level in the list is used, but you can use the
 116    * current function to specify that a given host uses another level of bandwidth. This can be used to take the
 117    * location of hosts into account, or even to model mobility in your SimGrid simulation.
 118    *
 119    * Note that this function asserts that the link is actually a wifi link */
 120   void set_host_wifi_rate(const s4u::Host* host, int level) const;
 121
 122   /** @brief Returns the current load (in bytes per second) */
 123   double get_usage() const;
 124
 125   /** @brief Check if the Link is used (at least one flow uses the link) */
 126   bool is_used() const;
 127
 128   /** @brief Check if the Link is shared (not a FATPIPE) */
 129   bool is_shared() const;
 130
 131   void turn_on();
 132   void turn_off();
 133   bool is_on() const;
 134
 135   Link* seal();
 136
 137   /* The signals */
 138   /** @brief Callback signal fired when a new Link is created */
 139   static xbt::signal<void(Link&)> on_creation;
 140
 141   /** @brief Callback signal fired when a Link is destroyed */
 142   static xbt::signal<void(Link const&)> on_destruction;
 143
 144   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
 145   static xbt::signal<void(Link const&)> on_state_change;
 146
 147   /** @brief Callback signal fired when the bandwidth of a Link changes */
 148   static xbt::signal<void(Link const&)> on_bandwidth_change;
 149
 150   /** @brief Callback signal fired when a communication starts */
 151   static xbt::signal<void(kernel::resource::NetworkAction&)> on_communicate;
 152
 153   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
 154   static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
 155       on_communication_state_change;
 156 };
 157
 158 /**
 159  * @beginrst
 160  * A SplitDuplexLink encapsulates the :cpp:class:`links <simgrid::s4u::Link>` which
 161  * compose a Split-Duplex link. Remember that a Split-Duplex link is nothing more than
 162  * a pair of up/down links.
 163  * @endrst
 164  */
 165 class XBT_PUBLIC SplitDuplexLink : public Link {
 166 public:
 167   explicit SplitDuplexLink(kernel::resource::LinkImplIntf* pimpl) : Link(pimpl) {}
 168   /** @brief Get the link direction up*/
 169   Link* get_link_up() const;
 170   /** @brief Get the link direction down */
 171   Link* get_link_down() const;
 172
 173   /** @brief Retrieve a link from its name */
 174   static SplitDuplexLink* by_name(const std::string& name);
 175 };
 176
 177 /**
 178  * @beginrst
 179  * Another encapsulation for using links in the :cpp:func:`NetZone::add_route`
 180  *
 181  * When adding a route with split-duplex links, you need to specify the direction of the link
 182  * so SimGrid can know exactly which physical link to insert in the route.
 183  *
 184  * For shared/fat-pipe links, use the :cpp:enum:`Direction::NONE` since they don't have
 185  * the concept of UP/DOWN links.
 186  * @endrst
 187  */
 188 class XBT_PUBLIC LinkInRoute {
 189 public:
 190   enum class Direction { UP = 2, DOWN = 1, NONE = 0 };
 191
 192   explicit LinkInRoute(const Link* link) : link_(link) {}
 193   LinkInRoute(const Link* link, Direction d) : link_(link), direction_(d) {}
 194
 195   /** @brief Get direction of this link in the route: UP or DOWN */
 196   Direction get_direction() const { return direction_; }
 197   /** @brief Get pointer to the link */
 198   const Link* get_link() const { return link_; }
 199
 200 private:
 201   const Link* link_;
 202   Direction direction_ = Direction::NONE;
 203 };
 204
 205 } // namespace s4u
 206 } // namespace simgrid
 207
 208 #endif /* S4U_LINK_HPP */