1 /* Copyright (c) 2004-2020. 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 extern template class XBT_PUBLIC xbt::Extendable<s4u::Link>;
27 /** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
28 class XBT_PUBLIC Link : public xbt::Extendable<Link> {
29 friend kernel::resource::LinkImpl;
31 // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
32 explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
33 virtual ~Link() = default;
34 // The private implementation, that never changes
35 kernel::resource::LinkImpl* const pimpl_;
38 enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
40 kernel::resource::LinkImpl* get_impl() const { return pimpl_; }
42 /** @brief Retrieve a link from its name */
43 static Link* by_name(const std::string& name);
44 static Link* by_name_or_null(const std::string& name);
46 /** @brief Retrieves the name of that link as a C++ string */
47 const std::string& get_name() const;
48 /** @brief Retrieves the name of that link as a C string */
49 const char* get_cname() const;
51 /** @brief Get the bandwidth in bytes per second of current Link */
52 double get_bandwidth() const;
54 /** @brief Get the latency in seconds of current Link */
55 double get_latency() const;
57 /** @brief Describes how the link is shared between flows */
58 SharingPolicy get_sharing_policy() const;
60 /** @brief Returns the current load (in flops per second) */
61 double get_usage() const;
63 /** @brief Check if the Link is used (at least one flow uses the link) */
70 /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
71 void set_state_profile(kernel::profile::Profile* profile);
72 /** Setup the profile with bandwidth events (peak speed changes due to external load).
73 * The profile must contain percentages (value between 0 and 1). */
74 void set_bandwidth_profile(kernel::profile::Profile* profile);
75 /** Setup the profile file with latency events (peak latency changes due to external load).
76 * The profile must contain absolute values */
77 void set_latency_profile(kernel::profile::Profile* profile);
79 const char* get_property(const std::string& key) const;
80 void set_property(const std::string& key, const std::string& value);
83 /** @brief Callback signal fired when a new Link is created */
84 static xbt::signal<void(Link&)> on_creation;
86 /** @brief Callback signal fired when a Link is destroyed */
87 static xbt::signal<void(Link const&)> on_destruction;
89 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
90 static xbt::signal<void(Link const&)> on_state_change;
92 /** @brief Callback signal fired when the bandwidth of a Link changes */
93 static xbt::signal<void(Link const&)> on_bandwidth_change;
95 /** @brief Callback signal fired when a communication starts */
96 static xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> on_communicate;
98 /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
99 static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
100 on_communication_state_change;
103 } // namespace simgrid
105 #endif /* S4U_LINK_HPP */