X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/149c63f36e15b8500b1e826bda5138318ff7ba2b..4c34ab4cc0212a08411fd0fa4ef9d452db66d3f3:/include/simgrid/s4u/Host.hpp diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index 4870a86239..f4a11749f7 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2020. 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. */ @@ -36,6 +36,7 @@ namespace s4u { * @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; @@ -43,13 +44,10 @@ class XBT_PUBLIC Host : public xbt::Extendable { 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; + virtual ~Host(); // Call destroy() instead of manually deleting it. + Host* set_netpoint(kernel::routing::NetPoint* netpoint); +#endif public: /** Called on each newly created host */ @@ -63,9 +61,11 @@ public: 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); @@ -100,38 +100,66 @@ public: bool is_on() const; const char* get_property(const std::string& key) const; - void set_property(const std::string& key, const std::string& value); + Host* set_property(const std::string& key, const std::string& value); const std::unordered_map* get_properties() const; - void set_properties(const std::map& properties); + Host* set_properties(const std::unordered_map& properties); - void set_state_profile(kernel::profile::Profile* p); - void set_speed_profile(kernel::profile::Profile* p); + Host* set_state_profile(kernel::profile::Profile* p); + Host* 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; + Host* set_core_count(int core_count); + + /** 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; int get_pstate_count() const; - void set_pstate(int pstate_index); int get_pstate() const; + double get_pstate_speed(int pstate_index) const; + Host* set_pstate(int pstate_index); std::vector get_disks() const; - void add_disk(Disk* disk); + Disk* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth); + 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 programmatically (yet). - */ - std::unordered_map const& get_mounted_storages(); - 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 send_to(Host* dest, double byte_amount); + +#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(); /** Block the calling actor on an execution located on the called host @@ -139,16 +167,16 @@ 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_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); + 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: