X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/15479dbe435febdbec7411e8de9b11bac1ca9350..555ebc2e544437445450239b48e7df9b4f371460:/include/simgrid/s4u/Disk.hpp

diff --git a/include/simgrid/s4u/Disk.hpp b/include/simgrid/s4u/Disk.hpp
index 771509594c..5ba6306774 100644
--- a/include/simgrid/s4u/Disk.hpp
+++ b/include/simgrid/s4u/Disk.hpp
@@ -1,4 +1,4 @@
-/* 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. */
@@ -6,6 +6,7 @@
 #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>
@@ -17,6 +18,9 @@
 #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
@@ -26,50 +30,94 @@ namespace s4u {
  */
 
 class XBT_PUBLIC Disk : public xbt::Extendable<Disk> {
+#ifndef DOXYGEN
   friend Engine;
   friend Io;
   friend kernel::resource::DiskImpl;
+#endif
 
-public:
-  explicit Disk(const std::string& name, kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl), name_(name) {}
-
-protected:
+  explicit Disk(kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl) {}
   virtual ~Disk() = default;
 
-public:
-  /** @brief Callback signal fired when a new Storage is created */
-  static xbt::signal<void(Disk&)> on_creation;
-  /** @brief Callback signal fired when a Storage is destroyed */
-  static xbt::signal<void(Disk const&)> on_destruction;
-  /** @brief Callback signal fired when a Storage's state changes */
-  static xbt::signal<void(Disk const&)> on_state_change;
-
-  /** @brief Retrieves the name of that storage as a C++ string */
-  std::string const& get_name() const { return name_; }
-  /** @brief Retrieves the name of that storage as a C string */
-  const char* get_cname() const { return name_.c_str(); }
-
-  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);
-  Host* get_host();
+  // The private implementation, that never changes
+  kernel::resource::DiskImpl* const pimpl_;
 
-  void set_data(void* data) { userdata_ = data; }
-  void* get_data() { return userdata_; }
+public:
+#ifndef DOXYGEN
+  kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
+#endif
 
-  IoPtr io_init(sg_size_t size, s4u::Io::OpType type);
+  std::string const& get_name() const;
+  /** @brief Retrieves the name of that disk as a C string */
+  const char* get_cname() const;
 
-  IoPtr read_async(sg_size_t size);
-  sg_size_t read(sg_size_t size);
+  Disk* set_read_bandwidth(double read_bw);
+  double get_read_bandwidth() const;
 
-  IoPtr write_async(sg_size_t size);
-  sg_size_t write(sg_size_t size);
-  kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
+  Disk* set_write_bandwidth(double write_bw);
+  double get_write_bandwidth() const;
 
-private:
-  kernel::resource::DiskImpl* const pimpl_;
-  std::string name_;
-  void* userdata_ = nullptr;
+  const std::unordered_map<std::string, std::string>* get_properties() const;
+  const char* get_property(const std::string& key) const;
+  Disk* set_property(const std::string&, const std::string& value);
+  Disk* set_properties(const std::unordered_map<std::string, std::string>& properties);
+
+  Disk* set_host(Host* host);
+  Host* get_host() const;
+
+  Disk* set_state_profile(kernel::profile::Profile* profile);
+  Disk* set_read_bandwidth_profile(kernel::profile::Profile* profile);
+  Disk* set_write_bandwidth_profile(kernel::profile::Profile* profile);
+
+  IoPtr io_init(sg_size_t size, s4u::Io::OpType type) const;
+
+  IoPtr read_async(sg_size_t size) const;
+  sg_size_t read(sg_size_t size) const;
+
+  IoPtr write_async(sg_size_t size) const;
+  sg_size_t write(sg_size_t size) const;
+
+  /** @brief Policy for sharing the disk among activities */
+  enum class SharingPolicy { NONLINEAR = 1, LINEAR = 0 };
+  enum class Operation { READ = 2, WRITE = 1, READWRITE = 0 };
+
+  /**
+   * @brief Describes how the disk is shared between activities for each operation
+   *
+   * Disks have different bandwidths for read and write operations. This method
+   * allows you to set different sharing policies for each operation:
+   * - Read: resource sharing for read operation
+   * - Write: resource sharing for write
+   * - ReadWrite: global sharing for read and write operations
+   *
+   * @param op Operation type
+   * @param policy Sharing policy
+   * @param cb Callback for NONLINEAR policies
+   */
+  Disk* set_sharing_policy(Operation op, SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {});
+  SharingPolicy get_sharing_policy(Operation op) const;
+  /**
+   * @brief Callback to set IO factors
+   *
+   * This callback offers a flexible way to create variability in I/O operations
+   *
+   * @param size I/O operation size in bytes
+   * @param op I/O operation type: read or write
+   * @return Multiply factor
+   */
+  using IoFactorCb = double(sg_size_t size, Io::OpType op);
+  /** @brief Configure the factor callback */
+  Disk* set_factor_cb(const std::function<IoFactorCb>& cb);
+
+  Disk* seal();
+
+  /* The signals */
+  /** @brief Callback signal fired when a new Disk is created */
+  static xbt::signal<void(Disk&)> on_creation;
+  /** @brief Callback signal fired when a Disk is destroyed */
+  static xbt::signal<void(Disk const&)> on_destruction;
+  /** @brief Callback signal fired when a Disk's state changes */
+  static xbt::signal<void(Disk const&)> on_state_change;
 };
 
 } // namespace s4u