X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0445b0862c323d8285fba620d5137a0891527914..1bf033cc925aa31693ef5163ea056fde5b75ff1e:/src/surf/network_interface.hpp diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index 46cd1a4b98..f8b0e65a0d 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -1,270 +1,167 @@ -/* Copyright (c) 2004-2014. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2018. 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 "xbt/fifo.h" -#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/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 +#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)` - */ -XBT_PUBLIC_DATA( 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)` - */ -XBT_PUBLIC_DATA( 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)` - */ -XBT_PUBLIC_DATA( 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)` - */ -XBT_PUBLIC_DATA( 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)` - */ -XBT_PUBLIC_DATA( surf_callback(void, NetworkActionPtr, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate)) networkCommunicateCallbacks; - -/********* - * Tools * - *********/ -XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link); - -XBT_PUBLIC(void) net_add_traces(); +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 { public: - /** - * @brief NetworkModel constructor - */ - NetworkModel() : Model("network") { - }; + static simgrid::config::Flag cfg_tcp_gamma; + static simgrid::config::Flag cfg_crosstraffic; - /** - * @brief NetworkModel constructor - * - * @param name The name of the NetworkModel - */ - NetworkModel(const char *name) : Model(name) { - f_networkSolve = lmm_solve; - m_haveGap = false; - }; - - /** - * @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; - } + explicit NetworkModel(Model::UpdateAlgo algo) : Model(algo) {} + ~NetworkModel() override; /** - * @brief Create a NetworkLink + * @brief Create a 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 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 */ - virtual NetworkLinkPtr createNetworkLink(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 void gapAppend(double /*size*/, const NetworkLinkPtr /*link*/, NetworkActionPtr /*action*/) {}; + virtual LinkImpl* createLink(const std::string& name, double bandwidth, double latency, + s4u::Link::SharingPolicy policy) = 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 - */ - void (*f_networkSolve)(lmm_system_t); - - /** - * @brief [brief description] - * @details [long description] - * - * @param size [description] - * @return [description] + * @param size The size of the message. + * @return The latency factor. */ virtual double latencyFactor(double size); /** - * @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 bandwidthFactor(double size); /** - * @brief [brief description] - * @details [long description] - * - * @param rate [description] - * @param bound [description] - * @param size [description] - * @return [description] + * @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 bandwidthConstraint(double rate, double bound, double size); - bool m_haveGap; + double next_occuring_event_full(double now) override; + + 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, public simgrid::surf::PropertyHolder { +protected: + LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint); + ~LinkImpl() override; + 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 +private: + bool currentlyDestroying_ = false; - /** - * @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); +public: + /** @brief Public interface */ + s4u::Link piface_; - /** - * @brief NetworkLink destructor - */ - ~NetworkLink(); + /** @brief Get the bandwidth in bytes per second of current Link */ + virtual double get_bandwidth(); - /** - * @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 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 */ + virtual double get_latency(); - /** - * @brief Get the latency in seconds of current NetworkLink - * - * @return The latency in seconds of the current NetworkLink - */ - virtual double getLatency(); + /** @brief Update the latency in seconds of current Link */ + virtual void set_latency(double value) = 0; - /** - * @brief Update the latency in seconds of current NetworkLink - */ - virtual void updateLatency(double value, double date=surf_get_clock())=0; + /** @brief The sharing policy */ + virtual s4u::Link::SharingPolicy get_sharing_policy(); - /** - * @brief Check if the NetworkLink is shared - * @details [long description] - * - * @return true if the current NetwokrLink is shared, false otherwise - */ - virtual bool isShared(); + /** @brief Check if the Link is used */ + bool is_used() override; - /** - * @brief Check if the NetworkLink is used - * - * @return true if the current NetwokrLink is used, false otherwise - */ - bool isUsed(); + void turn_on() override; + void turn_off() override; - void setState(e_surf_resource_state_t state); + void on_bandwidth_change(); - /* Using this object with the public part of - model does not make sense */ - double m_latCurrent; - tmgr_trace_event_t p_latEvent; + 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 */ - /* LMM */ - tmgr_trace_event_t p_stateEvent; - s_surf_metric_t p_power; + 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; }; /********** @@ -272,55 +169,43 @@ 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 { 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, double cost, bool failed) : Action(model, cost, failed) {} /** * @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) {}; - - void setState(e_surf_action_state_t state); + NetworkAction(Model* model, double cost, bool failed, lmm::Variable* var) : Action(model, cost, failed, var){}; -#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 + void set_state(Action::State state) override; + virtual std::list links(); + double latency_ = {}; + double lat_current_ = {}; + double weight_ = {}; + double rate_ = {}; }; +} +} +} // namespace simgrid +/** \ingroup SURF_models + * \brief The network model + */ +XBT_PUBLIC_DATA simgrid::kernel::resource::NetworkModel* surf_network_model; #endif /* SURF_NETWORK_INTERFACE_HPP_ */