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(const char* 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(const char* name);
69 /** Retrieves an host from its name, or return nullptr */
70 static Host* by_name_or_null(std::string name);
71 /** Retrieves an host from its name, or die */
72 static s4u::Host* by_name(const char* name);
73 /** Retrieves an host from its name, or die */
74 static s4u::Host* by_name(std::string name);
75 /** Retrieves the host on which the current actor is running */
76 static s4u::Host* current();
78 /** Retrieves the name of that host as a C++ string */
79 simgrid::xbt::string const& get_name() const { return name_; }
80 /** Retrieves the name of that host as a C string */
81 const char* get_cname() const { return name_.c_str(); }
83 int get_actor_count();
84 std::vector<ActorPtr> get_all_actors();
86 /** Turns that host on if it was previously off
88 * All actors on that host which were marked autorestart will be restarted automatically.
89 * This call does nothing if the host is already on.
92 /** Turns that host off. All actors are forcefully stopped. */
94 /** Returns if that host is currently up and running */
96 /** Returns if that host is currently down and offline */
97 bool is_off() { return not is_on(); }
99 const char* get_property(const char* key);
100 void set_property(std::string key, std::string value);
101 std::map<std::string, std::string>* getProperties();
104 double get_available_speed();
107 double getPstateSpeed(int pstate_index);
108 int getPstatesCount() const;
109 void setPstate(int pstate_index);
111 std::vector<const char*> get_attached_storages();
112 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
113 std::vector<const char*>* storages);
115 /** Get an associative list [mount point]->[Storage] of all local mount points.
117 * This is defined in the platform file, and cannot be modified programatically (yet).
119 std::unordered_map<std::string, Storage*> const& getMountedStorages();
121 void routeTo(Host* dest, std::vector<Link*>& links, double* latency);
122 void routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
124 /** Block the calling actor on an execution located on the called host
126 * It is not a problem if the actor is not located on the called host.
127 * The actor will not be migrated in this case. Such remote execution are easy in simulation.
129 void execute(double flops);
130 /** Block the calling actor on an execution located on the called host (with explicit priority) */
131 void execute(double flops, double priority);
133 /** @brief Returns the current computation load (in flops per second)
134 * The external load (coming from an availability trace) is not taken in account.
136 * @return The number of activities currently running on a host (an activity at priority 2 is counted twice).
140 // Deprecated functions
141 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
145 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
146 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector<ActorPtr>* whereto);
147 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector<ActorPtr>* list);
148 XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); }
149 XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); }
150 XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
151 XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); }
153 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
155 return get_property(key);
157 XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
159 set_property(key, value);
163 simgrid::xbt::string name_{"noname"};
164 std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
167 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
168 surf::Cpu* pimpl_cpu = nullptr;
169 // TODO, this could be a unique_ptr
170 surf::HostImpl* pimpl_ = nullptr;
171 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
172 kernel::routing::NetPoint* pimpl_netpoint = nullptr;
175 } // namespace simgrid::s4u
177 extern int USER_HOST_LEVEL;
179 #endif /* SIMGRID_S4U_HOST_HPP */