X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9f445ea00e7791874928d3022fb97bc3f2a38946..89f6d35abcb0216d91af8375fc48a027ff372a08:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index b27c954e0c..844c8dd3eb 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2017. 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. */ @@ -6,145 +6,242 @@ #ifndef SIMGRID_S4U_HOST_HPP #define SIMGRID_S4U_HOST_HPP +#include +#include +#include +#include + #include -#include #include -#include "xbt/Extendable.hpp" -#include "xbt/signal.hpp" -#include "xbt/string.hpp" -#include "xbt/swag.h" - -#include "simgrid/forward.h" -#include "simgrid/s4u/forward.hpp" - 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 * - * 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(). */ -XBT_PUBLIC_CLASS Host : public simgrid::xbt::Extendable -{ +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(const char* name); + explicit Host(const std::string& name); /** Host destruction logic */ protected: virtual ~Host(); private: - bool currentlyDestroying_ = false; + bool currently_destroying_ = false; public: - void destroy(); + /*** 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 xbt::signal on_speed_change; + + virtual void destroy(); // No copy/move 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(std::string name); - /** Retrieves 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(); - simgrid::xbt::string const& getName() const { return name_; } - const char* getCname() const { return name_.c_str(); } + /** Retrieves the name of that host as a C++ string */ + 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(); } - void actorList(std::vector * whereto); + int get_actor_count(); + std::vector get_all_actors(); /** 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 turnOn(); + void turn_on(); /** Turns that host off. All actors are forcefully stopped. */ - void turnOff(); + void turn_off(); /** Returns if that host is currently up and running */ - bool isOn(); + bool is_on() const; /** Returns if that host is currently down and offline */ - bool isOff() { return not isOn(); } - - double getSpeed(); - int getCoreCount(); - std::map* getProperties(); - const char* getProperty(const char* key); - void setProperty(std::string key, std::string value); - void getProcesses(std::vector * list); - double getPstateSpeed(int pstate_index); - int getPstatesCount() const; - void setPstate(int pstate_index); - int getPstate(); - void getAttachedStorages(std::vector * storages); + XBT_ATTRIB_DEPRECATED_v325("Please use !is_on()") bool is_off() const { return not is_on(); } + + const char* get_property(const std::string& key) const; + void set_property(const std::string& key, const std::string& value); + std::unordered_map* 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* 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 get_speed() const; + double get_available_speed() const; + int get_core_count() const; + double get_load() const; + + double get_pstate_speed(int pstate_index) const; + int get_pstate_count() const; + void set_pstate(int pstate_index); + int get_pstate() const; + + std::vector get_attached_storages() 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); + } + 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& getMountedStorages(); + 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 routeTo(Host * dest, std::vector * links, double* latency); - void routeTo(Host * dest, std::vector * links, double* latency); + /** 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. + * 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 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(const std::string& key, + const 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"; - std::unordered_map* mounts = nullptr; // caching + xbt::string name_{"noname"}; + std::unordered_map* mounts_ = nullptr; // caching public: - // TODO, this could be a unique_ptr - surf::HostImpl* pimpl_ = nullptr; +#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; - - /*** Called on each newly created host */ - static simgrid::xbt::signal onCreation; - /*** Called just before destructing an host */ - static simgrid::xbt::signal onDestruction; - /*** Called when the machine is turned on or off (called AFTER the change) */ - static simgrid::xbt::signal onStateChange; - /*** 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 onSpeedChange; +#endif }; -} -} // namespace simgrid::s4u +} // namespace s4u +} // namespace simgrid extern int USER_HOST_LEVEL; #endif /* SIMGRID_S4U_HOST_HPP */ - -#if 0 - -public class Host { - - /** - * This method returns the number of tasks currently running on a host. - * The external load (coming from an availability trace) is not taken in account. - * - * @return The number of tasks currently running on a host. - */ - public native int getLoad(); - -} -#endif