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 <xbt/Extendable.hpp>
  11 #include <xbt/base.h>
  12
  13 #include <map>
  14 #include <string>
  15 #include <unordered_map>
  16
  17 namespace simgrid {
  18 namespace xbt {
  19 extern template class XBT_PUBLIC Extendable<simgrid::s4u::Storage>;
  20 }
  21 namespace s4u {
  22
  23 XBT_ATTRIB_DEPRECATED_v322(
  24     "simgrid::s4u::getStorageList() is deprecated in favor of Engine::getAllStorages(). Please switch before v3.22")
  25     XBT_PUBLIC void getStorageList(std::map<std::string, Storage*>* whereTo);
  26
  27 class XBT_PUBLIC Storage : public simgrid::xbt::Extendable<Storage> {
  28   friend s4u::Engine;
  29   friend simgrid::surf::StorageImpl;
  30
  31 public:
  32   explicit Storage(std::string name, surf::StorageImpl * pimpl);
  33
  34 protected:
  35   virtual ~Storage() = default;
  36
  37 public:
  38   /** @brief Callback signal fired when a new Storage is created */
  39   static simgrid::xbt::signal<void(s4u::Storage&)> on_creation;
  40   /** @brief Callback signal fired when a Storage is destroyed */
  41   static simgrid::xbt::signal<void(s4u::Storage&)> on_destruction;
  42   /** @brief Callback signal fired when a Storage's state changes */
  43   static simgrid::xbt::signal<void(s4u::Storage&)> on_state_change;
  44
  45   /** Retrieve a Storage by its name. It must exist in the platform file */
  46   static Storage* by_name(std::string name);
  47
  48   /** @brief Retrieves the name of that storage as a C++ string */
  49   std::string const& get_name() const;
  50   /** @brief Retrieves the name of that storage as a C string */
  51   const char* get_cname() const;
  52
  53   const char* get_type();
  54   Host* get_host() { return attached_to_; };
  55   void set_host(Host* host) { attached_to_ = host; }
  56
  57   std::map<std::string, std::string>* getProperties();
  58   const char* get_property(std::string key);
  59   void set_property(std::string, std::string value);
  60
  61   void set_data(void* data) { userdata_ = data; }
  62   void* get_data() { return userdata_; }
  63
  64   sg_size_t read(sg_size_t size);
  65   sg_size_t write(sg_size_t size);
  66   surf::StorageImpl* get_impl() { return pimpl_; }
  67
  68   // Deprecated functions
  69   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::by_name()") Storage* byName(std::string name)
  70   {
  71     return by_name(name);
  72   }
  73   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); }
  74   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); }
  75   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_type()") const char* getType() { return get_type(); }
  76   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_host()") Host* getHost() { return get_host(); }
  77   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_property()") const char* getProperty(const char* key)
  78   {
  79     return get_property(key);
  80   }
  81   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_property()") void setProperty(std::string key, std::string value)
  82   {
  83     set_property(key, value);
  84   }
  85   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_data()") void setUserdata(void* data) { set_data(data); }
  86   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_data()") void* getUserdata() { return get_data(); }
  87
  88 private:
  89   Host* attached_to_              = nullptr;
  90   surf::StorageImpl* const pimpl_ = nullptr;
  91   std::string name_;
  92   void* userdata_ = nullptr;
  93 };
  94
  95 } /* namespace s4u */
  96 } /* namespace simgrid */
  97
  98 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */