1 /* Copyright (c) 2004-2017. 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 "src/surf/PropertyHolder.hpp"
11 #include "surf_interface.hpp"
14 #ifndef STORAGE_INTERFACE_HPP_
15 #define STORAGE_INTERFACE_HPP_
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::xbt::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::xbt::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::xbt::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, simgrid::surf::Action::State old, simgrid::surf::Action::State current)`
54 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::StorageAction*, simgrid::surf::Action::State, simgrid::surf::Action::State)>) 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 virtual Storage* createStorage(const char* id, const char* type_id, const char* content_name,
69 const char* content_type, 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 {
86 * @brief Storage constructor
88 * @param model StorageModel associated to this Storage
89 * @param name The name of the Storage
90 * @param props Dictionary of properties associated to this Storage
92 Storage(Model* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite, double bconnection,
93 const char* type_id, const char* content_name, const char* content_type, sg_size_t size, const char* attach);
97 /** @brief Check if the Storage is used (if an action currently uses its resources) */
98 bool isUsed() override;
100 void apply_event(tmgr_trace_iterator_t event, double value) override;
102 void turnOn() override;
103 void turnOff() override;
105 std::map<std::string, sg_size_t*>* content_;
110 char* attach_; //FIXME: this is the name of the host. Use the host directly
115 * @param mount The mount point
116 * @param path The path to the file
118 * @return The StorageAction corresponding to the opening
120 virtual StorageAction *open(const char* mount, const char* path)=0;
123 * @brief Close a file
125 * @param fd The file descriptor to close
126 * @return The StorageAction corresponding to the closing
128 virtual StorageAction *close(surf_file_t fd)=0;
133 * @param fd The file descriptor to read
134 * @param size The size in bytes to read
135 * @return The StorageAction corresponding to the reading
137 virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
140 * @brief Write a file
142 * @param fd The file descriptor to write
143 * @param size The size in bytes to write
144 * @return The StorageAction corresponding to the writing
146 virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
149 * @brief Get the content of the current Storage
151 * @return A xbt_dict_t with path as keys and size in bytes as values
153 virtual xbt_dict_t getContent();
156 * @brief Get the available size in bytes of the current Storage
158 * @return The available size in bytes of the current Storage
160 virtual sg_size_t getFreeSize();
163 * @brief Get the used size in bytes of the current Storage
165 * @return The used size in bytes of the current Storage
167 virtual sg_size_t getUsedSize();
169 std::map<std::string, sg_size_t*>* parseContent(const char* filename);
171 std::vector<StorageAction*> writeActions_;
173 lmm_constraint_t constraintWrite_; /* Constraint for maximum write bandwidth*/
174 lmm_constraint_t constraintRead_; /* Constraint for maximum write bandwidth*/
181 /** @ingroup SURF_storage_interface
182 * @brief The possible type of action for the storage component
185 READ=0, /**< Read a file */
186 WRITE, /**< Write in a file */
187 STAT, /**< Stat a file */
188 OPEN, /**< Open a file */
189 CLOSE /**< Close a file */
190 } e_surf_action_storage_type_t;
192 /** @ingroup SURF_storage_interface
193 * @brief SURF storage action interface class
195 class StorageAction : public Action {
198 * @brief StorageAction constructor
200 * @param model The StorageModel associated to this StorageAction
201 * @param cost The cost of this NetworkAction in [TODO]
202 * @param failed [description]
203 * @param storage The Storage associated to this StorageAction
204 * @param type [description]
206 StorageAction(Model *model, double cost, bool failed, Storage *storage,
207 e_surf_action_storage_type_t type);
210 * @brief StorageAction constructor
212 * @param model The StorageModel associated to this StorageAction
213 * @param cost The cost of this StorageAction in [TODO]
214 * @param failed [description]
215 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
216 * @param storage The Storage associated to this StorageAction
217 * @param type [description]
219 StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
220 Storage *storage, e_surf_action_storage_type_t type);
222 void setState(simgrid::surf::Action::State state) override;
224 e_surf_action_storage_type_t type_;
233 typedef struct s_storage_type {
238 xbt_dict_t properties;
239 std::map<std::string, std::string>* model_properties;
242 typedef s_storage_type_t* storage_type_t;
244 typedef struct s_mount {
248 typedef s_mount_t* mount_t;
250 typedef struct surf_file {
254 sg_size_t current_position;
257 #endif /* STORAGE_INTERFACE_HPP_ */