1 /* Copyright (c) 2017-2022. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_IO_HPP
7 #define SIMGRID_S4U_IO_HPP
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Activity.hpp>
17 /** I/O Activity, representing the asynchronous disk access.
19 * They are generated from Disk::io_init(), Disk::read() Disk::read_async(), Disk::write() and Disk::write_async().
22 class XBT_PUBLIC Io : public Activity_T<Io> {
24 friend kernel::activity::IoImpl;
25 friend kernel::EngineImpl;
28 static xbt::signal<void(Io const&)> on_start;
31 explicit Io(kernel::activity::IoImplPtr pimpl);
34 enum class OpType { READ, WRITE };
36 static void on_start_cb(const std::function<void(Io const&)>& cb) { on_start.connect(cb); }
40 /*! take a vector of s4u::IoPtr and return when one of them is finished.
41 * The return value is the rank of the first finished IoPtr. */
42 static ssize_t wait_any(const std::vector<IoPtr>& ios) { return wait_any_for(ios, -1); }
43 /*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
44 static ssize_t wait_any_for(const std::vector<IoPtr>& ios, double timeout);
46 double get_remaining() const override;
47 sg_size_t get_performed_ioops() const;
48 IoPtr set_disk(const_sg_disk_t disk);
49 IoPtr set_priority(double priority);
50 IoPtr set_size(sg_size_t size);
51 IoPtr set_op_type(OpType type);
53 IoPtr update_priority(double priority);
55 bool is_assigned() const override;
59 } // namespace simgrid
61 #endif /* SIMGRID_S4U_IO_HPP */