X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b60613a2c7267d689bc14020155ea38efc8135f9..e3879f46e9ecd25bf7da2e0caaf24688414b5dc0:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index cbb94851d1..9153fbe01f 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -25,21 +25,22 @@ namespace s4u { * * @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 { 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: @@ -64,13 +65,9 @@ public: 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 */ static s4u::Host* current(); @@ -96,9 +93,12 @@ public: /** Returns if that host is currently down and offline */ bool is_off() const { return not is_on(); } - const char* get_property(const char* key) const; + const char* get_property(std::string key) const; void set_property(std::string key, std::string value); std::unordered_map* get_properties(); + +#ifndef DOXYGEN + /** @deprecated See Host::get_properties() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map* getProperties() { std::map* res = new std::map(); @@ -107,6 +107,7 @@ public: res->insert(kv); return res; } +#endif double get_speed() const; double get_available_speed() const; @@ -118,11 +119,15 @@ public: 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 get_attached_storages() const; XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages( @@ -133,6 +138,7 @@ public: * This is defined in the platform file, and cannot be modified programatically (yet). */ std::unordered_map const& get_mounted_storages(); + /** @deprecated See Host::get_mounted_storages() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map const& getMountedStorages() { return get_mounted_storages(); @@ -147,48 +153,67 @@ public: * 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* whereto); + /** @deprecated See Host::get_all_actors() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector* 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& 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& 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"};