-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */
/* 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. */
*
* @tableofcontents
*
- * An host represents some physical resource with computing and networking capabilities.
+ * Some physical resource with computing and networking capabilities on which Actors execute.
*
* All hosts are automatically created during the call of the method
- * @ref simgrid::s4u::Engine::loadPlatform().
+ * @ref simgrid::s4u::Engine::load_platform().
* You cannot create a host yourself.
*
- * 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:
- explicit Host(const char* name);
+ explicit Host(std::string name);
/** Host destruction logic */
protected:
public:
/*** Called on each newly created host */
static simgrid::xbt::signal<void(Host&)> on_creation;
- /*** Called just before destructing an host */
+ /*** Called just before destructing a host */
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;
Host(Host const&) = delete;
Host& operator=(Host const&) = delete;
- /** 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 */
- static Host* by_name_or_null(std::string name);
- /** Retrieves an host from its name, or die */
- static s4u::Host* by_name(const char* 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 */
+ /** 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 s4u::Host* by_name(const std::string& name);
+ /** Retrieves the host on which the running actor is located */
static s4u::Host* current();
/** Retrieves the name of that host as a C++ string */
/** Turns that host on if it was previously off
*
- * 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.
*/
void turn_on();
/** Turns that host off. All actors are forcefully stopped. */
void turn_off();
/** Returns if that host is currently up and running */
- bool is_on();
+ bool is_on() const;
/** Returns if that host is currently down and offline */
- bool is_off() { return not is_on(); }
+ XBT_ATTRIB_DEPRECATED_v325("Please use !is_on()") bool is_off() const { return not is_on(); }
- const char* get_property(const char* key);
- 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, std::string value);
std::unordered_map<std::string, std::string>* get_properties();
+
+ void set_state_profile(kernel::profile::Profile* p);
+ void set_speed_profile(kernel::profile::Profile* p);
+
+#ifndef DOXYGEN
+ /** @deprecated See Host::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>();
res->insert(kv);
return res;
}
+#endif
- 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;
- double getPstateSpeed(int pstate_index);
+ double get_pstate_speed(int pstate_index) const;
int get_pstate_count() const;
void set_pstate(int pstate_index);
- int get_pstate();
+ int get_pstate() const;
- std::vector<const char*> get_attached_storages();
+#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);
+ }
+
+ std::vector<const char*> get_attached_storages() const;
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
std::vector<const char*>* storages);
+#endif
/** 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);
* The actor will not be migrated in this case. Such remote execution are easy in simulation.
*/
void execute(double flops);
+ /** Start an asynchronous computation on that host (possibly remote) */
+ ExecPtr exec_async(double flops_amounts);
+
/** Block the calling actor on an execution located on the called host (with explicit priority) */
void execute(double flops, double priority);
- /** @brief Returns the current computation load (in flops per second)
- * The external load (coming from an availability trace) is not taken in account.
- *
- * @return The number of activities currently running on a host (an activity at priority 2 is counted twice).
- */
- double getLoad();
-
// Deprecated functions
+#ifndef DOXYGEN
+ /** @deprecated See Host::get_name() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
{
return name_;
}
+ /** @deprecated See Host::get_cname() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
+ /** @deprecated See Host::get_all_actors() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector<ActorPtr>* whereto);
+ /** @deprecated See Host::get_all_actors() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector<ActorPtr>* list);
+ /** @deprecated See Host::turn_on() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); }
+ /** @deprecated See Host::turn_off() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); }
+ /** @deprecated See Host::is_on() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); }
-
+ /** @deprecated See Host::is_off() */
+ XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return not is_on(); }
+ /** @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)
{
set_property(key, value);
}
+ /** @deprecated See Host::set_pstate() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); }
+ /** @deprecated See Host::get_pstate() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); }
-
+ /** @deprecated See Host::route_to() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
double* latency)
{
route_to(dest, links, latency);
}
+ /** @deprecated See Host::route_to() */
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);
}
+ /** @deprecated See Host::get_core_count() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); }
+ /** @deprecated See Host::get_pstate_count() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
{
return get_pstate_count();
}
+#endif /* !DOXYGEN */
private:
- simgrid::xbt::string name_{"noname"};
+ simgrid::xbt::string name_ {"noname"};
std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
public:
+#ifndef DOXYGEN
/** 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;
+#endif
};
}
} // namespace simgrid::s4u