Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Snake case.
[simgrid.git] / src / surf / StorageImpl.hpp
index 4cfb23d..da13a3c 100644 (file)
@@ -1,60 +1,39 @@
-/* Copyright (c) 2004-2017. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2019. 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 "simgrid/kernel/resource/Action.hpp"
+#include "simgrid/kernel/resource/Model.hpp"
+#include "simgrid/kernel/resource/Resource.hpp"
+#include "simgrid/s4u/Io.hpp"
 #include "simgrid/s4u/Storage.hpp"
+#include "src/kernel/resource/profile/trace_mgr.hpp"
 #include "src/surf/PropertyHolder.hpp"
 #include "surf_interface.hpp"
+
 #include <map>
 
 #ifndef STORAGE_INTERFACE_HPP_
 #define STORAGE_INTERFACE_HPP_
 
-namespace simgrid {
-namespace surf {
+/*********
+ * Model *
+ *********/
+
+XBT_PUBLIC_DATA simgrid::kernel::resource::StorageModel* surf_storage_model;
 
+namespace simgrid {
+namespace kernel {
+namespace resource {
 /***********
  * Classes *
  ***********/
 
 class StorageAction;
-
-/*************
- * Callbacks *
- *************/
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Storage creation *
- * @details Callback functions have the following signature: `void(Storage*)`
- */
-XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::StorageImpl*)>) storageCreatedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Storage destruction *
- * @details Callback functions have the following signature: `void(StoragePtr)`
- */
-XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::StorageImpl*)>) storageDestructedCallbacks;
-
-/** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after Storage State changed *
- * @details Callback functions have the following signature: `void(StorageAction *action, int previouslyOn, int
- * currentlyOn)`
- */
-XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::StorageImpl*, 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(StorageAction *action, simgrid::surf::Action::State
- * old, simgrid::surf::Action::State current)`
+/** @ingroup SURF_storage_interface
+ * @brief The possible type of action for the storage component
  */
-XBT_PUBLIC_DATA(simgrid::xbt::signal<void(simgrid::surf::StorageAction*, simgrid::surf::Action::State,
-                                          simgrid::surf::Action::State)>)
-storageActionStateChangedCallbacks;
 
 /*********
  * Model *
@@ -63,15 +42,15 @@ storageActionStateChangedCallbacks;
  * @brief SURF storage model interface class
  * @details A model is an object which handle the interactions between its Resources and its Actions
  */
-class StorageModel : public Model {
+class StorageModel : public kernel::resource::Model {
 public:
   StorageModel();
+  StorageModel(const StorageModel&) = delete;
+  StorageModel& operator=(const StorageModel&) = delete;
   ~StorageModel();
 
-  virtual StorageImpl* createStorage(const char* id, const char* type_id, const char* content_name,
-                                     const char* attach) = 0;
-
-  std::vector<StorageImpl*> p_storageList;
+  virtual StorageImpl* createStorage(const std::string& id, const std::string& type_id, const std::string& content_name,
+                                     const std::string& attach) = 0;
 };
 
 /************
@@ -81,98 +60,58 @@ public:
  * @brief SURF storage interface class
  * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
  */
-class StorageImpl : public simgrid::surf::Resource, public simgrid::surf::PropertyHolder {
+class StorageImpl : public Resource, public surf::PropertyHolder {
 public:
   /** @brief Storage constructor */
-  StorageImpl(Model* model, const char* name, lmm_system_t maxminSystem, double bread, double bwrite,
-              const char* type_id, const char* content_name, sg_size_t size, const char* attach);
+  StorageImpl(Model* model, const std::string& name, kernel::lmm::System* maxmin_system, double bread, double bwrite,
+              const std::string& type_id, const std::string& content_name, sg_size_t size, const std::string& attach);
+  StorageImpl(const StorageImpl&) = delete;
+  StorageImpl& operator=(const StorageImpl&) = delete;
 
   ~StorageImpl() override;
 
-public:
   /** @brief Public interface */
   s4u::Storage piface_;
-  static StorageImpl* byName(const char* name);
 
   /** @brief Check if the Storage is used (if an action currently uses its resources) */
-  bool isUsed() override;
-
-  void apply_event(tmgr_trace_event_t event, double value) override;
+  bool is_used() override;
 
-  void turnOn() override;
-  void turnOff() override;
+  void apply_event(profile::Event* event, double value) override;
 
-  std::map<std::string, sg_size_t>* content_;
-  sg_size_t size_;
-  sg_size_t usedSize_;
-  std::string typeId_;
-  std::string attach_; // Name of the host to which this storage is attached.
-                       // Only used until the platform is fully parsed only.
-                       // Then the interface stores the Host directly.
-                       /**
-                        * @brief Open a file
-                        *
-                        * @param mount The mount point
-                        * @param path The path to the file
-                        *
-                        * @return The StorageAction corresponding to the opening
-                        */
-  virtual StorageAction* open(const char* mount, const char* path) = 0;
-
-  /**
-   * @brief Close a file
-   *
-   * @param fd The file descriptor to close
-   * @return The StorageAction corresponding to the closing
-   */
-  virtual StorageAction* close(surf_file_t fd) = 0;
+  void turn_on() override;
+  void turn_off() override;
 
+  void destroy(); // Must be called instead of the destructor
+  virtual Action* io_start(sg_size_t size, s4u::Io::OpType type) = 0;
   /**
    * @brief Read a file
    *
-   * @param fd The file descriptor to read
    * @param size The size in bytes to read
    * @return The StorageAction corresponding to the reading
    */
-  virtual StorageAction* read(surf_file_t fd, sg_size_t size) = 0;
+  virtual StorageAction* read(sg_size_t size) = 0;
 
   /**
    * @brief Write a file
    *
-   * @param fd The file descriptor to write
    * @param size The size in bytes to write
    * @return The StorageAction corresponding to the writing
    */
-  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 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 used size in bytes of the current Storage
-   *
-   * @return The used size in bytes of the current Storage
-   */
-  virtual sg_size_t getUsedSize();
+  virtual StorageAction* write(sg_size_t size) = 0;
+  const std::string& get_host() const { return attach_; }
 
-  std::map<std::string, sg_size_t>* parseContent(const char* filename);
-  static std::unordered_map<std::string, StorageImpl*>* storages;
-  static std::unordered_map<std::string, StorageImpl*>* storagesMap() { return StorageImpl::storages; }
-  std::vector<StorageAction*> writeActions_;
+  lmm::Constraint* constraint_write_; /* Constraint for maximum write bandwidth*/
+  lmm::Constraint* constraint_read_;  /* Constraint for maximum write bandwidth*/
 
-  lmm_constraint_t constraintWrite_; /* Constraint for maximum write bandwidth*/
-  lmm_constraint_t constraintRead_;  /* Constraint for maximum write bandwidth*/
+  std::string typeId_;
+  std::string content_name_; // Only used at parsing time then goes to the FileSystemExtension
+  sg_size_t size_;          // Only used at parsing time then goes to the FileSystemExtension
+
+private:
+  bool currently_destroying_ = false;
+  // Name of the host to which this storage is attached. Only used at platform parsing time, then the interface stores
+  // the Host directly.
+  std::string attach_;
 };
 
 /**********
@@ -180,31 +119,28 @@ public:
  **********/
 
 /** @ingroup SURF_storage_interface
- * @brief The possible type of action for the storage component
- */
-typedef enum {
-  READ = 0, /**< Read a file */
-  WRITE,    /**< Write in a file */
-  STAT,     /**< Stat a file */
-  OPEN,     /**< Open a file */
-  CLOSE     /**< Close a file */
-} e_surf_action_storage_type_t;
-
-/** @ingroup SURF_storage_interface
  * @brief SURF storage action interface class
  */
 class StorageAction : public Action {
 public:
   /**
+   * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
+   * @details Callback functions have the following signature: `void(StorageAction& action,
+   * simgrid::kernel::resource::Action::State old, simgrid::kernel::resource::Action::State current)`
+   */
+  static xbt::signal<void(StorageAction const&, Action::State, Action::State)> on_state_change;
+
+  /**
    * @brief StorageAction constructor
    *
    * @param model The StorageModel associated to this StorageAction
-   * @param cost The cost of this  NetworkAction in [TODO]
+   * @param cost The cost of this StorageAction in bytes
    * @param failed [description]
    * @param storage The Storage associated to this StorageAction
    * @param type [description]
    */
-  StorageAction(Model* model, double cost, bool failed, StorageImpl* storage, e_surf_action_storage_type_t type);
+  StorageAction(Model* model, double cost, bool failed, StorageImpl* storage, s4u::Io::OpType type)
+      : Action(model, cost, failed), type_(type), storage_(storage){};
 
   /**
  * @brief StorageAction constructor
@@ -216,27 +152,33 @@ public:
  * @param storage The Storage associated to this StorageAction
  * @param type [description]
  */
-  StorageAction(Model* model, double cost, bool failed, lmm_variable_t var, StorageImpl* storage,
-                e_surf_action_storage_type_t type);
+  StorageAction(kernel::resource::Model* model, double cost, bool failed, kernel::lmm::Variable* var,
+                StorageImpl* storage, s4u::Io::OpType type)
+      : Action(model, cost, failed, var), type_(type), storage_(storage){};
 
-  void setState(simgrid::surf::Action::State state) override;
+  void set_state(simgrid::kernel::resource::Action::State state) override;
 
-  e_surf_action_storage_type_t type_;
+  s4u::Io::OpType type_;
   StorageImpl* storage_;
-  FileImpl* file_;
-  double progress_;
 };
-}
-}
-
-typedef struct s_storage_type {
-  char* model;
-  char* content;
-  char* type_id;
-  xbt_dict_t properties;
-  std::map<std::string, std::string>* model_properties;
+
+class StorageType {
+public:
+  std::string id;
+  std::string model;
+  std::string content;
+  std::unordered_map<std::string, std::string>* properties;
+  std::unordered_map<std::string, std::string>* model_properties;
   sg_size_t size;
-} s_storage_type_t;
-typedef s_storage_type_t* storage_type_t;
+  StorageType(const std::string& id, const std::string& model, const std::string& content,
+              std::unordered_map<std::string, std::string>* properties,
+              std::unordered_map<std::string, std::string>* model_properties, sg_size_t size)
+      : id(id), model(model), content(content), properties(properties), model_properties(model_properties), size(size)
+  {
+  }
+};
 
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid
 #endif /* STORAGE_INTERFACE_HPP_ */