1 /* Copyright (c) 2004-2021. 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. */
6 #ifndef SURF_NETWORK_INTERFACE_HPP_
7 #define SURF_NETWORK_INTERFACE_HPP_
9 #include "simgrid/kernel/resource/Model.hpp"
10 #include "simgrid/kernel/resource/Resource.hpp"
11 #include "simgrid/s4u/Link.hpp"
12 #include "src/kernel/lmm/maxmin.hpp"
13 #include <xbt/PropertyHolder.hpp>
16 #include <unordered_map>
29 /** @ingroup SURF_network_interface
30 * @brief SURF network model interface class
31 * @details A model is an object which handles the interactions between its Resources and its Actions
33 class NetworkModel : public Model {
35 static config::Flag<double> cfg_tcp_gamma;
36 static config::Flag<bool> cfg_crosstraffic;
39 NetworkModel(const NetworkModel&) = delete;
40 NetworkModel& operator=(const NetworkModel&) = delete;
41 ~NetworkModel() override;
44 * @brief Create a Link
46 * @param name The name of the Link
47 * @param bandwidth The initial bandwidth of the Link in bytes per second
48 * @param latency The initial latency of the Link in seconds
49 * @param policy The sharing policy of the Link
51 virtual LinkImpl* create_link(const std::string& name, const std::vector<double>& bandwidths, double latency,
52 s4u::Link::SharingPolicy policy) = 0;
55 * @brief Create a communication between two hosts.
56 * @details It makes calls to the routing part, and execute the communication between the two end points.
58 * @param src The source of the communication
59 * @param dst The destination of the communication
60 * @param size The size of the communication in bytes
61 * @param rate Allows to limit the transfer rate. Negative value means unlimited.
62 * @return The action representing the communication
64 virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0;
67 * @brief Get the right multiplicative factor for the latency.
68 * @details Depending on the model, the effective latency when sending a message might be different from the
69 * theoretical latency of the link, in function of the message size. In order to account for this, this function gets
72 * @param size The size of the message.
73 * @return The latency factor.
75 virtual double get_latency_factor(double size);
78 * @brief Get the right multiplicative factor for the bandwidth.
79 * @details Depending on the model, the effective bandwidth when sending a message might be different from the
80 * theoretical bandwidth of the link, in function of the message size. In order to account for this, this function
83 * @param size The size of the message.
84 * @return The bandwidth factor.
86 virtual double get_bandwidth_factor(double size);
89 * @brief Get definitive bandwidth.
90 * @details It gives the minimum bandwidth between the one that would occur if no limitation was enforced, and the
91 * one arbitrary limited.
92 * @param rate The desired maximum bandwidth.
93 * @param bound The bandwidth with only the network taken into account.
94 * @param size The size of the message.
95 * @return The new bandwidth.
97 virtual double get_bandwidth_constraint(double rate, double bound, double size);
98 double next_occurring_event_full(double now) override;
100 LinkImpl* loopback_ = nullptr;
106 /** @ingroup SURF_network_interface
107 * @brief SURF network link interface class
108 * @details A Link represents the link between two [hosts](@ref simgrid::surf::HostImpl)
110 class LinkImpl : public Resource, public xbt::PropertyHolder {
111 bool currently_destroying_ = false;
115 LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint);
116 LinkImpl(const LinkImpl&) = delete;
117 LinkImpl& operator=(const LinkImpl&) = delete;
118 ~LinkImpl() override;
121 void destroy(); // Must be called instead of the destructor
123 /** @brief Public interface */
124 const s4u::Link* get_iface() const { return &piface_; }
125 s4u::Link* get_iface() { return &piface_; }
127 /** @brief Get the bandwidth in bytes per second of current Link */
128 double get_bandwidth() const;
130 /** @brief Update the bandwidth in bytes per second of current Link */
131 virtual void set_bandwidth(double value) = 0;
133 /** @brief Get the latency in seconds of current Link */
134 double get_latency() const;
136 /** @brief Update the latency in seconds of current Link */
137 virtual void set_latency(double value) = 0;
139 /** @brief The sharing policy */
140 virtual s4u::Link::SharingPolicy get_sharing_policy() const;
142 /** @brief Check if the Link is used */
143 bool is_used() const override;
145 void turn_on() override;
146 void turn_off() override;
148 void on_bandwidth_change() const;
151 set_bandwidth_profile(kernel::profile::Profile* profile); /*< setup the profile file with bandwidth events
152 (peak speed changes due to external load). Trace must
153 contain percentages (value between 0 and 1). */
155 set_latency_profile(kernel::profile::Profile* profile); /*< setup the trace file with latency events (peak
156 latency changes due to external load). Trace must contain
159 Metric latency_ = {0.0, 0, nullptr};
160 Metric bandwidth_ = {1.0, 0, nullptr};
166 /** @ingroup SURF_network_interface
167 * @brief SURF network action interface class
168 * @details A NetworkAction represents a communication between two [hosts](@ref simgrid::surf::HostImpl)
170 class NetworkAction : public Action {
175 /** @brief Constructor
177 * @param model The NetworkModel associated to this NetworkAction
178 * @param cost The cost of this NetworkAction in [TODO]
179 * @param failed [description]
181 NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed)
182 : Action(model, cost, failed), src_(src), dst_(dst)
187 * @brief NetworkAction constructor
189 * @param model The NetworkModel associated to this NetworkAction
190 * @param cost The cost of this NetworkAction in bytes
191 * @param failed Actions can be created in a failed state
192 * @param var The lmm variable associated to this Action if it is part of a LMM component
194 NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed, lmm::Variable* var)
195 : Action(model, cost, failed, var), src_(src), dst_(dst){};
197 void set_state(Action::State state) override;
198 virtual std::list<LinkImpl*> get_links() const;
200 double latency_ = {};
201 double lat_current_ = {};
202 double sharing_penalty_ = {};
204 s4u::Host& get_src() const { return src_; }
205 s4u::Host& get_dst() const { return dst_; }
207 } // namespace resource
208 } // namespace kernel
209 } // namespace simgrid
211 /** @ingroup SURF_models
212 * @brief The network model
214 XBT_PUBLIC_DATA simgrid::kernel::resource::NetworkModel* surf_network_model;
216 #endif /* SURF_NETWORK_INTERFACE_HPP_ */