Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
c0f9ffba83db261a4dde25da5db33237f2901abd
[simgrid.git] / include / simgrid / s4u / Host.hpp
1 /* Copyright (c) 2006-2018. 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 SIMGRID_S4U_HOST_HPP
7 #define SIMGRID_S4U_HOST_HPP
8
9 #include <simgrid/forward.h>
10 #include <xbt/Extendable.hpp>
11 #include <xbt/signal.hpp>
12 #include <xbt/string.hpp>
13
14 #include <map>
15 #include <unordered_map>
16
17 namespace simgrid {
18
19 namespace xbt {
20 extern template class XBT_PUBLIC Extendable<simgrid::s4u::Host>;
21 }
22 namespace s4u {
23
24 /** @ingroup s4u_api
25  *
26  * @tableofcontents
27  *
28  * An host represents some physical resource with computing and networking capabilities.
29  *
30  * All hosts are automatically created during the call of the method
31  * @ref simgrid::s4u::Engine::loadPlatform().
32  * You cannot create a host yourself.
33  *
34  * You can retrieve a particular host using simgrid::s4u::Host::byName()
35  * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
36  */
37 class XBT_PUBLIC Host : public simgrid::xbt::Extendable<Host> {
38
39 public:
40   explicit Host(const char* name);
41
42   /** Host destruction logic */
43 protected:
44   virtual ~Host();
45
46 private:
47   bool currentlyDestroying_ = false;
48
49 public:
50   /*** Called on each newly created host */
51   static simgrid::xbt::signal<void(Host&)> on_creation;
52   /*** Called just before destructing an host */
53   static simgrid::xbt::signal<void(Host&)> on_destruction;
54   /*** Called when the machine is turned on or off (called AFTER the change) */
55   static simgrid::xbt::signal<void(Host&)> on_state_change;
56   /*** Called when the speed of the machine is changed (called AFTER the change)
57    * (either because of a pstate switch or because of an external load event coming from the profile) */
58   static simgrid::xbt::signal<void(Host&)> on_speed_change;
59
60   virtual void destroy();
61   // No copy/move
62   Host(Host const&) = delete;
63   Host& operator=(Host const&) = delete;
64
65   /** Retrieves an host from its name, or return nullptr */
66   static Host* by_name_or_null(const char* name);
67   /** Retrieves an host from its name, or return nullptr */
68   static Host* by_name_or_null(std::string name);
69   /** Retrieves an host from its name, or die */
70   static s4u::Host* by_name(const char* name);
71   /** Retrieves an host from its name, or die */
72   static s4u::Host* by_name(std::string name);
73   /** Retrieves the host on which the current actor is running */
74   static s4u::Host* current();
75
76   /** Retrieves the name of that host as a C++ string */
77   simgrid::xbt::string const& get_name() const { return name_; }
78   /** Retrieves the name of that host as a C string */
79   const char* get_cname() const { return name_.c_str(); }
80
81   void actorList(std::vector<ActorPtr> * whereto);
82
83   /** Turns that host on if it was previously off
84    *
85    * All actors on that host which were marked autorestart will be restarted automatically.
86    * This call does nothing if the host is already on.
87    */
88   void turnOn();
89   /** Turns that host off. All actors are forcefully stopped. */
90   void turnOff();
91   /** Returns if that host is currently up and running */
92   bool isOn();
93   /** Returns if that host is currently down and offline */
94   bool isOff() { return not isOn(); }
95
96   double getSpeed();
97   double get_available_speed();
98   int getCoreCount();
99   std::map<std::string, std::string>* getProperties();
100   const char* getProperty(const char* key);
101   void setProperty(std::string key, std::string value);
102   void getProcesses(std::vector<ActorPtr> * list);
103   int get_actor_count();
104   double getPstateSpeed(int pstate_index);
105   int getPstatesCount() const;
106   void setPstate(int pstate_index);
107   int getPstate();
108   std::vector<const char*> get_attached_storages();
109   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
110       std::vector<const char*>* storages);
111
112   /** Get an associative list [mount point]->[Storage] of all local mount points.
113    *
114    *  This is defined in the platform file, and cannot be modified programatically (yet).
115    */
116   std::unordered_map<std::string, Storage*> const& getMountedStorages();
117
118   void routeTo(Host* dest, std::vector<Link*>& links, double* latency);
119   void routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
120
121   /** Block the calling actor on an execution located on the called host
122    *
123    * It is not a problem if the actor is not located on the called host.
124    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
125    */
126   void execute(double flops);
127   /** Block the calling actor on an execution located on the called host (with explicit priority) */
128   void execute(double flops, double priority);
129
130   /** @brief Returns the current computation load (in flops per second)
131    * The external load (coming from an availability trace) is not taken in account.
132    *
133    * @return      The number of activities currently running on a host (an activity at priority 2 is counted twice).
134    */
135   double getLoad();
136
137   // Deprecated functions
138   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
139   {
140     return name_;
141   }
142   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
143
144 private:
145   simgrid::xbt::string name_{"noname"};
146   std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
147
148 public:
149   // TODO, this could be a unique_ptr
150   surf::HostImpl* pimpl_ = nullptr;
151   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
152   surf::Cpu* pimpl_cpu = nullptr;
153   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
154   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
155 };
156 }
157 } // namespace simgrid::s4u
158
159 extern int USER_HOST_LEVEL;
160
161 #endif /* SIMGRID_S4U_HOST_HPP */