src/s4u/s4u_Storage.cpp

   1 /* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   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"
  12
  13 namespace simgrid {
  14 namespace xbt {
  15 template class Extendable<simgrid::s4u::Storage>;
  16 }
  17
  18 namespace s4u {
  19
  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;
  23
  24 Storage::Storage(std::string name, surf::StorageImpl* pimpl) : pimpl_(pimpl), name_(name)
  25 {
  26   simgrid::s4u::Engine::get_instance()->storage_register(name, this);
  27 }
  28
  29 Storage* Storage::by_name(std::string name)
  30 {
  31   return Engine::get_instance()->storage_by_name(name);
  32 }
  33
  34 Storage* Storage::by_name_or_null(std::string name)
  35 {
  36   return Engine::get_instance()->storage_by_name_or_null(name);
  37 }
  38
  39 const char* Storage::get_type()
  40 {
  41   return pimpl_->typeId_.c_str();
  42 }
  43
  44 std::unordered_map<std::string, std::string>* Storage::get_properties()
  45 {
  46   return simgrid::simix::simcall([this] { return pimpl_->get_properties(); });
  47 }
  48
  49 const char* Storage::get_property(std::string key)
  50 {
  51   return this->pimpl_->get_property(key);
  52 }
  53
  54 void Storage::set_property(std::string key, std::string value)
  55 {
  56   simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, value); });
  57 }
  58
  59 IoPtr Storage::io_init(sg_size_t size, Io::OpType type)
  60 {
  61   IoPtr res = IoPtr(new Io(this, size, type));
  62   return res;
  63 }
  64
  65 IoPtr Storage::read_async(sg_size_t size)
  66 {
  67   IoPtr res = io_init(size, Io::OpType::READ);
  68   res->start();
  69   return res;
  70 }
  71
  72 sg_size_t Storage::read(sg_size_t size)
  73 {
  74   IoPtr i = io_init(size, Io::OpType::READ);
  75   i->start()->wait();
  76   return i->get_performed_ioops();
  77 }
  78
  79 IoPtr Storage::write_async(sg_size_t size)
  80 {
  81
  82   IoPtr res = io_init(size, Io::OpType::WRITE);
  83   res->start();
  84   return res;
  85 }
  86
  87 sg_size_t Storage::write(sg_size_t size)
  88 {
  89   IoPtr i = io_init(size, Io::OpType::WRITE);
  90   i->start()->wait();
  91   return i->get_performed_ioops();
  92 }
  93
  94 } /* namespace s4u */
  95 } /* namespace simgrid */
  96
  97 /* **************************** Public C interface *************************** */
  98
  99 /** @addtogroup sg_storage_management
 100  * (#sg_storage_t) and the functions for managing it.
 101  */
 102
 103 /** @ingroup sg_storage_management
 104  *
 105  * @brief Returns the name of the #sg_storage_t.
 106  *
 107  * This functions checks whether a storage is a valid pointer or not and return its name.
 108  */
 109 const char* sg_storage_get_name(sg_storage_t storage)
 110 {
 111   xbt_assert((storage != nullptr), "Invalid parameters");
 112   return storage->get_cname();
 113 }
 114
 115 const char* sg_storage_get_host(sg_storage_t storage)
 116 {
 117   xbt_assert((storage != nullptr), "Invalid parameters");
 118   return storage->get_host()->get_cname();
 119 }
 120
 121 /** @ingroup sg_storage_management
 122  * @brief Returns a xbt_dict_t consisting of the list of properties assigned to this storage
 123  * @param storage a storage
 124  * @return a dict containing the properties
 125  */
 126 xbt_dict_t sg_storage_get_properties(sg_storage_t storage)
 127 {
 128   xbt_assert((storage != nullptr), "Invalid parameters (storage is nullptr)");
 129   xbt_dict_t as_dict                        = xbt_dict_new_homogeneous(xbt_free_f);
 130   std::unordered_map<std::string, std::string>* props = storage->get_properties();
 131   if (props == nullptr)
 132     return nullptr;
 133   for (auto const& elm : *props) {
 134     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 135   }
 136   return as_dict;
 137 }
 138
 139 /** @ingroup sg_storage_management
 140  * @brief Change the value of a given storage property
 141  *
 142  * @param storage a storage
 143  * @param name a property name
 144  * @param value what to change the property to
 145  */
 146 void sg_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
 147 {
 148   storage->set_property(name, value);
 149 }
 150
 151 /** @ingroup sg_storage_management
 152  * @brief Returns the value of a given storage property
 153  *
 154  * @param storage a storage
 155  * @param name a property name
 156  * @return value of a property (or nullptr if property not set)
 157  */
 158 const char* sg_storage_get_property_value(sg_storage_t storage, const char* name)
 159 {
 160   return storage->get_property(name);
 161 }
 162
 163 /** @ingroup sg_storage_management
 164  * @brief Finds a sg_storage_t using its name.
 165  * @param name the name of a storage
 166  * @return the corresponding storage
 167  */
 168 sg_storage_t sg_storage_get_by_name(const char* name)
 169 {
 170   return simgrid::s4u::Storage::by_name(name);
 171 }
 172
 173 /** @ingroup sg_storage_management
 174  * @brief Returns a dynar containing all the storage elements declared at a given point of time
 175  */
 176 xbt_dynar_t sg_storages_as_dynar()
 177 {
 178   std::vector<simgrid::s4u::Storage*> storage_list = simgrid::s4u::Engine::get_instance()->get_all_storages();
 179   xbt_dynar_t res                                  = xbt_dynar_new(sizeof(sg_storage_t), nullptr);
 180   for (auto const& s : storage_list)
 181     xbt_dynar_push(res, &s);
 182   return res;
 183 }
 184
 185 void* sg_storage_get_data(sg_storage_t storage)
 186 {
 187   xbt_assert((storage != nullptr), "Invalid parameters");
 188   return storage->get_data();
 189 }
 190
 191 void sg_storage_set_data(sg_storage_t storage, void* data)
 192 {
 193   storage->set_data(data);
 194 }
 195
 196 sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size)
 197 {
 198   return storage->read(size);
 199 }
 200
 201 sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size)
 202 {
 203   return storage->write(size);
 204 }