1 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_HOST_HPP
7 #define SIMGRID_S4U_HOST_HPP
9 #include <simgrid/forward.h>
10 #include <xbt/Extendable.hpp>
11 #include <xbt/signal.hpp>
12 #include <xbt/string.hpp>
15 #include <unordered_map>
20 extern template class XBT_PUBLIC Extendable<simgrid::s4u::Host>;
28 * An host represents some physical resource with computing and networking capabilities.
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.
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().
37 class XBT_PUBLIC Host : public simgrid::xbt::Extendable<Host> {
38 friend simgrid::vm::VMModel; // Use the pimpl_cpu to compute the VM sharing
39 friend simgrid::vm::VirtualMachineImpl; // creates the the pimpl_cpu
42 explicit Host(std::string name);
44 /** Host destruction logic */
49 bool currentlyDestroying_ = false;
52 /*** Called on each newly created host */
53 static simgrid::xbt::signal<void(Host&)> on_creation;
54 /*** Called just before destructing an host */
55 static simgrid::xbt::signal<void(Host&)> on_destruction;
56 /*** Called when the machine is turned on or off (called AFTER the change) */
57 static simgrid::xbt::signal<void(Host&)> on_state_change;
58 /*** Called when the speed of the machine is changed (called AFTER the change)
59 * (either because of a pstate switch or because of an external load event coming from the profile) */
60 static simgrid::xbt::signal<void(Host&)> on_speed_change;
62 virtual void destroy();
64 Host(Host const&) = delete;
65 Host& operator=(Host const&) = delete;
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(std::string name);
71 /** Retrieves the host on which the current actor is running */
72 static s4u::Host* current();
74 /** Retrieves the name of that host as a C++ string */
75 simgrid::xbt::string const& get_name() const { return name_; }
76 /** Retrieves the name of that host as a C string */
77 const char* get_cname() const { return name_.c_str(); }
79 int get_actor_count();
80 std::vector<ActorPtr> get_all_actors();
82 /** Turns that host on if it was previously off
84 * All actors on that host which were marked autorestart will be restarted automatically.
85 * This call does nothing if the host is already on.
88 /** Turns that host off. All actors are forcefully stopped. */
90 /** Returns if that host is currently up and running */
92 /** Returns if that host is currently down and offline */
93 bool is_off() const { return not is_on(); }
95 const char* get_property(std::string key) const;
96 void set_property(std::string key, std::string value);
97 std::unordered_map<std::string, std::string>* get_properties();
98 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
100 std::map<std::string, std::string>* res = new std::map<std::string, std::string>();
101 std::unordered_map<std::string, std::string>* props = get_properties();
102 for (auto const& kv : *props)
107 double get_speed() const;
108 double get_available_speed() const;
109 int get_core_count() const;
110 double get_load() const;
112 double get_pstate_speed(int pstate_index) const;
113 int get_pstate_count() const;
114 void set_pstate(int pstate_index);
115 int get_pstate() const;
117 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
118 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_speed() instead.") double getPstateSpeed(int pstate_index)
120 return get_pstate_speed(pstate_index);
123 std::vector<const char*> get_attached_storages() const;
124 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
125 std::vector<const char*>* storages);
127 /** Get an associative list [mount point]->[Storage] of all local mount points.
129 * This is defined in the platform file, and cannot be modified programatically (yet).
131 std::unordered_map<std::string, Storage*> const& get_mounted_storages();
132 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
134 return get_mounted_storages();
137 void route_to(Host* dest, std::vector<Link*>& links, double* latency);
138 void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
140 /** Block the calling actor on an execution located on the called host
142 * It is not a problem if the actor is not located on the called host.
143 * The actor will not be migrated in this case. Such remote execution are easy in simulation.
145 void execute(double flops);
146 /** Block the calling actor on an execution located on the called host (with explicit priority) */
147 void execute(double flops, double priority);
149 // Deprecated functions
150 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
154 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
155 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector<ActorPtr>* whereto);
156 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector<ActorPtr>* list);
157 XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); }
158 XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); }
159 XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
160 XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); }
162 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
164 return get_property(key);
166 XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
168 set_property(key, value);
170 XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); }
171 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); }
173 XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
176 route_to(dest, links, latency);
178 XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(
179 Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
181 route_to(dest, links, latency);
183 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); }
184 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
186 return get_pstate_count();
190 simgrid::xbt::string name_ {"noname"};
191 std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
194 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
195 surf::Cpu* pimpl_cpu = nullptr;
196 // TODO, this could be a unique_ptr
197 surf::HostImpl* pimpl_ = nullptr;
198 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
199 kernel::routing::NetPoint* pimpl_netpoint = nullptr;
202 } // namespace simgrid::s4u
204 extern int USER_HOST_LEVEL;
206 #endif /* SIMGRID_S4U_HOST_HPP */