Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
bd0cd4f176daa02720120b75eafe18e582973f22
[simgrid.git] / src / surf / storage_interface.hpp
1 /* Copyright (c) 2004-2014. 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 "surf_interface.hpp"
8
9 #ifndef STORAGE_INTERFACE_HPP_
10 #define STORAGE_INTERFACE_HPP_
11
12 extern xbt_dynar_t mount_list;
13
14 /***********
15  * Classes *
16  ***********/
17
18 class StorageModel;
19 typedef StorageModel *StorageModelPtr;
20
21 class Storage;
22 typedef Storage *StoragePtr;
23
24 class Storage;
25 typedef Storage *StoragePtr;
26
27 class StorageAction;
28 typedef StorageAction *StorageActionPtr;
29
30 class StorageAction;
31 typedef StorageAction *StorageActionPtr;
32
33 /*************
34  * Callbacks *
35  *************/
36
37 /** @ingroup SURF_callbacks
38  * @brief Callbacks handler which emit the callbacks after Storage creation *
39  * @details Callback functions have the following signature: `void(StoragePtr)`
40  */
41 extern surf_callback(void, StoragePtr) storageCreatedCallbacks;
42
43 /** @ingroup SURF_callbacks
44  * @brief Callbacks handler which emit the callbacks after Storage destruction *
45  * @details Callback functions have the following signature: `void(StoragePtr)`
46  */
47 extern surf_callback(void, StoragePtr) storageDestructedCallbacks;
48
49 /** @ingroup SURF_callbacks
50  * @brief Callbacks handler which emit the callbacks after Storage State changed *
51  * @details Callback functions have the following signature: `void(StorageActionPtr)`
52  */
53 extern surf_callback(void, StoragePtr) storageStateChangedCallbacks;
54
55 /** @ingroup SURF_callbacks
56  * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
57  * @details Callback functions have the following signature: `void(StorageActionPtr)`
58  */
59 extern surf_callback(void, StorageActionPtr) storageActionStateChangedCallbacks;
60
61 /*********
62  * Model *
63  *********/
64 /** @ingroup SURF_storage_interface
65  * @brief SURF storage model interface class
66  * @details A model is an object which handle the interactions between its Resources and its Actions
67  */
68 class StorageModel : public Model {
69 public:
70   /**
71    * @brief The storage model constructor
72    */
73   StorageModel();
74
75   /**
76    * @brief The Storange model destructor
77    */
78   ~StorageModel();
79
80   /**
81    * @brief Create a Storage
82    * 
83    * @param id [description]
84    * @param type_id [description]
85    * @param content_name [description]
86    * @param content_type [description]
87    * @param properties [description]
88    * @return The created Storage
89    */
90   virtual StoragePtr createResource(const char* id, const char* type_id,
91                    const char* content_name, const char* content_type, xbt_dict_t properties)=0;
92
93   xbt_dynar_t p_storageList;
94 };
95
96 /************
97  * Resource *
98  ************/
99 /** @ingroup SURF_storage_interface
100  * @brief SURF storage interface class
101  * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
102  */
103 class Storage : public Resource {
104 public:
105   /**
106    * @brief Storage constructor
107    * 
108    * @param model StorageModel associated to this Storage
109    * @param name The name of the Storage
110    * @param props Dictionary of properties associated to this Storage
111    * @param type_id [description]
112    * @param content_name [description]
113    * @param content_type [description]
114    * @param size [description]
115    * @param model_props Dictionary of model specific properties associated to this Storage
116    */
117   Storage(ModelPtr model, const char *name, xbt_dict_t props,
118           const char* type_id, char *content_name, char *content_type,
119           sg_size_t size);
120
121   /**
122    * @brief Storage constructor
123    * 
124    * @param model StorageModel associated to this Storage
125    * @param name The name of the Storage
126    * @param props Dictionary of properties associated to this Storage
127    * @param maxminSystem [description]
128    * @param bread [description]
129    * @param bwrite [description]
130    * @param bconnection [description]
131    * @param type_id [description]
132    * @param content_name [description]
133    * @param content_type [description]
134    * @param size [description]
135    */
136   Storage(ModelPtr model, const char *name, xbt_dict_t props,
137           lmm_system_t maxminSystem, double bread, double bwrite,
138           double bconnection,
139           const char* type_id, char *content_name, char *content_type,
140           sg_size_t size);
141
142   /**
143    * @brief Storage destructor
144    */
145   ~Storage();
146
147   /**
148    * @brief Check if the Storage is used
149    * 
150    * @return true if the current Storage is used, false otherwise
151    */
152   bool isUsed();
153
154   /**
155    * @brief Update the state of the current Storage
156    * 
157    * @param event_type [description]
158    * @param value [description]
159    * @param date [description]
160    */
161   void updateState(tmgr_trace_event_t event_type, double value, double date);
162
163   void setState(e_surf_resource_state_t state);
164
165   xbt_dict_t p_content;
166   char* p_contentType;
167   sg_size_t m_size;
168   sg_size_t m_usedSize;
169   char * p_typeId;
170
171   /**
172    * @brief Open a file
173    * 
174    * @param mount The mount point
175    * @param path The path to the file
176    * 
177    * @return The StorageAction corresponding to the opening
178    */
179   virtual StorageActionPtr open(const char* mount, const char* path)=0;
180
181   /**
182    * @brief Close a file
183    * 
184    * @param fd The file descriptor to close
185    * @return The StorageAction corresponding to the closing
186    */
187   virtual StorageActionPtr close(surf_file_t fd)=0;
188
189   /**
190    * @brief List directory contents of a path
191    * @details [long description]
192    * 
193    * @param path The path to the directory
194    * @return The StorageAction corresponding to the ls action
195    */
196   virtual StorageActionPtr ls(const char *path)=0;
197
198   /**
199    * @brief Read a file
200    * 
201    * @param fd The file descriptor to read
202    * @param size The size in bytes to read
203    * @return The StorageAction corresponding to the reading
204    */
205   virtual StorageActionPtr read(surf_file_t fd, sg_size_t size)=0;
206
207   /**
208    * @brief Write a file
209    * 
210    * @param fd The file descriptor to write
211    * @param size The size in bytes to write
212    * @return The StorageAction corresponding to the writing
213    */
214   virtual StorageActionPtr write(surf_file_t fd, sg_size_t size)=0;
215
216   /**
217    * @brief Rename a path
218    * 
219    * @param src The old path
220    * @param dest The new path
221    */
222   virtual void rename(const char *src, const char *dest)=0;
223
224   /**
225    * @brief Get the content of the current Storage
226    * 
227    * @return A xbt_dict_t with path as keys and size in bytes as values
228    */
229   virtual xbt_dict_t getContent();
230
231   /**
232    * @brief Get the size in bytes of the current Storage
233    * 
234    * @return The size in bytes of the current Storage
235    */
236   virtual sg_size_t getSize();
237
238   xbt_dict_t parseContent(char *filename);
239
240   xbt_dynar_t p_writeActions;
241
242   lmm_constraint_t p_constraintWrite;    /* Constraint for maximum write bandwidth*/
243   lmm_constraint_t p_constraintRead;     /* Constraint for maximum write bandwidth*/
244 };
245
246 /**********
247  * Action *
248  **********/
249
250 /** @ingroup SURF_storage_interface
251  * @brief The possible type of action for the storage component
252  */
253 typedef enum {
254   READ=0, /**< Read a file */
255   WRITE,  /**< Write in a file */
256   STAT,   /**< Stat a file */
257   OPEN,   /**< Open a file */
258   CLOSE,  /**< Close a file */
259   LS      /**< List directory contents */
260 } e_surf_action_storage_type_t;
261
262 /** @ingroup SURF_storage_interface
263  * @brief SURF storage action interface class
264  */
265 class StorageAction : public Action {
266 public:
267   /**
268    * @brief StorageAction constructor
269    */
270   StorageAction() : m_type(READ) {};//FIXME:REMOVE
271
272   /**
273    * @brief StorageAction constructor
274    * 
275    * @param model The StorageModel associated to this StorageAction
276    * @param cost The cost of this  NetworkAction in [TODO]
277    * @param failed [description]
278    * @param storage The Storage associated to this StorageAction
279    * @param type [description]
280    */
281   StorageAction(ModelPtr model, double cost, bool failed,
282                             StoragePtr storage, e_surf_action_storage_type_t type);
283
284     /**
285    * @brief StorageAction constructor
286    * 
287    * @param model The StorageModel associated to this StorageAction
288    * @param cost The cost of this  StorageAction in [TODO]
289    * @param failed [description]
290    * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
291    * @param storage The Storage associated to this StorageAction
292    * @param type [description]
293    */
294   StorageAction(ModelPtr model, double cost, bool failed, lmm_variable_t var,
295                             StoragePtr storage, e_surf_action_storage_type_t type);
296
297   void setState(e_surf_action_state_t state);
298
299   e_surf_action_storage_type_t m_type;
300   StoragePtr p_storage;
301   surf_file_t p_file;
302   xbt_dict_t p_lsDict;
303 };
304
305 typedef struct s_storage_type {
306   char *model;
307   char *content;
308   char *content_type;
309   char *type_id;
310   xbt_dict_t properties;
311   xbt_dict_t model_properties;
312   sg_size_t size;
313 } s_storage_type_t, *storage_type_t;
314
315 typedef struct s_mount {
316   void *storage;
317   char *name;
318 } s_mount_t, *mount_t;
319
320 typedef struct surf_file {
321   char *name;
322   char *mount;
323   sg_size_t size;
324   sg_size_t current_position;
325 } s_surf_file_t;
326
327
328 #endif /* STORAGE_INTERFACE_HPP_ */