Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'actor-yield' of github.com:Takishipp/simgrid into actor-yield
[simgrid.git] / src / surf / StorageImpl.hpp
1 /* Copyright (c) 2004-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 #include <xbt/base.h>
8 #include <xbt/signal.hpp>
9
10 #include "simgrid/s4u/Storage.hpp"
11 #include "src/surf/PropertyHolder.hpp"
12 #include "surf_interface.hpp"
13 #include <map>
14
15 #ifndef STORAGE_INTERFACE_HPP_
16 #define STORAGE_INTERFACE_HPP_
17
18 namespace simgrid {
19 namespace surf {
20
21 /***********
22  * Classes *
23  ***********/
24
25 class StorageAction;
26
27 /*************
28  * Callbacks *
29  *************/
30
31 /** @ingroup SURF_callbacks
32  * @brief Callbacks handler which emit the callbacks after Storage creation *
33  * @details Callback functions have the following signature: `void(Storage*)`
34  */
35 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(StorageImpl*)>) storageCreatedCallbacks;
36
37 /** @ingroup SURF_callbacks
38  * @brief Callbacks handler which emit the callbacks after Storage destruction *
39  * @details Callback functions have the following signature: `void(StoragePtr)`
40  */
41 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(StorageImpl*)>) storageDestructedCallbacks;
42
43 /** @ingroup SURF_callbacks
44  * @brief Callbacks handler which emit the callbacks after Storage State changed *
45  * @details Callback functions have the following signature: `void(StorageAction *action, int previouslyOn, int
46  * currentlyOn)`
47  */
48 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(StorageImpl*, int, int)>) storageStateChangedCallbacks;
49
50 /** @ingroup SURF_callbacks
51  * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
52  * @details Callback functions have the following signature: `void(StorageAction *action, simgrid::surf::Action::State
53  * old, simgrid::surf::Action::State current)`
54  */
55 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(StorageAction*, Action::State, Action::State)>)
56 storageActionStateChangedCallbacks;
57
58 /*********
59  * Model *
60  *********/
61 /** @ingroup SURF_storage_interface
62  * @brief SURF storage model interface class
63  * @details A model is an object which handle the interactions between its Resources and its Actions
64  */
65 class StorageModel : public Model {
66 public:
67   StorageModel();
68   ~StorageModel();
69
70   virtual StorageImpl* createStorage(std::string id, std::string type_id, std::string content_name,
71                                      std::string attach) = 0;
72
73   std::vector<StorageImpl*> p_storageList;
74 };
75
76 /************
77  * Resource *
78  ************/
79 /** @ingroup SURF_storage_interface
80  * @brief SURF storage interface class
81  * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
82  */
83 class StorageImpl : public Resource, public PropertyHolder {
84 public:
85   /** @brief Storage constructor */
86   StorageImpl(Model* model, std::string name, lmm_system_t maxminSystem, double bread, double bwrite,
87               std::string type_id, std::string content_name, sg_size_t size, std::string attach);
88
89   ~StorageImpl() override;
90
91   /** @brief Public interface */
92   s4u::Storage piface_;
93   static StorageImpl* byName(std::string name);
94
95   /** @brief Check if the Storage is used (if an action currently uses its resources) */
96   bool isUsed() override;
97
98   void apply_event(tmgr_trace_event_t event, double value) override;
99
100   void turnOn() override;
101   void turnOff() override;
102
103   /**
104    * @brief Read a file
105    *
106    * @param size The size in bytes to read
107    * @return The StorageAction corresponding to the reading
108    */
109   virtual StorageAction* read(sg_size_t size) = 0;
110
111   /**
112    * @brief Write a file
113    *
114    * @param size The size in bytes to write
115    * @return The StorageAction corresponding to the writing
116    */
117   virtual StorageAction* write(sg_size_t size) = 0;
118
119   /**
120    * @brief Get the content of the current Storage
121    *
122    * @return A map with path as keys and size in bytes as values
123    */
124   virtual std::map<std::string, sg_size_t>* getContent();
125
126   /**
127    * @brief Get the available size in bytes of the current Storage
128    *
129    * @return The available size in bytes of the current Storage
130    */
131   virtual sg_size_t getFreeSize();
132
133   /**
134    * @brief Get the used size in bytes of the current Storage
135    *
136    * @return The used size in bytes of the current Storage
137    */
138   virtual sg_size_t getUsedSize();
139   virtual sg_size_t getSize() { return size_; }
140   virtual std::string getHost() { return attach_; }
141
142   std::map<std::string, sg_size_t>* parseContent(std::string filename);
143   static std::unordered_map<std::string, StorageImpl*>* storagesMap() { return StorageImpl::storages; }
144
145   lmm_constraint_t constraintWrite_; /* Constraint for maximum write bandwidth*/
146   lmm_constraint_t constraintRead_;  /* Constraint for maximum write bandwidth*/
147
148   std::string typeId_;
149   sg_size_t usedSize_ = 0;
150
151 private:
152   sg_size_t size_;
153   static std::unordered_map<std::string, StorageImpl*>* storages;
154   std::map<std::string, sg_size_t>* content_;
155   // Name of the host to which this storage is attached. Only used at platform parsing time, then the interface stores
156   // the Host directly.
157   std::string attach_;
158 };
159
160 /**********
161  * Action *
162  **********/
163
164 /** @ingroup SURF_storage_interface
165  * @brief The possible type of action for the storage component
166  */
167 enum e_surf_action_storage_type_t {
168   READ = 0, /**< Read a file */
169   WRITE     /**< Write in a file */
170 };
171
172 /** @ingroup SURF_storage_interface
173  * @brief SURF storage action interface class
174  */
175 class StorageAction : public Action {
176 public:
177   /**
178    * @brief StorageAction constructor
179    *
180    * @param model The StorageModel associated to this StorageAction
181    * @param cost The cost of this  NetworkAction in [TODO]
182    * @param failed [description]
183    * @param storage The Storage associated to this StorageAction
184    * @param type [description]
185    */
186   StorageAction(Model* model, double cost, bool failed, StorageImpl* storage, e_surf_action_storage_type_t type)
187       : Action(model, cost, failed), type_(type), storage_(storage){};
188
189   /**
190  * @brief StorageAction constructor
191  *
192  * @param model The StorageModel associated to this StorageAction
193  * @param cost The cost of this  StorageAction in [TODO]
194  * @param failed [description]
195  * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
196  * @param storage The Storage associated to this StorageAction
197  * @param type [description]
198  */
199   StorageAction(Model* model, double cost, bool failed, lmm_variable_t var, StorageImpl* storage,
200                 e_surf_action_storage_type_t type)
201       : Action(model, cost, failed, var), type_(type), storage_(storage){};
202
203   void setState(simgrid::surf::Action::State state) override;
204
205   e_surf_action_storage_type_t type_;
206   StorageImpl* storage_;
207 };
208
209 class StorageType {
210 public:
211   std::string id;
212   std::string model;
213   std::string content;
214   std::map<std::string, std::string>* properties;
215   std::map<std::string, std::string>* model_properties;
216   sg_size_t size;
217   StorageType(std::string id, std::string model, std::string content, std::map<std::string, std::string>* properties,
218               std::map<std::string, std::string>* model_properties, sg_size_t size)
219       : id(id), model(model), content(content), properties(properties), model_properties(model_properties), size(size)
220   {
221   }
222 };
223 }
224 }
225
226 #endif /* STORAGE_INTERFACE_HPP_ */