X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/a21681e5aca1a37efb2e9001e5055dec94c5de41..f9e6853d2c5b7b867211700bc12f0ee57f640b30:/src/surf/network_interface.hpp diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index ed28c8663c..8988357d7c 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -1,9 +1,9 @@ -/* - * 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 "surf_interface.hpp" #include "surf_routing.hpp" @@ -19,14 +19,36 @@ typedef NetworkModel *NetworkModelPtr; class NetworkLink; typedef NetworkLink *NetworkLinkPtr; -class NetworkLinkLmm; -typedef NetworkLinkLmm *NetworkLinkLmmPtr; - class NetworkAction; typedef NetworkAction *NetworkActionPtr; -class NetworkActionLmm; -typedef NetworkActionLmm *NetworkActionLmmPtr; +/************* + * 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; + +/** @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; + +/** @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 * @@ -37,14 +59,31 @@ void net_define_callbacks(void); /********* * 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 + */ 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 The destructor of the NetworkModel + */ ~NetworkModel() { if (p_maxminSystem) lmm_system_free(p_maxminSystem); @@ -54,6 +93,20 @@ public: delete p_modifiedSet; } + /** + * @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 + * @param properties Dictionary of properties associated to this Resource + * @return The created NetworkLink + */ virtual NetworkLinkPtr createResource(const char *name, double bw_initial, tmgr_trace_t bw_trace, @@ -64,14 +117,56 @@ 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 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] + * @param size The size of the communication in bytes + * @param rate The + * @return The action representing the communication + */ 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 + + /** + * @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); + + /** + * @brief [brief description] + * @details [long description] + * + * @param size [description] + * @return [description] + */ virtual double latencyFactor(double size); + + /** + * @brief [brief description] + * @details [long description] + * + * @param size [description] + * @return [description] + */ virtual double bandwidthFactor(double size); + + /** + * @brief [brief description] + * @details [long description] + * + * @param rate [description] + * @param bound [description] + * @param size [description] + * @return [description] + */ virtual double bandwidthConstraint(double rate, double bound, double size); bool m_haveGap; }; @@ -79,28 +174,78 @@ public: /************ * Resource * ************/ - -class NetworkLink : virtual public 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 { public: - NetworkLink() : p_latEvent(NULL) {}; - virtual double getBandwidth()=0; + /** + * @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); + + /** + * @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); + + /** + * @brief NetworkLink destructor + */ + ~NetworkLink(); + + /** + * @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 Get the latency in seconds of current NetworkLink + * + * @return The latency in seconds of the current NetworkLink + */ virtual double getLatency(); - virtual bool isShared()=0; + + /** + * @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 NetworkLink is used + * + * @return true if the current NetwokrLink is used, false otherwise + */ + 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 { -protected: -public: - NetworkLinkLmm() {}; - NetworkLinkLmm(lmm_constraint_t constraint, tmgr_history_t history, tmgr_trace_t state_trace); - bool isShared(); - bool isUsed(); - double getBandwidth(); + /* LMM */ tmgr_trace_event_t p_stateEvent; s_surf_metric_t p_power; }; @@ -108,9 +253,44 @@ public: /********** * Action * **********/ -class NetworkAction : virtual public Action { +/** @ingroup SURF_network_interface + * @brief SURF network action interface class + * @details A NetworkAction represent a communication bettween two [Workstations](\ref Workstation) + */ +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(ModelPtr 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(ModelPtr 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; @@ -125,11 +305,6 @@ public: }; -class NetworkActionLmm : public ActionLmm, public NetworkAction { -public: - NetworkActionLmm() {}; -}; - #endif /* SURF_NETWORK_INTERFACE_HPP_ */