Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cosmetics around deprecated functions.
[simgrid.git] / src / s4u / s4u_Host.cpp
index fa9d46c..c06d170 100644 (file)
@@ -1,16 +1,19 @@
-/* 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. */
 
+#include "simgrid/Exception.hpp"
 #include "simgrid/host.h"
 #include "simgrid/kernel/routing/NetPoint.hpp"
 #include "simgrid/s4u/Actor.hpp"
+#include "simgrid/s4u/Comm.hpp"
 #include "simgrid/s4u/Engine.hpp"
 #include "simgrid/s4u/Exec.hpp"
 #include "simgrid/s4u/VirtualMachine.hpp"
 #include "src/plugins/vm/VirtualMachineImpl.hpp"
 #include "src/surf/HostImpl.hpp"
+#include "xbt/parse_units.hpp"
 
 #include <algorithm>
 #include <string>
@@ -29,23 +32,26 @@ xbt::signal<void(Host const&)> Host::on_destruction;
 xbt::signal<void(Host const&)> Host::on_state_change;
 xbt::signal<void(Host const&)> Host::on_speed_change;
 
-Host::Host(const std::string& name) : name_(name)
+Host* Host::set_cpu(kernel::resource::CpuImpl* cpu)
 {
-  xbt_assert(Host::by_name_or_null(name_) == nullptr, "Refusing to create a second host named '%s'.", get_cname());
-  Engine::get_instance()->host_register(name_, this);
-  new surf::HostImpl(this);
+  pimpl_cpu_ = cpu;
+  return this;
 }
 
-Host::~Host()
+#ifndef DOXYGEN
+Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
 {
-  xbt_assert(currently_destroying_, "Please call h->destroy() instead of manually deleting it.");
+  pimpl_netpoint_ = netpoint;
+  return this;
+}
 
-  delete pimpl_;
+Host::~Host()
+{
   if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
     Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
-  delete pimpl_cpu;
-  delete mounts_;
+  delete pimpl_cpu_;
 }
+#endif
 
 /** @brief Fire the required callbacks and destroy the object
  *
@@ -56,12 +62,7 @@ Host::~Host()
  */
 void Host::destroy()
 {
-  if (not currently_destroying_) {
-    currently_destroying_ = true;
-    on_destruction(*this);
-    Engine::get_instance()->host_unregister(std::string(name_));
-    delete this;
-  }
+  kernel::actor::simcall([this] { this->pimpl_->destroy(); });
 }
 
 Host* Host::by_name(const std::string& name)
@@ -76,16 +77,25 @@ Host* Host::by_name_or_null(const std::string& name)
 Host* Host::current()
 {
   kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
-  if (self == nullptr)
-    xbt_die("Cannot call Host::current() from the maestro context");
+  xbt_assert(self != nullptr, "Cannot call Host::current() from the maestro context");
   return self->get_host();
 }
 
