include/simgrid/s4u/Disk.hpp

   1 /* Copyright (c) 2019-2021. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #ifndef INCLUDE_SIMGRID_S4U_DISK_HPP_
   7 #define INCLUDE_SIMGRID_S4U_DISK_HPP_
   8
   9 #include <simgrid/disk.h>
  10 #include <simgrid/forward.h>
  11 #include <simgrid/s4u/Io.hpp>
  12 #include <xbt/Extendable.hpp>
  13 #include <xbt/base.h>
  14 #include <xbt/signal.hpp>
  15
  16 #include <map>
  17 #include <string>
  18 #include <unordered_map>
  19
  20 namespace simgrid {
  21
  22 extern template class XBT_PUBLIC xbt::Extendable<s4u::Disk>;
  23
  24 namespace s4u {
  25
  26 /** Disk represent the disk resources associated to a host
  27  *
  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.
  30  */
  31
  32 class XBT_PUBLIC Disk : public xbt::Extendable<Disk> {
  33   kernel::resource::DiskImpl* const pimpl_;
  34   std::string name_;
  35   friend Engine;
  36   friend Io;
  37   friend kernel::resource::DiskImpl;
  38
  39 protected:
  40 #ifndef DOXYGEN
  41   virtual ~Disk() = default;
  42 #endif
  43
  44 public:
  45 #ifndef DOXYGEN
  46   explicit Disk(kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl) {}
  47 #endif
  48
  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;
  55
  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(); }
  61
  62   Disk* set_read_bandwidth(double read_bw);
  63   double get_read_bandwidth() const;
  64
  65   Disk* set_write_bandwidth(double write_bw);
  66   double get_write_bandwidth() const;
  67
  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   Host* get_host() const;
  72
  73   IoPtr io_init(sg_size_t size, s4u::Io::OpType type);
  74
  75   IoPtr read_async(sg_size_t size);
  76   sg_size_t read(sg_size_t size);
  77
  78   IoPtr write_async(sg_size_t size);
  79   sg_size_t write(sg_size_t size);
  80 #ifndef DOXYGEN
  81   kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
  82 #endif
  83 };
  84
  85 } // namespace s4u
  86 } // namespace simgrid
  87
  88 #endif /* INCLUDE_SIMGRID_S4U_DISK_HPP_ */