include/simgrid/s4u/Link.hpp

   1 /* Copyright (c) 2004-2018. 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/link.h>
  10 #include <string>
  11 #include <unordered_map>
  12 #include <xbt/Extendable.hpp>
  13 #include <xbt/base.h>
  14 #include <xbt/signal.hpp>
  15
  16 /***********
  17  * Classes *
  18  ***********/
  19
  20 namespace simgrid {
  21 namespace s4u {
  22 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
  23 class XBT_PUBLIC Link : public simgrid::xbt::Extendable<Link> {
  24   friend simgrid::kernel::resource::LinkImpl;
  25
  26   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
  27   explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
  28   virtual ~Link() = default;
  29   // The private implementation, that never changes
  30   kernel::resource::LinkImpl* const pimpl_;
  31
  32   bool currentlyDestroying_ = false;
  33
  34 public:
  35   enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
  36
  37   kernel::resource::LinkImpl* get_impl() { return pimpl_; }
  38
  39   /** @brief Retrieve a link from its name */
  40   static Link* by_name(std::string name);
  41   static Link* by_name_or_null(std::string name);
  42
  43   /** @brief Retrieves the name of that link as a C++ string */
  44   const std::string& get_name() const;
  45   /** @brief Retrieves the name of that link as a C string */
  46   const char* get_cname() const;
  47
  48   /** @brief Get the bandwidth in bytes per second of current Link */
  49   double get_bandwidth();
  50
  51   /** @brief Get the latency in seconds of current Link */
  52   double get_latency();
  53
  54   /** @brief Describes how the link is shared between flows */
  55   SharingPolicy get_sharing_policy();
  56
  57   /** @brief Returns the current load (in flops per second) */
  58   double get_usage();
  59
  60   /** @brief Check if the Link is used (at least one flow uses the link) */
  61   bool is_used();
  62
  63   void turn_on();
  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   void set_state_trace(tmgr_trace_t trace);     /*< setup the trace file with states events (ON or OFF). Trace must contain
  70                                                   boolean values. */
  71   void set_bandwidth_trace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
  72                                                   external load). Trace must contain percentages (value between 0 and 1). */
  73   void set_latency_trace(tmgr_trace_t trace);   /*< setup the trace file with latency events (peak latency changes due to
  74                                                   external load). Trace must contain absolute values */
  75
  76   const char* get_property(const char* key);
  77   void set_property(std::string key, std::string value);
  78
  79   /* The signals */
  80   /** @brief Callback signal fired when a new Link is created */
  81   static simgrid::xbt::signal<void(s4u::Link&)> on_creation;
  82
  83   /** @brief Callback signal fired when a Link is destroyed */
  84   static simgrid::xbt::signal<void(s4u::Link&)> on_destruction;
  85
  86   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
  87   static simgrid::xbt::signal<void(s4u::Link&)> on_state_change;
  88
  89   /** @brief Callback signal fired when the bandwidth of a Link changes */
  90   static simgrid::xbt::signal<void(s4u::Link&)> on_bandwidth_change;
  91
  92   /** @brief Callback signal fired when a communication starts */
  93   static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> on_communicate;
  94
  95   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
  96   static simgrid::xbt::signal<void(kernel::resource::NetworkAction*)> on_communication_state_change;
  97
  98   // Deprecated methods
  99   XBT_ATTRIB_DEPRECATED_v321("Use get_cname(): v3.21 will turn this warning into an error.") const char* name();
 100   XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
 101   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
 102   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
 103   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();}
 104   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();}
 105   XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();}
 106   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();}
 107   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();}
 108
 109   XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();}
 110   XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();}
 111
 112   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
 113   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);}
 114
 115   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
 116   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);}
 117
 118   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_trace()") void setStateTrace(tmgr_trace_t trace) {set_state_trace(trace);}
 119   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_trace()") void setBandwidthTrace(tmgr_trace_t trace) {set_bandwidth_trace(trace);}
 120   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_trace()") void setLatencyTrace(tmgr_trace_t trace) {set_latency_trace(trace);}
 121 };
 122 }
 123 }
 124
 125 #endif /* SURF_NETWORK_INTERFACE_HPP_ */