X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8d900364a801ea8e049c5862e360aedea8093094..fa900b346af7c55195fd90c3345cc4107c2afc6d:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index a8fcd8e279..586a2ddf11 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" @@ -13,12 +12,11 @@ #include "xbt/graph.h" #include "xbt/misc.h" #include "xbt/config.h" -#include "src/portable.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/platf_interface.h" #include "simgrid/datatypes.h" #include "simgrid/forward.h" @@ -32,14 +30,6 @@ 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 */ -} e_surf_network_element_type_t; #ifdef __cplusplus @@ -49,56 +39,35 @@ namespace surf { class Model; class CpuModel; class HostModel; -class VMModel; class NetworkModel; class StorageModel; class Resource; -class ResourceLmm; -class Host; -class HostCLM03; class NetworkCm02Link; class Action; -class ActionLmm; -class StorageActionLmm; -class As; -class RoutingPlatf; - } } typedef simgrid::surf::Model surf_Model; typedef simgrid::surf::CpuModel surf_CpuModel; +typedef simgrid::surf::Cpu surf_Cpu; 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::HostImpl surf_Host; 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 surf_Model surf_Model; typedef struct surf_CpuModel surf_CpuModel; +typedef struct surf_Cpu surf_Cpu; 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 @@ -111,14 +80,10 @@ 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 @@ -129,71 +94,26 @@ 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 Specify that we use that action */ -XBT_PUBLIC(void) surf_action_ref(surf_action_t action); - -/** @brief Creates a new action. - * - * @param size The size is the one of the subtype you want to create - * @param cost initial value - * @param model to which model we should attach this action - * @param failed whether we should start this action in failed mode - */ -XBT_PUBLIC(void *) surf_action_new(size_t size, double cost, - surf_model_t model, int failed); - /** \brief Resource model description */ -typedef struct surf_model_description { +struct surf_model_description { const char *name; const char *description; void_f_void_t model_init_preparse; -} s_surf_model_description_t, *surf_model_description_t; +}; +typedef struct surf_model_description s_surf_model_description_t; +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_interface - * @brief Action states - * - * @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 ? */ -} 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; +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); /***************************/ /* 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); } @@ -228,41 +148,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 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); -} - -/** @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); @@ -276,7 +161,7 @@ XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size 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 + * @brief Get the information of a file descriptor * @details The returned xbt_dynar_t contains: * - the size of the file, * - the mount point, @@ -286,7 +171,7 @@ XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_siz * * @param host The surf host * @param fd The file descriptor - * @return An xbt_dynar_t with the file informations + * @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); @@ -308,89 +193,6 @@ XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* na */ 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 * @@ -445,17 +247,7 @@ XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* * - 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); +XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host, surf_file_t fd, sg_offset_t offset, int origin); /** * @brief Get the size in bytes of a storage @@ -484,82 +276,6 @@ 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 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] @@ -609,9 +325,6 @@ 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 object for the physical machine layer */ @@ -626,21 +339,20 @@ XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm; /** \ingroup SURF_models * \brief Initializes the CPU model with the model Cas01 * - * By default, this model uses the lazy optimization mechanism that - * relies on partial invalidation in LMM and a heap for lazy action update. - * You can change this behavior by setting the cpu/optim configuration - * variable to a different value. + * By default, this model uses the lazy optimization mechanism that relies on partial invalidation in LMM and a heap + * for lazy action update. + * You can change this behavior by setting the cpu/optim configuration variable to a different value. * * You shouldn't have to call it by yourself. */ -XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void); +XBT_PUBLIC(void) surf_cpu_model_init_Cas01(); /** \ingroup SURF_models * \brief Initializes the CPU model with trace integration [Deprecated] * * You shouldn't have to call it by yourself. */ -XBT_PUBLIC(void) surf_cpu_model_init_ti(void); +XBT_PUBLIC(void) surf_cpu_model_init_ti(); /** \ingroup SURF_models * \brief The list of all available optimization modes (both for cpu and networks). @@ -658,32 +370,24 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[]; */ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[]; -/**\brief create new host bypass the parser - * - */ - - /** \ingroup SURF_models * \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 host - * model should be accessed because depending on the platform model, - * the network model can be NULL. + * 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 host model should be accessed because depending on the platform model, the network model can be NULL. */ XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model; /** \ingroup SURF_models * \brief Same as network model 'LagrangeVelho', only with different correction factors. * - * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud - * based on the model 'LV08' and different correction factors depending on the communication - * size (< 1KiB, < 64KiB, >= 64KiB). + * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud based on the model 'LV08' and + * different correction factors depending on the communication size (< 1KiB, < 64KiB, >= 64KiB). * See comments in the code for more information. * * \see surf_host_model_init_SMPI() */ -XBT_PUBLIC(void) surf_network_model_init_SMPI(void); +XBT_PUBLIC(void) surf_network_model_init_SMPI(); /** \ingroup SURF_models * \brief Same as network model 'LagrangeVelho', only with different correction factors. @@ -693,52 +397,46 @@ XBT_PUBLIC(void) surf_network_model_init_SMPI(void); * * \see surf_host_model_init_IB() */ -XBT_PUBLIC(void) surf_network_model_init_IB(void); +XBT_PUBLIC(void) surf_network_model_init_IB(); /** \ingroup SURF_models * \brief Initializes the platform with the network model 'LegrandVelho' * - * This model is proposed by Arnaud Legrand and Pedro Velho based on - * the results obtained with the GTNets simulator for onelink and - * dogbone sharing scenarios. See comments in the code for more information. + * This model is proposed by Arnaud Legrand and Pedro Velho based on the results obtained with the GTNets simulator for + * onelink and dogbone sharing scenarios. See comments in the code for more information. * * \see surf_host_model_init_LegrandVelho() */ -XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void); +XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(); /** \ingroup SURF_models * \brief Initializes the platform with the network model 'Constant' * - * In this model, the communication time between two network cards is - * 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_host_model_init_compound. + * In this model, the communication time between two network cards is constant, hence no need for a routing table. + * This is particularly useful when simulating huge distributed algorithms where scalability is really an issue. This + * function is called in conjunction with surf_host_model_init_compound. * * \see surf_host_model_init_compound() */ -XBT_PUBLIC(void) surf_network_model_init_Constant(void); +XBT_PUBLIC(void) surf_network_model_init_Constant(); /** \ingroup SURF_models * \brief Initializes the platform with the network model CM02 * - * You sould call this function by yourself only if you plan using - * surf_host_model_init_compound. + * You sould call this function by yourself only if you plan using surf_host_model_init_compound. * See comments in the code for more information. */ -XBT_PUBLIC(void) surf_network_model_init_CM02(void); +XBT_PUBLIC(void) surf_network_model_init_CM02(); -#ifdef HAVE_NS3 /** \ingroup SURF_models * \brief Initializes the platform with the network model NS3 * - * This function is called by surf_host_model_init_NS3 - * or by yourself only if you plan using surf_host_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_host_model_init_NS3() */ -XBT_PUBLIC(void) surf_network_model_init_NS3(void); -#endif +XBT_PUBLIC(void) surf_network_model_init_NS3(); /** \ingroup SURF_models * \brief Initializes the platform with the network model Reno @@ -750,9 +448,8 @@ XBT_PUBLIC(void) surf_network_model_init_NS3(void); * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003. * * Call this function only if you plan using surf_host_model_init_compound. - * */ -XBT_PUBLIC(void) surf_network_model_init_Reno(void); +XBT_PUBLIC(void) surf_network_model_init_Reno(); /** \ingroup SURF_models * \brief Initializes the platform with the network model Reno2 @@ -764,35 +461,31 @@ XBT_PUBLIC(void) surf_network_model_init_Reno(void); * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003. * * Call this function only if you plan using surf_host_model_init_compound. - * */ -XBT_PUBLIC(void) surf_network_model_init_Reno2(void); +XBT_PUBLIC(void) surf_network_model_init_Reno2(); /** \ingroup SURF_models * \brief Initializes the platform with the network model Vegas * - * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent - * to the proportional fairness. + * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent to the proportional fairness. * * Reference: * [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_host_model_init_compound. - * */ -XBT_PUBLIC(void) surf_network_model_init_Vegas(void); +XBT_PUBLIC(void) surf_network_model_init_Vegas(); /** \ingroup SURF_models * \brief The list of all available network model models */ -XBT_PUBLIC_DATA(s_surf_model_description_t) - surf_network_model_description[]; +XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[]; /** \ingroup SURF_models * \brief The storage model */ -XBT_PUBLIC(void) surf_storage_model_init_default(void); +XBT_PUBLIC(void) surf_storage_model_init_default(); /** \ingroup SURF_models * \brief The list of all available storage modes. @@ -805,120 +498,65 @@ XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model; /** \ingroup SURF_models * \brief The host model * - * Note that when you create an API on top of SURF, - * 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. + * Note that when you create an API on top of SURF, 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_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 * - * This function should be called after a cpu_model and a - * network_model have been set up. - * + * This function should be called after a cpu_model and a network_model have been set up. */ -XBT_PUBLIC(void) surf_host_model_init_compound(void); +XBT_PUBLIC(void) surf_host_model_init_compound(); /** \ingroup SURF_models * \brief Initializes the platform with the current best network and cpu models at hand * * 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. + * 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_host_model_init_current_default(void); +XBT_PUBLIC(void) surf_host_model_init_current_default(); /** \ingroup SURF_models * \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. - * + * 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_host_model_init_ptask_L07(void); +XBT_PUBLIC(void) surf_host_model_init_ptask_L07(); /** \ingroup SURF_models * \brief The list of all available host model models */ -XBT_PUBLIC_DATA(s_surf_model_description_t) - surf_host_model_description[]; +XBT_PUBLIC_DATA(s_surf_model_description_t) 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 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. + * 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_model_init_HL13(void); - -/** \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) 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; +XBT_PUBLIC(void) surf_vm_model_init_HL13(); /** \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 *************************/ -/*******************************************/ -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(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_netcard_t edge); - -/*******************************************/ /*** SURF Globals **************************/ -/*******************************************/ /** \ingroup SURF_simulation * \brief Initialize SURF * \param argc argument number * \param argv arguments * - * This function has to be called to initialize the common - * structures. Then you will have to create the environment by - * calling - * e.g. surf_host_model_init_CM02() + * This function has to be called to initialize the common structures. Then you will have to create the environment by + * calling e.g. surf_host_model_init_CM02() * * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit() */ @@ -929,17 +567,16 @@ XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common str * * This function must be called before the first call to surf_solve() */ -XBT_PUBLIC(void) surf_presolve(void); +XBT_PUBLIC(void) surf_presolve(); /** \ingroup SURF_simulation * \brief Performs a part of the simulation * \param max_date Maximum date to update the simulation to, or -1 * \return the elapsed time, or -1.0 if no event could be executed * - * This function execute all possible events, update the action states - * and returns the time elapsed. - * When you call execute or communicate on a model, the corresponding actions - * are not executed immediately but only when you call surf_solve. + * This function execute all possible events, update the action states and returns the time elapsed. + * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only + * when you call surf_solve. * Note that the returned elapsed time can be zero. */ XBT_PUBLIC(double) surf_solve(double max_date); @@ -949,7 +586,7 @@ XBT_PUBLIC(double) surf_solve(double max_date); * * Return the current time in millisecond. */ -XBT_PUBLIC(double) surf_get_clock(void); +XBT_PUBLIC(double) surf_get_clock(); /** \ingroup SURF_simulation * \brief Exit SURF @@ -958,13 +595,10 @@ XBT_PUBLIC(double) surf_get_clock(void); * * \see surf_init() */ -XBT_PUBLIC(void) surf_exit(void); +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; +XBT_PUBLIC_DATA(xbt_dict_t) current_property_set;// the prop set for the currently parsed element (also used in SIMIX) /* surf parse file related (public because called from a test suite) */ XBT_PUBLIC(void) parse_platform_file(const char *file); @@ -972,37 +606,28 @@ 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. + * 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. */ -const char *__surf_get_initial_path(void); +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); -void TRACE_surf_release(void); +void TRACE_surf_alloc(); +void TRACE_surf_release(); /* instr_routing.c */ -void instr_routing_define_callbacks (void); +void instr_routing_define_callbacks (); void instr_new_variable_type (const char *new_typename, const char *color); void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color); void instr_new_user_state_type (const char *father_type, const char *new_typename); void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color); -int instr_platform_traced (void); -xbt_graph_t instr_routing_platform_graph (void); +int instr_platform_traced (); +xbt_graph_t instr_routing_platform_graph (); 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); -void routing_cluster_add_backbone(Link* bb); -surf_As* routing_get_current(); - SG_END_DECL() -#endif /* _SURF_SURF_H */ + +#endif