/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
* and actors can retrieve the host on which they run using @ref simgrid::s4u::Host::current() or
* @ref simgrid::s4u::this_actor::get_host().
*/
* and actors can retrieve the host on which they run using @ref simgrid::s4u::Host::current() or
* @ref simgrid::s4u::this_actor::get_host().
*/
-class XBT_PUBLIC Host : public simgrid::xbt::Extendable<Host> {
- friend simgrid::vm::VMModel; // Use the pimpl_cpu to compute the VM sharing
- friend simgrid::vm::VirtualMachineImpl; // creates the the pimpl_cpu
+class XBT_PUBLIC Host : public xbt::Extendable<Host> {
+ friend vm::VMModel; // Use the pimpl_cpu to compute the VM sharing
+ friend vm::VirtualMachineImpl; // creates the the pimpl_cpu
- static simgrid::xbt::signal<void(Host&)> on_creation;
- /*** Called just before destructing an host */
- static simgrid::xbt::signal<void(Host&)> on_destruction;
+ static xbt::signal<void(Host&)> on_creation;
+ /*** Called just before destructing a host */
+ static xbt::signal<void(Host&)> on_destruction;
/*** Called when the speed of the machine is changed (called AFTER the change)
* (either because of a pstate switch or because of an external load event coming from the profile) */
/*** Called when the speed of the machine is changed (called AFTER the change)
* (either because of a pstate switch or because of an external load event coming from the profile) */
- /** Retrieves an host from its name, or return nullptr */
- static Host* by_name_or_null(std::string name);
- /** Retrieves an host from its name, or die */
- static s4u::Host* by_name(std::string name);
- /** Retrieves the host on which the current actor is running */
- static s4u::Host* current();
+ /** Retrieve a host from its name, or return nullptr */
+ static Host* by_name_or_null(const std::string& name);
+ /** Retrieve a host from its name, or die */
+ static Host* by_name(const std::string& name);
+ /** Retrieves the host on which the running actor is located */
+ static Host* current();
/** Retrieves the name of that host as a C string */
const char* get_cname() const { return name_.c_str(); }
/** Retrieves the name of that host as a C string */
const char* get_cname() const { return name_.c_str(); }
- * All actors on that host which were marked autorestart will be restarted automatically.
- * This call does nothing if the host is already on.
+ * This call does nothing if the host is already on. If it was off, all actors which were marked 'autorestart' on that
+ * host will be restarted automatically (note that this may differ from the actors that were initially running on the
+ * host).
+ *
+ * All other Host's properties are left unchanged; in particular, the pstate is left unchanged and not reset to its
+ * initial value.
/** Returns if that host is currently up and running */
bool is_on() const;
/** Returns if that host is currently down and offline */
/** Returns if that host is currently up and running */
bool is_on() const;
/** Returns if that host is currently down and offline */
- const char* get_property(std::string key) const;
- void set_property(std::string key, std::string value);
+ const char* get_property(const std::string& key) const;
+ void set_property(const std::string& key, const std::string& value);
#ifndef DOXYGEN
/** @deprecated See Host::get_properties() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
#ifndef DOXYGEN
/** @deprecated See Host::get_properties() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
#ifndef DOXYGEN
/** @deprecated See Host::get_speed() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
#ifndef DOXYGEN
/** @deprecated See Host::get_speed() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
std::vector<const char*>* storages);
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
std::vector<const char*>* storages);
/** Get an associative list [mount point]->[Storage] of all local mount points.
*
* This is defined in the platform file, and cannot be modified programatically (yet).
*/
std::unordered_map<std::string, Storage*> const& get_mounted_storages();
/** Get an associative list [mount point]->[Storage] of all local mount points.
*
* This is defined in the platform file, and cannot be modified programatically (yet).
*/
std::unordered_map<std::string, Storage*> const& get_mounted_storages();
/** @deprecated See Host::get_mounted_storages() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
{
return get_mounted_storages();
}
/** @deprecated See Host::get_mounted_storages() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
{
return get_mounted_storages();
}
void route_to(Host* dest, std::vector<Link*>& links, double* latency);
void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
void route_to(Host* dest, std::vector<Link*>& links, double* latency);
void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
/** @deprecated See Host::is_on() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
/** @deprecated See Host::is_off() */
/** @deprecated See Host::is_on() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
/** @deprecated See Host::is_off() */
/** @deprecated See Host::get_property() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
{
return get_property(key);
}
/** @deprecated See Host::set_property() */
/** @deprecated See Host::get_property() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
{
return get_property(key);
}
/** @deprecated See Host::set_property() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
+ XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(const std::string& key,
+ const std::string& value)
/** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
surf::Cpu* pimpl_cpu = nullptr;
// TODO, this could be a unique_ptr
surf::HostImpl* pimpl_ = nullptr;
/** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
kernel::routing::NetPoint* pimpl_netpoint = nullptr;
/** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
surf::Cpu* pimpl_cpu = nullptr;
// TODO, this could be a unique_ptr
surf::HostImpl* pimpl_ = nullptr;
/** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
kernel::routing::NetPoint* pimpl_netpoint = nullptr;