X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/96cedde3cdbc0b8ffc3f096a1b65d021b0226f99..fcb729916269f63a4c9d031d5be35aff3774e769:/include/simgrid/s4u/Link.hpp diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp index 24a901b166..bcd91afbac 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,125 +20,189 @@ ***********/ 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 +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) {} + explicit Link(kernel::resource::LinkImplIntf* pimpl) : pimpl_(pimpl) {} virtual ~Link() = default; - // The private implementation, that never changes - kernel::resource::LinkImpl* const pimpl_; + // The implementation that never changes + kernel::resource::LinkImplIntf* const pimpl_; public: - enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 }; + enum class SharingPolicy { NONLINEAR = 4, WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 }; - kernel::resource::LinkImpl* get_impl() { return pimpl_; } + kernel::resource::LinkImpl* get_impl() const; /** @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(); - - /** @brief Get the latency in seconds of current Link */ - double get_latency(); + /** Get/Set the bandwidth of the current Link (in bytes per second) */ + double get_bandwidth() const; + Link* set_bandwidth(double value); + + /** 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) + * + * 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 */ - SharingPolicy get_sharing_policy(); - - /** @brief Returns the current load (in flops per second) */ - double get_usage(); + 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* 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(); + bool is_used() const; + + /** @brief Check if the Link is shared (not a FATPIPE) */ + bool is_shared() const; void turn_on(); void turn_off(); + bool is_on() const; - void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */ - void set_data(void* d); - - void set_state_trace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain - boolean values. */ - void set_bandwidth_trace(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 set_latency_trace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to - external load). Trace must contain absolute values */ - - const char* get_property(std::string key); - void set_property(std::string key, std::string value); + Link* seal(); /* 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_trace()") void setStateTrace(tmgr_trace_t trace) {set_state_trace(trace);} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_trace()") void setBandwidthTrace(tmgr_trace_t trace) {set_bandwidth_trace(trace);} - /** @deprecated */ - XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_trace()") void setLatencyTrace(tmgr_trace_t trace) {set_latency_trace(trace);} -#endif +/** + * @beginrst + * A SplitDuplexLink encapsulates the :cpp:class:`links ` 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::LinkImplIntf* 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 Retrieve a link from its name */ + static SplitDuplexLink* by_name(const std::string& name); }; -} -} -#endif /* SURF_NETWORK_INTERFACE_HPP_ */ +/** + * @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 }; + + explicit LinkInRoute(const Link* link) : link_(link) {} + LinkInRoute(const Link* link, Direction d) : link_(link), direction_(d) {} + + /** @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 + +#endif /* S4U_LINK_HPP */