X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6af809fdd97845671db6136b3903e0d543ab7217..3715b2a421abd8357f41fb2be3c25a351f1af8cb:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index 07bda08049..15b1b8e1e5 100644 --- a/src/include/surf/surf.h +++ b/src/include/surf/surf.h @@ -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 @@ -18,6 +18,8 @@ #include "xbt/lib.h" #include "surf/surf_routing.h" #include "simgrid/platf_interface.h" +#include "simgrid/datatypes.h" +#include "simgrid/plugins.h" SG_BEGIN_DECL() /* Actions and models are highly connected structures... */ @@ -45,15 +47,15 @@ typedef enum { #ifdef __cplusplus class Model; class CpuModel; -class WorkstationModel; -class WorkstationVMModel; -class NetworkCm02Model; +class HostModel; +class VMModel; +class NetworkModel; class StorageModel; class Resource; class ResourceLmm; -class WorkstationCLM03; +class Host; +class HostCLM03; class NetworkCm02Link; -class Cpu; class Action; class ActionLmm; class StorageActionLmm; @@ -63,15 +65,15 @@ class RoutingPlatf; #else typedef struct Model Model; typedef struct CpuModel CpuModel; -typedef struct WorkstationModel WorkstationModel; -typedef struct WorkstationVMModel WorkstationVMModel; -typedef struct NetworkCm02Model NetworkCm02Model; +typedef struct HostModel HostModel; +typedef struct VMModel VMModel; +typedef struct NetworkModel NetworkModel; typedef struct StorageModel StorageModel; typedef struct Resource Resource; typedef struct ResourceLmm ResourceLmm; -typedef struct WorkstationCLM03 WorkstationCLM03; +typedef struct HostCLM03 HostCLM03; +typedef struct Host Host; typedef struct NetworkCm02Link NetworkCm02Link; -typedef struct Cpu Cpu; typedef struct Action Action; typedef struct ActionLmm ActionLmm; typedef struct StorageActionLmm StorageActionLmm; @@ -80,27 +82,25 @@ typedef struct RoutingEdge RoutingEdge; typedef struct RoutingPlatf RoutingPlatf; #endif -/** \ingroup SURF_models +/** @ingroup SURF_c_bindings * \brief Model datatype * - * Generic data structure for a model. The workstations, + * Generic data structure for a model. The hosts, * the CPUs and the network links are examples of models. */ typedef Model *surf_model_t; typedef CpuModel *surf_cpu_model_t; -typedef WorkstationModel *surf_workstation_model_t; -typedef WorkstationVMModel *surf_vm_workstation_model_t; +typedef HostModel *surf_host_model_t; +typedef VMModel *surf_vm_model_t; -typedef NetworkCm02Model *surf_network_model_t; +typedef NetworkModel *surf_network_model_t; typedef StorageModel *surf_storage_model_t; typedef xbt_dictelm_t surf_resource_t; typedef Resource *surf_cpp_resource_t; -typedef WorkstationCLM03 *surf_workstation_CLM03_t; -typedef NetworkCm02Link *surf_network_link_t; -typedef Cpu *surf_cpu_t; +typedef Host *surf_host_t; -/** \ingroup SURF_actions +/** @ingroup SURF_c_bindings * \brief Action structure * * Never create s_surf_action_t by yourself ! The actions are created @@ -109,8 +109,6 @@ typedef Cpu *surf_cpu_t; * \see e_surf_action_state_t */ typedef Action *surf_action_t; -typedef ActionLmm *surf_action_lmm_t; -typedef StorageActionLmm *surf_storage_action_lmm_t; typedef As *AS_t; typedef RoutingEdge *routing_edge_t; @@ -147,182 +145,761 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table); -/** \ingroup SURF_actions - * \brief Action states +/** @ingroup SURF_interface + * @brief Action states * * Action states. * - * \see surf_action_t, surf_action_state_t + * @see Action */ - typedef enum { SURF_ACTION_READY = 0, /**< Ready */ SURF_ACTION_RUNNING, /**< Running */ SURF_ACTION_FAILED, /**< Task Failure */ SURF_ACTION_DONE, /**< Completed */ SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */ - SURF_ACTION_NOT_IN_THE_SYSTEM - /**< Not in the system anymore. Why did you ask ? */ + SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */ } e_surf_action_state_t; +/** @ingroup SURF_vm_interface + * + * + */ /* FIXME: Where should the VM state be defined? */ typedef enum { - /* created, but not yet started */ - SURF_VM_STATE_CREATED, - + SURF_VM_STATE_CREATED, /**< created, but not yet started */ SURF_VM_STATE_RUNNING, - SURF_VM_STATE_MIGRATING, - - /* Suspend/resume does not involve disk I/O, so we assume there is no transition states. */ - SURF_VM_STATE_SUSPENDED, + SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */ - /* Save/restore involves disk I/O, so there should be transition states. */ - SURF_VM_STATE_SAVING, + 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; -typedef struct ws_params { - int ncpus; - sg_size_t ramsize; - int overcommit; - - /* The size of other states than memory pages, which is out-of-scope of dirty - * page tracking. */ - long devsize; - int skip_stage1; - int skip_stage2; - double max_downtime; - - double dp_rate; - double dp_cap; /* bytes per 1 flop execution */ - - double xfer_cpu_overhead; - double dpt_cpu_overhead; - - /* set migration speed */ - double mig_speed; -} s_ws_params_t, *ws_params_t; - /***************************/ /* Generic model object */ /***************************/ -//FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t; + XBT_PUBLIC_DATA(routing_platf_t) routing_platf; -static inline void *surf_cpu_resource_priv(const void *host) { - return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL); -} -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 surf_host_t surf_host_resource_priv(const void *host){ + return (surf_host_t) xbt_lib_get_level((xbt_dictelm_t)host, SURF_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); } -static inline void *surf_cpu_resource_by_name(const char *name) { - return xbt_lib_get_elm_or_null(host_lib, name); -} -static inline void *surf_workstation_resource_by_name(const char *name){ - return xbt_lib_get_elm_or_null(host_lib, name); -} static inline void *surf_storage_resource_by_name(const char *name){ return xbt_lib_get_elm_or_null(storage_lib, name); } -#ifdef __cplusplus -extern "C" { -#endif -char *surf_routing_edge_name(sg_routing_edge_t edge); -void *surf_as_cluster_get_backbone(AS_t as); -void surf_as_cluster_set_backbone(AS_t as, void* backbone); -const char *surf_model_name(surf_model_t model); -xbt_swag_t surf_model_done_action_set(surf_model_t model); -xbt_swag_t surf_model_failed_action_set(surf_model_t model); -xbt_swag_t surf_model_ready_action_set(surf_model_t model); -xbt_swag_t surf_model_running_action_set(surf_model_t model); -surf_action_t surf_workstation_model_execute_parallel_task(surf_workstation_model_t model, - int workstation_nb, - void **workstation_list, - double *computation_amount, - double *communication_amount, +XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as); +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 (dont rely on exact value) + * + * This is implemented using typeid(), so it may change with the compiler + */ +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 + */ +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 + */ +XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model); + +/** + * @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 + */ +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 + */ +XBT_PUBLIC(surf_action_t) surf_model_extract_running_action_set(surf_model_t model); + +/** + * @brief Get the size of the running action set of a model + * + * @param model The model + * @return The size of the running action set + */ +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 host_nb The number of hosts + * @param host_list The list of hosts on which the task is executed + * @param flops_amount The processing amount (in flop) needed to process + * @param bytes_amount The amount of data (in bytes) needed to transfer + * @param rate [description] + * @return The action corresponding to the parallele execution task + */ +XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model, + int host_nb, + void **host_list, + double *flops_amount, + double *bytes_amount, double rate); -surf_action_t surf_workstation_model_communicate(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate); -xbt_dynar_t surf_workstation_model_get_route(surf_workstation_model_t model, surf_resource_t src, surf_resource_t dst); -void surf_vm_workstation_model_create(const char *name, surf_resource_t ind_phys_host); -surf_action_t surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate); -const char *surf_resource_name(surf_cpp_resource_t resource); -xbt_dict_t surf_resource_get_properties(surf_cpp_resource_t resource); -e_surf_resource_state_t surf_resource_get_state(surf_cpp_resource_t resource); -void surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state); -double surf_workstation_get_speed(surf_resource_t resource, double load); -double surf_workstation_get_available_speed(surf_resource_t resource); -int surf_workstation_get_core(surf_resource_t resource); -surf_action_t surf_workstation_execute(surf_resource_t resource, double size); -surf_action_t surf_workstation_sleep(surf_resource_t resource, double duration); -surf_action_t surf_workstation_open(surf_resource_t workstation, const char* mount, const char* path); -surf_action_t surf_workstation_close(surf_resource_t workstation, surf_file_t fd); -surf_action_t surf_workstation_read(surf_resource_t resource, surf_file_t fd, sg_size_t size); -surf_action_t surf_workstation_write(surf_resource_t resource, surf_file_t fd, sg_size_t size); -xbt_dynar_t surf_workstation_get_info(surf_resource_t resource, surf_file_t fd); -sg_size_t surf_workstation_get_free_size(surf_resource_t resource, const char* name); -sg_size_t surf_workstation_get_used_size(surf_resource_t resource, const char* name); -xbt_dynar_t surf_workstation_get_vms(surf_resource_t resource); -void surf_workstation_get_params(surf_resource_t resource, ws_params_t params); -void surf_workstation_set_params(surf_resource_t resource, ws_params_t params); -void surf_vm_workstation_destroy(surf_resource_t resource); -void surf_vm_workstation_suspend(surf_resource_t resource); -void surf_vm_workstation_resume(surf_resource_t resource); -void surf_vm_workstation_save(surf_resource_t resource); -void surf_vm_workstation_restore(surf_resource_t resource); -void surf_vm_workstation_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest); -surf_resource_t surf_vm_workstation_get_pm(surf_resource_t resource); -void surf_vm_workstation_set_bound(surf_resource_t resource, double bound); -void surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask); -surf_action_t surf_cpu_execute(surf_resource_t cpu, double size); -surf_action_t surf_cpu_sleep(surf_resource_t cpu, double duration); -double surf_workstation_get_current_power_peak(surf_resource_t host); -double surf_workstation_get_power_peak_at(surf_resource_t host, int pstate_index); -int surf_workstation_get_nb_pstates(surf_resource_t host); -void surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index); -double surf_workstation_get_consumed_energy(surf_resource_t host); -xbt_dict_t surf_workstation_get_storage_list(surf_resource_t workstation); -int surf_workstation_unlink(surf_resource_t workstation, surf_file_t fd); -surf_action_t surf_workstation_ls(surf_resource_t workstation, const char* mount, const char *path); -size_t surf_workstation_get_size(surf_resource_t workstation, surf_file_t fd); -int surf_network_link_is_shared(surf_cpp_resource_t link); -double surf_network_link_get_bandwidth(surf_cpp_resource_t link); -double surf_network_link_get_latency(surf_cpp_resource_t link); -xbt_dict_t surf_storage_get_content(surf_resource_t resource); -sg_size_t surf_storage_get_size(surf_resource_t resource); -void surf_storage_rename(surf_resource_t resource, const char* src, const char* dest); -void *surf_action_get_data(surf_action_t action); -void surf_action_set_data(surf_action_t action, void *data); -void surf_action_unref(surf_action_t action); -double surf_action_get_start_time(surf_action_t action); -double surf_action_get_finish_time(surf_action_t action); -double surf_action_get_remains(surf_action_t action); -void surf_action_suspend(surf_action_t action); -void surf_action_resume(surf_action_t action); -void surf_action_cancel(surf_action_t action); -void surf_action_set_priority(surf_action_t action, double priority); -void surf_action_set_category(surf_action_t action, const char *category); -e_surf_action_state_t surf_action_get_state(surf_action_t action); -int surf_action_get_cost(surf_action_t action); -void surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask); -void surf_cpu_action_set_bound(surf_action_t action, double bound); -surf_file_t surf_storage_action_get_file(surf_action_t action); -xbt_dict_t surf_storage_action_get_ls_dict(surf_action_t action); -surf_model_t surf_resource_model(const void *host, int level); -#ifdef __cplusplus + +/** + * @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 + * @param size The amount of data (in bytes) needed to transfer + * @param rate [description] + * @return The action corresponding to the communication + */ +XBT_PUBLIC(surf_action_t) surf_host_model_communicate(surf_host_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate); + +/** + * @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 + * @return The list of [TODO] from the source to the host + */ +XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(surf_host_model_t model, surf_resource_t src, surf_resource_t dst); + +/** + * @brief Create a new VM on the specified host + * + * @param name The name of the VM + * @param host_PM The host on which the VM is created + */ +XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM); + +/** + * @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 + * @param size The amount of data (in bytes) needed to transfer + * @param rate [description] + * @return The action corresponding to the communication + */ +XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate); + +/** + * @brief Get the name of a surf resource (cpu, host, network, …) + * + * @param resource The surf resource + * @return The name of the surf resource + */ +XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource); +static inline const char * surf_cpu_name(surf_cpu_t cpu) { + return surf_resource_name((surf_cpp_resource_t)cpu); } -#endif + +/** + * @brief Get the properties of a surf resource (cpu, host, network, …) + * + * @param resource The surf resource + * @return The properties of the surf resource + */ +XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource); +static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) { + return surf_resource_get_properties((surf_cpp_resource_t)host); +} + + +/** + * @brief Get the state of a surf resource (cpu, host, network, …) + * + * @param resource The surf resource + * @return The state of the surf resource + */ +XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource); + +static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) { + return surf_resource_get_state((surf_cpp_resource_t)host); +} + + +/** + * @brief Set the state of a surf resource (cpu, host, network, …) + * + * @param resource The surf resource + * @param state The new state of the surf resource + */ +XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state); +static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) { + surf_resource_set_state((surf_cpp_resource_t)host, state); +} + +/** + * @brief Get the speed of the cpu associated to a host + * + * @param resource The surf host + * @param load [description] + * + * @return [description] + */ +XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load); + +/** + * @brief Get the available speed of cpu associated to a host + * + * @param resource The surf host + * @return [description] + */ +XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource); + +/** + * @brief Get the number of cores of the cpu associated to a host + * + * @param resource The surf host + * @return The number of cores + */ +XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource); + +/** + * @brief Execute some quantity of computation + * + * @param resource The surf host + * @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_host_execute(surf_resource_t resource, double size); + +/** + * @brief Make the host sleep + * + * @param resource The surf host + * @param duration The number of seconds to sleep + * @return The surf action corresponding to the sleep + */ +XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration); + +/** + * @brief Open a file on an host + * + * @param host The surf host + * @param fullpath The path to the file + * @return The surf action corresponding to the openning + */ +XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath); + +/** + * @brief Close a file descriptor on an host + * + * @param host The surf host + * @param fd The file descriptor + * + * @return The surf action corresponding to the closing + */ +XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd); + +/** + * @brief Read a file + * + * @param host The surf host + * @param fd The file descriptor to read + * @param size The size in bytes to read + * @return The surf action corresponding to the reading + */ +XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size); + +/** + * @brief Write a file + * + * @param host The surf host + * @param fd The file descriptor to write + * @param size The size in bytes to write + * @return The surf action corresponding to the writing + */ +XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size); + +/** + * @brief Get the informations of a file descriptor + * @details The returned xbt_dynar_t contains: + * - the size of the file, + * - the mount point, + * - the storage name, + * - the storage typeId, + * - the storage content type + * + * @param host The surf host + * @param fd The file descriptor + * @return An xbt_dynar_t with the file informations + */ +XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(surf_resource_t host, surf_file_t fd); + +/** + * @brief Get the available space of the storage at the mount point + * + * @param resource The surf host + * @param name The mount point + * @return The amount of available space in bytes + */ +XBT_PUBLIC(sg_size_t) surf_host_get_free_size(surf_resource_t resource, const char* name); + +/** + * @brief Get the used space of the storage at the mount point + * + * @param resource The surf host + * @param name The mount point + * @return The amount of used space in bytes + */ +XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name); + +/** + * @brief Get the VMs hosted on the host + * + * @param resource The surf host + * @return The list of VMs on the host + */ +XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource); + +/** + * @brief [brief description] + * @details [long description] + * + * @param resource [description] + * @param params [description] + */ +XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, ws_params_t params); + +/** + * @brief [brief description] + * @details [long description] + * + * @param resource [description] + * @param params [description] + */ +XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, ws_params_t params); + +/** + * @brief Destroy a VM + * + * @param resource The surf vm + */ +XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource); + +/** + * @brief Suspend a VM + * + * @param resource The surf vm + */ +XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource); + +/** + * @brief Resume a VM + * + * @param resource The surf vm + */ +XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource); + +/** + * @brief Save the VM (Not yet implemented) + * + * @param resource The surf vm + */ +XBT_PUBLIC(void) surf_vm_save(surf_resource_t resource); + +/** + * @brief Restore the VM (Not yet implemented) + * + * @param resource The surf vm + */ +XBT_PUBLIC(void) surf_vm_restore(surf_resource_t resource); + +/** + * @brief Migrate the VM to the destination host + * + * @param resource The surf vm + * @param ind_vm_ws_dest The destination host + */ +XBT_PUBLIC(void) surf_vm_migrate(surf_resource_t resource, surf_resource_t ind_vm_ws_dest); + +/** + * @brief Get the physical machine hosting the VM + * + * @param resource The surf vm + * @return The physical machine hosting the VM + */ +XBT_PUBLIC(surf_resource_t) surf_vm_get_pm(surf_resource_t resource); + +/** + * @brief [brief description] + * @details [long description] + * + * @param resource [description] + * @param bound [description] + */ +XBT_PUBLIC(void) surf_vm_set_bound(surf_resource_t resource, double bound); + +/** + * @brief [brief description] + * @details [long description] + * + * @param resource [description] + * @param cpu [description] + * @param mask [description] + */ +XBT_PUBLIC(void) surf_vm_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask); + +/** + * @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 + */ +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 + */ +XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration); + +/** + * @brief Get the host power peak + * @details [long description] + * + * @param host The surf host + * @return The power peak + */ +XBT_PUBLIC(double) surf_host_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_host_get_power_peak_at(surf_resource_t host, int pstate_index); + +/** + * @brief [brief description] + * @details [long description] + * + * @param host [description] + * @return [description] + */ +XBT_PUBLIC(int) surf_host_get_nb_pstates(surf_resource_t host); + +XBT_PUBLIC(void) surf_host_set_pstate(surf_resource_t host, int pstate_index); +XBT_PUBLIC(int) surf_host_get_pstate(surf_resource_t host); +XBT_PUBLIC(double) surf_host_get_wattmin_at(surf_resource_t resource, int pstate); +XBT_PUBLIC(double) surf_host_get_wattmax_at(surf_resource_t resource, int pstate); + +/** + * @brief Get the consumed energy (in joules) of an host + * + * @param host The surf host + * @return The consumed energy + */ +XBT_PUBLIC(double) surf_host_get_consumed_energy(surf_resource_t host); + +/** + * @brief Get the list of storages mounted on an host + * + * @param host The surf host + * @return Dictionary of mount point, Storage + */ +XBT_PUBLIC(xbt_dict_t) surf_host_get_mounted_storage_list(surf_resource_t host); + +/** + * @brief Get the list of storages attached to an host + * + * @param host The surf host + * @return Dictionary of storage + */ +XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(surf_resource_t host); + +/** + * @brief Unlink a file descriptor + * + * @param host The surf host + * @param fd The file descriptor + * + * @return 0 if failed to unlink, 1 otherwise + */ +XBT_PUBLIC(int) surf_host_unlink(surf_resource_t host, surf_file_t fd); + +/** + * @brief Get the size of a file on a host + * + * @param host The surf host + * @param fd The file descriptor + * + * @return The size in bytes of the file + */ +XBT_PUBLIC(size_t) surf_host_get_size(surf_resource_t host, surf_file_t fd); + +/** + * @brief Get the current position of the file descriptor + * + * @param host The surf host + * @param fd The file descriptor + * @return The current position of the file descriptor + */ +XBT_PUBLIC(size_t) surf_host_file_tell(surf_resource_t host, surf_file_t fd); + +/** + * @brief Move a file to another location on the *same mount point*. + * @details [long description] + * + * @param host The surf host + * @param fd The file descriptor + * @param fullpath The new full path + * + * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED + */ +XBT_PUBLIC(int) surf_host_file_move(surf_resource_t host, surf_file_t fd, const char* fullpath); + +/** + * @brief Set the position indictator assiociated with the file descriptor to a new position + * @details [long description] + * + * @param host The surf host + * @param fd The file descriptor + * @param offset The offset from the origin + * @param origin Position used as a reference for the offset + * - SEEK_SET: beginning of the file + * - SEEK_CUR: current position indicator + * - SEEK_END: end of the file + * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED + */ +XBT_PUBLIC(int) surf_host_file_seek(surf_resource_t host, + surf_file_t fd, sg_offset_t offset, + int origin); + +/** + * @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 + */ +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 + */ +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 + */ +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 + */ +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 + */ +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 + */ +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); + +/** + * @brief Set the priority of an action + * @details [long description] + * + * @param action The surf action + * @param priority The new priority [TODO] + */ +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 + * + * @param action The surf action + * @return The state of the action + */ +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 + */ +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] + */ +XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask); + +/** + * @brief [brief description] + * @details [long description] + * + * @param action The surf cpu action + * @param bound [description] + */ +XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound); + +/** + * @brief [brief description] + * @details [long description] + * + * @param action The surf network action + */ +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 + */ +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 + */ +XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action); + + +/** + * @brief Get the host the storage is attached to + * + * @param resource The surf storage + * @return The host name + */ +XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource); + +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 @@ -360,6 +937,11 @@ XBT_PUBLIC(void) surf_cpu_model_init_ti(void); */ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[]; +/** \ingroup SURF_plugins + * \brief The list of all available surf plugins + */ +XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[]; + /** \ingroup SURF_models * \brief The list of all available cpu model models */ @@ -374,7 +956,7 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[]; * \brief The network model * * When creating a new API on top on SURF, you shouldn't use the - * network model unless you know what you are doing. Only the workstation + * network model unless you know what you are doing. Only the host * model should be accessed because depending on the platform model, * the network model can be NULL. */ @@ -388,10 +970,20 @@ XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model; * size (< 1KiB, < 64KiB, >= 64KiB). * See comments in the code for more information. * - * \see surf_workstation_model_init_SMPI() + * \see surf_host_model_init_SMPI() */ 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_host_model_init_IB() + */ +XBT_PUBLIC(void) surf_network_model_init_IB(void); + /** \ingroup SURF_models * \brief Initializes the platform with the network model 'LegrandVelho' * @@ -399,7 +991,7 @@ XBT_PUBLIC(void) surf_network_model_init_SMPI(void); * the results obtained with the GTNets simulator for onelink and * dogbone sharing scenarios. See comments in the code for more information. * - * \see surf_workstation_model_init_LegrandVelho() + * \see surf_host_model_init_LegrandVelho() */ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void); @@ -410,9 +1002,9 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void); * constant, hence no need for a routing table. This is particularly * usefull when simulating huge distributed algorithms where * scalability is really an issue. This function is called in - * conjunction with surf_workstation_model_init_compound. + * conjunction with surf_host_model_init_compound. * - * \see surf_workstation_model_init_compound() + * \see surf_host_model_init_compound() */ XBT_PUBLIC(void) surf_network_model_init_Constant(void); @@ -420,7 +1012,7 @@ XBT_PUBLIC(void) surf_network_model_init_Constant(void); * \brief Initializes the platform with the network model CM02 * * You sould call this function by yourself only if you plan using - * surf_workstation_model_init_compound. + * surf_host_model_init_compound. * See comments in the code for more information. */ XBT_PUBLIC(void) surf_network_model_init_CM02(void); @@ -430,10 +1022,10 @@ XBT_PUBLIC(void) surf_network_model_init_CM02(void); * \brief Initializes the platform with the network model GTNETS * \param filename XML platform file name * - * This function is called by surf_workstation_model_init_GTNETS - * or by yourself only if you plan using surf_workstation_model_init_compound + * This function is called by surf_host_model_init_GTNETS + * or by yourself only if you plan using surf_host_model_init_compound * - * \see surf_workstation_model_init_GTNETS() + * \see surf_host_model_init_GTNETS() */ XBT_PUBLIC(void) surf_network_model_init_GTNETS(void); #endif @@ -443,10 +1035,10 @@ XBT_PUBLIC(void) surf_network_model_init_GTNETS(void); * \brief Initializes the platform with the network model NS3 * \param filename XML platform file name * - * This function is called by surf_workstation_model_init_NS3 - * or by yourself only if you plan using surf_workstation_model_init_compound + * This function is called by surf_host_model_init_NS3 + * or by yourself only if you plan using surf_host_model_init_compound * - * \see surf_workstation_model_init_NS3() + * \see surf_host_model_init_NS3() */ XBT_PUBLIC(void) surf_network_model_init_NS3(void); #endif @@ -461,7 +1053,7 @@ XBT_PUBLIC(void) surf_network_model_init_NS3(void); * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms. * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003. * - * Call this function only if you plan using surf_workstation_model_init_compound. + * Call this function only if you plan using surf_host_model_init_compound. * */ XBT_PUBLIC(void) surf_network_model_init_Reno(void); @@ -476,7 +1068,7 @@ XBT_PUBLIC(void) surf_network_model_init_Reno(void); * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms. * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003. * - * Call this function only if you plan using surf_workstation_model_init_compound. + * Call this function only if you plan using surf_host_model_init_compound. * */ XBT_PUBLIC(void) surf_network_model_init_Reno2(void); @@ -492,7 +1084,7 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(void); * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms. * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003. * - * Call this function only if you plan using surf_workstation_model_init_compound. + * Call this function only if you plan using surf_host_model_init_compound. * */ XBT_PUBLIC(void) surf_network_model_init_Vegas(void); @@ -517,79 +1109,79 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[]; XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model; /** \ingroup SURF_models - * \brief The workstation model + * \brief The host model * * Note that when you create an API on top of SURF, - * the workstation model should be the only one you use + * the host model should be the only one you use * because depending on the platform model, the network model and the CPU model * may not exist. */ -XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model; +XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model; /** \ingroup SURF_models - * \brief The vm_workstation model + * \brief The vm model * * Note that when you create an API on top of SURF, - * the vm_workstation model should be the only one you use + * the vm model should be the only one you use * because depending on the platform model, the network model and the CPU model * may not exist. */ -XBT_PUBLIC_DATA(surf_vm_workstation_model_t) surf_vm_workstation_model; +XBT_PUBLIC_DATA(surf_vm_model_t) surf_vm_model; /** \ingroup SURF_models - * \brief Initializes the platform with a compound workstation model + * \brief Initializes the platform with a compound host model * * This function should be called after a cpu_model and a * network_model have been set up. * */ -XBT_PUBLIC(void) surf_workstation_model_init_compound(void); +XBT_PUBLIC(void) surf_host_model_init_compound(void); /** \ingroup SURF_models * \brief Initializes the platform with the current best network and cpu models at hand * - * This platform model seperates the workstation model and the network model. - * The workstation model will be initialized with the model compound, the network + * This platform model separates the host model and the network model. + * The host model will be initialized with the model compound, the network * model with the model LV08 (with cross traffic support) and the CPU model with * the model Cas01. * Such model is subject to modification with warning in the ChangeLog so monitor it! * */ -XBT_PUBLIC(void) surf_workstation_model_init_current_default(void); +XBT_PUBLIC(void) surf_host_model_init_current_default(void); /** \ingroup SURF_models - * \brief Initializes the platform with the model KCCFLN05 + * \brief Initializes the platform with the model L07 * * With this model, only parallel tasks can be used. Resource sharing * is done by identifying bottlenecks and giving an equal share of * the model to each action. * */ -XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void); +XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void); /** \ingroup SURF_models - * \brief The list of all available workstation model models + * \brief The list of all available host model models */ XBT_PUBLIC_DATA(s_surf_model_description_t) - surf_workstation_model_description[]; + surf_host_model_description[]; /** \ingroup SURF_models * \brief Initializes the platform with the current best network and cpu models at hand * - * This platform model seperates the workstation model and the network model. - * The workstation model will be initialized with the model compound, the network + * This platform model seperates the host model and the network model. + * The host model will be initialized with the model compound, the network * model with the model LV08 (with cross traffic support) and the CPU model with * the model Cas01. * 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_model_init_HL13(void); /** \ingroup SURF_models - * \brief The list of all available vm workstation model models + * \brief The list of all available vm model models */ XBT_PUBLIC_DATA(s_surf_model_description_t) - surf_vm_workstation_model_description[]; + surf_vm_model_description[]; /*******************************************/ @@ -607,25 +1199,20 @@ XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart; /** \ingroup SURF_simulation * \brief List of hosts for which one want to be notified if they ever restart. */ -XBT_PUBLIC(xbt_dict_t) watched_hosts_lib; +XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib; /*******************************************/ /*** SURF Platform *************************/ /*******************************************/ -#ifdef __cplusplus -extern "C" { -#endif -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); XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges); XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf); XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge); -#ifdef __cplusplus -} -#endif /*******************************************/ /*** SURF Globals **************************/ @@ -638,10 +1225,10 @@ 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 - * e.g. surf_workstation_model_init_CM02() + * calling + * e.g. surf_host_model_init_CM02() * - * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit() + * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit() */ XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */ @@ -684,6 +1271,9 @@ XBT_PUBLIC(void) surf_exit(void); /* Prototypes of the functions that handle the properties */ XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */ +/* The same for model_prop set*/ +XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set; + /* surf parse file related (public because called from a test suite) */ XBT_PUBLIC(void) parse_platform_file(const char *file);