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(const char* name);
  32   const char* name();
  33   const char* host();
  34   sg_size_t sizeFree();
  35   sg_size_t sizeUsed();
  36   /** Retrieve the total amount of space of this storage element */
  37   sg_size_t size();
  38   xbt_dict_t properties();
  39   const char* property(const char* key);
  40   void setProperty(const char* key, char* value);
  41   std::map<std::string, sg_size_t*>* content();
  42
  43 public:
  44   void setUserdata(void* data) { userdata_ = data; }
  45   void* userdata() { return userdata_; }
  46
  47   /* The signals */
  48   /** @brief Callback signal fired when a new Link is created */
  49   static simgrid::xbt::signal<void(s4u::Storage&)> onCreation;
  50
  51   /** @brief Callback signal fired when a Link is destroyed */
  52   static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
  53
  54 private:
  55   std::string name_;
  56   surf::StorageImpl* const pimpl_ = nullptr;
  57   void* userdata_      = nullptr;
  58 };
  59
  60 } /* namespace s4u */
  61 } /* namespace simgrid */
  62
  63 #endif /* INCLUDE_SIMGRID_S4U_STORAGE_HPP_ */