X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/dd60a691bb83ef59ac7395b8e842712271774e18..39c935d6d5ee86d153f6f7e6a10d723ae7c57f6f:/include/simgrid/s4u/Link.hpp diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp index c34383a283..ae4335a337 100644 --- a/include/simgrid/s4u/Link.hpp +++ b/include/simgrid/s4u/Link.hpp @@ -1,11 +1,12 @@ -/* Copyright (c) 2004-2019. 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. */ -#ifndef S4U_LINK_HPP_ -#define S4U_LINK_HPP_ +#ifndef S4U_LINK_HPP +#define S4U_LINK_HPP +#include #include #include #include @@ -19,10 +20,17 @@ ***********/ namespace simgrid { + +extern template class XBT_PUBLIC xbt::Extendable; + namespace s4u { -/** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */ -class XBT_PUBLIC Link : public simgrid::xbt::Extendable { - friend simgrid::kernel::resource::LinkImpl; +/** + * @rst + * A Link represents the network facilities between :cpp:class:`hosts `. + * @endrst + */ +class XBT_PUBLIC Link : public xbt::Extendable { + friend kernel::resource::LinkImpl; // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {} @@ -31,59 +39,54 @@ class XBT_PUBLIC Link : public simgrid::xbt::Extendable { kernel::resource::LinkImpl* const pimpl_; public: - enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 }; + enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 }; - kernel::resource::LinkImpl* get_impl() { return pimpl_; } + kernel::resource::LinkImpl* get_impl() const { return pimpl_; } /** @brief Retrieve a link from its name */ - static Link* by_name(std::string name); - static Link* by_name_or_null(std::string 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 std::string& get_name() const; /** @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 */ - double get_bandwidth(); + /** Get 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); - /** @brief Get the latency in seconds of current Link */ - double get_latency(); + /** Get 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 Describes how the link is shared between flows */ - SharingPolicy get_sharing_policy(); - - /** @brief Returns the current load (in flops per second) */ - double get_usage(); + SharingPolicy get_sharing_policy() 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), + * 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(); + bool is_used() const; void turn_on(); bool is_on() const; void turn_off(); - bool is_off() const; - - void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */ - void set_data(void* d); - -#ifndef DOXYGEN - XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_state_profile()") void set_state_trace( - kernel::profile::Profile* profile) - { - set_state_profile(profile); - } - XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_bandwidth_profile()") void set_bandwidth_trace( - kernel::profile::Profile* profile) - { - set_bandwidth_profile(profile); - } - XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_latency_profile()") void set_latency_trace( - kernel::profile::Profile* profile) - { - set_latency_profile(profile); - } -#endif /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */ void set_state_profile(kernel::profile::Profile* profile); @@ -94,75 +97,30 @@ public: * The profile must contain absolute values */ void set_latency_profile(kernel::profile::Profile* profile); - const char* get_property(std::string key); - void set_property(std::string key, std::string value); + const char* get_property(const std::string& key) const; + void set_property(const std::string& key, const std::string& value); /* The signals */ /** @brief Callback signal fired when a new Link is created */ - static simgrid::xbt::signal on_creation; + static xbt::signal on_creation; /** @brief Callback signal fired when a Link is destroyed */ - static simgrid::xbt::signal on_destruction; + static xbt::signal on_destruction; /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */ - static simgrid::xbt::signal on_state_change; + static xbt::signal on_state_change; /** @brief Callback signal fired when the bandwidth of a Link changes */ - static simgrid::xbt::signal on_bandwidth_change; + static xbt::signal on_bandwidth_change; /** @brief Callback signal fired when a communication starts */ - static simgrid::xbt::signal on_communicate; + static xbt::signal on_communicate; /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */ - static simgrid::xbt::signal + static xbt::signal on_communication_state_change; - -#ifndef DOXYGEN - // Deprecated methods - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); } - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); } - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); } - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();} - - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();} - - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);} - - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);} - - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_profile()") void setStateTrace( - simgrid::kernel::profile::Profile* profile) {set_state_profile(profile); } - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_profile()") void setBandwidthTrace( - simgrid::kernel::profile::Profile* profile) { set_bandwidth_profile(profile); } - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_profile()") void setLatencyTrace( - simgrid::kernel::profile::Profile* profile) { set_latency_profile(profile); } -#endif }; -} -} +} // namespace s4u +} // namespace simgrid -#endif /* SURF_NETWORK_INTERFACE_HPP_ */ +#endif /* S4U_LINK_HPP */