Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
NetZone: father to parent and more accessors
[simgrid.git] / src / s4u / s4u_Host.cpp
index 04d1f58..47feede 100644 (file)
@@ -1,10 +1,12 @@
-/* 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/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"
@@ -35,15 +37,18 @@ Host::Host(const std::string& name) : name_(name)
   new surf::HostImpl(this);
 }
 
-Host::~Host()
+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;
+}
 
+Host::~Host()
+{
   delete pimpl_;
   if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
     Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
   delete pimpl_cpu;
-  delete mounts_;
 }
 
 /** @brief Fire the required callbacks and destroy the object
@@ -55,12 +60,9 @@ 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;
-  }
+  on_destruction(*this);
+  Engine::get_instance()->host_unregister(std::string(name_));
+  delete this;
 }
 
 Host* Host::by_name(const std::string& name)
@@ -95,7 +97,7 @@ 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) {
@@ -152,7 +154,7 @@ void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency
 {
   std::vector<kernel::resource::LinkImpl*> linkImpls;
   this->route_to(dest, linkImpls, latency);
-  for (kernel::resource::LinkImpl* const& l : linkImpls)
+  for (auto* l : linkImpls)
     links.push_back(l->get_iface());
 }
 
@@ -163,7 +165,7 @@ void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>&
   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
                (latency == nullptr ? -1 : *latency));
-    for (auto const& link : links)
+    for (auto const* link : links)
       XBT_CDEBUG(surf_route, "  Link '%s'", link->get_cname());
   }
 }
@@ -174,17 +176,19 @@ NetZone* Host::get_englobing_zone()
   return pimpl_netpoint_->get_englobing_zone()->get_iface();
 }
 
-void Host::sendto(Host* dest, double byte_amount)
+void Host::sendto(Host* dest, double byte_amount) // deprecated 331
 {
-  sendto_async(dest, byte_amount)->wait();
+  Comm::sendto_async(this, dest, byte_amount)->wait();
 }
 
-ActivityPtr Host::sendto_async(Host* dest, double byte_amount)
+CommPtr Host::sendto_async(Host* dest, double byte_amount) // deprecated 331
 {
-  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();
+  return Comm::sendto_async(this, dest, byte_amount);
+}
+
+void Host::send_to(Host* dest, double byte_amount) // deprecated 330
+{
+  Comm::sendto(this, dest, byte_amount);
 }
 
 /** Get the properties assigned to a host */
@@ -199,23 +203,25 @@ 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 a exhaustive list or a stochastic law.
+/** 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)
 {
   return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
 }
-/** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
+/** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
  *
  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
@@ -250,6 +256,12 @@ int Host::get_core_count() const
   return this->pimpl_cpu->get_core_count();
 }
 
+Host* Host::set_core_count(int core_count)
+{
+  this->pimpl_cpu->set_core_count(core_count);
+  return this;
+}
+
 /** @brief Set the pstate at which the host should run */
 void Host::set_pstate(int pstate_index)
 {
@@ -266,7 +278,14 @@ std::vector<Disk*> Host::get_disks() const
   return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
 }
 
-void Host::add_disk(Disk* disk)
+Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
+{
+  auto disk =
+      this->get_netpoint()->get_englobing_zone()->get_disk_model()->create_disk(name, read_bandwidth, write_bandwidth);
+  return disk->set_host(this)->get_iface();
+}
+
+void Host::add_disk(const Disk* disk)
 {
   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
 }
@@ -275,28 +294,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
@@ -306,7 +312,7 @@ 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();
 }
 
 } // namespace s4u
@@ -320,12 +326,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());
+  std::copy(begin(hosts), end(hosts), res);
 
   return res;
 }
@@ -368,67 +375,57 @@ xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
 // ========= Layering madness ==============*
 
 // ========== User data Layer ==========
-void* sg_host_data(const_sg_host_t host)
+void* sg_host_get_data(const_sg_host_t host)
 {
   return host->get_data();
 }
-void sg_host_data_set(sg_host_t host, void* userdata)
+void sg_host_set_data(sg_host_t host, void* userdata)
 {
   host->set_data(userdata);
 }
-void* sg_host_user(sg_host_t host) // deprecated
+void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
+{
+  return sg_host_get_data(host);
+}
+void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
+{
+  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) // deprecated
+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) // deprecated
+void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
 {
   host->set_data(nullptr);
 }
 
-// ========= storage related functions ============
-void sg_host_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
+// ========= 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 ===============
 // ================================================
 /** @brief Returns the total speed of a host */
-double sg_host_speed(const_sg_host_t host)
+double sg_host_get_speed(const_sg_host_t host)
 {
   return host->get_speed();
 }
 
+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.
  *
  * @param  host host to test
@@ -523,8 +520,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) {
@@ -557,7 +555,7 @@ void sg_host_set_property_value(sg_host_t host, const char* name, const char* va
  * @param to where to
  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
  */
-void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
+void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
 {
   std::vector<simgrid::s4u::Link*> vlinks;
   from->route_to(to, vlinks, nullptr);
@@ -570,7 +568,7 @@ void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
  * @param from where from
  * @param to where to
  */
-double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
+double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
 {
   std::vector<simgrid::s4u::Link*> vlinks;
   double res = 0;
@@ -583,7 +581,7 @@ double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
  * @param from where from
  * @param to where to
  */
-double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
+double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
 {
   double min_bandwidth = -1.0;
 
@@ -597,9 +595,24 @@ double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
   return min_bandwidth;
 }
 
+void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
+{
+  sg_host_get_route(from, to, links);
+}
+
+double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
+{
+  return sg_host_get_route_latency(from, to);
+}
+
+double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
+{
+  return sg_host_get_route_bandwidth(from, to);
+}
+
 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 */
@@ -647,7 +660,12 @@ const char* sg_host_self_get_name()
   return res;
 }
 
-double sg_host_load(const_sg_host_t host)
+double sg_host_get_load(const_sg_host_t host)
 {
   return host->get_load();
 }
+
+double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
+{
+  return sg_host_get_load(host);
+}