-/* 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. */
namespace simgrid {
-namespace xbt {
-extern template class XBT_PUBLIC Extendable<simgrid::s4u::Host>;
-}
-namespace s4u {
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Host>;
+namespace s4u {
/** @ingroup s4u_api
*
* @tableofcontents
*
* 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 simgrid::xbt::Extendable<Host> {
- 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<Host> {
+#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_;
public:
- explicit Host(std::string 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:
- /*** Called on each newly created host */
- static simgrid::xbt::signal<void(Host&)> on_creation;
- /*** Called just before destructing a host */
- static simgrid::xbt::signal<void(Host&)> on_destruction;
- /*** Called when the machine is turned on or off (called AFTER the change) */
- static simgrid::xbt::signal<void(Host&)> 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<void(Host&)> on_creation;
+ /** Called just before destructing a host */
+ static xbt::signal<void(Host const&)> on_destruction;
+ /** Called when the machine is turned on or off (called AFTER the change) */
+ static xbt::signal<void(Host const&)> 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<void(Host&)> on_speed_change;
+ static xbt::signal<void(Host const&)> 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(std::string name);
+ static Host* by_name_or_null(const std::string& name);
/** Retrieve a host from its name, or die */
- static s4u::Host* by_name(std::string name);
+ static Host* by_name(const std::string& name);
/** Retrieves the host on which the running actor is located */
- static s4u::Host* current();
+ 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;
/** Retrieves the name of that host as a C string */
- const char* get_cname() const { return name_.c_str(); }
+ const char* get_cname() const;
- int get_actor_count();
- std::vector<ActorPtr> get_all_actors();
+ kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; }
+
+ size_t get_actor_count() const;
+ std::vector<ActorPtr> get_all_actors() const;
/** Turns that host on if it was previously off
*
- * 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).
+ * 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.
+ * 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<std::string, std::string>* get_properties();
+ const char* get_property(const std::string& key) const;
+ Host* set_property(const std::string& key, const std::string& value);
+ const std::unordered_map<std::string, std::string>* get_properties() const;
+ Host* set_properties(const std::unordered_map<std::string, std::string>& 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);
-#ifndef DOXYGEN
- /** @deprecated See Host::get_properties() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
- {
- std::map<std::string, std::string>* res = new std::map<std::string, std::string>();
- std::unordered_map<std::string, std::string>* props = get_properties();
- for (auto const& kv : *props)
- res->insert(kv);
- return res;
- }
-#endif
+ /** @brief Convert the CPU's speed from string to double */
+ static std::vector<double> convert_pstate_speed_vector(const std::vector<std::string>& 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<double>& 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<std::string>& speed_per_state);
+ /** @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);
+ Host* set_coordinates(const std::string& coords);
-#ifndef DOXYGEN
- /** @deprecated See Host::get_speed() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
- /** @deprecated See Host::get_pstate_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<const char*> get_attached_storages() const;
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
- std::vector<const char*>* storages);
-#endif
-
- /** Get an associative list [mount point]->[Storage] of all local mount points.
+ std::vector<Disk*> get_disks() const;
+ /**
+ * @brief Create and add disk in the host
+ *
+ * @param name Disk name
+ * @param read_bandwidth Reading speed of the disk
+ * @param write_bandwidth Writing speed of the disk
+ */
+ Disk* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth);
+ /**
+ * @brief Human-friendly version of create_disk function.
*
- * This is defined in the platform file, and cannot be modified programatically (yet).
+ * @throw std::invalid_argument if read/write speeds are incorrect
*/
- std::unordered_map<std::string, Storage*> const& get_mounted_storages();
+ 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<Link*>& links, double* latency) const;
+ void route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const;
+
+ /**
+ * @brief Seal this host
+ * No more configuration is allowed after the seal
+ */
+ Host* seal();
+
#ifndef DOXYGEN
- /** @deprecated See Host::get_mounted_storages() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
- {
- return get_mounted_storages();
- }
-#endif
+ XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto()") void sendto(Host* dest, double byte_amount);
- void route_to(Host* dest, std::vector<Link*>& links, double* latency);
- void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
+ 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);
+ 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);
-
- // Deprecated functions
-#ifndef DOXYGEN
- /** @deprecated See Host::get_name() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
- {
- return name_;
- }
- /** @deprecated See Host::get_cname() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
- /** @deprecated See Host::get_all_actors() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector<ActorPtr>* whereto);
- /** @deprecated See Host::get_all_actors() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector<ActorPtr>* list);
- /** @deprecated See Host::turn_on() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); }
- /** @deprecated See Host::turn_off() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); }
- /** @deprecated See Host::is_on() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
- /** @deprecated See Host::is_off() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); }
- /** @deprecated See Host::get_property() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
- {
- return get_property(key);
- }
- /** @deprecated See Host::set_property() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
- {
- set_property(key, value);
- }
- /** @deprecated See Host::set_pstate() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); }
- /** @deprecated See Host::get_pstate() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); }
- /** @deprecated See Host::route_to() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
- double* latency)
- {
- route_to(dest, links, latency);
- }
- /** @deprecated See Host::route_to() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(
- Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
- {
- route_to(dest, links, latency);
- }
- /** @deprecated See Host::get_core_count() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); }
- /** @deprecated See Host::get_pstate_count() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
- {
- return get_pstate_count();
- }
-#endif /* !DOXYGEN */
+ void execute(double flops, double priority) const;
+ surf::HostImpl* get_impl() const { return pimpl_; }
private:
- simgrid::xbt::string name_ {"noname"};
- std::unordered_map<std::string, Storage*>* 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;
- // 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;
+ kernel::resource::CpuImpl* pimpl_cpu = nullptr;
#endif
};
-}
-} // namespace simgrid::s4u
-
-extern int USER_HOST_LEVEL;
+} // namespace s4u
+} // namespace simgrid
#endif /* SIMGRID_S4U_HOST_HPP */