-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
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)`
+ */
+XBT_PUBLIC_DATA( 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)`
+ */
+XBT_PUBLIC_DATA( 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 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
+ * @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
+ * @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;
+
/*********
* Tools *
*********/
/**
* @brief NetworkModel constructor
- *
+ *
* @param name The name of the NetworkModel
*/
NetworkModel(const char *name) : Model(name) {
/**
* @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]
/**
* @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
+ * @param rate The
* @return The action representing the communication
*/
virtual ActionPtr communicate(RoutingEdgePtr src, RoutingEdgePtr 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
- *
+ *
* @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]
*/
/**
* @brief [brief description]
* @details [long description]
- *
+ *
* @param size [description]
* @return [description]
*/
/**
* @brief [brief description]
* @details [long description]
- *
+ *
* @param rate [description]
* @param bound [description]
* @param size [description]
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 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
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 Update the bandwidth in bytes per second of current NetworkLink
+ */
+ virtual void updateBandwidth(double value, double date=surf_get_clock())=0;
+
/**
* @brief Get the latency in seconds of current NetworkLink
- *
+ *
* @return The latency in seconds of the current NetworkLink
*/
virtual double getLatency();
+ /**
+ * @brief Update the latency in seconds of current NetworkLink
+ */
+ virtual void updateLatency(double value, double date=surf_get_clock())=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;
public:
/**
* @brief NetworkAction constructor
- *
+ *
* @param model The NetworkModel associated to this NetworkAction
* @param cost The cost of this NetworkAction in [TODO]
* @param failed [description]
/**
* @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, 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;
