Add new entry in Release_Notes.

[simgrid.git] / include / simgrid / s4u / Io.hpp

diff --git a/include/simgrid/s4u/Io.hpp b/include/simgrid/s4u/Io.hpp
index c9d55d6..0709a3b 100644 (file)
--- a/include/simgrid/s4u/Io.hpp
+++ b/include/simgrid/s4u/Io.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2023. 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. */
@@ -9,11 +9,9 @@
 #include <simgrid/forward.h>
 #include <simgrid/s4u/Activity.hpp>
 
-#include <atomic>
 #include <string>
 
-namespace simgrid {
-namespace s4u {
+namespace simgrid::s4u {
 
 /** I/O Activity, representing the asynchronous disk access.
  *
@@ -21,40 +19,50 @@ namespace s4u {
  */
 
 class XBT_PUBLIC Io : public Activity_T<Io> {
-public:
-  enum class OpType { READ, WRITE };
+#ifndef DOXYGEN
+  friend kernel::activity::IoImpl;
+  friend kernel::EngineImpl;
+#endif
 
-private:
-  Storage* storage_ = nullptr;
-  Disk* disk_       = nullptr;
-  sg_size_t size_   = 0;
-  OpType type_      = OpType::READ;
-  std::atomic_int_fast32_t refcount_{0};
+protected:
+  explicit Io(kernel::activity::IoImplPtr pimpl);
+  Io* do_start() override;
 
-  explicit Io(sg_storage_t storage, sg_size_t size, OpType type);
-  explicit Io(sg_disk_t disk, sg_size_t size, OpType type);
+  static ssize_t deprecated_wait_any_for(const std::vector<IoPtr>& ios, double timeout); // XBT_ATTRIB_DEPRECATED_v339
 
 public:
+  enum class OpType { READ, WRITE };
+
+   /*! \static Initiate the creation of an I/O. Setters have to be called afterwards */
+  static IoPtr init();
 #ifndef DOXYGEN
-  friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Io* i);
-  friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Io* i);
-  friend Disk;    // Factory of IOs
-  friend Storage; // Factory of IOs
+  XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") 
+  static ssize_t wait_any(const std::vector<IoPtr>& ios) { return deprecated_wait_any_for(ios, -1); }
+  XBT_ATTRIB_DEPRECATED_v339("Please use ActivitySet instead") 
+  static ssize_t wait_any_for(const std::vector<IoPtr>& ios, double timeout) { return deprecated_wait_any_for(ios, timeout); }
 #endif
 
-  ~Io() = default;
+  double get_remaining() const override;
+  sg_size_t get_performed_ioops() const;
+  IoPtr set_disk(const_sg_disk_t disk);
+  IoPtr set_priority(double priority);
+  IoPtr set_size(sg_size_t size);
+  IoPtr set_op_type(OpType type);
+
+  static IoPtr streamto_init(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk);
+  static IoPtr streamto_async(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk,
+                              uint64_t simulated_size_in_bytes);
+  static void streamto(Host* from, const Disk* from_disk, Host* to, const Disk* to_disk,
+                       uint64_t simulated_size_in_bytes);
+
+  IoPtr set_source(Host* from, const Disk* from_disk);
+  IoPtr set_destination(Host* to, const Disk* to_disk);
 
-  Io* start() override;
-  Io* wait() override;
-  Io* wait_for(double timeout) override;
-  Io* cancel() override;
-  bool test() override;
+  IoPtr update_priority(double priority);
 
-  double get_remaining() override;
-  sg_size_t get_performed_ioops();
+  bool is_assigned() const override;
 };
 
-} // namespace s4u
-} // namespace simgrid
+} // namespace simgrid::s4u
 
 #endif /* SIMGRID_S4U_IO_HPP */