X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c353d0f0915ccee0aceaa91fdb1534ab5d7b7cb4..155a1e0df5db6960042e06036b942b9f93378b05:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index fdcbf87b6c..c9f19e8186 100644 --- a/src/include/surf/surf.h +++ b/src/include/surf/surf.h @@ -102,7 +102,7 @@ typedef WorkstationCLM03 *surf_workstation_CLM03_t; typedef NetworkCm02Link *surf_network_link_t; typedef Cpu *surf_cpu_t; -/** @ingroup SURF_c_bindings +/** @ingroup SURF_c_bindings * \brief Action structure * * Never create s_surf_action_t by yourself ! The actions are created @@ -165,22 +165,18 @@ typedef enum { } e_surf_action_state_t; /** @ingroup SURF_vm_interface - * - * + * + * */ /* FIXME: Where should the VM state be defined? */ typedef enum { SURF_VM_STATE_CREATED, /**< created, but not yet started */ - SURF_VM_STATE_RUNNING, - SURF_VM_STATE_MIGRATING, - SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */ SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */ SURF_VM_STATE_SAVED, SURF_VM_STATE_RESTORING, - } e_surf_vm_state_t; /***************************/ @@ -196,6 +192,9 @@ static inline void *surf_cpu_resource_priv(const void *host) { static inline void *surf_workstation_resource_priv(const void *host){ return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL); } +static inline void *surf_routing_resource_priv(const void *host){ + return (void*)xbt_lib_get_level((xbt_dictelm_t)host, ROUTING_HOST_LEVEL); +} static inline void *surf_storage_resource_priv(const void *storage){ return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL); } @@ -217,9 +216,9 @@ XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone); /** @{ @ingroup SURF_c_bindings */ -/** +/** * @brief Get the name of a surf model - * + * * @param model A model * @return The name of the model */ @@ -227,7 +226,7 @@ XBT_PUBLIC(const char *) surf_model_name(surf_model_t model); /** * @brief Pop an action from the done actions set - * + * * @param model The model from which the action is extracted * @return An action in done state */ @@ -235,7 +234,7 @@ XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model) /** * @brief Pop an action from the failed actions set - * + * * @param model The model from which the action is extracted * @return An action in failed state */ @@ -243,7 +242,7 @@ XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t mode /** * @brief Pop an action from the ready actions set - * + * * @param model The model from which the action is extracted * @return An action in ready state */ @@ -251,7 +250,7 @@ XBT_PUBLIC(surf_action_t) surf_model_extract_ready_action_set(surf_model_t model /** * @brief Pop an action from the running actions set - * + * * @param model The model from which the action is extracted * @return An action in running state */ @@ -259,7 +258,7 @@ XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t mod /** * @brief Get the size of the running action set of a model - * + * * @param model The model * @return The size of the running action set */ @@ -268,9 +267,9 @@ XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model); /** * @brief Execute a parallel task * @details [long description] - * + * * @param model The model which handle the parallelisation - * @param workstation_nb The number of workstations + * @param workstation_nb The number of workstations * @param workstation_list The list of workstations on which the task is executed * @param computation_amount The processing amount (in flop) needed to process * @param communication_amount The amount of data (in bytes) needed to transfer @@ -286,7 +285,7 @@ XBT_PUBLIC(surf_action_t) surf_workstation_model_execute_parallel_task(surf_work /** * @brief Create a communication between two hosts - * + * * @param model The model which handle the communication * @param src The source host * @param dst The destination host @@ -299,7 +298,7 @@ XBT_PUBLIC(surf_action_t) surf_workstation_model_communicate(surf_workstation_mo /** * @brief Get the route between two hosts * @details [long description] - * + * * @param model The model which handle the routes * @param src The source host * @param dst The destination host @@ -309,7 +308,7 @@ XBT_PUBLIC(xbt_dynar_t) surf_workstation_model_get_route(surf_workstation_model_ /** * @brief Create a new VM on the specified host - * + * * @param name The name of the workstation * @param ind_phys_host The host on which the VM is created */ @@ -318,7 +317,7 @@ XBT_PUBLIC(void) surf_vm_workstation_model_create(const char *name, surf_resourc /** * @brief Create a communication between two routing edges [TODO] * @details [long description] - * + * * @param model The model which handle the communication * @param src The source host * @param dst The destination host @@ -330,7 +329,7 @@ XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t mo /** * @brief Get the name of a surf resource (cpu, workstation, network, …) - * + * * @param resource The surf resource * @return The name of the surf resource */ @@ -338,7 +337,7 @@ XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource); /** * @brief Get the properties of a surf resource (cpu, workstation, network, …) - * + * * @param resource The surf resource * @return The properties of the surf resource */ @@ -346,7 +345,7 @@ XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource /** * @brief Get the state of a surf resource (cpu, workstation, network, …) - * + * * @param resource The surf resource * @return The state of the surf resource */ @@ -354,7 +353,7 @@ XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t /** * @brief Set the state of a surf resource (cpu, workstation, network, …) - * + * * @param resource The surf resource * @param state The new state of the surf resource */ @@ -362,17 +361,17 @@ XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_re /** * @brief Get the speed of the cpu associtated to a workstation - * + * * @param resource The surf workstation * @param load [description] - * + * * @return [description] */ XBT_PUBLIC(double) surf_workstation_get_speed(surf_resource_t resource, double load); /** * @brief Get the available speed of cpu associtated to a workstation - * + * * @param resource The surf workstation * @return [description] */ @@ -380,7 +379,7 @@ XBT_PUBLIC(double) surf_workstation_get_available_speed(surf_resource_t resource /** * @brief Get the number of cores of the cpu associated to a workstation - * + * * @param resource The surf workstation * @return The number of cores */ @@ -391,14 +390,14 @@ XBT_PUBLIC(int) surf_workstation_get_core(surf_resource_t resource); * * @param resource The surf workstation * @param size The value of the processing amount (in flop) needed to process - * + * * @return The surf action corresponding to the processing */ XBT_PUBLIC(surf_action_t) surf_workstation_execute(surf_resource_t resource, double size); /** * @brief Make the workstation sleep - * + * * @param resource The surf workstation * @param duration The number of seconds to sleep * @return The surf action corresponding to the sleep @@ -407,7 +406,7 @@ XBT_PUBLIC(surf_action_t) surf_workstation_sleep(surf_resource_t resource, doubl /** * @brief Open a file on a workstation - * + * * @param workstation The surf workstation * @param fullpath The path to the file * @return The surf action corresponding to the openning @@ -416,17 +415,17 @@ XBT_PUBLIC(surf_action_t) surf_workstation_open(surf_resource_t workstation, con /** * @brief Close a file descriptor on a workstation - * + * * @param workstation The surf workstation * @param fd The file descriptor - * + * * @return The surf action corresponding to the closing */ XBT_PUBLIC(surf_action_t) surf_workstation_close(surf_resource_t workstation, surf_file_t fd); /** * @brief Read a file - * + * * @param resource The surf workstation * @param fd The file descriptor to read * @param size The size in bytes to read @@ -436,7 +435,7 @@ XBT_PUBLIC(surf_action_t) surf_workstation_read(surf_resource_t resource, surf_f /** * @brief Write a file - * + * * @param resource The surf workstation * @param fd The file descriptor to write * @param size The size in bytes to write @@ -452,7 +451,7 @@ XBT_PUBLIC(surf_action_t) surf_workstation_write(surf_resource_t resource, surf_ * - the storage name, * - the storage typeId, * - the storage content type - * + * * @param resource The surf workstation * @param fd The file descriptor * @return An xbt_dynar_t with the file informations @@ -461,7 +460,7 @@ XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_info(surf_resource_t resource, surf /** * @brief Get the available space of the storage at the mount point - * + * * @param resource The surf workstation * @param name The mount point * @return The amount of availble space in bytes @@ -470,7 +469,7 @@ XBT_PUBLIC(sg_size_t) surf_workstation_get_free_size(surf_resource_t resource, c /** * @brief Get the used space of the storage at the mount point - * + * * @param resource The surf workstation * @param name The mount point * @return The amount of used space in bytes @@ -479,7 +478,7 @@ XBT_PUBLIC(sg_size_t) surf_workstation_get_used_size(surf_resource_t resource, c /** * @brief Get the VMs hosted on the workstation - * + * * @param resource The surf workstation * @return The list of VMs on the workstation */ @@ -488,7 +487,7 @@ XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_vms(surf_resource_t resource); /** * @brief [brief description] * @details [long description] - * + * * @param resource [description] * @param params [description] */ @@ -497,7 +496,7 @@ XBT_PUBLIC(void) surf_workstation_get_params(surf_resource_t resource, ws_params /** * @brief [brief description] * @details [long description] - * + * * @param resource [description] * @param params [description] */ @@ -505,42 +504,42 @@ XBT_PUBLIC(void) surf_workstation_set_params(surf_resource_t resource, ws_params /** * @brief Destroy a Workstation VM - * + * * @param resource The surf workstation vm */ XBT_PUBLIC(void) surf_vm_workstation_destroy(surf_resource_t resource); /** * @brief Suspend a Workstation VM - * + * * @param resource The surf workstation vm */ XBT_PUBLIC(void) surf_vm_workstation_suspend(surf_resource_t resource); /** * @brief Resume a Workstation VM - * + * * @param resource The surf workstation vm */ XBT_PUBLIC(void) surf_vm_workstation_resume(surf_resource_t resource); /** * @brief Save the Workstation VM (Not yet implemented) - * + * * @param resource The surf workstation vm */ XBT_PUBLIC(void) surf_vm_workstation_save(surf_resource_t resource); /** * @brief Restore the Workstation VM (Not yet implemented) - * + * * @param resource The surf workstation vm */ XBT_PUBLIC(void) surf_vm_workstation_restore(surf_resource_t resource); /** * @brief Migrate the VM to the destination host - * + * * @param resource The surf workstation vm * @param ind_vm_ws_dest The destination host */ @@ -548,7 +547,7 @@ XBT_PUBLIC(void) surf_vm_workstation_migrate(surf_resource_t resource, surf_reso /** * @brief Get the physical machine hosting the VM - * + * * @param resource The surf workstation vm * @return The physical machine hosting the VM */ @@ -557,7 +556,7 @@ XBT_PUBLIC(surf_resource_t) surf_vm_workstation_get_pm(surf_resource_t resource) /** * @brief [brief description] * @details [long description] - * + * * @param resource [description] * @param bound [description] */ @@ -566,7 +565,7 @@ XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double /** * @brief [brief description] * @details [long description] - * + * * @param resource [description] * @param cpu [description] * @param mask [description] @@ -575,7 +574,7 @@ XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf /** * @brief Execute some quantity of computation - * + * * @param cpu The surf cpu * @param size The value of the processing amount (in flop) needed to process * @return The surf action corresponding to the processing @@ -585,7 +584,7 @@ XBT_PUBLIC(surf_action_t) surf_cpu_execute(surf_resource_t cpu, double size); /** * @brief Make the cpu sleep for duration (in seconds) * @details [long description] - * + * * @param cpu The surf cpu * @param duration The number of seconds to sleep * @return The surf action corresponding to the sleeping @@ -595,7 +594,7 @@ XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration); /** * @brief Get the workstation power peak * @details [long description] - * + * * @param host The surf workstation * @return The power peak */ @@ -604,10 +603,10 @@ XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host) /** * @brief [brief description] * @details [long description] - * + * * @param host [description] * @param pstate_index [description] - * + * * @return [description] */ XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index); @@ -615,7 +614,7 @@ XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int /** * @brief [brief description] * @details [long description] - * + * * @param host [description] * @return [description] */ @@ -624,7 +623,7 @@ XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host); /** * @brief [brief description] * @details [long description] - * + * * @param host [description] * @param pstate_index [description] */ @@ -632,7 +631,7 @@ XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int ps /** * @brief Get the consumed energy (in joules) of a workstation - * + * * @param host The surf workstation * @return The consumed energy */ @@ -640,7 +639,7 @@ XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host); /** * @brief Get the list of storages mounted on a workstation - * + * * @param workstation The surf workstation * @return Dictionary of mount point, Storage */ @@ -656,27 +655,27 @@ XBT_PUBLIC(xbt_dynar_t) surf_workstation_get_attached_storage_list(surf_resource /** * @brief Unlink a file descriptor - * + * * @param workstation The surf workstation * @param fd The file descriptor - * + * * @return 0 if failed to unlink, 1 otherwise */ XBT_PUBLIC(int) surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd); /** * @brief Get the size of a file on a workstation - * + * * @param workstation The surf workstation * @param fd The file descriptor - * + * * @return The size in bytes of the file */ XBT_PUBLIC(size_t) surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd); /** * @brief Get the current position of the file descriptor - * + * * @param workstation The surf workstation * @param fd The file descriptor * @return The current position of the file descriptor @@ -698,7 +697,7 @@ XBT_PUBLIC(int) surf_workstation_file_move(surf_resource_t workstation, surf_fil /** * @brief Set the position indictator assiociated with the file descriptor to a new position * @details [long description] - * + * * @param workstation The surf workstation * @param fd The file descriptor * @param offset The offset from the origin @@ -708,25 +707,14 @@ XBT_PUBLIC(int) surf_workstation_file_move(surf_resource_t workstation, surf_fil * - SEEK_END: end of the file * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED */ -XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation, surf_file_t fd, sg_size_t offset, int origin); - -/** - * @brief Copy a file to another location on a remote host. - * @details [long description] - * - * @param workstation The surf workstation - * @param fd The file descriptor - * @param host_dest The workstation destination - * @param fullpath The new full path - * - * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED - */ -XBT_PUBLIC(int) surf_workstation_file_rcopy(surf_resource_t workstation, surf_file_t fd, surf_resource_t host_dest, const char* fullpath); +XBT_PUBLIC(int) surf_workstation_file_seek(surf_resource_t workstation, + surf_file_t fd, sg_offset_t offset, + int origin); /** * @brief [brief description] * @details [long description] - * + * * @param link [description] * @return [description] */ @@ -734,7 +722,7 @@ XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link); /** * @brief Get the bandwidth of a link in bytes per second - * + * * @param link The surf link * @return The bandwidth in bytes per second */ @@ -742,7 +730,7 @@ XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link); /** * @brief Get the latency of a link in seconds - * + * * @param link The surf link * @return The latency in seconds */ @@ -750,7 +738,7 @@ XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link); /** * @brief Get the content of a storage - * + * * @param resource The surf storage * @return A xbt_dict_t with path as keys and size in bytes as values */ @@ -758,15 +746,32 @@ XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource); /** * @brief Get the size in bytes of a storage - * + * * @param resource The surf storage * @return The size in bytes of the storage */ XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource); +/** + * @brief Get the available size in bytes of a storage + * + * @param resource The surf storage + * @return The available size in bytes of the storage + */ +XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource); + +/** + * @brief Get the size in bytes of a storage + * + * @param resource The surf storage + * @return The used size in bytes of the storage + */ +XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource); + + /** * @brief Get the data associated to the action - * + * * @param action The surf action * @return The data associated to the action */ @@ -775,7 +780,7 @@ XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action); /** * @brief Set the data associated to the action * @details [long description] - * + * * @param action The surf action * @param data The new data associated to the action */ @@ -783,14 +788,14 @@ XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data); /** * @brief Unreference an action - * + * * @param action The surf action */ XBT_PUBLIC(void) surf_action_unref(surf_action_t action); /** * @brief Get the start time of an action - * + * * @param action The surf action * @return The start time in seconds from the beginning of the simulation */ @@ -798,7 +803,7 @@ XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action); /** * @brief Get the finish time of an action - * + * * @param action The surf action * @return The finish time in seconds from the beginning of the simulation */ @@ -806,7 +811,7 @@ XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action); /** * @brief Get the remains amount of work to do of an action - * + * * @param action The surf action * @return The remains amount of work to do */ @@ -814,21 +819,21 @@ XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action); /** * @brief Suspend an action - * + * * @param action The surf action */ XBT_PUBLIC(void) surf_action_suspend(surf_action_t action); /** * @brief Resume an action - * + * * @param action The surf action */ XBT_PUBLIC(void) surf_action_resume(surf_action_t action); /** * @brief Cancel an action - * + * * @param action The surf action */ XBT_PUBLIC(void) surf_action_cancel(surf_action_t action); @@ -836,7 +841,7 @@ XBT_PUBLIC(void) surf_action_cancel(surf_action_t action); /** * @brief Set the priority of an action * @details [long description] - * + * * @param action The surf action * @param priority The new priority [TODO] */ @@ -845,15 +850,15 @@ XBT_PUBLIC(void) surf_action_set_priority(surf_action_t action, double priority) /** * @brief Set the category of an action * @details [long description] - * + * * @param action The surf action * @param category The new category of the action */ XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category); /** - * @brief Get the state of an action - * + * @brief Get the state of an action + * * @param action The surf action * @return The state of the action */ @@ -861,7 +866,7 @@ XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action); /** * @brief Get the cost of an action - * + * * @param action The surf action * @return The cost of the action */ @@ -870,7 +875,7 @@ XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action); /** * @brief [brief desrciption] * @details [long description] - * + * * @param action The surf cpu action * @param cpu [description] * @param mask [description] @@ -880,7 +885,7 @@ XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resourc /** * @brief [brief description] * @details [long description] - * + * * @param action The surf cpu action * @param bound [description] */ @@ -896,7 +901,7 @@ XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action) /** * @brief Get the file associated to a storage action - * + * * @param action The surf storage action * @return The file associated to a storage action */ @@ -904,7 +909,7 @@ XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action); /** * @brief Get the result dictionary of an ls action - * + * * @param action The surf storage action * @return The dictionry listing a path */ @@ -927,6 +932,9 @@ XBT_PUBLIC(surf_model_t) surf_resource_model(const void *host, int level); /* Implementations of model object */ /**************************************/ +XBT_PUBLIC_DATA(int) autoload_surf_cpu_model; +XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse; + /** \ingroup SURF_models * \brief The CPU model object for the physical machine layer */ @@ -1000,6 +1008,16 @@ XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model; */ XBT_PUBLIC(void) surf_network_model_init_SMPI(void); +/** \ingroup SURF_models + * \brief Same as network model 'LagrangeVelho', only with different correction factors. + * + * This model impelments a variant of the contention model on Infinband networks based on + * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf + * + * \see surf_workstation_model_init_IB() + */ +XBT_PUBLIC(void) surf_network_model_init_IB(void); + /** \ingroup SURF_models * \brief Initializes the platform with the network model 'LegrandVelho' * @@ -1191,7 +1209,7 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) * Such model is subject to modification with warning in the ChangeLog so monitor it! * */ -XBT_PUBLIC(void) surf_vm_workstation_model_init_current_default(void); +XBT_PUBLIC(void) surf_vm_workstation_model_init_HL13(void); /** \ingroup SURF_models * \brief The list of all available vm workstation model models @@ -1220,8 +1238,9 @@ XBT_PUBLIC(xbt_dict_t) watched_hosts_lib; /*******************************************/ /*** SURF Platform *************************/ /*******************************************/ -XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void); +XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void); XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as); +XBT_PUBLIC_DATA(AS_t) surf_AS_get_by_name(const char * name); XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as); XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as); XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as); @@ -1240,7 +1259,7 @@ XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_ * * This function has to be called to initialize the common * structures. Then you will have to create the environment by - * calling + * calling * e.g. surf_workstation_model_init_CM02() * * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()