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   friend kernel::resource::LinkImpl;
  34
  35   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
  36   explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
  37   virtual ~Link() = default;
  38   // The private implementation, that never changes
  39   kernel::resource::LinkImpl* const pimpl_;
  40
  41 public:
  42   enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
  43
  44   kernel::resource::LinkImpl* get_impl() const { return pimpl_; }
  45
  46   /** @brief Retrieve a link from its name */
  47   static Link* by_name(const std::string& name);
  48   static Link* by_name_or_null(const std::string& name);
  49
  50   /** @brief Retrieves the name of that link as a C++ string */
  51   const std::string& get_name() const;
  52   /** @brief Retrieves the name of that link as a C string */
  53   const char* get_cname() const;
  54
  55   /** Get/Set the bandwidth of the current Link (in bytes per second) */
  56   double get_bandwidth() const;
  57   Link* set_bandwidth(double value);
  58
  59   /** Get/Set the latency of the current Link (in seconds) */
  60   double get_latency() const;
  61   /**
  62    * @brief Set link's latency
  63    *
  64    * @param value New latency value (in s)
  65    */
  66   Link* set_latency(double value);
  67   /** @brief Set latency (string version) */
  68   Link* set_latency(const std::string& value);
  69
  70   /** @brief Describes how the link is shared between flows */
  71   SharingPolicy get_sharing_policy() const;
  72
  73   /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
  74   Link* set_state_profile(kernel::profile::Profile* profile);
  75   /** Setup the profile with bandwidth events (peak speed changes due to external load).
  76    * The profile must contain percentages (value between 0 and 1). */
  77   Link* set_bandwidth_profile(kernel::profile::Profile* profile);
  78   /** Setup the profile file with latency events (peak latency changes due to external load).
  79    * The profile must contain absolute values */
  80   Link* set_latency_profile(kernel::profile::Profile* profile);
  81
  82   const std::unordered_map<std::string, std::string>* get_properties() const;
  83   const char* get_property(const std::string& key) const;
  84   Link* set_properties(const std::unordered_map<std::string, std::string>& properties);
  85   Link* set_property(const std::string& key, const std::string& value);
  86
  87   /** @brief Set the level of communication speed of the given host on this wifi link.
  88    *
  89    * The bandwidth of a wifi link for a given host depends on its SNR (signal to noise ratio),
  90    * which ultimately depends on the distance between the host and the station and the material between them.
  91    *
  92    * This is modeled in SimGrid by providing several bandwidths to wifi links, one per SNR level (just provide
  93    * comma-separated values in the XML file). By default, the first level in the list is used, but you can use the
  94    * current function to specify that a given host uses another level of bandwidth. This can be used to take the
  95    * location of hosts into account, or even to model mobility in your SimGrid simulation.
  96    *
  97    * Note that this function asserts that the link is actually a wifi link */
  98   void set_host_wifi_rate(const s4u::Host* host, int level) const;
  99
 100   /** @brief Returns the current load (in bytes per second) */
 101   double get_usage() const;
 102
 103   /** @brief Check if the Link is used (at least one flow uses the link) */
 104   bool is_used() const;
 105
 106   /** @brief Check if the Link is shared (not a FATPIPE) */
 107   bool is_shared() const;
 108
 109   void turn_on();
 110   void turn_off();
 111   bool is_on() const;
 112
 113   void seal();
 114
 115   /* The signals */
 116   /** @brief Callback signal fired when a new Link is created */
 117   static xbt::signal<void(Link&)> on_creation;
 118
 119   /** @brief Callback signal fired when a Link is destroyed */
 120   static xbt::signal<void(Link const&)> on_destruction;
 121
 122   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
 123   static xbt::signal<void(Link const&)> on_state_change;
 124
 125   /** @brief Callback signal fired when the bandwidth of a Link changes */
 126   static xbt::signal<void(Link const&)> on_bandwidth_change;
 127
 128   /** @brief Callback signal fired when a communication starts */
 129   static xbt::signal<void(kernel::resource::NetworkAction&)> on_communicate;
 130
 131   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
 132   static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
 133       on_communication_state_change;
 134 };
 135 } // namespace s4u
 136 } // namespace simgrid
 137
 138 #endif /* S4U_LINK_HPP */