src/gras/DataDesc/datadesc.c

   1 /* datadesc - data description in order to send/recv it in GRAS             */
   2
   3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include "gras/DataDesc/datadesc_private.h"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_ddt, gras, "Data description");
  12 /* FIXME: make this host-dependent using a trick such as UserData*/
  13 /*@null@*/ xbt_set_t gras_datadesc_set_local = NULL;
  14
  15
  16 /* callback for array size when sending strings */
  17 static int _strlen_cb( /*@unused@ */ gras_datadesc_type_t type, /*@unused@ */
  18                       gras_cbps_t vars, void *data)
  19 {
  20
  21   return 1 + (int) strlen(data);
  22 }
  23
  24
  25 /**
  26  * gras_datadesc_init:
  27  *
  28  * Initialize the datadesc module.
  29  * FIXME: We assume that when neither signed nor unsigned is given,
  30  *    that means signed. To be checked by configure.
  31  **/
  32 void gras_datadesc_init(void)
  33 {
  34   gras_datadesc_type_t ddt;     /* What to add */
  35
  36   /* only initialize once */
  37   if (gras_datadesc_set_local != NULL)
  38     return;
  39
  40   XBT_VERB("Initializing DataDesc");
  41
  42   gras_datadesc_set_local = xbt_set_new();
  43
  44
  45   /* all known datatypes */
  46
  47   ddt = gras_datadesc_scalar("signed char",
  48                              gras_ddt_scalar_char,
  49                              e_gras_dd_scalar_encoding_sint);
  50   ddt = gras_datadesc_scalar("char",
  51                              gras_ddt_scalar_char,
  52                              e_gras_dd_scalar_encoding_sint);
  53   ddt = gras_datadesc_scalar("unsigned char",
  54                              gras_ddt_scalar_char,
  55                              e_gras_dd_scalar_encoding_uint);
  56
  57   ddt = gras_datadesc_scalar("signed short int",
  58                              gras_ddt_scalar_short,
  59                              e_gras_dd_scalar_encoding_sint);
  60   ddt = gras_datadesc_scalar("short int",
  61                              gras_ddt_scalar_short,
  62                              e_gras_dd_scalar_encoding_sint);
  63   ddt = gras_datadesc_scalar("short",
  64                              gras_ddt_scalar_short,
  65                              e_gras_dd_scalar_encoding_sint);
  66   ddt = gras_datadesc_scalar("unsigned short int",
  67                              gras_ddt_scalar_short,
  68                              e_gras_dd_scalar_encoding_uint);
  69
  70   ddt = gras_datadesc_scalar("signed int",
  71                              gras_ddt_scalar_int,
  72                              e_gras_dd_scalar_encoding_sint);
  73   ddt = gras_datadesc_scalar("int",
  74                              gras_ddt_scalar_int,
  75                              e_gras_dd_scalar_encoding_sint);
  76   ddt = gras_datadesc_scalar("unsigned int",
  77                              gras_ddt_scalar_int,
  78                              e_gras_dd_scalar_encoding_uint);
  79
  80   ddt = gras_datadesc_scalar("signed long int",
  81                              gras_ddt_scalar_long,
  82                              e_gras_dd_scalar_encoding_sint);
  83   ddt = gras_datadesc_scalar("long int",
  84                              gras_ddt_scalar_long,
  85                              e_gras_dd_scalar_encoding_sint);
  86   ddt = gras_datadesc_scalar("long",
  87                              gras_ddt_scalar_long,
  88                              e_gras_dd_scalar_encoding_sint);
  89   ddt = gras_datadesc_scalar("unsigned long int",
  90                              gras_ddt_scalar_long,
  91                              e_gras_dd_scalar_encoding_uint);
  92
  93   ddt = gras_datadesc_scalar("signed long long int",
  94                              gras_ddt_scalar_long_long,
  95                              e_gras_dd_scalar_encoding_sint);
  96   ddt = gras_datadesc_scalar("long long int",
  97                              gras_ddt_scalar_long_long,
  98                              e_gras_dd_scalar_encoding_sint);
  99   ddt = gras_datadesc_scalar("unsigned long long int",
 100                              gras_ddt_scalar_long_long,
 101                              e_gras_dd_scalar_encoding_uint);
 102
 103   ddt = gras_datadesc_scalar("data pointer",
 104                              gras_ddt_scalar_pdata,
 105                              e_gras_dd_scalar_encoding_uint);
 106   ddt = gras_datadesc_scalar("function pointer",
 107                              gras_ddt_scalar_pfunc,
 108                              e_gras_dd_scalar_encoding_uint);
 109
 110   ddt = gras_datadesc_scalar("float",
 111                              gras_ddt_scalar_float,
 112                              e_gras_dd_scalar_encoding_float);
 113   ddt = gras_datadesc_scalar("double",
 114                              gras_ddt_scalar_double,
 115                              e_gras_dd_scalar_encoding_float);
 116
 117   ddt = gras_datadesc_array_dyn("char[]",
 118                                 gras_datadesc_by_name("char"), _strlen_cb);
 119   gras_datadesc_ref("string", ddt);
 120   gras_datadesc_ref("xbt_string_t", ddt);
 121
 122   /* specific datatype: the exception type (for RPC) */
 123   ddt = gras_datadesc_struct("ex_t");
 124   gras_datadesc_struct_append(ddt, "msg", gras_datadesc_by_name("string"));
 125   gras_datadesc_struct_append(ddt, "category",
 126                               gras_datadesc_by_name("int"));
 127   gras_datadesc_struct_append(ddt, "value", gras_datadesc_by_name("int"));
 128
 129   gras_datadesc_struct_append(ddt, "remote",
 130                               gras_datadesc_by_name("short int"));
 131
 132   gras_datadesc_struct_append(ddt, "host",
 133                               gras_datadesc_by_name("string"));
 134   gras_datadesc_struct_append(ddt, "procname",
 135                               gras_datadesc_by_name("string"));
 136   gras_datadesc_struct_append(ddt, "pid",
 137                               gras_datadesc_by_name("long int"));
 138   gras_datadesc_struct_append(ddt, "file",
 139                               gras_datadesc_by_name("string"));
 140   gras_datadesc_struct_append(ddt, "line", gras_datadesc_by_name("int"));
 141   gras_datadesc_struct_append(ddt, "func",
 142                               gras_datadesc_by_name("string"));
 143   gras_datadesc_struct_append(ddt, "used", gras_datadesc_by_name("int"));
 144   gras_datadesc_cb_field_push(ddt, "used");
 145   gras_datadesc_struct_append(ddt, "bt_strings",
 146                               gras_datadesc_ref_pop_arr
 147                               (gras_datadesc_by_name("string")));
 148
 149   gras_datadesc_struct_close(ddt);
 150
 151   /* specific datatype: xbt_peer_t */
 152   ddt = gras_datadesc_struct("s_xbt_peer_t");
 153   gras_datadesc_struct_append(ddt, "name",
 154                               gras_datadesc_by_name("string"));
 155   gras_datadesc_struct_append(ddt, "port", gras_datadesc_by_name("int"));
 156   gras_datadesc_struct_close(ddt);
 157
 158   ddt = gras_datadesc_ref("xbt_peer_t", ddt);
 159
 160   /* Dict containing the constant value (for the parsing macro) */
 161   gras_dd_constants = xbt_dict_new();
 162
 163 }
 164
 165 /**
 166  * gras_datadesc_exit:
 167  *
 168  * Finalize the datadesc module
 169  **/
 170 void gras_datadesc_exit(void)
 171 {
 172   XBT_VERB("Exiting DataDesc");
 173   xbt_set_free(&gras_datadesc_set_local);
 174   xbt_dict_free(&gras_dd_constants);
 175   XBT_DEBUG("Exited DataDesc");
 176 }
 177
 178 /** This is mainly to debug */
 179 const char *gras_datadesc_get_name(gras_datadesc_type_t ddt)
 180 {
 181   return ddt ? (const char *) ddt->name : "(null)";
 182 }
 183
 184 /** This is mainly to debug */
 185 int gras_datadesc_get_id(gras_datadesc_type_t ddt)
 186 {
 187   return ddt->code;
 188 }
 189
 190 /**
 191  * gras_datadesc_size:
 192  *
 193  * Returns the size occuped by data of this type (on the current arch).
 194  *
 195  */
 196 int gras_datadesc_size(gras_datadesc_type_t type)
 197 {
 198   return type ? type->size[GRAS_THISARCH] : 0;
 199 }
 200
 201 /**
 202  * gras_datadesc_type_dump:
 203  *
 204  * For debugging purpose
 205  */
 206 void gras_datadesc_type_dump(const gras_datadesc_type_t ddt)
 207 {
 208   unsigned int cpt;
 209
 210   printf("DataDesc dump:");
 211   if (!ddt) {
 212     printf("(null)\n");
 213     return;
 214   }
 215   printf("%s (ID:%d)\n", ddt->name, ddt->code);
 216   printf("  category: %s\n", gras_datadesc_cat_names[ddt->category_code]);
 217
 218   printf("  size[");
 219   for (cpt = 0; cpt < gras_arch_count; cpt++) {
 220     printf("%s%s%ld%s",
 221            cpt > 0 ? ", " : "",
 222            cpt == GRAS_THISARCH ? ">" : "",
 223            ddt->size[cpt], cpt == GRAS_THISARCH ? "<" : "");
 224   }
 225   printf("]\n");
 226
 227   printf("  alignment[");
 228   for (cpt = 0; cpt < gras_arch_count; cpt++) {
 229     printf("%s%s%ld%s",
 230            cpt > 0 ? ", " : "",
 231            cpt == GRAS_THISARCH ? ">" : "",
 232            ddt->alignment[cpt], cpt == GRAS_THISARCH ? "<" : "");
 233   }
 234   printf("]\n");
 235
 236   printf("  aligned_size[");
 237   for (cpt = 0; cpt < gras_arch_count; cpt++) {
 238     printf("%s%s%ld%s",
 239            cpt > 0 ? ", " : "",
 240            cpt == GRAS_THISARCH ? ">" : "",
 241            ddt->aligned_size[cpt], cpt == GRAS_THISARCH ? "<" : "");
 242   }
 243   printf("]\n");
 244   if (ddt->category_code == e_gras_datadesc_type_cat_struct) {
 245     gras_dd_cat_struct_t struct_data;
 246     gras_dd_cat_field_t field;
 247
 248     struct_data = ddt->category.struct_data;
 249     xbt_dynar_foreach(struct_data.fields, cpt, field) {
 250       printf(">>> Dump field #%d (%s) (offset=%ld)\n",
 251              cpt, field->name, field->offset[GRAS_THISARCH]);
 252       gras_datadesc_type_dump(field->type);
 253       printf("<<< end dump field #%d (%s)\n", cpt, field->name);
 254     }
 255   }
 256   fflush(stdout);
 257 }