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 simgrid::xbt::Extendable<Link> {
  25   friend simgrid::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(std::string name);
  40   static Link* by_name_or_null(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();
  49
  50   /** @brief Get the latency in seconds of current Link */
  51   double get_latency();
  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();
  64   void turn_off();
  65   bool is_off();
  66
  67   void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */
  68   void set_data(void* d);
  69
  70 #ifndef DOXYGEN
  71   XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_state_profile()") void set_state_trace(
  72       kernel::profile::Profile* profile)
  73   {
  74     set_state_profile(profile);
  75   }
  76   XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_bandwidth_profile()") void set_bandwidth_trace(
  77       kernel::profile::Profile* profile)
  78   {
  79     set_bandwidth_profile(profile);
  80   }
  81   XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_latency_profile()") void set_latency_trace(
  82       kernel::profile::Profile* profile)
  83   {
  84     set_latency_profile(profile);
  85   }
  86 #endif
  87
  88   /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
  89   void set_state_profile(kernel::profile::Profile* profile);
  90   /** Setup the profile with bandwidth events (peak speed changes due to external load).
  91    * The profile must contain percentages (value between 0 and 1). */
  92   void set_bandwidth_profile(kernel::profile::Profile* profile);
  93   /** Setup the profile file with latency events (peak latency changes due to external load).
  94    * The profile must contain absolute values */
  95   void set_latency_profile(kernel::profile::Profile* profile);
  96
  97   const char* get_property(std::string key);
  98   void set_property(std::string key, std::string value);
  99
 100   /* The signals */
 101   /** @brief Callback signal fired when a new Link is created */
 102   static simgrid::xbt::signal<void(s4u::Link&)> on_creation;
 103
 104   /** @brief Callback signal fired when a Link is destroyed */
 105   static simgrid::xbt::signal<void(s4u::Link&)> on_destruction;
 106
 107   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
 108   static simgrid::xbt::signal<void(s4u::Link&)> on_state_change;
 109
 110   /** @brief Callback signal fired when the bandwidth of a Link changes */
 111   static simgrid::xbt::signal<void(s4u::Link&)> on_bandwidth_change;
 112
 113   /** @brief Callback signal fired when a communication starts */
 114   static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> on_communicate;
 115
 116   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
 117   static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, kernel::resource::Action::State)>
 118       on_communication_state_change;
 119
 120 #ifndef DOXYGEN
 121   // Deprecated methods
 122   /** @deprecated */
 123   XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
 124   /** @deprecated */
 125   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
 126   /** @deprecated */
 127   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
 128   /** @deprecated */
 129   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();}
 130   /** @deprecated */
 131   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();}
 132   /** @deprecated */
 133   XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();}
 134   /** @deprecated */
 135   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();}
 136   /** @deprecated */
 137   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();}
 138
 139   /** @deprecated */
 140   XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();}
 141   /** @deprecated */
 142   XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();}
 143
 144   /** @deprecated */
 145   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
 146   /** @deprecated */
 147   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);}
 148
 149   /** @deprecated */
 150   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
 151   /** @deprecated */
 152   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);}
 153
 154   /** @deprecated */
 155   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_profile()") void setStateTrace(
 156       simgrid::kernel::profile::Profile* profile) {set_state_profile(profile); }
 157   /** @deprecated */
 158   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_profile()") void setBandwidthTrace(
 159       simgrid::kernel::profile::Profile* profile) { set_bandwidth_profile(profile); }
 160   /** @deprecated */
 161   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_profile()") void setLatencyTrace(
 162       simgrid::kernel::profile::Profile* profile) { set_latency_profile(profile); }
 163 #endif
 164 };
 165 }
 166 }
 167
 168 #endif /* SURF_NETWORK_INTERFACE_HPP_ */