1 /* Copyright (c) 2006-2015. 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
11 #include <unordered_map>
13 #include "xbt/Extendable.hpp"
15 #include "xbt/signal.hpp"
16 #include "xbt/string.hpp"
19 #include "simgrid/forward.h"
20 #include "simgrid/s4u/forward.hpp"
25 extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
33 * An host represents some physical resource with computing and networking capabilities.
35 * All hosts are automatically created during the call of the method
36 * @ref simgrid::s4u::Engine::loadPlatform().
37 * You cannot create a host yourself.
39 * You can retrieve a particular host using simgrid::s4u::Host::byName()
40 * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
42 XBT_PUBLIC_CLASS Host : public simgrid::xbt::Extendable<Host>
46 explicit Host(const char* name);
48 /** Host destruction logic */
53 bool currentlyDestroying_ = false;
58 Host(Host const&) = delete;
59 Host& operator=(Host const&) = delete;
61 /** Retrieves an host from its name, or return nullptr */
62 static Host* by_name_or_null(const char* name);
63 /** Retrieves an host from its name, or return nullptr */
64 static Host* by_name_or_null(std::string name);
65 /** Retrieves an host from its name, or die */
66 static s4u::Host* by_name(std::string name);
67 /** Retrieves the host on which the current actor is running */
68 static s4u::Host* current();
70 simgrid::xbt::string const& getName() const { return name_; }
71 const char* getCname() { return name_.c_str(); }
73 void actorList(std::vector<ActorPtr> * whereto);
75 /** Turns that host on if it was previously off
77 * All actors on that host which were marked autorestart will be restarted automatically.
78 * This call does nothing if the host is already on.
81 /** Turns that host off. All actors are forcefully stopped. */
83 /** Returns if that host is currently up and running */
85 /** Returns if that host is currently down and offline */
86 bool isOff() { return not isOn(); }
90 std::map<std::string, std::string>* getProperties();
91 const char* getProperty(const char* key);
92 void setProperty(std::string key, std::string value);
93 void getProcesses(std::vector<ActorPtr> * list);
94 double getPstateSpeed(int pstate_index);
95 int getPstatesCount() const;
96 void setPstate(int pstate_index);
98 void getAttachedStorages(std::vector<const char*> * storages);
100 /** Get an associative list [mount point]->[Storage] of all local mount points.
102 * This is defined in the platform file, and cannot be modified programatically (yet).
104 std::unordered_map<std::string, Storage*> const& getMountedStorages();
106 void routeTo(Host * dest, std::vector<Link*> * links, double* latency);
107 void routeTo(Host * dest, std::vector<surf::LinkImpl*> * links, double* latency);
110 simgrid::xbt::string name_ = "noname";
111 std::unordered_map<std::string, Storage*>* mounts = nullptr; // caching
114 // TODO, this could be a unique_ptr
115 surf::HostImpl* pimpl_ = nullptr;
116 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
117 surf::Cpu* pimpl_cpu = nullptr;
118 /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
119 kernel::routing::NetPoint* pimpl_netpoint = nullptr;
121 /*** Called on each newly created host */
122 static simgrid::xbt::signal<void(Host&)> onCreation;
123 /*** Called just before destructing an host */
124 static simgrid::xbt::signal<void(Host&)> onDestruction;
125 /*** Called when the machine is turned on or off (called AFTER the change) */
126 static simgrid::xbt::signal<void(Host&)> onStateChange;
127 /*** Called when the speed of the machine is changed (called AFTER the change)
128 * (either because of a pstate switch or because of an external load event coming from the profile) */
129 static simgrid::xbt::signal<void(Host&)> onSpeedChange;
132 } // namespace simgrid::s4u
134 extern int USER_HOST_LEVEL;
136 #endif /* SIMGRID_S4U_HOST_HPP */
143 * This method returns the number of tasks currently running on a host.
144 * The external load (coming from an availability trace) is not taken in account.
146 * @return The number of tasks currently running on a host.
148 public native int getLoad();