Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #237 from oar-team/upstream
[simgrid.git] / include / simgrid / s4u / Link.hpp
1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef S4U_LINK_HPP_
7 #define S4U_LINK_HPP_
8
9 #include <simgrid/link.h>
10 #include <string>
11 #include <unordered_map>
12 #include <xbt/Extendable.hpp>
13 #include <xbt/base.h>
14 #include <xbt/signal.hpp>
15
16 /***********
17  * Classes *
18  ***********/
19
20 namespace simgrid {
21 namespace surf {
22 class NetworkAction;
23 };
24 namespace s4u {
25 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
26 XBT_PUBLIC_CLASS Link : public simgrid::xbt::Extendable<Link>
27 {
28   friend simgrid::surf::LinkImpl;
29
30   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
31   explicit Link(surf::LinkImpl* pimpl) : pimpl_(pimpl) {}
32   virtual ~Link() = default;
33   // The private implementation, that never changes
34   surf::LinkImpl* const pimpl_;
35
36 public:
37   /** @brief Retrieve a link from its name */
38   static Link* byName(const char* name);
39
40   /** @brief Retrieves the name of that link as a C++ string */
41   const std::string& getName() const;
42   /** @brief Retrieves the name of that link as a C string */
43   const char* getCname() const;
44
45   /** @brief Get the bandwidth in bytes per second of current Link */
46   double bandwidth();
47
48   /** @brief Get the latency in seconds of current Link */
49   double latency();
50
51   /** @brief The sharing policy is a @{link e_surf_link_sharing_policy_t::EType} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX)
52    */
53   int sharingPolicy();
54
55   /** @brief Returns the current load (in flops per second) */
56   double getUsage();
57
58   /** @brief Check if the Link is used */
59   bool isUsed();
60
61   void turnOn();
62   void turnOff();
63
64   void* getData();
65   void setData(void* d);
66
67   void setStateTrace(tmgr_trace_t trace); /*< setup the trace file with states events (ON or OFF). Trace must contain
68                                              boolean values. */
69   void setBandwidthTrace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
70                                                   external load). Trace must contain percentages (value between 0 and 1). */
71   void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
72                                                external load). Trace must contain absolute values */
73
74   const char* getProperty(const char* key);
75   void setProperty(std::string key, std::string value);
76
77   /* The signals */
78   /** @brief Callback signal fired when a new Link is created */
79   static simgrid::xbt::signal<void(s4u::Link&)> onCreation;
80
81   /** @brief Callback signal fired when a Link is destroyed */
82   static simgrid::xbt::signal<void(s4u::Link&)> onDestruction;
83
84   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
85   static simgrid::xbt::signal<void(s4u::Link&)> onStateChange;
86
87   /** @brief Callback signal fired when a communication starts */
88   static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
89
90   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
91   static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
92
93   XBT_ATTRIB_DEPRECATED_v321("Use getCname(): v3.21 will turn this warning into an error.") const char* name();
94 };
95 }
96 }
97
98 #endif /* SURF_NETWORK_INTERFACE_HPP_ */