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, int previouslyOn, int currentlyOn)`
48 XBT_PUBLIC_DATA(simgrid::surf::signal<void(simgrid::surf::Storage*, int, int)>) 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, const char *content_name, const 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, const char *content_name, const char *content_type,
135 sg_size_t size, const 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 turnOn() override;
152 void turnOff() override;
154 xbt_dict_t p_content;
157 sg_size_t m_usedSize;
159 char* p_attach; //FIXME: this is the name of the host. Use the host directly
164 * @param mount The mount point
165 * @param path The path to the file
167 * @return The StorageAction corresponding to the opening
169 virtual StorageAction *open(const char* mount, const char* path)=0;
172 * @brief Close a file
174 * @param fd The file descriptor to close
175 * @return The StorageAction corresponding to the closing
177 virtual StorageAction *close(surf_file_t fd)=0;
182 * @param fd The file descriptor to read
183 * @param size The size in bytes to read
184 * @return The StorageAction corresponding to the reading
186 virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
189 * @brief Write a file
191 * @param fd The file descriptor to write
192 * @param size The size in bytes to write
193 * @return The StorageAction corresponding to the writing
195 virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
198 * @brief Get the content of the current Storage
200 * @return A xbt_dict_t with path as keys and size in bytes as values
202 virtual xbt_dict_t getContent();
205 * @brief Get the size in bytes of the current Storage
207 * @return The size in bytes of the current Storage
209 virtual sg_size_t getSize();
212 * @brief Get the available size in bytes of the current Storage
214 * @return The available size in bytes of the current Storage
216 virtual sg_size_t getFreeSize();
219 * @brief Get the used size in bytes of the current Storage
221 * @return The used size in bytes of the current Storage
223 virtual sg_size_t getUsedSize();
226 xbt_dict_t parseContent(const char *filename);
228 xbt_dynar_t p_writeActions;
230 lmm_constraint_t p_constraintWrite; /* Constraint for maximum write bandwidth*/
231 lmm_constraint_t p_constraintRead; /* Constraint for maximum write bandwidth*/
238 /** @ingroup SURF_storage_interface
239 * @brief The possible type of action for the storage component
242 READ=0, /**< Read a file */
243 WRITE, /**< Write in a file */
244 STAT, /**< Stat a file */
245 OPEN, /**< Open a file */
246 CLOSE /**< Close a file */
247 } e_surf_action_storage_type_t;
249 /** @ingroup SURF_storage_interface
250 * @brief SURF storage action interface class
252 class StorageAction : public Action {
255 * @brief StorageAction constructor
257 * @param model The StorageModel associated to this StorageAction
258 * @param cost The cost of this NetworkAction in [TODO]
259 * @param failed [description]
260 * @param storage The Storage associated to this StorageAction
261 * @param type [description]
263 StorageAction(Model *model, double cost, bool failed, Storage *storage,
264 e_surf_action_storage_type_t type);
267 * @brief StorageAction constructor
269 * @param model The StorageModel associated to this StorageAction
270 * @param cost The cost of this StorageAction in [TODO]
271 * @param failed [description]
272 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
273 * @param storage The Storage associated to this StorageAction
274 * @param type [description]
276 StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
277 Storage *storage, e_surf_action_storage_type_t type);
279 void setState(e_surf_action_state_t state);
281 e_surf_action_storage_type_t m_type;
290 typedef struct s_storage_type {
295 xbt_dict_t properties;
296 xbt_dict_t model_properties;
298 } s_storage_type_t, *storage_type_t;
300 typedef struct s_mount {
303 } s_mount_t, *mount_t;
305 typedef struct surf_file {
309 sg_size_t current_position;
313 #endif /* STORAGE_INTERFACE_HPP_ */