-/* Copyright (c) 2004-2019. 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 <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 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, const std::vector<double>& bandwidths, 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.
* @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.
* @param size The size of the message.
* @return The bandwidth factor.
*/
- virtual double get_bandwidth_factor(double size);
+ virtual double get_bandwidth_factor(double /* size*/) { return sg_bandwidth_factor; }
- /**
- * @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;
+ double next_occurring_event_full(double now) override;
+
+ 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; }
LinkImpl* loopback_ = nullptr;
};
* @brief SURF network link interface class
* @details A Link represents the link between two [hosts](@ref simgrid::surf::HostImpl)
*/
-class LinkImpl : public Resource, public surf::PropertyHolder {
- bool currently_destroying_ = false;
+class LinkImpl : public Resource_T<LinkImpl>, public xbt::PropertyHolder {
+ s4u::Link piface_;
protected:
- LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint);
+ explicit LinkImpl(const std::string& name);
LinkImpl(const LinkImpl&) = delete;
LinkImpl& operator=(const LinkImpl&) = delete;
- ~LinkImpl() override;
+ ~LinkImpl() override = default; // Use destroy() instead of this destructor.
public:
void destroy(); // Must be called instead of the destructor
+ void latency_check(double latency) const;
+
/** @brief Public interface */
- s4u::Link piface_;
+ const s4u::Link* get_iface() const { return &piface_; }
+ s4u::Link* get_iface() { return &piface_; }
/** @brief Get the bandwidth in bytes per second of current Link */
- virtual double get_bandwidth();
-
+ double get_bandwidth() const { return bandwidth_.peak * bandwidth_.scale; }
/** @brief Update the bandwidth in bytes per second of current Link */
virtual void set_bandwidth(double value) = 0;
/** @brief Get the latency in seconds of current Link */
- virtual double get_latency();
-
+ double get_latency() const { return latency_.peak * latency_.scale; }
/** @brief Update the latency in seconds of current Link */
- virtual void set_latency(double value) = 0;
+ virtual LinkImpl* set_latency(double value) = 0;
/** @brief The sharing policy */
- virtual s4u::Link::SharingPolicy get_sharing_policy();
+ virtual LinkImpl* set_sharing_policy(s4u::Link::SharingPolicy policy);
+ virtual s4u::Link::SharingPolicy get_sharing_policy() const;
/** @brief Check if the Link is used */
- bool is_used() override;
+ bool is_used() const override;
void turn_on() override;
void turn_off() override;
- void on_bandwidth_change();
+ void seal() override;
- virtual void
- set_bandwidth_profile(kernel::profile::Profile* profile); /*< setup the profile file with bandwidth events
- (peak speed changes due to external load). Trace must
- contain percentages (value between 0 and 1). */
- virtual void
- set_latency_profile(kernel::profile::Profile* profile); /*< setup the trace file with latency events (peak
- latency changes due to external load). Trace must contain
- absolute values */
+ void on_bandwidth_change() const;
- Metric latency_ = {1.0, 0, nullptr};
- Metric bandwidth_ = {1.0, 0, nullptr};
+ /* setup the profile file with bandwidth events (peak speed changes due to external load).
+ * Profile must contain percentages (value between 0 and 1). */
+ virtual LinkImpl* set_bandwidth_profile(kernel::profile::Profile* profile);
+ /* setup the profile file with latency events (peak latency changes due to external load).
+ * Profile must contain absolute values */
+ virtual LinkImpl* set_latency_profile(kernel::profile::Profile* profile);
+ void set_concurrency_limit(int limit) const;
+
+ Metric latency_ = {0.0, 1, nullptr};
+ Metric bandwidth_ = {1.0, 1, 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() const;
+ virtual std::list<LinkImpl*> get_links() const;
- double latency_ = {};
- double lat_current_ = {};
+ 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 rate_ = {};
+
+ s4u::Host& get_src() const { return src_; }
+ s4u::Host& get_dst() const { return dst_; }
};
+
+/* 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
-/** @ingroup SURF_models
- * @brief The network model
- */
-XBT_PUBLIC_DATA simgrid::kernel::resource::NetworkModel* surf_network_model;
-
#endif /* SURF_NETWORK_INTERFACE_HPP_ */
-
-
