X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d27fee3e154a5eecf4cd708a23b0b656cbea6ec1..c60ecd167e796895eb98398295e320688ffe701b:/include/gras/datadesc.h
diff --git a/include/gras/datadesc.h b/include/gras/datadesc.h
index 1e49d2a3e8..f19da0a69b 100644
--- a/include/gras/datadesc.h
+++ b/include/gras/datadesc.h
@@ -46,7 +46,7 @@ SG_BEGIN_DECL()
* - char (both signed and unsigned)
* - int (short, regular, long and long long, both signed and unsigned)
* - float and double
- * - string (which is indeed a reference to a dynamically sized array of char, strlen being used to retrive the size)
+ * - string (which is indeed a reference to a dynamically sized array of char, strlen being used to retrieve the size)
*
* Example:\verbatim gras_datadesc_type_t i = gras_datadesc_by_name("int");
gras_datadesc_type_t uc = gras_datadesc_by_name("unsigned char");
@@ -59,7 +59,8 @@ SG_BEGIN_DECL()
typedef struct s_gras_datadesc_type *gras_datadesc_type_t;
/** \brief Search a type description from its name */
-gras_datadesc_type_t gras_datadesc_by_name(const char *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);
/* @} */
@@ -93,6 +94,7 @@ gras_datadesc_type_t gras_datadesc_by_name(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);
@@ -101,21 +103,48 @@ gras_datadesc_type_t gras_datadesc_by_name(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;
- int b;\endverbatim
+int b;\endverbatim
*
- * Defining multidimentional arrays
+ * \section gras_dd_define \#define and fixed size array
+ *
+ * If you want to exchange arrays which size is given at compilation time by a
+ * \#defined constant, you need to keep GRAS informed. It would be done the
+ * following way:
+
+\verbatim #define BLOCK_SIZE 32
+GRAS_DEFINE_TYPE(s_toto,
+struct {
+ double data[BLOCK_SIZE];
+} s_toto;)
+
+void register_messages() {
+ gras_datadesc_type_t toto_type;
+
+ gras_datadesc_set_const("BLOCK_SIZE",BLOCK_SIZE);
+ toto_type = gras_datadesc_by_symbol(s_toto);
+}\endverbatim
+ *
+ * The form gras_datadesc_set_const("BLOCK_SIZE",BLOCK_SIZE); ensures
+ * that when you change the definition of the constant, GRAS keeps informed of
+ * the right value. Passing the numerical value of the constant as second
+ * argument would be a bad idea to that regard. Of course, the call to
+ * gras_datadesc_set_const() should come before any gras_datadesc_by_symbol()
+ * containing references to it.
+ *
+ * \section GRAS_dd_multidim Defining multidimentional arrays
*
* The mecanism for multidimensional arrays is known to be fragile and cumbersome. If you want to use it,
* you have to understand how it is implemented: the multiplication is performed using the sizes stack. In previous example,
* a \ref gras_datadesc_cb_push_int callback is added to the \a rows field and a \ref gras_datadesc_cb_push_int_mult one is
* added to \a cols. So, when the structure is sent, the \a rows field push its value onto the stack, then the \a cols field
- * retrieve this value from the stack, compute (and push) the multiplication value. The \a matrix field can then retrive this
+ * retrieve this value from the stack, compute (and push) the multiplication value. The \a matrix field can then retrieve this
* value by poping the array. There is several ways for this to go wrong:
* - if the matrix field is placed before the sizes, the right value won't get pushed into the stack soon enough.
* Reorder your structure fields if needed.
@@ -128,7 +157,7 @@ gras_datadesc_type_t gras_datadesc_by_name(const char *name);
* If you cannot express your datadescs with this mechanism, you'll have to use the more advanced
* (and somehow complex) one described in the \ref GRAS_dd_cb_full.
*
- * Projects spanning over multiple files
+ * \section GRAS_dd_multifile Projects spanning over multiple files
*
* GRAS_DEFINE_TYPE declares some symbols to work, it needs some special
* care when used in several files. In such case, you want the regular type
@@ -152,11 +181,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"
@@ -166,15 +196,26 @@ 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.
*
*/
/** @{ */
@@ -198,15 +239,25 @@ 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
*/
#define gras_datadesc_by_symbol(name) \
- (gras_datadesc_by_name(#name) ? \
- gras_datadesc_by_name(#name) : \
+ (gras_datadesc_by_name_or_null(#name) ? \
+ gras_datadesc_by_name_or_null(#name) : \
gras_datadesc_parse(#name, \
_gras_this_type_symbol_does_not_exist__##name) \
)
@@ -215,10 +266,14 @@ 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);
/* @} */
-gras_datadesc_type_t
+XBT_PUBLIC(gras_datadesc_type_t)
gras_datadesc_parse(const char *name, const char *C_statement);
/** @defgroup GRAS_dd_manual Simple manual data description
@@ -275,79 +330,85 @@ typedef gras_datadesc_type_t (*gras_datadesc_selector_t)(gras_datadesc_type_t ty
**** Declare datadescription yourself ****
******************************************/
-gras_datadesc_type_t gras_datadesc_struct(const char *name);
-void gras_datadesc_struct_append(gras_datadesc_type_t struct_type,
+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);
-void gras_datadesc_struct_close(gras_datadesc_type_t struct_type);
+XBT_PUBLIC(void) gras_datadesc_struct_close(gras_datadesc_type_t struct_type);
-gras_datadesc_type_t gras_datadesc_union(const char *name,
+XBT_PUBLIC(gras_datadesc_type_t) gras_datadesc_union(const char *name,
gras_datadesc_type_cb_int_t selector);
-void gras_datadesc_union_append(gras_datadesc_type_t union_type,
+XBT_PUBLIC(void) gras_datadesc_union_append(gras_datadesc_type_t union_type,
const char *name,
gras_datadesc_type_t field_type);
-void gras_datadesc_union_close(gras_datadesc_type_t union_type);
+XBT_PUBLIC(void) gras_datadesc_union_close(gras_datadesc_type_t union_type);
-gras_datadesc_type_t
+XBT_PUBLIC(gras_datadesc_type_t)
gras_datadesc_ref(const char *name,
gras_datadesc_type_t referenced_type);
-gras_datadesc_type_t
+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);
-gras_datadesc_type_t
+XBT_PUBLIC(gras_datadesc_type_t)
gras_datadesc_array_fixed(const char *name,
gras_datadesc_type_t element_type,
long int fixed_size);
-gras_datadesc_type_t
+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);
-gras_datadesc_type_t
+XBT_PUBLIC(gras_datadesc_type_t)
gras_datadesc_ref_pop_arr(gras_datadesc_type_t element_type);
-gras_datadesc_type_t
+XBT_PUBLIC(gras_datadesc_type_t)
gras_datadesc_dynar(gras_datadesc_type_t elm_t,
- void_f_pvoid_t *free_func);
+ 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 *
*********************************/
/** \brief Specify that this type may contain cycles */
-void gras_datadesc_cycle_set(gras_datadesc_type_t type);
+XBT_PUBLIC(void) gras_datadesc_cycle_set(gras_datadesc_type_t type);
/** \brief Specify that this type do not contain any cycles (default) */
-void gras_datadesc_cycle_unset(gras_datadesc_type_t type);
+XBT_PUBLIC(void) gras_datadesc_cycle_unset(gras_datadesc_type_t type);
/** \brief Add a pre-send callback to this datadesc. */
-void gras_datadesc_cb_send (gras_datadesc_type_t type,
+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.*/
-void gras_datadesc_cb_recv(gras_datadesc_type_t type,
+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 */
-void gras_datadesc_cb_field_send (gras_datadesc_type_t type,
+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 */
-void gras_datadesc_cb_field_recv(gras_datadesc_type_t type,
+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 */
-void gras_datadesc_cb_field_push (gras_datadesc_type_t type,
+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 */
-void gras_datadesc_cb_field_push_multiplier (gras_datadesc_type_t type,
+XBT_PUBLIC(void) gras_datadesc_cb_field_push_multiplier (gras_datadesc_type_t type,
const char *field_name);
/******************************
* Get stuff within datadescs *
******************************/
/** \brief Returns the name of a datadescription */
-const char * gras_datadesc_get_name(gras_datadesc_type_t ddt);
+XBT_PUBLIC(const char *) gras_datadesc_get_name(gras_datadesc_type_t ddt);
/** \brief Returns the identifier of a datadescription */
-int gras_datadesc_get_id(gras_datadesc_type_t ddt);
+XBT_PUBLIC(int) gras_datadesc_get_id(gras_datadesc_type_t ddt);
/* @} */
@@ -398,22 +459,22 @@ gras_datadesc_struct_close(my_type);
*/
/* @{ */
-void
+XBT_PUBLIC(void)
gras_cbps_i_push(gras_cbps_t ps, int val);
-int
+XBT_PUBLIC(int)
gras_cbps_i_pop(gras_cbps_t ps);
-int gras_datadesc_cb_pop(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
+XBT_PUBLIC(int) gras_datadesc_cb_pop(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
-void gras_datadesc_cb_push_int(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
-void gras_datadesc_cb_push_uint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
-void gras_datadesc_cb_push_lint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
-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(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);
-void gras_datadesc_cb_push_int_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
-void gras_datadesc_cb_push_uint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
-void gras_datadesc_cb_push_lint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
-void gras_datadesc_cb_push_ulint_mult(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);
/* @} */
@@ -432,25 +493,25 @@ void gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t typedesc, gras_cbps_t
/* @{ */
-void gras_cbps_v_pop (gras_cbps_t ps,
+XBT_PUBLIC(void) gras_cbps_v_pop (gras_cbps_t ps,
const char *name,
/* OUT */ gras_datadesc_type_t *ddt,
/* OUT */ void **res);
-void gras_cbps_v_push(gras_cbps_t ps,
+XBT_PUBLIC(void) gras_cbps_v_push(gras_cbps_t ps,
const char *name,
void *data,
gras_datadesc_type_t ddt);
-void gras_cbps_v_set (gras_cbps_t ps,
+XBT_PUBLIC(void) gras_cbps_v_set (gras_cbps_t ps,
const char *name,
void *data,
gras_datadesc_type_t ddt);
-void * gras_cbps_v_get (gras_cbps_t ps,
+XBT_PUBLIC(void*) gras_cbps_v_get (gras_cbps_t ps,
const char *name,
/* OUT */ gras_datadesc_type_t *ddt);
-void gras_cbps_block_begin(gras_cbps_t ps);
-void gras_cbps_block_end(gras_cbps_t ps);
+XBT_PUBLIC(void) gras_cbps_block_begin(gras_cbps_t ps);
+XBT_PUBLIC(void) gras_cbps_block_end(gras_cbps_t ps);
/* @} */
/* @} */
@@ -459,7 +520,7 @@ void gras_cbps_block_end(gras_cbps_t ps);
/*******************************
**** About data convertion ****
*******************************/
-int gras_arch_selfid(void); /* ID of this arch */
+XBT_PUBLIC(int) gras_arch_selfid(void); /* ID of this arch */
/*****************************
@@ -506,7 +567,7 @@ typedef struct DataDescriptorStruct {
sizeof(structType) - offsetof(structType, lastMember) - \
sizeof(memberType) * repetitions
-gras_datadesc_type_t
+XBT_PUBLIC(gras_datadesc_type_t)
gras_datadesc_import_nws(const char *name,
const DataDescriptor *desc,
unsigned long howmany);