src/gras/DataDesc/cbps.c

   1 /* cbps - persistant states for callbacks                                   */
   2
   3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 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 "xbt/ex.h"
  10 #include "gras/DataDesc/datadesc_private.h"
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_ddt_cbps, gras_ddt,
  12                                 "callback persistant state");
  13
  14 typedef struct {
  15   gras_datadesc_type_t type;
  16   void *data;
  17 } s_gras_cbps_elm_t, *gras_cbps_elm_t;
  18
  19 typedef struct s_gras_cbps {
  20   xbt_dynar_t lints;            /* simple stack of long integers (easy interface) */
  21
  22   xbt_dict_t space;             /* varname x dynar of gras_cbps_elm_t */
  23   xbt_dynar_t frames;           /* of dynar of names defined within this frame
  24                                    (and to pop when we leave it) */
  25   xbt_dynar_t globals;
  26 } s_gras_cbps_t;
  27
  28 gras_cbps_t gras_cbps_new(void)
  29 {
  30   gras_cbps_t res;
  31
  32   res = xbt_new(s_gras_cbps_t, 1);
  33
  34   res->lints = xbt_dynar_new(sizeof(int), NULL);
  35   res->space = xbt_dict_new_homogeneous(NULL);
  36   /* no leak, the content is freed manually on block_end */
  37   res->frames = xbt_dynar_new(sizeof(xbt_dynar_t), NULL);
  38   res->globals = xbt_dynar_new(sizeof(char *), NULL);
  39
  40   gras_cbps_block_begin(res);
  41
  42   return res;
  43 }
  44
  45 void gras_cbps_free(gras_cbps_t * state)
  46 {
  47
  48   xbt_dynar_free(&((*state)->lints));
  49
  50   gras_cbps_block_end(*state);
  51   xbt_dict_free(&((*state)->space));
  52   xbt_dynar_free(&((*state)->frames));
  53   xbt_dynar_free(&((*state)->globals));
  54
  55   free(*state);
  56   *state = NULL;
  57 }
  58
  59 void gras_cbps_reset(gras_cbps_t state)
  60 {
  61
  62   xbt_dynar_reset(state->lints);
  63
  64   xbt_dict_reset(state->space);
  65
  66   xbt_dynar_reset(state->frames);
  67   xbt_dynar_reset(state->globals);
  68 }
  69
  70 /** \brief Declare a new element in the PS, and give it a value.
  71  *
  72  * If an element of that
  73  * name already exists, it is masked by the one given here, and will be
  74  * seeable again only after a pop to remove the value this push adds.
  75  */
  76 void
  77 gras_cbps_v_push(gras_cbps_t ps,
  78                  const char *name, void *data, gras_datadesc_type_t ddt)
  79 {
  80
  81   xbt_dynar_t varstack = NULL, frame;
  82   gras_cbps_elm_t var;
  83   char *varname = (char *) xbt_strdup(name);
  84   xbt_ex_t e;
  85
  86   XBT_DEBUG("push(%s,%p)", name, (void *) data);
  87
  88   TRY {
  89     varstack = xbt_dict_get(ps->space, name);
  90   }
  91   CATCH(e) {
  92     if (e.category != mismatch_error)
  93       RETHROW;
  94
  95     XBT_DEBUG("Create a new variable stack for '%s' into the space", name);
  96     varstack = xbt_dynar_new(sizeof(gras_cbps_elm_t *), NULL);
  97     xbt_dict_set(ps->space, name, (void **) varstack, NULL);
  98     xbt_ex_free(e);
  99     /* leaking, you think? only if you do not close all the openned blocks ;) */
 100   }
 101
 102   var = xbt_new0(s_gras_cbps_elm_t, 1);
 103   var->type = ddt;
 104   var->data = data;
 105
 106   xbt_dynar_push(varstack, &var);
 107
 108   xbt_dynar_pop(ps->frames, &frame);
 109   XBT_DEBUG("Push %s (%p @%p) into frame %p", varname, (void *) varname,
 110          (void *) &varname, (void *) frame);
 111   xbt_dynar_push(frame, &varname);
 112   xbt_dynar_push(ps->frames, &frame);
 113 }
 114
 115 /** \brief Retrieve an element from the PS, and remove it from the PS.
 116  *
 117  * If it's not present in the current block, it will fail (throwing not_found)
 118  * and not search in upper blocks since this denotes a programmation error.
 119  */
 120 void
 121 gras_cbps_v_pop(gras_cbps_t ps,
 122                 const char *name, gras_datadesc_type_t * ddt, void **res)
 123 {
 124   xbt_dynar_t varstack = NULL, frame = NULL;
 125   gras_cbps_elm_t var = NULL;
 126   void *data = NULL;
 127   xbt_ex_t e;
 128
 129   XBT_DEBUG("pop(%s)", name);
 130   TRY {
 131     varstack = xbt_dict_get(ps->space, name);
 132   }
 133   CATCH(e) {
 134     if (e.category != mismatch_error)
 135       RETHROW;
 136
 137     xbt_ex_free(e);
 138     THROWF(not_found_error, 1, "Asked to pop the non-existant %s", name);
 139   }
 140   xbt_dynar_pop(varstack, &var);
 141
 142   if (xbt_dynar_is_empty(varstack)) {
 143     XBT_DEBUG("Last incarnation of %s poped. Kill it", name);
 144     xbt_dict_remove(ps->space, name);
 145     xbt_dynar_free(&varstack);
 146   }
 147
 148   if (ddt)
 149     *ddt = var->type;
 150   data = var->data;
 151
 152   free(var);
 153
 154   xbt_dynar_pop(ps->frames, &frame);
 155   {
 156     int l = xbt_dynar_length(frame);
 157
 158     while (l--) {
 159       char *_name = NULL;
 160
 161       _name = xbt_dynar_get_as(frame, l, char *);
 162       if (!strcmp(name, _name)) {
 163         xbt_dynar_remove_at(frame, l, &_name);
 164         free(_name);
 165         break;
 166       }
 167     }
 168   }
 169   xbt_dynar_push(ps->frames, &frame);
 170
 171   *res = data;
 172 }
 173
 174 /** \brief Change the value of an element in the PS.
 175  *
 176  * If it's not present in the current block, look in the upper ones.
 177  * If it's not present in any of them, modify in the globals
 178  * If not present there neither, the code may segfault (Oli?).
 179  *
 180  * Once a reference to an element of that name is found somewhere in the PS,
 181  *   its value is changed.
 182  */
 183 void
 184 gras_cbps_v_set(gras_cbps_t ps,
 185                 const char *name, void *data, gras_datadesc_type_t ddt)
 186 {
 187
 188   xbt_dynar_t dynar = NULL;
 189   gras_cbps_elm_t elm = NULL;
 190
 191   XBT_DEBUG("set(%s)", name);
 192   dynar = xbt_dict_get_or_null(ps->space, name);
 193
 194   if (dynar == NULL) {
 195     dynar = xbt_dynar_new(sizeof(gras_cbps_elm_t), NULL);
 196     xbt_dict_set(ps->space, name, (void **) dynar, NULL);
 197
 198     elm = xbt_new0(s_gras_cbps_elm_t, 1);
 199     xbt_dynar_push(ps->globals, &name);
 200   } else {
 201     xbt_dynar_pop(dynar, &elm);
 202   }
 203
 204   elm->type = ddt;
 205   elm->data = data;
 206
 207   xbt_dynar_push(dynar, &elm);
 208
 209 }
 210
 211 /** \brief Get the value of an element in the PS without modifying it.
 212  *
 213  * (note that you get the content of the data struct and not a copy to it)
 214  * If it's not present in the current block, look in the upper ones.
 215  * If it's not present in any of them, look in the globals
 216  * If not present there neither, the code may segfault (Oli?).
 217  */
 218 void *gras_cbps_v_get(gras_cbps_t ps, const char *name,
 219                       /* OUT */ gras_datadesc_type_t * ddt)
 220 {
 221
 222   xbt_dynar_t dynar = NULL;
 223   gras_cbps_elm_t elm = NULL;
 224
 225   XBT_DEBUG("get(%s)", name);
 226   dynar = xbt_dict_get(ps->space, name);
 227   xbt_dynar_pop(dynar, &elm);
 228   xbt_dynar_push(dynar, &elm);
 229
 230   if (ddt) {
 231     *ddt = elm->type;
 232   }
 233
 234   return elm->data;
 235
 236 }
 237
 238 /** \brief Begins a new block.
 239  *
 240  * Blocks are usefull to remove a whole set of declarations you don't even know
 241  *
 242  * E.g., they constitute an elegent solution to recursive data structures.
 243  *
 244  * push/pop may be used in some cases for that, but if your recursive data
 245  * struct contains other structs needing themselves callbacks, you have to
 246  * use block_{begin,end} to do the trick.
 247  */
 248
 249 void gras_cbps_block_begin(gras_cbps_t ps)
 250 {
 251
 252   xbt_dynar_t dynar = NULL;
 253
 254   XBT_DEBUG(">>> Block begin");
 255   dynar = xbt_dynar_new(sizeof(char *), NULL);
 256   xbt_dynar_push(ps->frames, &dynar);
 257 }
 258
 259 /** \brief End the current block, and go back to the upper one. */
 260 void gras_cbps_block_end(gras_cbps_t ps)
 261 {
 262
 263   xbt_dynar_t frame = NULL;
 264   unsigned int cursor = 0;
 265   char *name = NULL;
 266
 267   xbt_assert(xbt_dynar_length(ps->frames),
 268               "More block_end than block_begin");
 269   xbt_dynar_pop(ps->frames, &frame);
 270
 271   xbt_dynar_foreach(frame, cursor, name) {
 272
 273     xbt_dynar_t varstack = NULL;
 274     gras_cbps_elm_t var = NULL;
 275
 276     XBT_DEBUG("Get ride of %s (%p)", name, (void *) name);
 277     varstack = xbt_dict_get(ps->space, name);
 278     xbt_dynar_pop(varstack, &var);
 279
 280     if (xbt_dynar_is_empty(varstack)) {
 281       xbt_dict_remove(ps->space, name);
 282       xbt_dynar_free_container(&varstack);      /*already empty, save a test ;) */
 283     }
 284
 285     free(var->data);
 286     free(var);
 287     free(name);
 288   }
 289   xbt_dynar_free_container(&frame);     /* we just emptied it */
 290   XBT_DEBUG("<<< Block end");
 291 }
 292
 293
 294 /** \brief Push a new integer value into the cbps. */
 295 void gras_cbps_i_push(gras_cbps_t ps, int val)
 296 {
 297   XBT_DEBUG("push %d as a size", val);
 298   xbt_dynar_push_as(ps->lints, int, val);
 299 }
 300
 301 /** \brief Pop the lastly pushed integer value from the cbps. */
 302 int gras_cbps_i_pop(gras_cbps_t ps)
 303 {
 304   int ret;
 305
 306   xbt_assert(!xbt_dynar_is_empty(ps->lints),
 307               "gras_cbps_i_pop: no value to pop");
 308   ret = xbt_dynar_pop_as(ps->lints, int);
 309   XBT_DEBUG("pop %d as a size", ret);
 310   return ret;
 311 }
 312
 313 /** \brief Generic cb returning the lastly pushed value
 314  *
 315  * Used by \ref gras_datadesc_ref_pop_arr
 316  */
 317 int gras_datadesc_cb_pop(gras_datadesc_type_t ignored, gras_cbps_t vars,
 318                          void *data)
 319 {
 320   return gras_cbps_i_pop(vars);
 321 }
 322
 323 /* ************************* */
 324 /* **** PUSHy callbacks **** */
 325 /* ************************* */
 326
 327 /** \brief Cb to push an integer. Must be attached to the field you want to push */
 328 void gras_datadesc_cb_push_int(gras_datadesc_type_t ignored,
 329                                gras_cbps_t vars, void *data)
 330 {
 331   int *i = (int *) data;
 332   gras_cbps_i_push(vars, (int) *i);
 333 }
 334
 335 /** \brief Cb to push an unsigned integer. Must be attached to the field you want to push */
 336 void gras_datadesc_cb_push_uint(gras_datadesc_type_t ignored,
 337                                 gras_cbps_t vars, void *data)
 338 {
 339   unsigned int *i = (unsigned int *) data;
 340   gras_cbps_i_push(vars, (int) *i);
 341 }
 342
 343 /** \brief Cb to push an long integer. Must be attached to the field you want to push
 344  */
 345 void gras_datadesc_cb_push_lint(gras_datadesc_type_t ignored,
 346                                 gras_cbps_t vars, void *data)
 347 {
 348   long int *i = (long int *) data;
 349   gras_cbps_i_push(vars, (int) *i);
 350 }
 351
 352 /** \brief Cb to push an unsigned long integer. Must be attached to the field you want to push
 353  */
 354 void gras_datadesc_cb_push_ulint(gras_datadesc_type_t ignored,
 355                                  gras_cbps_t vars, void *data)
 356 {
 357   unsigned long int *i = (unsigned long int *) data;
 358   gras_cbps_i_push(vars, (int) *i);
 359 }
 360
 361 /* ************************************ */
 362 /* **** PUSHy multiplier callbacks **** */
 363 /* ************************************ */
 364 /** \brief Cb to push an integer as multiplier. Must be attached to the field you want to push */
 365 void gras_datadesc_cb_push_int_mult(gras_datadesc_type_t ignored,
 366                                     gras_cbps_t vars, void *data)
 367 {
 368   int old = *(int *) data;
 369   int new = gras_cbps_i_pop(vars);
 370   XBT_DEBUG("push %d x %d as a size", old, new);
 371   gras_cbps_i_push(vars, old * new);
 372 }
 373
 374 /** \brief Cb to push an unsigned integer as multiplier. Must be attached to the field you want to push */
 375 void gras_datadesc_cb_push_uint_mult(gras_datadesc_type_t ignored,
 376                                      gras_cbps_t vars, void *data)
 377 {
 378   unsigned int old = *(unsigned int *) data;
 379   unsigned int new = gras_cbps_i_pop(vars);
 380
 381   XBT_DEBUG("push %d x %d as a size", old, new);
 382   gras_cbps_i_push(vars, (int) (old * new));
 383 }
 384
 385 /** \brief Cb to push an long integer as multiplier. Must be attached to the field you want to push
 386  */
 387 void gras_datadesc_cb_push_lint_mult(gras_datadesc_type_t ignored,
 388                                      gras_cbps_t vars, void *data)
 389 {
 390   long int i = *(long int *) data;
 391   i *= gras_cbps_i_pop(vars);
 392   gras_cbps_i_push(vars, (int) i);
 393 }
 394
 395 /** \brief Cb to push an unsigned long integer as multiplier. Must be attached to the field you want to push
 396  */
 397 void gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t ignored,
 398                                       gras_cbps_t vars, void *data)
 399 {
 400   unsigned long int old = *(unsigned long int *) data;
 401   unsigned long int new = gras_cbps_i_pop(vars);
 402
 403   XBT_DEBUG("push %ld x %ld as a size", old, new);
 404   gras_cbps_i_push(vars, (int) (old * new));
 405 }