3 /* cbps - persistant states for callbacks */
5 /* Copyright (c) 2003 Olivier Aumage. */
6 /* Copyright (c) 2003, 2004 Martin Quinson. */
7 /* All rights reserved. */
9 /* This program is free software; you can redistribute it and/or modify it
10 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include "gras/DataDesc/datadesc_private.h"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ddt_cbps,datadesc,"callback persistant state");
16 gras_datadesc_type_t type;
18 } s_gras_cbps_elm_t, *gras_cbps_elm_t;
20 typedef struct s_gras_cbps {
21 xbt_dynar_t lints; /* simple stack of long integers (easy interface) */
23 xbt_dict_t space; /* varname x dynar of gras_cbps_elm_t */
24 xbt_dynar_t frames; /* of dynar of names defined within this frame
25 (and to pop when we leave it) */
29 static void free_string(void *d);
31 static void free_string(void *d){
35 gras_cbps_t gras_cbps_new(void) {
38 res=xbt_new(s_gras_cbps_t,1);
40 res->lints = xbt_dynar_new(sizeof(int), NULL);
41 res->space = xbt_dict_new();
42 /* no leak, the content is freed manually on block_end */
43 res->frames = xbt_dynar_new(sizeof(xbt_dynar_t), NULL);
44 res->globals = xbt_dynar_new(sizeof(char*), NULL);
46 gras_cbps_block_begin(res);
51 void gras_cbps_free(gras_cbps_t *state) {
53 xbt_dynar_free( &( (*state)->lints ) );
55 gras_cbps_block_end(*state);
56 xbt_dict_free ( &( (*state)->space ) );
57 xbt_dynar_free( &( (*state)->frames ) );
58 xbt_dynar_free( &( (*state)->globals ) );
64 /** \brief Declare a new element in the PS, and give it a value.
66 * If an element of that
67 * name already exists, it is masked by the one given here, and will be
68 * seeable again only after a pop to remove the value this push adds.
71 gras_cbps_v_push(gras_cbps_t ps,
74 gras_datadesc_type_t ddt) {
76 xbt_dynar_t varstack,frame;
79 char *varname = (char*)strdup(name);
81 DEBUG2("push(%s,%p)",name,(void*)data);
82 errcode = xbt_dict_get(ps->space, name, (void **)&varstack);
84 if (errcode == mismatch_error) {
85 DEBUG1("Create a new variable stack for '%s' into the space",name);
86 varstack = xbt_dynar_new(sizeof (gras_cbps_elm_t *), NULL);
87 xbt_dict_set(ps->space, varname, (void **)varstack, NULL);
88 /* leaking, you think? only if you do not close all the openned blocks ;)*/
89 } else if (errcode != no_error) {
93 var = xbt_new0(s_gras_cbps_elm_t,1);
97 xbt_dynar_push(varstack, &var);
99 xbt_dynar_pop(ps->frames, &frame);
100 DEBUG4("Push %s (%p @%p) into frame %p",varname,(void*)varname,(void*)&varname,(void*)frame);
101 xbt_dynar_push(frame, &varname);
102 xbt_dynar_push(ps->frames, &frame);
106 /** \brief Retrieve an element from the PS, and remove it from the PS.
109 * present in the current block, it will fail (with abort) and not search
110 * in upper blocks since this denotes a programmation error.
113 gras_cbps_v_pop (gras_cbps_t ps,
115 gras_datadesc_type_t *ddt,
117 xbt_dynar_t varstack,frame;
118 gras_cbps_elm_t var = NULL;
122 DEBUG1("pop(%s)",name);
123 /* FIXME: Error handling */
124 errcode = xbt_dict_get(ps->space, name, (void **)&varstack);
125 if (errcode == mismatch_error) {
126 RAISE1(mismatch_error,"Asked to pop the non-existant %s",
129 xbt_dynar_pop(varstack, &var);
131 if (!xbt_dynar_length(varstack)) {
132 DEBUG1("Last incarnation of %s poped. Kill it",name);
133 xbt_dict_remove(ps->space, name);
134 xbt_dynar_free(&varstack);
143 xbt_dynar_pop(ps->frames, &frame);
145 int l = xbt_dynar_length(frame);
150 _name = xbt_dynar_get_as(frame, l, char*);
151 if (!strcmp(name, _name)) {
152 xbt_dynar_remove_at(frame, l, &_name);
158 xbt_dynar_push(ps->frames, &frame);
164 /** \brief Change the value of an element in the PS.
166 * If it's not present in the current block, look in the upper ones.
167 * If it's not present in any of them, modify in the globals
168 * If not present there neither, the code may segfault (Oli?).
170 * Once a reference to an element of that name is found somewhere in the PS,
171 * its value is changed.
174 gras_cbps_v_set (gras_cbps_t ps,
177 gras_datadesc_type_t ddt) {
179 xbt_dynar_t dynar = NULL;
180 gras_cbps_elm_t elm = NULL;
183 DEBUG1("set(%s)",name);
184 errcode = xbt_dict_get(ps->space, name, (void **)&dynar);
186 if (errcode == mismatch_error) {
187 dynar = xbt_dynar_new(sizeof (gras_cbps_elm_t), NULL);
188 xbt_dict_set(ps->space, name, (void **)dynar, NULL);
190 elm = xbt_new0(s_gras_cbps_elm_t,1);
191 xbt_dynar_push(ps->globals, &name);
193 xbt_dynar_pop(dynar, &elm);
199 xbt_dynar_push(dynar, &elm);
203 /** \brief Get the value of an element in the PS without modifying it.
205 * (note that you get the content of the data struct and not a copy to it)
206 * If it's not present in the current block, look in the upper ones.
207 * If it's not present in any of them, look in the globals
208 * If not present there neither, the code may segfault (Oli?).
211 gras_cbps_v_get (gras_cbps_t ps,
213 /* OUT */gras_datadesc_type_t *ddt) {
215 xbt_dynar_t dynar = NULL;
216 gras_cbps_elm_t elm = NULL;
218 DEBUG1("get(%s)",name);
219 /* FIXME: Error handling */
220 xbt_dict_get(ps->space, name, (void **)&dynar);
221 xbt_dynar_pop(dynar, &elm);
222 xbt_dynar_push(dynar, &elm);
232 /** \brief Begins a new block.
234 * Blocks are usefull to remove a whole set of declarations you don't even know
236 * E.g., they constitute an elegent solution to recursive data structures.
238 * push/pop may be used in some cases for that, but if your recursive data
239 * struct contains other structs needing themselves callbacks, you have to
240 * use block_{begin,end} to do the trick.
244 gras_cbps_block_begin(gras_cbps_t ps) {
246 xbt_dynar_t dynar = NULL;
248 DEBUG0(">>> Block begin");
249 dynar = xbt_dynar_new(sizeof (char *), NULL);
250 xbt_dynar_push(ps->frames, &dynar);
253 /** \brief End the current block, and go back to the upper one. */
255 gras_cbps_block_end(gras_cbps_t ps) {
257 xbt_dynar_t frame = NULL;
261 xbt_assert0(xbt_dynar_length(ps->frames),
262 "More block_end than block_begin");
263 xbt_dynar_pop(ps->frames, &frame);
265 xbt_dynar_foreach(frame, cursor, name) {
267 xbt_dynar_t varstack = NULL;
268 gras_cbps_elm_t var = NULL;
270 DEBUG2("Get ride of %s (%p)",name,(void*)name);
271 xbt_dict_get(ps->space, name, (void **)&varstack);
272 xbt_dynar_pop(varstack, &var);
274 if (!xbt_dynar_length(varstack)) {
275 xbt_dict_remove(ps->space, name);
276 xbt_dynar_free_container(&varstack); /*already empty, save a test ;) */
279 if (var->data) free(var->data);
283 xbt_dynar_free_container(&frame);/* we just emptied it */
284 DEBUG0("<<< Block end");
288 /** \brief Push a new integer value into the cbps. */
290 gras_cbps_i_push(gras_cbps_t ps,
292 DEBUG1("push %d as a size",val);
293 xbt_dynar_push_as(ps->lints,int,val);
295 /** \brief Pop the lastly pushed integer value from the cbps. */
297 gras_cbps_i_pop(gras_cbps_t ps) {
300 xbt_assert0(xbt_dynar_length(ps->lints) > 0,
301 "gras_cbps_i_pop: no value to pop");
302 ret = xbt_dynar_pop_as(ps->lints,int);
303 DEBUG1("pop %d as a size",ret);
307 /** \brief Generic cb returning the lastly pushed value
309 * Used by \ref gras_datadesc_ref_pop_arr
311 int gras_datadesc_cb_pop(gras_cbps_t vars, void *data) {
312 return gras_cbps_i_pop(vars);
315 /** \brief Cb to push an integer. Must be attached to the field you want to push */
316 void gras_datadesc_cb_push_int(gras_cbps_t vars, void *data) {
318 gras_cbps_i_push(vars, (int) *i);
321 /** \brief Cb to push an unsigned integer. Must be attached to the field you want to push */
322 void gras_datadesc_cb_push_uint(gras_cbps_t vars, void *data) {
323 unsigned int *i = (unsigned int*)data;
324 gras_cbps_i_push(vars, (int) *i);
327 /** \brief Cb to push an long integer. Must be attached to the field you want to push
329 void gras_datadesc_cb_push_lint(gras_cbps_t vars, void *data) {
330 long int *i = (long int*)data;
331 gras_cbps_i_push(vars, (int) *i);
333 /** \brief Cb to push an long integer. Must be attached to the field you want to push
335 void gras_datadesc_cb_push_ulint(gras_cbps_t vars, void *data) {
336 unsigned long int *i = (unsigned long int*)data;
337 gras_cbps_i_push(vars, (int) *i);