X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7ef49c428ab0209965a09a36ab28b59789aaa4b5..36fccba5f4f2b4c32e97c4e56911eb5bd804f7c9:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index d43c985fcf..c39588fda3 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2021. 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,219 @@ #ifndef SIMGRID_S4U_HOST_HPP #define SIMGRID_S4U_HOST_HPP -#include -#include - -#include "xbt/Extendable.hpp" -#include "xbt/dict.h" -#include "xbt/signal.hpp" -#include "xbt/string.hpp" -#include "xbt/swag.h" +#include +#include +#include +#include -#include "simgrid/forward.h" -#include "simgrid/s4u/forward.hpp" +#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 * - * An host represents some physical resource with computing and networking capabilities. + * 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::loadPlatform(). + * :cpp:func:`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 :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 */ -XBT_PUBLIC_CLASS Host : public simgrid::xbt::Extendable -{ +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::routing::NetZoneImpl; + friend surf::HostImpl; // call destructor from private implementation + + // The private implementation, that never changes + surf::HostImpl* const pimpl_; + + kernel::resource::CpuImpl* pimpl_cpu_ = nullptr; + kernel::routing::NetPoint* pimpl_netpoint_ = nullptr; public: - explicit Host(const char* name); + explicit Host(surf::HostImpl* pimpl) : pimpl_(pimpl) {} - /** Host destruction logic */ protected: - virtual ~Host(); - -private: - bool currentlyDestroying_ = false; + virtual ~Host(); // Call destroy() instead of manually deleting it. + Host* set_netpoint(kernel::routing::NetPoint* netpoint); +#endif 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(); +#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(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 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(); + /** Retrieves the name of that host as a C++ string */ + xbt::string const& get_name() const; + /** Retrieves the name of that host as a C string */ + const char* get_cname() const; - simgrid::xbt::string const& getName() const { return name_; } - const char* getCname() { return name_.c_str(); } + 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_; } - void actorList(std::vector * whereto); + 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 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(); - /** Returns if that host is currently down and offline */ - bool isOff() { return not isOn(); } - - double getSpeed(); - int getCoreCount(); - xbt_dict_t getProperties(); - const char* getProperty(const char* key); - void setProperty(const char* key, const char* 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); - - /** 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(); + bool is_on() const; - void routeTo(Host * dest, std::vector * links, double* latency); - void routeTo(Host * dest, std::vector * links, double* latency); + 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); -private: - simgrid::xbt::string name_ = "noname"; - std::unordered_map* mounts = nullptr; // caching + Host* set_state_profile(kernel::profile::Profile* p); + Host* set_speed_profile(kernel::profile::Profile* p); -public: - // 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) */ - surf::Cpu* pimpl_cpu = 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; -}; -} -} // namespace simgrid::s4u + /** @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); -extern int USER_HOST_LEVEL; + /** @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 set_speed_profile()), you must multiply the + * result of get_speed() by get_available_speed() 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(). + * + * 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 @ref set_speed_profile()). + */ + double get_available_speed() const; -#endif /* SIMGRID_S4U_HOST_HPP */ + /** Returns the number of core of the processor. */ + int get_core_count() const; + Host* set_core_count(int core_count); -#if 0 + /** 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; -public class Host { + int get_pstate_count() const; + int get_pstate() const; + double get_pstate_speed(int pstate_index) const; + Host* set_pstate(int pstate_index); + Host* set_coordinates(const std::string& coords); + std::vector get_disks() const; /** - * 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. + * @brief Create and add disk in the host * - * @return The number of tasks currently running on a host. + * @param name Disk name + * @param read_bandwidth Reading speed of the disk + * @param write_bandwidth Writing speed of the disk */ - public native int getLoad(); + 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); + + 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 + * No more configuration is allowed after the seal + */ + 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 + * + * 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) const; + /** Start an asynchronous computation on that host (possibly remote) */ + 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) const; + surf::HostImpl* get_impl() const { return pimpl_; } +}; +} // namespace s4u +} // namespace simgrid + +#endif /* SIMGRID_S4U_HOST_HPP */