-/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#define SURF_NETWORK_INTERFACE_HPP_
#include "simgrid/kernel/resource/Model.hpp"
+#include "simgrid/kernel/resource/NetworkModelIntf.hpp"
#include "simgrid/kernel/resource/Resource.hpp"
#include "simgrid/s4u/Link.hpp"
#include "src/kernel/lmm/maxmin.hpp"
-#include "src/surf/PropertyHolder.hpp"
-#include "src/surf/trace_mgr.hpp"
+#include "src/surf/LinkImpl.hpp"
+#include <xbt/PropertyHolder.hpp>
#include <list>
#include <unordered_map>
* @brief SURF network model interface class
* @details A model is an object which handles the interactions between its Resources and its Actions
*/
-class NetworkModel : public Model {
+class NetworkModel : public Model, public NetworkModelIntf {
public:
- static simgrid::config::Flag<double> cfg_tcp_gamma;
- static simgrid::config::Flag<bool> cfg_crosstraffic;
+ static config::Flag<double> cfg_tcp_gamma;
+ static config::Flag<bool> cfg_crosstraffic;
- explicit NetworkModel(Model::UpdateAlgo algo) : Model(algo) {}
+ using Model::Model;
+ NetworkModel(const NetworkModel&) = delete;
+ NetworkModel& operator=(const NetworkModel&) = delete;
~NetworkModel() override;
/**
- * @brief Create a Link
+ * @brief Create a [WiFi]Link
*
* @param name The name of the Link
- * @param bandwidth The initial bandwidth of the Link in bytes per second
- * @param latency The initial latency of the Link in seconds
- * @param policy The sharing policy of the Link
+ * @param bandwidths The vector of bandwidths of the Link in bytes per second
*/
- virtual LinkImpl* create_link(const std::string& name, double bandwidth, double latency,
- s4u::Link::SharingPolicy policy) = 0;
+ virtual LinkImpl* create_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
+
+ virtual LinkImpl* create_wifi_link(const std::string& name, const std::vector<double>& bandwidths) = 0;
/**
* @brief Create a communication between two hosts.
- * @details It makes calls to the routing part, and execute the communication
- * between the two end points.
+ * @details It makes calls to the routing part, and execute the communication between the two end points.
*
* @param src The source of the communication
* @param dst The destination of the communication
* @param size The size of the communication in bytes
- * @param rate Allows to limit the transfer rate. Negative value means
- * unlimited.
+ * @param rate Allows to limit the transfer rate. Negative value means unlimited.
* @return The action representing the communication
*/
virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0;
/**
* @brief Get the right multiplicative factor for the latency.
- * @details Depending on the model, the effective latency when sending
- * a message might be different from the theoretical latency of the link,
- * in function of the message size. In order to account for this, this
- * function gets this factor.
+ * @details Depending on the model, the effective latency when sending a message might be different from the
+ * theoretical latency of the link, in function of the message size. In order to account for this, this function gets
+ * this factor.
*
* @param size The size of the message.
* @return The latency factor.
*/
- virtual double get_latency_factor(double size);
+ virtual double get_latency_factor(double /* size */) { return sg_latency_factor; }
/**
* @brief Get the right multiplicative factor for the bandwidth.
- * @details Depending on the model, the effective bandwidth when sending
- * a message might be different from the theoretical bandwidth of the link,
- * in function of the message size. In order to account for this, this
- * function gets this factor.
+ * @details Depending on the model, the effective bandwidth when sending a message might be different from the
+ * theoretical bandwidth of the link, in function of the message size. In order to account for this, this function
+ * gets this factor.
*
* @param size The size of the message.
* @return The bandwidth factor.
*/
- virtual double get_bandwidth_factor(double size);
-
- /**
- * @brief Get definitive bandwidth.
- * @details It gives the minimum bandwidth between the one that would
- * occur if no limitation was enforced, and the one arbitrary limited.
- * @param rate The desired maximum bandwidth.
- * @param bound The bandwidth with only the network taken into account.
- * @param size The size of the message.
- * @return The new bandwidth.
- */
- virtual double get_bandwidth_constraint(double rate, double bound, double size);
- double next_occuring_event_full(double now) override;
-
- LinkImpl* loopback_ = nullptr;
-};
-
-/************
- * Resource *
- ************/
-/** @ingroup SURF_network_interface
- * @brief SURF network link interface class
- * @details A Link represents the link between two [hosts](@ref simgrid::surf::HostImpl)
- */
-class LinkImpl : public Resource, public simgrid::surf::PropertyHolder {
-protected:
- LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint);
- ~LinkImpl() override;
-
-public:
- void destroy(); // Must be called instead of the destructor
-private:
- bool currently_destroying_ = false;
-
-public:
- /** @brief Public interface */
- s4u::Link piface_;
-
- /** @brief Get the bandwidth in bytes per second of current Link */
- virtual double get_bandwidth();
+ virtual double get_bandwidth_factor(double /* size*/) { return sg_bandwidth_factor; }
- /** @brief Update the bandwidth in bytes per second of current Link */
- virtual void set_bandwidth(double value) = 0;
+ double next_occurring_event_full(double now) override;
- /** @brief Get the latency in seconds of current Link */
- virtual double get_latency();
+ void set_lat_factor_cb(const std::function<NetworkFactorCb>& cb) override { THROW_UNIMPLEMENTED; }
+ void set_bw_factor_cb(const std::function<NetworkFactorCb>& cb) override { THROW_UNIMPLEMENTED; }
- /** @brief Update the latency in seconds of current Link */
- virtual void set_latency(double value) = 0;
-
- /** @brief The sharing policy */
- virtual s4u::Link::SharingPolicy get_sharing_policy();
-
- /** @brief Check if the Link is used */
- bool is_used() override;
-
- void turn_on() override;
- void turn_off() override;
-
- void on_bandwidth_change();
-
- virtual void set_bandwidth_trace(
- tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to external load).
- Trace must contain percentages (value between 0 and 1). */
- virtual void set_latency_trace(
- tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to external load).
- Trace must contain absolute values */
-
- Metric latency_ = {1.0, 0, nullptr};
- Metric bandwidth_ = {1.0, 0, nullptr};
-
- /* User data */
- void* get_data() { return userdata_; }
- void set_data(void* d) { userdata_ = d; }
-private:
- void* userdata_ = nullptr;
+ LinkImpl* loopback_ = nullptr;
};
/**********
* @details A NetworkAction represents a communication between two [hosts](@ref simgrid::surf::HostImpl)
*/
class NetworkAction : public Action {
+ s4u::Host& src_;
+ s4u::Host& dst_;
+
public:
/** @brief Constructor
*
* @param cost The cost of this NetworkAction in [TODO]
* @param failed [description]
*/
- NetworkAction(Model* model, double cost, bool failed) : Action(model, cost, failed) {}
+ NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed)
+ : Action(model, cost, failed), src_(src), dst_(dst)
+ {
+ }
/**
* @brief NetworkAction constructor
* @param failed Actions can be created in a failed state
* @param var The lmm variable associated to this Action if it is part of a LMM component
*/
- NetworkAction(Model* model, double cost, bool failed, lmm::Variable* var) : Action(model, cost, failed, var){};
+ NetworkAction(Model* model, s4u::Host& src, s4u::Host& dst, double cost, bool failed, lmm::Variable* var)
+ : Action(model, cost, failed, var), src_(src), dst_(dst){};
void set_state(Action::State state) override;
- virtual std::list<LinkImpl*> links();
+ virtual std::list<LinkImpl*> get_links() const;
+
+ double latency_ = 0.; // Delay before the action starts
+ double lat_current_ = 0.; // Used to compute the communication RTT, and accordingly limit the communication rate
+ double sharing_penalty_ = {};
- double latency_ = {};
- double lat_current_ = {};
- double weight_ = {};
- double rate_ = {};
+ s4u::Host& get_src() const { return src_; }
+ s4u::Host& get_dst() const { return dst_; }
};
-}
-}
-} // namespace simgrid
-/** @ingroup SURF_models
- * @brief The network model
- */
-XBT_PUBLIC_DATA simgrid::kernel::resource::NetworkModel* surf_network_model;
-#endif /* SURF_NETWORK_INTERFACE_HPP_ */
+/* Insert link(s) at the end of vector `result' (at the beginning, and reversed, for insert_link_latency()), and add
+ * link->get_latency() to *latency when latency is not null
+ */
+void add_link_latency(std::vector<LinkImpl*>& result, LinkImpl* link, double* latency);
+void add_link_latency(std::vector<LinkImpl*>& result, const std::vector<LinkImpl*>& links, double* latency);
+void insert_link_latency(std::vector<LinkImpl*>& result, const std::vector<LinkImpl*>& links, double* latency);
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid
+#endif /* SURF_NETWORK_INTERFACE_HPP_ */
