include/simgrid/s4u/Io.hpp

   1 /* Copyright (c) 2017-2019. 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 <atomic>
  13 #include <string>
  14
  15 namespace simgrid {
  16 namespace s4u {
  17
  18 /** I/O Activity, representing the asynchronous disk access.
  19  *
  20  * They are generated from Storage::io_init() or Storage::read() and Storage::write().
  21  */
  22
  23 class XBT_PUBLIC Io : public Activity {
  24 public:
  25   enum class OpType { READ, WRITE };
  26
  27 private:
  28   Storage* storage_ = nullptr;
  29   sg_size_t size_   = 0;
  30   OpType type_      = OpType::READ;
  31   std::string name_ = "";
  32   std::atomic_int_fast32_t refcount_{0};
  33
  34   explicit Io(sg_storage_t storage, sg_size_t size, OpType type);
  35
  36 public:
  37   friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Io* i);
  38   friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Io* i);
  39   friend simgrid::s4u::Storage; // Factory of IOs
  40
  41   ~Io() = default;
  42
  43   Io* start() override;
  44   Io* wait() override;
  45   Io* wait_for(double timeout) override;
  46   Io* cancel() override;
  47   bool test() override;
  48
  49   double get_remaining() override;
  50   sg_size_t get_performed_ioops();
  51
  52 #ifndef DOXYGEN
  53   XBT_ATTRIB_DEPRECATED_v324("Please use Io::wait_for()") void wait(double t) override { wait_for(t); }
  54 #endif
  55
  56 }; // class
  57 } // namespace s4u
  58 } // namespace simgrid
  59
  60 #endif /* SIMGRID_S4U_IO_HPP */