src/s4u/s4u_Io.cpp

   1 /* Copyright (c) 2018-2023. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include <simgrid/s4u/Disk.hpp>
   7 #include <simgrid/s4u/Io.hpp>
   8 #include <xbt/log.h>
   9
  10 #include "src/kernel/activity/IoImpl.hpp"
  11 #include "src/kernel/actor/ActorImpl.hpp"
  12 #include "src/kernel/actor/SimcallObserver.hpp"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_io, s4u_activity, "S4U asynchronous I/Os");
  15
  16 namespace simgrid::s4u {
  17 xbt::signal<void(Io const&)> Io::on_start;
  18
  19 Io::Io(kernel::activity::IoImplPtr pimpl)
  20 {
  21   pimpl_ = pimpl;
  22 }
  23
  24 IoPtr Io::init()
  25 {
  26   auto pimpl = kernel::activity::IoImplPtr(new kernel::activity::IoImpl());
  27   return IoPtr(static_cast<Io*>(pimpl->get_iface()));
  28 }
  29
  30 IoPtr Io::streamto_init(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk)
  31 {
  32   auto res = Io::init()->set_source(from, from_disk)->set_destination(to, to_disk);
  33   res->set_state(State::STARTING);
  34   return res;
  35 }
  36
  37 IoPtr Io::streamto_async(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk,
  38                          uint64_t simulated_size_in_bytes)
  39 {
  40   return Io::init()->set_size(simulated_size_in_bytes)->set_source(from, from_disk)->set_destination(to, to_disk);
  41 }
  42
  43 void Io::streamto(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk, uint64_t simulated_size_in_bytes)
  44 {
  45   streamto_async(from, from_disk, to, to_disk, simulated_size_in_bytes)->wait();
  46 }
  47
  48 IoPtr Io::set_source(Host* from, const Disk* from_disk)
  49 {
  50   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
  51              "Cannot change the source of an IO stream once it's started (state: %s)", to_c_str(state_));
  52   kernel::actor::simcall_object_access(pimpl_.get(), [this, from, from_disk] {
  53     boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_host(from);
  54     if (from_disk != nullptr)
  55       boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_disk(from_disk->get_impl());
  56   });
  57   // Setting 'source' may allow to start the activity, let's try
  58   if (state_ == State::STARTING && remains_ <= 0)
  59     XBT_DEBUG("This IO has a size of 0 byte. It cannot start yet");
  60   else
  61     start();
  62
  63   return this;
  64 }
  65
  66 IoPtr Io::set_destination(Host* to, const Disk* to_disk)
  67 {
  68   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
  69              "Cannot change the source of an IO stream once it's started (state: %s)", to_c_str(state_));
  70   kernel::actor::simcall_object_access(pimpl_.get(), [this, to, to_disk] {
  71     boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_dst_host(to);
  72     if (to_disk != nullptr)
  73       boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_dst_disk(to_disk->get_impl());
  74   });
  75   // Setting 'destination' may allow to start the activity, let's try
  76   if (state_ == State::STARTING && remains_ <= 0)
  77     XBT_DEBUG("This IO has a size of 0 byte. It cannot start yet");
  78   else
  79     start();
  80
  81   return this;
  82 }
  83
  84 Io* Io::do_start()
  85 {
  86   kernel::actor::simcall_answered(
  87       [this] { (*boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)).set_name(get_name()).start(); });
  88
  89   if (suspended_)
  90     pimpl_->suspend();
  91
  92   state_ = State::STARTED;
  93   on_start(*this);
  94   return this;
  95 }
  96
  97 ssize_t Io::wait_any_for(const std::vector<IoPtr>& ios, double timeout)
  98 {
  99   std::vector<ActivityPtr> activities;
 100   for (const auto& io : ios)
 101     activities.push_back(boost::dynamic_pointer_cast<Activity>(io));
 102   return Activity::wait_any_for(activities, timeout);
 103 }
 104
 105 IoPtr Io::set_disk(const_sg_disk_t disk)
 106 {
 107   xbt_assert(state_ == State::INITED || state_ == State::STARTING, "Cannot set disk once the Io is started");
 108
 109   kernel::actor::simcall_answered(
 110       [this, disk] { boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_disk(disk->get_impl()); });
 111
 112   // Setting the disk may allow to start the activity, let's try
 113   if (state_ == State::STARTING)
 114     start();
 115
 116  return this;
 117 }
 118
 119 IoPtr Io::set_priority(double priority)
 120 {
 121   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 122              "Cannot change the priority of an io after its start");
 123   kernel::actor::simcall_object_access(pimpl_.get(), [this, priority] {
 124     boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_sharing_penalty(1. / priority);
 125   });
 126   return this;
 127 }
 128
 129 IoPtr Io::set_size(sg_size_t size)
 130 {
 131   xbt_assert(state_ == State::INITED || state_ == State::STARTING, "Cannot set size once the Io is started");
 132   kernel::actor::simcall_object_access(
 133       pimpl_.get(), [this, size] { boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_size(size); });
 134   set_remaining(size);
 135   return this;
 136 }
 137
 138 IoPtr Io::set_op_type(OpType type)
 139 {
 140   xbt_assert(state_ == State::INITED || state_ == State::STARTING, "Cannot set size once the Io is started");
 141   kernel::actor::simcall_object_access(
 142       pimpl_.get(), [this, type] { boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_type(type); });
 143   return this;
 144 }
 145
 146 IoPtr Io::update_priority(double priority)
 147 {
 148   kernel::actor::simcall_answered([this, priority] {
 149     boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->update_sharing_penalty(1. / priority);
 150   });
 151   return this;
 152 }
 153
 154 /** @brief Returns the amount of flops that remain to be done */
 155 double Io::get_remaining() const
 156 {
 157   return kernel::actor::simcall_object_access(
 158       pimpl_.get(), [this]() { return boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_remaining(); });
 159 }
 160
 161 sg_size_t Io::get_performed_ioops() const
 162 {
 163   return boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_performed_ioops();
 164 }
 165
 166 bool Io::is_assigned() const
 167 {
 168   if (boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_host() == nullptr) {
 169     return boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_disk() != nullptr;
 170   } else {
 171     return boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_dst_host() != nullptr;
 172   }
 173 }
 174
 175 } // namespace simgrid::s4u