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/Storage.hpp"
9 #include "simgrid/storage.h"
10 #include "src/surf/StorageImpl.hpp"
13 #include <unordered_map>
17 template class Extendable<simgrid::s4u::Storage>;
22 void getStorageList(std::map<std::string, Storage*>* whereTo)
24 for (auto const& s : simgrid::s4u::Engine::get_instance()->get_all_storages())
25 whereTo->insert({s->get_name(), s});
28 Storage::Storage(std::string name, surf::StorageImpl* pimpl) : pimpl_(pimpl), name_(name)
30 simgrid::s4u::Engine::get_instance()->storage_register(name, this);
33 Storage* Storage::by_name(std::string name)
35 return Engine::get_instance()->storage_by_name_or_null(name);
38 const std::string& Storage::get_name() const
43 const char* Storage::get_cname() const
48 const char* Storage::get_type()
50 return pimpl_->typeId_.c_str();
53 std::map<std::string, std::string>* Storage::getProperties()
55 return simgrid::simix::simcall([this] { return pimpl_->get_properties(); });
58 const char* Storage::get_property(std::string key)
60 return this->pimpl_->get_property(key);
63 void Storage::set_property(std::string key, std::string value)
65 simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
68 sg_size_t Storage::read(sg_size_t size)
70 return simcall_storage_read(pimpl_, size);
73 sg_size_t Storage::write(sg_size_t size)
75 return simcall_storage_write(pimpl_, size);
81 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_creation;
82 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_destruction;
83 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_state_change;
86 } /* namespace simgrid */
88 /* **************************** Public C interface *************************** */
90 /** @addtogroup sg_storage_management
91 * (#sg_storage_t) and the functions for managing it.
94 /** \ingroup sg_storage_management
96 * \brief Returns the name of the #sg_storage_t.
98 * This functions checks whether a storage is a valid pointer or not and return its name.
100 const char* sg_storage_get_name(sg_storage_t storage)
102 xbt_assert((storage != nullptr), "Invalid parameters");
103 return storage->get_cname();
106 const char* sg_storage_get_host(sg_storage_t storage)
108 xbt_assert((storage != nullptr), "Invalid parameters");
109 return storage->get_host()->get_cname();
112 /** \ingroup sg_storage_management
113 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
114 * \param storage a storage
115 * \return a dict containing the properties
117 xbt_dict_t sg_storage_get_properties(sg_storage_t storage)
119 xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)");
120 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
121 std::map<std::string, std::string>* props = storage->getProperties();
122 if (props == nullptr)
124 for (auto const& elm : *props) {
125 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
130 /** \ingroup sg_storage_management
131 * \brief Change the value of a given storage property
133 * \param storage a storage
134 * \param name a property name
135 * \param value what to change the property to
137 void sg_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
139 storage->set_property(name, value);
142 /** \ingroup sg_storage_management
143 * \brief Returns the value of a given storage property
145 * \param storage a storage
146 * \param name a property name
147 * \return value of a property (or nullptr if property not set)
149 const char* sg_storage_get_property_value(sg_storage_t storage, const char* name)
151 return storage->get_property(name);
154 /** \ingroup sg_storage_management
155 * \brief Finds a sg_storage_t using its name.
156 * \param name the name of a storage
157 * \return the corresponding storage
159 sg_storage_t sg_storage_get_by_name(const char* name)
161 return simgrid::s4u::Storage::by_name(name);
164 /** \ingroup sg_storage_management
165 * \brief Returns a dynar containing all the storage elements declared at a given point of time
167 xbt_dynar_t sg_storages_as_dynar()
169 std::vector<simgrid::s4u::Storage*> storage_list = simgrid::s4u::Engine::get_instance()->get_all_storages();
170 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_storage_t), nullptr);
171 for (auto const& s : storage_list)
172 xbt_dynar_push(res, &s);
176 void* sg_storage_get_data(sg_storage_t storage)
178 xbt_assert((storage != nullptr), "Invalid parameters");
179 return storage->get_data();
182 void sg_storage_set_data(sg_storage_t storage, void* data)
184 storage->set_data(data);
187 sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size)
189 return storage->read(size);
192 sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size)
194 return storage->write(size);