-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
#include <simgrid/forward.h>
+#include <simgrid/s4u/Io.hpp>
#include <xbt/Extendable.hpp>
#include <xbt/base.h>
+#include <xbt/signal.hpp>
#include <map>
#include <string>
#include <unordered_map>
namespace simgrid {
-namespace xbt {
-extern template class XBT_PUBLIC Extendable<simgrid::s4u::Storage>;
-}
namespace s4u {
-XBT_ATTRIB_DEPRECATED_v322(
- "simgrid::s4u::getStorageList() is deprecated in favor of Engine::getAllStorages(). Please switch before v3.22")
- XBT_PUBLIC void getStorageList(std::map<std::string, Storage*>* whereTo);
+/** Storage represent the disk resources, usually associated to a given host
+ *
+ * By default, SimGrid does not keep track of the actual data being written but
+ * only computes the time taken by the corresponding data movement.
+ */
-class XBT_PUBLIC Storage : public simgrid::xbt::Extendable<Storage> {
- friend s4u::Engine;
- friend simgrid::surf::StorageImpl;
+class XBT_PUBLIC Storage : public xbt::Extendable<Storage> {
+ friend Engine;
+ friend Io;
+ friend kernel::resource::StorageImpl;
public:
- explicit Storage(std::string name, surf::StorageImpl * pimpl);
+ explicit Storage(const std::string& name, kernel::resource::StorageImpl* pimpl);
+
+protected:
virtual ~Storage() = default;
- /** Retrieve a Storage by its name. It must exist in the platform file */
- static Storage* byName(std::string name);
+public:
+ /** @brief Callback signal fired when a new Storage is created */
+ static xbt::signal<void(Storage&)> on_creation;
+ /** @brief Callback signal fired when a Storage is destroyed */
+ static xbt::signal<void(Storage const&)> on_destruction;
+ /** @brief Callback signal fired when a Storage's state changes */
+ static xbt::signal<void(Storage const&)> on_state_change;
- XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); }
- XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); }
+ /** Retrieve a Storage by its name. It must exist in the platform file */
+ static Storage* by_name(const std::string& name);
+ static Storage* by_name_or_null(const std::string& name);
/** @brief Retrieves the name of that storage as a C++ string */
- std::string const& get_name() const;
+ std::string const& get_name() const { return name_; }
/** @brief Retrieves the name of that storage as a C string */
- const char* get_cname() const;
+ const char* get_cname() const { return name_.c_str(); }
- const char* getType();
- Host* getHost();
+ const char* get_type();
+ Host* get_host() { return attached_to_; };
+ void set_host(Host* host) { attached_to_ = host; }
- std::map<std::string, std::string>* getProperties();
- const char* getProperty(std::string key);
- void setProperty(std::string, std::string value);
+ std::unordered_map<std::string, std::string>* get_properties();
+ const char* get_property(const std::string& key);
+ void set_property(const std::string&, const std::string& value);
- void setUserdata(void* data) { userdata_ = data; }
- void* getUserdata() { return userdata_; }
+ void set_data(void* data) { userdata_ = data; }
+ void* get_data() { return userdata_; }
- sg_size_t read(sg_size_t size);
- sg_size_t write(sg_size_t size);
- surf::StorageImpl* getImpl() { return pimpl_; }
+ IoPtr io_init(sg_size_t size, s4u::Io::OpType type);
- /* The signals */
- /** @brief Callback signal fired when a new Storage is created */
- static simgrid::xbt::signal<void(s4u::Storage&)> on_creation;
- /** @brief Callback signal fired when a Storage is destroyed */
- static simgrid::xbt::signal<void(s4u::Storage&)> on_destruction;
- /** @brief Callback signal fired when a Storage's state changes */
- static simgrid::xbt::signal<void(s4u::Storage&)> on_state_change;
+ IoPtr read_async(sg_size_t size);
+ sg_size_t read(sg_size_t size);
- Host* attached_to_ = nullptr;
+ IoPtr write_async(sg_size_t size);
+ sg_size_t write(sg_size_t size);
+ kernel::resource::StorageImpl* get_impl() const { return pimpl_; }
private:
- surf::StorageImpl* const pimpl_ = nullptr;
+ Host* attached_to_ = nullptr;
+ kernel::resource::StorageImpl* const pimpl_;
std::string name_;
void* userdata_ = nullptr;
};
-} /* namespace s4u */
-} /* namespace simgrid */
+} // namespace s4u
+} // namespace simgrid
#endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */
