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 "src/surf/PropertyHolder.hpp"
19 #include "simgrid/link.h"
20 #include "simgrid/s4u/link.hpp"
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;
39 /** @ingroup SURF_network_interface
40 * @brief SURF network model interface class
41 * @details A model is an object which handles the interactions between its Resources and its Actions
43 class NetworkModel : public Model {
45 /** @brief Constructor */
46 NetworkModel() : Model() { }
48 /** @brief Destructor */
49 ~NetworkModel() override;
52 * @brief Create a Link
54 * @param name The name of the Link
55 * @param bandwidth The initial bandwidth of the Link in bytes per second
56 * @param latency The initial latency of the Link in seconds
57 * @param policy The sharing policy of the Link
59 virtual LinkImpl* createLink(const char* name, double bandwidth, double latency,
60 e_surf_link_sharing_policy_t policy) = 0;
63 * @brief Create a communication between two hosts.
64 * @details It makes calls to the routing part, and execute the communication
65 * between the two end points.
67 * @param src The source of the communication
68 * @param dst The destination of the communication
69 * @param size The size of the communication in bytes
70 * @param rate Allows to limit the transfer rate. Negative value means
72 * @return The action representing the communication
74 virtual Action* communicate(simgrid::s4u::Host* src, simgrid::s4u::Host* dst, double size, double rate) = 0;
76 /** @brief Function pointer to the function to use to solve the lmm_system_t
78 * @param system The lmm_system_t to solve
80 void (*f_networkSolve)(lmm_system_t) = lmm_solve;
83 * @brief Get the right multiplicative factor for the latency.
84 * @details Depending on the model, the effective latency when sending
85 * a message might be different from the theoretical latency of the link,
86 * in function of the message size. In order to account for this, this
87 * function gets this factor.
89 * @param size The size of the message.
90 * @return The latency factor.
92 virtual double latencyFactor(double size);
95 * @brief Get the right multiplicative factor for the bandwidth.
96 * @details Depending on the model, the effective bandwidth when sending
97 * a message might be different from the theoretical bandwidth of the link,
98 * in function of the message size. In order to account for this, this
99 * function gets this factor.
101 * @param size The size of the message.
102 * @return The bandwidth factor.
104 virtual double bandwidthFactor(double size);
107 * @brief Get definitive bandwidth.
108 * @details It gives the minimum bandwidth between the one that would
109 * occur if no limitation was enforced, and the one arbitrary limited.
110 * @param rate The desired maximum bandwidth.
111 * @param bound The bandwidth with only the network taken into account.
112 * @param size The size of the message.
113 * @return The new bandwidth.
115 virtual double bandwidthConstraint(double rate, double bound, double size);
116 double nextOccuringEventFull(double now) override;
118 LinkImpl* loopback_ = nullptr;
124 /** @ingroup SURF_network_interface
125 * @brief SURF network link interface class
126 * @details A Link represents the link between two [hosts](\ref simgrid::surf::HostImpl)
128 class LinkImpl : public simgrid::surf::Resource, public simgrid::surf::PropertyHolder {
130 LinkImpl(simgrid::surf::NetworkModel* model, const char* name, lmm_constraint_t constraint);
131 ~LinkImpl() override;
133 void destroy(); // Must be called instead of the destructor
135 bool currentlyDestroying_ = false;
138 /** @brief Public interface */
140 /** @brief Callback signal fired when a new Link is created */
141 static simgrid::xbt::signal<void(surf::LinkImpl*)> onCreation;
143 /** @brief Callback signal fired when a Link is destroyed */
144 static simgrid::xbt::signal<void(surf::LinkImpl*)> onDestruction;
146 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
147 static simgrid::xbt::signal<void(surf::LinkImpl*)> onStateChange;
149 /** @brief Callback signal fired when a communication starts */
150 static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
152 /** @brief Get the bandwidth in bytes per second of current Link */
153 virtual double bandwidth();
155 /** @brief Update the bandwidth in bytes per second of current Link */
156 virtual void setBandwidth(double value) = 0;
158 /** @brief Get the latency in seconds of current Link */
159 virtual double latency();
161 /** @brief Update the latency in seconds of current Link */
162 virtual void setLatency(double value) = 0;
164 /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2:
166 virtual int sharingPolicy();
168 /** @brief Check if the Link is used */
169 bool isUsed() override;
171 void turnOn() override;
172 void turnOff() override;
174 virtual void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF).
175 Trace must contain boolean values. */
176 virtual void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to external load).
177 Trace must contain percentages (value between 0 and 1). */
178 virtual void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to external load).
179 Trace must contain absolute values */
181 tmgr_trace_iterator_t stateEvent_ = nullptr;
182 s_surf_metric_t latency_ = {1.0, 0, nullptr};
183 s_surf_metric_t bandwidth_ = {1.0, 0, nullptr};
187 void *getData() { return userData;}
188 void setData(void *d) { userData=d;}
190 void *userData = nullptr;
192 /* List of all links. FIXME: should move to the Engine */
194 static std::unordered_map<std::string, LinkImpl*>* links;
197 static LinkImpl* byName(const char* name);
198 static int linksCount();
199 static LinkImpl** linksList();
200 static void linksExit();
206 /** @ingroup SURF_network_interface
207 * @brief SURF network action interface class
208 * @details A NetworkAction represents a communication between two [hosts](\ref HostImpl)
210 class NetworkAction : public simgrid::surf::Action {
212 /** @brief Constructor
214 * @param model The NetworkModel associated to this NetworkAction
215 * @param cost The cost of this NetworkAction in [TODO]
216 * @param failed [description]
218 NetworkAction(simgrid::surf::Model *model, double cost, bool failed)
219 : simgrid::surf::Action(model, cost, failed) {}
222 * @brief NetworkAction constructor
224 * @param model The NetworkModel associated to this NetworkAction
225 * @param cost The cost of this NetworkAction in [TODO]
226 * @param failed [description]
227 * @param var The lmm variable associated to this Action if it is part of a
230 NetworkAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
231 : simgrid::surf::Action(model, cost, failed, var) {};
233 void setState(simgrid::surf::Action::State state) override;
239 const char* senderLinkName_;
241 xbt_fifo_item_t senderFifoItem_;
246 #endif /* SURF_NETWORK_INTERFACE_HPP_ */