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 public:
  33   enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
  34
  35   /** @brief Retrieve a link from its name */
  36   static Link* by_name(const char* name);
  37
  38   /** @brief Retrieves the name of that link as a C++ string */
  39   const std::string& get_name() const;
  40   /** @brief Retrieves the name of that link as a C string */
  41   const char* get_cname() const;
  42
  43   XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
  44   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
  45   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
  46
  47   /** @brief Get the bandwidth in bytes per second of current Link */
  48   double bandwidth();
  49
  50   /** @brief Get the latency in seconds of current Link */
  51   double latency();
  52
  53   /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: SPLITDUPLEX)
  54    */
  55   SharingPolicy sharingPolicy();
  56
  57   /** @brief Returns the current load (in flops per second) */
  58   double getUsage();
  59
  60   /** @brief Check if the Link is used */
  61   bool isUsed();
  62
  63   void turnOn();
  64   void turnOff();
  65
  66   void* getData();
  67   void setData(void* d);
  68
  69   void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
  70                                              boolean values. */
  71   void setBandwidthTrace(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 setLatencyTrace(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* getProperty(const char* key);
  77   void setProperty(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   XBT_ATTRIB_DEPRECATED_v321("Use get_cname(): v3.21 will turn this warning into an error.") const char* name();
  99 };
 100 }
 101 }
 102
 103 #endif /* SURF_NETWORK_INTERFACE_HPP_ */