include/simgrid/s4u/Disk.hpp

   1 /* Copyright (c) 2019-2020. 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/forward.h>
  10 #include <simgrid/s4u/Io.hpp>
  11 #include <xbt/Extendable.hpp>
  12 #include <xbt/base.h>
  13 #include <xbt/signal.hpp>
  14
  15 #include <map>
  16 #include <string>
  17 #include <unordered_map>
  18
  19 namespace simgrid {
  20
  21 extern template class XBT_PUBLIC xbt::Extendable<s4u::Disk>;
  22
  23 namespace s4u {
  24
  25 /** Disk represent the disk resources associated to a host
  26  *
  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.
  29  */
  30
  31 class XBT_PUBLIC Disk : public xbt::Extendable<Disk> {
  32   kernel::resource::DiskImpl* const pimpl_;
  33   std::string name_;
  34   friend Engine;
  35   friend Io;
  36   friend kernel::resource::DiskImpl;
  37
  38 protected:
  39 #ifndef DOXYGEN
  40   virtual ~Disk() = default;
  41 #endif
  42
  43 public:
  44 #ifndef DOXYGEN
  45   explicit Disk(const std::string& name, kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl), name_(name) {}
  46 #endif
  47
  48   /** @brief Callback signal fired when a new Disk is created */
  49   static xbt::signal<void(Disk&)> on_creation;
  50   /** @brief Callback signal fired when a Disk is destroyed */
  51   static xbt::signal<void(Disk const&)> on_destruction;
  52   /** @brief Callback signal fired when a Disk's state changes */
  53   static xbt::signal<void(Disk const&)> on_state_change;
  54
  55   /** @brief Retrieves the name of that disk as a C++ string */
  56   std::string const& get_name() const { return name_; }
  57   /** @brief Retrieves the name of that disk as a C string */
  58   const char* get_cname() const { return name_.c_str(); }
  59   double get_read_bandwidth() const;
  60   double get_write_bandwidth() const;
  61   const std::unordered_map<std::string, std::string>* get_properties() const;
  62   const char* get_property(const std::string& key) const;
  63   void set_property(const std::string&, const std::string& value);
  64   Host* get_host() const;
  65
  66   IoPtr io_init(sg_size_t size, s4u::Io::OpType type);
  67
  68   IoPtr read_async(sg_size_t size);
  69   sg_size_t read(sg_size_t size);
  70
  71   IoPtr write_async(sg_size_t size);
  72   sg_size_t write(sg_size_t size);
  73 #ifndef DOXYGEN
  74   kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
  75 #endif
  76 };
  77
  78 } // namespace s4u
  79 } // namespace simgrid
  80
  81 #endif /* INCLUDE_SIMGRID_S4U_DISK_HPP_ */