1 /* Copyright (c) 2006-2018. 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/storage.h"
11 #include "src/surf/StorageImpl.hpp"
15 template class Extendable<simgrid::s4u::Storage>;
20 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_creation;
21 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_destruction;
22 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_state_change;
24 Storage::Storage(std::string name, surf::StorageImpl* pimpl) : pimpl_(pimpl), name_(name)
26 simgrid::s4u::Engine::get_instance()->storage_register(name, this);
29 Storage* Storage::by_name(std::string name)
31 return Engine::get_instance()->storage_by_name(name);
34 Storage* Storage::by_name_or_null(std::string name)
36 return Engine::get_instance()->storage_by_name_or_null(name);
39 const char* Storage::get_type()
41 return pimpl_->typeId_.c_str();
44 std::unordered_map<std::string, std::string>* Storage::get_properties()
46 return simgrid::simix::simcall([this] { return pimpl_->get_properties(); });
49 const char* Storage::get_property(std::string key)
51 return this->pimpl_->get_property(key);
54 void Storage::set_property(std::string key, std::string value)
56 simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
59 IoPtr Storage::io_init(sg_size_t size, Io::OpType type)
61 IoPtr res = IoPtr(new Io(size, type));
66 sg_size_t Storage::read(sg_size_t size)
68 IoPtr i = io_init(size, Io::OpType::READ);
70 return i->get_performed_ioops();
73 sg_size_t Storage::write(sg_size_t size)
75 IoPtr i = io_init(size, Io::OpType::WRITE);
77 return i->get_performed_ioops();
80 // Deprecated functions
81 void getStorageList(std::map<std::string, Storage*>* whereTo)
83 for (auto const& s : simgrid::s4u::Engine::get_instance()->get_all_storages())
84 whereTo->insert({s->get_name(), s});
88 } /* namespace simgrid */
90 /* **************************** Public C interface *************************** */
92 /** @addtogroup sg_storage_management
93 * (#sg_storage_t) and the functions for managing it.
96 /** @ingroup sg_storage_management
98 * @brief Returns the name of the #sg_storage_t.
100 * This functions checks whether a storage is a valid pointer or not and return its name.
102 const char* sg_storage_get_name(sg_storage_t storage)
104 xbt_assert((storage != nullptr), "Invalid parameters");
105 return storage->get_cname();
108 const char* sg_storage_get_host(sg_storage_t storage)
110 xbt_assert((storage != nullptr), "Invalid parameters");
111 return storage->get_host()->get_cname();
114 /** @ingroup sg_storage_management
115 * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
116 * @param storage a storage
117 * @return a dict containing the properties
119 xbt_dict_t sg_storage_get_properties(sg_storage_t storage)
121 xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)");
122 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
123 std::unordered_map<std::string, std::string>* props = storage->get_properties();
124 if (props == nullptr)
126 for (auto const& elm : *props) {
127 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
132 /** @ingroup sg_storage_management
133 * @brief Change the value of a given storage property
135 * @param storage a storage
136 * @param name a property name
137 * @param value what to change the property to
139 void sg_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
141 storage->set_property(name, value);
144 /** @ingroup sg_storage_management
145 * @brief Returns the value of a given storage property
147 * @param storage a storage
148 * @param name a property name
149 * @return value of a property (or nullptr if property not set)
151 const char* sg_storage_get_property_value(sg_storage_t storage, const char* name)
153 return storage->get_property(name);
156 /** @ingroup sg_storage_management
157 * @brief Finds a sg_storage_t using its name.
158 * @param name the name of a storage
159 * @return the corresponding storage
161 sg_storage_t sg_storage_get_by_name(const char* name)
163 return simgrid::s4u::Storage::by_name(name);
166 /** @ingroup sg_storage_management
167 * @brief Returns a dynar containing all the storage elements declared at a given point of time
169 xbt_dynar_t sg_storages_as_dynar()
171 std::vector<simgrid::s4u::Storage*> storage_list = simgrid::s4u::Engine::get_instance()->get_all_storages();
172 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_storage_t), nullptr);
173 for (auto const& s : storage_list)
174 xbt_dynar_push(res, &s);
178 void* sg_storage_get_data(sg_storage_t storage)
180 xbt_assert((storage != nullptr), "Invalid parameters");
181 return storage->get_data();
184 void sg_storage_set_data(sg_storage_t storage, void* data)
186 storage->set_data(data);
189 sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size)
191 return storage->read(size);
194 sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size)
196 return storage->write(size);