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