Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge remote-tracking branch 'upstream/master'
[simgrid.git] / 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   kernel::resource::LinkImpl* get_impl() { return pimpl_; }
36
37   /** @brief Retrieve a link from its name */
38   static Link* by_name(std::string name);
39   static Link* by_name_or_null(std::string name);
40
41   /** @brief Retrieves the name of that link as a C++ string */
42   const std::string& get_name() const;
43   /** @brief Retrieves the name of that link as a C string */
44   const char* get_cname() const;
45
46   /** @brief Get the bandwidth in bytes per second of current Link */
47   double get_bandwidth();
48
49   /** @brief Get the latency in seconds of current Link */
50   double get_latency();
51
52   /** @brief Describes how the link is shared between flows */
53   SharingPolicy get_sharing_policy();
54
55   /** @brief Returns the current load (in flops per second) */
56   double get_usage();
57
58   /** @brief Check if the Link is used (at least one flow uses the link) */
59   bool is_used();
60
61   void turn_on();
62   void turn_off();
63
64   void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */
65   void set_data(void* d);
66
67   void set_state_trace(tmgr_trace_t trace);     /*< setup the trace file with states events (ON or OFF). Trace must contain
68                                                   boolean values. */
69   void set_bandwidth_trace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
70                                                   external load). Trace must contain percentages (value between 0 and 1). */
71   void set_latency_trace(tmgr_trace_t trace);   /*< setup the trace file with latency events (peak latency changes due to
72                                                   external load). Trace must contain absolute values */
73
74   const char* get_property(const char* key);
75   void set_property(std::string key, std::string value);
76
77   /* The signals */
78   /** @brief Callback signal fired when a new Link is created */
79   static simgrid::xbt::signal<void(s4u::Link&)> on_creation;
80
81   /** @brief Callback signal fired when a Link is destroyed */
82   static simgrid::xbt::signal<void(s4u::Link&)> on_destruction;
83
84   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
85   static simgrid::xbt::signal<void(s4u::Link&)> on_state_change;
86
87   /** @brief Callback signal fired when the bandwidth of a Link changes */
88   static simgrid::xbt::signal<void(s4u::Link&)> on_bandwidth_change;
89
90   /** @brief Callback signal fired when a communication starts */
91   static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> on_communicate;
92
93   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
94   static simgrid::xbt::signal<void(kernel::resource::NetworkAction*)> on_communication_state_change;
95
96   // Deprecated methods
97   XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
98   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
99   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
100   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();}
101   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();}
102   XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();}
103   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();}
104   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();}
105
106   XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();}
107   XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();}
108
109   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
110   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);}
111
112   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
113   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);}
114
115   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_trace()") void setStateTrace(tmgr_trace_t trace) {set_state_trace(trace);}
116   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_trace()") void setBandwidthTrace(tmgr_trace_t trace) {set_bandwidth_trace(trace);}
117   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_trace()") void setLatencyTrace(tmgr_trace_t trace) {set_latency_trace(trace);}
118 };
119 }
120 }
121
122 #endif /* SURF_NETWORK_INTERFACE_HPP_ */