X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b8df87e176f27b25534f27d7e240defa32ca35bc..230f14e9e54194231417a6afe68983b67693ed6d:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index 9854c2ef04..d29468ece9 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2023. 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. */ @@ -7,233 +7,301 @@ #define SIMGRID_S4U_HOST_HPP #include +#include #include #include -#include #include #include namespace simgrid { -namespace xbt { -extern template class XBT_PUBLIC Extendable; -} -namespace s4u { +extern template class XBT_PUBLIC xbt::Extendable; +namespace s4u { /** @ingroup s4u_api * * @tableofcontents * * Some physical resource with computing and networking capabilities on which Actors execute. * + * @beginrst * All hosts are automatically created during the call of the method - * @ref simgrid::s4u::Engine::load_platform(). + * :cpp:func:`simgrid::s4u::Engine::load_platform()`. * You cannot create a host yourself. * - * 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(). + * You can retrieve a particular host using :cpp:func:`simgrid::s4u::Host::by_name()` + * and actors can retrieve the host on which they run using :cpp:func:`simgrid::s4u::Host::current()` or + * :cpp:func:`simgrid::s4u::this_actor::get_host()` + * @endrst */ -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 { +#ifndef DOXYGEN + friend kernel::resource::VMModel; // Use the pimpl_cpu to compute the VM sharing + friend kernel::resource::VirtualMachineImpl; // creates the the pimpl_cpu + friend kernel::routing::NetZoneImpl; + friend kernel::resource::HostImpl; // call destructor from private implementation + + // The private implementation, that never changes + kernel::resource::HostImpl* const pimpl_; + + kernel::resource::CpuImpl* pimpl_cpu_ = nullptr; + kernel::routing::NetPoint* pimpl_netpoint_ = nullptr; +#ifndef DOXYGEN + friend kernel::resource::CpuAction; // signal exec_state_changed +#endif public: - explicit Host(std::string name); + explicit Host(kernel::resource::HostImpl* pimpl) : pimpl_(pimpl) {} - /** Host destruction logic */ protected: - virtual ~Host(); + virtual ~Host(); // Call destroy() instead of manually deleting it. + Host* set_netpoint(kernel::routing::NetPoint* netpoint); -private: - bool currentlyDestroying_ = false; + static xbt::signal on_creation; + static xbt::signal on_destruction; + xbt::signal on_this_destruction; + static xbt::signal on_exec_state_change; public: - /*** Called on each newly created host */ - static simgrid::xbt::signal on_creation; - /*** Called just before destructing a 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) + static xbt::signal on_speed_change; + xbt::signal on_this_speed_change; + static xbt::signal on_onoff; + xbt::signal on_this_onoff; + +#endif + /** \static Add a callback fired on each newly created host */ + static void on_creation_cb(const std::function& cb) { on_creation.connect(cb); } + /** \static Add a callback fired when any machine is turned on or off (called AFTER the change) */ + static void on_onoff_cb(const std::function& cb) + { + on_onoff.connect(cb); + } + XBT_ATTRIB_DEPRECATED_v337("Please use on_onoff_cb() instead") static void on_state_change_cb( + const std::function& cb) + { + on_onoff.connect(cb); + } + /** Add a callback fired when this specific machine is turned on or off (called AFTER the change) */ + void on_this_onoff_cb(const std::function& cb) + { + on_this_onoff.connect(cb); + } + /** \static Add a callback fired when the speed of any 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 void on_speed_change_cb(const std::function& cb) { on_speed_change.connect(cb); } + /** Add a callback fired when the speed of this specific machine is changed (called AFTER the change) + * (either because of a pstate switch or because of an external load event coming from the profile) */ + void on_this_speed_change_cb(const std::function& cb) + { + on_this_speed_change.connect(cb); + } + /** \static Add a callback fired just before destructing any host */ + static void on_destruction_cb(const std::function& cb) { on_destruction.connect(cb); } + /** Add a callback fired just before destructing this specific host */ + void on_this_destruction_cb(const std::function& cb) + { + on_this_destruction.connect(cb); + } + /** \static Add a callback fired when the state of any exec activity changes */ + static void on_exec_state_change_cb( + const std::function& cb) + { + on_exec_state_change.connect(cb); + } virtual void destroy(); +#ifndef DOXYGEN // No copy/move Host(Host const&) = delete; Host& operator=(Host const&) = delete; +#endif - /** Retrieve a host from its name, or return nullptr */ - static Host* by_name_or_null(std::string name); - /** Retrieve a host from its name, or die */ - static s4u::Host* by_name(std::string name); - /** Retrieves the host on which the running actor is located */ - static s4u::Host* current(); + /** \static Retrieve a host from its name, or return nullptr */ + static Host* by_name_or_null(const std::string& name); + /** \static Retrieve a host from its name, or die */ + static Host* by_name(const std::string& name); + /** \static 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_; } + std::string const& get_name() const; /** Retrieves the name of that host as a C string */ - const char* get_cname() const { return name_.c_str(); } + const char* get_cname() const; + + Host* set_cpu(kernel::resource::CpuImpl* cpu); + kernel::resource::CpuImpl* get_cpu() const { return pimpl_cpu_; } + kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; } + /** + * @brief Callback to set CPU factor + * + * This callback offers a flexible way to create variability in CPU executions + * + * @param flops Execution size in flops + * @return Multiply factor + */ + using CpuFactorCb = double(double flops); + /** + * @brief Configure the factor callback to the CPU associated to this host + */ + Host* set_factor_cb(const std::function& cb); - int get_actor_count(); - std::vector get_all_actors(); + size_t get_actor_count() const; + std::vector get_all_actors() const; /** 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; + Host* set_property(const std::string& key, const std::string& value); + const std::unordered_map* get_properties() const; + Host* set_properties(const std::unordered_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 + Host* set_state_profile(kernel::profile::Profile* p); + Host* set_speed_profile(kernel::profile::Profile* p); + /** + * @brief Set the max amount of executions that can take place on this host at the same time + * + * Use -1 to set no limit. + */ + Host* set_concurrency_limit(int limit); + int get_concurrency_limit() const; + + /** \static @brief Convert the CPU's speed from string to double */ + static std::vector convert_pstate_speed_vector(const std::vector& speed_per_state); + /** + * @brief Set the CPU's speed + * + * @param speed_per_state list of powers for this processor (default power is at index 0) + */ + Host* set_pstate_speed(const std::vector& speed_per_state); + /** + * @brief Set the CPU's speed (string version) + * + * @throw std::invalid_argument if speed format is incorrect. + */ + Host* set_pstate_speed(const std::vector& speed_per_state); + + /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account. + * + * The amount of flops per second available for computing depends on several things: + * - The current pstate determines the maximal peak computing speed (use + * @verbatim embed:rst:inline :cpp:func:`get_pstate_speed() ` @endverbatim + * to retrieve the computing speed you would get at another pstate) + * - If you declared an external load (with + * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() ` @endverbatim ), + * you must multiply the result of + * @verbatim embed:rst:inline :cpp:func:`get_speed() ` @endverbatim by + * @verbatim embed:rst:inline :cpp:func:`get_available_speed() ` @endverbatim + * to retrieve what a new computation would get. + * + * The remaining speed is then shared between the executions located on this host. + * You can retrieve the amount of tasks currently running on this host with + * @verbatim embed:rst:inline :cpp:func:`get_load() ` @endverbatim . + * + * The host may have multiple cores, and your executions may be able to use more than a single core. + * + * Finally, executions of priority 2 get twice the amount of flops than executions of priority 1. + */ double get_speed() const; + /** @brief Get the available speed ratio, between 0 and 1. + * + * This accounts for external load (see + * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() ` @endverbatim ). + */ double get_available_speed() const; + + /** Returns the number of core of the processor. */ int get_core_count() const; - double get_load() const; + Host* set_core_count(int core_count); - double get_pstate_speed(int pstate_index) const; - int get_pstate_count() const; - void set_pstate(int pstate_index); - int get_pstate() const; + enum class SharingPolicy { NONLINEAR = 1, LINEAR = 0 }; + /** + * @brief Describes how the CPU is shared between concurrent tasks + * + * Note that the NONLINEAR callback is in the critical path of the solver, so it should be fast. + * + * @param policy Sharing policy + * @param cb Callback for NONLINEAR policies + */ + Host* set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {}); + SharingPolicy get_sharing_policy() 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); - } + /** Returns the current computation load (in flops per second) + * + * The external load (coming from an availability trace) is not taken in account. + * You may also be interested in the load plugin. + */ + double get_load() const; - std::vector get_attached_storages() const; - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages( - std::vector* storages); -#endif + unsigned long get_pstate_count() const; + unsigned long get_pstate() const; + double get_pstate_speed(unsigned long pstate_index) const; + Host* set_pstate(unsigned long pstate_index); + Host* set_coordinates(const std::string& coords); - /** Get an associative list [mount point]->[Storage] of all local mount points. + std::vector get_disks() const; + /** + * @brief Create and add disk in the host * - * This is defined in the platform file, and cannot be modified programatically (yet). + * @param name Disk name + * @param read_bandwidth Reading speed of the disk + * @param write_bandwidth Writing speed of the disk */ - 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 + Disk* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth); + /** + * @brief Human-friendly version of create_disk function. + * + * @throw std::invalid_argument if read/write speeds are incorrect + */ + Disk* create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth); + void add_disk(const Disk* disk); + void remove_disk(const std::string& disk_name); + + VirtualMachine* create_vm(const std::string& name, int core_amount); + VirtualMachine* create_vm(const std::string& name, int core_amount, size_t ramsize); + /** Retrieve a VM running on this host from its name, or return nullptr */ + VirtualMachine* vm_by_name_or_null(const std::string& name); - void route_to(Host* dest, std::vector& links, double* latency); - void route_to(Host* dest, std::vector& links, double* latency); + void route_to(const Host* dest, std::vector& links, double* latency) const; + void route_to(const Host* dest, std::vector& links, double* latency) const; + std::pair, double> route_to(const Host* dest) const; + /** + * @brief Seal this host + * No more configuration is allowed after the seal + */ + Host* seal(); + + NetZone* get_englobing_zone() const; /** 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); + void execute(double flops) const; /** Start an asynchronous computation on that host (possibly remote) */ - ExecPtr exec_async(double flops_amounts); + ExecPtr exec_init(double flops_amounts) const; + ExecPtr exec_async(double flops_amounts) const; /** 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"}; - 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; - // 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 + void execute(double flops, double priority) const; + kernel::resource::HostImpl* get_impl() const { return pimpl_; } }; -} -} // namespace simgrid::s4u - -extern int USER_HOST_LEVEL; +} // namespace s4u +} // namespace simgrid #endif /* SIMGRID_S4U_HOST_HPP */