1 /* Copyright (c) 2004-2022. 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 SIMGRID_KERNEL_RESOURCE_LINKIMPL_HPP
7 #define SIMGRID_KERNEL_RESOURCE_LINKIMPL_HPP
9 #include "simgrid/kernel/resource/Model.hpp"
10 #include "simgrid/kernel/resource/NetworkModelIntf.hpp"
11 #include "simgrid/s4u/Link.hpp"
12 #include "src/kernel/lmm/maxmin.hpp"
13 #include "src/kernel/resource/Resource.hpp"
14 #include "xbt/PropertyHolder.hpp"
17 #include <unordered_map>
22 class StandardLinkImpl;
32 /** @ingroup SURF_network_interface
33 * @brief SURF network model interface class
34 * @details A model is an object which handles the interactions between its Resources and its Actions
36 class NetworkModel : public Model, public NetworkModelIntf {
38 static config::Flag<double> cfg_tcp_gamma;
39 static config::Flag<bool> cfg_crosstraffic;
42 NetworkModel(const NetworkModel&) = delete;
43 NetworkModel& operator=(const NetworkModel&) = delete;
44 ~NetworkModel() override;
47 * @brief Create a [WiFi]Link
49 * @param name The name of the Link
50 * @param bandwidths The vector of bandwidths of the Link in bytes per second
52 virtual StandardLinkImpl* create_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
54 virtual StandardLinkImpl* create_wifi_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
57 * @brief Create a communication between two hosts.
58 * @details It makes calls to the routing part, and execute the communication between the two end points.
60 * @param src The source of the communication
61 * @param dst The destination of the communication
62 * @param size The size of the communication in bytes
63 * @param rate Allows to limit the transfer rate. Negative value means unlimited.
64 * @return The action representing the communication
66 virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0;
69 * @brief Get the right multiplicative factor for the latency.
70 * @details Depending on the model, the effective latency when sending a message might be different from the
71 * theoretical latency of the link, in function of the message size. In order to account for this, this function gets
74 * @param size The size of the message.
75 * @return The latency factor.
77 virtual double get_latency_factor(double /* size */) { return sg_latency_factor; }
80 * @brief Get the right multiplicative factor for the bandwidth.
81 * @details Depending on the model, the effective bandwidth when sending a message might be different from the
82 * theoretical bandwidth of the link, in function of the message size. In order to account for this, this function
85 * @param size The size of the message.
86 * @return The bandwidth factor.
88 virtual double get_bandwidth_factor(double /* size*/) { return sg_bandwidth_factor; }
90 double next_occurring_event_full(double now) override;
92 void set_lat_factor_cb(const std::function<NetworkFactorCb>& cb) override { THROW_UNIMPLEMENTED; }
93 void set_bw_factor_cb(const std::function<NetworkFactorCb>& cb) override { THROW_UNIMPLEMENTED; }
95 StandardLinkImpl* loopback_ = nullptr;
101 class LinkImpl : public Resource_T<LinkImpl>, public xbt::PropertyHolder {
103 using Resource_T::Resource_T;
104 /** @brief Get the bandwidth in bytes per second of current Link */
105 virtual double get_bandwidth() const = 0;
106 /** @brief Update the bandwidth in bytes per second of current Link */
107 virtual void set_bandwidth(double value) = 0;
109 /** @brief Get the latency in seconds of current Link */
110 virtual double get_latency() const = 0;
111 /** @brief Update the latency in seconds of current Link */
112 virtual void set_latency(double value) = 0;
114 /** @brief The sharing policy */
115 virtual void set_sharing_policy(s4u::Link::SharingPolicy policy, const s4u::NonLinearResourceCb& cb) = 0;
116 virtual s4u::Link::SharingPolicy get_sharing_policy() const = 0;
118 /* setup the profile file with bandwidth events (peak speed changes due to external load).
119 * Profile must contain percentages (value between 0 and 1). */
120 virtual void set_bandwidth_profile(kernel::profile::Profile* profile) = 0;
121 /* setup the profile file with latency events (peak latency changes due to external load).
122 * Profile must contain absolute values */
123 virtual void set_latency_profile(kernel::profile::Profile* profile) = 0;
124 /** @brief Set the concurrency limit for this link */
125 virtual void set_concurrency_limit(int limit) const = 0;
131 /** @ingroup SURF_network_interface
132 * @brief SURF network action interface class
133 * @details A NetworkAction represents a communication between two [hosts](@ref HostImpl)
135 class NetworkAction : public Action {
140 /** @brief Constructor
142 * @param model The NetworkModel associated to this NetworkAction
143 * @param cost The cost of this NetworkAction in [TODO]
144 * @param failed [description]
146 NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed)
147 : Action(model, cost, failed), src_(src), dst_(dst)
152 * @brief NetworkAction constructor
154 * @param model The NetworkModel associated to this NetworkAction
155 * @param cost The cost of this NetworkAction in bytes
156 * @param failed Actions can be created in a failed state
157 * @param var The lmm variable associated to this Action if it is part of a LMM component
159 NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed, lmm::Variable* var)
160 : Action(model, cost, failed, var), src_(src), dst_(dst){};
162 void set_state(Action::State state) override;
163 virtual std::list<StandardLinkImpl*> get_links() const;
165 double latency_ = 0.; // Delay before the action starts
166 double lat_current_ = 0.; // Used to compute the communication RTT, and accordingly limit the communication rate
167 double sharing_penalty_ = {};
169 s4u::Host& get_src() const { return src_; }
170 s4u::Host& get_dst() const { return dst_; }
173 /* Insert link(s) at the end of vector `result' (at the beginning, and reversed, for insert_link_latency()), and add
174 * link->get_latency() to *latency when latency is not null
176 void add_link_latency(std::vector<StandardLinkImpl*>& result, StandardLinkImpl* link, double* latency);
177 void add_link_latency(std::vector<StandardLinkImpl*>& result, const std::vector<StandardLinkImpl*>& links,
179 void insert_link_latency(std::vector<StandardLinkImpl*>& result, const std::vector<StandardLinkImpl*>& links,
182 } // namespace resource
183 } // namespace kernel
184 } // namespace simgrid
186 #endif /* SIMGRID_KERNEL_RESOURCE_LINKIMPL_HPP */