X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0dcd4ade18ba45d1500217fc03b9a04225b1b40e..da79d68ac67b62a07a3df69b8f1371874714ba90:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index 7a7a091d7a..7d7a121737 100644 --- a/src/include/surf/surf.h +++ b/src/include/surf/surf.h @@ -1,11 +1,10 @@ -/* Copyright (c) 2004-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -#ifndef _SURF_SURF_H -#define _SURF_SURF_H +#ifndef SURF_SURF_H +#define SURF_SURF_H #include "xbt/swag.h" #include "xbt/dynar.h" @@ -14,87 +13,55 @@ #include "xbt/misc.h" #include "xbt/config.h" #include "src/internal_config.h" -#include "surf/surf_routing.h" #include "surf/datatypes.h" -#include "xbt/lib.h" -#include "surf/surf_routing.h" #include "simgrid/datatypes.h" #include "simgrid/forward.h" -SG_BEGIN_DECL() -/* Actions and models are highly connected structures... */ - -/* user-visible parameters */ -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; - #ifdef __cplusplus namespace simgrid { namespace surf { - class Model; class CpuModel; class HostModel; -class VMModel; class NetworkModel; class StorageModel; class Resource; -class ResourceLmm; -class HostCLM03; class NetworkCm02Link; class Action; -class ActionLmm; -class StorageActionLmm; -} -namespace kernel { -namespace routing { -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::HostImpl 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::kernel::routing::RoutingPlatf surf_RoutingPlatf; #else 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 +SG_BEGIN_DECL() +/* Actions and models are highly connected structures... */ + +/* user-visible parameters */ +extern XBT_PRIVATE double sg_tcp_gamma; +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; + /** @ingroup SURF_c_bindings * \brief Model datatype * @@ -104,15 +71,9 @@ typedef struct surf_RoutingPlatf surf_RoutingPlatf; 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 * @@ -122,9 +83,7 @@ typedef surf_Cpu *surf_cpu_t; * \see e_surf_action_state_t */ typedef surf_Action *surf_action_t; -typedef surf_RoutingPlatf *routing_platf_t; -typedef struct surf_file *surf_file_t; /** \brief Resource model description */ @@ -139,32 +98,10 @@ typedef struct surf_model_description* surf_model_description_t; XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name); XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table); -/** @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 */ /***************************/ -XBT_PUBLIC_DATA(routing_platf_t) routing_platf; - -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_storage_resource_by_name(const char *name){ - return xbt_lib_get_elm_or_null(storage_lib, name); -} - /** @{ @ingroup SURF_c_bindings */ /** @@ -191,190 +128,6 @@ XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t mode */ XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model); -/** @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 information 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 information - */ -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 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 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 [brief description] * @details [long description] @@ -392,32 +145,6 @@ XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound); */ 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); - /** @} */ /**************************************/ @@ -602,14 +329,6 @@ XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model; */ XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model; -/** \ingroup SURF_models - * \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 * @@ -650,16 +369,6 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[]; */ XBT_PUBLIC(void) surf_vm_model_init_HL13(); -/** \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_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 Globals **************************/ /** \ingroup SURF_simulation @@ -709,19 +418,9 @@ XBT_PUBLIC(double) surf_get_clock(); */ XBT_PUBLIC(void) surf_exit(); -/* 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); -/* For the trace and trace:connect tag (store their content till the end of the parsing) */ -XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list; - -XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name); - /* * Returns the initial path. On Windows the initial path is the current directory for the current process in the other * case the function returns "./" that represents the current directory on Unix/Linux platforms. @@ -731,8 +430,6 @@ const char *__surf_get_initial_path(); /********** Tracing **********/ /* from surf_instr.c */ void TRACE_surf_action(surf_action_t surf_action, const char *category); -void TRACE_surf_alloc(); -void TRACE_surf_release(); /* instr_routing.c */ void instr_routing_define_callbacks (); @@ -745,4 +442,5 @@ xbt_graph_t instr_routing_platform_graph (); void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename); SG_END_DECL() -#endif /* _SURF_SURF_H */ + +#endif