1 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_
7 #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
9 #include <simgrid/forward.h>
10 #include <xbt/Extendable.hpp>
15 #include <unordered_map>
19 extern template class XBT_PUBLIC Extendable<simgrid::s4u::Storage>;
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);
27 class XBT_PUBLIC Storage : public simgrid::xbt::Extendable<Storage> {
29 friend simgrid::surf::StorageImpl;
32 explicit Storage(std::string name, surf::StorageImpl * pimpl);
33 virtual ~Storage() = default;
34 /** Retrieve a Storage by its name. It must exist in the platform file */
35 static Storage* byName(std::string name);
37 XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); }
38 XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); }
40 /** @brief Retrieves the name of that storage as a C++ string */
41 std::string const& get_name() const;
42 /** @brief Retrieves the name of that storage as a C string */
43 const char* get_cname() const;
45 const char* getType();
48 std::map<std::string, std::string>* getProperties();
49 const char* getProperty(std::string key);
50 void setProperty(std::string, std::string value);
52 void setUserdata(void* data) { userdata_ = data; }
53 void* getUserdata() { return userdata_; }
55 sg_size_t read(sg_size_t size);
56 sg_size_t write(sg_size_t size);
57 surf::StorageImpl* getImpl() { return pimpl_; }
60 /** @brief Callback signal fired when a new Link is created */
61 static simgrid::xbt::signal<void(s4u::Storage&)> onCreation;
63 /** @brief Callback signal fired when a Link is destroyed */
64 static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
66 Host* attached_to_ = nullptr;
69 surf::StorageImpl* const pimpl_ = nullptr;
71 void* userdata_ = nullptr;
75 } /* namespace simgrid */
77 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */