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(simgrid::surf::signal<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(simgrid::surf::signal<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(simgrid::surf::signal<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(simgrid::surf::signal<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 {
68 /** @brief Create a Storage
70 * @param id [description]
71 * @param type_id [description]
72 * @param content_name [description]
73 * @param content_type [description]
74 * @param properties [description]
75 * @param attach [description]
76 * @return The created Storage
78 virtual Storage *createStorage(const char* id,
80 const char* content_name,
81 const char* content_type,
82 xbt_dict_t properties,
83 const char *attach) = 0;
85 bool shareResourcesIsIdempotent() {return true;}
87 xbt_dynar_t p_storageList;
93 /** @ingroup SURF_storage_interface
94 * @brief SURF storage interface class
95 * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
97 class Storage : public simgrid::surf::Resource,
98 public simgrid::surf::PropertyHolder {
101 * @brief Storage constructor
103 * @param model StorageModel associated to this Storage
104 * @param name The name of the Storage
105 * @param props Dictionary of properties associated to this Storage
106 * @param type_id [description]
107 * @param content_name [description]
108 * @param content_type [description]
109 * @param size [description]
111 Storage(Model *model, const char *name, xbt_dict_t props,
112 const char* type_id, char *content_name, char *content_type,
116 * @brief Storage constructor
118 * @param model StorageModel associated to this Storage
119 * @param name The name of the Storage
120 * @param props Dictionary of properties associated to this Storage
121 * @param maxminSystem [description]
122 * @param bread [description]
123 * @param bwrite [description]
124 * @param bconnection [description]
125 * @param type_id [description]
126 * @param content_name [description]
127 * @param content_type [description]
128 * @param size [description]
129 * @param attach [description]
131 Storage(Model *model, const char *name, xbt_dict_t props,
132 lmm_system_t maxminSystem, double bread, double bwrite,
134 const char* type_id, char *content_name, char *content_type,
135 sg_size_t size, char *attach);
139 /** @brief Check if the Storage is used (if an action currently uses its resources) */
143 * @brief Update the state of the current Storage
145 * @param event_type [description]
146 * @param value [description]
147 * @param date [description]
149 void updateState(tmgr_trace_event_t event_type, double value, double date);
151 void setState(e_surf_resource_state_t state);
153 xbt_dict_t p_content;
156 sg_size_t m_usedSize;
163 * @param mount The mount point
164 * @param path The path to the file
166 * @return The StorageAction corresponding to the opening
168 virtual StorageAction *open(const char* mount, const char* path)=0;
171 * @brief Close a file
173 * @param fd The file descriptor to close
174 * @return The StorageAction corresponding to the closing
176 virtual StorageAction *close(surf_file_t fd)=0;
181 * @param fd The file descriptor to read
182 * @param size The size in bytes to read
183 * @return The StorageAction corresponding to the reading
185 virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
188 * @brief Write a file
190 * @param fd The file descriptor to write
191 * @param size The size in bytes to write
192 * @return The StorageAction corresponding to the writing
194 virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
197 * @brief Get the content of the current Storage
199 * @return A xbt_dict_t with path as keys and size in bytes as values
201 virtual xbt_dict_t getContent();
204 * @brief Get the size in bytes of the current Storage
206 * @return The size in bytes of the current Storage
208 virtual sg_size_t getSize();
211 * @brief Get the available size in bytes of the current Storage
213 * @return The available size in bytes of the current Storage
215 virtual sg_size_t getFreeSize();
218 * @brief Get the used size in bytes of the current Storage
220 * @return The used size in bytes of the current Storage
222 virtual sg_size_t getUsedSize();
225 xbt_dict_t parseContent(char *filename);
227 xbt_dynar_t p_writeActions;
229 lmm_constraint_t p_constraintWrite; /* Constraint for maximum write bandwidth*/
230 lmm_constraint_t p_constraintRead; /* Constraint for maximum write bandwidth*/
237 /** @ingroup SURF_storage_interface
238 * @brief The possible type of action for the storage component
241 READ=0, /**< Read a file */
242 WRITE, /**< Write in a file */
243 STAT, /**< Stat a file */
244 OPEN, /**< Open a file */
245 CLOSE /**< Close a file */
246 } e_surf_action_storage_type_t;
248 /** @ingroup SURF_storage_interface
249 * @brief SURF storage action interface class
251 class StorageAction : public Action {
254 * @brief StorageAction constructor
256 * @param model The StorageModel associated to this StorageAction
257 * @param cost The cost of this NetworkAction in [TODO]
258 * @param failed [description]
259 * @param storage The Storage associated to this StorageAction
260 * @param type [description]
262 StorageAction(Model *model, double cost, bool failed, Storage *storage,
263 e_surf_action_storage_type_t type);
266 * @brief StorageAction constructor
268 * @param model The StorageModel associated to this StorageAction
269 * @param cost The cost of this StorageAction in [TODO]
270 * @param failed [description]
271 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
272 * @param storage The Storage associated to this StorageAction
273 * @param type [description]
275 StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
276 Storage *storage, e_surf_action_storage_type_t type);
278 void setState(e_surf_action_state_t state);
280 e_surf_action_storage_type_t m_type;
289 typedef struct s_storage_type {
294 xbt_dict_t properties;
295 xbt_dict_t model_properties;
297 } s_storage_type_t, *storage_type_t;
299 typedef struct s_mount {
302 } s_mount_t, *mount_t;
304 typedef struct surf_file {
308 sg_size_t current_position;
312 #endif /* STORAGE_INTERFACE_HPP_ */