X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/18d23a87c23647366cfffbc61d3f7c632301159c..4a69abcc786d029bd2962537f767d12a0f808d11:/src/surf/storage_interface.hpp diff --git a/src/surf/storage_interface.hpp b/src/surf/storage_interface.hpp index 634bd942d4..f52d57b3b9 100644 --- a/src/surf/storage_interface.hpp +++ b/src/surf/storage_interface.hpp @@ -1,111 +1,234 @@ +/* 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 +#include + +#include "src/surf/PropertyHolder.hpp" #include "surf_interface.hpp" +#include #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 StorageLmm; -typedef StorageLmm *StorageLmmPtr; - class StorageAction; -typedef StorageAction *StorageActionPtr; -class StorageActionLmm; -typedef StorageActionLmm *StorageActionLmmPtr; +/************* + * 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) 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) 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) 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)` + */ +XBT_PUBLIC_DATA(simgrid::xbt::signal) storageActionStateChangedCallbacks; /********* * Model * *********/ +/** @ingroup SURF_storage_interface + * @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 { public: StorageModel(); ~StorageModel(); - virtual StoragePtr createResource(const char* id, const char* type_id, - const char* content_name, const char* content_type, xbt_dict_t properties)=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 p_storageList; }; /************ * Resource * ************/ - -class Storage : virtual public Resource { +/** @ingroup SURF_storage_interface + * @brief SURF storage interface class + * @details A Storage represent a storage unit (e.g.: hard drive, usb key) + */ +class Storage : public simgrid::surf::Resource, + public simgrid::surf::PropertyHolder { public: - Storage(const char* type_id, char *content_name, char *content_type, sg_size_t size); - ~Storage(); - - bool isUsed(); - void updateState(tmgr_trace_event_t event_type, double value, double date); - - xbt_dict_t p_content; - char* p_contentType; - sg_size_t m_size; - sg_size_t m_usedSize; - char * p_typeId; - - virtual StorageActionPtr open(const char* mount, const char* path)=0; - virtual StorageActionPtr close(surf_file_t fd)=0; - //virtual StorageActionPtr unlink(surf_file_t fd)=0; - virtual StorageActionPtr ls(const char *path)=0; - virtual StorageActionPtr read(surf_file_t fd, sg_size_t size)=0; - virtual StorageActionPtr write(surf_file_t fd, sg_size_t size)=0; - virtual void rename(const char *src, const char *dest)=0; - virtual xbt_dict_t getContent(); - virtual sg_size_t getSize(); + /** + * @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 + */ + 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); - xbt_dict_t parseContent(char *filename); - - xbt_dynar_t p_writeActions; -}; - -class StorageLmm : public ResourceLmm, public Storage { -public: - StorageLmm(lmm_system_t maxminSystem, double bread, double bwrite, double bconnection, - const char* type_id, char *content_name, char *content_type, sg_size_t size); + ~Storage(); - lmm_constraint_t p_constraintWrite; /* Constraint for maximum write bandwidth*/ - lmm_constraint_t p_constraintRead; /* Constraint for maximum write bandwidth*/ + /** @brief Check if the Storage is used (if an action currently uses its resources) */ + bool isUsed() override; + + void apply_event(tmgr_trace_iterator_t event, double value) override; + + void turnOn() override; + void turnOff() override; + + std::map* 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 + * + * @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; + + /** + * @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; + + /** + * @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* 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(); + + std::map* parseContent(const char* filename); + + std::vector writeActions_; + + lmm_constraint_t constraintWrite_; /* Constraint for maximum write bandwidth*/ + lmm_constraint_t constraintRead_; /* Constraint for maximum write bandwidth*/ }; /********** * Action * **********/ +/** @ingroup SURF_storage_interface + * @brief The possible type of action for the storage component + */ typedef enum { - READ=0, WRITE, STAT, OPEN, CLOSE, LS + 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; - -class StorageAction : virtual public Action { +/** @ingroup SURF_storage_interface + * @brief SURF storage action interface class + */ +class StorageAction : public Action { public: - StorageAction() : m_type(READ) {};//FIXME:REMOVE - StorageAction(StoragePtr storage, e_surf_action_storage_type_t type); - - e_surf_action_storage_type_t m_type; - StoragePtr p_storage; - surf_file_t p_file; - xbt_dict_t p_lsDict; + /** + * @brief StorageAction constructor + * + * @param model The StorageModel associated to this StorageAction + * @param cost The cost of this NetworkAction in [TODO] + * @param failed [description] + * @param storage The Storage associated to this StorageAction + * @param type [description] + */ + StorageAction(Model *model, double cost, bool failed, Storage *storage, + e_surf_action_storage_type_t type); + + /** + * @brief StorageAction constructor + * + * @param model The StorageModel associated to this StorageAction + * @param cost The cost of this StorageAction in [TODO] + * @param failed [description] + * @param var The lmm variable associated to this StorageAction if it is part of a LMM component + * @param storage The Storage associated to this StorageAction + * @param type [description] + */ + StorageAction(Model *model, double cost, bool failed, lmm_variable_t var, + Storage *storage, e_surf_action_storage_type_t type); + + void setState(simgrid::surf::Action::State state) override; + + e_surf_action_storage_type_t type_; + Storage* storage_; + surf_file_t file_; + double progress_; }; -class StorageActionLmm : public ActionLmm, public StorageAction { -public: - StorageActionLmm() {};//FIXME:REMOVE - - StorageActionLmm(StorageLmmPtr storage, e_surf_action_storage_type_t type, lmm_variable_t var); -}; +} +} typedef struct s_storage_type { char *model; @@ -113,13 +236,16 @@ typedef struct s_storage_type { char *content_type; char *type_id; xbt_dict_t properties; + std::map* 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; @@ -128,5 +254,4 @@ typedef struct surf_file { sg_size_t current_position; } s_surf_file_t; - #endif /* STORAGE_INTERFACE_HPP_ */