Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
I think I just killed a simcall
[simgrid.git] / src / surf / storage_interface.hpp
index d0e7df6..f52d57b 100644 (file)
@@ -1,34 +1,29 @@
-/* Copyright (c) 2004-2014. The SimGrid Team.
+/* Copyright (c) 2004-2017. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
+#include <xbt/base.h>
+#include <xbt/signal.hpp>
+
+#include "src/surf/PropertyHolder.hpp"
 #include "surf_interface.hpp"
+#include <map>
 
 #ifndef STORAGE_INTERFACE_HPP_
 #define STORAGE_INTERFACE_HPP_
 
-extern xbt_dynar_t mount_list;
+namespace simgrid {
+namespace surf {
 
 /***********
  * Classes *
  ***********/
 
 class StorageModel;
-typedef StorageModel *StorageModelPtr;
-
-class Storage;
-typedef Storage *StoragePtr;
-
 class Storage;
-typedef Storage *StoragePtr;
-
-class StorageAction;
-typedef StorageAction *StorageActionPtr;
-
 class StorageAction;
-typedef StorageAction *StorageActionPtr;
 
 /*************
  * Callbacks *
@@ -36,27 +31,27 @@ typedef StorageAction *StorageActionPtr;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Storage creation *
- * @details Callback functions have the following signature: `void(StoragePtr)`
+ * @details Callback functions have the following signature: `void(Storage*)`
  */
-extern surf_callback(void, StoragePtr) storageCreatedCallbacks;
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*)>) storageCreatedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Storage destruction *
  * @details Callback functions have the following signature: `void(StoragePtr)`
  */
-extern surf_callback(void, StoragePtr) storageDestructedCallbacks;
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*)>) storageDestructedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Storage State changed *
- * @details Callback functions have the following signature: `void(StorageActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)`
+ * @details Callback functions have the following signature: `void(StorageAction *action, int previouslyOn, int currentlyOn)`
  */
-extern surf_callback(void, StoragePtr, e_surf_resource_state_t, e_surf_resource_state_t) storageStateChangedCallbacks;
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::Storage*, int, int)>) storageStateChangedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
- * @details Callback functions have the following signature: `void(StorageActionPtr action, e_surf_action_state_t old, e_surf_action_state_t current)`
+ * @details Callback functions have the following signature: `void(StorageAction *action, simgrid::surf::Action::State old, simgrid::surf::Action::State current)`
  */
-extern surf_callback(void, StorageActionPtr, e_surf_action_state_t, e_surf_action_state_t) storageActionStateChangedCallbacks;
+XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::StorageAction*, simgrid::surf::Action::State, simgrid::surf::Action::State)>) storageActionStateChangedCallbacks;
 
 /*********
  * Model *
@@ -67,35 +62,13 @@ extern surf_callback(void, StorageActionPtr, e_surf_action_state_t, e_surf_actio
  */
 class StorageModel : public Model {
 public:
-  /**
-   * @brief The storage model constructor
-   */
   StorageModel();
-
-  /**
-   * @brief The Storange model destructor
-   */
   ~StorageModel();
 
-  /**
-   * @brief Create a Storage
-   *
-   * @param id [description]
-   * @param type_id [description]
-   * @param content_name [description]
-   * @param content_type [description]
-   * @param properties [description]
-   * @param attach [description]
-   * @return The created Storage
-   */
-  virtual StoragePtr createResource(const char* id,
-                                    const char* type_id,
-                                    const char* content_name,
-                                    const char* content_type,
-                                    xbt_dict_t properties,
-                                    const char *attach) = 0;
-
-  xbt_dynar_t p_storageList;
+  virtual Storage* createStorage(const char* id, const char* type_id, const char* content_name,
+                                 const char* content_type, const char* attach) = 0;
+
+  std::vector<Storage*> p_storageList;
 };
 
 /************
@@ -105,22 +78,9 @@ public:
  * @brief SURF storage interface class
  * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
  */
