X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e67606cb94466ad834686a11799c045f8948873c..ad2e588c6af6cf84b18ba7c1c96f4f9785d93c28:/src/surf/storage_interface.hpp diff --git a/src/surf/storage_interface.hpp b/src/surf/storage_interface.hpp index d11f501f3c..c606e11524 100644 --- a/src/surf/storage_interface.hpp +++ b/src/surf/storage_interface.hpp @@ -1,3 +1,9 @@ +/* Copyright (c) 2004-2013. 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 "surf_interface.hpp" #ifndef STORAGE_INTERFACE_HPP_ @@ -27,10 +33,32 @@ typedef StorageAction *StorageActionPtr; /********* * 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: + /** + * @brief The storage model constructor + */ StorageModel(); + + /** + * @brief The Storange model destructor + */ ~StorageModel(); + + /** + * @brief Create a Storage + * + * @param id [description] + * @param type_id [description] + * @param content_name [description] + * @param content_type [description] + * @param properties [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)=0; @@ -40,17 +68,69 @@ 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 Resource { public: + /** + * @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 constraint The lmm constraint associated to this Storage if it is part of a LMM component + * @param model [description] + * @param name [description] + * @param props [description] + * @param type_id [description] + * @param content_name [description] + * @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, 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 constraint The lmm constraint associated to this Storage if it is part of a LMM component + * @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] + */ 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 destructor + */ ~Storage(); + /** + * @brief Check if the Storage is used + * + * @return true if the current Storage is used, false otherwise + */ 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); xbt_dict_t p_content; @@ -59,15 +139,71 @@ public: sg_size_t m_usedSize; char * p_typeId; + /** + * @brief Open a file + * + * @param mount The mount point + * @param path The path to the file + * + * @return The StorageAction corresponding to the opening + */ virtual StorageActionPtr 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 StorageActionPtr close(surf_file_t fd)=0; - //virtual StorageActionPtr unlink(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; + + /** + * @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 StorageActionPtr 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 StorageActionPtr write(surf_file_t fd, sg_size_t size)=0; + + /** + * @brief Rename a path + * + * @param src The old path + * @param dest The new path + */ virtual void rename(const char *src, const char *dest)=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); @@ -82,18 +218,52 @@ 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 */ + LS /**< List directory contents */ } e_surf_action_storage_type_t; - +/** @ingroup SURF_storage_interface + * @brief SURF storage action interface class + */ class StorageAction : public Action { public: + /** + * @brief StorageAction constructor + */ StorageAction() : m_type(READ) {};//FIXME:REMOVE + + /** + * @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(ModelPtr model, double cost, bool failed, - StoragePtr storage, e_surf_action_storage_type_t type); + 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 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(ModelPtr model, double cost, bool failed, lmm_variable_t var, - StoragePtr storage, e_surf_action_storage_type_t type); + StoragePtr storage, e_surf_action_storage_type_t type); e_surf_action_storage_type_t m_type; StoragePtr p_storage;