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, const char* attach) = 0;
  67
  68   std::vector<Storage*> p_storageList;
  69 };
  70
  71 /************
  72  * Resource *
  73  ************/
  74 /** @ingroup SURF_storage_interface
  75  * @brief SURF storage interface class
  76  * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
  77  */
  78 class Storage : public simgrid::surf::Resource,
  79         public simgrid::surf::PropertyHolder {
  80 public:
  81
  82   /** @brief Storage constructor */
  83   Storage(Model* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite, const char* type_id,
  84       const char* content_name, sg_size_t size, const char* attach);
  85
  86   ~Storage();
  87
  88   /** @brief Check if the Storage is used (if an action currently uses its resources) */
  89   bool isUsed() override;
  90
  91   void apply_event(tmgr_trace_event_t event, double value) override;
  92
  93   void turnOn() override;
  94   void turnOff() override;
  95
  96   std::map<std::string, sg_size_t*>* content_;
  97   sg_size_t size_;
  98   sg_size_t usedSize_;
  99   char * typeId_;
 100   char* attach_; //FIXME: this is the name of the host. Use the host directly
 101
 102   /**
 103    * @brief Open a file
 104    *
 105    * @param mount The mount point
 106    * @param path The path to the file
 107    *
 108    * @return The StorageAction corresponding to the opening
 109    */
 110   virtual StorageAction *open(const char* mount, const char* path)=0;
 111
 112   /**
 113    * @brief Close a file
 114    *
 115    * @param fd The file descriptor to close
 116    * @return The StorageAction corresponding to the closing
 117    */
 118   virtual StorageAction *close(surf_file_t fd)=0;
 119
 120   /**
 121    * @brief Read a file
 122    *
 123    * @param fd The file descriptor to read
 124    * @param size The size in bytes to read
 125    * @return The StorageAction corresponding to the reading
 126    */
 127   virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
 128
 129   /**
 130    * @brief Write a file
 131    *
 132    * @param fd The file descriptor to write
 133    * @param size The size in bytes to write
 134    * @return The StorageAction corresponding to the writing
 135    */
 136   virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
 137
 138   /**
 139    * @brief Get the content of the current Storage
 140    *
 141    * @return A xbt_dict_t with path as keys and size in bytes as values
 142    */
 143   virtual std::map<std::string, sg_size_t*>* getContent();
 144
 145   /**
 146    * @brief Get the available size in bytes of the current Storage
 147    *
 148    * @return The available size in bytes of the current Storage
 149    */
 150   virtual sg_size_t getFreeSize();
 151
 152   /**
 153    * @brief Get the used size in bytes of the current Storage
 154    *
 155    * @return The used size in bytes of the current Storage
 156    */
 157   virtual sg_size_t getUsedSize();
 158
 159   std::map<std::string, sg_size_t*>* parseContent(const char* filename);
 160
 161   std::vector<StorageAction*> writeActions_;
 162
 163   lmm_constraint_t constraintWrite_;    /* Constraint for maximum write bandwidth*/
 164   lmm_constraint_t constraintRead_;     /* Constraint for maximum write bandwidth*/
 165 };
 166
 167 /**********
 168  * Action *
 169  **********/
 170
 171 /** @ingroup SURF_storage_interface
 172  * @brief The possible type of action for the storage component
 173  */
 174 typedef enum {
 175   READ=0, /**< Read a file */
 176   WRITE,  /**< Write in a file */
 177   STAT,   /**< Stat a file */
 178   OPEN,   /**< Open a file */
 179   CLOSE  /**< Close a file */
 180 } e_surf_action_storage_type_t;
 181
 182 /** @ingroup SURF_storage_interface
 183  * @brief SURF storage action interface class
 184  */
 185 class StorageAction : public Action {
 186 public:
 187   /**
 188    * @brief StorageAction constructor
 189    *
 190    * @param model The StorageModel associated to this StorageAction
 191    * @param cost The cost of this  NetworkAction in [TODO]
 192    * @param failed [description]
 193    * @param storage The Storage associated to this StorageAction
 194    * @param type [description]
 195    */
 196   StorageAction(Model *model, double cost, bool failed, Storage *storage,
 197       e_surf_action_storage_type_t type);
 198
 199     /**
 200    * @brief StorageAction constructor
 201    *
 202    * @param model The StorageModel associated to this StorageAction
 203    * @param cost The cost of this  StorageAction in [TODO]
 204    * @param failed [description]
 205    * @param var The lmm variable associated to this StorageAction if it is part of a LMM component
 206    * @param storage The Storage associated to this StorageAction
 207    * @param type [description]
 208    */
 209   StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
 210       Storage *storage, e_surf_action_storage_type_t type);
 211
 212   void setState(simgrid::surf::Action::State state) override;
 213
 214   e_surf_action_storage_type_t type_;
 215   Storage* storage_;
 216   surf_file_t file_;
 217   double progress_;
 218 };
 219
 220 }
 221 }
 222
 223 typedef struct s_storage_type {
 224   char *model;
 225   char *content;
 226   char *type_id;
 227   xbt_dict_t properties;
 228   std::map<std::string, std::string>* model_properties;
 229   sg_size_t size;
 230 } s_storage_type_t;
 231 typedef s_storage_type_t* storage_type_t;
 232
 233 typedef struct surf_file {
 234   char *name;
 235   char *mount;
 236   sg_size_t size;
 237   sg_size_t current_position;
 238 } s_surf_file_t;
 239
 240 #endif /* STORAGE_INTERFACE_HPP_ */