src/s4u/s4u_Storage.cpp

   1 /* Copyright (c) 2006-2018. 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)
  60 {
  61   IoPtr res  = IoPtr(new Io());
  62   res->size_ = size;
  63   res->storage_ = this;
  64   res->set_remaining(size);
  65   return res;
  66 }
  67
  68 sg_size_t Storage::read(sg_size_t size)
  69 {
  70   IoPtr i = io_init(size);
  71   i->set_io_type(Io::OpType::READ);
  72   i->start()->wait();
  73   return i->get_performed_ioops();
  74 }
  75
  76 sg_size_t Storage::write(sg_size_t size)
  77 {
  78   IoPtr i = io_init(size);
  79   i->set_io_type(Io::OpType::WRITE);
  80   i->start()->wait();
  81   return i->get_performed_ioops();
  82 }
  83
  84 // Deprecated functions
  85 void getStorageList(std::map<std::string, Storage*>* whereTo)
  86 {
  87   for (auto const& s : simgrid::s4u::Engine::get_instance()->get_all_storages())
  88     whereTo->insert({s->get_name(), s});
  89 }
  90
  91 } /* namespace s4u */
  92 } /* namespace simgrid */
  93
  94 /* **************************** Public C interface *************************** */
  95
  96 /** @addtogroup sg_storage_management
  97  * (#sg_storage_t) and the functions for managing it.
  98  */
  99
 100 /** @ingroup sg_storage_management
 101  *
 102  * @brief Returns the name of the #sg_storage_t.
 103  *
 104  * This functions checks whether a storage is a valid pointer or not and return its name.
 105  */
 106 const char* sg_storage_get_name(sg_storage_t storage)
 107 {
 108   xbt_assert((storage != nullptr), "Invalid parameters");
 109   return storage->get_cname();
 110 }
 111
 112 const char* sg_storage_get_host(sg_storage_t storage)
 113 {
 114   xbt_assert((storage != nullptr), "Invalid parameters");
 115   return storage->get_host()->get_cname();
 116 }
 117
 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
 122  */
 123 xbt_dict_t sg_storage_get_properties(sg_storage_t storage)
 124 {
 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::unordered_map<std::string, std::string>* props = storage->get_properties();
 128   if (props == nullptr)
 129     return nullptr;
 130   for (auto const& elm : *props) {
 131     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 132   }
 133   return as_dict;
 134 }
 135
 136 /** @ingroup sg_storage_management
 137  * @brief Change the value of a given storage property
 138  *
 139  * @param storage a storage
 140  * @param name a property name
 141  * @param value what to change the property to
 142  */
 143 void sg_storage_set_property_value(sg_storage_t storage, const char* name, const char* value)
 144 {
 145   storage->set_property(name, value);
 146 }
 147
 148 /** @ingroup sg_storage_management
 149  * @brief Returns the value of a given storage property
 150  *
 151  * @param storage a storage
 152  * @param name a property name
 153  * @return value of a property (or nullptr if property not set)
 154  */
 155 const char* sg_storage_get_property_value(sg_storage_t storage, const char* name)
 156 {
 157   return storage->get_property(name);
 158 }
 159
 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
 164  */
 165 sg_storage_t sg_storage_get_by_name(const char* name)
 166 {
 167   return simgrid::s4u::Storage::by_name(name);
 168 }
 169
 170 /** @ingroup sg_storage_management
 171  * @brief Returns a dynar containing all the storage elements declared at a given point of time
 172  */
 173 xbt_dynar_t sg_storages_as_dynar()
 174 {
 175   std::vector<simgrid::s4u::Storage*> storage_list = simgrid::s4u::Engine::get_instance()->get_all_storages();
 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);
 179   return res;
 180 }
 181
 182 void* sg_storage_get_data(sg_storage_t storage)
 183 {
 184   xbt_assert((storage != nullptr), "Invalid parameters");
 185   return storage->get_data();
 186 }
 187
 188 void sg_storage_set_data(sg_storage_t storage, void* data)
 189 {
 190   storage->set_data(data);
 191 }
 192
 193 sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size)
 194 {
 195   return storage->read(size);
 196 }
 197
 198 sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size)
 199 {
 200   return storage->write(size);
 201 }