X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2c35f563c1eb2624079c12f7ab27453e809ff599..39c935d6d5ee86d153f6f7e6a10d723ae7c57f6f:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index e28a95bebf..c6691d751a 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-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,9 +16,7 @@ namespace simgrid { -namespace xbt { -extern template class XBT_PUBLIC Extendable; -} // namespace xbt +extern template class XBT_PUBLIC xbt::Extendable; namespace s4u { /** @ingroup s4u_api @@ -27,43 +25,50 @@ namespace s4u { * * 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 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(const std::string& name); - /** Host destruction logic */ protected: virtual ~Host(); + void set_netpoint(kernel::routing::NetPoint* netpoint) { pimpl_netpoint_ = netpoint; } private: bool currently_destroying_ = false; +#endif public: - /*** Called on each newly created host */ + /** Called on each newly created host */ static xbt::signal on_creation; - /*** Called just before destructing a host */ + /** Called just before destructing a host */ static xbt::signal on_destruction; - /*** Called when the machine is turned on or off (called AFTER the change) */ + /** 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) + /** 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); @@ -77,8 +82,10 @@ public: /** 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 * @@ -94,20 +101,43 @@ public: 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 */ - 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); const std::unordered_map* get_properties() const; - void set_properties(const std::map& properties); + 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; @@ -116,18 +146,41 @@ public: int get_pstate() const; 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; /** 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(); - void route_to(Host* dest, std::vector& links, double* latency); - void route_to(Host* dest, std::vector& links, double* latency); - void send_to(Host* dest, double byte_amount); + 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) + { + sendto(dest, byte_amount); + } +#endif NetZone* get_englobing_zone(); /** Block the calling actor on an execution located on the called host @@ -135,16 +188,17 @@ public: * 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_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); + void execute(double flops, double priority) const; private: xbt::string name_{"noname"}; std::unordered_map* mounts_ = nullptr; // caching + kernel::routing::NetPoint* pimpl_netpoint_ = nullptr; public: #ifndef DOXYGEN @@ -152,13 +206,9 @@ public: 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 s4u } // namespace simgrid -extern int USER_HOST_LEVEL; - #endif /* SIMGRID_S4U_HOST_HPP */