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/link.h>
11 #include <unordered_map>
12 #include <xbt/Extendable.hpp>
14 #include <xbt/signal.hpp>
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;
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_;
33 bool currentlyDestroying_ = false;
36 enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
38 virtual void destroy();
39 kernel::resource::LinkImpl* get_impl() { return pimpl_; }
41 /** @brief Retrieve a link from its name */
42 static Link* by_name(std::string name);
43 static Link* by_name_or_null(std::string name);
45 /** @brief Retrieves the name of that link as a C++ string */
46 const std::string& get_name() const;
47 /** @brief Retrieves the name of that link as a C string */
48 const char* get_cname() const;
50 /** @brief Get the bandwidth in bytes per second of current Link */
51 double get_bandwidth();
53 /** @brief Get the latency in seconds of current Link */
56 /** @brief Describes how the link is shared between flows */
57 SharingPolicy get_sharing_policy();
59 /** @brief Returns the current load (in flops per second) */
62 /** @brief Check if the Link is used (at least one flow uses the link) */
68 void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */
69 void set_data(void* d);
71 void set_state_trace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
73 void set_bandwidth_trace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
74 external load). Trace must contain percentages (value between 0 and 1). */
75 void set_latency_trace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
76 external load). Trace must contain absolute values */
78 const char* get_property(const char* key);
79 void set_property(std::string key, std::string value);
82 /** @brief Callback signal fired when a new Link is created */
83 static simgrid::xbt::signal<void(s4u::Link&)> on_creation;
85 /** @brief Callback signal fired when a Link is destroyed */
86 static simgrid::xbt::signal<void(s4u::Link&)> on_destruction;
88 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
89 static simgrid::xbt::signal<void(s4u::Link&)> on_state_change;
91 /** @brief Callback signal fired when the bandwidth of a Link changes */
92 static simgrid::xbt::signal<void(s4u::Link&)> on_bandwidth_change;
94 /** @brief Callback signal fired when a communication starts */
95 static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> on_communicate;
97 /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
98 static simgrid::xbt::signal<void(kernel::resource::NetworkAction*)> on_communication_state_change;
100 // Deprecated methods
101 XBT_ATTRIB_DEPRECATED_v321("Use get_cname(): v3.21 will turn this warning into an error.") const char* name();
102 XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
103 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
104 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
105 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();}
106 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();}
107 XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();}
108 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();}
109 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();}
111 XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();}
112 XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();}
114 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
115 XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);}
117 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
118 XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);}
120 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_trace()") void setStateTrace(tmgr_trace_t trace) {set_state_trace(trace);}
121 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_trace()") void setBandwidthTrace(tmgr_trace_t trace) {set_bandwidth_trace(trace);}
122 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_trace()") void setLatencyTrace(tmgr_trace_t trace) {set_latency_trace(trace);}
127 #endif /* SURF_NETWORK_INTERFACE_HPP_ */