include/simgrid/s4u/Storage.hpp

   1 /* Copyright (c) 2006-2019. 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_STORAGE_HPP_
   7 #define INCLUDE_SIMGRID_S4U_STORAGE_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 namespace s4u {
  21
  22 /** Storage represent the disk resources, usually associated to a given host
  23  *
  24  * By default, SimGrid does not keep track of the actual data being written but
  25  * only computes the time taken by the corresponding data movement.
  26  */
  27
  28 class XBT_PUBLIC Storage : public xbt::Extendable<Storage> {
  29   friend Engine;
  30   friend Io;
  31   friend kernel::resource::StorageImpl;
  32
  33 public:
  34   explicit Storage(const std::string& name, kernel::resource::StorageImpl* pimpl);
  35
  36 protected:
  37   virtual ~Storage() = default;
  38 public:
  39   /** @brief Callback signal fired when a new Storage is created */
  40   static xbt::signal<void(Storage&)> on_creation;
  41   /** @brief Callback signal fired when a Storage is destroyed */
  42   static xbt::signal<void(Storage&)> on_destruction;
  43   /** @brief Callback signal fired when a Storage's state changes */
  44   static xbt::signal<void(Storage&)> on_state_change;
  45
  46   /** Retrieve a Storage by its name. It must exist in the platform file */
  47   static Storage* by_name(const std::string& name);
  48   static Storage* by_name_or_null(const std::string& name);
  49
  50   /** @brief Retrieves the name of that storage as a C++ string */
  51   std::string const& get_name() const { return name_; }
  52   /** @brief Retrieves the name of that storage as a C string */
  53   const char* get_cname() const { return name_.c_str(); }
  54
  55   const char* get_type();
  56   Host* get_host() { return attached_to_; };
  57   void set_host(Host* host) { attached_to_ = host; }
  58
  59   std::unordered_map<std::string, std::string>* get_properties();
  60   const char* get_property(const std::string& key);
  61   void set_property(const std::string&, const std::string& value);
  62
  63   void set_data(void* data) { userdata_ = data; }
  64   void* get_data() { return userdata_; }
  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   kernel::resource::StorageImpl* get_impl() { return pimpl_; }
  74
  75   // Deprecated functions
  76 #ifndef DOXYGEN
  77   /** @deprecated Storage::by_name() */
  78   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::by_name()") Storage* byName(const std::string& name)
  79   {
  80     return by_name(name);
  81   }
  82   /** @deprecated Storage::get_name() */
  83   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); }
  84   /** @deprecated Storage::get_cname() */
  85   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); }
  86   /** @deprecated Storage::get_type() */
  87   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_type()") const char* getType() { return get_type(); }
  88   /** @deprecated Storage::get_host() */
  89   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_host()") Host* getHost() { return get_host(); }
  90   /** @deprecated Storage::get_properties() */
  91   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_properties()") std::map<std::string, std::string>* getProperties()
  92   {
  93     std::map<std::string, std::string>* res             = new std::map<std::string, std::string>();
  94     std::unordered_map<std::string, std::string>* props = get_properties();
  95     for (auto const& kv : *props)
  96       res->insert(kv);
  97     return res;
  98   }
  99   /** @deprecated Storage::get_property() */
 100   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_property()") const char* getProperty(const char* key)
 101   {
 102     return get_property(key);
 103   }
 104   /** @deprecated Storage::set_property() */
 105   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_property()") void setProperty(const std::string& key,
 106                                                                                     const std::string& value)
 107   {
 108     set_property(key, value);
 109   }
 110   /** @deprecated Storage::set_data() */
 111   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_data()") void setUserdata(void* data) { set_data(data); }
 112   /** @deprecated Storage::get_data() */
 113   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_data()") void* getUserdata() { return get_data(); }
 114 #endif
 115
 116 private:
 117   Host* attached_to_ = nullptr;
 118   kernel::resource::StorageImpl* const pimpl_;
 119   std::string name_;
 120   void* userdata_ = nullptr;
 121 };
 122
 123 } // namespace s4u
 124 } // namespace simgrid
 125
 126 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */