src/s4u/s4u_Io.cpp

   1 /* Copyright (c) 2018-2022. 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, Disk* from_disk, Host* to, 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, Disk* from_disk, Host* to, Disk* to_disk, uint64_t simulated_size_in_bytes)
  38 {
  39   return Io::init()->set_size(simulated_size_in_bytes)->set_source(from, from_disk)->set_destination(to, to_disk);
  40 }
  41
  42 void Io::streamto(Host* from, Disk* from_disk, Host* to, Disk* to_disk, uint64_t simulated_size_in_bytes)
  43 {
  44   streamto_async(from, from_disk, to, to_disk, simulated_size_in_bytes)->wait();
  45 }
  46
  47 IoPtr Io::set_source(Host* from, Disk* from_disk)
  48 {
  49   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
  50              "Cannot change the source of an IO stream once it's started (state: %s)", to_c_str(state_));
  51   kernel::actor::simcall_answered(
  52       [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     vetoable_start();
  62
  63   return this;
  64 }
  65
  66 IoPtr Io::set_destination(Host* to, 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_answered(
  71       [this, to, to_disk] {
  72         boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_dst_host(to);
  73         if (to_disk != nullptr)
  74           boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_dst_disk(to_disk->get_impl());
  75       });
  76   // Setting 'destination' may allow to start the activity, let's try
  77   if (state_ == State::STARTING && remains_ <= 0)
  78     XBT_DEBUG("This IO has a size of 0 byte. It cannot start yet");
  79   else
  80     vetoable_start();
  81
  82   return this;
  83 }
  84
  85 Io* Io::start()
  86 {
  87   kernel::actor::simcall_answered(
  88       [this] { (*boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)).set_name(get_name()).start(); });
  89
  90   if (suspended_)
  91     pimpl_->suspend();
  92
  93   state_ = State::STARTED;
  94   on_start(*this);
  95   return this;
  96 }
  97
  98 ssize_t Io::wait_any_for(const std::vector<IoPtr>& ios, double timeout)
  99 {
 100   std::vector<ActivityPtr> activities;
 101   for (const auto& io : ios)
 102     activities.push_back(boost::dynamic_pointer_cast<Activity>(io));
 103   return Activity::wait_any_for(activities, timeout);
 104 }
 105
 106 IoPtr Io::set_disk(const_sg_disk_t disk)
 107 {
 108   xbt_assert(state_ == State::INITED || state_ == State::STARTING, "Cannot set disk once the Io is started");
 109
 110   kernel::actor::simcall_answered(
 111       [this, disk] { boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_disk(disk->get_impl()); });
 112
 113   // Setting the disk may allow to start the activity, let's try
 114   if (state_ == State::STARTING)
 115     vetoable_start();
 116
 117  return this;
 118 }
 119
 120 IoPtr Io::set_priority(double priority)
 121 {
 122   xbt_assert(state_ == State::INITED || state_ == State::STARTING,
 123              "Cannot change the priority of an io after its start");
 124   kernel::actor::simcall_answered([this, priority] {
 125     boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_sharing_penalty(1. / priority);
 126   });
 127   return this;
 128 }
 129
 130 IoPtr Io::set_size(sg_size_t size)
 131 {
 132   xbt_assert(state_ == State::INITED || state_ == State::STARTING, "Cannot set size once the Io is started");
 133   kernel::actor::simcall_answered(
 134       [this, size] { boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_size(size); });
 135   set_remaining(size);
 136   return this;
 137 }
 138
 139 IoPtr Io::set_op_type(OpType type)
 140 {
 141   xbt_assert(state_ == State::INITED || state_ == State::STARTING, "Cannot set size once the Io is started");
 142   kernel::actor::simcall_answered(
 143       [this, type] { boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->set_type(type); });
 144   return this;
 145 }
 146
 147 IoPtr Io::update_priority(double priority)
 148 {
 149   kernel::actor::simcall_answered([this, priority] {
 150     boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->update_sharing_penalty(1. / priority);
 151   });
 152   return this;
 153 }
 154
 155 /** @brief Returns the amount of flops that remain to be done */
 156 double Io::get_remaining() const
 157 {
 158   return kernel::actor::simcall_answered(
 159       [this]() { return boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_remaining(); });
 160 }
 161
 162 sg_size_t Io::get_performed_ioops() const
 163 {
 164   return boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_performed_ioops();
 165 }
 166
 167 bool Io::is_assigned() const
 168 {
 169   if (boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_host() == nullptr) {
 170     return boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_disk() != nullptr;
 171   } else {
 172     return boost::static_pointer_cast<kernel::activity::IoImpl>(pimpl_)->get_dst_host() != nullptr;
 173   }
 174 }
 175
 176 } // namespace simgrid::s4u