1 /* Copyright (c) 2006-2015, 2017. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_
8 #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
10 #include "xbt/Extendable.hpp"
12 #include <simgrid/s4u/forward.hpp>
13 #include <simgrid/simix.h>
15 #include <unordered_map>
20 extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Storage>;
24 XBT_ATTRIB_PUBLIC std::map<std::string, Storage*>* allStorages();
26 XBT_PUBLIC_CLASS Storage : public simgrid::xbt::Extendable<Storage>
29 friend simgrid::surf::StorageImpl;
32 explicit Storage(surf::StorageImpl * pimpl) : pimpl_(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);
36 /** @brief Retrieves the name of that storage as a C++ string */
37 std::string const& getName() const;
38 /** @brief Retrieves the name of that storage as a C string */
39 const char* getCname() const;
40 const char* getType();
43 std::map<std::string, std::string>* getProperties();
44 const char* getProperty(std::string key);
45 void setProperty(std::string, std::string value);
47 void setUserdata(void* data) { userdata_ = data; }
48 void* getUserdata() { return userdata_; }
50 sg_size_t read(sg_size_t size);
51 sg_size_t write(sg_size_t size);
52 surf::StorageImpl* getImpl() { return pimpl_; }
55 /** @brief Callback signal fired when a new Link is created */
56 static simgrid::xbt::signal<void(s4u::Storage&)> onCreation;
58 /** @brief Callback signal fired when a Link is destroyed */
59 static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
61 Host* attached_to_ = nullptr;
64 surf::StorageImpl* const pimpl_ = nullptr;
66 void* userdata_ = nullptr;
70 } /* namespace simgrid */
72 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */