include/simgrid/s4u/Link.hpp

   1 /* Copyright (c) 2004-2019. 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/kernel/resource/Action.hpp>
  10 #include <simgrid/link.h>
  11 #include <string>
  12 #include <unordered_map>
  13 #include <xbt/Extendable.hpp>
  14 #include <xbt/base.h>
  15 #include <xbt/signal.hpp>
  16
  17 /***********
  18  * Classes *
  19  ***********/
  20
  21 namespace simgrid {
  22 namespace s4u {
  23 /** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
  24 class XBT_PUBLIC Link : public xbt::Extendable<Link> {
  25   friend kernel::resource::LinkImpl;
  26
  27   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
  28   explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
  29   virtual ~Link() = default;
  30   // The private implementation, that never changes
  31   kernel::resource::LinkImpl* const pimpl_;
  32
  33 public:
  34   enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
  35
  36   kernel::resource::LinkImpl* get_impl() { return pimpl_; }
  37
  38   /** @brief Retrieve a link from its name */
  39   static Link* by_name(const std::string& name);
  40   static Link* by_name_or_null(const std::string& name);
  41
  42   /** @brief Retrieves the name of that link as a C++ string */
  43   const std::string& get_name() const;
  44   /** @brief Retrieves the name of that link as a C string */
  45   const char* get_cname() const;
  46
  47   /** @brief Get the bandwidth in bytes per second of current Link */
  48   double get_bandwidth() const;
  49
  50   /** @brief Get the latency in seconds of current Link */
  51   double get_latency() const;
  52
  53   /** @brief Describes how the link is shared between flows */
  54   SharingPolicy get_sharing_policy();
  55
  56   /** @brief Returns the current load (in flops per second) */
  57   double get_usage();
  58
  59   /** @brief Check if the Link is used (at least one flow uses the link) */
  60   bool is_used();
  61
  62   void turn_on();
  63   bool is_on() const;
  64   void turn_off();
  65
  66   void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */
  67   void set_data(void* d);
  68
  69 #ifndef DOXYGEN
  70   XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_state_profile()") void set_state_trace(
  71       kernel::profile::Profile* profile)
  72   {
  73     set_state_profile(profile);
  74   }
  75   XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_bandwidth_profile()") void set_bandwidth_trace(
  76       kernel::profile::Profile* profile)
  77   {
  78     set_bandwidth_profile(profile);
  79   }
  80   XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_latency_profile()") void set_latency_trace(
  81       kernel::profile::Profile* profile)
  82   {
  83     set_latency_profile(profile);
  84   }
  85 #endif
  86
  87   /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
  88   void set_state_profile(kernel::profile::Profile* profile);
  89   /** Setup the profile with bandwidth events (peak speed changes due to external load).
  90    * The profile must contain percentages (value between 0 and 1). */
  91   void set_bandwidth_profile(kernel::profile::Profile* profile);
  92   /** Setup the profile file with latency events (peak latency changes due to external load).
  93    * The profile must contain absolute values */
  94   void set_latency_profile(kernel::profile::Profile* profile);
  95
  96   const char* get_property(const std::string& key);
  97   void set_property(const std::string& key, const std::string& value);
  98
  99   /* The signals */
 100   /** @brief Callback signal fired when a new Link is created */
 101   static xbt::signal<void(Link&)> on_creation;
 102
 103   /** @brief Callback signal fired when a Link is destroyed */
 104   static xbt::signal<void(Link const&)> on_destruction;
 105
 106   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
 107   static xbt::signal<void(Link const&)> on_state_change;
 108
 109   /** @brief Callback signal fired when the bandwidth of a Link changes */
 110   static xbt::signal<void(Link const&)> on_bandwidth_change;
 111
 112   /** @brief Callback signal fired when a communication starts */
 113   static xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> on_communicate;
 114
 115   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
 116   static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
 117       on_communication_state_change;
 118
 119 #ifndef DOXYGEN
 120   // Deprecated methods
 121   /** @deprecated */
 122   XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
 123   /** @deprecated */
 124   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
 125   /** @deprecated */
 126   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
 127   /** @deprecated */
 128   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();}
 129   /** @deprecated */
 130   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();}
 131   /** @deprecated */
 132   XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();}
 133   /** @deprecated */
 134   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();}
 135   /** @deprecated */
 136   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();}
 137
 138   /** @deprecated */
 139   XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();}
 140   /** @deprecated */
 141   XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();}
 142
 143   /** @deprecated */
 144   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
 145   /** @deprecated */
 146   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(const std::string& key,
 147                                                                                  const std::string& value)
 148   {
 149     set_property(key, value);
 150   }
 151
 152   /** @deprecated */
 153   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
 154   /** @deprecated */
 155   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);}
 156
 157   /** @deprecated */
 158   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_profile()") void setStateTrace(
 159       kernel::profile::Profile* profile)
 160   {
 161     set_state_profile(profile);
 162   }
 163   /** @deprecated */
 164   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_profile()") void setBandwidthTrace(
 165       kernel::profile::Profile* profile)
 166   {
 167     set_bandwidth_profile(profile);
 168   }
 169   /** @deprecated */
 170   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_profile()") void setLatencyTrace(
 171       kernel::profile::Profile* profile)
 172   {
 173     set_latency_profile(profile);
 174   }
 175 #endif
 176 };
 177 } // namespace s4u
 178 } // namespace simgrid
 179
 180 #endif /* SURF_NETWORK_INTERFACE_HPP_ */