src/surf/StorageImpl.hpp

   1 /* Copyright (c) 2004-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 #include <xbt/base.h>
   8 #include <xbt/signal.hpp>
   9
  10 #include "simgrid/s4u/Storage.hpp"
  11 #include "src/surf/PropertyHolder.hpp"
  12 #include "surf_interface.hpp"
  13 #include <map>
  14
  15 #ifndef STORAGE_INTERFACE_HPP_
  16 #define STORAGE_INTERFACE_HPP_
  17
  18 namespace simgrid {
  19 namespace surf {
  20
  21 /***********
  22  * Classes *
  23  ***********/
  24
  25 class StorageAction;
  26
  27 /*************
  28  * Callbacks *
  29  *************/
  30
  31 /** @ingroup SURF_callbacks
  32  * @brief Callbacks handler which emit the callbacks after Storage creation *
  33  * @details Callback functions have the following signature: `void(Storage*)`
  34  */
  35 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(StorageImpl*)>) storageCreatedCallbacks;
  36
  37 /** @ingroup SURF_callbacks
  38  * @brief Callbacks handler which emit the callbacks after Storage destruction *
  39  * @details Callback functions have the following signature: `void(StoragePtr)`
  40  */
  41 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(StorageImpl*)>) storageDestructedCallbacks;
  42
  43 /** @ingroup SURF_callbacks
  44  * @brief Callbacks handler which emit the callbacks after Storage State changed *
  45  * @details Callback functions have the following signature: `void(StorageAction *action, int previouslyOn, int
  46  * currentlyOn)`
  47  */
  48 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(StorageImpl*, int, int)>) storageStateChangedCallbacks;
  49
  50 /** @ingroup SURF_callbacks
  51  * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
  52  * @details Callback functions have the following signature: `void(StorageAction *action, simgrid::surf::Action::State
  53  * old, simgrid::surf::Action::State current)`
  54  */
  55 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(StorageAction*, Action::State, Action::State)>)
  56 storageActionStateChangedCallbacks;
  57
  58 /*********
  59  * Model *
  60  *********/
  61 /** @ingroup SURF_storage_interface
  62  * @brief SURF storage model interface class
  63  * @details A model is an object which handle the interactions between its Resources and its Actions
  64  */
  65 class StorageModel : public Model {
  66 public:
  67   StorageModel();
  68   ~StorageModel();
  69
  70   virtual StorageImpl* createStorage(std::string id, std::string type_id, std::string content_name,
  71                                      std::string attach) = 0;
  72
  73   std::vector<StorageImpl*> p_storageList;
  74 };
  75
  76 /************
  77  * Resource *
  78  ************/
  79 /** @ingroup SURF_storage_interface
  80  * @brief SURF storage interface class
  81  * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
  82  */
  83 class StorageImpl : public Resource, public PropertyHolder {
  84 public:
  85   /** @brief Storage constructor */
  86   StorageImpl(Model* model, std::string name, lmm_system_t maxminSystem, double bread, double bwrite,
  87               std::string type_id, std::string content_name, sg_size_t size, std::string attach);
  88
  89   ~StorageImpl() override;
  90
  91   /** @brief Public interface */
  92   s4u::Storage piface_;
  93   static StorageImpl* byName(std::string name);
  94
  95   /** @brief Check if the Storage is used (if an action currently uses its resources) */
  96   bool isUsed() override;
  97
  98   void apply_event(tmgr_trace_event_t event, double value) override;
  99
 100   void turnOn() override;
 101   void turnOff() override;
 102
 103   /**
 104    * @brief Read a file
 105    *
 106    * @param size The size in bytes to read
 107    * @return The StorageAction corresponding to the reading
 108    */
 109   virtual StorageAction* read(sg_size_t size) = 0;
 110
 111   /**
 112    * @brief Write a file
 113    *
 114    * @param size The size in bytes to write
 115    * @return The StorageAction corresponding to the writing
 116    */
 117   virtual StorageAction* write(sg_size_t size) = 0;
 118   virtual sg_size_t getSize() { return size_; }
 119   virtual std::string getHost() { return attach_; }
 120
 121   static std::unordered_map<std::string, StorageImpl*>* storagesMap() { return StorageImpl::storages; }
 122
 123   lmm_constraint_t constraintWrite_; /* Constraint for maximum write bandwidth*/
 124   lmm_constraint_t constraintRead_;  /* Constraint for maximum write bandwidth*/
 125
 126   std::string typeId_;
 127   sg_size_t usedSize_ = 0;
 128   std::string content_name;
 129
 130 private:
 131   sg_size_t size_;
 132   static std::unordered_map<std::string, StorageImpl*>* storages;
 133   std::map<std::string, sg_size_t>* content_;
 134   // Name of the host to which this storage is attached. Only used at platform parsing time, then the interface stores
 135   // the Host directly.
 136   std::string attach_;
 137 };
 138
 139 /**********
 140  * Action *
 141  **********/
 142
 143 /** @ingroup SURF_storage_interface
 144  * @brief The possible type of action for the storage component
 145  */
 146 enum e_surf_action_storage_type_t {
 147   READ = 0, /**< Read a file */
 148   WRITE     /**< Write in a file */
 149 };
 150
 151 /** @ingroup SURF_storage_interface
 152  * @brief SURF storage action interface class
 153  */
 154 class StorageAction : public Action {
 155 public:
 156   /**
 157    * @brief StorageAction constructor
 158    *
 159    * @param model The StorageModel associated to this StorageAction
 160    * @param cost The cost of this  NetworkAction in [TODO]
 161    * @param failed [description]
 162    * @param storage The Storage associated to this StorageAction
 163    * @param type [description]
 164    */
 165   StorageAction(Model* model, double cost, bool failed, StorageImpl* storage, e_surf_action_storage_type_t type)
 166       : Action(model, cost, failed), type_(type), storage_(storage){};
 167
 168   /**
 169  * @brief StorageAction constructor
 170  *
 171  * @param model The StorageModel associated to this StorageAction
 172  * @param cost The cost of this  StorageAction in [TODO]
 173  * @param failed [description]
 174  * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
 175  * @param storage The Storage associated to this StorageAction
 176  * @param type [description]
 177  */
 178   StorageAction(Model* model, double cost, bool failed, lmm_variable_t var, StorageImpl* storage,
 179                 e_surf_action_storage_type_t type)
 180       : Action(model, cost, failed, var), type_(type), storage_(storage){};
 181
 182   void setState(simgrid::surf::Action::State state) override;
 183
 184   e_surf_action_storage_type_t type_;
 185   StorageImpl* storage_;
 186 };
 187
 188 class StorageType {
 189 public:
 190   std::string id;
 191   std::string model;
 192   std::string content;
 193   std::map<std::string, std::string>* properties;
 194   std::map<std::string, std::string>* model_properties;
 195   sg_size_t size;
 196   StorageType(std::string id, std::string model, std::string content, std::map<std::string, std::string>* properties,
 197               std::map<std::string, std::string>* model_properties, sg_size_t size)
 198       : id(id), model(model), content(content), properties(properties), model_properties(model_properties), size(size)
 199   {
 200   }
 201 };
 202 }
 203 }
 204
 205 #endif /* STORAGE_INTERFACE_HPP_ */