X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3f20736620afa2ecf5ef7bbda4e3a55bcd9a1cd3..39c935d6d5ee86d153f6f7e6a10d723ae7c57f6f:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index f8933b275f..c6691d751a 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-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. */ @@ -16,97 +16,128 @@ 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 */ -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 vm::VMModel; // Use the pimpl_cpu to compute the VM sharing + friend vm::VirtualMachineImpl; // creates the the pimpl_cpu + friend kernel::routing::NetZoneImpl; public: - explicit Host(std::string name); + explicit Host(const std::string& name); - /** Host destruction logic */ protected: virtual ~Host(); + void set_netpoint(kernel::routing::NetPoint* netpoint) { pimpl_netpoint_ = netpoint; } private: - bool currentlyDestroying_ = false; + bool currently_destroying_ = false; +#endif 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(); +#ifndef DOXYGEN // No copy/move Host(Host const&) = delete; Host& operator=(Host const&) = delete; +#endif - /** 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(); /** 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(); } - int get_actor_count(); - std::vector get_all_actors(); + kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; } + + int 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(); - 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; - } + 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::unordered_map& properties); + void set_state_profile(kernel::profile::Profile* p); + void set_speed_profile(kernel::profile::Profile* p); + + /** @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 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 simgrid::surf::Cpu::set_speed_profile()). + */ double get_available_speed() const; + /** Returns the number of core of the processor. */ int get_core_count() const; + /** 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; double get_pstate_speed(int pstate_index) const; @@ -114,93 +145,70 @@ public: void set_pstate(int pstate_index); int get_pstate() const; - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_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(const 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); /** 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). + * This is defined in the platform file, and cannot be modified programmatically (yet). */ std::unordered_map const& get_mounted_storages(); - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map const& getMountedStorages() + + void route_to(const Host* dest, std::vector& links, double* latency) const; + void route_to(const Host* dest, std::vector& links, double* latency) const; + /** Do a blocking communication between two arbitrary hosts. + * + * This starts a blocking communication right away, bypassing the mailbox and actors mechanism. + * The calling actor is blocked until the end of the communication; there is really no limit on the hosts involved. + * In particular, the actor does not have to be on one of the involved hosts. Enjoy the comfort of the simulator :) + */ + void sendto(Host* dest, double byte_amount); + + /** Do an asynchronous communication between two arbitrary hosts. + * + * This initializes a communication that completely bypass the mailbox and actors mechanism. + * There is really no limit on the hosts involved. In particular, the actor does not have to be on one of the involved + * hosts. + */ + ActivityPtr sendto_async(Host* dest, double byte_amount); + +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v330("Please use Host::sendto()") void send_to(Host* dest, double byte_amount) { - return get_mounted_storages(); + sendto(dest, byte_amount); } +#endif - void route_to(Host* dest, std::vector& links, double* latency); - void route_to(Host* dest, std::vector& links, double* latency); - + 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. * The actor will not be migrated in this case. Such remote execution are easy in simulation. */ - void execute(double flops); - /** Block the calling actor on an execution located on the called host (with explicit priority) */ - void execute(double flops, double priority); + void execute(double flops) const; + /** Start an asynchronous computation on that host (possibly remote) */ + ExecPtr exec_async(double flops_amounts) const; - // Deprecated functions - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const - { - return name_; - } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector* whereto); - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector* list); - XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); } - - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key) - { - return get_property(key); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value) - { - set_property(key, value); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); } - - XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector& links, - double* latency) - { - route_to(dest, links, latency); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo( - Host* dest, std::vector& links, double* latency) - { - route_to(dest, links, latency); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const - { - return get_pstate_count(); - } + /** Block the calling actor on an execution located on the called host (with explicit priority) */ + void execute(double flops, double priority) const; private: - simgrid::xbt::string name_ {"noname"}; + xbt::string name_{"noname"}; std::unordered_map* mounts_ = nullptr; // caching + kernel::routing::NetPoint* pimpl_netpoint_ = nullptr; 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 */