Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove features marked with XBT_ATTRIB_DEPRECATED_v325.
[simgrid.git] / include / simgrid / s4u / Host.hpp
1 /* Copyright (c) 2006-2019. 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<s4u::Host>;
21 } // namespace xbt
22
23 namespace s4u {
24 /** @ingroup s4u_api
25  *
26  * @tableofcontents
27  *
28  * Some physical resource with computing and networking capabilities on which Actors execute.
29  *
30  * All hosts are automatically created during the call of the method
31  * @ref simgrid::s4u::Engine::load_platform().
32  * You cannot create a host yourself.
33  *
34  * You can retrieve a particular host using @ref simgrid::s4u::Host::by_name()
35  * and actors can retrieve the host on which they run using @ref simgrid::s4u::Host::current() or
36  * @ref simgrid::s4u::this_actor::get_host().
37  */
38 class XBT_PUBLIC Host : public xbt::Extendable<Host> {
39   friend vm::VMModel;            // Use the pimpl_cpu to compute the VM sharing
40   friend vm::VirtualMachineImpl; // creates the the pimpl_cpu
41
42 public:
43   explicit Host(const std::string& name);
44
45   /** Host destruction logic */
46 protected:
47   virtual ~Host();
48
49 private:
50   bool currently_destroying_ = false;
51
52 public:
53   /** Called on each newly created host */
54   static xbt::signal<void(Host&)> on_creation;
55   /** Called just before destructing a host */
56   static xbt::signal<void(Host const&)> on_destruction;
57   /** Called when the machine is turned on or off (called AFTER the change) */
58   static xbt::signal<void(Host const&)> on_state_change;
59   /** Called when the speed of the machine is changed (called AFTER the change)
60    * (either because of a pstate switch or because of an external load event coming from the profile) */
61   static xbt::signal<void(Host const&)> on_speed_change;
62
63   virtual void destroy();
64   // No copy/move
65   Host(Host const&) = delete;
66   Host& operator=(Host const&) = delete;
67
68   /** Retrieve a host from its name, or return nullptr */
69   static Host* by_name_or_null(const std::string& name);
70   /** Retrieve a host from its name, or die */
71   static Host* by_name(const std::string& name);
72   /** Retrieves the host on which the running actor is located */
73   static Host* current();
74
75   /** Retrieves the name of that host as a C++ string */
76   xbt::string const& get_name() const { return name_; }
77   /** Retrieves the name of that host as a C string */
78   const char* get_cname() const { return name_.c_str(); }
79
80   int get_actor_count();
81   std::vector<ActorPtr> get_all_actors();
82
83   /** Turns that host on if it was previously off
84    *
85    * This call does nothing if the host is already on. If it was off, all actors which were marked 'autorestart' on that
86    * host will be restarted automatically (note that this may differ from the actors that were initially running on the
87    * host).
88    *
89    * All other Host's properties are left unchanged; in particular, the pstate is left unchanged and not reset to its
90    * initial value.
91    */
92   void turn_on();
93   /** Turns that host off. All actors are forcefully stopped. */
94   void turn_off();
95   /** Returns if that host is currently up and running */
96   bool is_on() const;
97
98   const char* get_property(const std::string& key) const;
99   void set_property(const std::string& key, const std::string& value);
100   const std::unordered_map<std::string, std::string>* get_properties() const;
101   void set_properties(const std::map<std::string, std::string>& properties);
102
103   void set_state_profile(kernel::profile::Profile* p);
104   void set_speed_profile(kernel::profile::Profile* p);
105
106   double get_speed() const;
107   double get_available_speed() const;
108   int get_core_count() const;
109   double get_load() const;
110
111   double get_pstate_speed(int pstate_index) const;
112   int get_pstate_count() const;
113   void set_pstate(int pstate_index);
114   int get_pstate() const;
115
116   std::vector<Disk*> get_disks() const;
117   void add_disk(Disk* disk);
118   void remove_disk(const std::string& disk_name);
119
120   std::vector<const char*> get_attached_storages() const;
121
122   /** Get an associative list [mount point]->[Storage] of all local mount points.
123    *
124    *  This is defined in the platform file, and cannot be modified programatically (yet).
125    */
126   std::unordered_map<std::string, Storage*> const& get_mounted_storages();
127
128   void route_to(Host* dest, std::vector<Link*>& links, double* latency);
129   void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
130   void send_to(Host* dest, double byte_amount);
131
132   NetZone* get_englobing_zone();
133   /** Block the calling actor on an execution located on the called host
134    *
135    * It is not a problem if the actor is not located on the called host.
136    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
137    */
138   void execute(double flops);
139   /** Start an asynchronous computation on that host (possibly remote) */
140   ExecPtr exec_async(double flops_amounts);
141
142   /** Block the calling actor on an execution located on the called host (with explicit priority) */
143   void execute(double flops, double priority);
144
145 private:
146   xbt::string name_{"noname"};
147   std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
148
149 public:
150 #ifndef DOXYGEN
151   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
152   kernel::resource::Cpu* pimpl_cpu = nullptr;
153   // TODO, this could be a unique_ptr
154   surf::HostImpl* pimpl_ = nullptr;
155   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
156   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
157 #endif
158 };
159 } // namespace s4u
160 } // namespace simgrid
161
162 #endif /* SIMGRID_S4U_HOST_HPP */