-/* Copyright (c) 2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2019-2021. 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. */
#ifndef INCLUDE_SIMGRID_S4U_DISK_HPP_
#define INCLUDE_SIMGRID_S4U_DISK_HPP_
+#include <simgrid/disk.h>
#include <simgrid/forward.h>
#include <simgrid/s4u/Io.hpp>
#include <xbt/Extendable.hpp>
#include <unordered_map>
namespace simgrid {
+
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Disk>;
+
namespace s4u {
/** Disk represent the disk resources associated to a host
*/
class XBT_PUBLIC Disk : public xbt::Extendable<Disk> {
+ kernel::resource::DiskImpl* const pimpl_;
+ std::string name_;
friend Engine;
friend Io;
friend kernel::resource::DiskImpl;
-public:
- explicit Disk(const std::string& name, kernel::resource::DiskImpl* pimpl);
-
protected:
+#ifndef DOXYGEN
virtual ~Disk() = default;
+#endif
public:
- /** @brief Callback signal fired when a new Storage is created */
+#ifndef DOXYGEN
+ explicit Disk(const std::string& name, kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl), name_(name) {}
+#endif
+
+ /** @brief Callback signal fired when a new Disk is created */
static xbt::signal<void(Disk&)> on_creation;
- /** @brief Callback signal fired when a Storage is destroyed */
+ /** @brief Callback signal fired when a Disk is destroyed */
static xbt::signal<void(Disk const&)> on_destruction;
- /** @brief Callback signal fired when a Storage's state changes */
+ /** @brief Callback signal fired when a Disk's state changes */
static xbt::signal<void(Disk const&)> on_state_change;
- /** Retrieve a Storage by its name. It must exist in the platform file */
- static Disk* by_name(const std::string& name);
- static Disk* by_name_or_null(const std::string& name);
-
- /** @brief Retrieves the name of that storage as a C++ string */
+ /** @brief Retrieves the name of that disk as a C++ string */
+ Disk* set_name(std::string const& name);
std::string const& get_name() const { return name_; }
- /** @brief Retrieves the name of that storage as a C string */
+ /** @brief Retrieves the name of that disk as a C string */
const char* get_cname() const { return name_.c_str(); }
- Host* get_host() { return attached_to_; };
- void set_host(Host* host) { attached_to_ = host; }
+ Disk* set_read_bandwidth(double read_bw);
+ double get_read_bandwidth() const;
+
+ Disk* set_write_bandwidth(double write_bw);
+ double get_write_bandwidth() const;
const std::unordered_map<std::string, std::string>* get_properties() const;
const char* get_property(const std::string& key) const;
- void set_property(const std::string&, const std::string& value);
+ Disk* set_property(const std::string&, const std::string& value);
+ Disk* set_host(Host* host);
+ Host* get_host() const;
- void set_data(void* data) { userdata_ = data; }
- void* get_data() { return userdata_; }
+ IoPtr io_init(sg_size_t size, s4u::Io::OpType type) const;
- IoPtr io_init(sg_size_t size, s4u::Io::OpType type);
+ IoPtr read_async(sg_size_t size) const;
+ sg_size_t read(sg_size_t size) const;
- IoPtr read_async(sg_size_t size);
- sg_size_t read(sg_size_t size);
+ IoPtr write_async(sg_size_t size) const;
+ sg_size_t write(sg_size_t size) const;
+ Disk* seal();
- IoPtr write_async(sg_size_t size);
- sg_size_t write(sg_size_t size);
+#ifndef DOXYGEN
kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
-
-private:
- Host* attached_to_ = nullptr;
- kernel::resource::DiskImpl* const pimpl_;
- std::string name_;
- void* userdata_ = nullptr;
+#endif
};
} // namespace s4u
