1 /* Copyright (c) 2004-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef SURF_NETWORK_INTERFACE_HPP_
8 #define SURF_NETWORK_INTERFACE_HPP_
12 #include <boost/unordered_map.hpp>
16 #include "surf_interface.hpp"
17 #include "surf_routing.hpp"
19 #include "simgrid/link.h"
31 /** @ingroup SURF_callbacks
32 * @brief Callbacks handler which emits the callbacks after Link creation
33 * @details Callback functions have the following signature: `void(Link*)`
35 XBT_PUBLIC_DATA( surf_callback(void, Link*)) networkLinkCreatedCallbacks;
37 /** @ingroup SURF_callbacks
38 * @brief Callbacks handler which emits the callbacks after Link destruction
39 * @details Callback functions have the following signature: `void(Link*)`
41 XBT_PUBLIC_DATA( surf_callback(void, Link*)) networkLinkDestructedCallbacks;
43 /** @ingroup SURF_callbacks
44 * @brief Callbacks handler which emits the callbacks after Link State changed
45 * @details Callback functions have the following signature: `void(LinkAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
47 XBT_PUBLIC_DATA( surf_callback(void, Link*, e_surf_resource_state_t, e_surf_resource_state_t)) networkLinkStateChangedCallbacks;
49 /** @ingroup SURF_callbacks
50 * @brief Callbacks handler which emits the callbacks after NetworkAction State changed
51 * @details Callback functions have the following signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)`
53 XBT_PUBLIC_DATA( surf_callback(void, NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)) networkActionStateChangedCallbacks;
55 /** @ingroup SURF_callbacks
56 * @brief Callbacks handler which emits the callbacks after communication created
57 * @details Callback functions have the following signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)`
59 XBT_PUBLIC_DATA( surf_callback(void, NetworkAction*, RoutingEdge *src, RoutingEdge *dst, double size, double rate)) networkCommunicateCallbacks;
64 XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link);
66 XBT_PUBLIC(void) net_add_traces();
71 /** @ingroup SURF_network_interface
72 * @brief SURF network model interface class
73 * @details A model is an object which handles the interactions between its Resources and its Actions
75 class NetworkModel : public Model {
77 /** @brief Constructor */
78 NetworkModel() : Model() { }
80 /** @brief Destructor */
83 lmm_system_free(p_maxminSystem);
85 xbt_heap_free(p_actionHeap);
91 * @brief Create a Link
93 * @param name The name of the Link
94 * @param bw_initial The initial bandwidth of the Link in bytes per second
95 * @param bw_trace The trace associated to the Link bandwidth
96 * @param lat_initial The initial latency of the Link in seconds
97 * @param lat_trace The trace associated to the Link latency
98 * @param state_initial The initial Link (state)[e_surf_resource_state_t]
99 * @param state_trace The trace associated to the Link (state)[e_surf_resource_state_t]
100 * @param policy The sharing policy of the Link
101 * @param properties Dictionary of properties associated to this Resource
102 * @return The created Link
104 virtual Link* createLink(const char *name,
106 tmgr_trace_t bw_trace,
108 tmgr_trace_t lat_trace,
109 e_surf_resource_state_t state_initial,
110 tmgr_trace_t state_trace,
111 e_surf_link_sharing_policy_t policy,
112 xbt_dict_t properties)=0;
114 virtual void gapAppend(double /*size*/, const Link* /*link*/, NetworkAction * /*action*/) {};
117 * @brief Create a communication between two hosts.
118 * @details It makes calls to the routing part, and execute the communication
119 * between the two end points.
121 * @param src The source of the communication
122 * @param dst The destination of the communication
123 * @param size The size of the communication in bytes
124 * @param rate Allows to limit the transfer rate. Negative value means
126 * @return The action representing the communication
128 virtual Action *communicate(RoutingEdge *src, RoutingEdge *dst,
129 double size, double rate)=0;
131 /** @brief Function pointer to the function to use to solve the lmm_system_t
133 * @param system The lmm_system_t to solve
135 void (*f_networkSolve)(lmm_system_t) = lmm_solve;
138 * @brief Get the right multiplicative factor for the latency.
139 * @details Depending on the model, the effective latency when sending
140 * a message might be different from the theoretical latency of the link,
141 * in function of the message size. In order to account for this, this
142 * function gets this factor.
144 * @param size The size of the message.
145 * @return The latency factor.
147 virtual double latencyFactor(double size);
150 * @brief Get the right multiplicative factor for the bandwidth.
151 * @details Depending on the model, the effective bandwidth when sending
152 * a message might be different from the theoretical bandwidth of the link,
153 * in function of the message size. In order to account for this, this
154 * function gets this factor.
156 * @param size The size of the message.
157 * @return The bandwidth factor.
159 virtual double bandwidthFactor(double size);
162 * @brief Get definitive bandwidth.
163 * @details It gives the minimum bandwidth between the one that would
164 * occur if no limitation was enforced, and the one arbitrary limited.
165 * @param rate The desired maximum bandwidth.
166 * @param bound The bandwidth with only the network taken into account.
167 * @param size The size of the message.
168 * @return The new bandwidth.
170 virtual double bandwidthConstraint(double rate, double bound, double size);
171 double shareResourcesFull(double now);
172 bool m_haveGap = false;
178 /** @ingroup SURF_network_interface
179 * @brief SURF network link interface class
180 * @details A Link represents the link between two [hosts](\ref Host)
182 class Link : public Resource {
185 * @brief Link constructor
187 * @param model The NetworkModel associated to this Link
188 * @param name The name of the Link
189 * @param props Dictionary of properties associated to this Link
191 Link(NetworkModel *model, const char *name, xbt_dict_t props);
194 * @brief Link constructor
196 * @param model The NetworkModel associated to this Link
197 * @param name The name of the Link
198 * @param props Dictionary of properties associated to this Link
199 * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
200 * @param history [TODO]
201 * @param state_trace [TODO]
203 Link(NetworkModel *model, const char *name, xbt_dict_t props,
204 lmm_constraint_t constraint,
205 tmgr_history_t history,
206 tmgr_trace_t state_trace);
208 /** @brief Link destructor */
211 /** @brief Get the bandwidth in bytes per second of current Link */
212 virtual double getBandwidth();
214 /** @brief Update the bandwidth in bytes per second of current Link */
215 virtual void updateBandwidth(double value, double date=surf_get_clock())=0;
217 /** @brief Get the latency in seconds of current Link */
218 virtual double getLatency();
220 /** @brief Update the latency in seconds of current Link */
221 virtual void updateLatency(double value, double date=surf_get_clock())=0;
224 * @brief Check if the Link is shared
226 * @return true if the current NetwokrLink is shared, false otherwise
228 virtual bool isShared();
230 /** @brief Check if the Link is used */
233 void setState(e_surf_resource_state_t state);
235 /* Using this object with the public part of
236 model does not make sense */
238 tmgr_trace_event_t p_latEvent;
241 tmgr_trace_event_t p_stateEvent = NULL;
242 s_surf_metric_t p_power;
246 void *getData() { return userData;}
247 void setData(void *d) { userData=d;}
249 void *userData = NULL;
251 /* List of all links */
253 static boost::unordered_map<std::string, Link *> *links;
255 static Link *byName(const char* name);
256 static int linksAmount();
257 static Link **linksList();
258 static void linksExit();
264 /** @ingroup SURF_network_interface
265 * @brief SURF network action interface class
266 * @details A NetworkAction represents a communication between two [hosts](\ref Host)
268 class NetworkAction : public Action {
270 /** @brief Constructor
272 * @param model The NetworkModel associated to this NetworkAction
273 * @param cost The cost of this NetworkAction in [TODO]
274 * @param failed [description]
276 NetworkAction(Model *model, double cost, bool failed)
277 : Action(model, cost, failed) {}
280 * @brief NetworkAction constructor
282 * @param model The NetworkModel associated to this NetworkAction
283 * @param cost The cost of this NetworkAction in [TODO]
284 * @param failed [description]
285 * @param var The lmm variable associated to this Action if it is part of a
288 NetworkAction(Model *model, double cost, bool failed, lmm_variable_t var)
289 : Action(model, cost, failed, var) {};
291 void setState(e_surf_action_state_t state);
293 #ifdef HAVE_LATENCY_BOUND_TRACKING
295 * @brief Check if the action is limited by latency.
297 * @return 1 if action is limited by latency, 0 otherwise
299 virtual int getLatencyLimited() {return m_latencyLimited;}
306 const char* p_senderLinkName;
309 xbt_fifo_item_t p_senderFifoItem;
310 #ifdef HAVE_LATENCY_BOUND_TRACKING
311 int m_latencyLimited;
316 #endif /* SURF_NETWORK_INTERFACE_HPP_ */