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_
11 #include <simgrid/s4u/forward.hpp>
12 #include <simgrid/simix.h>
14 #include <unordered_map>
20 XBT_ATTRIB_PUBLIC std::map<std::string, Storage*>* allStorages();
22 XBT_PUBLIC_CLASS Storage
25 friend simgrid::surf::StorageImpl;
28 explicit Storage(surf::StorageImpl * pimpl) : pimpl_(pimpl) {}
29 virtual ~Storage() = default;
30 /** Retrieve a Storage by its name. It must exist in the platform file */
31 static Storage* byName(std::string name);
32 /** @brief Retrieves the name of that storage as a C++ string */
33 std::string const& getName() const;
34 /** @brief Retrieves the name of that storage as a C string */
35 const char* getCname() const;
36 const char* getType();
38 sg_size_t getSize(); /** Retrieve the total amount of space of this storage element */
39 sg_size_t getSizeFree();
40 sg_size_t getSizeUsed();
42 std::map<std::string, std::string>* getProperties();
43 const char* getProperty(std::string key);
44 void setProperty(std::string, std::string value);
45 std::map<std::string, sg_size_t>* getContent();
47 void setUserdata(void* data) { userdata_ = data; }
48 void* getUserdata() { return userdata_; }
50 surf::StorageImpl* getImpl() { return pimpl_; }
53 /** @brief Callback signal fired when a new Link is created */
54 static simgrid::xbt::signal<void(s4u::Storage&)> onCreation;
56 /** @brief Callback signal fired when a Link is destroyed */
57 static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
59 Host* attached_to_ = nullptr;
62 surf::StorageImpl* const pimpl_ = nullptr;
64 void* userdata_ = nullptr;
68 } /* namespace simgrid */
70 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */