1 /* Copyright (c) 2019-2021. 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 INCLUDE_SIMGRID_S4U_DISK_HPP_
7 #define INCLUDE_SIMGRID_S4U_DISK_HPP_
9 #include <simgrid/disk.h>
10 #include <simgrid/forward.h>
11 #include <simgrid/s4u/Io.hpp>
12 #include <xbt/Extendable.hpp>
14 #include <xbt/signal.hpp>
18 #include <unordered_map>
22 extern template class XBT_PUBLIC xbt::Extendable<s4u::Disk>;
26 /** Disk represent the disk resources associated to a host
28 * By default, SimGrid does not keep track of the actual data being written but
29 * only computes the time taken by the corresponding data movement.
32 class XBT_PUBLIC Disk : public xbt::Extendable<Disk> {
33 kernel::resource::DiskImpl* const pimpl_;
37 friend kernel::resource::DiskImpl;
41 virtual ~Disk() = default;
46 explicit Disk(const std::string& name, kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl), name_(name) {}
49 /** @brief Callback signal fired when a new Disk is created */
50 static xbt::signal<void(Disk&)> on_creation;
51 /** @brief Callback signal fired when a Disk is destroyed */
52 static xbt::signal<void(Disk const&)> on_destruction;
53 /** @brief Callback signal fired when a Disk's state changes */
54 static xbt::signal<void(Disk const&)> on_state_change;
56 /** @brief Retrieves the name of that disk as a C++ string */
57 Disk* set_name(std::string const& name);
58 std::string const& get_name() const { return name_; }
59 /** @brief Retrieves the name of that disk as a C string */
60 const char* get_cname() const { return name_.c_str(); }
62 Disk* set_read_bandwidth(double read_bw);
63 double get_read_bandwidth() const;
65 Disk* set_write_bandwidth(double write_bw);
66 double get_write_bandwidth() const;
68 const std::unordered_map<std::string, std::string>* get_properties() const;
69 const char* get_property(const std::string& key) const;
70 void set_property(const std::string&, const std::string& value);
71 Disk* set_host(Host* host);
72 Host* get_host() const;
74 IoPtr io_init(sg_size_t size, s4u::Io::OpType type) const;
76 IoPtr read_async(sg_size_t size) const;
77 sg_size_t read(sg_size_t size) const;
79 IoPtr write_async(sg_size_t size) const;
80 sg_size_t write(sg_size_t size) const;
84 kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
89 } // namespace simgrid
91 #endif /* INCLUDE_SIMGRID_S4U_DISK_HPP_ */