1 /* Copyright (c) 2006-2020. 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/s4u/Engine.hpp"
7 #include "simgrid/s4u/Host.hpp"
8 #include "simgrid/s4u/Io.hpp"
9 #include "simgrid/s4u/Storage.hpp"
10 #include "simgrid/simix.hpp"
11 #include "simgrid/storage.h"
12 #include "src/surf/StorageImpl.hpp"
16 template class xbt::Extendable<s4u::Storage>;
20 xbt::signal<void(Storage&)> Storage::on_creation;
21 xbt::signal<void(Storage const&)> Storage::on_destruction;
22 xbt::signal<void(Storage const&)> Storage::on_state_change;
24 Storage::Storage(const std::string& name, kernel::resource::StorageImpl* pimpl) : pimpl_(pimpl), name_(name)
26 Engine::get_instance()->storage_register(name_, this);
29 Storage* Storage::by_name(const std::string& name)
31 return Engine::get_instance()->storage_by_name(name);
34 Storage* Storage::by_name_or_null(const std::string& name)
36 return Engine::get_instance()->storage_by_name_or_null(name);
39 const char* Storage::get_type() const
41 return pimpl_->get_type();
44 const std::unordered_map<std::string, std::string>* Storage::get_properties() const
46 return pimpl_->get_properties();
49 const char* Storage::get_property(const std::string& key) const
51 return this->pimpl_->get_property(key);
54 void Storage::set_property(const std::string& key, const std::string& value)
56 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
59 IoPtr Storage::io_init(sg_size_t size, Io::OpType type)
61 return IoPtr(new Io(this, size, type));
64 IoPtr Storage::read_async(sg_size_t size)
66 return IoPtr(io_init(size, Io::OpType::READ))->start();
69 sg_size_t Storage::read(sg_size_t size)
71 return IoPtr(io_init(size, Io::OpType::READ))->start()->wait()->get_performed_ioops();
74 IoPtr Storage::write_async(sg_size_t size)
76 return IoPtr(io_init(size, Io::OpType::WRITE)->start());
79 sg_size_t Storage::write(sg_size_t size)
81 return IoPtr(io_init(size, Io::OpType::WRITE))->start()->wait()->get_performed_ioops();
85 } // namespace simgrid
87 /* **************************** Public C interface *************************** */
89 /** @addtogroup sg_storage_management
90 * (#sg_storage_t) and the functions for managing it.
93 /** @ingroup sg_storage_management
95 * @brief Returns the name of the #sg_storage_t.
97 * This functions checks whether a storage is a valid pointer or not and return its name.
99 const char* sg_storage_get_name(const_sg_storage_t storage)
101 xbt_assert((storage != nullptr), "Invalid parameters");
102 return storage->get_cname();
105 const char* sg_storage_get_host(const_sg_storage_t storage)
107 xbt_assert((storage != nullptr), "Invalid parameters");
108 return storage->get_host()->get_cname();
111 /** @ingroup sg_storage_management
112 * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
113 * @param storage a storage
114 * @return a dict containing the properties
116 xbt_dict_t sg_storage_get_properties(const_sg_storage_t storage)
118 xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)");
119 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
120 const std::unordered_map<std::string, std::string>* props = storage->get_properties();
121 if (props == nullptr)
123 for (auto const& elm : *props) {
124 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
129 /** @ingroup sg_storage_management
130 * @brief Change the value of a given storage property
132 * @param storage a storage
133 * @param name a property name
134 * @param value what to change the property to
136 void sg_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
138 storage->set_property(name, value);
141 /** @ingroup sg_storage_management
142 * @brief Returns the value of a given storage property
144 * @param storage a storage
145 * @param name a property name
146 * @return value of a property (or nullptr if property not set)
148 const char* sg_storage_get_property_value(const_sg_storage_t storage, const char* name)
150 return storage->get_property(name);
153 /** @ingroup sg_storage_management
154 * @brief Finds a sg_storage_t using its name.
155 * @param name the name of a storage
156 * @return the corresponding storage
158 sg_storage_t sg_storage_get_by_name(const char* name)
160 return simgrid::s4u::Storage::by_name(name);
163 /** @ingroup sg_storage_management
164 * @brief Returns a dynar containing all the storage elements declared at a given point of time
166 xbt_dynar_t sg_storages_as_dynar()
168 std::vector<simgrid::s4u::Storage*> storage_list = simgrid::s4u::Engine::get_instance()->get_all_storages();
169 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_storage_t), nullptr);
170 for (auto const& s : storage_list)
171 xbt_dynar_push(res, &s);
175 void* sg_storage_get_data(const_sg_storage_t storage)
177 xbt_assert((storage != nullptr), "Invalid parameters");
178 return storage->get_data();
181 void sg_storage_set_data(sg_storage_t storage, void* data)
183 storage->set_data(data);
186 sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size)
188 return storage->read(size);
191 sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size)
193 return storage->write(size);