X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/38dfe4cc823740a962aa1da0f3be0c40582d7648..8206f2d5427004aa113da1f9985d9263183bb978:/include/simgrid/s4u/Link.hpp diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp index 81c392938b..b00085377c 100644 --- a/include/simgrid/s4u/Link.hpp +++ b/include/simgrid/s4u/Link.hpp @@ -1,11 +1,13 @@ -/* Copyright (c) 2004-2018. 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 #include @@ -18,10 +20,19 @@ ***********/ 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; +/** + * @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) {} @@ -30,69 +41,115 @@ class XBT_PUBLIC Link : public simgrid::xbt::Extendable { kernel::resource::LinkImpl* const pimpl_; public: + enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 }; + + kernel::resource::LinkImpl* get_impl() const { return pimpl_; } + /** @brief Retrieve a link from its name */ - static Link* by_name(const char* 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; - XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); } - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); } - - /** @brief Get the bandwidth in bytes per second of current Link */ - double bandwidth(); + /** Get/Set the bandwidth of the current Link (in bytes per second) */ + double get_bandwidth() const; + Link* set_bandwidth(double value); - /** @brief Get the latency in seconds of current Link */ - double latency(); - - /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: SPLITDUPLEX) + /** Get/Set the latency of the current Link (in seconds) */ + double get_latency() const; + /** + * @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; + + /** 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 */ - int sharingPolicy(); + Link* set_concurrency_limit(int limit); - /** @brief Returns the current load (in flops per second) */ - double getUsage(); + /** @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 Check if the Link is used */ - bool isUsed(); + /** @brief Returns the current load (in bytes per second) */ + double get_usage() const; - void turnOn(); - void turnOff(); + /** @brief Check if the Link is used (at least one flow uses the link) */ + bool is_used() const; - void* getData(); - void setData(void* d); + /** @brief Check if the Link is shared (not a FATPIPE) */ + bool is_shared() const; - void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain - boolean values. */ - void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to - external load). Trace must contain percentages (value between 0 and 1). */ - void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to - external load). Trace must contain absolute values */ + void turn_on(); + void turn_off(); + bool is_on() const; - const char* getProperty(const char* key); - void setProperty(std::string key, std::string value); + Link* seal(); /* The signals */ /** @brief Callback signal fired when a new Link is created */ - static simgrid::xbt::signal onCreation; + static xbt::signal on_creation; /** @brief Callback signal fired when a Link is destroyed */ - static simgrid::xbt::signal onDestruction; + 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 onStateChange; + static xbt::signal on_state_change; + + /** @brief Callback signal fired when the bandwidth of a Link changes */ + static xbt::signal on_bandwidth_change; /** @brief Callback signal fired when a communication starts */ - static simgrid::xbt::signal onCommunicate; + static xbt::signal on_communicate; /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */ - static simgrid::xbt::signal onCommunicationStateChange; - - XBT_ATTRIB_DEPRECATED_v321("Use get_cname(): v3.21 will turn this warning into an error.") const char* name(); + static xbt::signal + on_communication_state_change; }; -} -} +} // namespace s4u +} // namespace simgrid -#endif /* SURF_NETWORK_INTERFACE_HPP_ */ +#endif /* S4U_LINK_HPP */