1 /* cbps - persistant states for callbacks */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
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. */
10 #include "gras/DataDesc/datadesc_private.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_ddt_cbps, gras_ddt,
12 "callback persistant state");
15 gras_datadesc_type_t type;
17 } s_gras_cbps_elm_t, *gras_cbps_elm_t;
19 typedef struct s_gras_cbps {
20 xbt_dynar_t lints; /* simple stack of long integers (easy interface) */
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) */
28 gras_cbps_t gras_cbps_new(void)
32 res = xbt_new(s_gras_cbps_t, 1);
34 res->lints = xbt_dynar_new(sizeof(int), NULL);
35 res->space = xbt_dict_new();
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);
40 gras_cbps_block_begin(res);
45 void gras_cbps_free(gras_cbps_t * state)
48 xbt_dynar_free(&((*state)->lints));
50 gras_cbps_block_end(*state);
51 xbt_dict_free(&((*state)->space));
52 xbt_dynar_free(&((*state)->frames));
53 xbt_dynar_free(&((*state)->globals));
59 void gras_cbps_reset(gras_cbps_t state)
62 xbt_dynar_reset(state->lints);
64 xbt_dict_reset(state->space);
66 xbt_dynar_reset(state->frames);
67 xbt_dynar_reset(state->globals);
70 /** \brief Declare a new element in the PS, and give it a value.
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.
77 gras_cbps_v_push(gras_cbps_t ps,
78 const char *name, void *data, gras_datadesc_type_t ddt)
81 xbt_dynar_t varstack = NULL, frame;
83 char *varname = (char *) xbt_strdup(name);
86 DEBUG2("push(%s,%p)", name, (void *) data);
89 varstack = xbt_dict_get(ps->space, name);
91 if (e.category != mismatch_error)
94 DEBUG1("Create a new variable stack for '%s' into the space", name);
95 varstack = xbt_dynar_new(sizeof(gras_cbps_elm_t *), NULL);
96 xbt_dict_set(ps->space, varname, (void **) varstack, NULL);
98 /* leaking, you think? only if you do not close all the openned blocks ;) */
101 var = xbt_new0(s_gras_cbps_elm_t, 1);
105 xbt_dynar_push(varstack, &var);
107 xbt_dynar_pop(ps->frames, &frame);
108 DEBUG4("Push %s (%p @%p) into frame %p", varname, (void *) varname,
109 (void *) &varname, (void *) frame);
110 xbt_dynar_push(frame, &varname);
111 xbt_dynar_push(ps->frames, &frame);
114 /** \brief Retrieve an element from the PS, and remove it from the PS.
116 * If it's not present in the current block, it will fail (throwing not_found)
117 * and not search in upper blocks since this denotes a programmation error.
120 gras_cbps_v_pop(gras_cbps_t ps,
121 const char *name, gras_datadesc_type_t * ddt, void **res)
123 xbt_dynar_t varstack = NULL, frame = NULL;
124 gras_cbps_elm_t var = NULL;
128 DEBUG1("pop(%s)", name);
130 varstack = xbt_dict_get(ps->space, name);
132 if (e.category != mismatch_error)
136 THROW1(not_found_error, 1, "Asked to pop the non-existant %s", name);
138 xbt_dynar_pop(varstack, &var);
140 if (!xbt_dynar_length(varstack)) {
141 DEBUG1("Last incarnation of %s poped. Kill it", name);
142 xbt_dict_remove(ps->space, name);
143 xbt_dynar_free(&varstack);
152 xbt_dynar_pop(ps->frames, &frame);
154 int l = xbt_dynar_length(frame);
159 _name = xbt_dynar_get_as(frame, l, char *);
160 if (!strcmp(name, _name)) {
161 xbt_dynar_remove_at(frame, l, &_name);
167 xbt_dynar_push(ps->frames, &frame);
172 /** \brief Change the value of an element in the PS.
174 * If it's not present in the current block, look in the upper ones.
175 * If it's not present in any of them, modify in the globals
176 * If not present there neither, the code may segfault (Oli?).
178 * Once a reference to an element of that name is found somewhere in the PS,
179 * its value is changed.
182 gras_cbps_v_set(gras_cbps_t ps,
183 const char *name, void *data, gras_datadesc_type_t ddt)
186 xbt_dynar_t dynar = NULL;
187 gras_cbps_elm_t elm = NULL;
189 DEBUG1("set(%s)", name);
190 dynar = xbt_dict_get_or_null(ps->space, name);
193 dynar = xbt_dynar_new(sizeof(gras_cbps_elm_t), NULL);
194 xbt_dict_set(ps->space, name, (void **) dynar, NULL);
196 elm = xbt_new0(s_gras_cbps_elm_t, 1);
197 xbt_dynar_push(ps->globals, &name);
199 xbt_dynar_pop(dynar, &elm);
205 xbt_dynar_push(dynar, &elm);
209 /** \brief Get the value of an element in the PS without modifying it.
211 * (note that you get the content of the data struct and not a copy to it)
212 * If it's not present in the current block, look in the upper ones.
213 * If it's not present in any of them, look in the globals
214 * If not present there neither, the code may segfault (Oli?).
216 void *gras_cbps_v_get(gras_cbps_t ps, const char *name,
217 /* OUT */ gras_datadesc_type_t * ddt)
220 xbt_dynar_t dynar = NULL;
221 gras_cbps_elm_t elm = NULL;
223 DEBUG1("get(%s)", name);
224 dynar = xbt_dict_get(ps->space, name);
225 xbt_dynar_pop(dynar, &elm);
226 xbt_dynar_push(dynar, &elm);
236 /** \brief Begins a new block.
238 * Blocks are usefull to remove a whole set of declarations you don't even know
240 * E.g., they constitute an elegent solution to recursive data structures.
242 * push/pop may be used in some cases for that, but if your recursive data
243 * struct contains other structs needing themselves callbacks, you have to
244 * use block_{begin,end} to do the trick.
247 void gras_cbps_block_begin(gras_cbps_t ps)
250 xbt_dynar_t dynar = NULL;
252 DEBUG0(">>> Block begin");
253 dynar = xbt_dynar_new(sizeof(char *), NULL);
254 xbt_dynar_push(ps->frames, &dynar);
257 /** \brief End the current block, and go back to the upper one. */
258 void gras_cbps_block_end(gras_cbps_t ps)
261 xbt_dynar_t frame = NULL;
262 unsigned int cursor = 0;
265 xbt_assert0(xbt_dynar_length(ps->frames),
266 "More block_end than block_begin");
267 xbt_dynar_pop(ps->frames, &frame);
269 xbt_dynar_foreach(frame, cursor, name) {
271 xbt_dynar_t varstack = NULL;
272 gras_cbps_elm_t var = NULL;
274 DEBUG2("Get ride of %s (%p)", name, (void *) name);
275 varstack = xbt_dict_get(ps->space, name);
276 xbt_dynar_pop(varstack, &var);
278 if (!xbt_dynar_length(varstack)) {
279 xbt_dict_remove(ps->space, name);
280 xbt_dynar_free_container(&varstack); /*already empty, save a test ;) */
288 xbt_dynar_free_container(&frame); /* we just emptied it */
289 DEBUG0("<<< Block end");
293 /** \brief Push a new integer value into the cbps. */
294 void gras_cbps_i_push(gras_cbps_t ps, int val)
296 DEBUG1("push %d as a size", val);
297 xbt_dynar_push_as(ps->lints, int, val);
300 /** \brief Pop the lastly pushed integer value from the cbps. */
301 int gras_cbps_i_pop(gras_cbps_t ps)
305 xbt_assert0(xbt_dynar_length(ps->lints) > 0,
306 "gras_cbps_i_pop: no value to pop");
307 ret = xbt_dynar_pop_as(ps->lints, int);
308 DEBUG1("pop %d as a size", ret);
312 /** \brief Generic cb returning the lastly pushed value
314 * Used by \ref gras_datadesc_ref_pop_arr
316 int gras_datadesc_cb_pop(gras_datadesc_type_t ignored, gras_cbps_t vars,
319 return gras_cbps_i_pop(vars);
322 /* ************************* */
323 /* **** PUSHy callbacks **** */
324 /* ************************* */
326 /** \brief Cb to push an integer. Must be attached to the field you want to push */
327 void gras_datadesc_cb_push_int(gras_datadesc_type_t ignored,
328 gras_cbps_t vars, void *data)
330 int *i = (int *) data;
331 gras_cbps_i_push(vars, (int) *i);
334 /** \brief Cb to push an unsigned integer. Must be attached to the field you want to push */
335 void gras_datadesc_cb_push_uint(gras_datadesc_type_t ignored,
336 gras_cbps_t vars, void *data)
338 unsigned int *i = (unsigned int *) data;
339 gras_cbps_i_push(vars, (int) *i);
342 /** \brief Cb to push an long integer. Must be attached to the field you want to push
344 void gras_datadesc_cb_push_lint(gras_datadesc_type_t ignored,
345 gras_cbps_t vars, void *data)
347 long int *i = (long int *) data;
348 gras_cbps_i_push(vars, (int) *i);
351 /** \brief Cb to push an unsigned long integer. Must be attached to the field you want to push
353 void gras_datadesc_cb_push_ulint(gras_datadesc_type_t ignored,
354 gras_cbps_t vars, void *data)
356 unsigned long int *i = (unsigned long int *) data;
357 gras_cbps_i_push(vars, (int) *i);
360 /* ************************************ */
361 /* **** PUSHy multiplier callbacks **** */
362 /* ************************************ */
363 /** \brief Cb to push an integer as multiplier. Must be attached to the field you want to push */
364 void gras_datadesc_cb_push_int_mult(gras_datadesc_type_t ignored,
365 gras_cbps_t vars, void *data)
367 int old = *(int *) data;
368 int new = gras_cbps_i_pop(vars);
369 DEBUG2("push %d x %d as a size", old, new);
370 gras_cbps_i_push(vars, old * new);
373 /** \brief Cb to push an unsigned integer as multiplier. Must be attached to the field you want to push */
374 void gras_datadesc_cb_push_uint_mult(gras_datadesc_type_t ignored,
375 gras_cbps_t vars, void *data)
377 unsigned int old = *(unsigned int *) data;
378 unsigned int new = gras_cbps_i_pop(vars);
380 DEBUG2("push %d x %d as a size", old, new);
381 gras_cbps_i_push(vars, (int) (old * new));
384 /** \brief Cb to push an long integer as multiplier. Must be attached to the field you want to push
386 void gras_datadesc_cb_push_lint_mult(gras_datadesc_type_t ignored,
387 gras_cbps_t vars, void *data)
389 long int i = *(long int *) data;
390 i *= gras_cbps_i_pop(vars);
391 gras_cbps_i_push(vars, (int) i);
394 /** \brief Cb to push an unsigned long integer as multiplier. Must be attached to the field you want to push
396 void gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t ignored,
397 gras_cbps_t vars, void *data)
399 unsigned long int old = *(unsigned long int *) data;
400 unsigned long int new = gras_cbps_i_pop(vars);
402 DEBUG2("push %ld x %ld as a size", old, new);
403 gras_cbps_i_push(vars, (int) (old * new));