X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/47f77041d376b4144af4f41f93a71e083587fd22..346c06db41ebb088e88351d8381d0c232d2ddbb5:/src/include/surf/surf.h diff --git a/src/include/surf/surf.h b/src/include/surf/surf.h index 9566b4c81e..0d6cd04a1c 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" @@ -63,8 +64,8 @@ enum heap_action_type{ NOTSET }; -/** \brief Action structure - * \ingroup SURF_actions +/** \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. @@ -93,8 +94,8 @@ typedef struct surf_action { #ifdef HAVE_TRACING char *category; /**< tracing category for categorized resource utilization monitoring */ #endif - void* file; /**< m_file_t for storage model */ - size_t read_write; + surf_file_t file; /**< surf_file_t for storage model */ + s_file_stat_t stat; /**< surf_file_t for storage model */ } s_surf_action_t; typedef struct surf_action_lmm { @@ -107,8 +108,8 @@ typedef struct surf_action_lmm { 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. * @@ -124,8 +125,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. @@ -146,19 +147,19 @@ 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; -/** \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. */ @@ -178,18 +179,16 @@ typedef struct surf_cpu_model_extension_public { void (*add_traces) (void); } s_surf_model_extension_cpu_t; -typedef struct s_network_element_info *network_element_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) (network_element_t src, - network_element_t dst, + 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); @@ -210,23 +209,23 @@ typedef struct surf_network_model_extension_public { /* Storage model */ -/** \brief Storage model extension public - * \ingroup SURF_models +/** \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* path, const char* mode); - surf_action_t(*close) (void *storage, m_file_t fp); - surf_action_t(*read) (void *storage, void* ptr, size_t size, size_t nmemb, m_file_t stream); - surf_action_t(*write) (void *storage, const void* ptr, size_t size, size_t nmemb, m_file_t stream); - surf_action_t(*stat) (void *storage, int fd, void* buf); + 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, surf_file_t stream); void* (*create_resource) (const char* id, const char* model,const char* type_id); } s_surf_model_extension_storage_t; - /** \brief Workstation model extension public - * \ingroup SURF_models + /** \ingroup SURF_models + * \brief Workstation model extension public * * Public functions specific to the workstation model. */ @@ -251,10 +250,10 @@ typedef struct surf_workstation_model_extension_public { 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, m_file_t fp); - surf_action_t(*read) (void *workstation, const char* storage, void* ptr, size_t size, size_t nmemb, m_file_t stream); - surf_action_t(*write) (void *workstation, const char* storage, const void* ptr, size_t size, size_t nmemb, m_file_t stream); - surf_action_t(*stat) (void *workstation, const char* storage, int fd, void* buf); + 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, surf_file_t stream); int (*link_shared) (const void *link); xbt_dict_t(*get_properties) (const void *resource); void* (*link_create_resource) (const char *name, @@ -280,8 +279,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. @@ -334,9 +333,6 @@ static inline void *surf_cpu_resource_by_name(const char *name) { 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){ - 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); } @@ -347,30 +343,6 @@ typedef struct surf_resource { 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 */ @@ -393,13 +365,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. @@ -413,8 +385,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() @@ -431,14 +403,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[]; @@ -449,8 +421,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 @@ -459,8 +431,8 @@ 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 +/** \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 @@ -471,8 +443,8 @@ XBT_PUBLIC_DATA(surf_model_t) surf_network_model; */ XBT_PUBLIC(void) surf_network_model_init_SMPI(void); -/** \brief Initializes the platform with the network model 'LegrandVelho' - * \ingroup SURF_models +/** \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 @@ -482,8 +454,8 @@ XBT_PUBLIC(void) surf_network_model_init_SMPI(void); */ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void); -/** \brief Initializes the platform with the network model 'Constant' - * \ingroup SURF_models +/** \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 @@ -495,8 +467,8 @@ XBT_PUBLIC(void) 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 +/** \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 @@ -514,8 +486,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 @@ -527,8 +499,8 @@ 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 @@ -539,8 +511,8 @@ XBT_PUBLIC(void) surf_network_model_init_GTNETS(void); 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) ) ). @@ -554,8 +526,8 @@ XBT_PUBLIC(void) surf_network_model_init_NS3(void); */ 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) ) ). @@ -569,8 +541,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 @@ -585,8 +557,8 @@ 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[]; @@ -596,13 +568,13 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) -/** \brief The storage model - * \ingroup SURF_models +/** \ingroup SURF_models + * \brief The storage model */ XBT_PUBLIC(void) surf_storage_model_init_default(void); -/** \brief The list of all available storage modes. - * \ingroup SURF_models +/** \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[]; @@ -613,8 +585,8 @@ 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 @@ -623,8 +595,8 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[]; */ 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. @@ -632,8 +604,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 @@ -644,8 +616,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 @@ -656,8 +628,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 @@ -666,14 +638,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; @@ -682,8 +654,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 * @@ -696,15 +668,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 * @@ -716,15 +688,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_PUBLIC(double) surf_get_clock(void); -/** \brief Exit SURF - * \ingroup SURF_simulation +/** \ingroup SURF_simulation + * \brief Exit SURF * * Clean everything. *