-class Storage : public Resource {
+class Storage : public simgrid::surf::Resource,
+        public simgrid::surf::PropertyHolder {
 public:
-  /**
-   * @brief Storage constructor
-   *
-   * @param model StorageModel associated to this Storage
-   * @param name The name of the Storage
-   * @param props Dictionary of properties associated to this Storage
-   * @param type_id [description]
-   * @param content_name [description]
-   * @param content_type [description]
-   * @param size [description]
-   */
-  Storage(ModelPtr model, const char *name, xbt_dict_t props,
-          const char* type_id, char *content_name, char *content_type,
-          sg_size_t size);
 
   /**
    * @brief Storage constructor
@@ -128,51 +88,26 @@ public:
    * @param model StorageModel associated to this Storage
    * @param name The name of the Storage
    * @param props Dictionary of properties associated to this Storage
-   * @param maxminSystem [description]
-   * @param bread [description]
-   * @param bwrite [description]
-   * @param bconnection [description]
-   * @param type_id [description]
-   * @param content_name [description]
-   * @param content_type [description]
-   * @param size [description]
-   * @param attach [description]
    */
-  Storage(ModelPtr model, const char *name, xbt_dict_t props,
-          lmm_system_t maxminSystem, double bread, double bwrite,
-          double bconnection,
-          const char* type_id, char *content_name, char *content_type,
-          sg_size_t size, char *attach);
+  Storage(Model* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite, double bconnection,
+          const char* type_id, const char* content_name, const char* content_type, sg_size_t size, const char* attach);
 
-  /**
-   * @brief Storage destructor
-   */
   ~Storage();
 
-  /**
-   * @brief Check if the Storage is used
-   *
-   * @return true if the current Storage is used, false otherwise
-   */
-  bool isUsed();
+  /** @brief Check if the Storage is used (if an action currently uses its resources) */
+  bool isUsed() override;
 
-  /**
-   * @brief Update the state of the current Storage
-   *
-   * @param event_type [description]
-   * @param value [description]
-   * @param date [description]
-   */
-  void updateState(tmgr_trace_event_t event_type, double value, double date);
+  void apply_event(tmgr_trace_iterator_t event, double value) override;
 
-  void setState(e_surf_resource_state_t state);
+  void turnOn() override;
+  void turnOff() override;
 
-  xbt_dict_t p_content;
-  char* p_contentType;
-  sg_size_t m_size;
-  sg_size_t m_usedSize;
-  char * p_typeId;
-  char* p_attach;
+  std::map<std::string, sg_size_t*>* content_;
+  char* contentType_;
+  sg_size_t size_;
+  sg_size_t usedSize_;
+  char * typeId_;
+  char* attach_; //FIXME: this is the name of the host. Use the host directly
 
   /**
    * @brief Open a file
@@ -182,7 +117,7 @@ public:
    *
    * @return The StorageAction corresponding to the opening
    */
-  virtual StorageActionPtr open(const char* mount, const char* path)=0;
+  virtual StorageAction *open(const char* mount, const char* path)=0;
 
   /**
    * @brief Close a file
@@ -190,16 +125,7 @@ public:
    * @param fd The file descriptor to close
    * @return The StorageAction corresponding to the closing
    */
-  virtual StorageActionPtr close(surf_file_t fd)=0;
-
-  /**
-   * @brief List directory contents of a path
-   * @details [long description]
-   *
-   * @param path The path to the directory
-   * @return The StorageAction corresponding to the ls action
-   */
-  virtual StorageActionPtr ls(const char *path)=0;
+  virtual StorageAction *close(surf_file_t fd)=0;
 
   /**
    * @brief Read a file
@@ -208,7 +134,7 @@ public:
    * @param size The size in bytes to read
    * @return The StorageAction corresponding to the reading
    */
-  virtual StorageActionPtr read(surf_file_t fd, sg_size_t size)=0;
+  virtual StorageAction *read(surf_file_t fd, sg_size_t size)=0;
 
   /**
    * @brief Write a file
@@ -217,28 +143,35 @@ public:
    * @param size The size in bytes to write
    * @return The StorageAction corresponding to the writing
    */
-  virtual StorageActionPtr write(surf_file_t fd, sg_size_t size)=0;
+  virtual StorageAction *write(surf_file_t fd, sg_size_t size)=0;
 
   /**
    * @brief Get the content of the current Storage
    *
    * @return A xbt_dict_t with path as keys and size in bytes as values
    */
-  virtual xbt_dict_t getContent();
+  virtual std::map<std::string, sg_size_t*>* getContent();
+
+  /**
+   * @brief Get the available size in bytes of the current Storage
+   *
+   * @return The available size in bytes of the current Storage
+   */
+  virtual sg_size_t getFreeSize();
 
   /**
-   * @brief Get the size in bytes of the current Storage
+   * @brief Get the used size in bytes of the current Storage
    *
-   * @return The size in bytes of the current Storage
+   * @return The used size in bytes of the current Storage
    */
-  virtual sg_size_t getSize();
+  virtual sg_size_t getUsedSize();
 
-  xbt_dict_t parseContent(char *filename);
+  std::map<std::string, sg_size_t*>* parseContent(const char* filename);
 
-  xbt_dynar_t p_writeActions;
+  std::vector<StorageAction*> writeActions_;
 
-  lmm_constraint_t p_constraintWrite;    /* Constraint for maximum write bandwidth*/
-  lmm_constraint_t p_constraintRead;     /* Constraint for maximum write bandwidth*/
+  lmm_constraint_t constraintWrite_;    /* Constraint for maximum write bandwidth*/
+  lmm_constraint_t constraintRead_;     /* Constraint for maximum write bandwidth*/
 };
 
 /**********
@@ -253,8 +186,7 @@ typedef enum {
   WRITE,  /**< Write in a file */
   STAT,   /**< Stat a file */
   OPEN,   /**< Open a file */
-  CLOSE,  /**< Close a file */
-  LS      /**< List directory contents */
+  CLOSE  /**< Close a file */
 } e_surf_action_storage_type_t;
 
 /** @ingroup SURF_storage_interface
@@ -262,11 +194,6 @@ typedef enum {
  */
 class StorageAction : public Action {
 public:
-  /**
-   * @brief StorageAction constructor
-   */
-  StorageAction() : m_type(READ) {};//FIXME:REMOVE
-
   /**
    * @brief StorageAction constructor
    *
@@ -276,8 +203,8 @@ public:
    * @param storage The Storage associated to this StorageAction
    * @param type [description]
    */
-  StorageAction(ModelPtr model, double cost, bool failed,
-                           StoragePtr storage, e_surf_action_storage_type_t type);
+  StorageAction(Model *model, double cost, bool failed, Storage *storage,
+      e_surf_action_storage_type_t type);
 
     /**
    * @brief StorageAction constructor
@@ -289,31 +216,36 @@ public:
    * @param storage The Storage associated to this StorageAction
    * @param type [description]
    */
-  StorageAction(ModelPtr model, double cost, bool failed, lmm_variable_t var,
-                           StoragePtr storage, e_surf_action_storage_type_t type);
+  StorageAction(Model *model, double cost, bool failed, lmm_variable_t var,
+      Storage *storage, e_surf_action_storage_type_t type);
 
-  void setState(e_surf_action_state_t state);
+  void setState(simgrid::surf::Action::State state) override;
 
-  e_surf_action_storage_type_t m_type;
-  StoragePtr p_storage;
-  surf_file_t p_file;
-  xbt_dict_t p_lsDict;
+  e_surf_action_storage_type_t type_;
+  Storage* storage_;
+  surf_file_t file_;
+  double progress_;
 };
 
+}
+}
+
 typedef struct s_storage_type {
   char *model;
   char *content;
   char *content_type;
   char *type_id;
   xbt_dict_t properties;
-  xbt_dict_t model_properties;
+  std::map<std::string, std::string>* model_properties;
   sg_size_t size;
-} s_storage_type_t, *storage_type_t;
+} s_storage_type_t;
+typedef s_storage_type_t* storage_type_t;
 
 typedef struct s_mount {
   void *storage;
   char *name;
-} s_mount_t, *mount_t;
+} s_mount_t;
+typedef s_mount_t* mount_t;
 
 typedef struct surf_file {
   char *name;
@@ -322,5 +254,4 @@ typedef struct surf_file {
   sg_size_t current_position;
 } s_surf_file_t;
 
-
 #endif /* STORAGE_INTERFACE_HPP_ */