3 /* ddt_exchange - send/recv data described */
5 /* Authors: Olivier Aumage, Martin Quinson */
6 /* Copyright (C) 2003, 2004 the GRAS posse. */
8 /* This program is free software; you can redistribute it and/or modify it
9 under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "DataDesc/datadesc_private.h"
13 GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(exchange,DataDesc);
15 const char *gras_datadesc_cat_names[9] = {
17 "scalar", "struct", "union", "ref", "array", "ignored",
20 static gras_datadesc_type_t *int_type = NULL;
21 static gras_datadesc_type_t *pointer_type = NULL;
22 static gras_error_t gras_dd_send_int(gras_socket_t *sock, int i);
23 static gras_error_t gras_dd_recv_int(gras_socket_t *sock, int r_arch, int *i);
26 gras_dd_alloc_ref(gras_dict_t *refs, long int size,
27 char **r_ref, long int r_len,
30 gras_dd_is_r_null(char **r_ptr, long int length);
33 gras_datadesc_send_rec(gras_socket_t *sock,
34 gras_dd_cbps_t *state,
36 gras_datadesc_type_t *type,
39 gras_datadesc_recv_rec(gras_socket_t *sock,
40 gras_dd_cbps_t *state,
42 gras_datadesc_type_t *type,
50 gras_dd_send_int(gras_socket_t *sock,int i) {
53 int_type = gras_datadesc_by_name("int");
54 gras_assert(int_type);
57 DEBUG1("send_int(%d)",i);
58 return gras_trp_chunk_send(sock, (char*)&i, int_type->size[GRAS_THISARCH]);
62 gras_dd_recv_int(gras_socket_t *sock, int r_arch, int *i) {
66 int_type = gras_datadesc_by_name("int");
67 gras_assert(int_type);
70 if (int_type->size[GRAS_THISARCH] >= int_type->size[r_arch]) {
71 TRY(gras_trp_chunk_recv(sock, (char*)i, int_type->size[r_arch]));
72 TRY(gras_dd_convert_elm(int_type,r_arch, i,i));
75 ptr = malloc((size_t)int_type->size[r_arch]);
76 TRY(gras_trp_chunk_recv(sock, (char*)ptr, int_type->size[r_arch]));
77 TRY(gras_dd_convert_elm(int_type,r_arch, ptr,i));
80 DEBUG1("recv_int(%d)",*i);
86 * Note: here we suppose that the remote NULL is a sequence
87 * of 'length' bytes set to 0.
88 * FIXME: Check in configure?
91 gras_dd_is_r_null(char **r_ptr, long int length) {
94 for (i=0; i<length; i++) {
95 if ( ((unsigned char*)r_ptr) [i]) {
104 gras_dd_alloc_ref(gras_dict_t *refs,
107 long int r_len, /* pointer_type->size[r_arch] */
110 gras_error_t errcode;
112 gras_assert1(size>0,"Cannot allocate %d bytes!", size);
113 if (! (l_data = malloc((size_t)size)) )
117 DEBUG2("l_data=%p, &l_data=%p",l_data,&l_data);
119 DEBUG3("alloc_ref: r_ref=%p; *r_ref=%p, r_len=%d",
120 r_ref, r_ref?*r_ref:NULL, r_len);
121 if (r_ref && !gras_dd_is_r_null( r_ref, r_len)) {
122 void *ptr = malloc(sizeof(void *));
126 memcpy(ptr,l_ref, sizeof(void *));
128 DEBUG2("Insert %p under %p",*(void**)ptr, *(void**)r_ref);
130 TRY(gras_dict_set_ext(refs,(const char *) r_ref, r_len, ptr, free));
136 * gras_datadesc_type_cmp:
138 * Compares two datadesc types with the same semantic than strcmp.
140 * This comparison does not take the set headers into account (name and ID),
141 * but only the payload (actual type description).
143 int gras_datadesc_type_cmp(const gras_datadesc_type_t *d1,
144 const gras_datadesc_type_t *d2) {
146 gras_dd_cat_field_t *field1,*field2;
147 gras_datadesc_type_t *field_desc_1,*field_desc_2;
149 if (d1 == d2) return 0; /* easy optimization */
152 DEBUG0("ddt_cmp: !d1 && d2 => 1");
156 DEBUG0("ddt_cmp: !d1 && !d2 => 0");
160 DEBUG0("ddt_cmp: d1 && !d2 => -1");
164 for (cpt=0; cpt<gras_arch_count; cpt++) {
165 if (d1->size[cpt] != d2->size[cpt]) {
166 DEBUG5("ddt_cmp: %s->size=%d != %s->size=%d (on %s)",
167 d1->name,d1->size[cpt],d2->name,d2->size[cpt],
168 gras_arches[cpt].name);
169 return d1->size[cpt] > d2->size[cpt] ? 1 : -1;
172 if (d1->alignment[cpt] != d2->alignment[cpt]) {
173 DEBUG5("ddt_cmp: %s->alignment=%d != %s->alignment=%d (on %s)",
174 d1->name,d1->alignment[cpt],d2->name,d2->alignment[cpt],
175 gras_arches[cpt].name);
176 return d1->alignment[cpt] > d2->alignment[cpt] ? 1 : -1;
179 if (d1->aligned_size[cpt] != d2->aligned_size[cpt]) {
180 DEBUG5("ddt_cmp: %s->aligned_size=%d != %s->aligned_size=%d (on %s)",
181 d1->name,d1->aligned_size[cpt],d2->name,d2->aligned_size[cpt],
182 gras_arches[cpt].name);
183 return d1->aligned_size[cpt] > d2->aligned_size[cpt] ? 1 : -1;
187 if (d1->category_code != d2->category_code) {
188 DEBUG4("ddt_cmp: %s->cat=%s != %s->cat=%s",
189 d1->name,gras_datadesc_cat_names[d1->category_code],
190 d2->name,gras_datadesc_cat_names[d2->category_code]);
191 return d1->category_code > d2->category_code ? 1 : -1;
194 if (d1->pre != d2->pre) {
195 DEBUG4("ddt_cmp: %s->pre=%p != %s->pre=%p",
196 d1->name,d1->pre, d2->name,d2->pre);
197 return d1->pre > d2->pre ? 1 : -1;
200 if (d1->post != d2->post) {
201 DEBUG4("ddt_cmp: %s->post=%p != %s->post=%p",
202 d1->name,d1->post, d2->name,d2->post);
203 return d1->post > d2->post ? 1 : -1;
206 switch (d1->category_code) {
207 case e_gras_datadesc_type_cat_scalar:
208 if (d1->category.scalar_data.encoding != d2->category.scalar_data.encoding)
209 return d1->category.scalar_data.encoding > d2->category.scalar_data.encoding ? 1 : -1 ;
212 case e_gras_datadesc_type_cat_struct:
213 if (gras_dynar_length(d1->category.struct_data.fields) !=
214 gras_dynar_length(d2->category.struct_data.fields)) {
215 DEBUG4("ddt_cmp: %s (having %d fields) != %s (having %d fields)",
216 d1->name, gras_dynar_length(d1->category.struct_data.fields),
217 d2->name, gras_dynar_length(d2->category.struct_data.fields));
219 return gras_dynar_length(d1->category.struct_data.fields) >
220 gras_dynar_length(d2->category.struct_data.fields) ?
223 gras_dynar_foreach(d1->category.struct_data.fields, cpt, field1) {
225 gras_dynar_get(d2->category.struct_data.fields, cpt, &field2);
226 gras_datadesc_by_id(field1->code,&field_desc_1); /* FIXME: errcode ignored */
227 gras_datadesc_by_id(field2->code,&field_desc_2);
228 ret = gras_datadesc_type_cmp(field_desc_1,field_desc_2);
230 DEBUG6("%s->field[%d]=%s != %s->field[%d]=%s",
231 d1->name,cpt,field1->name,
232 d2->name,cpt,field2->name);
239 case e_gras_datadesc_type_cat_union:
240 if (d1->category.union_data.selector != d2->category.union_data.selector)
241 return d1->category.union_data.selector > d2->category.union_data.selector ? 1 : -1;
243 if (gras_dynar_length(d1->category.union_data.fields) !=
244 gras_dynar_length(d2->category.union_data.fields))
245 return gras_dynar_length(d1->category.union_data.fields) >
246 gras_dynar_length(d2->category.union_data.fields) ?
249 gras_dynar_foreach(d1->category.union_data.fields, cpt, field1) {
251 gras_dynar_get(d2->category.union_data.fields, cpt, field2);
252 gras_datadesc_by_id(field1->code,&field_desc_1); /* FIXME: errcode ignored */
253 gras_datadesc_by_id(field2->code,&field_desc_2);
254 ret = gras_datadesc_type_cmp(field_desc_1,field_desc_2);
262 case e_gras_datadesc_type_cat_ref:
263 if (d1->category.ref_data.selector != d2->category.ref_data.selector)
264 return d1->category.ref_data.selector > d2->category.ref_data.selector ? 1 : -1;
266 if (d1->category.ref_data.code != d2->category.ref_data.code)
267 return d1->category.ref_data.code > d2->category.ref_data.code ? 1 : -1;
270 case e_gras_datadesc_type_cat_array:
271 if (d1->category.array_data.code != d2->category.array_data.code)
272 return d1->category.array_data.code > d2->category.array_data.code ? 1 : -1;
274 if (d1->category.array_data.fixed_size != d2->category.array_data.fixed_size)
275 return d1->category.array_data.fixed_size > d2->category.array_data.fixed_size ? 1 : -1;
277 if (d1->category.array_data.dynamic_size != d2->category.array_data.dynamic_size)
278 return d1->category.array_data.dynamic_size > d2->category.array_data.dynamic_size ? 1 : -1;
282 case e_gras_datadesc_type_cat_ignored:
283 /* That's ignored... */
285 /* two stupidly created ddt are equally stupid ;) */
295 * Copy the data pointed by src and described by type
296 * to a new location, and store a pointer to it in dst.
299 gras_error_t gras_datadesc_cpy(gras_datadesc_type_t *type,
306 gras_datadesc_send_rec(gras_socket_t *sock,
307 gras_dd_cbps_t *state,
309 gras_datadesc_type_t *type,
312 gras_error_t errcode;
314 gras_datadesc_type_t *sub_type; /* type on which we recurse */
316 VERB2("Send a %s (%s)",
317 type->name, gras_datadesc_cat_names[type->category_code]);
320 type->pre(state,type,data);
323 switch (type->category_code) {
324 case e_gras_datadesc_type_cat_scalar:
325 TRY(gras_trp_chunk_send(sock, data, type->size[GRAS_THISARCH]));
328 case e_gras_datadesc_type_cat_struct: {
329 gras_dd_cat_struct_t struct_data;
330 gras_dd_cat_field_t *field;
333 struct_data = type->category.struct_data;
334 VERB1(">> Send all fields of the structure %s",type->name);
335 gras_dynar_foreach(struct_data.fields, cpt, field) {
337 field_data += field->offset[GRAS_THISARCH];
339 TRY(gras_datadesc_by_id(field->code, &sub_type));
342 field->pre(state,sub_type,field_data);
344 TRY(gras_datadesc_send_rec(sock,state,refs,sub_type, field_data));
347 field->post(state,sub_type,field_data);
349 VERB1("<< Sent all fields of the structure %s", type->name);
354 case e_gras_datadesc_type_cat_union: {
355 gras_dd_cat_union_t union_data;
356 gras_dd_cat_field_t *field;
359 union_data = type->category.union_data;
361 /* retrieve the field number */
362 field_num = union_data.selector(state, type, data);
364 gras_assert1(field_num > 0,
365 "union field selector of %s gave a negative value",
368 gras_assert3(field_num < gras_dynar_length(union_data.fields),
369 "union field selector of %s returned %d but there is only %d fields",
370 type->name, field_num, gras_dynar_length(union_data.fields));
372 /* Send the field number */
373 TRY(gras_dd_send_int(sock, field_num));
375 /* Send the content */
376 gras_dynar_get(union_data.fields, field_num, field);
377 TRY(gras_datadesc_by_id(field->code, &sub_type));
380 field->pre(state,sub_type,data);
382 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, data));
385 field->post(state,sub_type,data);
390 case e_gras_datadesc_type_cat_ref: {
391 gras_dd_cat_ref_t ref_data;
394 void **ref=(void**)data;
397 ref_data = type->category.ref_data;
399 /* Detect the referenced type and send it to peer if needed */
400 ref_code = ref_data.code;
402 ref_code = ref_data.selector(state,type,data);
403 TRY(gras_dd_send_int(sock, ref_code));
406 /* Send the actual value of the pointer for cycle handling */
408 pointer_type = gras_datadesc_by_name("data pointer");
409 gras_assert(pointer_type);
412 TRY(gras_trp_chunk_send(sock, (char*)data,
413 pointer_type->size[GRAS_THISARCH]));
415 /* Send the pointed data only if not already sent */
416 if (*(void**)data == NULL) {
417 VERB0("Not sending NULL referenced data");
420 errcode = gras_dict_get_ext(refs,(char*)ref, sizeof(void*), &dummy);
421 if (errcode == mismatch_error) {
422 VERB1("Sending data referenced at %p", *ref);
423 TRY(gras_dict_set_ext(refs, (char*)ref, sizeof(void*), ref, NULL));
424 TRY(gras_datadesc_by_id(ref_code, &sub_type));
425 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, *ref));
427 } else if (errcode == no_error) {
428 VERB1("Not sending data referenced at %p (already done)", *ref);
436 case e_gras_datadesc_type_cat_array: {
437 gras_dd_cat_array_t array_data;
442 array_data = type->category.array_data;
444 /* determine and send the element count */
445 count = array_data.fixed_size;
447 count = array_data.dynamic_size(state,type,data);
448 gras_assert1(count >=0,
449 "Invalid (negative) array size for type %s",type->name);
450 TRY(gras_dd_send_int(sock, count));
453 /* send the content */
454 TRY(gras_datadesc_by_id(array_data.code, &sub_type));
455 elm_size = sub_type->aligned_size[GRAS_THISARCH];
456 for (cpt=0; cpt<count; cpt++) {
457 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, ptr));
464 gras_assert0(0, "Invalid type");
468 type->post(state,type,data);
475 * gras_datadesc_send:
477 * Copy the data pointed by src and described by type to the socket
480 gras_error_t gras_datadesc_send(gras_socket_t *sock,
481 gras_datadesc_type_t *type,
484 gras_error_t errcode;
485 gras_dd_cbps_t *state = NULL;
486 gras_dict_t *refs; /* all references already sent */
488 TRY(gras_dict_new(&refs));
489 TRY(gras_dd_cbps_new(&state));
491 errcode = gras_datadesc_send_rec(sock,state,refs,type,(char*)src);
493 gras_dict_free(&refs);
494 gras_dd_cbps_free(&state);
500 * gras_datadesc_recv_rec:
502 * Do the data reception job recursively.
505 gras_datadesc_recv_rec(gras_socket_t *sock,
506 gras_dd_cbps_t *state,
508 gras_datadesc_type_t *type,
514 gras_error_t errcode;
516 gras_datadesc_type_t *sub_type;
518 VERB2("Recv a %s @%p", type->name, l_data);
521 switch (type->category_code) {
522 case e_gras_datadesc_type_cat_scalar:
523 if (type->size[GRAS_THISARCH] >= type->size[r_arch]) {
524 TRY(gras_trp_chunk_recv(sock, (char*)l_data, type->size[r_arch]));
525 TRY(gras_dd_convert_elm(type,r_arch, l_data,l_data));
528 ptr = malloc((size_t)type->size[r_arch]);
529 TRY(gras_trp_chunk_recv(sock, (char*)ptr, type->size[r_arch]));
530 TRY(gras_dd_convert_elm(type,r_arch, ptr,l_data));
535 case e_gras_datadesc_type_cat_struct: {
536 gras_dd_cat_struct_t struct_data;
537 gras_dd_cat_field_t *field;
539 struct_data = type->category.struct_data;
541 VERB1(">> Receive all fields of the structure %s",type->name);
542 gras_dynar_foreach(struct_data.fields, cpt, field) {
543 char *field_data = l_data + field->offset[GRAS_THISARCH];
545 TRY(gras_datadesc_by_id(field->code, &sub_type));
547 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
551 VERB1("<< Received all fields of the structure %s", type->name);
556 case e_gras_datadesc_type_cat_union: {
557 gras_dd_cat_union_t union_data;
558 gras_dd_cat_field_t *field;
561 union_data = type->category.union_data;
563 /* retrieve the field number */
564 TRY(gras_dd_recv_int(sock, r_arch, &field_num));
566 RAISE1(mismatch_error,
567 "Received union field for %s is negative", type->name);
568 if (field_num < gras_dynar_length(union_data.fields))
569 RAISE3(mismatch_error,
570 "Received union field for %s is %d but there is only %d fields",
571 type->name, field_num, gras_dynar_length(union_data.fields));
573 /* Recv the content */
574 gras_dynar_get(union_data.fields, field_num, field);
575 TRY(gras_datadesc_by_id(field->code, &sub_type));
577 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
583 case e_gras_datadesc_type_cat_ref: {
586 gras_dd_cat_ref_t ref_data;
589 ref_data = type->category.ref_data;
591 /* Get the referenced type locally or from peer */
592 ref_code = ref_data.code;
594 TRY(gras_dd_recv_int(sock, r_arch, &ref_code));
596 /* Get the actual value of the pointer for cycle handling */
598 pointer_type = gras_datadesc_by_name("data pointer");
599 gras_assert(pointer_type);
602 if (! (r_ref = malloc((size_t)pointer_type->size[r_arch])) )
604 TRY(gras_trp_chunk_recv(sock, (char*)r_ref,
605 pointer_type->size[r_arch]));
607 /* Receive the pointed data only if not already sent */
608 if (gras_dd_is_r_null(r_ref, pointer_type->size[r_arch])) {
609 VERB1("Not receiving data remotely referenced @%p since it's NULL",
611 *(void**)l_data = NULL;
615 errcode = gras_dict_get_ext(refs,
616 (char*)r_ref, pointer_type->size[r_arch],
620 if (errcode == mismatch_error) {
621 void *l_referenced=NULL;
623 TRY(gras_datadesc_by_id(ref_code, &sub_type));
625 VERB1("Receiving '%s' ",sub_type->name);
626 TRY(gras_dd_alloc_ref(refs,sub_type->size[GRAS_THISARCH],
627 r_ref,pointer_type->size[r_arch], (char**)&l_referenced));
629 VERB2("Receiving '%s' remotely referenced at %p",
630 sub_type->name, *(void**)r_ref);
632 // DEBUG2("l_ref= %p; &l_ref=%p",l_referenced,&l_referenced);
633 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
634 r_arch,r_ref,pointer_type->size[r_arch],
635 (char*)l_referenced));
636 *(void**)l_data=l_referenced;
637 VERB3("'%s' remotely referenced at %p locally at %p",
638 sub_type->name, *(void**)r_ref, l_referenced);
640 } else if (errcode == no_error) {
641 VERB2("NOT receiving data remotely referenced @%p (already done, locally @%p). ",
642 *(void**)r_ref, *(void**)l_ref);
644 *(void**)l_data=*l_ref;
653 case e_gras_datadesc_type_cat_array: {
654 gras_dd_cat_array_t array_data;
659 array_data = type->category.array_data;
660 /* determine element count locally or from peer */
661 count = array_data.fixed_size;
663 TRY(gras_dd_recv_int(sock, r_arch, &count));
665 RAISE1(mismatch_error,
666 "Invalid (negative) array size for type %s",type->name);
668 /* receive the content */
669 TRY(gras_datadesc_by_id(array_data.code, &sub_type));
670 elm_size = sub_type->aligned_size[GRAS_THISARCH];
671 VERB2("Receive a %d-long array of %s",count, sub_type->name);
674 TRY(gras_dd_alloc_ref(refs,elm_size*count,r_data,r_lgr, &l_data));
678 for (cpt=0; cpt<count; cpt++) {
679 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
680 r_arch, NULL, 0, ptr));
687 gras_assert0(0, "Invalid type");
694 * gras_datadesc_recv:
696 * Get an instance of the datatype described by @type from the @socket,
697 * and store a pointer to it in @dst
701 gras_datadesc_recv(gras_socket_t *sock,
702 gras_datadesc_type_t *type,
706 gras_error_t errcode;
707 gras_dd_cbps_t *state = NULL; /* callback persistent state */
708 gras_dict_t *refs; /* all references already sent */
710 TRY(gras_dict_new(&refs));
711 TRY(gras_dd_cbps_new(&state));
713 // VERB0("'dst' not NULL in datadesc_recv. Data to be copied there without malloc");
715 errcode = gras_datadesc_recv_rec(sock, state, refs, type,
719 gras_dict_free(&refs);
720 gras_dd_cbps_free(&state);