X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4871b54f42ce85370d6acdbcb7e42bf75a63b389..8a4f05a5d0b69c4f1a421bfdc1a016ae7471abb8:/src/surf/network_interface.hpp diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index 81ebd14860..9858267157 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -1,12 +1,17 @@ -/* - * network_interface.hpp - * - * Created on: Nov 29, 2013 - * Author: bedaride - */ +/* Copyright (c) 2004-2014. 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 + +#include "xbt/fifo.h" #include "surf_interface.hpp" #include "surf_routing.hpp" +#include "simgrid/link.h" + #ifndef SURF_NETWORK_INTERFACE_HPP_ #define SURF_NETWORK_INTERFACE_HPP_ @@ -14,47 +19,89 @@ * Classes * ***********/ class NetworkModel; -typedef NetworkModel *NetworkModelPtr; +class NetworkAction; -class NetworkLink; -typedef NetworkLink *NetworkLinkPtr; +/************* + * Callbacks * + *************/ -class NetworkLinkLmm; -typedef NetworkLinkLmm *NetworkLinkLmmPtr; +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emits the callbacks after Link creation + * @details Callback functions have the following signature: `void(Link*)` + */ +XBT_PUBLIC_DATA( surf_callback(void, Link*)) networkLinkCreatedCallbacks; -class NetworkAction; -typedef NetworkAction *NetworkActionPtr; +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emits the callbacks after Link destruction + * @details Callback functions have the following signature: `void(Link*)` + */ +XBT_PUBLIC_DATA( surf_callback(void, Link*)) networkLinkDestructedCallbacks; + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emits the callbacks after Link State changed + * @details Callback functions have the following signature: `void(LinkAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)` + */ +XBT_PUBLIC_DATA( surf_callback(void, Link*, e_surf_resource_state_t, e_surf_resource_state_t)) networkLinkStateChangedCallbacks; + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emits the callbacks after NetworkAction State changed + * @details Callback functions have the following signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)` + */ +XBT_PUBLIC_DATA( surf_callback(void, NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)) networkActionStateChangedCallbacks; -class NetworkActionLmm; -typedef NetworkActionLmm *NetworkActionLmmPtr; +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emits the callbacks after communication created + * @details Callback functions have the following signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)` + */ +XBT_PUBLIC_DATA( surf_callback(void, NetworkAction*, RoutingEdge *src, RoutingEdge *dst, double size, double rate)) networkCommunicateCallbacks; /********* * Tools * *********/ +XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link); -void net_define_callbacks(void); +XBT_PUBLIC(void) net_add_traces(); /********* * 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; - }; + /** @brief Constructor */ + NetworkModel() : Model("network") { } + + /** @brief Constructor */ + NetworkModel(const char *name) : Model(name) { } + + /** @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) - 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 state_initial 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, @@ -64,59 +111,195 @@ public: 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, + virtual void gapAppend(double /*size*/, const Link* /*link*/, NetworkAction */*action*/) {}; + + /** + * @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(RoutingEdge *src, RoutingEdge *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); + bool m_haveGap = false; }; /************ * Resource * ************/ - -class NetworkLink : virtual public 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 Resource { public: - NetworkLink() : p_latEvent(NULL) {}; - virtual double getBandwidth()=0; + /** + * @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(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(NetworkModel *model, const char *name, xbt_dict_t props, + lmm_constraint_t constraint, + tmgr_history_t history, + tmgr_trace_t state_trace); + + /** @brief Link destructor */ + ~Link(); + + /** @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 Check if the Link is shared + * + * @return true if the current NetwokrLink is shared, false otherwise + */ + virtual bool isShared(); + + /** @brief Check if the Link is used */ + bool isUsed(); + + void setState(e_surf_resource_state_t state); /* Using this object with the public part of model does not make sense */ double m_latCurrent; tmgr_trace_event_t p_latEvent; -}; -class NetworkLinkLmm : public ResourceLmm, public NetworkLink { + /* LMM */ + tmgr_trace_event_t p_stateEvent = NULL; + s_surf_metric_t p_power; + + /* 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 linksAmount(); + 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 Action { public: - NetworkAction() {}; + /** + * @brief NetworkAction constructor + * + * @param model The NetworkModel associated to this NetworkAction + * @param cost The cost of this NetworkAction in [TODO] + * @param failed [description] + */ + 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 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_t var) + : 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; @@ -131,11 +314,6 @@ public: }; -class NetworkActionLmm : public ActionLmm, public NetworkAction { -public: - NetworkActionLmm() {}; -}; - #endif /* SURF_NETWORK_INTERFACE_HPP_ */