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. */
8 #include <xbt/signal.hpp>
10 #include "surf_interface.hpp"
11 #include "src/surf/PropertyHolder.hpp"
13 #ifndef STORAGE_INTERFACE_HPP_
14 #define STORAGE_INTERFACE_HPP_
31 /** @ingroup SURF_callbacks
32 * @brief Callbacks handler which emit the callbacks after Storage creation *
33 * @details Callback functions have the following signature: `void(Storage*)`
35 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*)>) storageCreatedCallbacks;
37 /** @ingroup SURF_callbacks
38 * @brief Callbacks handler which emit the callbacks after Storage destruction *
39 * @details Callback functions have the following signature: `void(StoragePtr)`
41 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*)>) storageDestructedCallbacks;
43 /** @ingroup SURF_callbacks
44 * @brief Callbacks handler which emit the callbacks after Storage State changed *
45 * @details Callback functions have the following signature: `void(StorageAction *action, int previouslyOn, int currentlyOn)`
47 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*, int, int)>) storageStateChangedCallbacks;
49 /** @ingroup SURF_callbacks
50 * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
51 * @details Callback functions have the following signature: `void(StorageAction *action, simgrid::surf::Action::State old, simgrid::surf::Action::State current)`
53 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::StorageAction*, simgrid::surf::Action::State, simgrid::surf::Action::State)>) storageActionStateChangedCallbacks;
58 /** @ingroup SURF_storage_interface
59 * @brief SURF storage model interface class
60 * @details A model is an object which handle the interactions between its Resources and its Actions
62 class StorageModel : public Model {
67 /** @brief Create a Storage
69 * @param id [description]
70 * @param type_id [description]
71 * @param content_name [description]
72 * @param content_type [description]
73 * @param properties [description]
74 * @param attach [description]
75 * @return The created Storage
77 virtual Storage *createStorage(const char* id,
79 const char* content_name,
80 const char* content_type,
81 xbt_dict_t properties,
82 const char *attach) = 0;
84 bool next_occuring_event_isIdempotent() {return true;}
86 xbt_dynar_t p_storageList;
92 /** @ingroup SURF_storage_interface
93 * @brief SURF storage interface class
94 * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
96 class Storage : public simgrid::surf::Resource,
97 public simgrid::surf::PropertyHolder {
100 * @brief Storage constructor
102 * @param model StorageModel associated to this Storage
103 * @param name The name of the Storage
104 * @param props Dictionary of properties associated to this Storage
105 * @param type_id [description]
106 * @param content_name [description]
107 * @param content_type [description]
108 * @param size [description]
110 Storage(Model *model, const char *name, xbt_dict_t props,
111 const char* type_id, const char *content_name, const char *content_type,
115 * @brief Storage constructor
117 * @param model StorageModel associated to this Storage
118 * @param name The name of the Storage
119 * @param props Dictionary of properties associated to this Storage
120 * @param maxminSystem [description]
121 * @param bread [description]
122 * @param bwrite [description]
123 * @param bconnection [description]
124 * @param type_id [description]
125 * @param content_name [description]
126 * @param content_type [description]
127 * @param size [description]
128 * @param attach [description]
130 Storage(Model *model, const char *name, xbt_dict_t props,
131 lmm_system_t maxminSystem, double bread, double bwrite,
133 const char* type_id, const char *content_name, const char *content_type,
134 sg_size_t size, const char *attach);
138 /** @brief Check if the Storage is used (if an action currently uses its resources) */
139 bool isUsed() override;
141 void apply_event(tmgr_trace_iterator_t event, double value) override;
143 void turnOn() override;
144 void turnOff() override;
146 xbt_dict_t p_content;
149 sg_size_t m_usedSize;
151 char* p_attach; //FIXME: this is the name of the host. Use the host directly
156 * @param mount The mount point
157 * @param path The path to the file
159 * @return The StorageAction corresponding to the opening
161 virtual StorageAction *open(const char* mount, const char* path)=0;
164 * @brief Close a file
166 * @param fd The file descriptor to close
167 * @return The StorageAction corresponding to the closing
169 virtual StorageAction *close(surf_file_t fd)=0;
174 * @param fd The file descriptor to read
175 * @param size The size in bytes to read
176 * @return The StorageAction corresponding to the reading
178 virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
181 * @brief Write a file
183 * @param fd The file descriptor to write
184 * @param size The size in bytes to write
185 * @return The StorageAction corresponding to the writing
187 virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
190 * @brief Get the content of the current Storage
192 * @return A xbt_dict_t with path as keys and size in bytes as values
194 virtual xbt_dict_t getContent();
197 * @brief Get the size in bytes of the current Storage
199 * @return The size in bytes of the current Storage
201 virtual sg_size_t getSize();
204 * @brief Get the available size in bytes of the current Storage
206 * @return The available size in bytes of the current Storage
208 virtual sg_size_t getFreeSize();
211 * @brief Get the used size in bytes of the current Storage
213 * @return The used size in bytes of the current Storage
215 virtual sg_size_t getUsedSize();
218 xbt_dict_t parseContent(const char *filename);
220 xbt_dynar_t p_writeActions;
222 lmm_constraint_t p_constraintWrite; /* Constraint for maximum write bandwidth*/
223 lmm_constraint_t p_constraintRead; /* Constraint for maximum write bandwidth*/
230 /** @ingroup SURF_storage_interface
231 * @brief The possible type of action for the storage component
234 READ=0, /**< Read a file */
235 WRITE, /**< Write in a file */
236 STAT, /**< Stat a file */
237 OPEN, /**< Open a file */
238 CLOSE /**< Close a file */
239 } e_surf_action_storage_type_t;
241 /** @ingroup SURF_storage_interface
242 * @brief SURF storage action interface class
244 class StorageAction : public Action {
247 * @brief StorageAction constructor
249 * @param model The StorageModel associated to this StorageAction
250 * @param cost The cost of this NetworkAction in [TODO]
251 * @param failed [description]
252 * @param storage The Storage associated to this StorageAction
253 * @param type [description]
255 StorageAction(Model *model, double cost, bool failed, Storage *storage,
256 e_surf_action_storage_type_t type);
259 * @brief StorageAction constructor
261 * @param model The StorageModel associated to this StorageAction
262 * @param cost The cost of this StorageAction in [TODO]
263 * @param failed [description]
264 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
265 * @param storage The Storage associated to this StorageAction
266 * @param type [description]
268 StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
269 Storage *storage, e_surf_action_storage_type_t type);
271 void setState(simgrid::surf::Action::State state) override;
273 e_surf_action_storage_type_t m_type;
282 typedef struct s_storage_type {
287 xbt_dict_t properties;
288 xbt_dict_t model_properties;
290 } s_storage_type_t, *storage_type_t;
292 typedef struct s_mount {
295 } s_mount_t, *mount_t;
297 typedef struct surf_file {
301 sg_size_t current_position;
305 #endif /* STORAGE_INTERFACE_HPP_ */