1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include <simgrid/link.h>
11 #include <unordered_map>
12 #include <xbt/Extendable.hpp>
14 #include <xbt/signal.hpp>
22 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
23 class XBT_PUBLIC Link : public simgrid::xbt::Extendable<Link> {
24 friend simgrid::kernel::resource::LinkImpl;
26 // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
27 explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
28 virtual ~Link() = default;
29 // The private implementation, that never changes
30 kernel::resource::LinkImpl* const pimpl_;
33 enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
35 /** @brief Retrieve a link from its name */
36 static Link* by_name(const char* name);
38 /** @brief Retrieves the name of that link as a C++ string */
39 const std::string& get_name() const;
40 /** @brief Retrieves the name of that link as a C string */
41 const char* get_cname() const;
43 XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
44 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
45 XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
47 /** @brief Get the bandwidth in bytes per second of current Link */
50 /** @brief Get the latency in seconds of current Link */
53 /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: SPLITDUPLEX)
55 SharingPolicy sharingPolicy();
57 /** @brief Returns the current load (in flops per second) */
60 /** @brief Check if the Link is used */
67 void setData(void* d);
69 void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
71 void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
72 external load). Trace must contain percentages (value between 0 and 1). */
73 void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
74 external load). Trace must contain absolute values */
76 const char* getProperty(const char* key);
77 void setProperty(std::string key, std::string value);
80 /** @brief Callback signal fired when a new Link is created */
81 static simgrid::xbt::signal<void(s4u::Link&)> onCreation;
83 /** @brief Callback signal fired when a Link is destroyed */
84 static simgrid::xbt::signal<void(s4u::Link&)> onDestruction;
86 /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
87 static simgrid::xbt::signal<void(s4u::Link&)> onStateChange;
89 /** @brief Callback signal fired when a communication starts */
90 static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
92 /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
93 static simgrid::xbt::signal<void(kernel::resource::NetworkAction*)> onCommunicationStateChange;
95 XBT_ATTRIB_DEPRECATED_v321("Use get_cname(): v3.21 will turn this warning into an error.") const char* name();
100 #endif /* SURF_NETWORK_INTERFACE_HPP_ */