X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ad5365a072943b2b0bacc486fa504e93a99ea940..806d1314d9398af51ffd016c95b39d173960c659:/include/gras/datadesc.h diff --git a/include/gras/datadesc.h b/include/gras/datadesc.h index 393cd4c935..8523c197f5 100644 --- a/include/gras/datadesc.h +++ b/include/gras/datadesc.h @@ -1,8 +1,7 @@ -/* $Id$ */ - /* gras/datadesc.h - Describing the data you want to exchange */ -/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */ +/* Copyright (c) 2004, 2005, 2006, 2007, 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. */ @@ -10,8 +9,8 @@ #ifndef GRAS_DATADESC_H #define GRAS_DATADESC_H -#include "xbt/misc.h" /* SG_BEGIN_DECL */ -#include "xbt/dynar.h" /* void_f_pvoid_t */ +#include "xbt/misc.h" /* SG_BEGIN_DECL */ +#include "xbt/dynar.h" /* void_f_pvoid_t */ SG_BEGIN_DECL() @@ -36,7 +35,6 @@ SG_BEGIN_DECL() * - Section \ref GRAS_dd_cb_simple provides a simple interface to do so, allowing to share integers stored on a stack. * - Section \ref GRAS_dd_cb_full provides a full featured interface to do so, but it may reveal somehow difficult to use. **/ - /** @defgroup GRAS_dd_basic Basic operations on data descriptions * @ingroup GRAS_dd * \htmlonly \endhtmlonly @@ -54,16 +52,16 @@ SG_BEGIN_DECL() * */ /* @{ */ - /** @brief Opaque type describing a type description. */ typedef struct s_gras_datadesc_type *gras_datadesc_type_t; /** \brief Search a type description from its name */ XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_by_name(const char *name); -XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_by_name_or_null(const char *name); +XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_by_name_or_null(const char + *name); /* @} */ - + /** @defgroup GRAS_dd_auto Automatic parsing of data descriptions * @ingroup GRAS_dd * \htmlonly \endhtmlonly @@ -94,6 +92,7 @@ XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_by_name_or_null(const char *name) * * Here is an example:\verbatim GRAS_DEFINE_TYPE(s_clause, struct s_array { + xbt_string_t name; struct s_array *father GRAS_ANNOTE(size,1); int length; int *data GRAS_ANNOTE(size,length); @@ -102,9 +101,10 @@ XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_by_name_or_null(const char *name) int *matrix GRAS_ANNOTE(size,rows*cols); } ;)\endverbatim - * It specifies that the structure s_array contains five fields, that the \a father field is a simple reference, - * that the size of the array pointed by \a data is the \a length field, and that the \a matrix field is an array - * which size is the result of \a rows times \a cols. + * It specifies that the structure s_array contains six fields, that the \a name field is a classical null-terminated + * char* string (#xbt_string_t is just an helper type defined exactly to help the parsing macro to specify the semantic of the pointer), + * that \a father field is a simple reference, that the size of the array pointed by \a data is the \a length field, and that the + * \a matrix field is an arraywhich size is the result of \a rows times \a cols. * * \warning Since GRAS_DEFINE_TYPE is a macro, you shouldn't put any comma in your type definition * (comma separates macro args). For example, change \verbatim int a, b;\endverbatim to \verbatim int a; @@ -179,11 +179,12 @@ int server(int argc, char *argv[]) { }\endverbatim * * If you want to split this in two files (one for each kind of processes), - * you need to put the GRAS_DEFINE_TYPE block in a separate header. But + * you need to put the GRAS_DEFINE_TYPE block in a separate header (so that + * each process kind see the associated C type definition). But * then you cannot include this right away in all files because the extra - * symbols would be defined in dupplicate. + * symbols containing the GRAS definition would be dupplicated. * - * You thus have to decide in which file the symbols will live. In that + * You thus have to decide in which C file the symbols will live. In that * file, include the header without restriction: * \verbatim #include "my_header.h" @@ -193,27 +194,38 @@ int client(int argc, char *argv[]) { }\endverbatim * And in the other files needing the C definitions without the extra GRAS - * symbols, declare the symbol GRAS_DEFINE_TYPE_EXTERN before: + * symbols, declare the symbol GRAS_DEFINE_TYPE_EXTERN before loading gras.h: * \verbatim #define GRAS_DEFINE_TYPE_EXTERN +#include #include "my_header.h" int server(int argc, char *argv[]) { ... }\endverbatim + * + * Sometimes, the situation is even more complicated: There is some shared + * messages that you want to see from every file, and some private messages + * that you want to be defined only in one C file. + * In that case, use the previous trick for common messages, and use + * #GRAS_DEFINE_TYPE_LOCAL for the private messages. + * + * For now, there is no way to have semi-private symbols (for example shared + * in all files of a library), sorry. Use functions as interface to your + * library instead of publishing directly the messages. * */ /** @{ */ - + /** @brief Automatically parse C code * @hideinitializer */ #define GRAS_DEFINE_TYPE(name,def) \ const char * _gras_this_type_symbol_does_not_exist__##name=#def; def -#ifndef DOXYGEN_SKIP /* doxygen don't like macro fun too much */ +#ifndef DOXYGEN_SKIP /* doxygen don't like macro fun too much */ # ifdef GRAS_DEFINE_TYPE_EXTERN # undef GRAS_DEFINE_TYPE # define GRAS_DEFINE_TYPE(name,def) def @@ -225,8 +237,18 @@ int server(int argc, char *argv[]) { * @hideinitializer */ #define GRAS_DEFINE_TYPE_EXTERN 1 +/* leave the fun of declaring this to the user */ +#undef GRAS_DEFINE_TYPE_EXTERN - +/** @brief Define a symbol to be automatically parsed, disregarding #GRAS_DEFINE_TYPE_EXTERN + * @hideinitializer + * + * Call this macro instead of #GRAS_DEFINE_TYPE if you had to define #GRAS_DEFINE_TYPE_EXTERN + * to load some external symbols, but if you now want to automatically parse the content of + * your private messages. + */ +#define GRAS_DEFINE_TYPE_LOCAL(name, def) \ + const char * _gras_this_type_symbol_does_not_exist__##name=#def; def /** @brief Retrieve a datadesc which was previously parsed * @hideinitializer @@ -242,15 +264,15 @@ int server(int argc, char *argv[]) { * @brief Add an annotation to a type to be automatically parsed */ #define GRAS_ANNOTE(key,val) - + /** @brief Defines the value of a define to the datatype parsing infrastructure */ -XBT_PUBLIC(void) gras_datadesc_set_const(const char*name, int value); +XBT_PUBLIC(void) gras_datadesc_set_const(const char *name, int value); /* @} */ -XBT_PUBLIC(gras_datadesc_type_t) -gras_datadesc_parse(const char *name, const char *C_statement); +XBT_PUBLIC(gras_datadesc_type_t) + gras_datadesc_parse(const char *name, const char *C_statement); /** @defgroup GRAS_dd_manual Simple manual data description * @ingroup GRAS_dd @@ -295,11 +317,24 @@ typedef struct s_gras_cbps *gras_cbps_t; /* callbacks prototypes */ /** \brief Prototype of type callbacks returning nothing. */ -typedef void (*gras_datadesc_type_cb_void_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); +typedef void (*gras_datadesc_type_cb_void_t) (gras_datadesc_type_t + typedesc, gras_cbps_t vars, + void *data); /** \brief Prototype of type callbacks returning an int. */ -typedef int (*gras_datadesc_type_cb_int_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); +typedef int (*gras_datadesc_type_cb_int_t) (gras_datadesc_type_t + typedesc, gras_cbps_t vars, + void *data); /** \brief Prototype of type callbacks selecting a type. */ -typedef gras_datadesc_type_t (*gras_datadesc_selector_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); +typedef + + + + + +gras_datadesc_type_t(*gras_datadesc_selector_t) (gras_datadesc_type_t + typedesc, + gras_cbps_t vars, + void *data); /****************************************** @@ -307,44 +342,49 @@ typedef gras_datadesc_type_t (*gras_datadesc_selector_t)(gras_datadesc_type_t ty ******************************************/ XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_struct(const char *name); -XBT_PUBLIC(void) gras_datadesc_struct_append(gras_datadesc_type_t struct_type, - const char *name, - gras_datadesc_type_t field_type); -XBT_PUBLIC(void) gras_datadesc_struct_close(gras_datadesc_type_t struct_type); - - -XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_union(const char *name, - gras_datadesc_type_cb_int_t selector); -XBT_PUBLIC(void) gras_datadesc_union_append(gras_datadesc_type_t union_type, - const char *name, - gras_datadesc_type_t field_type); -XBT_PUBLIC(void) gras_datadesc_union_close(gras_datadesc_type_t union_type); - - -XBT_PUBLIC(gras_datadesc_type_t) - gras_datadesc_ref(const char *name, - gras_datadesc_type_t referenced_type); -XBT_PUBLIC(gras_datadesc_type_t) - gras_datadesc_ref_generic(const char *name, - gras_datadesc_selector_t selector); - -XBT_PUBLIC(gras_datadesc_type_t) - gras_datadesc_array_fixed(const char *name, - gras_datadesc_type_t element_type, - long int fixed_size); -XBT_PUBLIC(gras_datadesc_type_t) - gras_datadesc_array_dyn(const char *name, - gras_datadesc_type_t element_type, - gras_datadesc_type_cb_int_t dynamic_size); -XBT_PUBLIC(gras_datadesc_type_t) - gras_datadesc_ref_pop_arr(gras_datadesc_type_t element_type); - -XBT_PUBLIC(gras_datadesc_type_t) - gras_datadesc_dynar(gras_datadesc_type_t elm_t, - void_f_pvoid_t *free_func); +XBT_PUBLIC(void) gras_datadesc_struct_append(gras_datadesc_type_t + struct_type, const char *name, + gras_datadesc_type_t + field_type); +XBT_PUBLIC(void) gras_datadesc_struct_close(gras_datadesc_type_t + struct_type); + + +XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_union(const char *name, + gras_datadesc_type_cb_int_t + selector); +XBT_PUBLIC(void) gras_datadesc_union_append(gras_datadesc_type_t + union_type, const char *name, + gras_datadesc_type_t + field_type); +XBT_PUBLIC(void) gras_datadesc_union_close(gras_datadesc_type_t + union_type); + + +XBT_PUBLIC(gras_datadesc_type_t) + gras_datadesc_ref(const char *name, gras_datadesc_type_t referenced_type); +XBT_PUBLIC(gras_datadesc_type_t) + gras_datadesc_copy(const char *name, gras_datadesc_type_t copied_type); +XBT_PUBLIC(gras_datadesc_type_t) + gras_datadesc_ref_generic(const char *name, + gras_datadesc_selector_t selector); + +XBT_PUBLIC(gras_datadesc_type_t) + gras_datadesc_array_fixed(const char *name, + gras_datadesc_type_t element_type, + long int fixed_size); +XBT_PUBLIC(gras_datadesc_type_t) + gras_datadesc_array_dyn(const char *name, + gras_datadesc_type_t element_type, + gras_datadesc_type_cb_int_t dynamic_size); XBT_PUBLIC(gras_datadesc_type_t) - gras_datadesc_matrix(gras_datadesc_type_t elm_t, - void_f_pvoid_t * const free_f); + gras_datadesc_ref_pop_arr(gras_datadesc_type_t element_type); + +XBT_PUBLIC(gras_datadesc_type_t) + gras_datadesc_dynar(gras_datadesc_type_t elm_t, void_f_pvoid_t free_func); +XBT_PUBLIC(gras_datadesc_type_t) + gras_datadesc_matrix(gras_datadesc_type_t elm_t, + void_f_pvoid_t const free_f); /********************************* * Change stuff within datadescs * @@ -355,25 +395,29 @@ XBT_PUBLIC(void) gras_datadesc_cycle_set(gras_datadesc_type_t type); /** \brief Specify that this type do not contain any cycles (default) */ XBT_PUBLIC(void) gras_datadesc_cycle_unset(gras_datadesc_type_t type); /** \brief Add a pre-send callback to this datadesc. */ -XBT_PUBLIC(void) gras_datadesc_cb_send (gras_datadesc_type_t type, - gras_datadesc_type_cb_void_t pre); +XBT_PUBLIC(void) gras_datadesc_cb_send(gras_datadesc_type_t type, + gras_datadesc_type_cb_void_t pre); /** \brief Add a post-receive callback to this datadesc.*/ -XBT_PUBLIC(void) gras_datadesc_cb_recv(gras_datadesc_type_t type, - gras_datadesc_type_cb_void_t post); +XBT_PUBLIC(void) gras_datadesc_cb_recv(gras_datadesc_type_t type, + gras_datadesc_type_cb_void_t post); /** \brief Add a pre-send callback to the given field of the datadesc */ -XBT_PUBLIC(void) gras_datadesc_cb_field_send (gras_datadesc_type_t type, - const char *field_name, - gras_datadesc_type_cb_void_t pre); +XBT_PUBLIC(void) gras_datadesc_cb_field_send(gras_datadesc_type_t type, + const char *field_name, + gras_datadesc_type_cb_void_t + pre); /** \brief Add a post-receive callback to the given field of the datadesc */ -XBT_PUBLIC(void) gras_datadesc_cb_field_recv(gras_datadesc_type_t type, - const char *field_name, - gras_datadesc_type_cb_void_t post); +XBT_PUBLIC(void) gras_datadesc_cb_field_recv(gras_datadesc_type_t type, + const char *field_name, + gras_datadesc_type_cb_void_t + post); /** \brief Add a pre-send callback to the given field resulting in its value to be pushed */ -XBT_PUBLIC(void) gras_datadesc_cb_field_push (gras_datadesc_type_t type, - const char *field_name); +XBT_PUBLIC(void) gras_datadesc_cb_field_push(gras_datadesc_type_t type, + const char *field_name); /** \brief Add a pre-send callback to the given field resulting in its value multiplied to any previously pushed value and then pushed back */ -XBT_PUBLIC(void) gras_datadesc_cb_field_push_multiplier (gras_datadesc_type_t type, - const char *field_name); +XBT_PUBLIC(void) +gras_datadesc_cb_field_push_multiplier(gras_datadesc_type_t type, + const char + *field_name); /****************************** * Get stuff within datadescs * @@ -432,22 +476,36 @@ gras_datadesc_struct_close(my_type); */ /* @{ */ -XBT_PUBLIC(void) -gras_cbps_i_push(gras_cbps_t ps, int val); -XBT_PUBLIC(int) -gras_cbps_i_pop(gras_cbps_t ps); - -XBT_PUBLIC(int) gras_datadesc_cb_pop(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); - -XBT_PUBLIC(void) gras_datadesc_cb_push_int(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); -XBT_PUBLIC(void) gras_datadesc_cb_push_uint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); -XBT_PUBLIC(void) gras_datadesc_cb_push_lint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); -XBT_PUBLIC(void) gras_datadesc_cb_push_ulint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); - -XBT_PUBLIC(void) gras_datadesc_cb_push_int_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); -XBT_PUBLIC(void) gras_datadesc_cb_push_uint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); -XBT_PUBLIC(void) gras_datadesc_cb_push_lint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); -XBT_PUBLIC(void) gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data); +XBT_PUBLIC(void) gras_cbps_i_push(gras_cbps_t ps, int val); +XBT_PUBLIC(int) gras_cbps_i_pop(gras_cbps_t ps); + +XBT_PUBLIC(int) gras_datadesc_cb_pop(gras_datadesc_type_t typedesc, + gras_cbps_t vars, void *data); + +XBT_PUBLIC(void) gras_datadesc_cb_push_int(gras_datadesc_type_t typedesc, + gras_cbps_t vars, void *data); +XBT_PUBLIC(void) gras_datadesc_cb_push_uint(gras_datadesc_type_t typedesc, + gras_cbps_t vars, void *data); +XBT_PUBLIC(void) gras_datadesc_cb_push_lint(gras_datadesc_type_t typedesc, + gras_cbps_t vars, void *data); +XBT_PUBLIC(void) gras_datadesc_cb_push_ulint(gras_datadesc_type_t typedesc, + gras_cbps_t vars, void *data); + +XBT_PUBLIC(void) gras_datadesc_cb_push_int_mult(gras_datadesc_type_t + typedesc, gras_cbps_t vars, + void *data); +XBT_PUBLIC(void) gras_datadesc_cb_push_uint_mult(gras_datadesc_type_t + typedesc, + gras_cbps_t vars, + void *data); +XBT_PUBLIC(void) gras_datadesc_cb_push_lint_mult(gras_datadesc_type_t + typedesc, + gras_cbps_t vars, + void *data); +XBT_PUBLIC(void) gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t + typedesc, + gras_cbps_t vars, + void *data); /* @} */ @@ -466,22 +524,18 @@ XBT_PUBLIC(void) gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t typedesc, /* @{ */ -XBT_PUBLIC(void) gras_cbps_v_pop (gras_cbps_t ps, - const char *name, - /* OUT */ gras_datadesc_type_t *ddt, - /* OUT */ void **res); -XBT_PUBLIC(void) gras_cbps_v_push(gras_cbps_t ps, - const char *name, - void *data, - gras_datadesc_type_t ddt); -XBT_PUBLIC(void) gras_cbps_v_set (gras_cbps_t ps, - const char *name, - void *data, - gras_datadesc_type_t ddt); - -XBT_PUBLIC(void*) gras_cbps_v_get (gras_cbps_t ps, - const char *name, - /* OUT */ gras_datadesc_type_t *ddt); +XBT_PUBLIC(void) gras_cbps_v_pop(gras_cbps_t ps, const char *name, + /* OUT */ gras_datadesc_type_t * ddt, + /* OUT */ void **res); +XBT_PUBLIC(void) gras_cbps_v_push(gras_cbps_t ps, + const char *name, + void *data, gras_datadesc_type_t ddt); +XBT_PUBLIC(void) gras_cbps_v_set(gras_cbps_t ps, + const char *name, + void *data, gras_datadesc_type_t ddt); + +XBT_PUBLIC(void *) gras_cbps_v_get(gras_cbps_t ps, const char *name, + /* OUT */ gras_datadesc_type_t * ddt); XBT_PUBLIC(void) gras_cbps_block_begin(gras_cbps_t ps); XBT_PUBLIC(void) gras_cbps_block_end(gras_cbps_t ps); @@ -504,9 +558,9 @@ XBT_PUBLIC(int) gras_arch_selfid(void); /* ID of this arch */ * Basic types we can embeed in DataDescriptors. */ typedef enum - {CHAR_TYPE, DOUBLE_TYPE, FLOAT_TYPE, INT_TYPE, LONG_TYPE, SHORT_TYPE, - UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE, STRUCT_TYPE} - DataTypes; + { CHAR_TYPE, DOUBLE_TYPE, FLOAT_TYPE, INT_TYPE, LONG_TYPE, SHORT_TYPE, + UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE, STRUCT_TYPE +} DataTypes; #define SIMPLE_TYPE_COUNT 9 /** \brief Describe a collection of data. @@ -525,7 +579,7 @@ typedef struct DataDescriptorStruct { DataTypes type; size_t repetitions; size_t offset; - /*@null@*/ struct DataDescriptorStruct *members; + /*@null@ */ struct DataDescriptorStruct *members; size_t length; size_t tailPadding; } DataDescriptor; @@ -541,11 +595,10 @@ typedef struct DataDescriptorStruct { sizeof(memberType) * repetitions XBT_PUBLIC(gras_datadesc_type_t) -gras_datadesc_import_nws(const char *name, - const DataDescriptor *desc, - unsigned long howmany); + gras_datadesc_import_nws(const char *name, + const DataDescriptor * desc, + unsigned long howmany); SG_END_DECL() - -#endif /* GRAS_DATADESC_H */ +#endif /* GRAS_DATADESC_H */