1 /* Copyright (c) 2004-2014. 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 #include "surf_interface.hpp"
9 #ifndef STORAGE_INTERFACE_HPP_
10 #define STORAGE_INTERFACE_HPP_
12 extern xbt_dynar_t mount_list;
19 typedef StorageModel *StorageModelPtr;
22 typedef Storage *StoragePtr;
25 typedef Storage *StoragePtr;
28 typedef StorageAction *StorageActionPtr;
31 typedef StorageAction *StorageActionPtr;
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)`
41 extern surf_callback(void, StoragePtr) storageCreatedCallbacks;
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)`
47 extern surf_callback(void, StoragePtr) storageDestructedCallbacks;
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)`
53 extern surf_callback(void, StoragePtr) storageStateChangedCallbacks;
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)`
59 extern surf_callback(void, StorageActionPtr) storageActionStateChangedCallbacks;
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
68 class StorageModel : public Model {
71 * @brief The storage model constructor
76 * @brief The Storange model destructor
81 * @brief Create a Storage
83 * @param id [description]
84 * @param type_id [description]
85 * @param content_name [description]
86 * @param content_type [description]
87 * @param properties [description]
88 * @param attach [description]
89 * @return The created Storage
91 virtual StoragePtr createResource(const char* id,
93 const char* content_name,
94 const char* content_type,
95 xbt_dict_t properties,
96 const char *attach) = 0;
98 xbt_dynar_t p_storageList;
104 /** @ingroup SURF_storage_interface
105 * @brief SURF storage interface class
106 * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
108 class Storage : public Resource {
111 * @brief Storage constructor
113 * @param model StorageModel associated to this Storage
114 * @param name The name of the Storage
115 * @param props Dictionary of properties associated to this Storage
116 * @param type_id [description]
117 * @param content_name [description]
118 * @param content_type [description]
119 * @param size [description]
121 Storage(ModelPtr model, const char *name, xbt_dict_t props,
122 const char* type_id, char *content_name, char *content_type,
126 * @brief Storage constructor
128 * @param model StorageModel associated to this Storage
129 * @param name The name of the Storage
130 * @param props Dictionary of properties associated to this Storage
131 * @param maxminSystem [description]
132 * @param bread [description]
133 * @param bwrite [description]
134 * @param bconnection [description]
135 * @param type_id [description]
136 * @param content_name [description]
137 * @param content_type [description]
138 * @param size [description]
139 * @param attach [description]
141 Storage(ModelPtr model, const char *name, xbt_dict_t props,
142 lmm_system_t maxminSystem, double bread, double bwrite,
144 const char* type_id, char *content_name, char *content_type,
145 sg_size_t size, char *attach);
148 * @brief Storage destructor
153 * @brief Check if the Storage is used
155 * @return true if the current Storage is used, false otherwise
160 * @brief Update the state of the current Storage
162 * @param event_type [description]
163 * @param value [description]
164 * @param date [description]
166 void updateState(tmgr_trace_event_t event_type, double value, double date);
168 void setState(e_surf_resource_state_t state);
170 xbt_dict_t p_content;
173 sg_size_t m_usedSize;
180 * @param mount The mount point
181 * @param path The path to the file
183 * @return The StorageAction corresponding to the opening
185 virtual StorageActionPtr open(const char* mount, const char* path)=0;
188 * @brief Close a file
190 * @param fd The file descriptor to close
191 * @return The StorageAction corresponding to the closing
193 virtual StorageActionPtr close(surf_file_t fd)=0;
196 * @brief List directory contents of a path
197 * @details [long description]
199 * @param path The path to the directory
200 * @return The StorageAction corresponding to the ls action
202 virtual StorageActionPtr ls(const char *path)=0;
207 * @param fd The file descriptor to read
208 * @param size The size in bytes to read
209 * @return The StorageAction corresponding to the reading
211 virtual StorageActionPtr read(surf_file_t fd, sg_size_t size)=0;
214 * @brief Write a file
216 * @param fd The file descriptor to write
217 * @param size The size in bytes to write
218 * @return The StorageAction corresponding to the writing
220 virtual StorageActionPtr write(surf_file_t fd, sg_size_t size)=0;
223 * @brief Rename a path
225 * @param src The old path
226 * @param dest The new path
228 virtual void rename(const char *src, const char *dest)=0;
231 * @brief Get the content of the current Storage
233 * @return A xbt_dict_t with path as keys and size in bytes as values
235 virtual xbt_dict_t getContent();
238 * @brief Get the size in bytes of the current Storage
240 * @return The size in bytes of the current Storage
242 virtual sg_size_t getSize();
244 xbt_dict_t parseContent(char *filename);
246 xbt_dynar_t p_writeActions;
248 lmm_constraint_t p_constraintWrite; /* Constraint for maximum write bandwidth*/
249 lmm_constraint_t p_constraintRead; /* Constraint for maximum write bandwidth*/
256 /** @ingroup SURF_storage_interface
257 * @brief The possible type of action for the storage component
260 READ=0, /**< Read a file */
261 WRITE, /**< Write in a file */
262 STAT, /**< Stat a file */
263 OPEN, /**< Open a file */
264 CLOSE, /**< Close a file */
265 LS /**< List directory contents */
266 } e_surf_action_storage_type_t;
268 /** @ingroup SURF_storage_interface
269 * @brief SURF storage action interface class
271 class StorageAction : public Action {
274 * @brief StorageAction constructor
276 StorageAction() : m_type(READ) {};//FIXME:REMOVE
279 * @brief StorageAction constructor
281 * @param model The StorageModel associated to this StorageAction
282 * @param cost The cost of this NetworkAction in [TODO]
283 * @param failed [description]
284 * @param storage The Storage associated to this StorageAction
285 * @param type [description]
287 StorageAction(ModelPtr model, double cost, bool failed,
288 StoragePtr storage, e_surf_action_storage_type_t type);
291 * @brief StorageAction constructor
293 * @param model The StorageModel associated to this StorageAction
294 * @param cost The cost of this StorageAction in [TODO]
295 * @param failed [description]
296 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
297 * @param storage The Storage associated to this StorageAction
298 * @param type [description]
300 StorageAction(ModelPtr model, double cost, bool failed, lmm_variable_t var,
301 StoragePtr storage, e_surf_action_storage_type_t type);
303 void setState(e_surf_action_state_t state);
305 e_surf_action_storage_type_t m_type;
306 StoragePtr p_storage;
311 typedef struct s_storage_type {
316 xbt_dict_t properties;
317 xbt_dict_t model_properties;
319 } s_storage_type_t, *storage_type_t;
321 typedef struct s_mount {
324 } s_mount_t, *mount_t;
326 typedef struct surf_file {
330 sg_size_t current_position;
334 #endif /* STORAGE_INTERFACE_HPP_ */