-/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2019. 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 <simgrid/forward.h>
+#include <simgrid/kernel/resource/Action.hpp>
#include <simgrid/link.h>
-#include <xbt/base.h>
-#include <xbt/signal.hpp>
-
#include <string>
#include <unordered_map>
+#include <xbt/Extendable.hpp>
+#include <xbt/base.h>
+#include <xbt/signal.hpp>
/***********
* Classes *
***********/
namespace simgrid {
-namespace surf {
-class NetworkAction;
-};
namespace s4u {
-/** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
-XBT_PUBLIC_CLASS Link
-{
- friend simgrid::surf::LinkImpl;
+/** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
+class XBT_PUBLIC Link : public xbt::Extendable<Link> {
+ friend kernel::resource::LinkImpl;
// 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 Retrieves the name of that link as a C++ string */
- const std::string& getName() const;
+ const std::string& get_name() const;
/** @brief Retrieves the name of that link as a C string */
- const char* getCname() const;
+ const char* get_cname() const;
/** @brief Get the bandwidth in bytes per second of current Link */
- double bandwidth();
+ double get_bandwidth() const;
/** @brief Get the latency in seconds of current Link */
- double latency();
+ double get_latency() const;
+
+ /** @brief Describes how the link is shared between flows */
+ SharingPolicy get_sharing_policy();
- /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX)
- */
- int sharingPolicy();
+ /** @brief Returns the current load (in flops per second) */
+ double get_usage();
- /** @brief Check if the Link is used */
- bool isUsed();
+ /** @brief Check if the Link is used (at least one flow uses the link) */
+ bool is_used();
- void turnOn();
- void turnOff();
+ void turn_on();
+ bool is_on() const;
+ void turn_off();
- void* getData();
- void setData(void* d);
+ /** 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);
- 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 */
+ 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(s4u::Link&)> onCreation;
+ static xbt::signal<void(Link&)> on_creation;
/** @brief Callback signal fired when a Link is destroyed */
- static simgrid::xbt::signal<void(s4u::Link&)> 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(s4u::Link&)> 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&, Host* src, Host* dst)> on_communicate;
/** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
- static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
-
- const char* XBT_ATTRIB_DEPRECATED_v321("Use getCname(): v3.21 will turn this warning into an error.") name();
+ static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
+ on_communication_state_change;
};
-}
-}
+} // namespace s4u
+} // namespace simgrid
#endif /* SURF_NETWORK_INTERFACE_HPP_ */
