/* 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. */
- * You can retrieve a particular host using simgrid::s4u::Host::byName()
- * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
+ * You can retrieve a particular host using @ref simgrid::s4u::Host::by_name()
+ * 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
public:
*/
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
public:
static simgrid::xbt::signal<void(Host&)> on_destruction;
/*** Called when the machine is turned on or off (called AFTER the change) */
static simgrid::xbt::signal<void(Host&)> on_state_change;
static simgrid::xbt::signal<void(Host&)> on_destruction;
/*** Called when the machine is turned on or off (called AFTER the change) */
static simgrid::xbt::signal<void(Host&)> on_state_change;
- /** Retrieves an host from its name, or return nullptr */
- static Host* by_name_or_null(const char* name);
- /** Retrieves an host from its name, or return nullptr */
+ /** Retrieve a host from its name, or return nullptr */
- /** Retrieves an host from its name, or die */
- static s4u::Host* by_name(const char* name);
- /** Retrieves an host from its name, or die */
+ /** Retrieve a host from its name, or die */
/** Turns that host off. All actors are forcefully stopped. */
void turn_off();
/** Returns if that host is currently up and running */
/** Turns that host off. All actors are forcefully stopped. */
void turn_off();
/** Returns if that host is currently up and running */
void set_property(std::string key, std::string value);
std::unordered_map<std::string, std::string>* get_properties();
void set_property(std::string key, std::string value);
std::unordered_map<std::string, std::string>* get_properties();
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
{
std::map<std::string, std::string>* res = new std::map<std::string, std::string>();
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
{
std::map<std::string, std::string>* res = new std::map<std::string, std::string>();
- double getSpeed();
- double get_available_speed();
- int get_core_count();
+ double get_speed() const;
+ double get_available_speed() const;
+ int get_core_count() const;
+ double get_load() const;
+ int get_pstate() const;
+
+#ifndef DOXYGEN
+ /** @deprecated See Host::get_speed() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
+ /** @deprecated See Host::get_pstate_speed() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_speed() instead.") double getPstateSpeed(int pstate_index)
+ {
+ return get_pstate_speed(pstate_index);
+ }
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).
*/
/** 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& getMountedStorages();
+ std::unordered_map<std::string, Storage*> const& get_mounted_storages();
+#ifndef DOXYGEN
+ /** @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();
+ }
+#endif
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);
* The actor will not be migrated in this case. Such remote execution are easy in simulation.
*/
void execute(double flops);
* The actor will not be migrated in this case. Such remote execution are easy in simulation.
*/
void execute(double flops);
/** Block the calling actor on an execution located on the called host (with explicit priority) */
void execute(double flops, double priority);
/** Block the calling actor on an execution located on the called host (with explicit priority) */
void execute(double flops, double priority);
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
{
return get_property(key);
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
{
return get_property(key);
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
{
set_property(key, value);
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
{
set_property(key, value);
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
double* latency)
{
route_to(dest, links, latency);
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
double* latency)
{
route_to(dest, links, latency);
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(
Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
{
route_to(dest, links, latency);
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(
Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
{
route_to(dest, links, latency);
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
{
return get_pstate_count();
}
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
{
return get_pstate_count();
}
/** 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;