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 XBT_ATTRIB_DEPRECATED_v322(
23 "simgrid::s4u::getStorageList() is deprecated in favor of Engine::getAllStorages(). Please switch before v3.22")
24 getStorageList(std::map<std::string, Storage*>* whereTo)
26 for (auto const& s : simgrid::s4u::Engine::getInstance()->getAllStorages())
27 whereTo->insert({s->get_name(), s});
30 Storage::Storage(std::string name, surf::StorageImpl* pimpl) : pimpl_(pimpl), name_(name)
32 simgrid::s4u::Engine::getInstance()->addStorage(name, this);
35 Storage* Storage::byName(std::string name)
37 return Engine::getInstance()->storageByNameOrNull(name);
40 const std::string& Storage::get_name() const
45 const char* Storage::get_cname() const
50 const char* Storage::getType()
52 return pimpl_->typeId_.c_str();
55 Host* Storage::getHost()
60 std::map<std::string, std::string>* Storage::getProperties()
62 return simgrid::simix::kernelImmediate([this] { return pimpl_->getProperties(); });
65 const char* Storage::getProperty(std::string key)
67 return this->pimpl_->getProperty(key);
70 void Storage::setProperty(std::string key, std::string value)
72 simgrid::simix::kernelImmediate([this, key, value] { this->pimpl_->setProperty(key, value); });
75 sg_size_t Storage::read(sg_size_t size)
77 return simcall_storage_read(pimpl_, size);
80 sg_size_t Storage::write(sg_size_t size)
82 return simcall_storage_write(pimpl_, size);
88 simgrid::xbt::signal<void(s4u::Storage&)> Storage::onCreation;
89 simgrid::xbt::signal<void(s4u::Storage&)> Storage::onDestruction;
92 } /* namespace simgrid */
94 /* **************************** Public C interface *************************** */
96 /** @addtogroup sg_storage_management
97 * (#sg_storage_t) and the functions for managing it.
100 /** \ingroup sg_storage_management
102 * \brief Returns the name of the #sg_storage_t.
104 * This functions checks whether a storage is a valid pointer or not and return its name.
106 const char* sg_storage_get_name(sg_storage_t storage)
108 xbt_assert((storage != nullptr), "Invalid parameters");
109 return storage->get_cname();
112 const char* sg_storage_get_host(sg_storage_t storage)
114 xbt_assert((storage != nullptr), "Invalid parameters");
115 return storage->getHost()->get_cname();
118 /** \ingroup sg_storage_management
119 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
120 * \param storage a storage
121 * \return a dict containing the properties
123 xbt_dict_t sg_storage_get_properties(sg_storage_t storage)
125 xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)");
126 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
127 std::map<std::string, std::string>* props = storage->getProperties();
128 if (props == nullptr)
130 for (auto const& elm : *props) {
131 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
136 /** \ingroup sg_storage_management
137 * \brief Change the value of a given storage property
139 * \param storage a storage
140 * \param name a property name
141 * \param value what to change the property to
143 void sg_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
145 storage->setProperty(name, value);
148 /** \ingroup sg_storage_management
149 * \brief Returns the value of a given storage property
151 * \param storage a storage
152 * \param name a property name
153 * \return value of a property (or nullptr if property not set)
155 const char* sg_storage_get_property_value(sg_storage_t storage, const char* name)
157 return storage->getProperty(name);
160 /** \ingroup sg_storage_management
161 * \brief Finds a sg_storage_t using its name.
162 * \param name the name of a storage
163 * \return the corresponding storage
165 sg_storage_t sg_storage_get_by_name(const char* name)
167 return simgrid::s4u::Storage::byName(name);
170 /** \ingroup sg_storage_management
171 * \brief Returns a dynar containing all the storage elements declared at a given point of time
173 xbt_dynar_t sg_storages_as_dynar()
175 std::vector<simgrid::s4u::Storage*> storage_list = simgrid::s4u::Engine::getInstance()->getAllStorages();
176 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_storage_t), nullptr);
177 for (auto const& s : storage_list)
178 xbt_dynar_push(res, &s);
182 void* sg_storage_get_data(sg_storage_t storage)
184 xbt_assert((storage != nullptr), "Invalid parameters");
185 return storage->getUserdata();
188 void sg_storage_set_data(sg_storage_t storage, void* data)
190 storage->setUserdata(data);
193 sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size)
195 return storage->read(size);
198 sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size)
200 return storage->write(size);