X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/13e0c316176dfe56c04b66d96b65a174e76d0549..cc7e6879786102a1075ac4a51ee714777a8166df:/src/surf/workstation_interface.hpp diff --git a/src/surf/workstation_interface.hpp b/src/surf/workstation_interface.hpp index 5045cec283..da9e455ad6 100644 --- a/src/surf/workstation_interface.hpp +++ b/src/surf/workstation_interface.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2013. The SimGrid Team. +/* Copyright (c) 2004-2014. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it @@ -25,6 +25,34 @@ typedef Workstation *WorkstationPtr; class WorkstationAction; typedef WorkstationAction *WorkstationActionPtr; +/************* + * Callbacks * + *************/ + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emit the callbacks after Workstation creation * + * @details Callback functions have the following signature: `void(WorkstationPtr)` + */ +extern surf_callback(void, WorkstationPtr) workstationCreatedCallbacks; + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emit the callbacks after Workstation destruction * + * @details Callback functions have the following signature: `void(WorkstationPtr)` + */ +extern surf_callback(void, WorkstationPtr) workstationDestructedCallbacks; + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emit the callbacks after Workstation State changed * + * @details Callback functions have the following signature: `void(WorkstationActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)` + */ +extern surf_callback(void, WorkstationPtr, e_surf_resource_state_t, e_surf_resource_state_t) workstationStateChangedCallbacks; + +/** @ingroup SURF_callbacks + * @brief Callbacks handler which emit the callbacks after WorkstationAction State changed * + * @details Callback functions have the following signature: `void(WorkstationActionPtr action, e_surf_resource_state_t old, e_surf_resource_state_t current)` + */ +extern surf_callback(void, WorkstationActionPtr, e_surf_action_state_t, e_surf_action_state_t) workstationActionStateChangedCallbacks; + /********* * Tools * *********/ @@ -39,9 +67,9 @@ extern WorkstationModelPtr surf_workstation_model; */ class WorkstationModel : public Model { public: - /** + /** * @brief WorkstationModel constructor - * + * * @param name the name of the model */ WorkstationModel(const char *name); @@ -61,11 +89,11 @@ public: * @details [long description] */ virtual void adjustWeightOfDummyCpuActions(); - + /** * @brief [brief description] * @details [long description] - * + * * @param workstation_nb [description] * @param workstation_list [description] * @param computation_amount [description] @@ -82,18 +110,7 @@ public: /** * @brief [brief description] * @details [long description] - * - * @param src [description] - * @param dst [description] - * - * @return [description] - */ - virtual xbt_dynar_t getRoute(WorkstationPtr src, WorkstationPtr dst)=0; - - /** - * @brief [brief description] - * @details [long description] - * + * * @param src [description] * @param dst [description] * @param size [description] @@ -116,13 +133,12 @@ class Workstation : public Resource { public: /** * @brief Workstation consrtuctor - * @details [long description] */ - Workstation(){}; + Workstation(); /** * @brief Workstation constructor - * + * * @param model WorkstationModel associated to this Workstation * @param name The name of the Workstation * @param props Dictionary of properties associated to this Workstation @@ -135,7 +151,7 @@ public: /** * @brief Workstation constructor - * + * * @param model WorkstationModel associated to this Workstation * @param name The name of the Workstation * @param props Dictionary of properties associated to this Workstation @@ -147,6 +163,13 @@ public: Workstation(ModelPtr model, const char *name, xbt_dict_t props, lmm_constraint_t constraint, xbt_dynar_t storage, RoutingEdgePtr netElm, CpuPtr cpu); + /** + * @brief Workstation destructor + */ + ~ Workstation(); + + void setState(e_surf_resource_state_t state); + /** * @brief Get the properties of the currenrt Workstation * @@ -156,7 +179,7 @@ public: /** * @brief Execute some quantity of computation - * + * * @param size The value of the processing amount (in flop) needed to process * @return The CpuAction corresponding to the processing * @see Cpu @@ -165,7 +188,7 @@ public: /** * @brief Make a process sleep for duration seconds - * + * * @param duration The number of seconds to sleep * @return The CpuAction corresponding to the sleeping * @see Cpu @@ -174,7 +197,7 @@ public: /** * @brief Get the number of cores of the associated Cpu - * + * * @return The number of cores of the associated Cpu * @see Cpu */ @@ -182,7 +205,7 @@ public: /** * @brief Get the speed of the associated Cpu - * + * * @param load [TODO] * @return The speed of the associated Cpu * @see Cpu @@ -192,7 +215,7 @@ public: /** * @brief Get the available speed of the associated Cpu * @details [TODO] - * + * * @return The available speed of the associated Cpu * @see Cpu */ @@ -200,7 +223,7 @@ public: /** * @brief Get the associated Cpu power peak - * + * * @return The associated Cpu power peak * @see Cpu */ @@ -212,7 +235,7 @@ public: /** * @brief Return the storage of corresponding mount point - * + * * @param storage The mount point * @return The corresponding Storage */ @@ -220,24 +243,30 @@ public: /** * @brief Get the xbt_dict_t of mount_point: Storage - * + * * @return The xbt_dict_t of mount_point: Storage */ - virtual xbt_dict_t getStorageList(); + virtual xbt_dict_t getMountedStorageList(); + + /** + * @brief Get the xbt_dynar_t of storages attached to the workstation + * + * @return The xbt_dynar_t of Storage names + */ + virtual xbt_dynar_t getAttachedStorageList(); /** * @brief Open a file - * - * @param mount The mount point - * @param path The path to the file - * + * + * @param fullpath The full path to the file + * * @return The StorageAction corresponding to the opening */ - virtual ActionPtr open(const char* mount, const char* path); + virtual ActionPtr open(const char* fullpath); /** * @brief Close a file - * + * * @param fd The file descriptor to close * @return The StorageAction corresponding to the closing */ @@ -246,24 +275,15 @@ public: /** * @brief Unlink a file * @details [long description] - * + * * @param fd [description] * @return [description] */ virtual int unlink(surf_file_t fd); - /** - * @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 ActionPtr ls(const char* mount, const char *path); - /** * @brief Get the size in bytes of the file - * + * * @param fd The file descriptor to read * @return The size in bytes of the file */ @@ -271,7 +291,7 @@ public: /** * @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 @@ -280,7 +300,7 @@ public: /** * @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 @@ -295,7 +315,7 @@ public: * - the storage name, * - the storage typeId, * - the storage content type - * + * * @param fd The file descriptor * @return An xbt_dynar_t with the file informations */ @@ -303,15 +323,15 @@ public: /** * @brief Get the current position of the file descriptor - * + * * @param fd The file descriptor * @return The current position of the file descriptor */ virtual sg_size_t fileTell(surf_file_t fd); /** - * @brief Get the available space of the storage at the mount point - * + * @brief Get the available space of the storage at the mount point + * * @param name The mount point * @return The amount of availble space in bytes */ @@ -319,7 +339,7 @@ public: /** * @brief Get the used space of the storage at the mount point - * + * * @param name The mount point * @return The amount of used space in bytes */ @@ -328,7 +348,7 @@ public: /** * @brief Set the position indictator assiociated with the file descriptor to a new position * @details [long description] - * + * * @param fd The file descriptor * @param offset The offset from the origin * @param origin Position used as a reference for the offset @@ -339,6 +359,28 @@ public: */ virtual int fileSeek(surf_file_t fd, sg_size_t offset, int origin); + /** + * @brief Move a file to another location on the *same mount point*. + * @details [long description] + * + * @param fd The file descriptor + * @param fullpath The new full path + * @return MSG_OK if successful, MSG_TASK_CANCELED and a warning if the new + * full path is not on the same mount point + */ + virtual int fileMove(surf_file_t fd, const char* fullpath); + + /** + * @brief Copy a file to another location on a remote host. + * @details [long description] + * + * @param fd The file descriptor + * @param host_dest The worstation destination + * @param fullpath The new full path + * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED + */ + virtual int fileRcopy(surf_file_t fd, surf_resource_t host_dest, const char* fullpath); + xbt_dynar_t p_storage; RoutingEdgePtr p_netElm; CpuPtr p_cpu; @@ -346,7 +388,7 @@ public: /** * @brief Get the list of virtual machines on the current Workstation - * + * * @return The list of VMs */ xbt_dynar_t getVms(); @@ -355,7 +397,7 @@ public: /** * @brief [brief description] * @details [long description] - * + * * @param params [description] */ void getParams(ws_params_t params); @@ -363,7 +405,7 @@ public: /** * @brief [brief description] * @details [long description] - * + * * @param params [description] */ void setParams(ws_params_t params); @@ -373,6 +415,7 @@ public: /********** * Action * **********/ + /** @ingroup SURF_workstation_interface * @brief SURF workstation action interface class */ @@ -380,7 +423,7 @@ class WorkstationAction : public Action { public: /** * @brief WorkstationAction constructor - * + * * @param model The WorkstationModel associated to this WorkstationAction * @param cost The cost of this WorkstationAction in [TODO] * @param failed [description] @@ -390,7 +433,7 @@ public: /** * @brief WorkstationAction constructor - * + * * @param model The WorkstationModel associated to this WorkstationAction * @param cost The cost of this WorkstationAction in [TODO] * @param failed [description] @@ -399,6 +442,7 @@ public: WorkstationAction(ModelPtr model, double cost, bool failed, lmm_variable_t var) : Action(model, cost, failed, var) {} + void setState(e_surf_action_state_t state); };