X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e96187af67ea418609e2e4454afbab053b37fc2f..6bc18b576fa4a890d8b9916d292ca67dfbf60dd3:/include/simgrid/s4u/Storage.hpp diff --git a/include/simgrid/s4u/Storage.hpp b/include/simgrid/s4u/Storage.hpp index 13ae9be296..85005c1259 100644 --- a/include/simgrid/s4u/Storage.hpp +++ b/include/simgrid/s4u/Storage.hpp @@ -7,66 +7,114 @@ #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_ #include +#include #include #include +#include #include #include #include namespace simgrid { -namespace xbt { -extern template class XBT_PUBLIC Extendable; -} namespace s4u { -XBT_ATTRIB_DEPRECATED_v322( - "simgrid::s4u::getStorageList() is deprecated in favor of Engine::getAllStorages(). Please switch before v3.22") - XBT_PUBLIC void getStorageList(std::map* whereTo); +#ifndef DOXYGEN +/** @deprecated Engine::get_all_storages() */ +XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_storages()") XBT_PUBLIC void getStorageList(std::map* whereTo); +#endif + +/** Storage represent the disk resources, usually associated to a given host */ class XBT_PUBLIC Storage : public simgrid::xbt::Extendable { +#ifndef DOXYGEN friend s4u::Engine; + friend s4u::Io; friend simgrid::surf::StorageImpl; +#endif /* DOXYGEN */ public: explicit Storage(std::string name, surf::StorageImpl * pimpl); + +protected: virtual ~Storage() = default; - /** Retrieve a Storage by its name. It must exist in the platform file */ - static Storage* byName(std::string name); +public: + /** @brief Callback signal fired when a new Storage is created */ + static simgrid::xbt::signal on_creation; + /** @brief Callback signal fired when a Storage is destroyed */ + static simgrid::xbt::signal on_destruction; + /** @brief Callback signal fired when a Storage's state changes */ + static simgrid::xbt::signal on_state_change; - XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); } + /** Retrieve a Storage by its name. It must exist in the platform file */ + static Storage* by_name(std::string name); + static Storage* by_name_or_null(std::string name); /** @brief Retrieves the name of that storage as a C++ string */ - std::string const& get_name() const; + std::string const& get_name() const { return name_; } /** @brief Retrieves the name of that storage as a C string */ - const char* get_cname() const; + const char* get_cname() const { return name_.c_str(); } - const char* getType(); - Host* getHost(); + const char* get_type(); + Host* get_host() { return attached_to_; }; + void set_host(Host* host) { attached_to_ = host; } - std::map* getProperties(); - const char* getProperty(std::string key); - void setProperty(std::string, std::string value); + std::unordered_map* get_properties(); + const char* get_property(std::string key); + void set_property(std::string, std::string value); - void setUserdata(void* data) { userdata_ = data; } - void* getUserdata() { return userdata_; } + void set_data(void* data) { userdata_ = data; } + void* get_data() { return userdata_; } - sg_size_t read(sg_size_t size); - sg_size_t write(sg_size_t size); - surf::StorageImpl* getImpl() { return pimpl_; } + IoPtr io_init(sg_size_t size, s4u::Io::OpType type); - /* The signals */ - /** @brief Callback signal fired when a new Storage is created */ - static simgrid::xbt::signal on_creation; - /** @brief Callback signal fired when a Storage is destroyed */ - static simgrid::xbt::signal on_destruction; - /** @brief Callback signal fired when a Storage's state changes */ - static simgrid::xbt::signal on_state_change; + IoPtr read_async(sg_size_t size); + sg_size_t read(sg_size_t size); - Host* attached_to_ = nullptr; + IoPtr write_async(sg_size_t size); + sg_size_t write(sg_size_t size); + surf::StorageImpl* get_impl() { return pimpl_; } + + // Deprecated functions + /** @deprecated Storage::by_name() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::by_name()") Storage* byName(std::string name) + { + return by_name(name); + } + /** @deprecated Storage::get_name() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); } + /** @deprecated Storage::get_cname() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); } + /** @deprecated Storage::get_type() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_type()") const char* getType() { return get_type(); } + /** @deprecated Storage::get_host() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_host()") Host* getHost() { return get_host(); } + /** @deprecated Storage::get_properties() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_properties()") std::map* getProperties() + { + std::map* res = new std::map(); + std::unordered_map* props = get_properties(); + for (auto const& kv : *props) + res->insert(kv); + return res; + } + /** @deprecated Storage::get_property() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_property()") const char* getProperty(const char* key) + { + return get_property(key); + } + /** @deprecated Storage::set_property() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_property()") void setProperty(std::string key, std::string value) + { + set_property(key, value); + } + /** @deprecated Storage::set_data() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_data()") void setUserdata(void* data) { set_data(data); } + /** @deprecated Storage::get_data() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_data()") void* getUserdata() { return get_data(); } private: + Host* attached_to_ = nullptr; surf::StorageImpl* const pimpl_ = nullptr; std::string name_; void* userdata_ = nullptr;