1 /* Copyright (c) 2019-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 #include "simgrid/kernel/resource/Action.hpp"
7 #include "simgrid/kernel/resource/Model.hpp"
8 #include "simgrid/s4u/Disk.hpp"
9 #include "simgrid/s4u/Io.hpp"
10 #include "src/kernel/resource/Resource.hpp"
11 #include "src/surf/surf_interface.hpp"
12 #include "xbt/PropertyHolder.hpp"
16 #ifndef DISK_IMPL_HPP_
17 #define DISK_IMPL_HPP_
35 class DiskModel : public Model {
37 explicit DiskModel(const std::string& name);
38 DiskModel(const DiskModel&) = delete;
39 DiskModel& operator=(const DiskModel&) = delete;
41 virtual DiskImpl* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth) = 0;
43 virtual DiskAction* io_start(const DiskImpl* disk, sg_size_t size, s4u::Io::OpType type) = 0;
49 class DiskImpl : public Resource_T<DiskImpl>, public xbt::PropertyHolder {
51 s4u::Host* host_ = nullptr;
52 lmm::Constraint* constraint_write_ = nullptr; /* Constraint for maximum write bandwidth*/
53 lmm::Constraint* constraint_read_ = nullptr; /* Constraint for maximum read bandwidth*/
54 std::unordered_map<s4u::Disk::Operation, s4u::Disk::SharingPolicy> sharing_policy_ = {
55 {s4u::Disk::Operation::READ, s4u::Disk::SharingPolicy::LINEAR},
56 {s4u::Disk::Operation::WRITE, s4u::Disk::SharingPolicy::LINEAR},
57 {s4u::Disk::Operation::READWRITE, s4u::Disk::SharingPolicy::LINEAR}};
58 std::unordered_map<s4u::Disk::Operation, s4u::NonLinearResourceCb> sharing_policy_cb_ = {};
59 std::function<s4u::Disk::IoFactorCb> factor_cb_ = {};
61 Metric read_bw_ = {0.0, 0, nullptr};
62 Metric write_bw_ = {0.0, 0, nullptr};
63 double readwrite_bw_ = -1; /* readwrite constraint bound, usually max(read, write) */
65 void apply_sharing_policy_cfg();
68 ~DiskImpl() override = default; // Disallow direct deletion. Call destroy() instead.
71 explicit DiskImpl(const std::string& name, double read_bandwidth, double write_bandwidth);
72 DiskImpl(const DiskImpl&) = delete;
73 DiskImpl& operator=(const DiskImpl&) = delete;
75 /** @brief Public interface */
76 const s4u::Disk* get_iface() const { return &piface_; }
77 s4u::Disk* get_iface() { return &piface_; }
78 DiskImpl* set_host(s4u::Host* host);
79 s4u::Host* get_host() const { return host_; }
81 virtual void set_read_bandwidth(double value) { read_bw_.peak = value; }
82 double get_read_bandwidth() const { return read_bw_.peak * read_bw_.scale; }
84 virtual void set_write_bandwidth(double value) { write_bw_.peak = value; }
85 double get_write_bandwidth() const { return write_bw_.peak * write_bw_.scale; }
87 virtual void set_readwrite_bandwidth(double value) { readwrite_bw_ = value; }
88 double get_readwrite_bandwidth() const { return readwrite_bw_; }
90 DiskImpl* set_read_constraint(lmm::Constraint* constraint_read);
91 lmm::Constraint* get_read_constraint() const { return constraint_read_; }
93 DiskImpl* set_write_constraint(lmm::Constraint* constraint_write);
94 lmm::Constraint* get_write_constraint() const { return constraint_write_; }
96 profile::Event* get_read_event() const { return read_bw_.event; }
97 void unref_read_event() { tmgr_trace_event_unref(&read_bw_.event); }
99 profile::Event* get_write_event() const { return write_bw_.event; }
100 void unref_write_event() { tmgr_trace_event_unref(&write_bw_.event); }
102 DiskImpl* set_read_bandwidth_profile(profile::Profile* profile);
103 DiskImpl* set_write_bandwidth_profile(profile::Profile* profile);
105 void set_sharing_policy(s4u::Disk::Operation op, s4u::Disk::SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
106 s4u::Disk::SharingPolicy get_sharing_policy(s4u::Disk::Operation op) const;
108 void set_factor_cb(const std::function<s4u::Disk::IoFactorCb>& cb);
109 const std::function<s4u::Disk::IoFactorCb>& get_factor_cb() const { return factor_cb_; }
111 void turn_on() override;
112 void turn_off() override;
114 void seal() override;
115 void destroy(); // Must be called instead of the destructor
122 class DiskAction : public Action {
124 static xbt::signal<void(DiskAction const&, Action::State, Action::State)> on_state_change;
126 using Action::Action;
127 void set_state(simgrid::kernel::resource::Action::State state) override;
130 } // namespace resource
131 } // namespace kernel
132 } // namespace simgrid
133 #endif /* DISK_IMPL_HPP_ */