Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
2 dynar less (but this code is ... improvable)
[simgrid.git] / src / surf / storage_interface.hpp
index db02f42..e8879f9 100644 (file)
@@ -1,34 +1,28 @@
-/* Copyright (c) 2004-2014. The SimGrid Team.
+/* Copyright (c) 2004-2015. 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 "surf_interface.hpp"
+#include "src/surf/PropertyHolder.hpp"
 
 #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 +30,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,18 +61,10 @@ 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
+  /** @brief Create a Storage
    *
    * @param id [description]
    * @param type_id [description]
@@ -88,14 +74,13 @@ public:
    * @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,
+                                 xbt_dict_t properties, const char *attach) = 0;
+
+  bool next_occuring_event_isIdempotent() {return true;}
+
+  std::vector<Storage*> p_storageList;
 };
 
 /************
@@ -105,7 +90,8 @@ 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
@@ -118,8 +104,8 @@ public:
    * @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,
+  Storage(Model *model, const char *name, xbt_dict_t props,
+          const char* type_id, const char *content_name, const char *content_type,
           sg_size_t size);
 
   /**
@@ -138,41 +124,28 @@ public:
    * @param size [description]
    * @param attach [description]
    */
-  Storage(ModelPtr model, const char *name, xbt_dict_t props,
+  Storage(Model *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);
+          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;
+  char* p_attach; //FIXME: this is the name of the host. Use the host directly
 
   /**
    * @brief Open a file
@@ -182,7 +155,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 +163,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 +172,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,7 +181,7 @@ 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
@@ -233,9 +197,24 @@ public:
    */
   virtual sg_size_t getSize();
 
-  xbt_dict_t parseContent(char *filename);
+  /**
+   * @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 used size in bytes of the current Storage
+   *
+   * @return The used size in bytes of the current Storage
+   */
+  virtual sg_size_t getUsedSize();
 
-  xbt_dynar_t p_writeActions;
+
+  xbt_dict_t parseContent(const char *filename);
+
+  std::vector<StorageAction*> p_writeActions;
 
   lmm_constraint_t p_constraintWrite;    /* Constraint for maximum write bandwidth*/
   lmm_constraint_t p_constraintRead;     /* Constraint for maximum write bandwidth*/
@@ -253,8 +232,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
@@ -271,8 +249,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
@@ -284,18 +262,20 @@ 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;
+  Storage *p_storage;
   surf_file_t p_file;
-  xbt_dict_t p_lsDict;
   double progress;
 };
 
+}
+}
+
 typedef struct s_storage_type {
   char *model;
   char *content;
@@ -318,5 +298,4 @@ typedef struct surf_file {
   sg_size_t current_position;
 } s_surf_file_t;
 
-
 #endif /* STORAGE_INTERFACE_HPP_ */