1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
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. */
9 #include <simgrid/kernel/resource/Action.hpp>
10 #include <simgrid/link.h>
12 #include <unordered_map>
13 #include <xbt/Extendable.hpp>
15 #include <xbt/signal.hpp>
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;
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_;
34 enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
36 kernel::resource::LinkImpl* get_impl() { return pimpl_; }
38 /** @brief Retrieve a link from its name */
39 static Link* by_name(const std::string& name);
40 static Link* by_name_or_null(const std::string& name);
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;
47 /** @brief Get the bandwidth in bytes per second of current Link */
48 double get_bandwidth();
50 /** @brief Get the latency in seconds of current Link */
53 /** @brief Describes how the link is shared between flows */
54 SharingPolicy get_sharing_policy();
56 /** @brief Returns the current load (in flops per second) */
59 /** @brief Check if the Link is used (at least one flow uses the link) */
66 void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */
67 void set_data(void* d);
70 XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_state_profile()") void set_state_trace(
71 kernel::profile::Profile* profile)
73 set_state_profile(profile);
75 XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_bandwidth_profile()") void set_bandwidth_trace(
76 kernel::profile::Profile* profile)
78 set_bandwidth_profile(profile);
80 XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_latency_profile()") void set_latency_trace(
81 kernel::profile::Profile* profile)
83 set_latency_profile(profile);
87 /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
88 void set_state_profile(kernel::profile::Profile* profile);
89 /** Setup the profile with bandwidth events (peak speed changes due to external load).
90 * The profile must contain percentages (value between 0 and 1). */
91 void set_bandwidth_profile(kernel::profile::Profile* profile);
92 /** Setup the profile file with latency events (peak latency changes due to external load).
93 * The profile must contain absolute values */
94 void set_latency_profile(kernel::profile::Profile* profile);
96 const char* get_property(const std::string& key);
97 void set_property(const std::string& key, const std::string& value);
100 /** @brief Callback signal fired when a new Link is created */
101 static simgrid::xbt::signal<void(s4u::Link&)> on_creation;
103 /** @brief Callback signal fired when a Link is destroyed */
104 static simgrid::xbt::signal<void(s4u::Link&)> on_destruction;
106 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
107 static simgrid::xbt::signal<void(s4u::Link&)> on_state_change;
109 /** @brief Callback signal fired when the bandwidth of a Link changes */
110 static simgrid::xbt::signal<void(s4u::Link&)> on_bandwidth_change;
112 /** @brief Callback signal fired when a communication starts */
113 static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> on_communicate;
115 /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
116 static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, kernel::resource::Action::State)>
117 on_communication_state_change;
120 // Deprecated methods
122 XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
124 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
126 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
128 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();}
130 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();}
132 XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();}
134 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();}
136 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();}
139 XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();}
141 XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();}
144 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
146 XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(const std::string& key,
147 const std::string& value)
149 set_property(key, value);
153 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
155 XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);}
158 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_profile()") void setStateTrace(
159 simgrid::kernel::profile::Profile* profile) {set_state_profile(profile); }
161 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_profile()") void setBandwidthTrace(
162 simgrid::kernel::profile::Profile* profile) { set_bandwidth_profile(profile); }
164 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_profile()") void setLatencyTrace(
165 simgrid::kernel::profile::Profile* profile) { set_latency_profile(profile); }
171 #endif /* SURF_NETWORK_INTERFACE_HPP_ */