X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/56651d7c6d0cc1c2108ca0d8de7e34462acd0514..8206f2d5427004aa113da1f9985d9263183bb978:/include/simgrid/s4u/Link.hpp diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp index d5d13bba1d..b00085377c 100644 --- a/include/simgrid/s4u/Link.hpp +++ b/include/simgrid/s4u/Link.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2021. 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. */ @@ -25,12 +25,14 @@ extern template class XBT_PUBLIC xbt::Extendable; namespace s4u { /** - * @rst + * @beginrst * A Link represents the network facilities between :cpp:class:`hosts `. * @endrst */ class XBT_PUBLIC Link : public xbt::Extendable { +#ifndef DOXYGEN friend kernel::resource::LinkImpl; +#endif // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {} @@ -52,38 +54,80 @@ public: /** @brief Retrieves the name of that link as a C string */ const char* get_cname() const; - /** @brief Get the bandwidth in bytes per second of current Link */ + /** Get/Set the bandwidth of the current Link (in bytes per second) */ double get_bandwidth() const; - void set_bandwidth(double value); + Link* set_bandwidth(double value); - /** @brief Get the latency in seconds of current Link */ + /** Get/Set the latency of the current Link (in seconds) */ double get_latency() const; - 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) + * + * @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 */ + Link* set_sharing_policy(SharingPolicy policy); SharingPolicy get_sharing_policy() const; - /** @brief Returns the current load (in flops per second) */ + /** 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* get_properties() const; + const char* get_property(const std::string& key) const; + Link* set_properties(const std::unordered_map& 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); + + /** @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), + * which ultimately depends on the distance between the host and the station and the material between them. + * + * This is modeled in SimGrid by providing several bandwidths to wifi links, one per SNR level (just provide + * comma-separated values in the XML file). By default, the first level in the list is used, but you can use the + * 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 */ + 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; /** @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; + void turn_on(); - bool is_on() const; void turn_off(); + 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); - - const char* get_property(const std::string& key) const; - void set_property(const std::string& key, const std::string& value); + Link* seal(); /* The signals */ /** @brief Callback signal fired when a new Link is created */ @@ -99,7 +143,7 @@ public: static xbt::signal on_bandwidth_change; /** @brief Callback signal fired when a communication starts */ - static xbt::signal on_communicate; + static xbt::signal on_communicate; /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */ static xbt::signal