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 <unordered_map>
16 #include "surf_interface.hpp"
17 #include "surf_routing.hpp"
18 #include "src/surf/PropertyHolder.hpp"
20 #include "simgrid/link.h"
31 /** @brief Callback signal fired when the state of a NetworkAction changes
32 * Signature: `void(NetworkAction *action, simgrid::surf::Action::State old, simgrid::surf::Action::State current)` */
33 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::Action::State, simgrid::surf::Action::State)>) networkActionStateChangedCallbacks;
44 /** @ingroup SURF_network_interface
45 * @brief SURF network model interface class
46 * @details A model is an object which handles the interactions between its Resources and its Actions
48 class NetworkModel : public Model {
50 /** @brief Constructor */
51 NetworkModel() : Model() { }
53 /** @brief Destructor */
54 ~NetworkModel() override;
57 * @brief Create a Link
59 * @param name The name of the Link
60 * @param bandwidth The initial bandwidth of the Link in bytes per second
61 * @param latency The initial latency of the Link in seconds
62 * @param policy The sharing policy of the Link
63 * @param props Dictionary of properties associated to this Link
65 virtual Link* createLink(const char *name, double bandwidth, double latency,
66 e_surf_link_sharing_policy_t policy, xbt_dict_t properties)=0;
69 * @brief Create a communication between two hosts.
70 * @details It makes calls to the routing part, and execute the communication
71 * between the two end points.
73 * @param src The source of the communication
74 * @param dst The destination of the communication
75 * @param size The size of the communication in bytes
76 * @param rate Allows to limit the transfer rate. Negative value means
78 * @return The action representing the communication
80 virtual Action* communicate(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double size, double rate) = 0;
82 /** @brief Function pointer to the function to use to solve the lmm_system_t
84 * @param system The lmm_system_t to solve
86 void (*f_networkSolve)(lmm_system_t) = lmm_solve;
89 * @brief Get the right multiplicative factor for the latency.
90 * @details Depending on the model, the effective latency when sending
91 * a message might be different from the theoretical latency of the link,
92 * in function of the message size. In order to account for this, this
93 * function gets this factor.
95 * @param size The size of the message.
96 * @return The latency factor.
98 virtual double latencyFactor(double size);
101 * @brief Get the right multiplicative factor for the bandwidth.
102 * @details Depending on the model, the effective bandwidth when sending
103 * a message might be different from the theoretical bandwidth of the link,
104 * in function of the message size. In order to account for this, this
105 * function gets this factor.
107 * @param size The size of the message.
108 * @return The bandwidth factor.
110 virtual double bandwidthFactor(double size);
113 * @brief Get definitive bandwidth.
114 * @details It gives the minimum bandwidth between the one that would
115 * occur if no limitation was enforced, and the one arbitrary limited.
116 * @param rate The desired maximum bandwidth.
117 * @param bound The bandwidth with only the network taken into account.
118 * @param size The size of the message.
119 * @return The new bandwidth.
121 virtual double bandwidthConstraint(double rate, double bound, double size);
122 double nextOccuringEventFull(double now) override;
128 /** @ingroup SURF_network_interface
129 * @brief SURF network link interface class
130 * @details A Link represents the link between two [hosts](\ref simgrid::surf::HostImpl)
133 public simgrid::surf::Resource,
134 public simgrid::surf::PropertyHolder {
137 /** @brief Constructor of non-LMM links */
138 Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props);
139 /** @brief Constructor of LMM links */
140 Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
142 /* Link destruction logic */
143 /**************************/
147 void destroy(); // Must be called instead of the destructor
149 bool currentlyDestroying_ = false;
152 /** @brief Callback signal fired when a new Link is created.
153 * Signature: void(Link*) */
154 static simgrid::xbt::signal<void(surf::Link*)> onCreation;
156 /** @brief Callback signal fired when a Link is destroyed.
157 * Signature: void(Link*) */
158 static simgrid::xbt::signal<void(surf::Link*)> onDestruction;
160 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off)
161 * Signature: `void(Link*)` */
162 static simgrid::xbt::signal<void(surf::Link*)> onStateChange;
164 /** @brief Callback signal fired when a communication starts
165 * Signature: `void(NetworkAction *action, host *src, host *dst)` */
166 static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
168 /** @brief Get the bandwidth in bytes per second of current Link */
169 virtual double getBandwidth();
171 /** @brief Update the bandwidth in bytes per second of current Link */
172 virtual void updateBandwidth(double value)=0;
174 /** @brief Get the latency in seconds of current Link */
175 virtual double getLatency();
177 /** @brief Update the latency in seconds of current Link */
178 virtual void updateLatency(double value)=0;
180 /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
181 virtual int sharingPolicy();
183 /** @brief Check if the Link is used */
184 bool isUsed() override;
186 void turnOn() override;
187 void turnOff() override;
189 virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain boolean values. */
190 virtual void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to external load). Trace must contain percentages (value between 0 and 1). */
191 virtual void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to external load). Trace must contain absolute values */
193 tmgr_trace_iterator_t m_stateEvent = nullptr;
194 s_surf_metric_t m_latency = {1.0,0,nullptr};
195 s_surf_metric_t m_bandwidth = {1.0,0,nullptr};
199 void *getData() { return userData;}
200 void setData(void *d) { userData=d;}
202 void *userData = nullptr;
204 /* List of all links. FIXME: should move to the Engine */
206 static std::unordered_map<std::string, Link *> *links;
208 static Link *byName(const char* name);
209 static int linksCount();
210 static Link **linksList();
211 static void linksExit();
217 /** @ingroup SURF_network_interface
218 * @brief SURF network action interface class
219 * @details A NetworkAction represents a communication between two [hosts](\ref HostImpl)
221 class NetworkAction : public simgrid::surf::Action {
223 /** @brief Constructor
225 * @param model The NetworkModel associated to this NetworkAction
226 * @param cost The cost of this NetworkAction in [TODO]
227 * @param failed [description]
229 NetworkAction(simgrid::surf::Model *model, double cost, bool failed)
230 : simgrid::surf::Action(model, cost, failed) {}
233 * @brief NetworkAction constructor
235 * @param model The NetworkModel associated to this NetworkAction
236 * @param cost The cost of this NetworkAction in [TODO]
237 * @param failed [description]
238 * @param var The lmm variable associated to this Action if it is part of a
241 NetworkAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
242 : simgrid::surf::Action(model, cost, failed, var) {};
244 void setState(simgrid::surf::Action::State state) override;
250 const char* senderLinkName_;
252 xbt_fifo_item_t senderFifoItem_;
257 #endif /* SURF_NETWORK_INTERFACE_HPP_ */