include/simgrid/s4u/Storage.hpp

   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 #ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_
   7 #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
   8
   9 #include <simgrid/forward.h>
  10 #include <xbt/Extendable.hpp>
  11 #include <xbt/base.h>
  12
  13 #include <map>
  14 #include <string>
  15 #include <unordered_map>
  16
  17 namespace simgrid {
  18 namespace xbt {
  19 extern template class XBT_PUBLIC Extendable<simgrid::s4u::Storage>;
  20 }
  21 namespace s4u {
  22
  23 XBT_PUBLIC void getStorageList(std::map<std::string, Storage*>* whereTo);
  24
  25 class XBT_PUBLIC Storage : public simgrid::xbt::Extendable<Storage> {
  26   friend s4u::Engine;
  27   friend simgrid::surf::StorageImpl;
  28
  29 public:
  30   explicit Storage(std::string name, surf::StorageImpl * pimpl);
  31   virtual ~Storage() = default;
  32   /** Retrieve a Storage by its name. It must exist in the platform file */
  33   static Storage* byName(std::string name);
  34
  35   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); }
  36   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); }
  37
  38   /** @brief Retrieves the name of that storage as a C++ string */
  39   std::string const& get_name() const;
  40   /** @brief Retrieves the name of that storage as a C string */
  41   const char* get_cname() const;
  42
  43   const char* getType();
  44   Host* getHost();
  45
  46   std::map<std::string, std::string>* getProperties();
  47   const char* getProperty(std::string key);
  48   void setProperty(std::string, std::string value);
  49
  50   void setUserdata(void* data) { userdata_ = data; }
  51   void* getUserdata() { return userdata_; }
  52
  53   sg_size_t read(sg_size_t size);
  54   sg_size_t write(sg_size_t size);
  55   surf::StorageImpl* getImpl() { return pimpl_; }
  56
  57   /* The signals */
  58   /** @brief Callback signal fired when a new Link is created */
  59   static simgrid::xbt::signal<void(s4u::Storage&)> onCreation;
  60
  61   /** @brief Callback signal fired when a Link is destroyed */
  62   static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
  63
  64   Host* attached_to_              = nullptr;
  65
  66 private:
  67   surf::StorageImpl* const pimpl_ = nullptr;
  68   std::string name_;
  69   void* userdata_ = nullptr;
  70 };
  71
  72 } /* namespace s4u */
  73 } /* namespace simgrid */
  74
  75 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */