X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4871b54f42ce85370d6acdbcb7e42bf75a63b389..f2907d4c4e2bfdd55ae8a7c41711b731d106f668:/src/surf/network_interface.hpp diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index 81ebd14860..59c93ccc0e 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -1,140 +1,220 @@ -/* - * network_interface.hpp - * - * Created on: Nov 29, 2013 - * Author: bedaride - */ -#include "surf_interface.hpp" -#include "surf_routing.hpp" +/* Copyright (c) 2004-2017. 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. */ #ifndef SURF_NETWORK_INTERFACE_HPP_ #define SURF_NETWORK_INTERFACE_HPP_ +#include "simgrid/s4u/Link.hpp" +#include "src/surf/PropertyHolder.hpp" +#include "src/surf/surf_interface.hpp" +#include "xbt/base.h" +#include +#include + /*********** * Classes * ***********/ -class NetworkModel; -typedef NetworkModel *NetworkModelPtr; - -class NetworkLink; -typedef NetworkLink *NetworkLinkPtr; - -class NetworkLinkLmm; -typedef NetworkLinkLmm *NetworkLinkLmmPtr; - -class NetworkAction; -typedef NetworkAction *NetworkActionPtr; - -class NetworkActionLmm; -typedef NetworkActionLmm *NetworkActionLmmPtr; - -/********* - * Tools * - *********/ - -void net_define_callbacks(void); +namespace simgrid { +namespace surf { /********* * Model * *********/ + +/** @ingroup SURF_network_interface + * @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 { public: - NetworkModel() : Model("network") { - }; - NetworkModel(string name) : Model(name) { - f_networkSolve = lmm_solve; - m_haveGap = false; - }; - ~NetworkModel() { - if (p_maxminSystem) - lmm_system_free(p_maxminSystem); - if (p_actionHeap) - xbt_heap_free(p_actionHeap); - if (p_modifiedSet) - xbt_swag_free(p_modifiedSet); - } - - 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; - - //FIXME:void updateActionsStateLazy(double now, double delta); - virtual void gapAppend(double /*size*/, const NetworkLinkLmmPtr /*link*/, NetworkActionLmmPtr /*action*/) {}; - virtual ActionPtr communicate(RoutingEdgePtr src, RoutingEdgePtr dst, - double size, double rate)=0; - virtual xbt_dynar_t getRoute(RoutingEdgePtr src, RoutingEdgePtr dst); //FIXME: kill field? That is done by the routing nowadays - void (*f_networkSolve)(lmm_system_t); + /** @brief Constructor */ + NetworkModel() : Model() {} + + /** @brief Destructor */ + ~NetworkModel() override; + + /** + * @brief Create a 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 + */ + virtual LinkImpl* createLink(const char* name, double bandwidth, double latency, + e_surf_link_sharing_policy_t policy) = 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. + * + * @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. + * @return The action representing the communication + */ + virtual Action* communicate(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double size, double rate) = 0; + + /** @brief Function pointer to the function to use to solve the lmm_system_t + * + * @param system The lmm_system_t to solve + */ + void (*f_networkSolve)(lmm_system_t) = lmm_solve; + + /** + * @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 size The size of the message. + * @return The latency factor. + */ virtual double latencyFactor(double size); + + /** + * @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 The size of the message. + * @return The bandwidth factor. + */ virtual double bandwidthFactor(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 bandwidthConstraint(double rate, double bound, double size); - bool m_haveGap; + double nextOccuringEventFull(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 simgrid::surf::Resource, public simgrid::surf::PropertyHolder { +protected: + LinkImpl(simgrid::surf::NetworkModel* model, const char* name, lmm_constraint_t constraint); + ~LinkImpl() override; -class NetworkLink : virtual public Resource { public: - NetworkLink() : p_latEvent(NULL) {}; - virtual double getBandwidth()=0; - virtual double getLatency(); - virtual bool isShared()=0; - - /* Using this object with the public part of - model does not make sense */ - double m_latCurrent; - tmgr_trace_event_t p_latEvent; -}; + void destroy(); // Must be called instead of the destructor +private: + bool currentlyDestroying_ = false; -class NetworkLinkLmm : public ResourceLmm, public NetworkLink { public: - NetworkLinkLmm() {}; - NetworkLinkLmm(lmm_system_t system, - double constraint_value, - tmgr_history_t history, - e_surf_resource_state_t state_init, - tmgr_trace_t state_trace, - double metric_peak, - tmgr_trace_t metric_trace) - : ResourceLmm(system, constraint_value, history, state_init, state_trace, metric_peak, metric_trace) -{ -} - bool isShared(); - bool isUsed(); - double getBandwidth(); + /** @brief Public interface */ + s4u::Link piface_; + + /** @brief Get the bandwidth in bytes per second of current Link */ + virtual double bandwidth(); + + /** @brief Update the bandwidth in bytes per second of current Link */ + virtual void setBandwidth(double value) = 0; + + /** @brief Get the latency in seconds of current Link */ + virtual double latency(); + + /** @brief Update the latency in seconds of current Link */ + virtual void setLatency(double value) = 0; + + /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: + * FULLDUPLEX) */ + virtual int sharingPolicy(); + + /** @brief Check if the Link is used */ + bool isUsed() override; + + void turnOn() override; + void turnOff() override; + + virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). + Trace must contain boolean values. */ + virtual void setBandwidthTrace( + 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 setLatencyTrace( + tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to external load). + Trace must contain absolute values */ + + tmgr_trace_event_t stateEvent_ = nullptr; + s_surf_metric_t latency_ = {1.0, 0, nullptr}; + s_surf_metric_t bandwidth_ = {1.0, 0, nullptr}; + + /* User data */ + void* getData() { return userData; } + void setData(void* d) { userData = d; } +private: + void* userData = nullptr; + + /* List of all links. FIXME: should move to the Engine */ + static std::unordered_map* links; + +public: + static LinkImpl* byName(const char* name); + static int linksCount(); + static LinkImpl** linksList(); + static void linksExit(); }; /********** * Action * **********/ -class NetworkAction : virtual public Action { -public: - NetworkAction() {}; - 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 - -}; - -class NetworkActionLmm : public ActionLmm, public NetworkAction { +/** @ingroup SURF_network_interface + * @brief SURF network action interface class + * @details A NetworkAction represents a communication between two [hosts](\ref HostImpl) + */ +class NetworkAction : public simgrid::surf::Action { public: - NetworkActionLmm() {}; + /** @brief Constructor + * + * @param model The NetworkModel associated to this NetworkAction + * @param cost The cost of this NetworkAction in [TODO] + * @param failed [description] + */ + NetworkAction(simgrid::surf::Model* model, double cost, bool failed) : simgrid::surf::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 var The lmm variable associated to this Action if it is part of a LMM component + */ + NetworkAction(simgrid::surf::Model* model, double cost, bool failed, lmm_variable_t var) + : simgrid::surf::Action(model, cost, failed, var){}; + + void setState(simgrid::surf::Action::State state) override; + virtual std::list links(); + + double latency_; + double latCurrent_; + double weight_; + double rate_; }; +} +} #endif /* SURF_NETWORK_INTERFACE_HPP_ */