src/surf/storage_interface.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 "src/surf/PropertyHolder.hpp"
  11 #include "surf_interface.hpp"
  12 #include <map>
  13
  14 #ifndef STORAGE_INTERFACE_HPP_
  15 #define STORAGE_INTERFACE_HPP_
  16
  17 namespace simgrid {
  18 namespace surf {
  19
  20 /***********
  21  * Classes *
  22  ***********/
  23
  24 class StorageAction;
  25
  26 /*************
  27  * Callbacks *
  28  *************/
  29
  30 /** @ingroup SURF_callbacks
  31  * @brief Callbacks handler which emit the callbacks after Storage creation *
  32  * @details Callback functions have the following signature: `void(Storage*)`
  33  */
  34 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*)>) storageCreatedCallbacks;
  35
  36 /** @ingroup SURF_callbacks
  37  * @brief Callbacks handler which emit the callbacks after Storage destruction *
  38  * @details Callback functions have the following signature: `void(StoragePtr)`
  39  */
  40 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*)>) storageDestructedCallbacks;
  41
  42 /** @ingroup SURF_callbacks
  43  * @brief Callbacks handler which emit the callbacks after Storage State changed *
  44  * @details Callback functions have the following signature: `void(StorageAction *action, int previouslyOn, int currentlyOn)`
  45  */
  46 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*, int, int)>) storageStateChangedCallbacks;
  47
  48 /** @ingroup SURF_callbacks
  49  * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
  50  * @details Callback functions have the following signature: `void(StorageAction *action, simgrid::surf::Action::State old, simgrid::surf::Action::State current)`
  51  */
  52 XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::StorageAction*, simgrid::surf::Action::State, simgrid::surf::Action::State)>) storageActionStateChangedCallbacks;
  53
  54 /*********
  55  * Model *
  56  *********/
  57 /** @ingroup SURF_storage_interface
  58  * @brief SURF storage model interface class
  59  * @details A model is an object which handle the interactions between its Resources and its Actions
  60  */
  61 class StorageModel : public Model {
  62 public:
  63   StorageModel();
  64   ~StorageModel();
  65
  66   virtual Storage* createStorage(const char* id, const char* type_id, const char* content_name,
  67                                  const char* content_type, const char* attach) = 0;
  68
  69   std::vector<Storage*> p_storageList;
  70 };
  71
  72 /************
  73  * Resource *
  74  ************/
  75 /** @ingroup SURF_storage_interface
  76  * @brief SURF storage interface class
  77  * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
  78  */
  79 class Storage : public simgrid::surf::Resource,
  80         public simgrid::surf::PropertyHolder {
  81 public:
  82
  83   /** @brief Storage constructor */
  84   Storage(Model* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite, double bconnection,
  85           const char* type_id, const char* content_name, const char* content_type, sg_size_t size, const char* attach);
  86
  87   ~Storage();
  88
  89   /** @brief Check if the Storage is used (if an action currently uses its resources) */
  90   bool isUsed() override;
  91
  92   void apply_event(tmgr_trace_iterator_t event, double value) override;
  93
  94   void turnOn() override;
  95   void turnOff() override;
  96
  97   std::map<std::string, sg_size_t*>* content_;
  98   char* contentType_;
  99   sg_size_t size_;
 100   sg_size_t usedSize_;
 101   char * typeId_;
 102   char* attach_; //FIXME: this is the name of the host. Use the host directly
 103
 104   /**
 105    * @brief Open a file
 106    *
 107    * @param mount The mount point
 108    * @param path The path to the file
 109    *
 110    * @return The StorageAction corresponding to the opening
 111    */
 112   virtual StorageAction *open(const char* mount, const char* path)=0;
 113
 114   /**
 115    * @brief Close a file
 116    *
 117    * @param fd The file descriptor to close
 118    * @return The StorageAction corresponding to the closing
 119    */
 120   virtual StorageAction *close(surf_file_t fd)=0;
 121
 122   /**
 123    * @brief Read a file
 124    *
 125    * @param fd The file descriptor to read
 126    * @param size The size in bytes to read
 127    * @return The StorageAction corresponding to the reading
 128    */
 129   virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
 130
 131   /**
 132    * @brief Write a file
 133    *
 134    * @param fd The file descriptor to write
 135    * @param size The size in bytes to write
 136    * @return The StorageAction corresponding to the writing
 137    */
 138   virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
 139
 140   /**
 141    * @brief Get the content of the current Storage
 142    *
 143    * @return A xbt_dict_t with path as keys and size in bytes as values
 144    */
 145   virtual std::map<std::string, sg_size_t*>* getContent();
 146
 147   /**
 148    * @brief Get the available size in bytes of the current Storage
 149    *
 150    * @return The available size in bytes of the current Storage
 151    */
 152   virtual sg_size_t getFreeSize();
 153
 154   /**
 155    * @brief Get the used size in bytes of the current Storage
 156    *
 157    * @return The used size in bytes of the current Storage
 158    */
 159   virtual sg_size_t getUsedSize();
 160
 161   std::map<std::string, sg_size_t*>* parseContent(const char* filename);
 162
 163   std::vector<StorageAction*> writeActions_;
 164
 165   lmm_constraint_t constraintWrite_;    /* Constraint for maximum write bandwidth*/
 166   lmm_constraint_t constraintRead_;     /* Constraint for maximum write bandwidth*/
 167 };
 168
 169 /**********
 170  * Action *
 171  **********/
 172
 173 /** @ingroup SURF_storage_interface
 174  * @brief The possible type of action for the storage component
 175  */
 176 typedef enum {
 177   READ=0, /**< Read a file */
 178   WRITE,  /**< Write in a file */
 179   STAT,   /**< Stat a file */
 180   OPEN,   /**< Open a file */
 181   CLOSE  /**< Close a file */
 182 } e_surf_action_storage_type_t;
 183
 184 /** @ingroup SURF_storage_interface
 185  * @brief SURF storage action interface class
 186  */
 187 class StorageAction : public Action {
 188 public:
 189   /**
 190    * @brief StorageAction constructor
 191    *
 192    * @param model The StorageModel associated to this StorageAction
 193    * @param cost The cost of this  NetworkAction in [TODO]
 194    * @param failed [description]
 195    * @param storage The Storage associated to this StorageAction
 196    * @param type [description]
 197    */
 198   StorageAction(Model *model, double cost, bool failed, Storage *storage,
 199       e_surf_action_storage_type_t type);
 200
 201     /**
 202    * @brief StorageAction constructor
 203    *
 204    * @param model The StorageModel associated to this StorageAction
 205    * @param cost The cost of this  StorageAction in [TODO]
 206    * @param failed [description]
 207    * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
 208    * @param storage The Storage associated to this StorageAction
 209    * @param type [description]
 210    */
 211   StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
 212       Storage *storage, e_surf_action_storage_type_t type);
 213
 214   void setState(simgrid::surf::Action::State state) override;
 215
 216   e_surf_action_storage_type_t type_;
 217   Storage* storage_;
 218   surf_file_t file_;
 219   double progress_;
 220 };
 221
 222 }
 223 }
 224
 225 typedef struct s_storage_type {
 226   char *model;
 227   char *content;
 228   char *content_type;
 229   char *type_id;
 230   xbt_dict_t properties;
 231   std::map<std::string, std::string>* model_properties;
 232   sg_size_t size;
 233 } s_storage_type_t;
 234 typedef s_storage_type_t* storage_type_t;
 235
 236 typedef struct s_mount {
 237   void *storage;
 238   char *name;
 239 } s_mount_t;
 240 typedef s_mount_t* mount_t;
 241
 242 typedef struct surf_file {
 243   char *name;
 244   char *mount;
 245   sg_size_t size;
 246   sg_size_t current_position;
 247 } s_surf_file_t;
 248
 249 #endif /* STORAGE_INTERFACE_HPP_ */