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, const char* content_name,
68 const char* content_type, const char* attach) = 0;
70 std::vector<Storage*> p_storageList;
76 /** @ingroup SURF_storage_interface
77 * @brief SURF storage interface class
78 * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
80 class Storage : public simgrid::surf::Resource,
81 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
91 Storage(Model* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite, double bconnection,
92 const char* type_id, const char* content_name, const char* content_type, sg_size_t size, const char* attach);
96 /** @brief Check if the Storage is used (if an action currently uses its resources) */
97 bool isUsed() override;
99 void apply_event(tmgr_trace_iterator_t event, double value) override;
101 void turnOn() override;
102 void turnOff() override;
109 char* attach_; //FIXME: this is the name of the host. Use the host directly
114 * @param mount The mount point
115 * @param path The path to the file
117 * @return The StorageAction corresponding to the opening
119 virtual StorageAction *open(const char* mount, const char* path)=0;
122 * @brief Close a file
124 * @param fd The file descriptor to close
125 * @return The StorageAction corresponding to the closing
127 virtual StorageAction *close(surf_file_t fd)=0;
132 * @param fd The file descriptor to read
133 * @param size The size in bytes to read
134 * @return The StorageAction corresponding to the reading
136 virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
139 * @brief Write a file
141 * @param fd The file descriptor to write
142 * @param size The size in bytes to write
143 * @return The StorageAction corresponding to the writing
145 virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
148 * @brief Get the content of the current Storage
150 * @return A xbt_dict_t with path as keys and size in bytes as values
152 virtual xbt_dict_t getContent();
155 * @brief Get the size in bytes of the current Storage
157 * @return The size in bytes of the current Storage
159 virtual sg_size_t getSize();
162 * @brief Get the available size in bytes of the current Storage
164 * @return The available size in bytes of the current Storage
166 virtual sg_size_t getFreeSize();
169 * @brief Get the used size in bytes of the current Storage
171 * @return The used size in bytes of the current Storage
173 virtual sg_size_t getUsedSize();
176 xbt_dict_t parseContent(const char *filename);
178 std::vector<StorageAction*> writeActions_;
180 lmm_constraint_t constraintWrite_; /* Constraint for maximum write bandwidth*/
181 lmm_constraint_t constraintRead_; /* Constraint for maximum write bandwidth*/
188 /** @ingroup SURF_storage_interface
189 * @brief The possible type of action for the storage component
192 READ=0, /**< Read a file */
193 WRITE, /**< Write in a file */
194 STAT, /**< Stat a file */
195 OPEN, /**< Open a file */
196 CLOSE /**< Close a file */
197 } e_surf_action_storage_type_t;
199 /** @ingroup SURF_storage_interface
200 * @brief SURF storage action interface class
202 class StorageAction : public Action {
205 * @brief StorageAction constructor
207 * @param model The StorageModel associated to this StorageAction
208 * @param cost The cost of this NetworkAction in [TODO]
209 * @param failed [description]
210 * @param storage The Storage associated to this StorageAction
211 * @param type [description]
213 StorageAction(Model *model, double cost, bool failed, Storage *storage,
214 e_surf_action_storage_type_t type);
217 * @brief StorageAction constructor
219 * @param model The StorageModel associated to this StorageAction
220 * @param cost The cost of this StorageAction in [TODO]
221 * @param failed [description]
222 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
223 * @param storage The Storage associated to this StorageAction
224 * @param type [description]
226 StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
227 Storage *storage, e_surf_action_storage_type_t type);
229 void setState(simgrid::surf::Action::State state) override;
231 e_surf_action_storage_type_t type_;
240 typedef struct s_storage_type {
245 xbt_dict_t properties;
246 xbt_dict_t model_properties;
248 } s_storage_type_t, *storage_type_t;
250 typedef struct s_mount {
253 } s_mount_t, *mount_t;
255 typedef struct surf_file {
259 sg_size_t current_position;
262 #endif /* STORAGE_INTERFACE_HPP_ */