X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3f391af133151d7ed0125a4fbcfaf6f68a5df2c6..83ade874cb34c7f3afbc9f7a782e097cbb7209bf:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index 117e7bb0f8..d46f2351c4 100644 --- a/src/include/surf/surf.h +++ b/src/include/surf/surf.h @@ -1,4 +1,4 @@ -/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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 @@ -12,89 +12,115 @@ #include "xbt/dict.h" #include "xbt/graph.h" #include "xbt/misc.h" -#include "portable.h" #include "xbt/config.h" +#include "src/portable.h" +#include "surf/surf_routing.h" #include "surf/datatypes.h" #include "xbt/lib.h" #include "surf/surf_routing.h" #include "simgrid/platf_interface.h" +#include "simgrid/datatypes.h" +#include "simgrid/forward.h" SG_BEGIN_DECL() /* Actions and models are highly connected structures... */ /* user-visible parameters */ -extern double sg_tcp_gamma; -extern double sg_sender_gap; -extern double sg_latency_factor; -extern double sg_bandwidth_factor; -extern double sg_weight_S_parameter; -extern int sg_network_crosstraffic; -#ifdef HAVE_GTNETS -extern double sg_gtnets_jitter; -extern int sg_gtnets_jitter_seed; -#endif -extern xbt_dynar_t surf_path; +extern XBT_PRIVATE double sg_tcp_gamma; +extern XBT_PRIVATE double sg_sender_gap; +extern XBT_PRIVATE double sg_latency_factor; +extern XBT_PRIVATE double sg_bandwidth_factor; +extern XBT_PRIVATE double sg_weight_S_parameter; +extern XBT_PRIVATE int sg_network_crosstraffic; +extern XBT_PRIVATE xbt_dynar_t surf_path; typedef enum { - SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */ - SURF_NETWORK_ELEMENT_HOST, /* host type */ - SURF_NETWORK_ELEMENT_ROUTER, /* router type */ - SURF_NETWORK_ELEMENT_AS /* AS type */ + SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */ + SURF_NETWORK_ELEMENT_HOST, /* host type */ + SURF_NETWORK_ELEMENT_ROUTER, /* router type */ + SURF_NETWORK_ELEMENT_AS /* AS type */ } e_surf_network_element_type_t; #ifdef __cplusplus + +namespace simgrid { +namespace surf { + class Model; class CpuModel; -class WorkstationModel; -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; class As; -class RoutingEdge; class RoutingPlatf; + +} +} + +typedef simgrid::surf::Model surf_Model; +typedef simgrid::surf::CpuModel surf_CpuModel; +typedef simgrid::surf::HostModel surf_HostModel; +typedef simgrid::surf::VMModel surf_VMModel; +typedef simgrid::surf::NetworkModel surf_NetworkModel; +typedef simgrid::surf::StorageModel surf_StorageModel; +typedef simgrid::surf::Resource surf_Resource; +typedef simgrid::surf::ResourceLmm surf_ResourceLmm; +typedef simgrid::surf::Host surf_Host; +typedef simgrid::surf::HostCLM03 surf_HostCLM03; +typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link; +typedef simgrid::surf::Action surf_Action; +typedef simgrid::surf::ActionLmm surf_ActionLmm; +typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm; +typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf; + #else -typedef struct Model Model; -typedef struct CpuModel CpuModel; -typedef struct WorkstationModel WorkstationModel; -typedef struct NetworkCm02Model NetworkCm02Model; -typedef struct Resource Resource; -typedef struct ResourceLmm ResourceLmm; -typedef struct WorkstationCLM03 WorkstationCLM03; -typedef struct NetworkCm02Link NetworkCm02Link; -typedef struct Cpu Cpu; -typedef struct Action Action; -typedef struct ActionLmm ActionLmm; -typedef struct StorageActionLmm StorageActionLmm; -typedef struct As As; -typedef struct RoutingEdge RoutingEdge; -typedef struct RoutingPlatf RoutingPlatf; + +typedef struct surf_Model surf_Model; +typedef struct surf_CpuModel surf_CpuModel; +typedef struct surf_HostModel surf_HostModel; +typedef struct surf_VMModel surf_VMModel; +typedef struct surf_NetworkModel surf_NetworkModel; +typedef struct surf_StorageModel surf_StorageModel; +typedef struct surf_Resource surf_Resource; +typedef struct surf_ResourceLmm surf_ResourceLmm; +typedef struct surf_HostCLM03 surf_HostCLM03; +typedef struct surf_Host surf_Host; +typedef struct surf_NetworkCm02Link surf_NetworkCm02Link; +typedef struct surf_Action surf_Action; +typedef struct surf_ActionLmm surf_ActionLmm; +typedef struct surf_StorageActionLmm surf_StorageActionLmm; +typedef struct surf_RoutingPlatf surf_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 NetworkCm02Model *surf_network_model_t; - -typedef Resource *surf_resource_t; -typedef ResourceLmm *surf_resource_lmm_t; -typedef WorkstationCLM03 *surf_workstation_CLM03_t; -typedef xbt_dictelm_t surf_workstation_t; -typedef NetworkCm02Link *surf_network_link_t; -typedef Cpu *surf_cpu_t; - -/** \ingroup SURF_actions +typedef surf_Model *surf_model_t; +typedef surf_CpuModel *surf_cpu_model_t; +typedef surf_HostModel *surf_host_model_t; +typedef surf_VMModel *surf_vm_model_t; +typedef surf_NetworkModel *surf_network_model_t; +typedef surf_StorageModel *surf_storage_model_t; + +typedef xbt_dictelm_t surf_resource_t; +typedef surf_Resource *surf_cpp_resource_t; +typedef surf_Host *surf_host_t; +typedef surf_Cpu *surf_cpu_t; + +/** @ingroup SURF_c_bindings * \brief Action structure * * Never create s_surf_action_t by yourself ! The actions are created @@ -102,13 +128,8 @@ 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; -typedef RoutingPlatf *routing_platf_t; +typedef surf_Action *surf_action_t; +typedef surf_RoutingPlatf *routing_platf_t; typedef struct surf_file *surf_file_t; @@ -141,236 +162,499 @@ 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 { + SURF_VM_STATE_CREATED, /**< created, but not yet started */ + SURF_VM_STATE_RUNNING, + 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; + /***************************/ /* 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; -/******************************************* - * TUTORIAL: New model - * New model extension public - * Public functions specific to a New model. - */ -typedef struct surf_new_model_extension_public { - surf_action_t(*fct) (); - void* (*create_resource) (); -} s_surf_model_extension_new_model_t; -/*******************************************/ +XBT_PUBLIC_DATA(routing_platf_t) routing_platf; -/** \ingroup SURF_models - * \brief Private data available on all models - */ -typedef struct surf_model_private *surf_model_private_t; - - /* Cpu model */ - - /** \ingroup SURF_models - * \brief CPU model extension public - * - * Public functions specific to the CPU model. - */ -typedef struct surf_cpu_model_extension_public { - surf_action_t(*execute) (void *cpu, double size); - surf_action_t(*sleep) (void *cpu, double duration); - e_surf_resource_state_t(*get_state) (void *cpu); - int (*get_core) (void *cpu); - double (*get_speed) (void *cpu, double load); - double (*get_available_speed) (void *cpu); - void (*add_traces) (void); -} s_surf_model_extension_cpu_t; - - /* Network model */ - - /** \ingroup SURF_models - * \brief Network model extension public - * - * Public functions specific to the network model - */ -typedef struct surf_network_model_extension_public { - surf_action_t (*communicate) (sg_routing_edge_t src, - sg_routing_edge_t dst, - double size, double rate); - xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays - double (*get_link_bandwidth) (const void *link); - double (*get_link_latency) (const void *link); - int (*link_shared) (const void *link); - void (*add_traces) (void); -} s_surf_model_extension_network_t; - -/* Storage model */ -// -/** \ingroup SURF_models - * \brief Storage model extension public - * - * Public functions specific to the Storage model. - */ - -typedef struct surf_storage_model_extension_public { - surf_action_t(*open) (void *storage, const char* mount, const char* path); - surf_action_t(*close) (void *storage, surf_file_t fd); - surf_action_t(*read) (void *storage, void* ptr, size_t size, - surf_file_t fd); - surf_action_t(*write) (void *storage, const void* ptr, size_t size, - surf_file_t fd); - surf_action_t(*stat) (void *storage, surf_file_t fd); - surf_action_t(*ls) (void *storage, const char *path); -} s_surf_model_extension_storage_t; - - /** \ingroup SURF_models - * \brief Workstation model extension public - * - * Public functions specific to the workstation model. - */ -typedef struct surf_workstation_model_extension_public { - surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation - and create the corresponding action */ - surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */ - e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */ - int (*get_core) (void *workstation); - double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */ - double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */ - surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */ - void *workstation_dst, double size, - double max_rate); - // FIXME: kill next field, which duplicates the routing - xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */ - - surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */ - void **workstation_list, - double *computation_amount, - double *communication_amount, - double rate); - double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */ - double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */ - surf_action_t(*open) (void *workstation, const char* storage, - const char* path); - surf_action_t(*close) (void *workstation, surf_file_t fd); - surf_action_t(*read) (void *workstation, void* ptr, size_t size, - surf_file_t fd); - surf_action_t(*write) (void *workstation, const void* ptr, size_t size, - surf_file_t fd); - surf_action_t(*stat) (void *workstation, surf_file_t fd); - int(*unlink) (void *workstation, surf_file_t fd); - surf_action_t(*ls) (void *workstation, const char* mount, const char *path); - size_t (*get_size) (void *workstation, surf_file_t fd); - - int (*link_shared) (const void *link); - xbt_dict_t(*get_properties) (const void *resource); - void (*add_traces) (void); - -} s_surf_model_extension_workstation_t; - - -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 void *surf_storage_resource_priv(const void *host){ - return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_STORAGE_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); - -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, - double rate); -surf_action_t surf_workstation_model_communicate(surf_workstation_model_t model, surf_workstation_t src, surf_workstation_t dst, double size, double rate); -xbt_dynar_t surf_workstation_model_get_route(surf_workstation_model_t model, surf_workstation_t src, surf_workstation_t dst); -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_resource_t resource); -xbt_dict_t surf_resource_get_properties(surf_resource_t resource); -e_surf_resource_state_t surf_resource_get_state(surf_resource_t resource); -double surf_workstation_get_speed(surf_workstation_t resource, double load); -double surf_workstation_get_available_speed(surf_workstation_t resource); -int surf_workstation_get_core(surf_workstation_t resource); -surf_action_t surf_workstation_execute(surf_workstation_t resource, double size); -surf_action_t surf_workstation_sleep(surf_workstation_t resource, double duration); -surf_action_t surf_workstation_open(surf_workstation_t workstation, const char* mount, const char* path); -surf_action_t surf_workstation_close(surf_workstation_t workstation, surf_file_t fd); -const char *surf_cpu_name(surf_cpu_t resource); -surf_action_t surf_cpu_execute(surf_cpu_t cpu, double size); -surf_action_t surf_cpu_sleep(surf_cpu_t cpu, double duration); -int surf_workstation_unlink(surf_workstation_t workstation, surf_file_t fd); -surf_action_t surf_workstation_ls(surf_workstation_t workstation, const char* mount, const char *path); -size_t surf_workstation_get_size(surf_workstation_t workstation, surf_file_t fd); -surf_action_t surf_workstation_read(surf_workstation_t resource, void *ptr, size_t size, surf_file_t fd); -surf_action_t surf_workstation_write(surf_workstation_t resource, const void *ptr, size_t size, surf_file_t fd); -int surf_network_link_is_shared(surf_network_link_t link); -double surf_network_link_get_bandwidth(surf_network_link_t link); -double surf_network_link_get_latency(surf_network_link_t link); -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); -surf_file_t surf_storage_action_get_file(surf_storage_action_lmm_t action); -xbt_dict_t surf_storage_action_get_ls_dict(surf_storage_action_lmm_t action); +/** @{ @ingroup SURF_c_bindings */ -#ifdef __cplusplus +/** + * @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 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 Get the route (dynar of sg_link_t) between two hosts */ +XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route( + surf_host_model_t model, sg_host_t src, sg_host_t dst); + +/** @brief Create a new VM on the specified host */ +XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM); + +/** @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_network_model_communicate(surf_network_model_t model, sg_host_t src, sg_host_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 available speed of cpu associated to a host */ +XBT_PUBLIC(double) surf_host_get_available_speed(sg_host_t host); + +/** @brief Create a sleep action on the given host */ +XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration); + +/** @brief Create a file opening action on the given host */ +XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath); + +/** @brief Create a file closing action on the given host */ +XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd); + +/** @brief Create a file reading action on the given host */ +XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size); + +/** @brief Create a file writing action on the given host */ +XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_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(sg_host_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(sg_host_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(sg_host_t resource, const char* name); + +/** @brief Get the list of VMs hosted on the host */ +XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(sg_host_t resource); + +/** @brief Retrieve the params of that VM + * @details You can use fields ramsize and overcommit on a PM, too. + */ +XBT_PUBLIC(void) surf_host_get_params(sg_host_t resource, vm_params_t params); + +/** @brief Sets the params of that VM/PM + * @details You can use fields ramsize and overcommit on a PM, too. + */ +XBT_PUBLIC(void) surf_host_set_params(sg_host_t resource, vm_params_t params); + +/** + * @brief Destroy a VM + * + * @param resource The surf vm + */ +XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource); + +/** @brief Suspend a VM */ +XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource); + +/** @brief Resume a VM */ +XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource); + +/** + * @brief Save the VM (Not yet implemented) + * + * @param resource The surf vm + */ +XBT_PUBLIC(void) surf_vm_save(sg_host_t resource); + +/** + * @brief Restore the VM (Not yet implemented) + * + * @param resource The surf vm + */ +XBT_PUBLIC(void) surf_vm_restore(sg_host_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(sg_host_t resource, sg_host_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(sg_host_t) surf_vm_get_pm(sg_host_t resource); + +/** + * @brief [brief description] + * @details [long description] + * + * @param resource [description] + * @param bound [description] + */ +XBT_PUBLIC(void) surf_vm_set_bound(sg_host_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(sg_host_t resource, sg_host_t cpu, unsigned long mask); + +/** + * @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(sg_host_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(sg_host_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(sg_host_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(sg_host_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(sg_host_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(sg_host_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 return the properties set associated to that storage */ +XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(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 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, sg_host_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 + * may not exist. + */ +XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource); + +/** @} */ /**************************************/ /* 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 + * \brief The CPU model object for the physical machine layer */ -XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model; +XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm; + +/** \ingroup SURF_models + * \brief The CPU model object for the virtual machine layer + */ +XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm; + /** \ingroup SURF_models * \brief Initializes the CPU model with the model Cas01 @@ -397,6 +681,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 */ @@ -411,7 +700,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. */ @@ -425,10 +714,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' * @@ -436,7 +735,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); @@ -447,9 +746,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); @@ -457,40 +756,25 @@ 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); -#ifdef HAVE_GTNETS -/** \ingroup SURF_models - * \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 - * - * \see surf_workstation_model_init_GTNETS() - */ -XBT_PUBLIC(void) surf_network_model_init_GTNETS(void); -#endif - #ifdef HAVE_NS3 /** \ingroup SURF_models * \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 /** \ingroup SURF_models * \brief Initializes the platform with the network model Reno - * \param filename XML platform file name * * The problem is related to max( sum( arctan(C * Df * xi) ) ). * @@ -498,14 +782,13 @@ 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); /** \ingroup SURF_models * \brief Initializes the platform with the network model Reno2 - * \param filename XML platform file name * * The problem is related to max( sum( arctan(C * Df * xi) ) ). * @@ -513,14 +796,13 @@ 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); /** \ingroup SURF_models * \brief Initializes the platform with the network model Vegas - * \param filename XML platform file name * * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent * to the proportional fairness. @@ -529,7 +811,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); @@ -551,84 +833,112 @@ XBT_PUBLIC(void) surf_storage_model_init_default(void); */ 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 Initializes the platform with a compound workstation model + * \brief The vm model + * + * Note that when you create an API on top of SURF, + * 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_model_t) surf_vm_model; + +/** \ingroup SURF_models + * \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[]; -/******************************************* - * TUTORIAL: New model +/** \ingroup SURF_models + * \brief Initializes the platform with the current best network and cpu models at hand + * + * 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_new_model_init_default(void); +XBT_PUBLIC(void) surf_vm_model_init_HL13(void); -XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[]; +/** \ingroup SURF_models + * \brief The list of all available vm model models + */ +XBT_PUBLIC_DATA(s_surf_model_description_t) + surf_vm_model_description[]; /*******************************************/ /** \ingroup SURF_models * \brief List of initialized models */ -XBT_PUBLIC_DATA(xbt_dynar_t) model_list; +XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models; + +/** \ingroup SURF_simulation + * \brief List of hosts that have just restarted and whose autorestart process should be restarted. + */ +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_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 +XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_netcard_t edge); /*******************************************/ /*** SURF Globals **************************/ @@ -641,10 +951,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 */ @@ -687,6 +997,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); @@ -699,15 +1012,13 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth; XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency; -XBT_PUBLIC(double) get_cpu_power(const char *power); +XBT_PUBLIC(double) get_cpu_speed(const char *power); XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name); int surf_get_nthreads(void); void surf_set_nthreads(int nthreads); -void surf_watched_hosts(void); - /* * Returns the initial path. On Windows the initial path is * the current directory for the current process in the other @@ -732,5 +1043,12 @@ int instr_platform_traced (void); xbt_graph_t instr_routing_platform_graph (void); void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename); +/********** Routing **********/ +void routing_AS_begin(sg_platf_AS_cbarg_t AS); +void routing_AS_end(void); +surf_NetCard* routing_add_host(surf_As* as, sg_platf_host_cbarg_t host); +void routing_cluster_add_backbone(void* bb); +surf_As* routing_get_current(); + SG_END_DECL() #endif /* _SURF_SURF_H */