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"
14 template class Extendable<simgrid::s4u::Storage>;
19 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_creation;
20 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_destruction;
21 simgrid::xbt::signal<void(s4u::Storage&)> Storage::on_state_change;
23 Storage::Storage(std::string name, surf::StorageImpl* pimpl) : pimpl_(pimpl), name_(name)
25 simgrid::s4u::Engine::get_instance()->storage_register(name, this);
28 Storage* Storage::by_name(std::string name)
30 return Engine::get_instance()->storage_by_name(name);
33 Storage* Storage::by_name_or_null(std::string name)
35 return Engine::get_instance()->storage_by_name_or_null(name);
38 const char* Storage::get_type()
40 return pimpl_->typeId_.c_str();
43 std::unordered_map<std::string, std::string>* Storage::get_properties()
45 return simgrid::simix::simcall([this] { return pimpl_->get_properties(); });
48 const char* Storage::get_property(std::string key)
50 return this->pimpl_->get_property(key);
53 void Storage::set_property(std::string key, std::string value)
55 simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
58 sg_size_t Storage::read(sg_size_t size)
60 return simcall_storage_read(pimpl_, size);
63 sg_size_t Storage::write(sg_size_t size)
65 return simcall_storage_write(pimpl_, size);
68 // Deprecated functions
69 void getStorageList(std::map<std::string, Storage*>* whereTo)
71 for (auto const& s : simgrid::s4u::Engine::get_instance()->get_all_storages())
72 whereTo->insert({s->get_name(), s});
76 } /* namespace simgrid */
78 /* **************************** Public C interface *************************** */
80 /** @addtogroup sg_storage_management
81 * (#sg_storage_t) and the functions for managing it.
84 /** @ingroup sg_storage_management
86 * @brief Returns the name of the #sg_storage_t.
88 * This functions checks whether a storage is a valid pointer or not and return its name.
90 const char* sg_storage_get_name(sg_storage_t storage)
92 xbt_assert((storage != nullptr), "Invalid parameters");
93 return storage->get_cname();
96 const char* sg_storage_get_host(sg_storage_t storage)
98 xbt_assert((storage != nullptr), "Invalid parameters");
99 return storage->get_host()->get_cname();
102 /** @ingroup sg_storage_management
103 * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
104 * @param storage a storage
105 * @return a dict containing the properties
107 xbt_dict_t sg_storage_get_properties(sg_storage_t storage)
109 xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)");
110 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
111 std::unordered_map<std::string, std::string>* props = storage->get_properties();
112 if (props == nullptr)
114 for (auto const& elm : *props) {
115 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
120 /** @ingroup sg_storage_management
121 * @brief Change the value of a given storage property
123 * @param storage a storage
124 * @param name a property name
125 * @param value what to change the property to
127 void sg_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
129 storage->set_property(name, value);
132 /** @ingroup sg_storage_management
133 * @brief Returns the value of a given storage property
135 * @param storage a storage
136 * @param name a property name
137 * @return value of a property (or nullptr if property not set)
139 const char* sg_storage_get_property_value(sg_storage_t storage, const char* name)
141 return storage->get_property(name);
144 /** @ingroup sg_storage_management
145 * @brief Finds a sg_storage_t using its name.
146 * @param name the name of a storage
147 * @return the corresponding storage
149 sg_storage_t sg_storage_get_by_name(const char* name)
151 return simgrid::s4u::Storage::by_name(name);
154 /** @ingroup sg_storage_management
155 * @brief Returns a dynar containing all the storage elements declared at a given point of time
157 xbt_dynar_t sg_storages_as_dynar()
159 std::vector<simgrid::s4u::Storage*> storage_list = simgrid::s4u::Engine::get_instance()->get_all_storages();
160 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_storage_t), nullptr);
161 for (auto const& s : storage_list)
162 xbt_dynar_push(res, &s);
166 void* sg_storage_get_data(sg_storage_t storage)
168 xbt_assert((storage != nullptr), "Invalid parameters");
169 return storage->get_data();
172 void sg_storage_set_data(sg_storage_t storage, void* data)
174 storage->set_data(data);
177 sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size)
179 return storage->read(size);
182 sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size)
184 return storage->write(size);