1 /* Copyright (c) 2004-2015. 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. */
9 #include "surf_interface.hpp"
10 #include "src/surf/PropertyHolder.hpp"
12 #ifndef STORAGE_INTERFACE_HPP_
13 #define STORAGE_INTERFACE_HPP_
15 extern xbt_dynar_t mount_list;
32 /** @ingroup SURF_callbacks
33 * @brief Callbacks handler which emit the callbacks after Storage creation *
34 * @details Callback functions have the following signature: `void(Storage*)`
36 XBT_PUBLIC_DATA(surf_callback(void, simgrid::surf::Storage*)) storageCreatedCallbacks;
38 /** @ingroup SURF_callbacks
39 * @brief Callbacks handler which emit the callbacks after Storage destruction *
40 * @details Callback functions have the following signature: `void(StoragePtr)`
42 XBT_PUBLIC_DATA(surf_callback(void, simgrid::surf::Storage*)) storageDestructedCallbacks;
44 /** @ingroup SURF_callbacks
45 * @brief Callbacks handler which emit the callbacks after Storage State changed *
46 * @details Callback functions have the following signature: `void(StorageAction *action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
48 XBT_PUBLIC_DATA(surf_callback(void, simgrid::surf::Storage*, e_surf_resource_state_t, e_surf_resource_state_t)) storageStateChangedCallbacks;
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, e_surf_action_state_t old, e_surf_action_state_t current)`
54 XBT_PUBLIC_DATA(surf_callback(void, simgrid::surf::StorageAction*, e_surf_action_state_t, e_surf_action_state_t)) storageActionStateChangedCallbacks;
59 /** @ingroup SURF_storage_interface
60 * @brief SURF storage model interface class
61 * @details A model is an object which handle the interactions between its Resources and its Actions
63 class StorageModel : public Model {
66 * @brief The storage model constructor
71 * @brief The Storange model destructor
76 * @brief Create a Storage
78 * @param id [description]
79 * @param type_id [description]
80 * @param content_name [description]
81 * @param content_type [description]
82 * @param properties [description]
83 * @param attach [description]
84 * @return The created Storage
86 virtual Storage *createStorage(const char* id,
88 const char* content_name,
89 const char* content_type,
90 xbt_dict_t properties,
91 const char *attach) = 0;
93 bool shareResourcesIsIdempotent() {return true;}
95 xbt_dynar_t p_storageList;
101 /** @ingroup SURF_storage_interface
102 * @brief SURF storage interface class
103 * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
105 class Storage : public simgrid::surf::Resource, public simgrid::surf::PropertyHolder {
108 * @brief Storage constructor
110 * @param model StorageModel associated to this Storage
111 * @param name The name of the Storage
112 * @param props Dictionary of properties associated to this Storage
113 * @param type_id [description]
114 * @param content_name [description]
115 * @param content_type [description]
116 * @param size [description]
118 Storage(Model *model, const char *name, xbt_dict_t props,
119 const char* type_id, char *content_name, char *content_type,
123 * @brief Storage constructor
125 * @param model StorageModel associated to this Storage
126 * @param name The name of the Storage
127 * @param props Dictionary of properties associated to this Storage
128 * @param maxminSystem [description]
129 * @param bread [description]
130 * @param bwrite [description]
131 * @param bconnection [description]
132 * @param type_id [description]
133 * @param content_name [description]
134 * @param content_type [description]
135 * @param size [description]
136 * @param attach [description]
138 Storage(Model *model, const char *name, xbt_dict_t props,
139 lmm_system_t maxminSystem, double bread, double bwrite,
141 const char* type_id, char *content_name, char *content_type,
142 sg_size_t size, char *attach);
145 * @brief Storage destructor
150 * @brief Check if the Storage is used
152 * @return true if the current Storage is used, false otherwise
157 * @brief Update the state of the current Storage
159 * @param event_type [description]
160 * @param value [description]
161 * @param date [description]
163 void updateState(tmgr_trace_event_t event_type, double value, double date);
165 void setState(e_surf_resource_state_t state);
167 xbt_dict_t p_content;
170 sg_size_t m_usedSize;
177 * @param mount The mount point
178 * @param path The path to the file
180 * @return The StorageAction corresponding to the opening
182 virtual StorageAction *open(const char* mount, const char* path)=0;
185 * @brief Close a file
187 * @param fd The file descriptor to close
188 * @return The StorageAction corresponding to the closing
190 virtual StorageAction *close(surf_file_t fd)=0;
195 * @param fd The file descriptor to read
196 * @param size The size in bytes to read
197 * @return The StorageAction corresponding to the reading
199 virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
202 * @brief Write a file
204 * @param fd The file descriptor to write
205 * @param size The size in bytes to write
206 * @return The StorageAction corresponding to the writing
208 virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
211 * @brief Get the content of the current Storage
213 * @return A xbt_dict_t with path as keys and size in bytes as values
215 virtual xbt_dict_t getContent();
218 * @brief Get the size in bytes of the current Storage
220 * @return The size in bytes of the current Storage
222 virtual sg_size_t getSize();
225 * @brief Get the available size in bytes of the current Storage
227 * @return The available size in bytes of the current Storage
229 virtual sg_size_t getFreeSize();
232 * @brief Get the used size in bytes of the current Storage
234 * @return The used size in bytes of the current Storage
236 virtual sg_size_t getUsedSize();
239 xbt_dict_t parseContent(char *filename);
241 xbt_dynar_t p_writeActions;
243 lmm_constraint_t p_constraintWrite; /* Constraint for maximum write bandwidth*/
244 lmm_constraint_t p_constraintRead; /* Constraint for maximum write bandwidth*/
251 /** @ingroup SURF_storage_interface
252 * @brief The possible type of action for the storage component
255 READ=0, /**< Read a file */
256 WRITE, /**< Write in a file */
257 STAT, /**< Stat a file */
258 OPEN, /**< Open a file */
259 CLOSE /**< Close a file */
260 } e_surf_action_storage_type_t;
262 /** @ingroup SURF_storage_interface
263 * @brief SURF storage action interface class
265 class StorageAction : public Action {
268 * @brief StorageAction constructor
270 * @param model The StorageModel associated to this StorageAction
271 * @param cost The cost of this NetworkAction in [TODO]
272 * @param failed [description]
273 * @param storage The Storage associated to this StorageAction
274 * @param type [description]
276 StorageAction(Model *model, double cost, bool failed, Storage *storage,
277 e_surf_action_storage_type_t type);
280 * @brief StorageAction constructor
282 * @param model The StorageModel associated to this StorageAction
283 * @param cost The cost of this StorageAction in [TODO]
284 * @param failed [description]
285 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
286 * @param storage The Storage associated to this StorageAction
287 * @param type [description]
289 StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
290 Storage *storage, e_surf_action_storage_type_t type);
292 void setState(e_surf_action_state_t state);
294 e_surf_action_storage_type_t m_type;
303 typedef struct s_storage_type {
308 xbt_dict_t properties;
309 xbt_dict_t model_properties;
311 } s_storage_type_t, *storage_type_t;
313 typedef struct s_mount {
316 } s_mount_t, *mount_t;
318 typedef struct surf_file {
322 sg_size_t current_position;
326 #endif /* STORAGE_INTERFACE_HPP_ */