+xbt::string const& Host::get_name() const
+{
+  return this->pimpl_->get_name();
+}
+
+const char* Host::get_cname() const
+{
+  return this->pimpl_->get_cname();
+}
+
 void Host::turn_on()
 {
   if (not is_on()) {
     kernel::actor::simcall([this] {
-      this->pimpl_cpu->turn_on();
+      this->pimpl_cpu_->turn_on();
       this->pimpl_->turn_on();
       on_state_change(*this);
     });
@@ -96,14 +106,14 @@ void Host::turn_on()
 void Host::turn_off()
 {
   if (is_on()) {
-    kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
+    const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
     kernel::actor::simcall([this, self] {
       for (VirtualMachine* const& vm : vm::VirtualMachineImpl::allVms_)
         if (vm->get_pm() == this) {
           vm->shutdown();
           vm->turn_off();
         }
-      this->pimpl_cpu->turn_off();
+      this->pimpl_cpu_->turn_off();
       this->pimpl_->turn_off(self);
 
       on_state_change(*this);
@@ -113,12 +123,12 @@ void Host::turn_off()
 
 bool Host::is_on() const
 {
-  return this->pimpl_cpu->is_on();
+  return this->pimpl_cpu_->is_on();
 }
 
 int Host::get_pstate_count() const
 {
-  return this->pimpl_cpu->get_pstate_count();
+  return this->pimpl_cpu_->get_pstate_count();
 }
 
 /**
@@ -132,7 +142,7 @@ std::vector<ActorPtr> Host::get_all_actors() const
 }
 
 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
-int Host::get_actor_count() const
+size_t Host::get_actor_count() const
 {
   return pimpl_->get_actor_count();
 }
@@ -170,23 +180,27 @@ void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>&
 }
 
 /** @brief Returns the networking zone englobing that host */
-NetZone* Host::get_englobing_zone()
+NetZone* Host::get_englobing_zone() const
 {
   return pimpl_netpoint_->get_englobing_zone()->get_iface();
 }
 
-void Host::sendto(Host* dest, double byte_amount)
+#ifndef DOXYGEN
+void Host::sendto(Host* dest, double byte_amount) // XBT_ATTRIB_DEPRECATED_v331
+{
+  Comm::sendto_async(this, dest, byte_amount)->wait();
+}
+
+CommPtr Host::sendto_async(Host* dest, double byte_amount) // XBT_ATTRIB_DEPRECATED_v331
 {
-  sendto_async(dest, byte_amount)->wait();
+  return Comm::sendto_async(this, dest, byte_amount);
 }
 
-ActivityPtr Host::sendto_async(Host* dest, double byte_amount)
+void Host::send_to(Host* dest, double byte_amount) // XBT_ATTRIB_DEPRECATED_v330
 {
-  std::vector<Host*> m_host_list   = {this, dest};
-  std::vector<double> flops_amount = {0, 0};
-  std::vector<double> bytes_amount = {0, byte_amount, 0, 0};
-  return this_actor::exec_init(m_host_list, flops_amount, bytes_amount)->start();
+  Comm::sendto(this, dest, byte_amount);
 }
+#endif
 
 /** Get the properties assigned to a host */
 const std::unordered_map<std::string, std::string>* Host::get_properties() const
@@ -200,21 +214,24 @@ const char* Host::get_property(const std::string& key) const
   return this->pimpl_->get_property(key);
 }
 
-void Host::set_property(const std::string& key, const std::string& value)
+Host* Host::set_property(const std::string& key, const std::string& value)
 {
   kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
+  return this;
 }
 
-void Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
+Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
 {
   kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
+  return this;
 }
 
 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
  * The profile must contain boolean values. */
-void Host::set_state_profile(kernel::profile::Profile* p)
+Host* Host::set_state_profile(kernel::profile::Profile* p)
 {
-  return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
+  kernel::actor::simcall([this, p] { pimpl_cpu_->set_state_profile(p); });
+  return this;
 }
 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
  *
@@ -222,52 +239,122 @@ void Host::set_state_profile(kernel::profile::Profile* p)
  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
  * at this pstate level) by the rate coming from the profile.
  */
-void Host::set_speed_profile(kernel::profile::Profile* p)
+Host* Host::set_speed_profile(kernel::profile::Profile* p)
 {
-  return kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
+  kernel::actor::simcall([this, p] { pimpl_cpu_->set_speed_profile(p); });
+  return this;
 }
 
 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
 double Host::get_pstate_speed(int pstate_index) const
 {
-  return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
+  return this->pimpl_cpu_->get_pstate_peak_speed(pstate_index);
 }
 
 double Host::get_speed() const
 {
-  return this->pimpl_cpu->get_speed(1.0);
+  return this->pimpl_cpu_->get_speed(1.0);
 }
 double Host::get_load() const
 {
-  return this->pimpl_cpu->get_load();
+  return this->pimpl_cpu_->get_load();
 }
 double Host::get_available_speed() const
 {
-  return this->pimpl_cpu->get_speed_ratio();
+  return this->pimpl_cpu_->get_speed_ratio();
 }
 
 int Host::get_core_count() const
 {
-  return this->pimpl_cpu->get_core_count();
+  return this->pimpl_cpu_->get_core_count();
+}
+
+Host* Host::set_core_count(int core_count)
+{
+  kernel::actor::simcall([this, core_count] { this->pimpl_cpu_->set_core_count(core_count); });
+  return this;
+}
+
+Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
+{
+  kernel::actor::simcall([this, &speed_per_state] { pimpl_cpu_->set_pstate_speed(speed_per_state); });
+  return this;
+}
+
+std::vector<double> Host::convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state)
+{
+  std::vector<double> speed_list;
+  speed_list.reserve(speed_per_state.size());
+  for (const auto& speed_str : speed_per_state) {
+    try {
+      double speed = xbt_parse_get_speed("", 0, speed_str, "");
+      speed_list.push_back(speed);
+    } catch (const simgrid::ParseError&) {
+      throw std::invalid_argument(std::string("Invalid speed value: ") + speed_str);
+    }
+  }
+  return speed_list;
+}
+
+Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
+{
+  set_pstate_speed(Host::convert_pstate_speed_vector(speed_per_state));
+  return this;
 }
 
 /** @brief Set the pstate at which the host should run */
-void Host::set_pstate(int pstate_index)
+Host* Host::set_pstate(int pstate_index)
 {
-  kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
+  kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu_->set_pstate(pstate_index); });
+  return this;
 }
+
 /** @brief Retrieve the pstate at which the host is currently running */
 int Host::get_pstate() const
 {
-  return this->pimpl_cpu->get_pstate();
+  return this->pimpl_cpu_->get_pstate();
 }
 
+Host* Host::set_coordinates(const std::string& coords)
+{
+  if (not coords.empty())
+    kernel::actor::simcall([this, coords] { this->pimpl_netpoint_->set_coordinates(coords); });
+  return this;
+}
 std::vector<Disk*> Host::get_disks() const
 {
-  return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
+  return this->pimpl_->get_disks();
+}
+
+Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
+{
+  return kernel::actor::simcall([this, &name, read_bandwidth, write_bandwidth] {
+    auto* disk = pimpl_->create_disk(name, read_bandwidth, write_bandwidth);
+    pimpl_->add_disk(disk);
+    return disk;
+  });
 }
 
-void Host::add_disk(Disk* disk)
+Disk* Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
+{
+  double d_read;
+  try {
+    d_read = xbt_parse_get_bandwidth("", 0, read_bandwidth, "");
+  } catch (const simgrid::ParseError&) {
+    throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
+                                std::string(". Invalid read bandwidth: ") + read_bandwidth);
+  }
+  double d_write;
+  try {
+    d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth, "");
+  } catch (const simgrid::ParseError&) {
+    throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
+                                std::string(". Invalid write bandwidth: ") + write_bandwidth);
+  }
+  return create_disk(name, d_read, d_write);
+}
+
+void Host::add_disk(const Disk* disk)
 {
   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
 }
