1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "simgrid/kernel/resource/Action.hpp"
7 #include "simgrid/kernel/resource/Model.hpp"
8 #include "simgrid/kernel/resource/Resource.hpp"
9 #include "simgrid/s4u/Io.hpp"
10 #include "simgrid/s4u/Storage.hpp"
11 #include "src/kernel/resource/profile/trace_mgr.hpp"
12 #include "src/surf/PropertyHolder.hpp"
13 #include "surf_interface.hpp"
17 #ifndef STORAGE_INTERFACE_HPP_
18 #define STORAGE_INTERFACE_HPP_
24 XBT_PUBLIC_DATA simgrid::kernel::resource::StorageModel* surf_storage_model;
34 /** @ingroup SURF_storage_interface
35 * @brief The possible type of action for the storage component
41 /** @ingroup SURF_callbacks
42 * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
43 * @details Callback functions have the following signature: `void(StorageAction *action,
44 * simgrid::kernel::resource::Action::State old, simgrid::kernel::resource::Action::State current)`
47 simgrid::xbt::signal<void(StorageAction*, kernel::resource::Action::State, kernel::resource::Action::State)>
53 /** @ingroup SURF_storage_interface
54 * @brief SURF storage model interface class
55 * @details A model is an object which handle the interactions between its Resources and its Actions
57 class StorageModel : public kernel::resource::Model {
60 StorageModel(const StorageModel&) = delete;
61 StorageModel& operator=(const StorageModel&) = delete;
64 virtual StorageImpl* createStorage(const std::string& id, const std::string& type_id, const std::string& content_name,
65 const std::string& attach) = 0;
71 /** @ingroup SURF_storage_interface
72 * @brief SURF storage interface class
73 * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
75 class StorageImpl : public Resource, public surf::PropertyHolder {
77 /** @brief Storage constructor */
78 StorageImpl(Model* model, const std::string& name, kernel::lmm::System* maxmin_system, double bread, double bwrite,
79 const std::string& type_id, const std::string& content_name, sg_size_t size, const std::string& attach);
80 StorageImpl(const StorageImpl&) = delete;
81 StorageImpl& operator=(const StorageImpl&) = delete;
83 ~StorageImpl() override;
85 /** @brief Public interface */
88 /** @brief Check if the Storage is used (if an action currently uses its resources) */
89 bool is_used() override;
91 void apply_event(profile::Event* event, double value) override;
93 void turn_on() override;
94 void turn_off() override;
96 void destroy(); // Must be called instead of the destructor
97 virtual Action* io_start(sg_size_t size, s4u::Io::OpType type) = 0;
101 * @param size The size in bytes to read
102 * @return The StorageAction corresponding to the reading
104 virtual StorageAction* read(sg_size_t size) = 0;
107 * @brief Write a file
109 * @param size The size in bytes to write
110 * @return The StorageAction corresponding to the writing
112 virtual StorageAction* write(sg_size_t size) = 0;
113 virtual std::string getHost() { return attach_; }
115 lmm::Constraint* constraintWrite_; /* Constraint for maximum write bandwidth*/
116 lmm::Constraint* constraintRead_; /* Constraint for maximum write bandwidth*/
119 std::string content_name; // Only used at parsing time then goes to the FileSystemExtension
120 sg_size_t size_; // Only used at parsing time then goes to the FileSystemExtension
123 bool currentlyDestroying_ = false;
124 // Name of the host to which this storage is attached. Only used at platform parsing time, then the interface stores
125 // the Host directly.
133 /** @ingroup SURF_storage_interface
134 * @brief SURF storage action interface class
136 class StorageAction : public Action {
138 static xbt::signal<void(StorageAction*, Action::State, Action::State)> on_state_change;
141 * @brief StorageAction constructor
143 * @param model The StorageModel associated to this StorageAction
144 * @param cost The cost of this StorageAction in bytes
145 * @param failed [description]
146 * @param storage The Storage associated to this StorageAction
147 * @param type [description]
149 StorageAction(Model* model, double cost, bool failed, StorageImpl* storage, s4u::Io::OpType type)
150 : Action(model, cost, failed), type_(type), storage_(storage){};
153 * @brief StorageAction constructor
155 * @param model The StorageModel associated to this StorageAction
156 * @param cost The cost of this StorageAction in [TODO]
157 * @param failed [description]
158 * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
159 * @param storage The Storage associated to this StorageAction
160 * @param type [description]
162 StorageAction(kernel::resource::Model* model, double cost, bool failed, kernel::lmm::Variable* var,
163 StorageImpl* storage, s4u::Io::OpType type)
164 : Action(model, cost, failed, var), type_(type), storage_(storage){};
166 void set_state(simgrid::kernel::resource::Action::State state) override;
168 s4u::Io::OpType type_;
169 StorageImpl* storage_;
177 std::unordered_map<std::string, std::string>* properties;
178 std::unordered_map<std::string, std::string>* model_properties;
180 StorageType(const std::string& id, const std::string& model, const std::string& content,
181 std::unordered_map<std::string, std::string>* properties,
182 std::unordered_map<std::string, std::string>* model_properties, sg_size_t size)
183 : id(id), model(model), content(content), properties(properties), model_properties(model_properties), size(size)
188 } // namespace resource
189 } // namespace kernel
190 } // namespace simgrid
191 #endif /* STORAGE_INTERFACE_HPP_ */