include/simgrid/s4u/Link.hpp

   1 /* Copyright (c) 2004-2020. 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  * @rst
  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   /** @brief Get the bandwidth in bytes per second of current Link */
  56   double get_bandwidth() const;
  57   void set_bandwidth(double value);
  58
  59   /** @brief Get the latency in seconds of current Link */
  60   double get_latency() const;
  61   void set_latency(double value);
  62
  63   /** @brief Describes how the link is shared between flows */
  64   SharingPolicy get_sharing_policy() const;
  65
  66   /** @brief Set the level of communication speed of the given host on this wifi link.
  67    *
  68    * The bandwidth of a wifi link for a given host depends on its SNR (signal to noise ratio),
  69    * which ultimately depends on the distance between the host and the station and the material between them.
  70    *
  71    * This is modeled in SimGrid by providing several bandwidths to wifi links, one per SNR level (just provide
  72    * comma-separated values in the XML file). By default, the first level in the list is used, but you can use the
  73    * current function to specify that a given host uses another level of bandwidth. This can be used to take the
  74    * location of hosts into account, or even to model mobility in your SimGrid simulation.
  75    *
  76    * Note that this function asserts that the link is actually a wifi link */
  77   void set_host_wifi_rate(s4u::Host* host, int level);
  78
  79   /** @brief Returns the current load (in bytes per second) */
  80   double get_usage() const;
  81
  82   /** @brief Check if the Link is used (at least one flow uses the link) */
  83   bool is_used() const;
  84
  85   void turn_on();
  86   bool is_on() const;
  87   void turn_off();
  88
  89   /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
  90   void set_state_profile(kernel::profile::Profile* profile);
  91   /** Setup the profile with bandwidth events (peak speed changes due to external load).
  92    * The profile must contain percentages (value between 0 and 1). */
  93   void set_bandwidth_profile(kernel::profile::Profile* profile);
  94   /** Setup the profile file with latency events (peak latency changes due to external load).
  95    * The profile must contain absolute values */
  96   void set_latency_profile(kernel::profile::Profile* profile);
  97
  98   const char* get_property(const std::string& key) const;
  99   void set_property(const std::string& key, const std::string& value);
 100
 101   /* The signals */
 102   /** @brief Callback signal fired when a new Link is created */
 103   static xbt::signal<void(Link&)> on_creation;
 104
 105   /** @brief Callback signal fired when a Link is destroyed */
 106   static xbt::signal<void(Link const&)> on_destruction;
 107
 108   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
 109   static xbt::signal<void(Link const&)> on_state_change;
 110
 111   /** @brief Callback signal fired when the bandwidth of a Link changes */
 112   static xbt::signal<void(Link const&)> on_bandwidth_change;
 113
 114   /** @brief Callback signal fired when a communication starts */
 115   static xbt::signal<void(kernel::resource::NetworkAction&)> on_communicate;
 116
 117   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
 118   static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
 119       on_communication_state_change;
 120 };
 121 } // namespace s4u
 122 } // namespace simgrid
 123
 124 #endif /* S4U_LINK_HPP */