@@ -276,28 +363,15 @@ void Host::remove_disk(const std::string& disk_name)
 {
   kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
 }
-/**
- * @ingroup simix_storage_management
- * @brief Returns the list of storages attached to a host.
- * @return a vector containing all storages attached to the host
- */
-std::vector<const char*> Host::get_attached_storages() const
-{
-  return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
-}
 
-std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
+ExecPtr Host::exec_init(double flops) const
 {
-  kernel::actor::simcall([this] {
-    if (mounts_ == nullptr)
-      mounts_ = pimpl_->get_mounted_storages();
-  });
-  return *mounts_;
+  return this_actor::exec_init(flops);
 }
 
 ExecPtr Host::exec_async(double flops) const
 {
-  return this_actor::exec_init(flops);
+  return this_actor::exec_async(flops);
 }
 
 void Host::execute(double flops) const
@@ -307,7 +381,14 @@ void Host::execute(double flops) const
 
 void Host::execute(double flops, double priority) const
 {
-  this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
+  this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
+}
+
+Host* Host::seal()
+{
+  kernel::actor::simcall([this]() { this->pimpl_->seal(); });
+  simgrid::s4u::Host::on_creation(*this); // notify the signal
+  return this;
 }
 
 } // namespace s4u
@@ -321,12 +402,13 @@ size_t sg_host_count()
 sg_host_t* sg_host_list()
 {
   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
-  size_t host_count       = e->get_host_count();
+  size_t host_count             = e->get_host_count();
+
   xbt_assert(host_count > 0, "There is no host!");
   std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
 
-  sg_host_t* res = xbt_new(sg_host_t, hosts.size());
-  memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
+  auto* res = xbt_new(sg_host_t, hosts.size());
+  std::copy(begin(hosts), end(hosts), res);
 
   return res;
 }
@@ -385,49 +467,14 @@ void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v
 {
   sg_host_set_data(host, userdata);
 }
