include/simgrid/s4u/Io.hpp

   1 /* Copyright (c) 2017-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 #ifndef SIMGRID_S4U_IO_HPP
   7 #define SIMGRID_S4U_IO_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/s4u/Activity.hpp>
  11
  12 #include <string>
  13
  14 namespace simgrid::s4u {
  15
  16 /** I/O Activity, representing the asynchronous disk access.
  17  *
  18  * They are generated from Disk::io_init(), Disk::read() Disk::read_async(), Disk::write() and Disk::write_async().
  19  */
  20
  21 class XBT_PUBLIC Io : public Activity_T<Io> {
  22 #ifndef DOXYGEN
  23   friend kernel::activity::IoImpl;
  24   friend kernel::EngineImpl;
  25 #endif
  26
  27 protected:
  28   explicit Io(kernel::activity::IoImplPtr pimpl);
  29   Io* do_start() override;
  30
  31 public:
  32   enum class OpType { READ, WRITE };
  33
  34    /*! \static Initiate the creation of an I/O. Setters have to be called afterwards */
  35   static IoPtr init();
  36   /*! \static take a vector of s4u::IoPtr and return when one of them is finished.
  37    * The return value is the rank of the first finished IoPtr. */
  38   static ssize_t wait_any(const std::vector<IoPtr>& ios) { return wait_any_for(ios, -1); }
  39   /*! \static Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
  40   static ssize_t wait_any_for(const std::vector<IoPtr>& ios, double timeout);
  41
  42   double get_remaining() const override;
  43   sg_size_t get_performed_ioops() const;
  44   IoPtr set_disk(const_sg_disk_t disk);
  45   IoPtr set_priority(double priority);
  46   IoPtr set_size(sg_size_t size);
  47   IoPtr set_op_type(OpType type);
  48
  49   static IoPtr streamto_init(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk);
  50   static IoPtr streamto_async(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk,
  51                               uint64_t simulated_size_in_bytes);
  52   static void streamto(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk,
  53                        uint64_t simulated_size_in_bytes);
  54
  55   IoPtr set_source(Host* from, const Disk* from_disk);
  56   IoPtr set_destination(Host* to, const Disk* to_disk);
  57
  58   IoPtr update_priority(double priority);
  59
  60   bool is_assigned() const override;
  61 };
  62
  63 } // namespace simgrid::s4u
  64
  65 #endif /* SIMGRID_S4U_IO_HPP */