X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b87fc0829538ec066fd077e6c30ee6270b8abd78..939476f1fc7630eb237535b07ed0deef77ce1b24:/include/simgrid/s4u/Storage.hpp diff --git a/include/simgrid/s4u/Storage.hpp b/include/simgrid/s4u/Storage.hpp index efad7b826d..f9d55c4848 100644 --- a/include/simgrid/s4u/Storage.hpp +++ b/include/simgrid/s4u/Storage.hpp @@ -1,5 +1,4 @@ -/* Copyright (c) 2006-2015, 2017. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -7,55 +6,109 @@ #ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_ #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_ +#include +#include +#include +#include + #include -#include -#include #include #include -#include namespace simgrid { +namespace xbt { +extern template class XBT_PUBLIC Extendable; +} namespace s4u { -XBT_ATTRIB_PUBLIC std::map* allStorages(); +/** @deprecated Engine::get_all_storages() */ +XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_storages()") XBT_PUBLIC void getStorageList(std::map* whereTo); -XBT_PUBLIC_CLASS Storage -{ +class XBT_PUBLIC Storage : public simgrid::xbt::Extendable { friend s4u::Engine; + friend s4u::Io; friend simgrid::surf::StorageImpl; public: - explicit Storage(surf::StorageImpl * pimpl) : pimpl_(pimpl) {} - virtual ~Storage() = default; - /** Retrieve a Storage by its name. It must exist in the platform file */ - static Storage* byName(std::string name); - const char* getName(); - const char* getType(); - Host* getHost(); - sg_size_t getSize(); /** Retrieve the total amount of space of this storage element */ - sg_size_t getSizeFree(); - sg_size_t getSizeUsed(); - - std::map* getProperties(); - const char* getProperty(const char* key); - void setProperty(const char* key, const char* value); - std::map* getContent(); - - void setUserdata(void* data) { userdata_ = data; } - void* getUserdata() { return userdata_; } + explicit Storage(std::string name, surf::StorageImpl * pimpl); - surf::StorageImpl* getImpl() { return pimpl_; } - - /* The signals */ - /** @brief Callback signal fired when a new Link is created */ - static simgrid::xbt::signal onCreation; +protected: + virtual ~Storage() = default; - /** @brief Callback signal fired when a Link is destroyed */ - static simgrid::xbt::signal onDestruction; +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; - Host* attached_to_ = nullptr; + /** 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 { return name_; } + /** @brief Retrieves the name of that storage as a C string */ + const char* get_cname() const { return name_.c_str(); } + + const char* get_type(); + Host* get_host() { return attached_to_; }; + void set_host(Host* host) { attached_to_ = host; } + + std::unordered_map* get_properties(); + const char* get_property(std::string key); + void set_property(std::string, std::string value); + + void set_data(void* data) { userdata_ = data; } + void* get_data() { return userdata_; } + + static IoPtr io_init(sg_size_t size); + + sg_size_t read(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;