-void* sg_host_user(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
-{
-  return host->get_data();
-}
-void sg_host_user_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v328
-{
-  host->set_data(userdata);
-}
-void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
-{
-  host->set_data(nullptr);
-}
 
-// ========= storage related functions ============
+// ========= Disk related functions ============
 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
 {
   std::vector<sg_disk_t> list = host->get_disks();
   *disk_count                 = list.size();
-  *disks                      = static_cast<sg_disk_t*>(xbt_malloc(sizeof(sg_disk_t) * (*disk_count)));
-  for (size_t i = 0; i < *disk_count; i++)
-    (*disks)[i] = list[i];
-}
-
-xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
-{
-  xbt_assert((host != nullptr), "Invalid parameters");
-  xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
-  for (auto const& elm : host->get_mounted_storages()) {
-    const char* mount_name = elm.first.c_str();
-    const simgrid::s4u::Storage* storage = elm.second;
-    xbt_dict_set(res, mount_name, (void*)storage->get_cname());
-  }
-
-  return res;
-}
-
-xbt_dynar_t sg_host_get_attached_storage_list(const_sg_host_t host)
-{
-  xbt_dynar_t storage_dynar               = xbt_dynar_new(sizeof(const char*), nullptr);
-  std::vector<const char*> storage_vector = host->get_attached_storages();
-  for (auto const& name : storage_vector)
-    xbt_dynar_push(storage_dynar, &name);
-  return storage_dynar;
+  *disks                      = xbt_new(sg_disk_t, list.size());
+  std::copy(begin(list), end(list), *disks);
 }
 
 // =========== user-level functions ===============
@@ -443,7 +490,7 @@ double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
   return sg_host_get_speed(host);
 }
 
-/** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
+/** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_host_energy.
  *
  * @param  host host to test
  * @param pstate_index pstate to test
@@ -472,7 +519,7 @@ double sg_host_get_available_speed(const_sg_host_t host)
 
 /** @brief Returns the number of power states for a host.
  *
- *  See also @ref plugin_energy.
+ *  See also @ref plugin_host_energy.
  */
 int sg_host_get_nb_pstates(const_sg_host_t host)
 {
@@ -481,7 +528,7 @@ int sg_host_get_nb_pstates(const_sg_host_t host)
 
 /** @brief Gets the pstate at which that host currently runs.
  *
- *  See also @ref plugin_energy.
+ *  See also @ref plugin_host_energy.
  */
 int sg_host_get_pstate(const_sg_host_t host)
 {
@@ -489,7 +536,7 @@ int sg_host_get_pstate(const_sg_host_t host)
 }
 /** @brief Sets the pstate at which that host should run.
  *
- *  See also @ref plugin_energy.
+ *  See also @ref plugin_host_energy.
  */
 void sg_host_set_pstate(sg_host_t host, int pstate)
 {
@@ -500,7 +547,7 @@ void sg_host_set_pstate(sg_host_t host, int pstate)
  *
  * @brief Start the host if it is off
  *
- * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
+ * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
  * for more info on DVFS.
  */
 void sg_host_turn_on(sg_host_t host)
@@ -512,7 +559,7 @@ void sg_host_turn_on(sg_host_t host)
  *
  * @brief Stop the host if it is on
  *
- * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
+ * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_host_energy
  * for more info on DVFS.
  */
 void sg_host_turn_off(sg_host_t host)
@@ -523,8 +570,8 @@ void sg_host_turn_off(sg_host_t host)
 /** @ingroup m_host_management
  * @brief Determine if a host is up and running.
  *
- * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
- * info on DVFS.
+ * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_host_energy for
+ * more info on DVFS.
  *
  * @param host host to test
  * @return Returns true if the host is up and running, and false if it's currently down
@@ -537,8 +584,9 @@ int sg_host_is_on(const_sg_host_t host)
 /** @brief Get the properties of a host */
 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
 {
-  xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
   const std::unordered_map<std::string, std::string>* props = host->get_properties();
+  xbt_dict_t as_dict                                        = xbt_dict_new_homogeneous(xbt_free_f);
+
   if (props == nullptr)
     return nullptr;
   for (auto const& elm : *props) {
@@ -628,7 +676,7 @@ double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_
 
 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
 {
-  from->sendto(to, byte_amount);
+  simgrid::s4u::Comm::sendto(from, to, byte_amount);
 }
 
 /** @brief Displays debugging information about a host */