1 /* Copyright (c) 2019-2020. 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/forward.h>
10 #include <simgrid/s4u/Io.hpp>
11 #include <xbt/Extendable.hpp>
13 #include <xbt/signal.hpp>
17 #include <unordered_map>
21 extern template class XBT_PUBLIC xbt::Extendable<s4u::Disk>;
25 /** Disk represent the disk resources associated to a host
27 * By default, SimGrid does not keep track of the actual data being written but
28 * only computes the time taken by the corresponding data movement.
31 class XBT_PUBLIC Disk : public xbt::Extendable<Disk> {
32 kernel::resource::DiskImpl* const pimpl_;
36 friend kernel::resource::DiskImpl;
39 virtual ~Disk() = default;
42 explicit Disk(const std::string& name, kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl), name_(name) {}
44 /** @brief Callback signal fired when a new Disk is created */
45 static xbt::signal<void(Disk&)> on_creation;
46 /** @brief Callback signal fired when a Disk is destroyed */
47 static xbt::signal<void(Disk const&)> on_destruction;
48 /** @brief Callback signal fired when a Disk's state changes */
49 static xbt::signal<void(Disk const&)> on_state_change;
51 /** @brief Retrieves the name of that disk as a C++ string */
52 std::string const& get_name() const { return name_; }
53 /** @brief Retrieves the name of that disk as a C string */
54 const char* get_cname() const { return name_.c_str(); }
55 double get_read_bandwidth() const;
56 double get_write_bandwidth() const;
57 const std::unordered_map<std::string, std::string>* get_properties() const;
58 const char* get_property(const std::string& key) const;
59 void set_property(const std::string&, const std::string& value);
60 Host* get_host() const;
62 IoPtr io_init(sg_size_t size, s4u::Io::OpType type);
64 IoPtr read_async(sg_size_t size);
65 sg_size_t read(sg_size_t size);
67 IoPtr write_async(sg_size_t size);
68 sg_size_t write(sg_size_t size);
69 kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
73 } // namespace simgrid
75 #endif /* INCLUDE_SIMGRID_S4U_DISK_HPP_ */