Commit | Line | Data |
1e73acc8 |
1 | #include "EXTERN.h" |
2 | #include "perl.h" |
3 | #include "XSUB.h" |
4 | |
5 | /* support for Hash::Util::FieldHash, prefix HUF_ */ |
6 | |
6ff38c27 |
7 | /* A Perl sub that returns a hashref to the object registry */ |
8 | #define HUF_OB_REG "Hash::Util::FieldHash::_ob_reg" |
d74d639b |
9 | /* Identifier for PERL_MAGIC_ext magic */ |
10 | #define HUF_IDCACHE 0x4944 |
1e73acc8 |
11 | |
1e73acc8 |
12 | /* For global cache of object registry */ |
13 | #define MY_CXT_KEY "Hash::Util::FieldHash::_guts" XS_VERSION |
14 | typedef struct { |
15 | HV* ob_reg; /* Cache object registry */ |
16 | } my_cxt_t; |
17 | START_MY_CXT |
18 | |
6ff38c27 |
19 | /* Inquire the object registry (a lexical hash) from perl */ |
20 | HV* HUF_get_ob_reg(void) { |
21 | dSP; |
91dba0be |
22 | HV* ob_reg = NULL; |
0dbc1c87 |
23 | I32 items; |
91dba0be |
24 | ENTER; |
25 | SAVETMPS; |
26 | |
27 | PUSHMARK(SP); |
0dbc1c87 |
28 | items = call_pv(HUF_OB_REG, G_SCALAR|G_NOARGS); |
6ff38c27 |
29 | SPAGAIN; |
91dba0be |
30 | |
45552c86 |
31 | if (items == 1 && TOPs && SvROK(TOPs) && SvTYPE(SvRV(TOPs)) == SVt_PVHV) |
91dba0be |
32 | ob_reg = (HV*)SvRV(POPs); |
91dba0be |
33 | PUTBACK; |
34 | FREETMPS; |
35 | LEAVE; |
36 | |
45552c86 |
37 | if (!ob_reg) |
38 | Perl_die(aTHX_ "Can't get object registry hash"); |
39 | return ob_reg; |
6ff38c27 |
40 | } |
41 | |
1e73acc8 |
42 | /* Deal with global context */ |
43 | #define HUF_INIT 1 |
44 | #define HUF_CLONE 0 |
45 | #define HUF_RESET -1 |
46 | |
47 | void HUF_global(I32 how) { |
48 | if (how == HUF_INIT) { |
49 | MY_CXT_INIT; |
6ff38c27 |
50 | MY_CXT.ob_reg = HUF_get_ob_reg(); |
1e73acc8 |
51 | } else if (how == HUF_CLONE) { |
52 | MY_CXT_CLONE; |
6ff38c27 |
53 | MY_CXT.ob_reg = HUF_get_ob_reg(); |
1e73acc8 |
54 | } else if (how == HUF_RESET) { |
55 | dMY_CXT; |
6ff38c27 |
56 | MY_CXT.ob_reg = HUF_get_ob_reg(); |
1e73acc8 |
57 | } |
58 | } |
59 | |
d74d639b |
60 | /* Object id */ |
1e73acc8 |
61 | |
d74d639b |
62 | /* definition of id transformation */ |
63 | #define HUF_OBJ_ID(x) newSVuv(PTR2UV(x)) |
1e73acc8 |
64 | |
1e73acc8 |
65 | SV* HUF_obj_id(SV* obj) { |
d74d639b |
66 | SV *item = SvRV(obj); |
67 | MAGIC *mg; |
68 | SV *id; |
69 | |
70 | /* Get cached object ID, if it exists */ |
71 | if (SvTYPE(item) >= SVt_PVMG) { |
72 | for ( mg = SvMAGIC(item); mg; mg = mg->mg_moremagic ) { |
73 | if ((mg->mg_type == PERL_MAGIC_ext) && |
74 | (mg->mg_private == HUF_IDCACHE) |
75 | ) { |
76 | return mg->mg_obj; |
77 | } |
78 | } |
79 | } |
80 | |
81 | /* Create an object ID, cache it */ |
82 | id = HUF_OBJ_ID(item); |
83 | mg = sv_magicext(item, id, PERL_MAGIC_ext, NULL, NULL, 0); |
84 | mg->mg_private = HUF_IDCACHE; |
85 | |
86 | /* Return the object ID */ |
87 | return id; |
1e73acc8 |
88 | } |
89 | |
90 | /* set up uvar magic for any sv */ |
91 | void HUF_add_uvar_magic( |
6ff38c27 |
92 | SV* sv, /* the sv to enchant, visible to get/set */ |
1e73acc8 |
93 | I32(* val)(pTHX_ IV, SV*), /* "get" function */ |
94 | I32(* set)(pTHX_ IV, SV*), /* "set" function */ |
95 | I32 index, /* get/set will see this */ |
96 | SV* thing /* any associated info */ |
97 | ) { |
1e73acc8 |
98 | struct ufuncs uf; |
99 | uf.uf_val = val; |
100 | uf.uf_set = set; |
101 | uf.uf_index = index; |
102 | sv_magic(sv, thing, PERL_MAGIC_uvar, (char*)&uf, sizeof(uf)); |
103 | } |
104 | |
105 | /* Fetch the data container of a trigger */ |
106 | AV* HUF_get_trigger_content(SV* trigger) { |
107 | MAGIC* mg; |
108 | if (trigger && (mg = mg_find(trigger, PERL_MAGIC_uvar))) |
109 | return (AV*)mg->mg_obj; |
110 | return NULL; |
111 | } |
112 | |
113 | /* Delete an object from all field hashes it may occur in. Also delete |
c418a2d4 |
114 | * the object's entry from the object registry. This function goes in |
115 | * the uf_set field of the uvar magic of a trigger. |
1e73acc8 |
116 | */ |
117 | I32 HUF_destroy_obj(pTHX_ IV index, SV* trigger) { |
118 | /* Do nothing if the weakref wasn't undef'd. Also don't bother |
119 | * during global destruction. (MY_CXT.ob_reg is sometimes funny there) */ |
120 | if (!SvROK(trigger) && (!PL_in_clean_all)) { |
121 | dMY_CXT; |
122 | AV* cont = HUF_get_trigger_content(trigger); |
123 | SV* ob_id = *av_fetch(cont, 0, 0); |
124 | HV* field_tab = (HV*) *av_fetch(cont, 1, 0); |
125 | HE* ent; |
126 | hv_iterinit(field_tab); |
127 | while (ent = hv_iternext(field_tab)) { |
128 | SV* field_ref = HeVAL(ent); |
129 | SV* field = SvRV(field_ref); |
130 | hv_delete_ent((HV*)field, ob_id, G_DISCARD, 0); |
131 | } |
132 | /* make it safe in case we must run in global clenaup, after all */ |
133 | if (PL_in_clean_all) |
d74d639b |
134 | HUF_global(HUF_RESET); /* shoudn't be needed */ |
1e73acc8 |
135 | hv_delete_ent(MY_CXT.ob_reg, ob_id, G_DISCARD, 0); |
136 | } |
137 | return 0; |
138 | } |
139 | |
d74d639b |
140 | /* Create a trigger for an object. The trigger is a magical SV |
141 | * that holds a weak ref to the object. The magic fires when the object |
142 | * expires and takes care of garbage collection in registred hashes. |
143 | * For that purpose, the magic structure holds the original id of |
144 | * the object, and a list (a hash, really) of hashes from which the |
145 | * object may * have to be deleted. The trigger is stored in the |
146 | * object registry and is also deleted when the object expires. |
1e73acc8 |
147 | */ |
148 | SV* HUF_new_trigger(SV* obj, SV* ob_id) { |
149 | dMY_CXT; |
150 | SV* trigger = sv_rvweaken(newRV_inc(SvRV(obj))); |
151 | AV* cont = newAV(); |
152 | sv_2mortal((SV*)cont); |
153 | av_store(cont, 0, SvREFCNT_inc(ob_id)); |
154 | av_store(cont, 1, (SV*)newHV()); |
155 | HUF_add_uvar_magic(trigger, NULL, &HUF_destroy_obj, 0, (SV*)cont); |
156 | hv_store_ent(MY_CXT.ob_reg, ob_id, trigger, 0); |
157 | return trigger; |
158 | } |
159 | |
160 | /* retrieve a trigger for obj if one exists, return NULL otherwise */ |
161 | SV* HUF_ask_trigger(SV* ob_id) { |
162 | dMY_CXT; |
163 | HE* ent; |
164 | if (ent = hv_fetch_ent(MY_CXT.ob_reg, ob_id, 0, 0)) |
165 | return HeVAL(ent); |
166 | return NULL; |
167 | } |
168 | |
169 | /* get the trigger for an object, creating it if necessary */ |
d74d639b |
170 | SV* HUF_get_trigger0(SV* obj, SV* ob_id) { |
1e73acc8 |
171 | SV* trigger; |
172 | if (!(trigger = HUF_ask_trigger(ob_id))) |
173 | trigger = HUF_new_trigger(obj, ob_id); |
174 | return trigger; |
175 | } |
176 | |
d74d639b |
177 | SV* HUF_get_trigger(SV* obj, SV* ob_id) { |
178 | SV* trigger = HUF_ask_trigger(ob_id); |
179 | if (!trigger) |
180 | trigger = HUF_new_trigger(obj, ob_id); |
181 | return( trigger); |
182 | } |
183 | |
184 | /* mark an object (trigger) as having been used with a field |
185 | (a clenup-liability) |
186 | */ |
1e73acc8 |
187 | void HUF_mark_field(SV* trigger, SV* field) { |
188 | AV* cont = HUF_get_trigger_content(trigger); |
189 | HV* field_tab = (HV*) *av_fetch(cont, 1, 0); |
190 | SV* field_ref = newRV_inc(field); |
d74d639b |
191 | UV field_addr = PTR2UV(field); |
192 | hv_store(field_tab, (char *)&field_addr, sizeof(field_addr), field_ref, 0); |
1e73acc8 |
193 | } |
194 | |
d74d639b |
195 | /* Determine, from the value of action, whether this call may create a new |
196 | * hash key */ |
324a0d18 |
197 | #define HUF_WOULD_CREATE_KEY(x) ((x) != HV_DELETE && ((x) & (HV_FETCH_ISSTORE | HV_FETCH_LVALUE))) |
a607227a |
198 | |
d74d639b |
199 | /* The key exchange functions. They communicate with S_hv_magic_uvar_xkey |
1e73acc8 |
200 | * in hv.c */ |
d74d639b |
201 | I32 HUF_watch_key_safe(pTHX_ IV action, SV* field) { |
1e73acc8 |
202 | MAGIC* mg = mg_find(field, PERL_MAGIC_uvar); |
6ff38c27 |
203 | SV* keysv; |
d74d639b |
204 | if (mg && (keysv = mg->mg_obj)) { |
205 | if (SvROK(keysv)) { /* ref key */ |
45552c86 |
206 | SV* ob_id = HUF_obj_id(keysv); |
207 | mg->mg_obj = ob_id; /* key replacement */ |
208 | if (HUF_WOULD_CREATE_KEY(action)) { |
209 | SV* trigger = HUF_get_trigger(keysv, ob_id); |
210 | HUF_mark_field(trigger, field); |
211 | } |
d74d639b |
212 | } else if (HUF_WOULD_CREATE_KEY(action)) { /* string key */ |
213 | /* registered as object id? */ |
214 | SV* trigger; |
215 | if ( trigger = HUF_ask_trigger(keysv)) |
216 | HUF_mark_field( trigger, field); |
a607227a |
217 | } |
45552c86 |
218 | } else { |
d74d639b |
219 | Perl_die(aTHX_ "Rogue call of 'HUF_watch_key_safe'"); |
220 | } |
221 | return 0; |
222 | } |
223 | |
224 | I32 HUF_watch_key_id(pTHX_ IV action, SV* field) { |
225 | MAGIC* mg = mg_find(field, PERL_MAGIC_uvar); |
226 | SV* keysv; |
227 | if (mg && (keysv = mg->mg_obj)) { |
228 | if (SvROK(keysv)) /* ref key */ |
229 | mg->mg_obj = HUF_obj_id(keysv); /* key replacement */ |
230 | } else { |
231 | Perl_die(aTHX_ "Rogue call of 'HUF_watch_key_id'"); |
1e73acc8 |
232 | } |
233 | return 0; |
234 | } |
235 | |
3ae03d21 |
236 | /* see if something is a field hash */ |
237 | int HUF_get_status(HV* hash) { |
238 | int ans = 0; |
239 | if (hash && (SvTYPE(hash) == SVt_PVHV)) { |
240 | MAGIC* mg; |
241 | struct ufuncs* uf; |
242 | if ((mg = mg_find((SV*)hash, PERL_MAGIC_uvar)) && |
243 | (uf = (struct ufuncs *)mg->mg_ptr) && |
244 | (uf->uf_set == NULL) |
245 | ) { |
246 | ans = HUF_func_2mode(uf->uf_val); |
247 | } |
248 | } |
249 | return ans; |
250 | } |
251 | |
d74d639b |
252 | int HUF_func_2mode( I32(* val)(pTHX_ IV, SV*)) { |
253 | int ans = 0; |
254 | if (val == &HUF_watch_key_id) |
255 | ans = 1; |
256 | if (val == &HUF_watch_key_safe) |
257 | ans = 2; |
258 | return(ans); |
259 | } |
260 | |
261 | I32(* HUF_mode_2func( int mode))(pTHX_ IV, SV*) { |
262 | I32(* ans)(pTHX_ IV, SV*) = NULL; |
263 | switch (mode) { |
264 | case 1: |
265 | ans = &HUF_watch_key_id; |
266 | break; |
267 | case 2: |
268 | ans = &HUF_watch_key_safe; |
269 | break; |
270 | } |
271 | return(ans); |
272 | } |
273 | |
1e73acc8 |
274 | /* Thread support. These routines are called by CLONE (and nothing else) */ |
275 | |
276 | /* Fix entries for one object in all field hashes */ |
277 | void HUF_fix_trigger(SV* trigger, SV* new_id) { |
278 | AV* cont = HUF_get_trigger_content(trigger); |
279 | HV* field_tab = (HV*) *av_fetch(cont, 1, 0); |
280 | HV* new_tab = newHV(); |
281 | HE* ent; |
282 | SV* old_id = *av_fetch(cont, 0, 0); |
283 | hv_iterinit(field_tab); |
284 | while (ent = hv_iternext(field_tab)) { |
285 | SV* field_ref = HeVAL(ent); |
1e73acc8 |
286 | HV* field = (HV*)SvRV(field_ref); |
d74d639b |
287 | UV field_addr = PTR2UV(field); |
1e73acc8 |
288 | SV* val; |
289 | /* recreate field tab entry */ |
d74d639b |
290 | hv_store(new_tab, (char *)&field_addr, sizeof(field_addr), SvREFCNT_inc(field_ref), 0); |
1e73acc8 |
291 | /* recreate field entry, if any */ |
292 | if (val = hv_delete_ent(field, old_id, 0, 0)) |
293 | hv_store_ent(field, new_id, SvREFCNT_inc(val), 0); |
294 | } |
295 | /* update the trigger */ |
296 | av_store(cont, 0, SvREFCNT_inc(new_id)); |
297 | av_store(cont, 1, (SV*)new_tab); |
298 | } |
299 | |
300 | /* Go over object registry and fix all objects. Also fix the object |
301 | * registry. |
302 | */ |
ce809d1f |
303 | void HUF_fix_objects(void) { |
1e73acc8 |
304 | dMY_CXT; |
305 | I32 i, len; |
306 | HE* ent; |
307 | AV* oblist = (AV*)sv_2mortal((SV*)newAV()); |
308 | hv_iterinit(MY_CXT.ob_reg); |
309 | while(ent = hv_iternext(MY_CXT.ob_reg)) |
310 | av_push(oblist, SvREFCNT_inc(hv_iterkeysv(ent))); |
311 | len = av_len(oblist); |
312 | for (i = 0; i <= len; ++i) { |
313 | SV* old_id = *av_fetch(oblist, i, 0); |
314 | SV* trigger = hv_delete_ent(MY_CXT.ob_reg, old_id, 0, 0); |
d74d639b |
315 | SV* obj = SvRV(trigger); |
316 | MAGIC *mg; |
317 | |
318 | SV* new_id = HUF_OBJ_ID(obj); |
319 | |
320 | /* Replace cached object ID with this new one */ |
321 | for (mg = SvMAGIC(obj); mg; mg = mg->mg_moremagic) { |
322 | if ((mg->mg_type == PERL_MAGIC_ext) && |
323 | (mg->mg_private == HUF_IDCACHE) |
324 | ) { |
325 | mg->mg_obj = new_id; |
326 | } |
327 | } |
328 | |
1e73acc8 |
329 | HUF_fix_trigger(trigger, new_id); |
330 | hv_store_ent(MY_CXT.ob_reg, new_id, SvREFCNT_inc(trigger), 0); |
331 | } |
332 | } |
333 | |
334 | /* test support (not needed for functionality) */ |
335 | |
336 | static SV* counter; |
1748121c |
337 | I32 HUF_inc_var(pTHX_ IV index, SV* which) { |
1e73acc8 |
338 | sv_setiv(counter, 1 + SvIV(counter)); |
339 | return 0; |
340 | } |
341 | |
342 | MODULE = Hash::Util::FieldHash PACKAGE = Hash::Util::FieldHash |
343 | |
344 | BOOT: |
345 | { |
346 | HUF_global(HUF_INIT); /* create variables */ |
347 | } |
348 | |
349 | int |
350 | _fieldhash(SV* href, int mode) |
351 | PROTOTYPE: $$ |
352 | CODE: |
353 | HV* field; |
354 | RETVAL = 0; |
355 | if (mode && |
356 | href && SvROK(href) && |
357 | (field = (HV*)SvRV(href)) && |
358 | SvTYPE(field) == SVt_PVHV |
359 | ) { |
d74d639b |
360 | |
1e73acc8 |
361 | HUF_add_uvar_magic( |
362 | SvRV(href), |
d74d639b |
363 | HUF_mode_2func( mode), |
1e73acc8 |
364 | NULL, |
365 | 0, |
366 | NULL |
367 | ); |
368 | RETVAL = HUF_get_status(field); |
369 | } |
370 | OUTPUT: |
371 | RETVAL |
372 | |
373 | void |
d74d639b |
374 | id(SV* ref) |
3ae03d21 |
375 | PROTOTYPE: $ |
d74d639b |
376 | PPCODE: |
377 | if (SvROK(ref)) { |
378 | XPUSHs(HUF_obj_id(ref)); |
379 | } else { |
380 | XPUSHs(ref); |
381 | } |
382 | |
383 | SV* |
384 | id_2obj(SV* id) |
385 | PROTOTYPE: $ |
386 | CODE: |
387 | SV* obj = HUF_ask_trigger(id); |
388 | if (obj) { |
389 | RETVAL = newRV_inc(SvRV(obj)); |
390 | } else { |
391 | RETVAL = &PL_sv_undef; |
392 | } |
393 | OUTPUT: |
394 | RETVAL |
395 | |
396 | SV* |
397 | register(SV* obj, ...) |
398 | PROTOTYPE: $@ |
399 | CODE: |
400 | SV* trigger; |
401 | int i; |
402 | RETVAL = NULL; |
403 | if (!SvROK(obj)) { |
404 | Perl_die(aTHX_ "Attempt to register a non-ref"); |
405 | } else { |
406 | RETVAL = newRV_inc(SvRV(obj)); |
407 | } |
408 | trigger = HUF_get_trigger(obj, HUF_obj_id(obj)); |
409 | for (i = 1; i < items; ++ i) { |
410 | SV* field_ref = POPs; |
411 | if (SvROK(field_ref) && (SvTYPE(SvRV(field_ref)) == SVt_PVHV)) { |
412 | HUF_mark_field(trigger, SvRV(field_ref)); |
413 | } |
414 | } |
415 | OUTPUT: |
416 | RETVAL |
417 | |
418 | void |
87d46f97 |
419 | CLONE(char* classname) |
1e73acc8 |
420 | CODE: |
87d46f97 |
421 | if (0 == strcmp(classname, "Hash::Util::FieldHash")) { |
1e73acc8 |
422 | HUF_global(HUF_CLONE); |
423 | HUF_fix_objects(); |
424 | } |
425 | |
c418a2d4 |
426 | void |
1e73acc8 |
427 | _active_fields(SV* obj) |
428 | PPCODE: |
429 | if (SvROK(obj)) { |
430 | SV* ob_id = HUF_obj_id(obj); |
431 | SV* trigger = HUF_ask_trigger(ob_id); |
432 | if (trigger) { |
433 | AV* cont = HUF_get_trigger_content(trigger); |
434 | HV* field_tab = (HV*) *av_fetch(cont, 1, 0); |
435 | HE* ent; |
436 | hv_iterinit(field_tab); |
437 | while (ent = hv_iternext(field_tab)) { |
438 | HV* field = (HV*)SvRV(HeVAL(ent)); |
439 | if (hv_exists_ent(field, ob_id, 0)) |
440 | XPUSHs(sv_2mortal(newRV_inc((SV*)field))); |
441 | } |
442 | } |
443 | } |
444 | |
445 | void |
446 | _test_uvar_get(SV* svref, SV* countref) |
447 | CODE: |
448 | if (SvROK(svref) && SvROK(countref)) { |
449 | counter = SvRV(countref); |
450 | sv_setiv(counter, 0); |
451 | HUF_add_uvar_magic( |
452 | SvRV(svref), |
453 | &HUF_inc_var, |
454 | NULL, |
455 | 0, |
456 | SvRV(countref) |
457 | ); |
458 | } |
459 | |
460 | void |
461 | _test_uvar_set(SV* svref, SV* countref) |
462 | CODE: |
463 | if (SvROK(svref) && SvROK(countref)) { |
464 | counter = SvRV(countref); |
465 | sv_setiv(counter, 0); |
466 | counter = SvRV(countref); |
467 | HUF_add_uvar_magic( |
468 | SvRV(svref), |
469 | NULL, |
470 | &HUF_inc_var, |
471 | 0, |
472 | SvRV(countref) |
473 | ); |
474 | } |
475 | |
476 | void |
477 | _test_uvar_same(SV* svref, SV* countref) |
478 | CODE: |
479 | if (SvROK(svref) && SvROK(countref)) { |
480 | counter = SvRV(countref); |
481 | sv_setiv(counter, 0); |
482 | HUF_add_uvar_magic( |
483 | SvRV(svref), |
484 | &HUF_inc_var, |
485 | &HUF_inc_var, |
486 | 0, |
487 | NULL |
488 | ); |
489 | } |
490 | |