Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
854e0f9ab9d41c322eef9799e669aeec6e987755
[simgrid.git] / include / simgrid / s4u / Storage.hpp
1 /* Copyright (c) 2006-2015, 2017. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_
8 #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
9
10 #include <map>
11 #include <simgrid/s4u/forward.hpp>
12 #include <simgrid/simix.h>
13 #include <string>
14 #include <unordered_map>
15 #include <xbt/base.h>
16
17 namespace simgrid {
18 namespace s4u {
19
20 XBT_ATTRIB_PUBLIC std::map<std::string, Storage*>* allStorages();
21
22 XBT_PUBLIC_CLASS Storage
23 {
24   friend s4u::Engine;
25   friend simgrid::surf::StorageImpl;
26
27 public:
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(const char* name);
32   const char* getName();
33   const char* getType();
34   Host* getHost();
35   sg_size_t getSize(); /** Retrieve the total amount of space of this storage element */
36   sg_size_t getSizeFree();
37   sg_size_t getSizeUsed();
38
39   xbt_dict_t getProperties();
40   const char* getProperty(const char* key);
41   void setProperty(const char* key, char* value);
42   std::map<std::string, sg_size_t>* getContent();
43
44   void setUserdata(void* data) { userdata_ = data; }
45   void* getUserdata() { return userdata_; }
46
47   surf::StorageImpl* getImpl() { return pimpl_; }
48
49   /* The signals */
50   /** @brief Callback signal fired when a new Link is created */
51   static simgrid::xbt::signal<void(s4u::Storage&)> onCreation;
52
53   /** @brief Callback signal fired when a Link is destroyed */
54   static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
55
56   Host* attached_to_              = nullptr;
57
58 private:
59   surf::StorageImpl* const pimpl_ = nullptr;
60   std::string name_;
61   void* userdata_ = nullptr;
62 };
63
64 } /* namespace s4u */
65 } /* namespace simgrid */
66
67 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */