*
* @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
const char* get_property(std::string key) const;
void set_property(std::string key, std::string value);
std::unordered_map<std::string, std::string>* get_properties();
+
+#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 get_speed() const;
double get_available_speed() const;
void set_pstate(int pstate_index);
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);
}
+#endif
std::vector<const char*> get_attached_storages() const;
XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
* 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();
* 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);
// 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(); }
+ /** @deprecated See Host::is_off() */
XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return 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() */
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"};
