Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Snake case.
[simgrid.git] / src / surf / StorageImpl.hpp
index 6575a18..da13a3c 100644 (file)
@@ -1,63 +1,39 @@
-/* Copyright (c) 2004-2018. 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/Action.hpp"
-#include "src/kernel/resource/Model.hpp"
-#include "src/kernel/resource/Resource.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(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(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(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::kernel::resource::Action::State old, simgrid::kernel::resource::Action::State current)`
+/** @ingroup SURF_storage_interface
+ * @brief The possible type of action for the storage component
  */
-XBT_PUBLIC_DATA
-simgrid::xbt::signal<void(StorageAction*, kernel::resource::Action::State, kernel::resource::Action::State)>
-    storageActionStateChangedCallbacks;
 
 /*********
  * Model *
@@ -69,10 +45,12 @@ simgrid::xbt::signal<void(StorageAction*, kernel::resource::Action::State, kerne
 class StorageModel : public kernel::resource::Model {
 public:
   StorageModel();
+  StorageModel(const StorageModel&) = delete;
+  StorageModel& operator=(const StorageModel&) = delete;
   ~StorageModel();
 
-  virtual StorageImpl* createStorage(std::string id, std::string type_id, std::string content_name,
-                                     std::string attach) = 0;
+  virtual StorageImpl* createStorage(const std::string& id, const std::string& type_id, const std::string& content_name,
+                                     const std::string& attach) = 0;
 };
 
 /************
@@ -82,11 +60,13 @@ public:
  * @brief SURF storage interface class
  * @details A Storage represent a storage unit (e.g.: hard drive, usb key)
  */
-class StorageImpl : public kernel::resource::Resource, public PropertyHolder {
+class StorageImpl : public Resource, public surf::PropertyHolder {
 public:
   /** @brief Storage constructor */
-  StorageImpl(kernel::resource::Model* model, std::string name, lmm_system_t maxminSystem, double bread, double bwrite,
-              std::string type_id, std::string content_name, sg_size_t size, std::string 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;
 
@@ -94,13 +74,15 @@ public:
   s4u::Storage piface_;
 
   /** @brief Check if the Storage is used (if an action currently uses its resources) */
-  bool isUsed() override;
+  bool is_used() override;
 
-  void apply_event(tmgr_trace_event_t event, double value) override;
+  void apply_event(profile::Event* event, double value) override;
 
-  void turnOn() override;
-  void turnOff() override;
+  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
    *
@@ -116,16 +98,17 @@ public:
    * @return The StorageAction corresponding to the writing
    */
   virtual StorageAction* write(sg_size_t size) = 0;
-  virtual std::string getHost() { return attach_; }
+  const std::string& get_host() const { return attach_; }
 
-  kernel::lmm::Constraint* constraintWrite_; /* Constraint for maximum write bandwidth*/
-  kernel::lmm::Constraint* constraintRead_;  /* Constraint for maximum write bandwidth*/
+  lmm::Constraint* constraint_write_; /* Constraint for maximum write bandwidth*/
+  lmm::Constraint* constraint_read_;  /* Constraint for maximum write bandwidth*/
 
   std::string typeId_;
-  std::string content_name; // Only used at parsing time then goes to the FileSystemExtension
+  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_;
@@ -136,29 +119,27 @@ private:
  **********/
 
 /** @ingroup SURF_storage_interface
- * @brief The possible type of action for the storage component
- */
-enum e_surf_action_storage_type_t {
-  READ = 0, /**< Read a file */
-  WRITE     /**< Write in a file */
-};
-
-/** @ingroup SURF_storage_interface
  * @brief SURF storage action interface class
  */
-class StorageAction : public kernel::resource::Action {
+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(kernel::resource::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){};
 
   /**
@@ -172,12 +153,12 @@ public:
  * @param type [description]
  */
   StorageAction(kernel::resource::Model* model, double cost, bool failed, kernel::lmm::Variable* var,
-                StorageImpl* storage, e_surf_action_storage_type_t type)
+                StorageImpl* storage, s4u::Io::OpType type)
       : Action(model, cost, failed, var), type_(type), storage_(storage){};
 
-  void setState(simgrid::kernel::resource::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_;
 };
 
@@ -186,16 +167,18 @@ public:
   std::string id;
   std::string model;
   std::string content;
-  std::map<std::string, std::string>* properties;
-  std::map<std::string, std::string>* model_properties;
+  std::unordered_map<std::string, std::string>* properties;
+  std::unordered_map<std::string, std::string>* model_properties;
   sg_size_t size;
-  StorageType(std::string id, std::string model, std::string content, std::map<std::string, std::string>* properties,
-              std::map<std::string, std::string>* model_properties, sg_size_t size)
+  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_ */