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> {
40 explicit Host(const char* name);
42 /** Host destruction logic */
47 bool currentlyDestroying_ = false;
50 virtual void destroy();
52 Host(Host const&) = delete;
53 Host& operator=(Host const&) = delete;
55 /** Retrieves an host from its name, or return nullptr */
56 static Host* by_name_or_null(const char* name);
57 /** Retrieves an host from its name, or return nullptr */
58 static Host* by_name_or_null(std::string name);
59 /** Retrieves an host from its name, or die */
60 static s4u::Host* by_name(const char* name);
61 /** Retrieves an host from its name, or die */
62 static s4u::Host* by_name(std::string name);
63 /** Retrieves the host on which the current actor is running */
64 static s4u::Host* current();
66 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
70 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
72 /** Retrieves the name of that host as a C++ string */
73 simgrid::xbt::string const& get_name() const { return name_; }
74 /** Retrieves the name of that host as a C string */
75 const char* get_cname() const { return name_.c_str(); }
77 void actorList(std::vector<ActorPtr> * whereto);
79 /** Turns that host on if it was previously off
81 * All actors on that host which were marked autorestart will be restarted automatically.
82 * This call does nothing if the host is already on.
85 /** Turns that host off. All actors are forcefully stopped. */
87 /** Returns if that host is currently up and running */
89 /** Returns if that host is currently down and offline */
90 bool isOff() { return not isOn(); }
93 double get_available_speed();
95 std::map<std::string, std::string>* getProperties();
96 const char* getProperty(const char* key);
97 void setProperty(std::string key, std::string value);
98 void getProcesses(std::vector<ActorPtr> * list);
99 int get_actor_count();
100 double getPstateSpeed(int pstate_index);
101 int getPstatesCount() const;
102 void setPstate(int pstate_index);
104 std::vector<const char*> get_attached_storages();
105 XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
106 std::vector<const char*>* storages);
108 /** Get an associative list [mount point]->[Storage] of all local mount points.
110 * This is defined in the platform file, and cannot be modified programatically (yet).
112 std::unordered_map<std::string, Storage*> const& getMountedStorages();
114 void routeTo(Host* dest, std::vector<Link*>& links, double* latency);
115 void routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
117 /** Block the calling actor on an execution located on the called host
119 * It is not a problem if the actor is not located on the called host.
120 * The actor will not be migrated in this case. Such remote execution are easy in simulation.
122 void execute(double flops);
123 /** Block the calling actor on an execution located on the called host (with explicit priority) */
124 void execute(double flops, double priority);
126 /** @brief Returns the current computation load (in flops per second) */
130 simgrid::xbt::string name_{"noname"};
131 std::unordered_map<std::string, Storage*>* mounts = nullptr; // caching
134 // TODO, this could be a unique_ptr
135 surf::HostImpl* pimpl_ = nullptr;
136 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
137 surf::Cpu* pimpl_cpu = nullptr;
138 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
139 kernel::routing::NetPoint* pimpl_netpoint = nullptr;
141 /*** Called on each newly created host */
142 static simgrid::xbt::signal<void(Host&)> onCreation;
143 /*** Called just before destructing an host */
144 static simgrid::xbt::signal<void(Host&)> onDestruction;
145 /*** Called when the machine is turned on or off (called AFTER the change) */
146 static simgrid::xbt::signal<void(Host&)> onStateChange;
147 /*** Called when the speed of the machine is changed (called AFTER the change)
148 * (either because of a pstate switch or because of an external load event coming from the profile) */
149 static simgrid::xbt::signal<void(Host&)> onSpeedChange;
152 } // namespace simgrid::s4u
154 extern int USER_HOST_LEVEL;
156 #endif /* SIMGRID_S4U_HOST_HPP */
163 * This method returns the number of tasks currently running on a host.
164 * The external load (coming from an availability trace) is not taken in account.
166 * @return The number of tasks currently running on a host.
168 public native int getLoad();