-/* Copyright (c) 2004-2015. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef SURF_NETWORK_INTERFACE_HPP_
#define SURF_NETWORK_INTERFACE_HPP_
-#include <xbt/base.h>
-
-#include <boost/unordered_map.hpp>
-
-#include "xbt/fifo.h"
-#include "xbt/dict.h"
-#include "surf_interface.hpp"
-#include "surf_routing.hpp"
+#include "simgrid/kernel/resource/Model.hpp"
+#include "simgrid/kernel/resource/Resource.hpp"
+#include "simgrid/s4u/Link.hpp"
+#include "src/kernel/lmm/maxmin.hpp"
+#include "src/kernel/resource/profile/trace_mgr.hpp"
#include "src/surf/PropertyHolder.hpp"
-#include "simgrid/link.h"
+#include <list>
+#include <unordered_map>
/***********
* Classes *
***********/
namespace simgrid {
-namespace surf {
-
-class NetworkModel;
-class NetworkAction;
-
-/*************
- * Callbacks *
- *************/
-
-
-/** @brief Callback signal fired when the state of a NetworkAction changes
- * Signature: `void(NetworkAction *action, e_surf_action_state_t old, e_surf_action_state_t current)` */
-XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, e_surf_action_state_t, e_surf_action_state_t)>) networkActionStateChangedCallbacks;
-
-/** @brief Callback signal fired when a NetworkAction is created (when a communication starts)
- * Signature: `void(NetworkAction *action, RoutingEdge *src, RoutingEdge *dst, double size, double rate)` */
-XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::NetworkAction*, simgrid::surf::NetCard *src, simgrid::surf::NetCard *dst, double size, double rate)>) networkCommunicateCallbacks;
-
-}
-}
-
-/*********
- * Tools *
- *********/
-XBT_PUBLIC(void) netlink_parse_init(sg_platf_link_cbarg_t link);
-
+namespace kernel {
+namespace resource {
/*********
* Model *
*********/
-namespace simgrid {
-namespace surf {
-
/** @ingroup SURF_network_interface
* @brief SURF network model interface class
* @details A model is an object which handles the interactions between its Resources and its Actions
*/
class NetworkModel : public Model {
public:
- /** @brief Constructor */
- NetworkModel() : Model() { }
-
- /** @brief Destructor */
- ~NetworkModel() {
- if (p_maxminSystem)
- lmm_system_free(p_maxminSystem);
- if (p_actionHeap)
- xbt_heap_free(p_actionHeap);
- if (p_modifiedSet)
- delete p_modifiedSet;
- }
+ static config::Flag<double> cfg_tcp_gamma;
+ static config::Flag<bool> cfg_crosstraffic;
+
+ explicit NetworkModel(Model::UpdateAlgo algo) : Model(algo) {}
+ NetworkModel(const NetworkModel&) = delete;
+ NetworkModel& operator=(const NetworkModel&) = delete;
+ ~NetworkModel() override;
/**
* @brief Create a Link
*
* @param name The name of the Link
- * @param bw_initial The initial bandwidth of the Link in bytes per second
- * @param bw_trace The trace associated to the Link bandwidth
- * @param lat_initial The initial latency of the Link in seconds
- * @param lat_trace The trace associated to the Link latency
- * @param initiallyOn The initial Link (state)[e_surf_resource_state_t]
- * @param state_trace The trace associated to the Link (state)[e_surf_resource_state_t]
+ * @param bandwidth The initial bandwidth of the Link in bytes per second
+ * @param latency The initial latency of the Link in seconds
* @param policy The sharing policy of the Link
- * @param properties Dictionary of properties associated to this Resource
- * @return The created Link
*/
- virtual Link* createLink(const char *name,
- double bw_initial,
- tmgr_trace_t bw_trace,
- double lat_initial,
- tmgr_trace_t lat_trace,
- int initiallyOn,
- tmgr_trace_t state_trace,
- e_surf_link_sharing_policy_t policy,
- xbt_dict_t properties)=0;
+ virtual LinkImpl* create_link(const std::string& name, double bandwidth, double latency,
+ s4u::Link::SharingPolicy policy) = 0;
/**
* @brief Create a communication between two hosts.
- * @details It makes calls to the routing part, and execute the communication
- * between the two end points.
+ * @details It makes calls to the routing part, and execute the communication between the two end points.
*
* @param src The source of the communication
* @param dst The destination of the communication
* @param size The size of the communication in bytes
- * @param rate Allows to limit the transfer rate. Negative value means
- * unlimited.
+ * @param rate Allows to limit the transfer rate. Negative value means unlimited.
* @return The action representing the communication
*/
- virtual Action *communicate(NetCard *src, NetCard *dst,
- double size, double rate)=0;
-
- /** @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) = lmm_solve;
+ virtual Action* communicate(s4u::Host* src, s4u::Host* dst, double size, double rate) = 0;
/**
* @brief Get the right multiplicative factor for the latency.
- * @details Depending on the model, the effective latency when sending
- * a message might be different from the theoretical latency of the link,
- * in function of the message size. In order to account for this, this
- * function gets this factor.
+ * @details Depending on the model, the effective latency when sending a message might be different from the
+ * theoretical latency of the link, in function of the message size. In order to account for this, this function gets
+ * this factor.
*
* @param size The size of the message.
* @return The latency factor.
*/
- virtual double latencyFactor(double size);
+ virtual double get_latency_factor(double size);
/**
* @brief Get the right multiplicative factor for the bandwidth.
- * @details Depending on the model, the effective bandwidth when sending
- * a message might be different from the theoretical bandwidth of the link,
- * in function of the message size. In order to account for this, this
- * function gets this factor.
+ * @details Depending on the model, the effective bandwidth when sending a message might be different from the
+ * theoretical bandwidth of the link, in function of the message size. In order to account for this, this function
+ * gets this factor.
*
* @param size The size of the message.
* @return The bandwidth factor.
*/
- virtual double bandwidthFactor(double size);
+ virtual double get_bandwidth_factor(double size);
/**
* @brief Get definitive bandwidth.
- * @details It gives the minimum bandwidth between the one that would
- * occur if no limitation was enforced, and the one arbitrary limited.
+ * @details It gives the minimum bandwidth between the one that would occur if no limitation was enforced, and the
+ * one arbitrary limited.
* @param rate The desired maximum bandwidth.
* @param bound The bandwidth with only the network taken into account.
* @param size The size of the message.
* @return The new bandwidth.
*/
- virtual double bandwidthConstraint(double rate, double bound, double size);
- double shareResourcesFull(double now);
+ virtual double get_bandwidth_constraint(double rate, double bound, double size);
+ double next_occuring_event_full(double now) override;
+
+ LinkImpl* loopback_ = nullptr;
};
/************
* Resource *
************/
- /** @ingroup SURF_network_interface
- * @brief SURF network link interface class
- * @details A Link represents the link between two [hosts](\ref Host)
- */
-class Link :
- public simgrid::surf::Resource,
- public simgrid::surf::PropertyHolder {
-public:
- /**
- * @brief Link constructor
- *
- * @param model The NetworkModel associated to this Link
- * @param name The name of the Link
- * @param props Dictionary of properties associated to this Link
- */
- Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props);
-
- /**
- * @brief Link constructor
- *
- * @param model The NetworkModel associated to this Link
- * @param name The name of the Link
- * @param props Dictionary of properties associated to this Link
- * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component
- * @param fes Future Event Set in which our events must be registered
- * @param state_trace [TODO]
- */
- Link(simgrid::surf::NetworkModel *model, const char *name, xbt_dict_t props,
- lmm_constraint_t constraint,
- sg_future_evt_set_t fes,
- tmgr_trace_t state_trace);
+/** @ingroup SURF_network_interface
+ * @brief SURF network link interface class
+ * @details A Link represents the link between two [hosts](@ref simgrid::surf::HostImpl)
+ */
+class LinkImpl : public Resource, public surf::PropertyHolder {
+ bool currently_destroying_ = false;
+ void* userdata_ = nullptr;
- /* Link destruction logic */
- /**************************/
protected:
- ~Link();
-public:
- void destroy(); // Must be called instead of the destructor
-private:
- bool currentlyDestroying_ = false;
+ LinkImpl(NetworkModel* model, const std::string& name, lmm::Constraint* constraint);
+ LinkImpl(const LinkImpl&) = delete;
+ LinkImpl& operator=(const LinkImpl&) = delete;
+ ~LinkImpl() override;
public:
- /** @brief Callback signal fired when a new Link is created.
- * Signature: void(Link*) */
- static simgrid::xbt::signal<void(simgrid::surf::Link*)> onCreation;
-
- /** @brief Callback signal fired when a Link is destroyed.
- * Signature: void(Link*) */
- static simgrid::xbt::signal<void(simgrid::surf::Link*)> onDestruction;
-
- /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off)
- * Signature: `void(Link*)` */
- static simgrid::xbt::signal<void(simgrid::surf::Link*)> onStateChange;
+ void destroy(); // Must be called instead of the destructor
+ void* get_data() { return userdata_; }
+ void set_data(void* d) { userdata_ = d; }
+ /** @brief Public interface */
+ s4u::Link piface_;
/** @brief Get the bandwidth in bytes per second of current Link */
- virtual double getBandwidth();
+ virtual double get_bandwidth();
/** @brief Update the bandwidth in bytes per second of current Link */
- virtual void updateBandwidth(double value, double date=surf_get_clock())=0;
+ virtual void set_bandwidth(double value) = 0;
/** @brief Get the latency in seconds of current Link */
- virtual double getLatency();
+ virtual double get_latency();
/** @brief Update the latency in seconds of current Link */
- virtual void updateLatency(double value, double date=surf_get_clock())=0;
+ virtual void set_latency(double value) = 0;
- /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
- virtual int sharingPolicy();
+ /** @brief The sharing policy */
+ virtual s4u::Link::SharingPolicy get_sharing_policy();
/** @brief Check if the Link is used */
- bool isUsed() override;
+ bool is_used() override;
- void turnOn() override;
- void turnOff() override;
+ void turn_on() override;
+ void turn_off() override;
- /* Using this object with the public part of
- model does not make sense */
- double m_latCurrent = 0;
- tmgr_trace_iterator_t p_latEvent = NULL;
+ void on_bandwidth_change();
- /* LMM */
- tmgr_trace_iterator_t p_stateEvent = NULL;
- s_surf_metric_t p_speed;
+ virtual void
+ set_bandwidth_profile(kernel::profile::Profile* profile); /*< setup the profile file with bandwidth events
+ (peak speed changes due to external load). Trace must
+ contain percentages (value between 0 and 1). */
+ virtual void
+ set_latency_profile(kernel::profile::Profile* profile); /*< setup the trace file with latency events (peak
+ latency changes due to external load). Trace must contain
+ absolute values */
+
+ Metric latency_ = {1.0, 0, nullptr};
+ Metric bandwidth_ = {1.0, 0, nullptr};
- /* User data */
-public:
- void *getData() { return userData;}
- void setData(void *d) { userData=d;}
-private:
- void *userData = NULL;
-
- /* List of all links */
-private:
- static boost::unordered_map<std::string, Link *> *links;
-public:
- static Link *byName(const char* name);
- static int linksCount();
- static Link **linksList();
- static void linksExit();
};
/**********
**********/
/** @ingroup SURF_network_interface
* @brief SURF network action interface class
- * @details A NetworkAction represents a communication between two [hosts](\ref Host)
+ * @details A NetworkAction represents a communication between two [hosts](@ref simgrid::surf::HostImpl)
*/
-class NetworkAction : public simgrid::surf::Action {
+class NetworkAction : public Action {
public:
/** @brief Constructor
*
* @param cost The cost of this NetworkAction in [TODO]
* @param failed [description]
*/
- NetworkAction(simgrid::surf::Model *model, double cost, bool failed)
- : simgrid::surf::Action(model, cost, failed) {}
+ NetworkAction(Model* model, double cost, bool failed) : Action(model, cost, failed) {}
/**
* @brief NetworkAction constructor
*
* @param model The NetworkModel associated to this NetworkAction
- * @param cost The cost of this NetworkAction in [TODO]
- * @param failed [description]
- * @param var The lmm variable associated to this Action if it is part of a
- * LMM component
+ * @param cost The cost of this NetworkAction in bytes
+ * @param failed Actions can be created in a failed state
+ * @param var The lmm variable associated to this Action if it is part of a LMM component
*/
- NetworkAction(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var)
- : simgrid::surf::Action(model, cost, failed, var) {};
+ NetworkAction(Model* model, double cost, bool failed, lmm::Variable* 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;
- double m_rate;
- const char* p_senderLinkName;
- double m_senderSize;
- xbt_fifo_item_t p_senderFifoItem;
-#ifdef HAVE_LATENCY_BOUND_TRACKING
- int m_latencyLimited;
-#endif
+ void set_state(Action::State state) override;
+ virtual std::list<LinkImpl*> links() const;
+ double latency_ = {};
+ double lat_current_ = {};
+ double weight_ = {};
+ double rate_ = {};
};
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid
-}
-}
+/** @ingroup SURF_models
+ * @brief The network model
+ */
+XBT_PUBLIC_DATA simgrid::kernel::resource::NetworkModel* surf_network_model;
#endif /* SURF_NETWORK_INTERFACE_HPP_ */