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/forward.h>
10 #include <simgrid/kernel/resource/Action.hpp>
11 #include <simgrid/link.h>
13 #include <unordered_map>
14 #include <xbt/Extendable.hpp>
16 #include <xbt/signal.hpp>
24 /** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
25 class XBT_PUBLIC Link : public xbt::Extendable<Link> {
26 friend kernel::resource::LinkImpl;
28 // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
29 explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
30 virtual ~Link() = default;
31 // The private implementation, that never changes
32 kernel::resource::LinkImpl* const pimpl_;
35 enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
37 kernel::resource::LinkImpl* get_impl() const { return pimpl_; }
39 /** @brief Retrieve a link from its name */
40 static Link* by_name(const std::string& name);
41 static Link* by_name_or_null(const std::string& name);
43 /** @brief Retrieves the name of that link as a C++ string */
44 const std::string& get_name() const;
45 /** @brief Retrieves the name of that link as a C string */
46 const char* get_cname() const;
48 /** @brief Get the bandwidth in bytes per second of current Link */
49 double get_bandwidth() const;
51 /** @brief Get the latency in seconds of current Link */
52 double get_latency() const;
54 /** @brief Describes how the link is shared between flows */
55 SharingPolicy get_sharing_policy();
57 /** @brief Returns the current load (in flops per second) */
60 /** @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);
71 XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_state_profile()") void set_state_trace(
72 kernel::profile::Profile* profile)
74 set_state_profile(profile);
76 XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_bandwidth_profile()") void set_bandwidth_trace(
77 kernel::profile::Profile* profile)
79 set_bandwidth_profile(profile);
81 XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_latency_profile()") void set_latency_trace(
82 kernel::profile::Profile* profile)
84 set_latency_profile(profile);
88 /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
89 void set_state_profile(kernel::profile::Profile* profile);
90 /** Setup the profile with bandwidth events (peak speed changes due to external load).
91 * The profile must contain percentages (value between 0 and 1). */
92 void set_bandwidth_profile(kernel::profile::Profile* profile);
93 /** Setup the profile file with latency events (peak latency changes due to external load).
94 * The profile must contain absolute values */
95 void set_latency_profile(kernel::profile::Profile* profile);
97 const char* get_property(const std::string& key) const;
98 void set_property(const std::string& key, const std::string& value);
101 /** @brief Callback signal fired when a new Link is created */
102 static xbt::signal<void(Link&)> on_creation;
104 /** @brief Callback signal fired when a Link is destroyed */
105 static xbt::signal<void(Link const&)> on_destruction;
107 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
108 static xbt::signal<void(Link const&)> on_state_change;
110 /** @brief Callback signal fired when the bandwidth of a Link changes */
111 static xbt::signal<void(Link const&)> on_bandwidth_change;
113 /** @brief Callback signal fired when a communication starts */
114 static xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> on_communicate;
116 /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
117 static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
118 on_communication_state_change;
121 } // namespace simgrid
123 #endif /* SURF_NETWORK_INTERFACE_HPP_ */