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