X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ad5365a072943b2b0bacc486fa504e93a99ea940..af0b5e9494ca8988c8dd7d3874c3c7a400a63172:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index 6397cf694d..8b7e323d19 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. */ @@ -11,70 +10,122 @@ #include "xbt/swag.h" #include "xbt/dynar.h" #include "xbt/dict.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" -/* Actions and resources are higly connected structures... */ +SG_BEGIN_DECL() +/* Actions and models are highly connected structures... */ -/** \brief Action datatype - * \ingroup SURF_actions - * - * An action is some working amount on a resource. - * It is represented as a cost, a priority, a duration and a state. +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; + +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. * - * \see e_surf_action_state_t - */ -typedef struct surf_action *surf_action_t; - -/** \brief Resource datatype - * \ingroup SURF_resources - * - * Generic data structure for a resource. The workstations, - * the CPUs and the network links are examples of resources. - */ -typedef struct surf_resource *surf_resource_t; - -/** \brief Action structure - * \ingroup SURF_actions + * @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 { + const char *name; + const char *description; + void_f_void_t model_init_preparse; +} s_surf_model_description_t, *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); + +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 resource. - * + * on the fly when you call execute or communicate on a model. + * * \see e_surf_action_state_t */ typedef struct surf_action { s_xbt_swag_hookup_t state_hookup; xbt_swag_t state_set; - double cost; /**< cost */ - double priority; /**< priority (1.0 by default) */ - double max_duration; /**< max_duration (may fluctuate until + double cost; /**< cost */ + double priority; /**< priority (1.0 by default) */ + double max_duration; /**< max_duration (may fluctuate until the task is completed) */ - double remains; /**< How much of that cost remains to + double remains; /**< How much of that cost remains to * be done in the currently running task */ - double start; /**< start time */ - double finish; /**< finish time : this is modified during the run +#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 */ - void *data; /**< for your convenience */ - int using; - surf_resource_t resource_type; + 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 + void* file; /**< surf_file_t for storage model */ + size_t read_write; } s_surf_action_t; -/** \brief Action states - * \ingroup SURF_actions +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; + enum heap_action_type hat; +} s_surf_action_lmm_t, *surf_action_lmm_t; + +/** \ingroup SURF_actions + * \brief Action states * * Action states. * * \see surf_action_t, surf_action_state_t */ typedef enum { - SURF_ACTION_READY = 0, /**< Ready */ - SURF_ACTION_RUNNING, /**< Running */ - SURF_ACTION_FAILED, /**< Task Failure */ - SURF_ACTION_DONE, /**< Completed */ - SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */ - SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */ + SURF_ACTION_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; -/** \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. @@ -82,332 +133,636 @@ typedef enum { * \see surf_action_t, e_surf_action_state_t */ typedef struct surf_action_state { - xbt_swag_t ready_action_set; /**< Actions in state SURF_ACTION_READY */ - xbt_swag_t running_action_set; /**< Actions in state SURF_ACTION_RUNNING */ - xbt_swag_t failed_action_set; /**< Actions in state SURF_ACTION_FAILED */ - xbt_swag_t done_action_set; /**< Actions in state SURF_ACTION_DONE */ + xbt_swag_t ready_action_set; + /**< Actions in state SURF_ACTION_READY */ + xbt_swag_t running_action_set; + /**< Actions in state SURF_ACTION_RUNNING */ + xbt_swag_t failed_action_set; + /**< Actions in state SURF_ACTION_FAILED */ + xbt_swag_t done_action_set; + /**< Actions in state SURF_ACTION_DONE */ } s_surf_action_state_t, *surf_action_state_t; /***************************/ -/* Generic resource object */ +/* Generic model object */ /***************************/ +typedef struct s_routing_global s_routing_global_t, *routing_global_t; +XBT_PUBLIC_DATA(routing_global_t) global_routing; + -/** \brief Public data available on all resources - * \ingroup SURF_resources - * - * These functions are implemented by all resources. - */ -typedef struct surf_resource_public { - s_surf_action_state_t states; /**< Any living action on this resource */ - void *(*name_service) (const char *name); /**< Return a resource 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 */ - const char *name; /**< Name of this resource */ -} s_surf_resource_public_t, *surf_resource_public_t; - -/** \brief Private data available on all resources - * \ingroup SURF_resources - */ -typedef struct surf_resource_private *surf_resource_private_t; - -/** \brief Resource datatype - * \ingroup SURF_resources - * - * Generic data structure for a resource. The workstations, - * the CPUs and the network links are examples of resources. +/** \ingroup SURF_models + * \brief Private data available on all models */ +typedef struct surf_model_private *surf_model_private_t; + + /* Cpu model */ + + /** \ingroup SURF_models + * \brief CPU model extension public + * + * Public functions specific to the CPU model. + */ +typedef struct surf_cpu_model_extension_public { + surf_action_t(*execute) (void *cpu, double size); + surf_action_t(*sleep) (void *cpu, double duration); + e_surf_resource_state_t(*get_state) (void *cpu); + double (*get_speed) (void *cpu, double load); + double (*get_available_speed) (void *cpu); + void* (*create_resource) (const char *name, double power_peak, + double power_scale, + tmgr_trace_t power_trace, + int core, + e_surf_resource_state_t state_initial, + tmgr_trace_t state_trace, + xbt_dict_t cpu_properties); + void (*add_traces) (void); +} s_surf_model_extension_cpu_t; + +typedef struct s_network_element_info *network_element_t; + + /* Network model */ + + /** \ingroup SURF_models + * \brief Network model extension public + * + * Public functions specific to the network model + */ +typedef struct surf_network_model_extension_public { + surf_action_t (*communicate) (network_element_t src, + network_element_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) (const 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; + +/* Storage model */ + +/** \ingroup SURF_models + * \brief Storage model extension public + * + * Public functions specific to the Storage model. + */ + +typedef struct surf_file { + char *name; /**< @brief host name if any */ + void *simdata; + void *data; /**< @brief user data */ +}s_surf_file_t, *surf_file_t; + +typedef struct surf_storage_model_extension_public { + surf_action_t(*open) (void *storage, const char* path, const char* mode); + surf_action_t(*close) (void *storage, surf_file_t fp); + surf_action_t(*read) (void *storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream); + surf_action_t(*write) (void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream); + surf_action_t(*stat) (void *storage, int fd, void* buf); + void* (*create_resource) (const char* id, const char* model,const char* type_id); +} s_surf_model_extension_storage_t; + + /** \ingroup SURF_models + * \brief Workstation model extension public + * + * Public functions specific to the workstation model. + */ +typedef struct surf_workstation_model_extension_public { + surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation + and create the corresponding action */ + surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */ + e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */ + double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */ + double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */ + surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */ + void *workstation_dst, double size, + double max_rate); + // FIXME: kill next field, which duplicates the routing + xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */ + + surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */ + void **workstation_list, + double *computation_amount, + double *communication_amount, + double amount, double rate); + double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */ + double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */ + surf_action_t(*open) (void *workstation, const char* storage, const char* path, const char* mode); + surf_action_t(*close) (void *workstation, const char* storage, surf_file_t fp); + surf_action_t(*read) (void *workstation, const char* storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream); + surf_action_t(*write) (void *workstation, const char* storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream); + surf_action_t(*stat) (void *workstation, const char* storage, int fd, void* buf); + int (*link_shared) (const void *link); + xbt_dict_t(*get_properties) (const void *resource); + void* (*link_create_resource) (const 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) (const 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); + void (*add_traces) (void); + +} s_surf_model_extension_workstation_t; + + + + +/** \ingroup SURF_models + * \brief Model datatype + * + * Generic data structure for a model. The workstations, + * the CPUs and the network links are examples of models. + */ +typedef struct surf_model { + 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 */ +#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 + + surf_model_private_t model_private; + + union extension { + 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; + } extension; +} s_surf_model_t; + +surf_model_t surf_model_init(void); +void surf_model_exit(surf_model_t model); + +static inline void *surf_cpu_resource_by_name(const char *name) { + return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL); +} +static inline void *surf_workstation_resource_by_name(const char *name){ + return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL); +} +static inline void *surf_network_resource_by_name(const char *name){ + network_element_t net_elm = xbt_lib_get_or_null(host_lib, name, ROUTING_HOST_LEVEL); + if(!net_elm) net_elm = xbt_lib_get_or_null(as_router_lib, name, ROUTING_ASR_LEVEL); + return net_elm; +} +static inline void *surf_storage_resource_by_name(const char *name){ + return xbt_lib_get_or_null(storage_lib, name, SURF_STORAGE_LEVEL); +} + typedef struct surf_resource { - surf_resource_private_t common_private; - surf_resource_public_t common_public; -} s_surf_resource_t; + surf_model_t model; + char *name; + xbt_dict_t properties; +} s_surf_resource_t, *surf_resource_t; + +/** + * Storage struct + */ +typedef struct s_storage_type { + char *model; + xbt_dict_t content; + char *type_id; + xbt_dict_t properties; +} s_storage_type_t, *storage_type_t; + +typedef struct s_mount { + void *id; + char *name; +} s_mount_t, *mount_t; + +typedef struct s_content { + char *user_rights; + char *user; + char *group; + char *date; + char *time; + size_t size; +} s_content_t, *content_t; + +/** + * Resource which have a metric handled by a maxmin system + */ +typedef struct { + double scale; + double peak; + tmgr_trace_event_t event; +} s_surf_metric_t; + +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 resource object */ +/* Implementations of model object */ /**************************************/ -/** \brief Timer resource extension public - * \ingroup SURF_resource + +/** \ingroup SURF_models + * \brief The CPU model + */ +XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model; + +/** \ingroup SURF_models + * \brief Initializes the CPU model with the model Cas01 * - * Additionnal functions specific to the timer resource + * 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. + * + * 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_timer_resource_extension_public { - void (*set) (double date, void *function, void *arg); - int (*get) (void **function, void **arg); -} s_surf_timer_resource_extension_public_t, - *surf_timer_resource_extension_public_t; +XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void); -/** \brief Timer resource - * \ingroup SURF_resources +/** \ingroup SURF_models + * \brief Initializes the CPU model with trace integration [Deprecated] + * + * You shouldn't have to call it by yourself. + * \see surf_workstation_model_init_CLM03() */ -typedef struct surf_timer_resource { - surf_resource_private_t common_private; - surf_resource_public_t common_public; - surf_timer_resource_extension_public_t extension_public; -} s_surf_timer_resource_t, *surf_timer_resource_t; +XBT_PUBLIC(void) surf_cpu_model_init_ti(void); -/** \brief The timer resource - * \ingroup SURF_resources +/** \brief This function call the share resources function needed + * */ -extern surf_timer_resource_t surf_timer_resource; +XBT_PUBLIC(double) generic_share_resources(double now); -/** \brief Initializes the timer resource - * \ingroup SURF_resources +/** \brief This function call the update action state function needed + * */ -XBT_PUBLIC(void) surf_timer_resource_init(const char *filename); +XBT_PUBLIC(void) generic_update_actions_state(double now, double delta); -/* Cpu resource */ +/** \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_DATA(s_surf_model_description_t) surf_optimization_mode_description[]; -/** \brief CPU state - * \ingroup SURF_resources +/** \ingroup SURF_models + * \brief The list of all available cpu model models */ -typedef enum { - SURF_CPU_ON = 1, /**< Ready */ - SURF_CPU_OFF = 0 /**< Running */ -} e_surf_cpu_state_t; +XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[]; + +XBT_PUBLIC(void) create_workstations(void); -/** \brief CPU resource extension public - * \ingroup SURF_resources - * - * Public functions specific to the CPU resource. +/**\brief create new host bypass the parser + * */ -typedef struct surf_cpu_resource_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_resource_extension_public_t, - *surf_cpu_resource_extension_public_t; -/** \brief CPU resource datatype - * \ingroup SURF_resources + +/** \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 + * model should be accessed because depending on the platform model, + * the network model can be NULL. */ -typedef struct surf_cpu_resource { - surf_resource_private_t common_private; - surf_resource_public_t common_public; - surf_cpu_resource_extension_public_t extension_public; -} s_surf_cpu_resource_t, *surf_cpu_resource_t; +XBT_PUBLIC_DATA(surf_model_t) surf_network_model; -/** \brief The CPU resource - * \ingroup SURF_resources +/** \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() */ -extern surf_cpu_resource_t surf_cpu_resource; +XBT_PUBLIC(void) surf_network_model_init_SMPI(void); -/** \brief Initializes the CPU resource with the model Cas01 - * \ingroup SURF_resources +/** \ingroup SURF_models + * \brief Initializes the platform with the network model 'LegrandVelho' * - * This function is called by surf_workstation_resource_init_CLM03 - * so you shouldn't have to call it by yourself. + * 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_workstation_resource_init_CLM03() + * \see surf_workstation_model_init_LegrandVelho() */ -XBT_PUBLIC(void) surf_cpu_resource_init_Cas01(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void); -/* Network resource */ +/** \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_workstation_model_init_compound. + * + * \see surf_workstation_model_init_compound() + */ +XBT_PUBLIC(void) surf_network_model_init_Constant(void); -/** \brief Network resource extension public - * \ingroup SURF_resources +/** \ingroup SURF_models + * \brief Initializes the platform with the network model CM02 * - * Public functions specific to the network resource + * This function is called by surf_workstation_model_init_CLM03 + * or by yourself only if you plan using surf_workstation_model_init_compound + * See comments in the code for more information. + * + * \see surf_workstation_model_init_CLM03() */ -typedef struct surf_network_resource_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); -} s_surf_network_resource_extension_public_t, - *surf_network_resource_extension_public_t; +XBT_PUBLIC(void) surf_network_model_init_CM02(void); -/** \brief Network resource datatype - * \ingroup SURF_resources +/** + * brief initialize the the network model bypassing the XML parser */ -typedef struct surf_network_resource { - surf_resource_private_t common_private; - surf_resource_public_t common_public; - surf_network_resource_extension_public_t extension_public; -} s_surf_network_resource_t, *surf_network_resource_t; +XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id, + double initial_bw, + double initial_lat); -/** \brief The network resource - * \ingroup SURF_resources +#ifdef HAVE_GTNETS +/** \ingroup SURF_models + * \brief Initializes the platform with the network model GTNETS + * \param filename XML platform file name * - * When creating a new API on top on SURF, you shouldn't use the - * network resource unless you know what you are doing. Only the workstation - * resource should be accessed because depending on the platform model, - * the network resource can be NULL. + * This function is called by surf_workstation_model_init_GTNETS + * or by yourself only if you plan using surf_workstation_model_init_compound + * + * \see surf_workstation_model_init_GTNETS() */ -extern surf_network_resource_t surf_network_resource; +XBT_PUBLIC(void) surf_network_model_init_GTNETS(void); +#endif -/** \brief Initializes the platform with the network model CM02 - * \ingroup SURF_resources +#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_resource_init_CLM03 - * so you shouldn't call it by yourself. - * - * \see surf_workstation_resource_init_CLM03() - */ -XBT_PUBLIC(void) surf_network_resource_init_CM02(const char *filename); - -/** \brief Workstation resource extension public - * \ingroup SURF_resources - * - * Public functions specific to the workstation resource. - */ -typedef struct surf_workstation_resource_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 */ -} s_surf_workstation_resource_extension_public_t, - *surf_workstation_resource_extension_public_t; - -/** \brief Workstation resource datatype. - * \ingroup SURF_resources - * - */ -typedef struct surf_workstation_resource { - surf_resource_private_t common_private; - surf_resource_public_t common_public; - surf_workstation_resource_extension_public_t extension_public; -} s_surf_workstation_resource_t, *surf_workstation_resource_t; - -/** \brief The workstation resource - * \ingroup SURF_resources + * This function is called by surf_workstation_model_init_NS3 + * or by yourself only if you plan using surf_workstation_model_init_compound * - * Note that when you create an API on top of SURF, - * the workstation resource should be the only one you use - * because depending on the platform model, the network resource and the CPU resource - * may not exist. + * \see surf_workstation_model_init_NS3() */ -extern surf_workstation_resource_t surf_workstation_resource; +XBT_PUBLIC(void) surf_network_model_init_NS3(void); +#endif -/** \brief Initializes the platform with the workstation model CLM03 - * \ingroup SURF_resources +/** \ingroup SURF_models + * \brief Initializes the platform with the network model Reno * \param filename XML platform file name * - * This platform model seperates the workstation resource and the network resource. - * The workstation resource will be initialized with the model CLM03, the network - * resource with the model CM02 and the CPU resource with the model Cas01. - * In future releases, some other network models will be implemented and will be - * combined with the workstation model CLM03. + * The problem is related to max( sum( arctan(C * Df * xi) ) ). + * + * 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_workstation_model_init_compound. * - * \see surf_workstation_resource_init_KCCFLN05() */ -XBT_PUBLIC(void) surf_workstation_resource_init_CLM03(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_Reno(void); -/** \brief Initializes the platform with the model KCCFLN05 - * \ingroup SURF_resources +/** \ingroup SURF_models + * \brief Initializes the platform with the network model Reno2 * \param filename XML platform file name * - * With this model, the workstations and the network are handled together. - * There is no network resource. This platform model is the default one for - * MSG and SimDag. + * The problem is related to max( sum( arctan(C * Df * xi) ) ). + * + * Reference: + * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms. + * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003. + * + * Call this function only if you plan using surf_workstation_model_init_compound. * - * \see surf_workstation_resource_init_CLM03() */ -void surf_workstation_resource_init_KCCFLN05(const char *filename); +XBT_PUBLIC(void) surf_network_model_init_Reno2(void); -/** \brief The network links - * \ingroup SURF_resources +/** \ingroup SURF_models + * \brief Initializes the platform with the network model Vegas + * \param filename XML platform file name + * + * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent + * to the proportional fairness. + * + * Reference: + * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms. + * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003. * - * This dict contains all network links. + * Call this function only if you plan using surf_workstation_model_init_compound. * - * \see workstation_set */ -extern xbt_dict_t network_link_set; +XBT_PUBLIC(void) surf_network_model_init_Vegas(void); + +/** \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[]; + + + -/** \brief The workstations - * \ingroup SURF_resources + + + +/** \ingroup SURF_models + * \brief The workstation model * - * This dict contains all workstations. + * Note that when you create an API on top of SURF, + * the workstation 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_model_t) surf_workstation_model; + +/** \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(void); + +/** \ingroup SURF_models + * \brief Initializes the platform with the current best network and cpu models at hand + * + * This platform model seperates the workstation model and the network model. + * The workstation model will be initialized with the model compound, the network + * model with the model LV08 (with cross traffic support) and the CPU model with + * the model Cas01. + * Such model is subject to modification with warning in the ChangeLog so monitor it! + * + */ +XBT_PUBLIC(void) surf_workstation_model_init_current_default(void); + +/** \ingroup SURF_models + * \brief Initializes the platform with the workstation model CLM03 + * + * 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 network_link_set */ -extern xbt_dict_t workstation_set; +XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void); -/** \brief List of initialized resources - * \ingroup SURF_resources +/** \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. + * */ -extern xbt_dynar_t resource_list; +XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void); + +/** \ingroup SURF_models + * \brief The list of all available workstation model models + */ +XBT_PUBLIC_DATA(s_surf_model_description_t) + surf_workstation_model_description[]; + +/** \ingroup SURF_models + * \brief List of initialized models + */ +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 +/** \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_resource_init() - * and surf_workstation_resource_init_CLM03() or surf_workstation_resource_init_KCCFLN05(). + * This function has to be called to initialize the common + * structures. Then you will have to create the environment by + * calling + * e.g. surf_workstation_model_init_CLM03() * - * \see surf_timer_resource_init(), surf_workstation_resource_init_CLM03(), - * surf_workstation_resource_init_KCCFLN05(), surf_exit() + * \see surf_workstation_model_init_CLM03(), surf_workstation_model_init_compound(), surf_exit() */ -void surf_init(int *argc, char **argv); /* initialize common structures */ +XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */ -/** \brief Performs a part of the simulation - * \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); + +/** \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 resource, the corresponding actions + * 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. */ -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. */ -double surf_get_clock(void); +XBT_PUBLIC(double) surf_get_clock(void); -/** \brief Exit SURF - * \ingroup SURF_simulation +/** \ingroup SURF_simulation + * \brief Exit SURF * * Clean everything. * * \see surf_init() */ -void surf_exit(void); +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(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; +XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power; +XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail; +XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth; +XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency; + + +XBT_PUBLIC(double) get_cpu_power(const char *power); + +int surf_get_nthreads(void); +void surf_set_nthreads(int nthreads); -#endif /* _SURF_SURF_H */ +SG_END_DECL() +#endif /* _SURF_SURF_H */