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