X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a279c221114b93985c6aa249e71cc4141082b310..78cf63c4e0797bb270e0e809f7cb41d9d598c214:/src/surf/network_interface.hpp diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index 05792b2117..ad578421b5 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -1,269 +1,156 @@ -/* Copyright (c) 2004-2014. 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. */ -#include "surf_interface.hpp" -#include "surf_routing.hpp" - #ifndef SURF_NETWORK_INTERFACE_HPP_ #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 + +#include +#include + /*********** * Classes * ***********/ -class NetworkModel; -typedef NetworkModel *NetworkModelPtr; - -class NetworkLink; -typedef NetworkLink *NetworkLinkPtr; - -class NetworkAction; -typedef NetworkAction *NetworkActionPtr; - -/************* - * Callbacks * - *************/ - -/** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkLink creation - * @details Callback functions have the following signature: `void(NetworkLinkPtr)` - */ -extern surf_callback(void, NetworkLinkPtr) networkLinkCreatedCallbacks; - -/** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkLink destruction - * @details Callback functions have the following signature: `void(NetworkLinkPtr)` - */ -extern surf_callback(void, NetworkLinkPtr) networkLinkDestructedCallbacks; - -/** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkLink State changed - * @details Callback functions have the following signature: `void(NetworkLinkActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)` - */ -extern surf_callback(void, NetworkLinkPtr, e_surf_resource_state_t, e_surf_resource_state_t) networkLinkStateChangedCallbacks; - -/** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkAction State changed - * @details Callback functions have the following signature: `void(NetworkActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)` - */ -extern surf_callback(void, NetworkActionPtr, e_surf_action_state_t, e_surf_action_state_t) networkActionStateChangedCallbacks; - -/** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after communication created - * @details Callback functions have the following signature: `void(NetworkActionPtr action, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate)` - */ -extern surf_callback(void, NetworkActionPtr, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate) networkCommunicateCallbacks; - -/********* - * Tools * - *********/ - -void net_define_callbacks(void); +namespace simgrid { +namespace kernel { +namespace resource { /********* * Model * *********/ + /** @ingroup SURF_network_interface * @brief SURF network model interface class - * @details A model is an object which handle the interactions between its Resources and its Actions + * @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: - /** - * @brief NetworkModel constructor - */ - NetworkModel() : Model("network") { - }; - - /** - * @brief NetworkModel constructor - * - * @param name The name of the NetworkModel - */ - NetworkModel(const char *name) : Model(name) { - f_networkSolve = lmm_solve; - m_haveGap = false; - }; + static config::Flag cfg_tcp_gamma; + static config::Flag cfg_crosstraffic; - /** - * @brief The destructor of the NetworkModel - */ - ~NetworkModel() { - if (p_maxminSystem) - lmm_system_free(p_maxminSystem); - if (p_actionHeap) - xbt_heap_free(p_actionHeap); - if (p_modifiedSet) - delete p_modifiedSet; - } + using Model::Model; + NetworkModel(const NetworkModel&) = delete; + NetworkModel& operator=(const NetworkModel&) = delete; + ~NetworkModel() override; /** - * @brief Create a NetworkLink + * @brief Create a [WiFi]Link * - * @param name The name of the NetworkLink - * @param bw_initial The initial bandwidth of the NetworkLink in bytes per second - * @param bw_trace The trace associated to the NetworkLink bandwidth [TODO] - * @param lat_initial The initial latency of the NetworkLink in seconds - * @param lat_trace The trace associated to the NetworkLink latency [TODO] - * @param state_initial The initial NetworkLink (state)[e_surf_resource_state_t] - * @param state_trace The trace associated to the NetworkLink (state)[e_surf_resource_state_t] [TODO] - * @param policy The sharing policy of the NetworkLink - * @param properties Dictionary of properties associated to this Resource - * @return The created NetworkLink + * @param name The name of the Link + * @param bandwidths The vector of bandwidths of the Link in bytes per second */ - virtual NetworkLinkPtr createResource(const char *name, - double bw_initial, - tmgr_trace_t bw_trace, - double lat_initial, - tmgr_trace_t lat_trace, - e_surf_resource_state_t state_initial, - tmgr_trace_t state_trace, - e_surf_link_sharing_policy_t policy, - xbt_dict_t properties)=0; + virtual LinkImpl* create_link(const std::string& name, const std::vector& bandwidths) = 0; - - virtual void gapAppend(double /*size*/, const NetworkLinkPtr /*link*/, NetworkActionPtr /*action*/) {}; + virtual LinkImpl* create_wifi_link(const std::string& name, const std::vector& bandwidths) = 0; /** - * @brief Create a communication between two [TODO] - * @details [TODO] + * @brief Create a communication between two hosts. + * @details It makes calls to the routing part, and execute the communication between the two end points. * - * @param src The source [TODO] - * @param dst The destination [TODO] + * @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 The + * @param rate Allows to limit the transfer rate. Negative value means unlimited. * @return The action representing the communication */ - virtual ActionPtr communicate(RoutingEdgePtr src, RoutingEdgePtr dst, - double size, double rate)=0; + virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0; /** - * @brief Function pointer to the function to use to solve the lmm_system_t + * @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. * - * @param system The lmm_system_t to solve + * @param size The size of the message. + * @return The latency factor. */ - void (*f_networkSolve)(lmm_system_t); + virtual double get_latency_factor(double /* size */) { return sg_latency_factor; } /** - * @brief [brief description] - * @details [long description] + * @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. * - * @param size [description] - * @return [description] + * @param size The size of the message. + * @return The bandwidth factor. */ - virtual double latencyFactor(double size); + virtual double get_bandwidth_factor(double /* size*/) { return sg_bandwidth_factor; } - /** - * @brief [brief description] - * @details [long description] - * - * @param size [description] - * @return [description] - */ - virtual double bandwidthFactor(double size); + double next_occurring_event_full(double now) override; - /** - * @brief [brief description] - * @details [long description] - * - * @param rate [description] - * @param bound [description] - * @param size [description] - * @return [description] - */ - virtual double bandwidthConstraint(double rate, double bound, double size); - bool m_haveGap; + void set_lat_factor_cb(const std::function& cb) override { THROW_UNIMPLEMENTED; } + void set_bw_factor_cb(const std::function& cb) override { THROW_UNIMPLEMENTED; } + + LinkImpl* loopback_ = nullptr; }; /************ * Resource * ************/ - /** @ingroup SURF_network_interface - * @brief SURF network link interface class - * @details A NetworkLink represent the link between two [Workstations](\ref Workstation) - */ -class NetworkLink : public 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_T, public xbt::PropertyHolder { + s4u::Link piface_; + +protected: + explicit LinkImpl(const std::string& name); + LinkImpl(const LinkImpl&) = delete; + LinkImpl& operator=(const LinkImpl&) = delete; + ~LinkImpl() override = default; // Use destroy() instead of this destructor. + public: - /** - * @brief NetworkLink constructor - * - * @param model The CpuModel associated to this NetworkLink - * @param name The name of the NetworkLink - * @param props Dictionary of properties associated to this NetworkLink - */ - NetworkLink(NetworkModelPtr model, const char *name, xbt_dict_t props); + void destroy(); // Must be called instead of the destructor - /** - * @brief NetworkLink constructor - * - * @param model The CpuModel associated to this NetworkLink - * @param name The name of the NetworkLink - * @param props Dictionary of properties associated to this NetworkLink - * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component - * @param history [TODO] - * @param state_trace [TODO] - */ - NetworkLink(NetworkModelPtr model, const char *name, xbt_dict_t props, - lmm_constraint_t constraint, - tmgr_history_t history, - tmgr_trace_t state_trace); + void latency_check(double latency) const; - /** - * @brief NetworkLink destructor - */ - ~NetworkLink(); + /** @brief Public interface */ + const s4u::Link* get_iface() const { return &piface_; } + s4u::Link* get_iface() { return &piface_; } - /** - * @brief Get the bandwidth in bytes per second of current NetworkLink - * - * @return The bandwith in bytes per second of the current NetworkLink - */ - virtual double getBandwidth(); + /** @brief Get the bandwidth in bytes per second of current Link */ + 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 Update the bandwidth in bytes per second of current NetworkLink - */ - virtual void updateBandwidth(double value, double date=surf_get_clock())=0; + /** @brief Get the latency in seconds of current Link */ + double get_latency() const { return latency_.peak * latency_.scale; } + /** @brief Update the latency in seconds of current Link */ + virtual LinkImpl* set_latency(double value) = 0; - /** - * @brief Get the latency in seconds of current NetworkLink - * - * @return The latency in seconds of the current NetworkLink - */ - virtual double getLatency(); + /** @brief The sharing policy */ + virtual LinkImpl* set_sharing_policy(s4u::Link::SharingPolicy policy); + virtual s4u::Link::SharingPolicy get_sharing_policy() const; - /** - * @brief Update the latency in seconds of current NetworkLink - */ - virtual void updateLatency(double value, double date=surf_get_clock())=0; + /** @brief Check if the Link is used */ + bool is_used() const override; - /** - * @brief Check if the NetworkLink is shared - * @details [long description] - * - * @return true if the current NetwokrLink is shared, false otherwise - */ - virtual bool isShared(); + void turn_on() override; + void turn_off() override; - /** - * @brief Check if the NetworkLink is used - * - * @return true if the current NetwokrLink is used, false otherwise - */ - bool isUsed(); + void seal() override; - void setState(e_surf_resource_state_t state); + void on_bandwidth_change() const; - /* Using this object with the public part of - model does not make sense */ - double m_latCurrent; - tmgr_trace_event_t p_latEvent; + /* 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); - /* LMM */ - tmgr_trace_event_t p_stateEvent; - s_surf_metric_t p_power; + Metric latency_ = {0.0, 1, nullptr}; + Metric bandwidth_ = {1.0, 1, nullptr}; }; /********** @@ -271,56 +158,55 @@ public: **********/ /** @ingroup SURF_network_interface * @brief SURF network action interface class - * @details A NetworkAction represent a communication bettween two [Workstations](\ref Workstation) + * @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 NetworkAction constructor + /** @brief Constructor * * @param model The NetworkModel associated to this NetworkAction * @param cost The cost of this NetworkAction in [TODO] * @param failed [description] */ - NetworkAction(ModelPtr 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 model The NetworkModel associated to this NetworkAction - * @param cost The cost of this NetworkAction in [TODO] - * @param failed [description] + * @param cost The cost of this NetworkAction in bytes + * @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(ModelPtr model, double cost, bool failed, lmm_variable_t 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 setState(e_surf_action_state_t state); + void set_state(Action::State state) override; + virtual std::list get_links() const; -#ifdef HAVE_LATENCY_BOUND_TRACKING - /** - * @brief Check if the action is limited by latency. - * - * @return 1 if action is limited by latency, 0 otherwise - */ - virtual int getLatencyLimited() {return m_latencyLimited;} -#endif - - double m_latency; - double m_latCurrent; - double m_weight; - double m_rate; - const char* p_senderLinkName; - double m_senderGap; - double m_senderSize; - xbt_fifo_item_t p_senderFifoItem; -#ifdef HAVE_LATENCY_BOUND_TRACKING - int m_latencyLimited; -#endif + 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_ = {}; + s4u::Host& get_src() const { return src_; } + s4u::Host& get_dst() const { return dst_; } }; -#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& result, LinkImpl* link, double* latency); +void add_link_latency(std::vector& result, const std::vector& links, double* latency); +void insert_link_latency(std::vector& result, const std::vector& links, double* latency); +} // namespace resource +} // namespace kernel +} // namespace simgrid +#endif /* SURF_NETWORK_INTERFACE_HPP_ */