X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c39f643b5bfb0e99887c209a94e49f841a2daae4..62dcd7bdc99162b0675bbc9100a36b53ebe65f29:/src/surf/storage_interface.hpp diff --git a/src/surf/storage_interface.hpp b/src/surf/storage_interface.hpp index d11f501f3c..631299e9f2 100644 --- a/src/surf/storage_interface.hpp +++ b/src/surf/storage_interface.hpp @@ -1,38 +1,88 @@ +/* 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 + #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 StorageAction; -class Storage; -typedef Storage *StoragePtr; +/************* + * Callbacks * + *************/ -class StorageAction; -typedef StorageAction *StorageActionPtr; +/** @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::surf::signal) storageCreatedCallbacks; -class StorageAction; -typedef StorageAction *StorageActionPtr; +/** @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::surf::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, e_surf_resource_state_t old, e_surf_resource_state_t current)` + */ +XBT_PUBLIC_DATA(simgrid::surf::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, e_surf_action_state_t old, e_surf_action_state_t current)` + */ +XBT_PUBLIC_DATA(simgrid::surf::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; + + /** @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 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 shareResourcesIsIdempotent() {return true;} xbt_dynar_t p_storageList; }; @@ -40,37 +90,139 @@ public: /************ * Resource * ************/ - -class Storage : 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(ModelPtr model, const char *name, xbt_dict_t props, - const char* type_id, char *content_name, char *content_type, sg_size_t size); - 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); + /** + * @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(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); + + /** + * @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 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(Model *model, const char *name, xbt_dict_t props, + 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); + ~Storage(); + /** @brief Check if the Storage is used (if an action currently uses its resources) */ bool isUsed(); + + /** + * @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 setState(e_surf_resource_state_t state); + xbt_dict_t p_content; char* p_contentType; sg_size_t m_size; sg_size_t m_usedSize; char * p_typeId; + char* p_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; - 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; + /** + * @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 xbt_dict_t getContent(); + + /** + * @brief Get the size in bytes of the current Storage + * + * @return The size in bytes of the current Storage + */ 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_dict_t parseContent(const char *filename); xbt_dynar_t p_writeActions; @@ -82,31 +234,65 @@ public: * 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; - +/** @ingroup SURF_storage_interface + * @brief SURF storage action interface class + */ class StorageAction : public Action { public: - StorageAction() : m_type(READ) {};//FIXME:REMOVE - StorageAction(ModelPtr model, double cost, bool failed, - StoragePtr storage, e_surf_action_storage_type_t type); - StorageAction(ModelPtr model, double cost, bool failed, lmm_variable_t var, - StoragePtr 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 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(e_surf_action_state_t state); 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; char *content_type; char *type_id; xbt_dict_t properties; + xbt_dict_t model_properties; sg_size_t size; } s_storage_type_t, *storage_type_t;