include/simgrid/s4u/Storage.hpp

   1 /* Copyright (c) 2006-2015, 2017. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_
   8 #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
   9
  10 #include <map>
  11 #include <simgrid/s4u/forward.hpp>
  12 #include <simgrid/simix.h>
  13 #include <string>
  14 #include <unordered_map>
  15 #include <xbt/base.h>
  16
  17 namespace simgrid {
  18 namespace s4u {
  19
  20 XBT_ATTRIB_PUBLIC std::map<std::string, Storage*>* allStorages();
  21
  22 XBT_PUBLIC_CLASS Storage
  23 {
  24   friend s4u::Engine;
  25   friend simgrid::surf::StorageImpl;
  26
  27 public:
  28   explicit Storage(surf::StorageImpl * pimpl) : pimpl_(pimpl) {}
  29   virtual ~Storage() = default;
  30   /** Retrieve a Storage by its name. It must exist in the platform file */
  31   static Storage* byName(std::string name);
  32   /** @brief Retrieves the name of that storage as a C++ string */
  33   std::string const& getName() const;
  34   /** @brief Retrieves the name of that storage as a C string */
  35   const char* getCname() const;
  36   const char* getType();
  37   Host* getHost();
  38   sg_size_t getSize(); /** Retrieve the total amount of space of this storage element */
  39   sg_size_t getSizeFree();
  40   sg_size_t getSizeUsed();
  41   void decrUsedSize(sg_size_t size);
  42
  43   std::map<std::string, std::string>* getProperties();
  44   const char* getProperty(std::string key);
  45   void setProperty(std::string, std::string value);
  46   std::map<std::string, sg_size_t>* getContent();
  47
  48   void setUserdata(void* data) { userdata_ = data; }
  49   void* getUserdata() { return userdata_; }
  50
  51   sg_size_t read(sg_size_t size);
  52   sg_size_t write(sg_size_t size);
  53   surf::StorageImpl* getImpl() { return pimpl_; }
  54
  55   /* The signals */
  56   /** @brief Callback signal fired when a new Link is created */
  57   static simgrid::xbt::signal<void(s4u::Storage&)> onCreation;
  58
  59   /** @brief Callback signal fired when a Link is destroyed */
  60   static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
  61
  62   Host* attached_to_              = nullptr;
  63
  64 private:
  65   surf::StorageImpl* const pimpl_ = nullptr;
  66   std::string name_;
  67   void* userdata_ = nullptr;
  68 };
  69
  70 } /* namespace s4u */
  71 } /* namespace simgrid */
  72
  73 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */