X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/dff9e15c44ab6340d27215957c56fa72fad246a2..06719c673be736decee093e3f4750580c402552c:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index 92b1c62da5..41ebfa021a 100644 --- a/src/include/surf/surf.h +++ b/src/include/surf/surf.h @@ -1,6 +1,5 @@ -/* $Id$ */ - -/* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */ +/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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. */ @@ -13,37 +12,38 @@ #include "xbt/dict.h" #include "xbt/misc.h" #include "portable.h" +#include "xbt/config.h" +#include "surf/datatypes.h" SG_BEGIN_DECL() +/* Actions and models are highly connected structures... */ + typedef enum { + SURF_RESOURCE_ON = 1, /**< Up & ready */ + SURF_RESOURCE_OFF = 0 /**< Down & broken */ + } e_surf_resource_state_t; - - -/* Actions and models are higly connected structures... */ -/** \brief Action datatype - * \ingroup SURF_actions - * - * An action is some working amount on a model. - * It is represented as a cost, a priority, a duration and a state. +/** @Brief Specify that we use that action */ +XBT_PUBLIC(void) surf_action_ref(surf_action_t action); +/** @brief Creates a new action. * - * \see e_surf_action_state_t + * @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 */ - typedef struct surf_action *surf_action_t; +XBT_PUBLIC(void *) surf_action_new(size_t size, double cost, + surf_model_t model, int failed); + -/** \brief Model datatype - * \ingroup SURF_models - * - * Generic data structure for a model. The workstations, - * the CPUs and the network links are examples of models. - */ - typedef struct surf_model *surf_model_t; /** \brief Resource model description */ typedef struct surf_model_description { const char *name; + const char *description; surf_model_t model; - void (*model_init) (const char *filename); - void (*create_ws) (void); + void (*model_init_preparse) (const char *filename); + void (*model_init_postparse) (void); } s_surf_model_description_t, *surf_model_description_t; XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table, @@ -51,13 +51,14 @@ XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * table, surf_model_t model); 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); /** \brief Action structure * \ingroup SURF_actions * * Never create s_surf_action_t by yourself ! The actions are created * on the fly when you call execute or communicate on a model. - * + * * \see e_surf_action_state_t */ typedef struct surf_action { @@ -77,6 +78,12 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, surf_model_t model_type; } s_surf_action_t; + typedef struct surf_action_lmm { + s_surf_action_t generic_action; + lmm_variable_t variable; + int suspended; + } s_surf_action_lmm_t, *surf_action_lmm_t; + /** \brief Action states * \ingroup SURF_actions * @@ -116,142 +123,179 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, /***************************/ /* Generic model object */ /***************************/ - -/** \brief Public data available on all models - * \ingroup SURF_models - * - * These functions are implemented by all models. - */ - typedef struct surf_model_public { - s_surf_action_state_t states; - /**< Any living action on this model */ - void *(*name_service) (const char *name); - /**< Return a model given its name */ - const char *(*get_resource_name) (void *resource_id); - /**< Return the name of a resource */ - - e_surf_action_state_t(*action_get_state) (surf_action_t action); - /**< Return the state of an action */ - double (*action_get_start_time) (surf_action_t action); - /**< Return the start time of an action */ - double (*action_get_finish_time) (surf_action_t action); - /**< Return the finish time of an action */ - void (*action_use) (surf_action_t action); - /**< Set an action used */ - int (*action_free) (surf_action_t action); - /**< Free an action */ - void (*action_cancel) (surf_action_t action); - /**< Cancel a running action */ - void (*action_recycle) (surf_action_t action); - /**< Recycle an action */ - void (*action_change_state) (surf_action_t action, - /**< Change an action state*/ - e_surf_action_state_t state); - void (*action_set_data) (surf_action_t action, void *data); - /**< Set the user data of an action */ - void (*suspend) (surf_action_t action); - /**< Suspend an action */ - void (*resume) (surf_action_t action); - /**< Resume a suspended action */ - int (*is_suspended) (surf_action_t action); - /**< Return whether an action is suspended */ - void (*set_max_duration) (surf_action_t action, double duration); - /**< Set the max duration of an action*/ - void (*set_priority) (surf_action_t action, double priority); - /**< Set the priority of an action */ - xbt_dict_t(*get_properties) (void *resource_id); - /**< Return the properties dictionary */ - const char *name; - /**< Name of this model */ - } s_surf_model_public_t, *surf_model_public_t; + typedef struct s_routing s_routing_t, *routing_t; +XBT_PUBLIC_DATA(routing_t) used_routing; /** \brief Private data available on all models * \ingroup SURF_models */ typedef struct surf_model_private *surf_model_private_t; + /** \brief Timer model extension public + * \ingroup SURF_model + * + * Additionnal functions specific to the timer model + */ + typedef struct surf_timer_model_extension_public { + void (*set) (double date, void *function, void *arg); + int (*get) (void **function, void **arg); + } s_surf_model_extension_timer_t; + + /* Cpu model */ + + /** \brief CPU model extension public + * \ingroup SURF_models + * + * 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); + double (*get_speed) (void *cpu, double load); + double (*get_available_speed) (void *cpu); + } s_surf_model_extension_cpu_t; + + /* Network model */ + + /** \brief Network model extension public + * \ingroup SURF_models + * + * Public functions specific to the network model + */ + typedef struct surf_network_model_extension_public { + surf_action_t(*communicate) (const char *src_name, + const char *dst_name, int src, int dst, + double size, double rate); + xbt_dynar_t(*get_route) (int src, int dst); + double (*get_link_bandwidth) (const void *link); + double (*get_link_latency) (const void *link); + int (*link_shared) (const void *link); + } s_surf_model_extension_network_t; + + /** \brief Workstation model extension public + * \ingroup SURF_models + * + * 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 */ + 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); + 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 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 */ + int (*link_shared) (const void *link); + xbt_dict_t(*get_properties) (const void *resource); + } s_surf_model_extension_workstation_t; + /** \brief Model datatype * \ingroup SURF_models - * + * * Generic data structure for a model. The workstations, * the CPUs and the network links are examples of models. */ typedef struct surf_model { - surf_model_private_t common_private; - surf_model_public_t common_public; + const char *name;/**< Name of this model */ + s_surf_action_state_t states; /**< Any living action on this model */ + + e_surf_action_state_t(*action_state_get) (surf_action_t action); + /**< Return the state of an action */ + void (*action_state_set) (surf_action_t action, + e_surf_action_state_t state); + /**< Change an action state*/ + + double (*action_get_start_time) (surf_action_t action);/**< Return the start time of an action */ + double (*action_get_finish_time) (surf_action_t action);/**< Return the finish time of an action */ + int (*action_unref) (surf_action_t action);/**< Specify that we don't use that action anymore */ + void (*action_cancel) (surf_action_t action);/**< Cancel a running action */ + void (*action_recycle) (surf_action_t action);/**< Recycle an action */ + void (*action_data_set) (surf_action_t action, void *data);/**< Set the user data of an action */ + void (*suspend) (surf_action_t action);/**< Suspend an action */ + void (*resume) (surf_action_t action);/**< Resume a suspended action */ + int (*is_suspended) (surf_action_t action);/**< Return whether an action is suspended */ + void (*set_max_duration) (surf_action_t action, double duration);/**< Set the max duration of an action*/ + void (*set_priority) (surf_action_t action, double priority);/**< Set the priority of an action */ + double (*get_remains) (surf_action_t action);/**< Get the remains of an action */ + + xbt_dict_t resource_set; + + + + surf_model_private_t model_private; + + + + union extension { + s_surf_model_extension_timer_t timer; + s_surf_model_extension_cpu_t cpu; + s_surf_model_extension_network_t network; + s_surf_model_extension_workstation_t workstation; + } extension; } s_surf_model_t; -/**************************************/ -/* Implementations of model object */ -/**************************************/ + surf_model_t surf_model_init(void); + void surf_model_exit(surf_model_t model); -/** \brief Timer model extension public - * \ingroup SURF_model - * - * Additionnal functions specific to the timer model - */ - typedef struct surf_timer_model_extension_public { - void (*set) (double date, void *function, void *arg); - int (*get) (void **function, void **arg); - } s_surf_timer_model_extension_public_t, - *surf_timer_model_extension_public_t; + void *surf_model_resource_by_name(surf_model_t model, const char *name); +#define surf_model_resource_set(model) (model)->resource_set -/** \brief Timer model - * \ingroup SURF_models - */ - typedef struct surf_timer_model { - surf_model_private_t common_private; - surf_model_public_t common_public; - surf_timer_model_extension_public_t extension_public; - } s_surf_timer_model_t, *surf_timer_model_t; + typedef struct surf_resource { + surf_model_t model; + char *name; + xbt_dict_t properties; + } s_surf_resource_t, *surf_resource_t; -/** \brief The timer model - * \ingroup SURF_models - */ -XBT_PUBLIC_DATA(surf_timer_model_t) surf_timer_model; -/** \brief Initializes the timer model - * \ingroup SURF_models + +/** + * Resource which have a metric handled by a maxmin system */ -XBT_PUBLIC(void) surf_timer_model_init(const char *filename); + typedef struct { + double scale; + double peak; + tmgr_trace_event_t event; + } s_surf_metric_t; -/* Cpu model */ + typedef struct surf_resource_lmm { + s_surf_resource_t generic_resource; + lmm_constraint_t constraint; + e_surf_resource_state_t state_current; + tmgr_trace_event_t state_event; + s_surf_metric_t power; + } s_surf_resource_lmm_t, *surf_resource_lmm_t; + +/**************************************/ +/* Implementations of model object */ +/**************************************/ -/** \brief CPU state - * \ingroup SURF_models - */ - typedef enum { - SURF_CPU_ON = 1, /**< Up & ready */ - SURF_CPU_OFF = 0 /**< Down & broken */ - } e_surf_cpu_state_t; -/** \brief CPU model extension public +/** \brief The timer model * \ingroup SURF_models - * - * 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_cpu_state_t(*get_state) (void *cpu); - double (*get_speed) (void *cpu, double load); - double (*get_available_speed) (void *cpu); - } s_surf_cpu_model_extension_public_t, - *surf_cpu_model_extension_public_t; +XBT_PUBLIC_DATA(surf_model_t) surf_timer_model; -/** \brief CPU model datatype +/** \brief Initializes the timer model * \ingroup SURF_models */ - typedef struct surf_cpu_model { - surf_model_private_t common_private; - surf_model_public_t common_public; - surf_cpu_model_extension_public_t extension_public; - } s_surf_cpu_model_t, *surf_cpu_model_t; +XBT_PUBLIC(void) surf_timer_model_init(const char *filename); /** \brief The CPU model * \ingroup SURF_models */ -XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model; +XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model; /** \brief Initializes the CPU model with the model Cas01 * \ingroup SURF_models @@ -263,38 +307,26 @@ XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model; */ XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename); -/** \brief The list of all available cpu model models +/** \brief Initializes the CPU model with trace integration * \ingroup SURF_models + * */ -XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[]; - -/* Network model */ +XBT_PUBLIC(void) surf_cpu_model_init_ti(const char *filename); -/** \brief Network model extension public +/** \brief Initializes the CPU model with the model Cas01 Improved. This model uses a heap to order the events, decreasing the time complexity to get the minimum next event. * \ingroup SURF_models * - * Public functions specific to the network model + * This function is called by surf_workstation_model_init_CLM03 + * so you shouldn't have to call it by yourself. + * + * \see surf_workstation_model_init_CLM03() */ - typedef struct surf_network_model_extension_public { - surf_action_t(*communicate) (void *src, void *dst, double size, - double max_rate); - const void **(*get_route) (void *src, void *dst); - int (*get_route_size) (void *src, void *dst); - const char *(*get_link_name) (const void *link); - double (*get_link_bandwidth) (const void *link); - double (*get_link_latency) (const void *link); - int (*link_shared) (const void *link); - } s_surf_network_model_extension_public_t, - *surf_network_model_extension_public_t; +XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(const char *filename); -/** \brief Network model datatype +/** \brief The list of all available cpu model models * \ingroup SURF_models */ - typedef struct surf_network_model { - surf_model_private_t common_private; - surf_model_public_t common_public; - surf_network_model_extension_public_t extension_public; - } s_surf_network_model_t, *surf_network_model_t; +XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[]; XBT_PUBLIC(void) create_workstations(void); @@ -306,7 +338,19 @@ XBT_PUBLIC(void) create_workstations(void); * 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; +XBT_PUBLIC_DATA(surf_model_t) surf_network_model; + +/** \brief Same as network model 'LagrangeVelho', only with different correction factors. + * \ingroup SURF_models + * \param filename XML platform file name + * + * 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 surf_workstation_model_init_SMPI() + */ +XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename); /** \brief Initializes the platform with the network model 'LagrangeVelho' * \ingroup SURF_models @@ -334,6 +378,8 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename); */ XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_Vivaldi(const char *filename); + /** \brief Initializes the platform with the network model CM02 * \ingroup SURF_models * \param filename XML platform file name @@ -392,7 +438,7 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename); * \ingroup SURF_models * \param filename XML platform file name * - * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent + * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent * to the proportional fairness. * * Reference: @@ -404,69 +450,11 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename); */ XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename); -#ifdef HAVE_SDP -/** \brief Initializes the platform with the network model based on SDP - * \ingroup SURF_models - * \param filename XML platform file name - * - * This function implements the proportional fairness known as the maximization - * of x1*x2*...*xn . - * - * Reference: - * - * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier. - * Semi-definite programming approach for bandwidth allocation and routing in networks. - * Game Theory and Applications, 9:169-179, December 2003. Nova publisher. - * - * Call this function only if you plan using surf_workstation_model_init_compound. - */ -XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename); -#endif - /** \brief The list of all available network model models * \ingroup SURF_models */ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[]; -/** \brief Workstation model extension public - * \ingroup SURF_models - * - * 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_cpu_state_t(*get_state) (void *workstation); /**< Return the CPU state of a 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); - - 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 amount, double rate); - const void **(*get_route) (void *src, void *dst); /**< Return the network link list between two workstations */ - int (*get_route_size) (void *src, void *dst); /**< Return the route size between two workstations */ - const char *(*get_link_name) (const void *link); /**< Return the name of a network link */ - 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 */ - int (*link_shared) (const void *link); - } s_surf_workstation_model_extension_public_t, - *surf_workstation_model_extension_public_t; - -/** \brief Workstation model datatype. - * \ingroup SURF_models - * - */ - typedef struct surf_workstation_model { - surf_model_private_t common_private; - surf_model_public_t common_public; - surf_workstation_model_extension_public_t extension_public; - } s_surf_workstation_model_t, *surf_workstation_model_t; /** \brief The workstation model * \ingroup SURF_models @@ -476,7 +464,7 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[]; * 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_model_t) surf_workstation_model; /** \brief Initializes the platform with a compound workstation model * \ingroup SURF_models @@ -532,24 +520,6 @@ XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename); XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[]; -/** \brief The network links - * \ingroup SURF_models - * - * This dict contains all network links. - * - * \see workstation_set - */ -XBT_PUBLIC_DATA(xbt_dict_t) link_set; - -/** \brief The workstations - * \ingroup SURF_models - * - * This dict contains all workstations. - * - * \see link_set - */ -XBT_PUBLIC_DATA(xbt_dict_t) workstation_set; -XBT_PUBLIC_DATA(xbt_dict_t) cpu_set; /** \brief List of initialized models * \ingroup SURF_models */ @@ -558,6 +528,7 @@ XBT_PUBLIC_DATA(xbt_dynar_t) model_list; /*******************************************/ /*** SURF Globals **************************/ /*******************************************/ +XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set; /** \brief Initialize SURF * \ingroup SURF_simulation @@ -575,6 +546,21 @@ XBT_PUBLIC_DATA(xbt_dynar_t) model_list; */ XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */ +/** \brief Initialize the used models. + * + * Must be called after the surf_init so that configuration infrastructure is created + * Must be called before parsing/creating the environment + * Must not be called within the initialization process so that the use get a chance to change the settings from + * its code between, say, MSG_init and MSG_create_environment using MSG_config + */ +XBT_PUBLIC(void) surf_config_models_setup(const char *platform_file); + +/** \brief create the elements of the models + * + * Must be called after parsing the platform file and before using any elements + */ +XBT_PUBLIC(void) surf_config_models_create_elms(void); + /** \brief Finish simulation initialization * \ingroup SURF_simulation * @@ -639,8 +625,14 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth; XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency; -XBT_PUBLIC_DATA(double) get_cpu_power(const char *power); +XBT_PUBLIC(double) get_cpu_power(const char *power); + + +/* used to byPass XML ( interact direclty with cpu and avoid callback ) */ +XBT_PUBLIC(void) surf_cpu_init_im_bypass(char* name,double power); +#include "surf/surf_resource.h" +#include "surf/surf_resource_lmm.h" SG_END_DECL() #endif /* _SURF_SURF_H */