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"
18 #include "src/surf/PropertyHolder.hpp"
20 #include "simgrid/link.h"
36 /** @ingroup SURF_callbacks
37 * @brief Callbacks handler which emits the callbacks after Link creation
38 * @details Callback functions have the following signature: `void(Link*)`
40 XBT_PUBLIC_DATA( surf_callback(void, simgrid::surf::Link*)) networkLinkCreatedCallbacks;
42 /** @ingroup SURF_callbacks
43 * @brief Callbacks handler which emits the callbacks after Link destruction
44 * @details Callback functions have the following signature: `void(Link*)`
46 XBT_PUBLIC_DATA( surf_callback(void, simgrid::surf::Link*)) networkLinkDestructedCallbacks;
48 /** @ingroup SURF_callbacks
49 * @brief Callbacks handler which emits the callbacks after Link State changed
50 * @details Callback functions have the following signature: `void(LinkAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
52 XBT_PUBLIC_DATA( surf_callback(void, simgrid::surf::Link*, e_surf_resource_state_t, e_surf_resource_state_t)) networkLinkStateChangedCallbacks;
54 /** @ingroup SURF_callbacks
55 * @brief Callbacks handler which emits the callbacks after NetworkAction State changed
56 * @details Callback functions have the following signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)`
58 XBT_PUBLIC_DATA( surf_callback(void, simgrid::surf::NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)) networkActionStateChangedCallbacks;
60 /** @ingroup SURF_callbacks
61 * @brief Callbacks handler which emits the callbacks after communication created
62 * @details Callback functions have the following signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)`
64 XBT_PUBLIC_DATA( surf_callback(void, simgrid::surf::NetworkAction*, simgrid::surf::RoutingEdge *src, simgrid::surf::RoutingEdge *dst, double size, double rate)) networkCommunicateCallbacks;
72 XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link);
74 XBT_PUBLIC(void) net_add_traces();
83 /** @ingroup SURF_network_interface
84 * @brief SURF network model interface class
85 * @details A model is an object which handles the interactions between its Resources and its Actions
87 class NetworkModel : public Model {
89 /** @brief Constructor */
90 NetworkModel() : Model() { }
92 /** @brief Destructor */
95 lmm_system_free(p_maxminSystem);
97 xbt_heap_free(p_actionHeap);
103 * @brief Create a Link
105 * @param name The name of the Link
106 * @param bw_initial The initial bandwidth of the Link in bytes per second
107 * @param bw_trace The trace associated to the Link bandwidth
108 * @param lat_initial The initial latency of the Link in seconds
109 * @param lat_trace The trace associated to the Link latency
110 * @param state_initial The initial Link (state)[e_surf_resource_state_t]
111 * @param state_trace The trace associated to the Link (state)[e_surf_resource_state_t]
112 * @param policy The sharing policy of the Link
113 * @param properties Dictionary of properties associated to this Resource
114 * @return The created Link
116 virtual Link* createLink(const char *name,
118 tmgr_trace_t bw_trace,
120 tmgr_trace_t lat_trace,
121 e_surf_resource_state_t state_initial,
122 tmgr_trace_t state_trace,
123 e_surf_link_sharing_policy_t policy,
124 xbt_dict_t properties)=0;
127 * @brief Create a communication between two hosts.
128 * @details It makes calls to the routing part, and execute the communication
129 * between the two end points.
131 * @param src The source of the communication
132 * @param dst The destination of the communication
133 * @param size The size of the communication in bytes
134 * @param rate Allows to limit the transfer rate. Negative value means
136 * @return The action representing the communication
138 virtual Action *communicate(RoutingEdge *src, RoutingEdge *dst,
139 double size, double rate)=0;
141 /** @brief Function pointer to the function to use to solve the lmm_system_t
143 * @param system The lmm_system_t to solve
145 void (*f_networkSolve)(lmm_system_t) = lmm_solve;
148 * @brief Get the right multiplicative factor for the latency.
149 * @details Depending on the model, the effective latency when sending
150 * a message might be different from the theoretical latency of the link,
151 * in function of the message size. In order to account for this, this
152 * function gets this factor.
154 * @param size The size of the message.
155 * @return The latency factor.
157 virtual double latencyFactor(double size);
160 * @brief Get the right multiplicative factor for the bandwidth.
161 * @details Depending on the model, the effective bandwidth when sending
162 * a message might be different from the theoretical bandwidth of the link,
163 * in function of the message size. In order to account for this, this
164 * function gets this factor.
166 * @param size The size of the message.
167 * @return The bandwidth factor.
169 virtual double bandwidthFactor(double size);
172 * @brief Get definitive bandwidth.
173 * @details It gives the minimum bandwidth between the one that would
174 * occur if no limitation was enforced, and the one arbitrary limited.
175 * @param rate The desired maximum bandwidth.
176 * @param bound The bandwidth with only the network taken into account.
177 * @param size The size of the message.
178 * @return The new bandwidth.
180 virtual double bandwidthConstraint(double rate, double bound, double size);
181 double shareResourcesFull(double now);
187 /** @ingroup SURF_network_interface
188 * @brief SURF network link interface class
189 * @details A Link represents the link between two [hosts](\ref Host)
191 class Link : public simgrid::surf::Resource, public simgrid::surf::PropertyHolder {
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
200 Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props);
203 * @brief Link constructor
205 * @param model The NetworkModel associated to this Link
206 * @param name The name of the Link
207 * @param props Dictionary of properties associated to this Link
208 * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
209 * @param history [TODO]
210 * @param state_trace [TODO]
212 Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props,
213 lmm_constraint_t constraint,
214 tmgr_history_t history,
215 tmgr_trace_t state_trace);
217 /** @brief Link destructor */
220 /** @brief Get the bandwidth in bytes per second of current Link */
221 virtual double getBandwidth();
223 /** @brief Update the bandwidth in bytes per second of current Link */
224 virtual void updateBandwidth(double value, double date=surf_get_clock())=0;
226 /** @brief Get the latency in seconds of current Link */
227 virtual double getLatency();
229 /** @brief Update the latency in seconds of current Link */
230 virtual void updateLatency(double value, double date=surf_get_clock())=0;
232 /** @brief The sharing policy is a @{link #e_surf_link_sharing_policy_t} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
233 virtual int sharingPolicy();
235 /** @brief Check if the Link is used */
238 void setState(e_surf_resource_state_t state);
240 /* Using this object with the public part of
241 model does not make sense */
242 double m_latCurrent = 0;
243 tmgr_trace_event_t p_latEvent = NULL;
246 tmgr_trace_event_t p_stateEvent = NULL;
247 s_surf_metric_t p_speed;
251 void *getData() { return userData;}
252 void setData(void *d) { userData=d;}
254 void *userData = NULL;
256 /* List of all links */
258 static boost::unordered_map<std::string, Link *> *links;
260 static Link *byName(const char* name);
261 static int linksAmount();
262 static Link **linksList();
263 static void linksExit();
269 /** @ingroup SURF_network_interface
270 * @brief SURF network action interface class
271 * @details A NetworkAction represents a communication between two [hosts](\ref Host)
273 class NetworkAction : public simgrid::surf::Action {
275 /** @brief Constructor
277 * @param model The NetworkModel associated to this NetworkAction
278 * @param cost The cost of this NetworkAction in [TODO]
279 * @param failed [description]
281 NetworkAction(simgrid::surf::Model *model, double cost, bool failed)
282 : simgrid::surf::Action(model, cost, failed) {}
285 * @brief NetworkAction constructor
287 * @param model The NetworkModel associated to this NetworkAction
288 * @param cost The cost of this NetworkAction in [TODO]
289 * @param failed [description]
290 * @param var The lmm variable associated to this Action if it is part of a
293 NetworkAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
294 : simgrid::surf::Action(model, cost, failed, var) {};
296 void setState(e_surf_action_state_t state);
298 #ifdef HAVE_LATENCY_BOUND_TRACKING
300 * @brief Check if the action is limited by latency.
302 * @return 1 if action is limited by latency, 0 otherwise
304 virtual int getLatencyLimited() {return m_latencyLimited;}
311 const char* p_senderLinkName;
313 xbt_fifo_item_t p_senderFifoItem;
314 #ifdef HAVE_LATENCY_BOUND_TRACKING
315 int m_latencyLimited;
323 #endif /* SURF_NETWORK_INTERFACE_HPP_ */