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,
51 gras_dd_send_int(gras_socket_t *sock,int i) {
54 int_type = gras_datadesc_by_name("int");
55 gras_assert(int_type);
58 DEBUG1("send_int(%d)",i);
59 return gras_trp_chunk_send(sock, (char*)&i, int_type->size[GRAS_THISARCH]);
63 gras_dd_recv_int(gras_socket_t *sock, int r_arch, int *i) {
67 int_type = gras_datadesc_by_name("int");
68 gras_assert(int_type);
71 if (int_type->size[GRAS_THISARCH] >= int_type->size[r_arch]) {
72 TRY(gras_trp_chunk_recv(sock, (char*)i, int_type->size[r_arch]));
73 TRY(gras_dd_convert_elm(int_type,1,r_arch, i,i));
76 ptr = malloc((size_t)int_type->size[r_arch]);
77 TRY(gras_trp_chunk_recv(sock, (char*)ptr, int_type->size[r_arch]));
78 TRY(gras_dd_convert_elm(int_type,1,r_arch, ptr,i));
81 DEBUG1("recv_int(%d)",*i);
87 * Note: here we suppose that the remote NULL is a sequence
88 * of 'length' bytes set to 0.
89 * FIXME: Check in configure?
92 gras_dd_is_r_null(char **r_ptr, long int length) {
95 for (i=0; i<length; i++) {
96 if ( ((unsigned char*)r_ptr) [i]) {
105 gras_dd_alloc_ref(gras_dict_t *refs,
108 long int r_len, /* pointer_type->size[r_arch] */
111 gras_error_t errcode;
113 gras_assert1(size>0,"Cannot allocate %d bytes!", size);
114 if (! (l_data = malloc((size_t)size)) )
118 DEBUG2("l_data=%p, &l_data=%p",l_data,&l_data);
120 DEBUG3("alloc_ref: r_ref=%p; *r_ref=%p, r_len=%d",
121 r_ref, r_ref?*r_ref:NULL, r_len);
122 if (r_ref && !gras_dd_is_r_null( r_ref, r_len)) {
123 void *ptr = malloc(sizeof(void *));
127 memcpy(ptr,l_ref, sizeof(void *));
129 DEBUG2("Insert %p under %p",*(void**)ptr, *(void**)r_ref);
131 TRY(gras_dict_set_ext(refs,(const char *) r_ref, r_len, ptr, free));
137 * gras_datadesc_type_cmp:
139 * Compares two datadesc types with the same semantic than strcmp.
141 * This comparison does not take the set headers into account (name and ID),
142 * but only the payload (actual type description).
144 int gras_datadesc_type_cmp(const gras_datadesc_type_t *d1,
145 const gras_datadesc_type_t *d2) {
147 gras_dd_cat_field_t *field1,*field2;
148 gras_datadesc_type_t *field_desc_1,*field_desc_2;
150 if (d1 == d2) return 0; /* easy optimization */
153 DEBUG0("ddt_cmp: !d1 && d2 => 1");
157 DEBUG0("ddt_cmp: !d1 && !d2 => 0");
161 DEBUG0("ddt_cmp: d1 && !d2 => -1");
165 for (cpt=0; cpt<gras_arch_count; cpt++) {
166 if (d1->size[cpt] != d2->size[cpt]) {
167 DEBUG5("ddt_cmp: %s->size=%d != %s->size=%d (on %s)",
168 d1->name,d1->size[cpt],d2->name,d2->size[cpt],
169 gras_arches[cpt].name);
170 return d1->size[cpt] > d2->size[cpt] ? 1 : -1;
173 if (d1->alignment[cpt] != d2->alignment[cpt]) {
174 DEBUG5("ddt_cmp: %s->alignment=%d != %s->alignment=%d (on %s)",
175 d1->name,d1->alignment[cpt],d2->name,d2->alignment[cpt],
176 gras_arches[cpt].name);
177 return d1->alignment[cpt] > d2->alignment[cpt] ? 1 : -1;
180 if (d1->aligned_size[cpt] != d2->aligned_size[cpt]) {
181 DEBUG5("ddt_cmp: %s->aligned_size=%d != %s->aligned_size=%d (on %s)",
182 d1->name,d1->aligned_size[cpt],d2->name,d2->aligned_size[cpt],
183 gras_arches[cpt].name);
184 return d1->aligned_size[cpt] > d2->aligned_size[cpt] ? 1 : -1;
188 if (d1->category_code != d2->category_code) {
189 DEBUG4("ddt_cmp: %s->cat=%s != %s->cat=%s",
190 d1->name,gras_datadesc_cat_names[d1->category_code],
191 d2->name,gras_datadesc_cat_names[d2->category_code]);
192 return d1->category_code > d2->category_code ? 1 : -1;
195 if (d1->pre != d2->pre) {
196 DEBUG4("ddt_cmp: %s->pre=%p != %s->pre=%p",
197 d1->name,d1->pre, d2->name,d2->pre);
198 return d1->pre > d2->pre ? 1 : -1;
201 if (d1->post != d2->post) {
202 DEBUG4("ddt_cmp: %s->post=%p != %s->post=%p",
203 d1->name,d1->post, d2->name,d2->post);
204 return d1->post > d2->post ? 1 : -1;
207 switch (d1->category_code) {
208 case e_gras_datadesc_type_cat_scalar:
209 if (d1->category.scalar_data.encoding != d2->category.scalar_data.encoding)
210 return d1->category.scalar_data.encoding > d2->category.scalar_data.encoding ? 1 : -1 ;
213 case e_gras_datadesc_type_cat_struct:
214 if (gras_dynar_length(d1->category.struct_data.fields) !=
215 gras_dynar_length(d2->category.struct_data.fields)) {
216 DEBUG4("ddt_cmp: %s (having %d fields) != %s (having %d fields)",
217 d1->name, gras_dynar_length(d1->category.struct_data.fields),
218 d2->name, gras_dynar_length(d2->category.struct_data.fields));
220 return gras_dynar_length(d1->category.struct_data.fields) >
221 gras_dynar_length(d2->category.struct_data.fields) ?
224 gras_dynar_foreach(d1->category.struct_data.fields, cpt, field1) {
226 gras_dynar_get(d2->category.struct_data.fields, cpt, &field2);
227 gras_datadesc_by_id(field1->code,&field_desc_1); /* FIXME: errcode ignored */
228 gras_datadesc_by_id(field2->code,&field_desc_2);
229 ret = gras_datadesc_type_cmp(field_desc_1,field_desc_2);
231 DEBUG6("%s->field[%d]=%s != %s->field[%d]=%s",
232 d1->name,cpt,field1->name,
233 d2->name,cpt,field2->name);
240 case e_gras_datadesc_type_cat_union:
241 if (d1->category.union_data.selector != d2->category.union_data.selector)
242 return d1->category.union_data.selector > d2->category.union_data.selector ? 1 : -1;
244 if (gras_dynar_length(d1->category.union_data.fields) !=
245 gras_dynar_length(d2->category.union_data.fields))
246 return gras_dynar_length(d1->category.union_data.fields) >
247 gras_dynar_length(d2->category.union_data.fields) ?
250 gras_dynar_foreach(d1->category.union_data.fields, cpt, field1) {
252 gras_dynar_get(d2->category.union_data.fields, cpt, field2);
253 gras_datadesc_by_id(field1->code,&field_desc_1); /* FIXME: errcode ignored */
254 gras_datadesc_by_id(field2->code,&field_desc_2);
255 ret = gras_datadesc_type_cmp(field_desc_1,field_desc_2);
263 case e_gras_datadesc_type_cat_ref:
264 if (d1->category.ref_data.selector != d2->category.ref_data.selector)
265 return d1->category.ref_data.selector > d2->category.ref_data.selector ? 1 : -1;
267 if (d1->category.ref_data.code != d2->category.ref_data.code)
268 return d1->category.ref_data.code > d2->category.ref_data.code ? 1 : -1;
271 case e_gras_datadesc_type_cat_array:
272 if (d1->category.array_data.code != d2->category.array_data.code)
273 return d1->category.array_data.code > d2->category.array_data.code ? 1 : -1;
275 if (d1->category.array_data.fixed_size != d2->category.array_data.fixed_size)
276 return d1->category.array_data.fixed_size > d2->category.array_data.fixed_size ? 1 : -1;
278 if (d1->category.array_data.dynamic_size != d2->category.array_data.dynamic_size)
279 return d1->category.array_data.dynamic_size > d2->category.array_data.dynamic_size ? 1 : -1;
283 case e_gras_datadesc_type_cat_ignored:
284 /* That's ignored... */
286 /* two stupidly created ddt are equally stupid ;) */
296 * Copy the data pointed by src and described by type
297 * to a new location, and store a pointer to it in dst.
300 gras_error_t gras_datadesc_cpy(gras_datadesc_type_t *type,
307 gras_datadesc_send_rec(gras_socket_t *sock,
308 gras_dd_cbps_t *state,
310 gras_datadesc_type_t *type,
313 gras_error_t errcode;
315 gras_datadesc_type_t *sub_type; /* type on which we recurse */
317 VERB2("Send a %s (%s)",
318 type->name, gras_datadesc_cat_names[type->category_code]);
321 type->pre(state,type,data);
324 switch (type->category_code) {
325 case e_gras_datadesc_type_cat_scalar:
326 TRY(gras_trp_chunk_send(sock, data, type->size[GRAS_THISARCH]));
329 case e_gras_datadesc_type_cat_struct: {
330 gras_dd_cat_struct_t struct_data;
331 gras_dd_cat_field_t *field;
334 gras_assert1(type->category.struct_data.closed,
335 "Please call gras_datadesc_declare_array_close on %s before sending it",
337 struct_data = type->category.struct_data;
338 VERB1(">> Send all fields of the structure %s",type->name);
339 gras_dynar_foreach(struct_data.fields, cpt, field) {
341 field_data += field->offset[GRAS_THISARCH];
343 errcode=gras_datadesc_by_id(field->code, &sub_type);
344 if (errcode != no_error)
346 "Got %s while searching for the sub type %d, #%d of %s",
347 gras_error_name(errcode),field->code,cpt,type->name);
350 field->pre(state,sub_type,field_data);
352 VERB1("Send field %s",field->name);
353 TRY(gras_datadesc_send_rec(sock,state,refs,sub_type, field_data));
356 field->post(state,sub_type,field_data);
358 VERB1("<< Sent all fields of the structure %s", type->name);
363 case e_gras_datadesc_type_cat_union: {
364 gras_dd_cat_union_t union_data;
365 gras_dd_cat_field_t *field;
368 union_data = type->category.union_data;
370 gras_assert1(union_data.closed,
371 "Please call gras_datadesc_declare_union_close on %s before sending it",
373 /* retrieve the field number */
374 field_num = union_data.selector(state, type, data);
376 gras_assert1(field_num > 0,
377 "union field selector of %s gave a negative value",
380 gras_assert3(field_num < gras_dynar_length(union_data.fields),
381 "union field selector of %s returned %d but there is only %d fields",
382 type->name, field_num, gras_dynar_length(union_data.fields));
384 /* Send the field number */
385 TRY(gras_dd_send_int(sock, field_num));
387 /* Send the content */
388 gras_dynar_get(union_data.fields, field_num, field);
389 TRY(gras_datadesc_by_id(field->code, &sub_type));
392 field->pre(state,sub_type,data);
394 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, data));
397 field->post(state,sub_type,data);
402 case e_gras_datadesc_type_cat_ref: {
403 gras_dd_cat_ref_t ref_data;
406 void **ref=(void**)data;
409 ref_data = type->category.ref_data;
411 /* Detect the referenced type and send it to peer if needed */
412 ref_code = ref_data.code;
414 ref_code = ref_data.selector(state,type,data);
415 TRY(gras_dd_send_int(sock, ref_code));
418 /* Send the actual value of the pointer for cycle handling */
420 pointer_type = gras_datadesc_by_name("data pointer");
421 gras_assert(pointer_type);
424 TRY(gras_trp_chunk_send(sock, (char*)data,
425 pointer_type->size[GRAS_THISARCH]));
427 /* Send the pointed data only if not already sent */
428 if (*(void**)data == NULL) {
429 VERB0("Not sending NULL referenced data");
432 errcode = gras_dict_get_ext(refs,(char*)ref, sizeof(void*), &dummy);
433 if (errcode == mismatch_error) {
434 VERB1("Sending data referenced at %p", *ref);
435 TRY(gras_dict_set_ext(refs, (char*)ref, sizeof(void*), ref, NULL));
436 TRY(gras_datadesc_by_id(ref_code, &sub_type));
437 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, *ref));
439 } else if (errcode == no_error) {
440 VERB1("Not sending data referenced at %p (already done)", *ref);
448 case e_gras_datadesc_type_cat_array: {
449 gras_dd_cat_array_t array_data;
454 array_data = type->category.array_data;
456 /* determine and send the element count */
457 count = array_data.fixed_size;
459 count = array_data.dynamic_size(state,type,data);
460 gras_assert1(count >=0,
461 "Invalid (negative) array size for type %s",type->name);
462 TRY(gras_dd_send_int(sock, count));
465 /* send the content */
466 TRY(gras_datadesc_by_id(array_data.code, &sub_type));
467 elm_size = sub_type->aligned_size[GRAS_THISARCH];
468 if (sub_type->category_code == e_gras_datadesc_type_cat_scalar) {
469 VERB1("Array of %d scalars, send it in one shoot",count);
470 TRY(gras_trp_chunk_send(sock, data,
471 sub_type->aligned_size[GRAS_THISARCH] * count));
473 for (cpt=0; cpt<count; cpt++) {
474 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, ptr));
482 gras_assert0(0, "Invalid type");
486 type->post(state,type,data);
493 * gras_datadesc_send:
495 * Copy the data pointed by src and described by type to the socket
498 gras_error_t gras_datadesc_send(gras_socket_t *sock,
499 gras_datadesc_type_t *type,
502 gras_error_t errcode;
503 gras_dd_cbps_t *state = NULL;
504 gras_dict_t *refs; /* all references already sent */
506 TRY(gras_dict_new(&refs));
507 TRY(gras_dd_cbps_new(&state));
509 errcode = gras_datadesc_send_rec(sock,state,refs,type,(char*)src);
511 gras_dict_free(&refs);
512 gras_dd_cbps_free(&state);
518 * gras_datadesc_recv_rec:
520 * Do the data reception job recursively.
522 * subsize used only to deal with vicious case of reference to dynamic array.
523 * This size is needed at the reference reception level (to allocate enough
524 * space) and at the array reception level (to fill enough room).
526 * Having this size passed as an argument of the recursive function is a crude
527 * hack, but I was told that working code is sometimes better than neat one ;)
530 gras_datadesc_recv_rec(gras_socket_t *sock,
531 gras_dd_cbps_t *state,
533 gras_datadesc_type_t *type,
540 gras_error_t errcode;
542 gras_datadesc_type_t *sub_type;
544 VERB2("Recv a %s @%p", type->name, l_data);
547 switch (type->category_code) {
548 case e_gras_datadesc_type_cat_scalar:
549 if (type->size[GRAS_THISARCH] == type->size[r_arch]) {
550 TRY(gras_trp_chunk_recv(sock, (char*)l_data, type->size[r_arch]));
551 TRY(gras_dd_convert_elm(type,1,r_arch, l_data,l_data));
554 ptr = malloc((size_t)type->size[r_arch]);
555 TRY(gras_trp_chunk_recv(sock, (char*)ptr, type->size[r_arch]));
556 TRY(gras_dd_convert_elm(type,1,r_arch, ptr,l_data));
561 case e_gras_datadesc_type_cat_struct: {
562 gras_dd_cat_struct_t struct_data;
563 gras_dd_cat_field_t *field;
565 struct_data = type->category.struct_data;
567 gras_assert1(struct_data.closed,
568 "Please call gras_datadesc_declare_struct_close on %s before receiving it",
570 VERB1(">> Receive all fields of the structure %s",type->name);
571 gras_dynar_foreach(struct_data.fields, cpt, field) {
572 char *field_data = l_data + field->offset[GRAS_THISARCH];
574 TRY(gras_datadesc_by_id(field->code, &sub_type));
576 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
580 VERB1("<< Received all fields of the structure %s", type->name);
585 case e_gras_datadesc_type_cat_union: {
586 gras_dd_cat_union_t union_data;
587 gras_dd_cat_field_t *field;
590 union_data = type->category.union_data;
592 gras_assert1(union_data.closed,
593 "Please call gras_datadesc_declare_union_close on %s before receiving it",
595 /* retrieve the field number */
596 TRY(gras_dd_recv_int(sock, r_arch, &field_num));
598 RAISE1(mismatch_error,
599 "Received union field for %s is negative", type->name);
600 if (field_num < gras_dynar_length(union_data.fields))
601 RAISE3(mismatch_error,
602 "Received union field for %s is %d but there is only %d fields",
603 type->name, field_num, gras_dynar_length(union_data.fields));
605 /* Recv the content */
606 gras_dynar_get(union_data.fields, field_num, field);
607 TRY(gras_datadesc_by_id(field->code, &sub_type));
609 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
615 case e_gras_datadesc_type_cat_ref: {
618 gras_dd_cat_ref_t ref_data;
621 ref_data = type->category.ref_data;
623 /* Get the referenced type locally or from peer */
624 ref_code = ref_data.code;
626 TRY(gras_dd_recv_int(sock, r_arch, &ref_code));
628 /* Get the actual value of the pointer for cycle handling */
630 pointer_type = gras_datadesc_by_name("data pointer");
631 gras_assert(pointer_type);
634 if (! (r_ref = malloc((size_t)pointer_type->size[r_arch])) )
636 TRY(gras_trp_chunk_recv(sock, (char*)r_ref,
637 pointer_type->size[r_arch]));
639 /* Receive the pointed data only if not already sent */
640 if (gras_dd_is_r_null(r_ref, pointer_type->size[r_arch])) {
641 VERB1("Not receiving data remotely referenced @%p since it's NULL",
643 *(void**)l_data = NULL;
647 errcode = gras_dict_get_ext(refs,
648 (char*)r_ref, pointer_type->size[r_arch],
652 if (errcode == mismatch_error) {
653 int subsubcount = -1;
654 void *l_referenced=NULL;
656 TRY(gras_datadesc_by_id(ref_code, &sub_type));
658 VERB2("Receiving a ref to '%s', remotely @%p",
659 sub_type->name, *(void**)r_ref);
660 if (sub_type->category_code == e_gras_datadesc_type_cat_array) {
661 /* Damn. Reference to a dynamic array. Allocating the size for it
662 is more complicated */
663 gras_dd_cat_array_t array_data = sub_type->category.array_data;
664 gras_datadesc_type_t *subsub_type;
666 subsubcount = array_data.fixed_size;
668 TRY(gras_dd_recv_int(sock, r_arch, &subsubcount));
670 TRY(gras_datadesc_by_id(array_data.code, &subsub_type));
673 TRY(gras_dd_alloc_ref(refs,
674 subsub_type->size[GRAS_THISARCH] * subsubcount,
675 r_ref,pointer_type->size[r_arch],
676 (char**)&l_referenced));
678 TRY(gras_dd_alloc_ref(refs,sub_type->size[GRAS_THISARCH],
679 r_ref,pointer_type->size[r_arch],
680 (char**)&l_referenced));
683 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
684 r_arch,r_ref,pointer_type->size[r_arch],
685 (char*)l_referenced, subsubcount));
686 *(void**)l_data=l_referenced;
687 VERB3("'%s' remotely referenced at %p locally at %p",
688 sub_type->name, *(void**)r_ref, l_referenced);
690 } else if (errcode == no_error) {
691 VERB2("NOT receiving data remotely referenced @%p (already done, @%p here)",
692 *(void**)r_ref, *(void**)l_ref);
694 *(void**)l_data=*l_ref;
703 case e_gras_datadesc_type_cat_array: {
704 gras_dd_cat_array_t array_data;
709 array_data = type->category.array_data;
710 /* determine element count locally, or from caller, or from peer */
711 count = array_data.fixed_size;
715 TRY(gras_dd_recv_int(sock, r_arch, &count));
717 RAISE1(mismatch_error,
718 "Invalid (negative) array size for type %s",type->name);
720 /* receive the content */
721 TRY(gras_datadesc_by_id(array_data.code, &sub_type));
722 if (sub_type->category_code == e_gras_datadesc_type_cat_scalar) {
723 VERB1("Array of %d scalars, get it in one shoot", count);
724 if (sub_type->aligned_size[GRAS_THISARCH] >=
725 sub_type->aligned_size[r_arch]) {
726 TRY(gras_trp_chunk_recv(sock, (char*)l_data,
727 sub_type->aligned_size[r_arch] * count));
728 TRY(gras_dd_convert_elm(sub_type,count,r_arch, l_data,l_data));
730 ptr = malloc((size_t)sub_type->aligned_size[r_arch] * count);
731 TRY(gras_trp_chunk_recv(sock, (char*)ptr,
732 sub_type->size[r_arch] * count));
733 TRY(gras_dd_convert_elm(sub_type,count,r_arch, ptr,l_data));
737 /* not scalar content, get it recursively (may contain pointers) */
738 elm_size = sub_type->aligned_size[GRAS_THISARCH];
739 VERB2("Receive a %d-long array of %s",count, sub_type->name);
742 for (cpt=0; cpt<count; cpt++) {
743 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
744 r_arch, NULL, 0, ptr,-1));
752 gras_assert0(0, "Invalid type");
759 * gras_datadesc_recv:
761 * Get an instance of the datatype described by @type from the @socket,
762 * and store a pointer to it in @dst
766 gras_datadesc_recv(gras_socket_t *sock,
767 gras_datadesc_type_t *type,
771 gras_error_t errcode;
772 gras_dd_cbps_t *state = NULL; /* callback persistent state */
773 gras_dict_t *refs; /* all references already sent */
775 TRY(gras_dict_new(&refs));
776 TRY(gras_dd_cbps_new(&state));
778 errcode = gras_datadesc_recv_rec(sock, state, refs, type,
782 gras_dict_free(&refs);
783 gras_dd_cbps_free(&state);