X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ec0f63f2f483005848e9ff182daaa53825bb28dd..a73d204e173f35c0abb92b26e061929066b8b283:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index 83e70252c8..b066d36c54 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -1,4 +1,4 @@ -/* 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. */ @@ -17,10 +17,10 @@ namespace simgrid { namespace xbt { -extern template class XBT_PUBLIC Extendable; -} -namespace s4u { +extern template class XBT_PUBLIC Extendable; +} // namespace xbt +namespace s4u { /** @ingroup s4u_api * * @tableofcontents @@ -35,45 +35,45 @@ namespace s4u { * 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 +class XBT_PUBLIC Host : public xbt::Extendable { + friend vm::VMModel; // Use the pimpl_cpu to compute the VM sharing + friend vm::VirtualMachineImpl; // creates the the pimpl_cpu public: - explicit Host(std::string name); + explicit Host(const std::string& name); /** Host destruction logic */ protected: virtual ~Host(); private: - bool currentlyDestroying_ = false; + bool currently_destroying_ = false; public: - /*** Called on each newly created host */ - static simgrid::xbt::signal on_creation; - /*** Called just before destructing an host */ - static simgrid::xbt::signal on_destruction; - /*** Called when the machine is turned on or off (called AFTER the change) */ - static simgrid::xbt::signal on_state_change; - /*** Called when the speed of the machine is changed (called AFTER the change) + /** Called on each newly created host */ + static xbt::signal on_creation; + /** Called just before destructing a host */ + static xbt::signal on_destruction; + /** Called when the machine is turned on or off (called AFTER the change) */ + static xbt::signal on_state_change; + /** Called when the speed of the machine is changed (called AFTER the change) * (either because of a pstate switch or because of an external load event coming from the profile) */ - static simgrid::xbt::signal on_speed_change; + static xbt::signal on_speed_change; virtual void destroy(); // No copy/move Host(Host const&) = delete; Host& operator=(Host const&) = delete; - /** Retrieve an host from its name, or return nullptr */ - static Host* by_name_or_null(std::string name); - /** Retrieve an host from its name, or die */ - static s4u::Host* by_name(std::string name); - /** Retrieve the host on which the current actor is running */ - static s4u::Host* current(); + /** 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 Host* by_name(const std::string& name); + /** Retrieves the host on which the running actor is located */ + static Host* current(); /** Retrieves the name of that host as a C++ string */ - simgrid::xbt::string const& get_name() const { return name_; } + xbt::string const& get_name() const { return name_; } /** Retrieves the name of that host as a C string */ const char* get_cname() const { return name_.c_str(); } @@ -82,32 +82,26 @@ public: /** 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() const; - /** Returns if that host is currently down and offline */ - bool is_off() const { return not is_on(); } - const char* get_property(std::string key) const; - void set_property(std::string key, std::string value); - std::unordered_map* get_properties(); + const char* get_property(const std::string& key) const; + void set_property(const std::string& key, const std::string& value); + const std::unordered_map* get_properties() const; + void set_properties(const std::map& 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 + void set_state_profile(kernel::profile::Profile* p); + void set_speed_profile(kernel::profile::Profile* p); double get_speed() const; double get_available_speed() const; @@ -119,36 +113,23 @@ 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); - } + std::vector get_disks() const; + void add_disk(Disk* disk); + void remove_disk(const std::string& disk_name); std::vector get_attached_storages() const; - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages( - std::vector* 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 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 const& getMountedStorages() - { - return get_mounted_storages(); - } -#endif void route_to(Host* dest, std::vector& links, double* latency); void route_to(Host* dest, std::vector& links, double* latency); + void send_to(Host* dest, double byte_amount); + NetZone* get_englobing_zone(); /** Block the calling actor on an execution located on the called host * * It is not a problem if the actor is not located on the called host. @@ -161,79 +142,21 @@ public: /** 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"}; + xbt::string name_{"noname"}; std::unordered_map* 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; + kernel::resource::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 - -extern int USER_HOST_LEVEL; +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_HOST_HPP */