-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2020. 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_
-
-#include <xbt/base.h>
+#ifndef S4U_LINK_HPP
+#define S4U_LINK_HPP
+#include <simgrid/forward.h>
+#include <simgrid/kernel/resource/Action.hpp>
+#include <simgrid/link.h>
+#include <string>
#include <unordered_map>
-
-#include "xbt/signal.hpp"
-
-#include "simgrid/link.h"
+#include <xbt/Extendable.hpp>
+#include <xbt/base.h>
+#include <xbt/signal.hpp>
/***********
* Classes *
***********/
namespace simgrid {
-namespace surf {
-class NetworkAction;
-class Action;
-};
+
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Link>;
+
namespace s4u {
-/** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
-class Link {
- friend simgrid::surf::LinkImpl;
+/**
+ * @rst
+ * A Link represents the network facilities between :cpp:class:`hosts <simgrid::s4u::Host>`.
+ * @endrst
+ */
+class XBT_PUBLIC Link : public xbt::Extendable<Link> {
+ friend kernel::resource::LinkImpl;
-private:
// Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
- explicit Link(surf::LinkImpl* pimpl) : pimpl_(pimpl) {}
+ explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
virtual ~Link() = default;
// The private implementation, that never changes
- surf::LinkImpl* const pimpl_;
+ 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* byName(const char* name);
+ static Link* by_name(const std::string& name);
+ static Link* by_name_or_null(const std::string& name);
- /** @brief Get da name */
- const char* 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 bandwidth();
+ double get_bandwidth() const;
+ void 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: FULLDUPLEX)
- */
- int sharingPolicy();
-
- /** @brief Check if the Link is used */
- bool isUsed();
-
- void turnOn();
- void turnOff();
-
- void* getData();
- void setData(void* d);
-
- 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 */
+ double get_latency() const;
+ void set_latency(double value);
+
+ /** @brief Describes how the link is shared between flows */
+ 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(s4u::Host* host, int level);
+
+ /** @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;
+
+ void turn_on();
+ bool is_on() const;
+ void turn_off();
+
+ /** 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);
/* The signals */
/** @brief Callback signal fired when a new Link is created */
- static simgrid::xbt::signal<void(surf::LinkImpl*)> onCreation;
+ static xbt::signal<void(Link&)> on_creation;
/** @brief Callback signal fired when a Link is destroyed */
- static simgrid::xbt::signal<void(surf::LinkImpl*)> onDestruction;
+ static xbt::signal<void(Link const&)> on_destruction;
/** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
- static simgrid::xbt::signal<void(surf::LinkImpl*)> onStateChange;
+ static xbt::signal<void(Link const&)> on_state_change;
+
+ /** @brief Callback signal fired when the bandwidth of a Link changes */
+ static xbt::signal<void(Link const&)> on_bandwidth_change;
/** @brief Callback signal fired when a communication starts */
- static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
+ static xbt::signal<void(kernel::resource::NetworkAction&)> on_communicate;
/** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
- static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
+ static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
+ on_communication_state_change;
};
-}
-}
+} // namespace s4u
+} // namespace simgrid
-#endif /* SURF_NETWORK_INTERFACE_HPP_ */
+#endif /* S4U_LINK_HPP */