-/* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2023. 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. */
namespace s4u {
/**
- * @rst
+ * @beginrst
* A Link represents the network facilities between :cpp:class:`hosts <simgrid::s4u::Host>`.
* @endrst
*/
class XBT_PUBLIC Link : public xbt::Extendable<Link> {
- friend kernel::resource::LinkImpl;
+#ifndef DOXYGEN
+ friend kernel::resource::StandardLinkImpl;
+#endif
+protected:
// Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
virtual ~Link() = default;
- // The private implementation, that never changes
+ // The implementation that never changes
kernel::resource::LinkImpl* const pimpl_;
+#ifndef DOXYGEN
+ friend kernel::resource::NetworkAction; // signal comm_state_changed
+#endif
public:
- enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
+ /** Specifies how a given link is shared between concurrent communications */
+ enum class SharingPolicy {
+ /// This policy takes a callback that specifies the maximal capacity as a function of the number of usage. See the
+ /// examples with 'degradation' in their name.
+ NONLINEAR = 4,
+ /// Pseudo-sharing policy requesting wifi-specific sharing.
+ WIFI = 3,
+ /// Each link is split in 2, UP and DOWN, one per direction. These links are SHARED.
+ SPLITDUPLEX = 2,
+ /// The bandwidth is shared between all comms using that link, regardless of their direction.
+ SHARED = 1,
+ /// Each comm can use the link fully, with no sharing (only a maximum). This is intended to represent the backbone
+ /// links that cannot be saturated by concurrent links, but have a maximal bandwidth.
+ FATPIPE = 0
+ };
- kernel::resource::LinkImpl* get_impl() const { return pimpl_; }
+ kernel::resource::StandardLinkImpl* get_impl() const;
- /** @brief Retrieve a link from its name */
+ /** \static @brief Retrieve a link from its name */
static Link* by_name(const std::string& name);
static Link* by_name_or_null(const std::string& name);
/** @brief Retrieves the name of that link as a C string */
const char* get_cname() const;
- /** Get the bandwidth of the current Link (in bytes per second) */
+ /** Get/Set the bandwidth of the current Link (in bytes per second) */
double get_bandwidth() const;
- /** Set the bandwidth of the current Link (in bytes per second) */
- void set_bandwidth(double value);
+ Link* set_bandwidth(double value);
- /** Get the latency of the current Link (in seconds) */
+ /** Get/Set the latency of the current Link (in seconds) */
double get_latency() const;
- /** Set the latency of the current Link (in seconds) */
- void set_latency(double value);
+ /**
+ * @brief Set link's latency
+ *
+ * @param value New latency value (in s)
+ */
+ Link* set_latency(double value);
+ /**
+ * @brief Set latency (string version)
+ *
+ * Accepts values with units, such as '1s' or '7ms'.
+ *
+ * Full list of accepted units: w (week), d (day), h, s, ms, us, ns, ps.
+ *
+ * @throw std::invalid_argument if latency format is incorrect.
+ */
+ Link* set_latency(const std::string& value);
- /** @brief Describes how the link is shared between flows */
+ /** @brief Describes how the link is shared between flows
+ *
+ * Note that the NONLINEAR callback is in the critical path of the solver, so it should be fast.
+ */
+ Link* set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {});
SharingPolicy get_sharing_policy() const;
+ /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
+ Link* set_state_profile(kernel::profile::Profile* profile);
+ /** Setup the profile with bandwidth events (peak speed changes due to external load).
+ * The profile must contain percentages (value between 0 and 1). */
+ Link* set_bandwidth_profile(kernel::profile::Profile* profile);
+ /** Setup the profile file with latency events (peak latency changes due to external load).
+ * The profile must contain absolute values */
+ Link* set_latency_profile(kernel::profile::Profile* profile);
+
+ const std::unordered_map<std::string, std::string>* get_properties() const;
+ const char* get_property(const std::string& key) const;
+ Link* set_properties(const std::unordered_map<std::string, std::string>& properties);
+ Link* set_property(const std::string& key, const std::string& value);
+
+ /**
+ * @brief Set the number of communications that can shared this link at the same time
+ *
+ * Use this method to serialize communication flows going through this link.
+ * Use -1 to set no limit.
+ *
+ * @param limit Number of concurrent flows
+ */
+ Link* set_concurrency_limit(int limit);
+ int get_concurrency_limit() const;
+
/** @brief Set the level of communication speed of the given host on this wifi link.
*
* The bandwidth of a wifi link for a given host depends on its SNR (signal to noise ratio),
* current function to specify that a given host uses another level of bandwidth. This can be used to take the
* location of hosts into account, or even to model mobility in your SimGrid simulation.
*
- * Note that this function asserts that the link is actually a wifi link */
+ * Note that this function asserts that the link is actually a wifi link
+ *
+ * warning: in the case where a 0Mbps data rate should be used, set that rate only once during the
+ * experiment, and don't modify the bandwidth of that host later */
void set_host_wifi_rate(const s4u::Host* host, int level) const;
/** @brief Returns the current load (in bytes per second) */
- double get_usage() const;
+ double get_load() const;
+
+#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v338("Please use get_load() instead") double get_usage() const { return get_load(); }
+#endif
/** @brief Check if the Link is used (at least one flow uses the link) */
bool is_used() const;
+ /** @brief Check if the Link is shared (not a FATPIPE) */
+ bool is_shared() const;
+
+ /** Turns the link on. */
void turn_on();
- bool is_on() const;
+ /** Turns the link off. */
void turn_off();
+ /** Checks whether the link is on. */
+ bool is_on() const;
- /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
- void set_state_profile(kernel::profile::Profile* profile);
- /** Setup the profile with bandwidth events (peak speed changes due to external load).
- * The profile must contain percentages (value between 0 and 1). */
- void set_bandwidth_profile(kernel::profile::Profile* profile);
- /** Setup the profile file with latency events (peak latency changes due to external load).
- * The profile must contain absolute values */
- void set_latency_profile(kernel::profile::Profile* profile);
+ Link* seal();
- const char* get_property(const std::string& key) const;
- void set_property(const std::string& key, const std::string& value);
+private:
+#ifndef DOXYGEN
+ static xbt::signal<void(Link&)> on_creation;
+ static xbt::signal<void(Link const&)> on_onoff;
+ xbt::signal<void(Link const&)> on_this_onoff;
+ static xbt::signal<void(Link const&)> on_bandwidth_change;
+ xbt::signal<void(Link const&)> on_this_bandwidth_change;
+ static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
+ on_communication_state_change;
+ static xbt::signal<void(Link const&)> on_destruction;
+ xbt::signal<void(Link const&)> on_this_destruction;
+#endif
+public:
/* The signals */
- /** @brief Callback signal fired when a new Link is created */
- static xbt::signal<void(Link&)> on_creation;
+ /** \static @brief Add a callback fired when a new Link is created */
+ static void on_creation_cb(const std::function<void(Link&)>& cb) { on_creation.connect(cb); }
+ /** \static @brief Add a callback fired when any Link is turned on or off */
+ static void on_onoff_cb(const std::function<void(Link const&)>& cb)
+ {
+ on_onoff.connect(cb);
+ }
+ /** @brief Add a callback fired when this specific Link is turned on or off */
+ void on_this_onoff_cb(const std::function<void(Link const&)>& cb)
+ {
+ on_this_onoff.connect(cb);
+ }
+ /** \static @brief Add a callback fired when the bandwidth of any Link changes */
+ static void on_bandwidth_change_cb(const std::function<void(Link const&)>& cb) { on_bandwidth_change.connect(cb); }
+ /** @brief Add a callback fired when the bandwidth of this specific Link changes */
+ void on_this_bandwidth_change_cb(const std::function<void(Link const&)>& cb)
+ {
+ on_this_bandwidth_change.connect(cb);
+ }
+ /** \static @brief Add a callback fired when a communication changes it state (ready/done/cancel) */
+ static void on_communication_state_change_cb(
+ const std::function<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>& cb)
+ {
+ on_communication_state_change.connect(cb);
+ }
+ /** \static @brief Add a callback fired when any Link is destroyed */
+ static void on_destruction_cb(const std::function<void(Link const&)>& cb) { on_destruction.connect(cb); }
+ /** @brief Add a callback fired when this specific Link is destroyed */
+ void on_this_destruction_cb(const std::function<void(Link const&)>& cb)
+ {
+ on_this_destruction.connect(cb);
+ }
- /** @brief Callback signal fired when a Link is destroyed */
- static xbt::signal<void(Link const&)> on_destruction;
+ XBT_ATTRIB_DEPRECATED_v338("Please use on_onoff_cb() instead") static void on_state_change_cb(
+ const std::function<void(Link const&)>& cb)
+ {
+ on_onoff.connect(cb);
+ }
+};
- /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
- static xbt::signal<void(Link const&)> on_state_change;
+/**
+ * @beginrst
+ * A SplitDuplexLink encapsulates the :cpp:class:`links <simgrid::s4u::Link>` which
+ * compose a Split-Duplex link. Remember that a Split-Duplex link is nothing more than
+ * a pair of up/down links.
+ * @endrst
+ */
+class XBT_PUBLIC SplitDuplexLink : public Link {
+public:
+ explicit SplitDuplexLink(kernel::resource::LinkImpl* pimpl) : Link(pimpl) {}
+ /** @brief Get the link direction up*/
+ Link* get_link_up() const;
+ /** @brief Get the link direction down */
+ Link* get_link_down() const;
- /** @brief Callback signal fired when the bandwidth of a Link changes */
- static xbt::signal<void(Link const&)> on_bandwidth_change;
+ /** \static @brief Retrieve a link from its name */
+ static SplitDuplexLink* by_name(const std::string& name);
+};
+
+/**
+ * @beginrst
+ * Another encapsulation for using links in the :cpp:func:`NetZone::add_route`
+ *
+ * When adding a route with split-duplex links, you need to specify the direction of the link
+ * so SimGrid can know exactly which physical link to insert in the route.
+ *
+ * For shared/fat-pipe links, use the :cpp:enumerator:`Direction::NONE` since they don't have
+ * the concept of UP/DOWN links.
+ * @endrst
+ */
+class XBT_PUBLIC LinkInRoute {
+public:
+ enum class Direction { UP = 2, DOWN = 1, NONE = 0 };
- /** @brief Callback signal fired when a communication starts */
- static xbt::signal<void(kernel::resource::NetworkAction&)> on_communicate;
+ explicit LinkInRoute(const Link* link) : link_(link) {}
+ LinkInRoute(const Link* link, Direction d) : link_(link), direction_(d) {}
- /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
- static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
- on_communication_state_change;
+ /** @brief Get direction of this link in the route: UP or DOWN */
+ Direction get_direction() const { return direction_; }
+ /** @brief Get pointer to the link */
+ const Link* get_link() const { return link_; }
+
+private:
+ const Link* link_;
+ Direction direction_ = Direction::NONE;
};
+
} // namespace s4u
} // namespace simgrid
