X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8461d5fbbf4d4f12a92d4a1f3924cf2f8e040e4c..9889deb10c0b29c3c5a2ae25ac0c4b9e25e8334e:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index bc8b8626eb..d072e4bd91 100644 --- a/src/include/surf/surf.h +++ b/src/include/surf/surf.h @@ -11,6 +11,7 @@ #include "xbt/dynar.h" #include "xbt/dict.h" #include "xbt/misc.h" +#include "xbt/file_stat.h" #include "portable.h" #include "xbt/config.h" #include "surf/datatypes.h" @@ -25,14 +26,15 @@ 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 */ + 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); + 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 @@ -56,8 +58,15 @@ XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, 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. @@ -70,32 +79,40 @@ 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 */ + s_file_stat_t stat; /**< 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. * @@ -111,8 +128,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. @@ -133,19 +150,30 @@ 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; /* 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. */ @@ -167,16 +195,16 @@ typedef struct surf_cpu_model_extension_public { /* 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); //FIXME: kill field? That is done by the routing nowadays + 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); @@ -193,14 +221,33 @@ typedef struct surf_network_model_extension_public { 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, const char* mode); + surf_action_t(*close) (void *storage, surf_file_t fp); + surf_action_t(*read) (void *storage, void* ptr, double 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, surf_file_t stream); + surf_action_t(*unlink) (void *storage, surf_file_t stream); + surf_action_t(*ls) (void *storage, const char *path); + void* (*create_resource) (const char* id, const char* model, const char* type_id, const char *content); +} 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 */ double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */ @@ -215,9 +262,17 @@ typedef struct surf_workstation_model_extension_public { 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, const char* mode); + surf_action_t(*close) (void *workstation, surf_file_t fp); + surf_action_t(*read) (void *workstation, void* ptr, size_t size, size_t nmemb, surf_file_t stream); + surf_action_t(*write) (void *workstation, const void* ptr, size_t size, size_t nmemb, surf_file_t stream); + surf_action_t(*stat) (void *workstation, surf_file_t stream); + surf_action_t(*unlink) (void *workstation, surf_file_t stream); + surf_action_t(*ls) (void *workstation, const char* mount, const char *path); + int (*link_shared) (const void *link); xbt_dict_t(*get_properties) (const void *resource); void* (*link_create_resource) (const char *name, @@ -243,8 +298,8 @@ typedef struct surf_workstation_model_extension_public { -/** \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. @@ -261,7 +316,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 */ @@ -278,12 +333,16 @@ typedef struct surf_model { int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */ #endif + void (*gap_remove) (surf_action_lmm_t action); + 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; + s_surf_model_extension_new_model_t new_model; } extension; } s_surf_model_t; @@ -291,13 +350,13 @@ 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); + 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); + return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL); } -static inline void *surf_network_resource_by_name(const char *name){ - return xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL); +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 { @@ -306,8 +365,6 @@ typedef struct surf_resource { xbt_dict_t properties; } s_surf_resource_t, *surf_resource_t; - - /** * Resource which have a metric handled by a maxmin system */ @@ -330,13 +387,13 @@ typedef struct surf_resource_lmm { /**************************************/ -/** \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 * * By default, this model uses the lazy optimization mechanism that * relies on partial invalidation in LMM and a heap for lazy action update. @@ -350,8 +407,8 @@ XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model; */ XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void); -/** \brief Initializes the CPU model with trace integration [Deprecated] - * \ingroup SURF_models +/** \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() @@ -368,14 +425,14 @@ XBT_PUBLIC(double) generic_share_resources(double now); */ XBT_PUBLIC(void) generic_update_actions_state(double now, double delta); -/** \brief The list of all available optimization modes (both for cpu and networks). - * \ingroup SURF_models +/** \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 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[]; @@ -386,8 +443,8 @@ XBT_PUBLIC(void) create_workstations(void); */ -/** \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 @@ -396,47 +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(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(void); - -/** \brief Initializes the platform with the network model 'LV08_im' - * \ingroup SURF_models - * \param filename XML platform file name - * - * This model is adds the lazy management improvement to Legrand and - * Velho model. This improvement essentially replaces the list of actions - * inside the simulation kernel by a heap in order to reduce the complexity - * at each iteration of the simulation kernel. - * - * \see surf_workstation_model_init_LegrandVelho() - */ -XBT_PUBLIC(void) im_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 @@ -448,12 +489,12 @@ XBT_PUBLIC(void) im_surf_network_model_init_LegrandVelho(void); */ XBT_PUBLIC(void) surf_network_model_init_Constant(void); -/** \brief Initializes the platform with the network model CM02 - * \ingroup SURF_models - * \param filename XML platform file name +/** \ingroup SURF_models + * \brief Initializes the platform with the network model CM02 * * 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() */ @@ -467,8 +508,8 @@ XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id, double initial_lat); #ifdef HAVE_GTNETS -/** \brief Initializes the platform with the network model GTNETS - * \ingroup SURF_models +/** \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_GTNETS @@ -476,12 +517,12 @@ XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id, * * \see surf_workstation_model_init_GTNETS() */ -XBT_PUBLIC(void) surf_network_model_init_GbTNETS(void); +XBT_PUBLIC(void) surf_network_model_init_GTNETS(void); #endif #ifdef HAVE_NS3 -/** \brief Initializes the platform with the network model NS3 - * \ingroup SURF_models +/** \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_NS3 @@ -490,23 +531,10 @@ XBT_PUBLIC(void) surf_network_model_init_GbTNETS(void); * \see surf_workstation_model_init_NS3() */ XBT_PUBLIC(void) surf_network_model_init_NS3(void); - -XBT_PUBLIC(void) parse_ns3_add_host(void); -XBT_PUBLIC(void) parse_ns3_add_router(void); -XBT_PUBLIC(void) parse_ns3_add_link(void); -XBT_PUBLIC(void) parse_ns3_add_AS(void); -XBT_PUBLIC(void) parse_ns3_add_route(void); -XBT_PUBLIC(void) parse_ns3_add_ASroute(void); -XBT_PUBLIC(void) parse_ns3_add_cluster(void); -XBT_PUBLIC(void) parse_ns3_end_platform(void); -XBT_PUBLIC(void) create_ns3_topology(void); -XBT_PUBLIC(double) ns3_get_link_latency(const void *link); -XBT_PUBLIC(double) ns3_get_link_bandwidth(const void *link); - #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) ) ). @@ -520,8 +548,8 @@ XBT_PUBLIC(double) ns3_get_link_bandwidth(const void *link); */ 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) ) ). @@ -535,8 +563,8 @@ XBT_PUBLIC(void) surf_network_model_init_Reno(void); */ 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 @@ -551,15 +579,25 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(void); */ 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[]; -/** \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 @@ -568,8 +606,8 @@ 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 +/** \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. @@ -577,8 +615,8 @@ XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model; */ XBT_PUBLIC(void) surf_workstation_model_init_compound(void); -/** \brief Initializes the platform with the current best network and cpu models at hand - * \ingroup SURF_models +/** \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 @@ -589,8 +627,8 @@ XBT_PUBLIC(void) surf_workstation_model_init_compound(void); */ XBT_PUBLIC(void) surf_workstation_model_init_current_default(void); -/** \brief Initializes the platform with the workstation model CLM03 - * \ingroup SURF_models +/** \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 @@ -601,8 +639,8 @@ XBT_PUBLIC(void) surf_workstation_model_init_current_default(void); */ XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void); -/** \brief Initializes the platform with the model KCCFLN05 - * \ingroup SURF_models +/** \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 @@ -611,14 +649,14 @@ XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void); */ 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 +/** \ingroup SURF_models + * \brief List of initialized models */ XBT_PUBLIC_DATA(xbt_dynar_t) model_list; @@ -627,8 +665,8 @@ XBT_PUBLIC_DATA(xbt_dynar_t) model_list; /*******************************************/ 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 * @@ -641,15 +679,15 @@ XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set; */ XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */ -/** \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 * @@ -661,15 +699,15 @@ XBT_PUBLIC(void) surf_presolve(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_INLINE XBT_PUBLIC(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. * @@ -698,5 +736,12 @@ XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency; XBT_PUBLIC(double) get_cpu_power(const char *power); +XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name); + +int surf_get_nthreads(void); +void surf_set_nthreads(int nthreads); + +void surf_watched_hosts(void); + SG_END_DECL() #endif /* _SURF_SURF_H */