include/simgrid/s4u/Storage.hpp

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