X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ad6c13e59372de15e361f15bbb7f5861c6873d4d..cef6554994ae17d8f56c9245ad2c10c7cf39af8c:/include/simgrid/s4u/Link.hpp diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp index fec2d9a8d2..c2ac18e036 100644 --- a/include/simgrid/s4u/Link.hpp +++ b/include/simgrid/s4u/Link.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2022. 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. */ @@ -45,11 +45,25 @@ protected: #endif public: - enum class SharingPolicy { NONLINEAR = 4, 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::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); @@ -111,6 +125,7 @@ public: * @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. * @@ -122,11 +137,18 @@ public: * 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; @@ -146,29 +168,56 @@ public: private: #ifndef DOXYGEN static xbt::signal on_creation; - static xbt::signal on_state_change; + static xbt::signal on_onoff; + xbt::signal on_this_onoff; static xbt::signal on_bandwidth_change; + xbt::signal on_this_bandwidth_change; static xbt::signal on_communication_state_change; static xbt::signal on_destruction; + xbt::signal on_this_destruction; #endif public: /* The signals */ - /** @brief Add a callback fired when a new Link is created */ + /** \static @brief Add a callback fired when a new Link is created */ static void on_creation_cb(const std::function& cb) { on_creation.connect(cb); } - /** @brief Add a callback fired when the state of a Link changes (when it is turned on or off) */ - static void on_state_change_cb(const std::function& cb) { on_state_change.connect(cb); } - /** @brief Add a callback fired when the bandwidth of a Link changes */ + /** \static @brief Add a callback fired when any Link is turned on or off */ + static void on_onoff_cb(const std::function& 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& 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& cb) { on_bandwidth_change.connect(cb); } - /** @brief Add a callback fired when a communication changes it state (ready/done/cancel) */ + /** @brief Add a callback fired when the bandwidth of this specific Link changes */ + void on_this_bandwidth_change_cb(const std::function& 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& cb) { on_communication_state_change.connect(cb); } - /** @brief Add a callback fired when a Link is destroyed */ + /** \static @brief Add a callback fired when any Link is destroyed */ static void on_destruction_cb(const std::function& cb) { on_destruction.connect(cb); } + /** @brief Add a callback fired when this specific Link is destroyed */ + void on_this_destruction_cb(const std::function& cb) + { + on_this_destruction.connect(cb); + } + + XBT_ATTRIB_DEPRECATED_v338("Please use on_onoff_cb() instead") static void on_state_change_cb( + const std::function& cb) + { + on_onoff.connect(cb); + } }; /** @@ -186,7 +235,7 @@ public: /** @brief Get the link direction down */ Link* get_link_down() const; - /** @brief Retrieve a link from its name */ + /** \static @brief Retrieve a link from its name */ static SplitDuplexLink* by_name(const std::string& name); };