X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c7b4fbf9bd362ef98af378f5f87d437a7ffa28e8..e9f0018b823e34405847177b25a85d3facc30ae1:/src/surf/network_interface.hpp diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index 994991b3d2..6696895b1b 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -1,89 +1,72 @@ -/* Copyright (c) 2004-2014. The SimGrid Team. +/* 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" -#ifndef SURF_NETWORK_INTERFACE_HPP_ -#define SURF_NETWORK_INTERFACE_HPP_ +#include "simgrid/link.h" /*********** * Classes * ***********/ -class NetworkModel; -typedef NetworkModel *NetworkModelPtr; -class NetworkLink; -typedef NetworkLink *NetworkLinkPtr; +namespace simgrid { +namespace surf { +class NetworkModel; 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; +/** @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; -/** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkLink State changed * - * @details Callback functions have the following signature: `void(NetworkLinkActionPtr)` - */ -extern surf_callback(void, NetworkLinkPtr) networkLinkStateChangedCallbacks; +/** @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; -/** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkAction State changed * - * @details Callback functions have the following signature: `void(NetworkActionPtr)` - */ -extern surf_callback(void, NetworkActionPtr) networkActionStateChangedCallbacks; +} +} /********* * 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 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") { - }; - - /** - * @brief NetworkModel constructor - * - * @param name The name of the NetworkModel - */ - NetworkModel(const char *name) : Model(name) { - f_networkSolve = lmm_solve; - m_haveGap = false; - }; + /** @brief Constructor */ + NetworkModel() : Model() { } - /** - * @brief The destructor of the NetworkModel - */ + /** @brief Destructor */ ~NetworkModel() { if (p_maxminSystem) lmm_system_free(p_maxminSystem); @@ -94,92 +77,85 @@ public: } /** - * @brief Create a NetworkLink - * - * @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 + * @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 NetworkLink + * @return The created Link */ - virtual NetworkLinkPtr createResource(const char *name, + 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; - - virtual void gapAppend(double /*size*/, const NetworkLinkPtr /*link*/, NetworkActionPtr /*action*/) {}; - /** - * @brief Create a communication between two [TODO] - * @details [TODO] - * - * @param src The source [TODO] - * @param dst The destination [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 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, + virtual Action *communicate(NetCard *src, NetCard *dst, double size, double rate)=0; - /** - * @brief Get the route between two RoutingEdge - * @details [TODO] - * - * @param src [TODO] - * @param dst [TODO] - * - * @return A xbt_dynar_t of [TODO] - */ - virtual xbt_dynar_t getRoute(RoutingEdgePtr src, RoutingEdgePtr dst); //FIXME: kill field? That is done by the routing nowadays - - /** - * @brief Function pointer to the function to use to solve the 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); + void (*f_networkSolve)(lmm_system_t) = lmm_solve; /** - * @brief [brief description] - * @details [long description] - * - * @param size [description] - * @return [description] + * @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 [brief description] - * @details [long description] - * - * @param size [description] - * @return [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 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 shareResourcesFull(double now); }; /************ @@ -187,78 +163,104 @@ public: ************/ /** @ingroup SURF_network_interface * @brief SURF network link interface class - * @details A NetworkLink represent the link between two [Workstations](\ref Workstation) + * @details A Link represents the link between two [hosts](\ref Host) */ -class NetworkLink : public Resource { +class Link : + public simgrid::surf::Resource, + public simgrid::surf::PropertyHolder { 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 + * @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 */ - NetworkLink(NetworkModelPtr model, const char *name, xbt_dict_t props); + Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props); /** - * @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 + * @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] */ - NetworkLink(NetworkModelPtr model, const char *name, xbt_dict_t props, - lmm_constraint_t constraint, - tmgr_history_t history, - tmgr_trace_t state_trace); + 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; - /** - * @brief NetworkLink destructor - */ - ~NetworkLink(); +public: + /** @brief Callback signal fired when a new Link is created. + * Signature: void(Link*) */ + static simgrid::xbt::signal onCreation; - /** - * @brief Get the bandwidth in bytes per second of current NetworkLink - * - * @return The bandwith in bytes per second of the current NetworkLink - */ + /** @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 Get the latency in seconds of current NetworkLink - * - * @return The latency in seconds of the current NetworkLink - */ + /** @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(); - /** - * @brief Check if the NetworkLink is shared - * @details [long description] - * - * @return true if the current NetwokrLink is shared, false otherwise - */ - virtual bool isShared(); + /** @brief Update the latency in seconds of current Link */ + virtual void updateLatency(double value, double date=surf_get_clock())=0; - /** - * @brief Check if the NetworkLink is used - * - * @return true if the current NetwokrLink is used, false otherwise - */ - bool isUsed(); + /** @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 setState(e_surf_resource_state_t state); + 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; - s_surf_metric_t p_power; + tmgr_trace_event_t p_stateEvent = NULL; + s_surf_metric_t p_speed; + + /* User data */ +public: + 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(); }; /********** @@ -266,30 +268,30 @@ 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 Host) */ -class NetworkAction : public Action { +class NetworkAction : public simgrid::surf::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(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 + * @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(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); @@ -307,7 +309,6 @@ public: 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 @@ -316,6 +317,9 @@ public: }; +} +} + #endif /* SURF_NETWORK_INTERFACE_HPP_ */