X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ad2e588c6af6cf84b18ba7c1c96f4f9785d93c28..62dcd7bdc99162b0675bbc9100a36b53ebe65f29:/src/surf/storage_interface.hpp diff --git a/src/surf/storage_interface.hpp b/src/surf/storage_interface.hpp index c606e11524..631299e9f2 100644 --- a/src/surf/storage_interface.hpp +++ b/src/surf/storage_interface.hpp @@ -1,34 +1,57 @@ -/* Copyright (c) 2004-2013. The SimGrid Team. +/* 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 * @@ -39,28 +62,27 @@ typedef StorageAction *StorageActionPtr; */ class StorageModel : public Model { public: - /** - * @brief The storage model constructor - */ StorageModel(); - - /** - * @brief The Storange model destructor - */ ~StorageModel(); - /** - * @brief Create a Storage - * + /** @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 StoragePtr createResource(const char* id, const char* type_id, - const char* content_name, const char* content_type, xbt_dict_t properties)=0; + 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; }; @@ -72,33 +94,30 @@ public: * @brief SURF storage interface class * @details A Storage represent a storage unit (e.g.: hard drive, usb key) */ -class Storage : public Resource { +class Storage : public simgrid::surf::Resource, + public simgrid::surf::PropertyHolder { 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); + 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 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] @@ -107,106 +126,103 @@ public: * @param content_name [description] * @param content_type [description] * @param size [description] + * @param attach [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); + 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); - /** - * @brief Storage destructor - */ ~Storage(); - /** - * @brief Check if the Storage is used - * - * @return true if the current Storage is used, false otherwise - */ + /** @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 StorageActionPtr open(const char* mount, const char* path)=0; + 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 StorageActionPtr close(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; + 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 StorageActionPtr read(surf_file_t fd, sg_size_t size)=0; + 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 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; + 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; @@ -226,8 +242,7 @@ typedef enum { WRITE, /**< Write in a file */ STAT, /**< Stat a file */ OPEN, /**< Open a file */ - CLOSE, /**< Close a file */ - LS /**< List directory contents */ + CLOSE /**< Close a file */ } e_surf_action_storage_type_t; /** @ingroup SURF_storage_interface @@ -237,24 +252,19 @@ 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); + 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] @@ -262,21 +272,27 @@ public: * @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); + 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;