X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/37847073d272353f40d07e8d110b963488362efb..fdc1a282a7200e7131298083d6dd41f6aa8beb89:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index 277069fc25..1e34b2c766 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-2013. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it @@ -10,26 +10,45 @@ #include "xbt/swag.h" #include "xbt/dynar.h" #include "xbt/dict.h" +#include "xbt/graph.h" #include "xbt/misc.h" #include "portable.h" #include "xbt/config.h" #include "surf/datatypes.h" +#include "xbt/lib.h" +#include "surf/surf_routing.h" +#include "simgrid/platf_interface.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; + +/* 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; + typedef enum { - SURF_LINK_FULLDUPLEX = 2, - SURF_LINK_SHARED = 1, - SURF_LINK_FATPIPE = 0 -} e_surf_link_sharing_policy_t; + 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; + +XBT_PUBLIC(e_surf_network_element_type_t) + routing_get_network_element_type(const char* name); /** @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 @@ -45,21 +64,23 @@ XBT_PUBLIC(void *) surf_action_new(size_t size, double cost, typedef struct surf_model_description { const char *name; const char *description; - surf_model_t model; - void (*model_init_preparse) (const char *filename); - void (*model_init_postparse) (void); + void_f_void_t model_init_preparse; } s_surf_model_description_t, *surf_model_description_t; -XBT_PUBLIC(void) update_model_description(s_surf_model_description_t * - table, const char *name, - 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 +enum heap_action_type{ + LATENCY = 100, + MAX_DURATION, + NORMAL, + NOTSET +}; + +/** \ingroup SURF_actions + * \brief Action structure * * Never create s_surf_action_t by yourself ! The actions are created * on the fly when you call execute or communicate on a model. @@ -72,32 +93,39 @@ typedef struct surf_action { double cost; /**< cost */ double priority; /**< priority (1.0 by default) */ double max_duration; /**< max_duration (may fluctuate until - the task is completed) */ + the task is completed) */ double remains; /**< How much of that cost remains to - * be done in the currently running task */ + * be done in the currently running task */ #ifdef HAVE_LATENCY_BOUND_TRACKING int latency_limited; /**< Set to 1 if is limited by latency, 0 otherwise */ #endif double start; /**< start time */ double finish; /**< finish time : this is modified during the run - * and fluctuates until the task is completed */ + * and fluctuates until the task is completed */ void *data; /**< for your convenience */ int refcount; surf_model_t model_type; #ifdef HAVE_TRACING char *category; /**< tracing category for categorized resource utilization monitoring */ #endif + surf_file_t file; /**< surf_file_t for storage model */ + xbt_dict_t ls_dict; } s_surf_action_t; typedef struct surf_action_lmm { s_surf_action_t generic_action; lmm_variable_t variable; int suspended; + s_xbt_swag_hookup_t action_list_hookup; + int index_heap; + double last_update; + double last_value; + enum heap_action_type hat; } s_surf_action_lmm_t, *surf_action_lmm_t; -/** \brief Action states - * \ingroup SURF_actions +/** \ingroup SURF_actions + * \brief Action states * * Action states. * @@ -113,8 +141,8 @@ typedef enum { /**< Not in the system anymore. Why did you ask ? */ } e_surf_action_state_t; -/** \brief Action state sets - * \ingroup SURF_actions +/** \ingroup SURF_actions + * \brief Action state sets * * This structure contains some sets of actions. * It provides a fast access to the actions in each state. @@ -135,29 +163,29 @@ typedef struct surf_action_state { /***************************/ /* Generic model object */ /***************************/ -typedef struct s_routing_global s_routing_global_t, *routing_global_t; -XBT_PUBLIC_DATA(routing_global_t) global_routing; - +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; +/*******************************************/ -/** \brief Private data available on all models - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief Private data available on all 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 + /** \ingroup SURF_models + * \brief CPU model extension public * * Public functions specific to the CPU model. */ @@ -165,96 +193,115 @@ 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 (*create_resource) (char *name, double power_peak, - double power_scale, - tmgr_trace_t power_trace, - e_surf_resource_state_t state_initial, - tmgr_trace_t state_trace, - xbt_dict_t cpu_properties); + double (*get_current_power_peak) (void *cpu); + double (*get_power_peak_at) (void *cpu, int pstate_index); + int (*get_nb_pstates) (void *cpu); + void (*set_power_peak_at) (void *cpu, int pstate_index); + double (*get_consumed_energy) (void *cpu); void (*add_traces) (void); } s_surf_model_extension_cpu_t; /* Network model */ - /** \brief Network model extension public - * \ingroup SURF_models + /** \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) (const char *src_name, - const char *dst_name, - double size, double rate); - xbt_dynar_t(*get_route) (const char *src_name, const char *dst_name); + 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); - void (*create_resource) (char *name, - double bw_initial, - tmgr_trace_t bw_trace, - double lat_initial, - tmgr_trace_t lat_trace, - e_surf_resource_state_t - state_initial, - tmgr_trace_t state_trace, - e_surf_link_sharing_policy_t policy, - xbt_dict_t properties); } s_surf_model_extension_network_t; - /** \brief Workstation model extension public - * \ingroup SURF_models +/* 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, surf_file_t fd, sg_storage_size_t size); + surf_action_t(*write) (void *storage, surf_file_t fd, sg_storage_size_t size); + surf_action_t(*stat) (void *storage, surf_file_t fd); + surf_action_t(*ls) (void *storage, const char *path); + xbt_dict_t(*get_properties) (const void *storage); + xbt_dict_t(*get_content) (void *storage); +} 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 */ + 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 */ + + double (*get_current_power_peak) (void *workstation); /**< Return the current CPU speed of a workstation */ + double (*get_power_peak_at) (void *workstation, int pstate_index); /**< Return the speed of a workstation for a specific pstate, + (where higher pstate values represent lower processor speeds) */ + int (*get_nb_pstates) (void *workstation); /**< Return the number of pstates defined for a workstation (default is 1) */ + void (*set_power_peak_at) (void *workstation, int pstate_index); /**< Set the processor speed of a workstation to the speed associated with the pstate_index pstate */ + double (*get_consumed_energy) (void *workstation); /**< Return the total energy consumed by 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 amount, double rate); + 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, surf_file_t fd, sg_storage_size_t size); + surf_action_t(*write) (void *workstation, surf_file_t fd, sg_storage_size_t size); + 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); + sg_storage_size_t (*get_size) (void *workstation, surf_file_t fd); + xbt_dynar_t (*get_info) (void *workstation, surf_file_t fd); + int (*link_shared) (const void *link); - xbt_dict_t(*get_properties) (const void *resource); - void (*link_create_resource) (char *name, - double bw_initial, - tmgr_trace_t bw_trace, - double lat_initial, - tmgr_trace_t lat_trace, - e_surf_resource_state_t - state_initial, - tmgr_trace_t state_trace, - e_surf_link_sharing_policy_t - policy, xbt_dict_t properties); - void (*cpu_create_resource) (char *name, double power_peak, - double power_scale, - tmgr_trace_t power_trace, - e_surf_resource_state_t state_initial, - tmgr_trace_t state_trace, - xbt_dict_t cpu_properties); + xbt_dict_t(*get_properties) (const void *resource); void (*add_traces) (void); + sg_storage_size_t (*get_free_size) (void *workstation,const char* name); + sg_storage_size_t (*get_used_size) (void *workstation,const char* name); + xbt_dict_t (*get_storage_list) (void *workstation); + } s_surf_model_extension_workstation_t; -/** \brief Model datatype - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief Model datatype * * Generic data structure for a model. The workstations, * the CPUs and the network links are examples of models. @@ -271,7 +318,7 @@ typedef struct surf_model { 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 */ + int (*action_unref) (surf_action_t action); /**< Specify that we don't use that action anymore. Returns true if the action was destroyed and false if someone still has references on it. */ 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 */ @@ -280,39 +327,60 @@ typedef struct surf_model { 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 */ +#ifdef HAVE_TRACING + void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */ +#endif double (*get_remains) (surf_action_t action); /**< Get the remains of an action */ #ifdef HAVE_LATENCY_BOUND_TRACKING int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */ #endif - xbt_dict_t resource_set; - + void (*gap_remove) (surf_action_lmm_t action); 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_storage_t storage; s_surf_model_extension_workstation_t workstation; + /*******************************************/ + /* TUTORIAL: New model */ + s_surf_model_extension_new_model_t new_model; + /*******************************************/ } extension; } s_surf_model_t; surf_model_t surf_model_init(void); void surf_model_exit(surf_model_t model); -void *surf_model_resource_by_name(surf_model_t model, const char *name); -#define surf_model_resource_set(model) (model)->resource_set +static inline void *surf_cpu_resource_priv(const void *host) { + return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL); +} +static inline void *surf_workstation_resource_priv(const void *host){ + return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL); +} +static inline void *surf_storage_resource_priv(const void *storage){ + return xbt_lib_get_level((void *)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); +} typedef struct surf_resource { surf_model_t model; char *name; xbt_dict_t properties; + void_f_pvoid_t free_f; } s_surf_resource_t, *surf_resource_t; - - /** * Resource which have a metric handled by a maxmin system */ @@ -335,61 +403,48 @@ typedef struct surf_resource_lmm { /**************************************/ -/** \brief The timer model - * \ingroup SURF_models - */ -XBT_PUBLIC_DATA(surf_model_t) surf_timer_model; - -/** \brief Initializes the timer model - * \ingroup SURF_models - */ -XBT_PUBLIC(void) surf_timer_model_init(const char *filename); - -/** \brief The CPU model - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief The CPU model */ XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model; -/** \brief Initializes the CPU model with the model Cas01 - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief Initializes the CPU model with the model Cas01 * - * This function is called by surf_workstation_model_init_CLM03 - * so you shouldn't have to call it by yourself. + * 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. * - * \see surf_workstation_model_init_CLM03() + * You shouldn't have to call it by yourself. */ -XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename); +XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void); -/** \brief Initializes the CPU model with trace integration - * \ingroup SURF_models +/** \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(const char *filename); +XBT_PUBLIC(void) surf_cpu_model_init_ti(void); -/** \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 - * - * 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() +/** \ingroup SURF_models + * \brief The list of all available optimization modes (both for cpu and networks). + * These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:... */ -XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(const char *filename); +XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[]; -/** \brief The list of all available cpu model models - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief The list of all available cpu model models */ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[]; -XBT_PUBLIC(void) create_workstations(void); - /**\brief create new host bypass the parser * */ -/** \brief The network model - * \ingroup SURF_models +/** \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 workstation @@ -398,34 +453,31 @@ XBT_PUBLIC(void) create_workstations(void); */ 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 +/** \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). + * See comments in the code for more information. * * \see surf_workstation_model_init_SMPI() */ -XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_SMPI(void); -/** \brief Initializes the platform with the network model 'LagrangeVelho' - * \ingroup SURF_models - * \param filename XML platform file name +/** \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. + * dogbone sharing scenarios. See comments in the code for more information. * * \see surf_workstation_model_init_LegrandVelho() */ -XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char - *filename); +XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void); -/** \brief Initializes the platform with the network model 'Constant' - * \ingroup SURF_models - * \param filename XML platform file name +/** \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 @@ -435,43 +487,45 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char * * \see surf_workstation_model_init_compound() */ -XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_Constant(void); -XBT_PUBLIC(void) surf_network_model_init_Vivaldi(const char *filename); +/** \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_workstation_model_init_compound. + * See comments in the code for more information. + */ +XBT_PUBLIC(void) surf_network_model_init_CM02(void); -/** \brief Initializes the platform with the network model CM02 - * \ingroup SURF_models +#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_CLM03 + * 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_CLM03() - */ -XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename); - -/** - * brief initialize the the network model bypassing the XML parser + * \see surf_workstation_model_init_GTNETS() */ -XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id, - double initial_bw, - double initial_lat); +XBT_PUBLIC(void) surf_network_model_init_GTNETS(void); +#endif -#ifdef HAVE_GTNETS -/** \brief Initializes the platform with the network model GTNETS - * \ingroup SURF_models +#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_GTNETS + * This function is called by surf_workstation_model_init_NS3 * or by yourself only if you plan using surf_workstation_model_init_compound * - * \see surf_workstation_model_init_GTNETS() + * \see surf_workstation_model_init_NS3() */ -XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_NS3(void); #endif -/** \brief Initializes the platform with the network model Reno - * \ingroup SURF_models +/** \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) ) ). @@ -483,10 +537,10 @@ XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename); * Call this function only if you plan using surf_workstation_model_init_compound. * */ -XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_Reno(void); -/** \brief Initializes the platform with the network model Reno2 - * \ingroup SURF_models +/** \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) ) ). @@ -498,10 +552,10 @@ XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename); * Call this function only if you plan using surf_workstation_model_init_compound. * */ -XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_Reno2(void); -/** \brief Initializes the platform with the network model Vegas - * \ingroup SURF_models +/** \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 @@ -514,17 +568,29 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(const char *filename); * Call this function only if you plan using surf_workstation_model_init_compound. * */ -XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_Vegas(void); -/** \brief The list of all available network model models - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief The list of all available network model models */ 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); + +/** \ingroup SURF_models + * \brief The list of all available storage modes. + * This storage mode can be set using --cfg=storage/model:... + */ +XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[]; + +XBT_PUBLIC_DATA(surf_model_t) surf_storage_model; -/** \brief The workstation model - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief The workstation model * * Note that when you create an API on top of SURF, * the workstation model should be the only one you use @@ -533,113 +599,104 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) */ XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model; -/** \brief Initializes the platform with a compound workstation model - * \ingroup SURF_models - * \param filename XML platform file name +/** \ingroup SURF_models + * \brief Initializes the platform with a compound workstation 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(const char - *filename); +XBT_PUBLIC(void) surf_workstation_model_init_compound(void); -/** \brief Initializes the platform with the workstation model CLM03 - * \ingroup SURF_models - * \param filename XML platform file name +/** \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 CLM03, the network - * model with the model CM02 and the CPU model with the model Cas01. - * In future releases, some other network models will be implemented and will be - * combined with the workstation model CLM03. - * - * \see surf_workstation_model_init_KCCFLN05() - */ -XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename); - -/** \brief Initializes the platform with the model KCCFLN05 - * \ingroup SURF_models - * \param filename XML platform file name - * - * With this model, the workstations and the network are handled - * together. The network model is roughly the same as in CM02 but - * interference between computations and communications can be taken - * into account. This platform model is the default one for MSG and - * SimDag. + * The workstation 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_KCCFLN05(const char - *filename); +XBT_PUBLIC(void) surf_workstation_model_init_current_default(void); -/** \brief Initializes the platform with the model KCCFLN05 - * \ingroup SURF_models - * \param filename XML platform file name +/** \ingroup SURF_models + * \brief Initializes the platform with the model KCCFLN05 * * 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(const char - *filename); +XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void); -/** \brief The list of all available workstation model models - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief The list of all available workstation model models */ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[]; -/** \brief List of initialized models - * \ingroup SURF_models +/******************************************* + * TUTORIAL: New model + */ +XBT_PUBLIC(void) surf_new_model_init_default(void); +XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[]; +/*******************************************/ + +/** \ingroup SURF_models + * \brief List of initialized models */ XBT_PUBLIC_DATA(xbt_dynar_t) model_list; +/** \ingroup SURF_simulation + * \brief List of hosts that have juste 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(xbt_dict_t) watched_hosts_lib; + +/*******************************************/ +/*** SURF Platform *************************/ +/*******************************************/ +typedef struct s_as *AS_t; + +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(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); + /*******************************************/ /*** SURF Globals **************************/ /*******************************************/ -XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set; -/** \brief Initialize SURF - * \ingroup SURF_simulation +/** \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 surf_timer_model_init() and - * e.g. surf_workstation_model_init_CLM03() or - * surf_workstation_model_init_KCCFLN05(). + * calling + * e.g. surf_workstation_model_init_CM02() * - * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(), - * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit() + * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit() */ 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 +/** \ingroup SURF_simulation + * \brief Finish simulation initialization * * This function must be called before the first call to surf_solve() */ XBT_PUBLIC(void) surf_presolve(void); -/** \brief Performs a part of the simulation - * \ingroup SURF_simulation +/** \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 @@ -648,17 +705,17 @@ XBT_PUBLIC(void) surf_presolve(void); * 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(void); +XBT_PUBLIC(double) surf_solve(double max_date); -/** \brief Return the current time - * \ingroup SURF_simulation +/** \ingroup SURF_simulation + * \brief Return the current time * * Return the current time in millisecond. */ XBT_PUBLIC(double) surf_get_clock(void); -/** \brief Exit SURF - * \ingroup SURF_simulation +/** \ingroup SURF_simulation + * \brief Exit SURF * * Clean everything. * @@ -668,14 +725,10 @@ 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) */ -XBT_PUBLIC_DATA(void) parse_properties(void); /* surf parse file related (public because called from a test suite) */ XBT_PUBLIC(void) parse_platform_file(const char *file); -/* Stores the sets */ -XBT_PUBLIC_DATA(xbt_dict_t) set_list; - /* 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_DATA(xbt_dict_t) trace_connect_list_host_avail; @@ -687,111 +740,34 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency; XBT_PUBLIC(double) get_cpu_power(const char *power); -/*public interface to create resource bypassing the parser via cpu/network model - * - * see surfxml_parse.c - * */ -XBT_PUBLIC(void) surf_host_create_resource(char *name, double power_peak, - double power_scale, - tmgr_trace_t power_trace, - e_surf_resource_state_t - state_initial, - tmgr_trace_t state_trace, - xbt_dict_t cpu_properties); - -/*public interface to create resource bypassing the parser via workstation_ptask_L07 model - * - * see surfxml_parse.c - * */ -XBT_PUBLIC(void) surf_wsL07_host_create_resource(char *name, - double power_peak, - double power_scale, - tmgr_trace_t power_trace, - e_surf_resource_state_t - state_initial, - tmgr_trace_t state_trace, - xbt_dict_t - cpu_properties); -/** - * create link resource - * see surfxml_parse.c - */ -XBT_PUBLIC(void) surf_link_create_resource(char *name, - double bw_initial, - tmgr_trace_t bw_trace, - double lat_initial, - tmgr_trace_t lat_trace, - e_surf_resource_state_t - state_initial, - tmgr_trace_t state_trace, - e_surf_link_sharing_policy_t - policy, xbt_dict_t properties); - - -XBT_PUBLIC(void) surf_wsL07_link_create_resource(char *name, - double bw_initial, - tmgr_trace_t bw_trace, - double lat_initial, - tmgr_trace_t lat_trace, - e_surf_resource_state_t - state_initial, - tmgr_trace_t state_trace, - e_surf_link_sharing_policy_t - policy, - xbt_dict_t properties); -/** - * add route element (link_ctn) bypassing the parser - * - * see surfxml_parse.c - * - */ -XBT_PUBLIC(void) surf_add_route_element(char *link_ctn_id); - -/** - * set route src_id,dest_id, and create a route resource - * - * see surf_routing.c && surfxml_parse.c - */ - -XBT_PUBLIC(void) surf_set_routes(void); - - -/** - * add traces - * see surfxml_parse.c - */ -XBT_PUBLIC(void) surf_add_host_traces(void); -XBT_PUBLIC(void) surf_add_link_traces(void); -XBT_PUBLIC(void) surf_wsL07_add_traces(void); +XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name); -/* - * init AS from lua console - * see surf_routing.c - */ -XBT_PUBLIC(void) routing_AS_init(const char *id, const char *mode); -XBT_PUBLIC(void) routing_AS_end(const char *id); -// add host to network element list -XBT_PUBLIC(void) routing_add_host(const char *host_id); -//Set a new link on the actual list of link for a route or ASroute -XBT_PUBLIC(void) routing_add_link(const char *link_id); -//Set the endpoints for a route -XBT_PUBLIC(void) routing_set_route(const char *src_id, const char *dst_id); -//Store the route -XBT_PUBLIC(void) routing_store_route(void); +int surf_get_nthreads(void); +void surf_set_nthreads(int nthreads); /* - * interface between surf and lua bindings - * see surfxml_parse.c - */ -XBT_PUBLIC(void) surf_AS_new(const char *id, const char *mode); -XBT_PUBLIC(void) surf_AS_finalize(const char *id); -XBT_PUBLIC(void) surf_route_add_host(const char *id); -XBT_PUBLIC(void) surf_routing_add_route(const char *src_id, - const char *dest_id, - xbt_dynar_t links_id); - -#include "surf/surf_resource.h" -#include "surf/surf_resource_lmm.h" + * 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); + +/********** 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); + +/* instr_routing.c */ +void instr_routing_define_callbacks (void); +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); +void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename); SG_END_DECL() #endif /* _SURF_SURF_H */