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 std::vector<Storage*> p_storageList;
77 /** @ingroup SURF_storage_interface
78 * @brief SURF storage interface class
79 * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
81 class Storage : public simgrid::surf::Resource,
82 public simgrid::surf::PropertyHolder {
85 * @brief Storage constructor
87 * @param model StorageModel associated to this Storage
88 * @param name The name of the Storage
89 * @param props Dictionary of properties associated to this Storage
90 * @param type_id [description]
91 * @param content_name [description]
92 * @param content_type [description]
93 * @param size [description]
95 Storage(Model *model, const char *name, xbt_dict_t props,
96 const char* type_id, const char *content_name, const char *content_type,
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
106 Storage(Model *model, const char *name, xbt_dict_t props,
107 lmm_system_t maxminSystem, double bread, double bwrite,
109 const char* type_id, const char *content_name, const char *content_type,
110 sg_size_t size, const char *attach);
114 /** @brief Check if the Storage is used (if an action currently uses its resources) */
115 bool isUsed() override;
117 void apply_event(tmgr_trace_iterator_t event, double value) override;
119 void turnOn() override;
120 void turnOff() override;
127 char* attach_; //FIXME: this is the name of the host. Use the host directly
132 * @param mount The mount point
133 * @param path The path to the file
135 * @return The StorageAction corresponding to the opening
137 virtual StorageAction *open(const char* mount, const char* path)=0;
140 * @brief Close a file
142 * @param fd The file descriptor to close
143 * @return The StorageAction corresponding to the closing
145 virtual StorageAction *close(surf_file_t fd)=0;
150 * @param fd The file descriptor to read
151 * @param size The size in bytes to read
152 * @return The StorageAction corresponding to the reading
154 virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
157 * @brief Write a file
159 * @param fd The file descriptor to write
160 * @param size The size in bytes to write
161 * @return The StorageAction corresponding to the writing
163 virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
166 * @brief Get the content of the current Storage
168 * @return A xbt_dict_t with path as keys and size in bytes as values
170 virtual xbt_dict_t getContent();
173 * @brief Get the size in bytes of the current Storage
175 * @return The size in bytes of the current Storage
177 virtual sg_size_t getSize();
180 * @brief Get the available size in bytes of the current Storage
182 * @return The available size in bytes of the current Storage
184 virtual sg_size_t getFreeSize();
187 * @brief Get the used size in bytes of the current Storage
189 * @return The used size in bytes of the current Storage
191 virtual sg_size_t getUsedSize();
194 xbt_dict_t parseContent(const char *filename);
196 std::vector<StorageAction*> writeActions_;
198 lmm_constraint_t constraintWrite_; /* Constraint for maximum write bandwidth*/
199 lmm_constraint_t constraintRead_; /* Constraint for maximum write bandwidth*/
206 /** @ingroup SURF_storage_interface
207 * @brief The possible type of action for the storage component
210 READ=0, /**< Read a file */
211 WRITE, /**< Write in a file */
212 STAT, /**< Stat a file */
213 OPEN, /**< Open a file */
214 CLOSE /**< Close a file */
215 } e_surf_action_storage_type_t;
217 /** @ingroup SURF_storage_interface
218 * @brief SURF storage action interface class
220 class StorageAction : public Action {
223 * @brief StorageAction constructor
225 * @param model The StorageModel associated to this StorageAction
226 * @param cost The cost of this NetworkAction in [TODO]
227 * @param failed [description]
228 * @param storage The Storage associated to this StorageAction
229 * @param type [description]
231 StorageAction(Model *model, double cost, bool failed, Storage *storage,
232 e_surf_action_storage_type_t type);
235 * @brief StorageAction constructor
237 * @param model The StorageModel associated to this StorageAction
238 * @param cost The cost of this StorageAction in [TODO]
239 * @param failed [description]
240 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
241 * @param storage The Storage associated to this StorageAction
242 * @param type [description]
244 StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
245 Storage *storage, e_surf_action_storage_type_t type);
247 void setState(simgrid::surf::Action::State state) override;
249 e_surf_action_storage_type_t m_type;
258 typedef struct s_storage_type {
263 xbt_dict_t properties;
264 xbt_dict_t model_properties;
266 } s_storage_type_t, *storage_type_t;
268 typedef struct s_mount {
271 } s_mount_t, *mount_t;
273 typedef struct surf_file {
277 sg_size_t current_position;
280 #endif /* STORAGE_INTERFACE_HPP_ */