X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3487cb8ad0b2f9b896ee9c3af67a5fdbe5f3e80d..e9f0018b823e34405847177b25a85d3facc30ae1:/src/surf/network_interface.hpp diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index f863cb3024..6696895b1b 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -1,128 +1,314 @@ -/* - * network_interface.hpp - * - * Created on: Nov 29, 2013 - * Author: bedaride - */ -#include "surf.hpp" -#include "surf_routing.hpp" +/* Copyright (c) 2004-2015. 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 + +#include + +#include "xbt/fifo.h" +#include "xbt/dict.h" +#include "surf_interface.hpp" +#include "surf_routing.hpp" +#include "src/surf/PropertyHolder.hpp" + +#include "simgrid/link.h" + /*********** * Classes * ***********/ + +namespace simgrid { +namespace surf { + class NetworkModel; -typedef NetworkModel *NetworkModelPtr; +class NetworkAction; -class NetworkLink; -typedef NetworkLink *NetworkLinkPtr; +/************* + * Callbacks * + *************/ -class NetworkLinkLmm; -typedef NetworkLinkLmm *NetworkLinkLmmPtr; -class NetworkAction; -typedef NetworkAction *NetworkActionPtr; +/** @brief Callback signal fired when the state of a NetworkAction changes + * Signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)` */ +XBT_PUBLIC_DATA(simgrid::xbt::signal) networkActionStateChangedCallbacks; + +/** @brief Callback signal fired when a NetworkAction is created (when a communication starts) + * Signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)` */ +XBT_PUBLIC_DATA(simgrid::xbt::signal) networkCommunicateCallbacks; -class NetworkActionLmm; -typedef NetworkActionLmm *NetworkActionLmmPtr; +} +} /********* * Tools * *********/ - -void net_define_callbacks(void); +XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link); /********* * Model * *********/ + +namespace simgrid { +namespace surf { + +/** @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; - }; + /** @brief Constructor */ + NetworkModel() : Model() { } + + /** @brief Destructor */ ~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); + delete p_modifiedSet; } - virtual NetworkLinkPtr createResource(const char *name, + /** + * @brief Create a Link + * + * @param name The name of the Link + * @param bw_initial The initial bandwidth of the Link in bytes per second + * @param bw_trace The trace associated to the Link bandwidth + * @param lat_initial The initial latency of the Link in seconds + * @param lat_trace The trace associated to the Link latency + * @param initiallyOn The initial Link (state)[e_surf_resource_state_t] + * @param state_trace The trace associated to the Link (state)[e_surf_resource_state_t] + * @param policy The sharing policy of the Link + * @param properties Dictionary of properties associated to this Resource + * @return The created Link + */ + virtual Link* createLink(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, + int initiallyOn, 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, + /** + * @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(NetCard *src, NetCard *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 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 shareResourcesFull(double now); }; /************ * Resource * ************/ + /** @ingroup SURF_network_interface + * @brief SURF network link interface class + * @details A Link represents the link between two [hosts](\ref Host) + */ +class Link : + public simgrid::surf::Resource, + public simgrid::surf::PropertyHolder { +public: + /** + * @brief Link constructor + * + * @param model The NetworkModel associated to this Link + * @param name The name of the Link + * @param props Dictionary of properties associated to this Link + */ + Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props); + + /** + * @brief Link constructor + * + * @param model The NetworkModel associated to this Link + * @param name The name of the Link + * @param props Dictionary of properties associated to this Link + * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component + * @param history [TODO] + * @param state_trace [TODO] + */ + Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props, + lmm_constraint_t constraint, + tmgr_history_t history, + tmgr_trace_t state_trace); + + /* Link destruction logic */ + /**************************/ +protected: + ~Link(); +public: + void destroy(); // Must be called instead of the destructor +private: + bool currentlyDestroying_ = false; -class NetworkLink : virtual public Resource { public: - NetworkLink() : p_latEvent(NULL) {}; - virtual double getBandwidth()=0; + /** @brief Callback signal fired when a new Link is created. + * Signature: void(Link*) */ + static simgrid::xbt::signal onCreation; + + /** @brief Callback signal fired when a Link is destroyed. + * Signature: void(Link*) */ + static simgrid::xbt::signal onDestruction; + + /** @brief Callback signal fired when the state of a Link changes + * Signature: `void(LinkAction *action, int previouslyOn, int currentlyOn)` */ + static simgrid::xbt::signal onStateChange; + + + /** @brief Get the bandwidth in bytes per second of current Link */ + virtual double getBandwidth(); + + /** @brief Update the bandwidth in bytes per second of current Link */ + virtual void updateBandwidth(double value, double date=surf_get_clock())=0; + + /** @brief Get the latency in seconds of current Link */ virtual double getLatency(); - virtual bool isShared()=0; + + /** @brief Update the latency in seconds of current Link */ + virtual void updateLatency(double value, double date=surf_get_clock())=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; /* Using this object with the public part of model does not make sense */ - double m_latCurrent; - tmgr_trace_event_t p_latEvent; -}; + double m_latCurrent = 0; + tmgr_trace_event_t p_latEvent = NULL; + + /* LMM */ + tmgr_trace_event_t p_stateEvent = NULL; + s_surf_metric_t p_speed; -class NetworkLinkLmm : public ResourceLmm, public NetworkLink { + /* User data */ 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(); + void *getData() { return userData;} + void setData(void *d) { userData=d;} +private: + void *userData = NULL; + + /* List of all links */ +private: + static boost::unordered_map *links; +public: + static Link *byName(const char* name); + static int linksCount(); + static Link **linksList(); + static void linksExit(); }; /********** * Action * **********/ -class NetworkAction : virtual public Action { +/** @ingroup SURF_network_interface + * @brief SURF network action interface class + * @details A NetworkAction represents a communication between two [hosts](\ref Host) + */ +class NetworkAction : public simgrid::surf::Action { public: - NetworkAction() {}; + /** @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(e_surf_action_state_t state); + +#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 @@ -131,10 +317,8 @@ public: }; -class NetworkActionLmm : public ActionLmm, public NetworkAction { -public: - NetworkActionLmm() {}; -}; +} +} #endif /* SURF_NETWORK_INTERFACE_HPP_ */