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"
12 #include "Transport/transport_interface.h" /* gras_trp_chunk_send/recv */
14 GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(exchange,datadesc);
16 const char *gras_datadesc_cat_names[9] = {
18 "scalar", "struct", "union", "ref", "array", "ignored",
21 static gras_datadesc_type_t *int_type = NULL;
22 static gras_datadesc_type_t *pointer_type = NULL;
23 static inline gras_error_t gras_dd_send_int(gras_socket_t *sock, int i);
24 static inline gras_error_t gras_dd_recv_int(gras_socket_t *sock, int r_arch, int *i);
26 static inline gras_error_t
27 gras_dd_alloc_ref(gras_dict_t *refs, long int size,
28 char **r_ref, long int r_len,
31 gras_dd_is_r_null(char **r_ptr, long int length);
34 gras_datadesc_send_rec(gras_socket_t *sock,
37 gras_datadesc_type_t *type,
40 gras_datadesc_recv_rec(gras_socket_t *sock,
43 gras_datadesc_type_t *type,
51 static inline gras_error_t
52 gras_dd_send_int(gras_socket_t *sock,int i) {
55 int_type = gras_datadesc_by_name("int");
56 gras_assert(int_type);
59 DEBUG1("send_int(%d)",i);
60 return gras_trp_chunk_send(sock, (char*)&i, int_type->size[GRAS_THISARCH]);
63 static inline gras_error_t
64 gras_dd_recv_int(gras_socket_t *sock, int r_arch, int *i) {
68 int_type = gras_datadesc_by_name("int");
69 gras_assert(int_type);
72 if (int_type->size[GRAS_THISARCH] >= int_type->size[r_arch]) {
73 TRY(gras_trp_chunk_recv(sock, (char*)i, int_type->size[r_arch]));
74 TRY(gras_dd_convert_elm(int_type,1,r_arch, i,i));
77 ptr = malloc((size_t)int_type->size[r_arch]);
78 TRY(gras_trp_chunk_recv(sock, (char*)ptr, int_type->size[r_arch]));
79 TRY(gras_dd_convert_elm(int_type,1,r_arch, ptr,i));
82 DEBUG1("recv_int(%d)",*i);
88 * Note: here we suppose that the remote NULL is a sequence
89 * of 'length' bytes set to 0.
90 * FIXME: Check in configure?
93 gras_dd_is_r_null(char **r_ptr, long int length) {
96 for (i=0; i<length; i++) {
97 if ( ((unsigned char*)r_ptr) [i]) {
105 static inline gras_error_t
106 gras_dd_alloc_ref(gras_dict_t *refs,
109 long int r_len, /* pointer_type->size[r_arch] */
112 gras_error_t errcode;
114 gras_assert1(size>0,"Cannot allocate %ld bytes!", size);
115 if (! (l_data = malloc((size_t)size)) )
119 DEBUG2("l_data=%p, &l_data=%p",l_data,&l_data);
121 DEBUG3("alloc_ref: r_ref=%p; *r_ref=%p, r_len=%ld",
122 r_ref, r_ref?*r_ref:NULL, r_len);
123 if (r_ref && !gras_dd_is_r_null( r_ref, r_len)) {
124 void *ptr = malloc(sizeof(void *));
128 memcpy(ptr,l_ref, sizeof(void *));
130 DEBUG2("Insert %p under %p",*(void**)ptr, *(void**)r_ref);
132 TRY(gras_dict_set_ext(refs,(const char *) r_ref, r_len, ptr, free));
138 * gras_datadesc_type_cmp:
140 * Compares two datadesc types with the same semantic than strcmp.
142 * This comparison does not take the set headers into account (name and ID),
143 * but only the payload (actual type description).
145 int gras_datadesc_type_cmp(const gras_datadesc_type_t *d1,
146 const gras_datadesc_type_t *d2) {
148 gras_dd_cat_field_t *field1,*field2;
149 gras_datadesc_type_t *field_desc_1,*field_desc_2;
151 if (d1 == d2) return 0; /* easy optimization */
154 DEBUG0("ddt_cmp: !d1 && d2 => 1");
158 DEBUG0("ddt_cmp: !d1 && !d2 => 0");
162 DEBUG0("ddt_cmp: d1 && !d2 => -1");
166 for (cpt=0; cpt<gras_arch_count; cpt++) {
167 if (d1->size[cpt] != d2->size[cpt]) {
168 DEBUG5("ddt_cmp: %s->size=%ld != %s->size=%ld (on %s)",
169 d1->name,d1->size[cpt],d2->name,d2->size[cpt],
170 gras_arches[cpt].name);
171 return d1->size[cpt] > d2->size[cpt] ? 1 : -1;
174 if (d1->alignment[cpt] != d2->alignment[cpt]) {
175 DEBUG5("ddt_cmp: %s->alignment=%ld != %s->alignment=%ld (on %s)",
176 d1->name,d1->alignment[cpt],d2->name,d2->alignment[cpt],
177 gras_arches[cpt].name);
178 return d1->alignment[cpt] > d2->alignment[cpt] ? 1 : -1;
181 if (d1->aligned_size[cpt] != d2->aligned_size[cpt]) {
182 DEBUG5("ddt_cmp: %s->aligned_size=%ld != %s->aligned_size=%ld (on %s)",
183 d1->name,d1->aligned_size[cpt],d2->name,d2->aligned_size[cpt],
184 gras_arches[cpt].name);
185 return d1->aligned_size[cpt] > d2->aligned_size[cpt] ? 1 : -1;
189 if (d1->category_code != d2->category_code) {
190 DEBUG4("ddt_cmp: %s->cat=%s != %s->cat=%s",
191 d1->name,gras_datadesc_cat_names[d1->category_code],
192 d2->name,gras_datadesc_cat_names[d2->category_code]);
193 return d1->category_code > d2->category_code ? 1 : -1;
196 if (d1->send != d2->send) {
197 DEBUG4("ddt_cmp: %s->send=%p != %s->send=%p",
198 d1->name,d1->send, d2->name,d2->send);
199 return d1->send > d2->send ? 1 : -1;
202 if (d1->recv != d2->recv) {
203 DEBUG4("ddt_cmp: %s->recv=%p != %s->recv=%p",
204 d1->name,d1->recv, d2->name,d2->recv);
205 return d1->recv > d2->recv ? 1 : -1;
208 switch (d1->category_code) {
209 case e_gras_datadesc_type_cat_scalar:
210 if (d1->category.scalar_data.encoding != d2->category.scalar_data.encoding)
211 return d1->category.scalar_data.encoding > d2->category.scalar_data.encoding ? 1 : -1 ;
214 case e_gras_datadesc_type_cat_struct:
215 if (gras_dynar_length(d1->category.struct_data.fields) !=
216 gras_dynar_length(d2->category.struct_data.fields)) {
217 DEBUG4("ddt_cmp: %s (having %d fields) != %s (having %d fields)",
218 d1->name, gras_dynar_length(d1->category.struct_data.fields),
219 d2->name, gras_dynar_length(d2->category.struct_data.fields));
221 return gras_dynar_length(d1->category.struct_data.fields) >
222 gras_dynar_length(d2->category.struct_data.fields) ?
225 gras_dynar_foreach(d1->category.struct_data.fields, cpt, field1) {
227 gras_dynar_get(d2->category.struct_data.fields, cpt, &field2);
228 gras_datadesc_by_id(field1->code,&field_desc_1); /* FIXME: errcode ignored */
229 gras_datadesc_by_id(field2->code,&field_desc_2);
230 ret = gras_datadesc_type_cmp(field_desc_1,field_desc_2);
232 DEBUG6("%s->field[%d]=%s != %s->field[%d]=%s",
233 d1->name,cpt,field1->name,
234 d2->name,cpt,field2->name);
241 case e_gras_datadesc_type_cat_union:
242 if (d1->category.union_data.selector != d2->category.union_data.selector)
243 return d1->category.union_data.selector > d2->category.union_data.selector ? 1 : -1;
245 if (gras_dynar_length(d1->category.union_data.fields) !=
246 gras_dynar_length(d2->category.union_data.fields))
247 return gras_dynar_length(d1->category.union_data.fields) >
248 gras_dynar_length(d2->category.union_data.fields) ?
251 gras_dynar_foreach(d1->category.union_data.fields, cpt, field1) {
253 gras_dynar_get(d2->category.union_data.fields, cpt, field2);
254 gras_datadesc_by_id(field1->code,&field_desc_1); /* FIXME: errcode ignored */
255 gras_datadesc_by_id(field2->code,&field_desc_2);
256 ret = gras_datadesc_type_cmp(field_desc_1,field_desc_2);
264 case e_gras_datadesc_type_cat_ref:
265 if (d1->category.ref_data.selector != d2->category.ref_data.selector)
266 return d1->category.ref_data.selector > d2->category.ref_data.selector ? 1 : -1;
268 if (d1->category.ref_data.code != d2->category.ref_data.code)
269 return d1->category.ref_data.code > d2->category.ref_data.code ? 1 : -1;
272 case e_gras_datadesc_type_cat_array:
273 if (d1->category.array_data.code != d2->category.array_data.code)
274 return d1->category.array_data.code > d2->category.array_data.code ? 1 : -1;
276 if (d1->category.array_data.fixed_size != d2->category.array_data.fixed_size)
277 return d1->category.array_data.fixed_size > d2->category.array_data.fixed_size ? 1 : -1;
279 if (d1->category.array_data.dynamic_size != d2->category.array_data.dynamic_size)
280 return d1->category.array_data.dynamic_size > d2->category.array_data.dynamic_size ? 1 : -1;
284 case e_gras_datadesc_type_cat_ignored:
285 /* That's ignored... */
287 /* two stupidly created ddt are equally stupid ;) */
297 * Copy the data pointed by src and described by type
298 * to a new location, and store a pointer to it in dst.
301 gras_error_t gras_datadesc_cpy(gras_datadesc_type_t *type,
308 gras_datadesc_send_rec(gras_socket_t *sock,
311 gras_datadesc_type_t *type,
314 gras_error_t errcode;
316 gras_datadesc_type_t *sub_type; /* type on which we recurse */
318 VERB2("Send a %s (%s)",
319 type->name, gras_datadesc_cat_names[type->category_code]);
322 type->send(state,data);
325 switch (type->category_code) {
326 case e_gras_datadesc_type_cat_scalar:
327 TRY(gras_trp_chunk_send(sock, data, type->size[GRAS_THISARCH]));
330 case e_gras_datadesc_type_cat_struct: {
331 gras_dd_cat_struct_t struct_data;
332 gras_dd_cat_field_t *field;
335 struct_data = type->category.struct_data;
336 gras_assert1(struct_data.closed,
337 "Please call gras_datadesc_declare_struct_close on %s before sending it",
339 VERB1(">> Send all fields of the structure %s",type->name);
340 gras_dynar_foreach(struct_data.fields, cpt, field) {
342 field_data += field->offset[GRAS_THISARCH];
344 errcode=gras_datadesc_by_id(field->code, &sub_type);
345 if (errcode != no_error)
347 "Got %s while searching for the sub type %d, #%d of %s",
348 gras_error_name(errcode),field->code,cpt,type->name);
351 field->pre(state,field_data);
353 VERB1("Send field %s",field->name);
354 TRY(gras_datadesc_send_rec(sock,state,refs,sub_type, field_data));
357 field->post(state,field_data);
359 VERB1("<< Sent all fields of the structure %s", type->name);
364 case e_gras_datadesc_type_cat_union: {
365 gras_dd_cat_union_t union_data;
366 gras_dd_cat_field_t *field;
369 union_data = type->category.union_data;
371 gras_assert1(union_data.closed,
372 "Please call gras_datadesc_declare_union_close on %s before sending it",
374 /* retrieve the field number */
375 field_num = union_data.selector(state, data);
377 gras_assert1(field_num > 0,
378 "union field selector of %s gave a negative value",
381 gras_assert3(field_num < gras_dynar_length(union_data.fields),
382 "union field selector of %s returned %d but there is only %d fields",
383 type->name, field_num, gras_dynar_length(union_data.fields));
385 /* Send the field number */
386 TRY(gras_dd_send_int(sock, field_num));
388 /* Send the content */
389 gras_dynar_get(union_data.fields, field_num, field);
390 TRY(gras_datadesc_by_id(field->code, &sub_type));
393 field->pre(state,data);
395 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, data));
398 field->post(state,data);
403 case e_gras_datadesc_type_cat_ref: {
404 gras_dd_cat_ref_t ref_data;
407 void **ref=(void**)data;
410 ref_data = type->category.ref_data;
412 /* Detect the referenced type and send it to peer if needed */
413 ref_code = ref_data.code;
415 ref_code = ref_data.selector(state,data);
416 TRY(gras_dd_send_int(sock, ref_code));
419 /* Send the actual value of the pointer for cycle handling */
421 pointer_type = gras_datadesc_by_name("data pointer");
422 gras_assert(pointer_type);
425 TRY(gras_trp_chunk_send(sock, (char*)data,
426 pointer_type->size[GRAS_THISARCH]));
428 /* Send the pointed data only if not already sent */
429 if (*(void**)data == NULL) {
430 VERB0("Not sending NULL referenced data");
433 errcode = gras_dict_get_ext(refs,(char*)ref, sizeof(void*), &dummy);
434 if (errcode == mismatch_error) {
435 VERB1("Sending data referenced at %p", *ref);
436 TRY(gras_dict_set_ext(refs, (char*)ref, sizeof(void*), ref, NULL));
437 TRY(gras_datadesc_by_id(ref_code, &sub_type));
438 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, *ref));
440 } else if (errcode == no_error) {
441 VERB1("Not sending data referenced at %p (already done)", *ref);
449 case e_gras_datadesc_type_cat_array: {
450 gras_dd_cat_array_t array_data;
455 array_data = type->category.array_data;
457 /* determine and send the element count */
458 count = array_data.fixed_size;
460 count = array_data.dynamic_size(state,data);
461 gras_assert1(count >=0,
462 "Invalid (negative) array size for type %s",type->name);
463 TRY(gras_dd_send_int(sock, count));
466 /* send the content */
467 TRY(gras_datadesc_by_id(array_data.code, &sub_type));
468 elm_size = sub_type->aligned_size[GRAS_THISARCH];
469 if (sub_type->category_code == e_gras_datadesc_type_cat_scalar) {
470 VERB1("Array of %ld scalars, send it in one shot",count);
471 TRY(gras_trp_chunk_send(sock, data,
472 sub_type->aligned_size[GRAS_THISARCH] * count));
474 for (cpt=0; cpt<count; cpt++) {
475 TRY(gras_datadesc_send_rec(sock,state,refs, sub_type, ptr));
483 gras_assert0(0, "Invalid type");
490 * gras_datadesc_send:
492 * Copy the data pointed by src and described by type to the socket
495 gras_error_t gras_datadesc_send(gras_socket_t *sock,
496 gras_datadesc_type_t *type,
499 gras_error_t errcode;
500 gras_cbps_t *state = NULL;
501 gras_dict_t *refs; /* all references already sent */
503 TRY(gras_dict_new(&refs));
504 TRY(gras_cbps_new(&state));
506 errcode = gras_datadesc_send_rec(sock,state,refs,type,(char*)src);
508 gras_dict_free(&refs);
509 gras_cbps_free(&state);
515 * gras_datadesc_recv_rec:
517 * Do the data reception job recursively.
519 * subsize used only to deal with vicious case of reference to dynamic array.
520 * This size is needed at the reference reception level (to allocate enough
521 * space) and at the array reception level (to fill enough room).
523 * Having this size passed as an argument of the recursive function is a crude
524 * hack, but I was told that working code is sometimes better than neat one ;)
527 gras_datadesc_recv_rec(gras_socket_t *sock,
530 gras_datadesc_type_t *type,
537 gras_error_t errcode;
539 gras_datadesc_type_t *sub_type;
541 VERB2("Recv a %s @%p", type->name, l_data);
544 switch (type->category_code) {
545 case e_gras_datadesc_type_cat_scalar:
546 if (type->size[GRAS_THISARCH] == type->size[r_arch]) {
547 TRY(gras_trp_chunk_recv(sock, (char*)l_data, type->size[r_arch]));
548 TRY(gras_dd_convert_elm(type,1,r_arch, l_data,l_data));
551 ptr = malloc((size_t)type->size[r_arch]);
552 TRY(gras_trp_chunk_recv(sock, (char*)ptr, type->size[r_arch]));
553 TRY(gras_dd_convert_elm(type,1,r_arch, ptr,l_data));
558 case e_gras_datadesc_type_cat_struct: {
559 gras_dd_cat_struct_t struct_data;
560 gras_dd_cat_field_t *field;
562 struct_data = type->category.struct_data;
564 gras_assert1(struct_data.closed,
565 "Please call gras_datadesc_declare_struct_close on %s before receiving it",
567 VERB1(">> Receive all fields of the structure %s",type->name);
568 gras_dynar_foreach(struct_data.fields, cpt, field) {
569 char *field_data = l_data + field->offset[GRAS_THISARCH];
571 TRY(gras_datadesc_by_id(field->code, &sub_type));
573 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
577 VERB1("<< Received all fields of the structure %s", type->name);
582 case e_gras_datadesc_type_cat_union: {
583 gras_dd_cat_union_t union_data;
584 gras_dd_cat_field_t *field;
587 union_data = type->category.union_data;
589 gras_assert1(union_data.closed,
590 "Please call gras_datadesc_declare_union_close on %s before receiving it",
592 /* retrieve the field number */
593 TRY(gras_dd_recv_int(sock, r_arch, &field_num));
595 RAISE1(mismatch_error,
596 "Received union field for %s is negative", type->name);
597 if (field_num < gras_dynar_length(union_data.fields))
598 RAISE3(mismatch_error,
599 "Received union field for %s is %d but there is only %d fields",
600 type->name, field_num, gras_dynar_length(union_data.fields));
602 /* Recv the content */
603 gras_dynar_get(union_data.fields, field_num, field);
604 TRY(gras_datadesc_by_id(field->code, &sub_type));
606 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
612 case e_gras_datadesc_type_cat_ref: {
615 gras_dd_cat_ref_t ref_data;
618 ref_data = type->category.ref_data;
620 /* Get the referenced type locally or from peer */
621 ref_code = ref_data.code;
623 TRY(gras_dd_recv_int(sock, r_arch, &ref_code));
625 /* Get the actual value of the pointer for cycle handling */
627 pointer_type = gras_datadesc_by_name("data pointer");
628 gras_assert(pointer_type);
631 if (! (r_ref = malloc((size_t)pointer_type->size[r_arch])) )
633 TRY(gras_trp_chunk_recv(sock, (char*)r_ref,
634 pointer_type->size[r_arch]));
636 /* Receive the pointed data only if not already sent */
637 if (gras_dd_is_r_null(r_ref, pointer_type->size[r_arch])) {
638 VERB1("Not receiving data remotely referenced @%p since it's NULL",
640 *(void**)l_data = NULL;
644 errcode = gras_dict_get_ext(refs,
645 (char*)r_ref, pointer_type->size[r_arch],
649 if (errcode == mismatch_error) {
650 int subsubcount = -1;
651 void *l_referenced=NULL;
653 TRY(gras_datadesc_by_id(ref_code, &sub_type));
655 VERB2("Receiving a ref to '%s', remotely @%p",
656 sub_type->name, *(void**)r_ref);
657 if (sub_type->category_code == e_gras_datadesc_type_cat_array) {
658 /* Damn. Reference to a dynamic array. Allocating the size for it
659 is more complicated */
660 gras_dd_cat_array_t array_data = sub_type->category.array_data;
661 gras_datadesc_type_t *subsub_type;
663 subsubcount = array_data.fixed_size;
665 TRY(gras_dd_recv_int(sock, r_arch, &subsubcount));
667 TRY(gras_datadesc_by_id(array_data.code, &subsub_type));
670 TRY(gras_dd_alloc_ref(refs,
671 subsub_type->size[GRAS_THISARCH] * subsubcount,
672 r_ref,pointer_type->size[r_arch],
673 (char**)&l_referenced));
675 TRY(gras_dd_alloc_ref(refs,sub_type->size[GRAS_THISARCH],
676 r_ref,pointer_type->size[r_arch],
677 (char**)&l_referenced));
680 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
681 r_arch,r_ref,pointer_type->size[r_arch],
682 (char*)l_referenced, subsubcount));
683 *(void**)l_data=l_referenced;
684 VERB3("'%s' remotely referenced at %p locally at %p",
685 sub_type->name, *(void**)r_ref, l_referenced);
687 } else if (errcode == no_error) {
688 VERB2("NOT receiving data remotely referenced @%p (already done, @%p here)",
689 *(void**)r_ref, *(void**)l_ref);
691 *(void**)l_data=*l_ref;
700 case e_gras_datadesc_type_cat_array: {
701 gras_dd_cat_array_t array_data;
706 array_data = type->category.array_data;
707 /* determine element count locally, or from caller, or from peer */
708 count = array_data.fixed_size;
712 TRY(gras_dd_recv_int(sock, r_arch, &count));
714 RAISE1(mismatch_error,
715 "Invalid (negative) array size for type %s",type->name);
717 /* receive the content */
718 TRY(gras_datadesc_by_id(array_data.code, &sub_type));
719 if (sub_type->category_code == e_gras_datadesc_type_cat_scalar) {
720 VERB1("Array of %d scalars, get it in one shoot", count);
721 if (sub_type->aligned_size[GRAS_THISARCH] >=
722 sub_type->aligned_size[r_arch]) {
723 TRY(gras_trp_chunk_recv(sock, (char*)l_data,
724 sub_type->aligned_size[r_arch] * count));
725 TRY(gras_dd_convert_elm(sub_type,count,r_arch, l_data,l_data));
727 ptr = malloc((size_t)sub_type->aligned_size[r_arch] * count);
728 TRY(gras_trp_chunk_recv(sock, (char*)ptr,
729 sub_type->size[r_arch] * count));
730 TRY(gras_dd_convert_elm(sub_type,count,r_arch, ptr,l_data));
734 /* not scalar content, get it recursively (may contain pointers) */
735 elm_size = sub_type->aligned_size[GRAS_THISARCH];
736 VERB2("Receive a %d-long array of %s",count, sub_type->name);
739 for (cpt=0; cpt<count; cpt++) {
740 TRY(gras_datadesc_recv_rec(sock,state,refs, sub_type,
741 r_arch, NULL, 0, ptr,-1));
749 gras_assert0(0, "Invalid type");
753 type->recv(state,l_data);
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_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_cbps_new(&state));
778 errcode = gras_datadesc_recv_rec(sock, state, refs, type,
782 gras_dict_free(&refs);
783 gras_cbps_free(&state);