X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e83a6a62aac54e3477bd15c64f243cfa23b3add3..6bc18b576fa4a890d8b9916d292ca67dfbf60dd3:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index 87f6cbb544..26568e8b1d 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -35,11 +35,13 @@ namespace s4u { * and actors can retrieve the host on which they run using simgrid::s4u::Host::current(). */ class XBT_PUBLIC Host : public simgrid::xbt::Extendable { +#ifndef DOXYGEN friend simgrid::vm::VMModel; // Use the pimpl_cpu to compute the VM sharing friend simgrid::vm::VirtualMachineImpl; // creates the the pimpl_cpu +#endif public: - explicit Host(const char* name); + explicit Host(std::string name); /** Host destruction logic */ protected: @@ -64,13 +66,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(); @@ -92,24 +90,47 @@ public: /** 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(); } + bool is_off() const { return not is_on(); } - const char* get_property(const char* key); + const char* get_property(std::string key) const; void set_property(std::string key, std::string value); - std::map* getProperties(); + 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(); + std::unordered_map* props = get_properties(); + for (auto const& kv : *props) + 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; + +#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(); + std::vector get_attached_storages() const; XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages( std::vector* storages); @@ -117,7 +138,12 @@ public: * * This is defined in the platform file, and cannot be modified programatically (yet). */ - std::unordered_map const& getMountedStorages(); + 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(); + } void route_to(Host* dest, std::vector& links, double* latency); void route_to(Host* dest, std::vector& links, double* latency); @@ -131,55 +157,64 @@ public: /** 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* 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"}; + simgrid::xbt::string name_ {"noname"}; std::unordered_map* mounts_ = nullptr; // caching public: