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 virtual Storage *createStorage(const char* id, const char* type_id,
68 const char* content_name, const char* content_type,
69 xbt_dict_t properties, const char *attach) = 0;
71 bool next_occuring_event_isIdempotent() {return true;}
73 std::vector<Storage*> p_storageList;
79 /** @ingroup SURF_storage_interface
80 * @brief SURF storage interface class
81 * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
83 class Storage : public simgrid::surf::Resource,
84 public simgrid::surf::PropertyHolder {
87 * @brief Storage constructor
89 * @param model StorageModel associated to this Storage
90 * @param name The name of the Storage
91 * @param props Dictionary of properties associated to this Storage
92 * @param type_id [description]
93 * @param content_name [description]
94 * @param content_type [description]
95 * @param size [description]
97 Storage(Model *model, const char *name, xbt_dict_t props,
98 const char* type_id, const char *content_name, const char *content_type,
102 * @brief Storage constructor
104 * @param model StorageModel associated to this Storage
105 * @param name The name of the Storage
106 * @param props Dictionary of properties associated to this Storage
108 Storage(Model *model, const char *name, xbt_dict_t props,
109 lmm_system_t maxminSystem, double bread, double bwrite,
111 const char* type_id, const char *content_name, const char *content_type,
112 sg_size_t size, const char *attach);
116 /** @brief Check if the Storage is used (if an action currently uses its resources) */
117 bool isUsed() override;
119 void apply_event(tmgr_trace_iterator_t event, double value) override;
121 void turnOn() override;
122 void turnOff() override;
129 char* attach_; //FIXME: this is the name of the host. Use the host directly
134 * @param mount The mount point
135 * @param path The path to the file
137 * @return The StorageAction corresponding to the opening
139 virtual StorageAction *open(const char* mount, const char* path)=0;
142 * @brief Close a file
144 * @param fd The file descriptor to close
145 * @return The StorageAction corresponding to the closing
147 virtual StorageAction *close(surf_file_t fd)=0;
152 * @param fd The file descriptor to read
153 * @param size The size in bytes to read
154 * @return The StorageAction corresponding to the reading
156 virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
159 * @brief Write a file
161 * @param fd The file descriptor to write
162 * @param size The size in bytes to write
163 * @return The StorageAction corresponding to the writing
165 virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
168 * @brief Get the content of the current Storage
170 * @return A xbt_dict_t with path as keys and size in bytes as values
172 virtual xbt_dict_t getContent();
175 * @brief Get the size in bytes of the current Storage
177 * @return The size in bytes of the current Storage
179 virtual sg_size_t getSize();
182 * @brief Get the available size in bytes of the current Storage
184 * @return The available size in bytes of the current Storage
186 virtual sg_size_t getFreeSize();
189 * @brief Get the used size in bytes of the current Storage
191 * @return The used size in bytes of the current Storage
193 virtual sg_size_t getUsedSize();
196 xbt_dict_t parseContent(const char *filename);
198 std::vector<StorageAction*> writeActions_;
200 lmm_constraint_t constraintWrite_; /* Constraint for maximum write bandwidth*/
201 lmm_constraint_t constraintRead_; /* Constraint for maximum write bandwidth*/
208 /** @ingroup SURF_storage_interface
209 * @brief The possible type of action for the storage component
212 READ=0, /**< Read a file */
213 WRITE, /**< Write in a file */
214 STAT, /**< Stat a file */
215 OPEN, /**< Open a file */
216 CLOSE /**< Close a file */
217 } e_surf_action_storage_type_t;
219 /** @ingroup SURF_storage_interface
220 * @brief SURF storage action interface class
222 class StorageAction : public Action {
225 * @brief StorageAction constructor
227 * @param model The StorageModel associated to this StorageAction
228 * @param cost The cost of this NetworkAction in [TODO]
229 * @param failed [description]
230 * @param storage The Storage associated to this StorageAction
231 * @param type [description]
233 StorageAction(Model *model, double cost, bool failed, Storage *storage,
234 e_surf_action_storage_type_t type);
237 * @brief StorageAction constructor
239 * @param model The StorageModel associated to this StorageAction
240 * @param cost The cost of this StorageAction in [TODO]
241 * @param failed [description]
242 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
243 * @param storage The Storage associated to this StorageAction
244 * @param type [description]
246 StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
247 Storage *storage, e_surf_action_storage_type_t type);
249 void setState(simgrid::surf::Action::State state) override;
251 e_surf_action_storage_type_t m_type;
260 typedef struct s_storage_type {
265 xbt_dict_t properties;
266 xbt_dict_t model_properties;
268 } s_storage_type_t, *storage_type_t;
270 typedef struct s_mount {
273 } s_mount_t, *mount_t;
275 typedef struct surf_file {
279 sg_size_t current_position;
282 #endif /* STORAGE_INTERFACE_HPP_ */