X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/eb5b6b0c3c4d9a38bb205b2c8bc9aeeba8674a25..7cad4f0d54aafeabb7ee95007fc370514c4923a9:/src/surf/network_interface.hpp diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index 46cd1a4b98..b532f72be4 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -10,7 +10,6 @@ #ifndef SURF_NETWORK_INTERFACE_HPP_ #define SURF_NETWORK_INTERFACE_HPP_ - /*********** * Classes * ***********/ @@ -28,31 +27,31 @@ typedef NetworkAction *NetworkActionPtr; *************/ /** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkLink creation + * @brief Callbacks handler which emits the callbacks after NetworkLink creation * @details Callback functions have the following signature: `void(NetworkLinkPtr)` */ XBT_PUBLIC_DATA( surf_callback(void, NetworkLinkPtr)) networkLinkCreatedCallbacks; /** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkLink destruction + * @brief Callbacks handler which emits the callbacks after NetworkLink destruction * @details Callback functions have the following signature: `void(NetworkLinkPtr)` */ XBT_PUBLIC_DATA( surf_callback(void, NetworkLinkPtr)) networkLinkDestructedCallbacks; /** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkLink State changed + * @brief Callbacks handler which emits the callbacks after NetworkLink State changed * @details Callback functions have the following signature: `void(NetworkLinkActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)` */ XBT_PUBLIC_DATA( surf_callback(void, NetworkLinkPtr, e_surf_resource_state_t, e_surf_resource_state_t)) networkLinkStateChangedCallbacks; /** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after NetworkAction State changed + * @brief Callbacks handler which emits the callbacks after NetworkAction State changed * @details Callback functions have the following signature: `void(NetworkActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)` */ XBT_PUBLIC_DATA( surf_callback(void, NetworkActionPtr, e_surf_action_state_t, e_surf_action_state_t)) networkActionStateChangedCallbacks; /** @ingroup SURF_callbacks - * @brief Callbacks handler which emit the callbacks after communication created + * @brief Callbacks handler which emits the callbacks after communication created * @details Callback functions have the following signature: `void(NetworkActionPtr action, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate)` */ XBT_PUBLIC_DATA( surf_callback(void, NetworkActionPtr, RoutingEdgePtr src, RoutingEdgePtr dst, double size, double rate)) networkCommunicateCallbacks; @@ -69,7 +68,7 @@ XBT_PUBLIC(void) net_add_traces(); *********/ /** @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: @@ -77,6 +76,7 @@ public: * @brief NetworkModel constructor */ NetworkModel() : Model("network") { + f_networkSolve = lmm_solve; }; /** @@ -106,11 +106,11 @@ public: * * @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 bw_trace The trace associated to the NetworkLink bandwidth * @param lat_initial The initial latency of the NetworkLink in seconds - * @param lat_trace The trace associated to the NetworkLink latency [TODO] + * @param lat_trace The trace associated to the NetworkLink latency * @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 state_trace The trace associated to the NetworkLink (state)[e_surf_resource_state_t] * @param policy The sharing policy of the NetworkLink * @param properties Dictionary of properties associated to this Resource * @return The created NetworkLink @@ -128,13 +128,15 @@ public: virtual void gapAppend(double /*size*/, const NetworkLinkPtr /*link*/, NetworkActionPtr /*action*/) {}; /** - * @brief Create a communication between two [TODO] - * @details [TODO] + * @brief Create a communication between two workstations. + * @details It makes calls to the routing part, and execute the communication + * between the two end points. * - * @param src The source [TODO] - * @param dst The destination [TODO] + * @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, @@ -148,33 +150,40 @@ public: void (*f_networkSolve)(lmm_system_t); /** - * @brief [brief description] - * @details [long 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 [description] - * @return [description] + * @param size The size of the message. + * @return The latency factor. */ virtual double latencyFactor(double size); /** - * @brief [brief description] - * @details [long 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 [description] - * @return [description] + * @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); + double shareResourcesFull(double now); bool m_haveGap; }; @@ -183,14 +192,14 @@ public: ************/ /** @ingroup SURF_network_interface * @brief SURF network link interface class - * @details A NetworkLink represent the link between two [Workstations](\ref Workstation) + * @details A NetworkLink represents the link between two [Workstations](\ref Workstation) */ class NetworkLink : public Resource { public: /** * @brief NetworkLink constructor * - * @param model The CpuModel associated to this NetworkLink + * @param model The NetworkModel associated to this NetworkLink * @param name The name of the NetworkLink * @param props Dictionary of properties associated to this NetworkLink */ @@ -199,7 +208,7 @@ public: /** * @brief NetworkLink constructor * - * @param model The CpuModel associated to this NetworkLink + * @param model The NetworkModel 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 @@ -207,9 +216,9 @@ public: * @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); + lmm_constraint_t constraint, + tmgr_history_t history, + tmgr_trace_t state_trace); /** * @brief NetworkLink destructor @@ -242,7 +251,6 @@ public: /** * @brief Check if the NetworkLink is shared - * @details [long description] * * @return true if the current NetwokrLink is shared, false otherwise */ @@ -272,7 +280,8 @@ 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 + * [Workstations](\ref Workstation) */ class NetworkAction : public Action { public: @@ -292,7 +301,8 @@ public: * @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) {};