X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e53e94eb6cb9f8edda78234ec8a0ba7880431d2a..0a6556cf9aa3e733965b6a18574efd63b54caa0d:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index 2f6502c08d..bae7f7396d 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2022. 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. */ @@ -37,32 +37,40 @@ namespace s4u { */ class XBT_PUBLIC Host : public xbt::Extendable { #ifndef DOXYGEN - friend vm::VMModel; // Use the pimpl_cpu to compute the VM sharing - friend vm::VirtualMachineImpl; // creates the the pimpl_cpu + 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 surf::HostImpl; // call destructor from private implementation + friend kernel::resource::HostImpl; // call destructor from private implementation // The private implementation, that never changes - surf::HostImpl* const pimpl_; + kernel::resource::HostImpl* const pimpl_; + + kernel::resource::CpuImpl* pimpl_cpu_ = nullptr; + kernel::routing::NetPoint* pimpl_netpoint_ = nullptr; public: - explicit Host(surf::HostImpl* pimpl) : pimpl_(pimpl) {} + explicit Host(kernel::resource::HostImpl* pimpl) : pimpl_(pimpl) {} protected: virtual ~Host(); // Call destroy() instead of manually deleting it. Host* set_netpoint(kernel::routing::NetPoint* netpoint); -#endif -public: - /** 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) */ + +public: + static xbt::signal on_speed_change; static xbt::signal on_state_change; - /** Called when the speed of the machine is changed (called AFTER the change) +#endif + /** Add a callback fired on each newly created host */ + static void on_creation_cb(const std::function& cb) { on_creation.connect(cb); } + /** Add a callback fired when the machine is turned on or off (called AFTER the change) */ + static void on_state_change_cb(const std::function& cb) { on_state_change.connect(cb); } + /** Add a callback fired 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; + static void on_speed_change_cb(const std::function& cb) { on_speed_change.connect(cb); } + /** Add a callback fired just before destructing a host */ + static void on_destruction_cb(const std::function& cb) { on_destruction.connect(cb); } virtual void destroy(); #ifndef DOXYGEN @@ -79,11 +87,26 @@ public: static Host* current(); /** Retrieves the name of that host as a C++ string */ - xbt::string const& get_name() const; + std::string const& get_name() const; /** Retrieves the name of that host as a C string */ 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); size_t get_actor_count() const; std::vector get_all_actors() const; @@ -129,13 +152,19 @@ public: /** @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 @ref get_pstate_speed() to retrieve the - * computing speed you would get at another pstate) - * - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the - * result of get_speed() by get_available_speed() to retrieve what a new computation would get. + * - 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 @ref get_load(). + * 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. * @@ -144,7 +173,8 @@ public: double get_speed() const; /** @brief Get the available speed ratio, between 0 and 1. * - * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()). + * This accounts for external load (see + * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() ` @endverbatim ). */ double get_available_speed() const; @@ -152,6 +182,18 @@ public: int get_core_count() const; Host* set_core_count(int core_count); + 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; + /** Returns the current computation load (in flops per second) * * The external load (coming from an availability trace) is not taken in account. @@ -159,10 +201,10 @@ public: */ double get_load() const; - int get_pstate_count() const; - int get_pstate() const; - double get_pstate_speed(int pstate_index) const; - Host* set_pstate(int pstate_index); + 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); std::vector get_disks() const; @@ -183,8 +225,13 @@ public: 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(const Host* dest, std::vector& links, double* latency) const; - void route_to(const Host* dest, std::vector& links, double* latency) const; + void route_to(const Host* dest, std::vector& links, double* latency) const; /** * @brief Seal this host @@ -192,14 +239,6 @@ public: */ Host* seal(); -#ifndef DOXYGEN - XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto()") void sendto(Host* dest, double byte_amount); - - XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto_async()") CommPtr sendto_async(Host* dest, double byte_amount); - - XBT_ATTRIB_DEPRECATED_v330("Please use Host::sendto()") void send_to(Host* dest, double byte_amount); -#endif - NetZone* get_englobing_zone() const; /** Block the calling actor on an execution located on the called host * @@ -213,16 +252,7 @@ public: /** Block the calling actor on an execution located on the called host (with explicit priority) */ void execute(double flops, double priority) const; - surf::HostImpl* get_impl() const { return pimpl_; } - -private: - kernel::routing::NetPoint* pimpl_netpoint_ = nullptr; - -public: -#ifndef DOXYGEN - /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */ - kernel::resource::CpuImpl* pimpl_cpu = nullptr; -#endif + kernel::resource::HostImpl* get_impl() const { return pimpl_; } }; } // namespace s4u } // namespace simgrid