1 /* Copyright (c) 2006-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 #ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_
7 #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
9 #include <simgrid/forward.h>
10 #include <simgrid/s4u/Io.hpp>
11 #include <xbt/Extendable.hpp>
13 #include <xbt/signal.hpp>
17 #include <unordered_map>
22 /** Storage represent the disk resources, usually associated to a given host
24 * By default, SimGrid does not keep track of the actual data being written but
25 * only computes the time taken by the corresponding data movement.
28 class XBT_PUBLIC Storage : public xbt::Extendable<Storage> {
31 friend kernel::resource::StorageImpl;
34 explicit Storage(const std::string& name, kernel::resource::StorageImpl* pimpl);
37 virtual ~Storage() = default;
39 /** @brief Callback signal fired when a new Storage is created */
40 static xbt::signal<void(Storage&)> on_creation;
41 /** @brief Callback signal fired when a Storage is destroyed */
42 static xbt::signal<void(Storage const&)> on_destruction;
43 /** @brief Callback signal fired when a Storage's state changes */
44 static xbt::signal<void(Storage const&)> on_state_change;
46 /** Retrieve a Storage by its name. It must exist in the platform file */
47 static Storage* by_name(const std::string& name);
48 static Storage* by_name_or_null(const std::string& name);
50 /** @brief Retrieves the name of that storage as a C++ string */
51 std::string const& get_name() const { return name_; }
52 /** @brief Retrieves the name of that storage as a C string */
53 const char* get_cname() const { return name_.c_str(); }
55 const char* get_type();
56 Host* get_host() { return attached_to_; };
57 void set_host(Host* host) { attached_to_ = host; }
59 const std::unordered_map<std::string, std::string>* get_properties() const;
60 const char* get_property(const std::string& key) const;
61 void set_property(const std::string&, const std::string& value);
63 void set_data(void* data) { userdata_ = data; }
64 void* get_data() { return userdata_; }
66 IoPtr io_init(sg_size_t size, s4u::Io::OpType type);
68 IoPtr read_async(sg_size_t size);
69 sg_size_t read(sg_size_t size);
71 IoPtr write_async(sg_size_t size);
72 sg_size_t write(sg_size_t size);
73 kernel::resource::StorageImpl* get_impl() const { return pimpl_; }
76 Host* attached_to_ = nullptr;
77 kernel::resource::StorageImpl* const pimpl_;
79 void* userdata_ = nullptr;
83 } // namespace simgrid
85 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */