1 /* Copyright (c) 2004-2018. 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> {
26 friend simgrid::kernel::resource::LinkImpl;
29 // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
30 explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
31 virtual ~Link() = default;
32 // The private implementation, that never changes
33 kernel::resource::LinkImpl* const pimpl_;
36 enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
38 kernel::resource::LinkImpl* get_impl() { return pimpl_; }
40 /** @brief Retrieve a link from its name */
41 static Link* by_name(std::string name);
42 static Link* by_name_or_null(std::string name);
44 /** @brief Retrieves the name of that link as a C++ string */
45 const std::string& get_name() const;
46 /** @brief Retrieves the name of that link as a C string */
47 const char* get_cname() const;
49 /** @brief Get the bandwidth in bytes per second of current Link */
50 double get_bandwidth();
52 /** @brief Get the latency in seconds of current Link */
55 /** @brief Describes how the link is shared between flows */
56 SharingPolicy get_sharing_policy();
58 /** @brief Returns the current load (in flops per second) */
61 /** @brief Check if the Link is used (at least one flow uses the link) */
67 void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */
68 void set_data(void* d);
70 void set_state_trace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
72 void set_bandwidth_trace(tmgr_trace_t 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(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
75 external load). Trace must contain absolute values */
77 const char* get_property(std::string key);
78 void set_property(std::string key, std::string value);
81 /** @brief Callback signal fired when a new Link is created */
82 static simgrid::xbt::signal<void(s4u::Link&)> on_creation;
84 /** @brief Callback signal fired when a Link is destroyed */
85 static simgrid::xbt::signal<void(s4u::Link&)> on_destruction;
87 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
88 static simgrid::xbt::signal<void(s4u::Link&)> on_state_change;
90 /** @brief Callback signal fired when the bandwidth of a Link changes */
91 static simgrid::xbt::signal<void(s4u::Link&)> on_bandwidth_change;
93 /** @brief Callback signal fired when a communication starts */
94 static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> on_communicate;
96 /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
97 static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, kernel::resource::Action::State)>
98 on_communication_state_change;
100 // Deprecated methods
102 XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
104 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
106 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
108 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();}
110 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();}
112 XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();}
114 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();}
116 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();}
119 XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();}
121 XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();}
124 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
126 XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);}
129 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
131 XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);}
134 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_trace()") void setStateTrace(tmgr_trace_t trace) {set_state_trace(trace);}
136 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_trace()") void setBandwidthTrace(tmgr_trace_t trace) {set_bandwidth_trace(trace);}
138 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_trace()") void setLatencyTrace(tmgr_trace_t trace) {set_latency_trace(trace);}
143 #endif /* SURF_NETWORK_INTERFACE_HPP_ */