1 #define PERL_NO_GET_CONTEXT
8 /* Not yet in ppport.h */
10 # define CvISXSUB(cv) (CvXSUB(cv) ? TRUE : FALSE)
13 # define SvRV_const(rv) SvRV(rv)
17 /* "structured exception" handling is a Microsoft extension to C and C++.
18 It's *not* C++ exception handling - C++ exception handling can't capture
19 SEGVs and suchlike, whereas this can. There's no known analagous
20 functionality on other platforms. */
22 # define TRY_TO_CATCH_SEGV __try
23 # define CAUGHT_EXCEPTION __except(EXCEPTION EXCEPTION_EXECUTE_HANDLER)
25 # define TRY_TO_CATCH_SEGV if(1)
26 # define CAUGHT_EXCEPTION else
30 # define __attribute__(x)
33 #if 0 && defined(DEBUGGING)
34 #define dbg_printf(x) printf x
39 #define TAG /* printf( "# %s(%d)\n", __FILE__, __LINE__ ) */
42 /* The idea is to have a tree structure to store 1 bit per possible pointer
43 address. The lowest 16 bits are stored in a block of 8092 bytes.
44 The blocks are in a 256-way tree, indexed by the reset of the pointer.
45 This can cope with 32 and 64 bit pointers, and any address space layout,
46 without excessive memory needs. The assumption is that your CPU cache
47 works :-) (And that we're not going to bust it) */
50 #define LEAF_BITS (16 - BYTE_BITS)
51 #define LEAF_MASK 0x1FFF
59 /* My hunch (not measured) is that for most architectures pointers will
60 start with 0 bits, hence the start of this array will be hot, and the
61 end unused. So put the flags next to the hot end. */
66 Checks to see if thing is in the bitstring.
67 Returns true or false, and
68 notes thing in the segmented bitstring.
71 check_new(struct state *st, const void *const p) {
72 unsigned int bits = 8 * sizeof(void*);
73 const size_t raw_p = PTR2nat(p);
74 /* This effectively rotates the value right by the number of low always-0
75 bits in an aligned pointer. The assmption is that most (if not all)
76 pointers are aligned, and these will be in the same chain of nodes
77 (and hence hot in the cache) but we can still deal with any unaligned
80 = (raw_p >> ALIGN_BITS) | (raw_p << (bits - ALIGN_BITS));
81 const U8 this_bit = 1 << (cooked_p & 0x7);
85 void **tv_p = (void **) (st->tracking);
87 if (NULL == p) return FALSE;
89 const char c = *(const char *)p;
93 warn( "Devel::Size: Encountered invalid pointer: %p\n", p );
99 /* bits now 24 (32 bit pointers) or 56 (64 bit pointers) */
101 /* First level is always present. */
103 i = (unsigned int)((cooked_p >> bits) & 0xFF);
105 Newxz(tv_p[i], 256, void *);
106 tv_p = (void **)(tv_p[i]);
108 } while (bits > LEAF_BITS + BYTE_BITS);
109 /* bits now 16 always */
110 #if !defined(MULTIPLICITY) || PERL_VERSION > 8 || (PERL_VERSION == 8 && PERL_SUBVERSION > 8)
111 /* 5.8.8 and early have an assert() macro that uses Perl_croak, hence needs
112 a my_perl under multiplicity */
115 leaf_p = (U8 **)tv_p;
116 i = (unsigned int)((cooked_p >> bits) & 0xFF);
118 Newxz(leaf_p[i], 1 << LEAF_BITS, U8);
123 i = (unsigned int)((cooked_p >> BYTE_BITS) & LEAF_MASK);
125 if(leaf[i] & this_bit)
133 free_tracking_at(void **tv, int level)
141 free_tracking_at(tv[i], level);
155 free_state(struct state *st)
157 const int top_level = (sizeof(void *) * 8 - LEAF_BITS - BYTE_BITS) / 8;
158 free_tracking_at((void **)st->tracking, top_level);
162 /* For now, this is somewhat a compatibility bodge until the plan comes
163 together for fine grained recursion control. total_size() would recurse into
164 hash and array members, whereas sv_size() would not. However, sv_size() is
165 called with CvSTASH() of a CV, which means that if it (also) starts to
166 recurse fully, then the size of any CV now becomes the size of the entire
167 symbol table reachable from it, and potentially the entire symbol table, if
168 any subroutine makes a reference to a global (such as %SIG). The historical
169 implementation of total_size() didn't report "everything", and changing the
170 only available size to "everything" doesn't feel at all useful. */
172 #define NO_RECURSION 0
173 #define SOME_RECURSION 1
174 #define TOTAL_SIZE_RECURSION 2
176 static bool sv_size(pTHX_ struct state *, const SV *const, const int recurse);
194 cc_opclass(const OP * const o)
200 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
202 if (o->op_type == OP_SASSIGN)
203 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
206 if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_AELEMFAST)
210 if ((o->op_type == OP_TRANS)) {
214 switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
239 case OA_PVOP_OR_SVOP: TAG;
241 * Character translations (tr///) are usually a PVOP, keeping a
242 * pointer to a table of shorts used to look up translations.
243 * Under utf8, however, a simple table isn't practical; instead,
244 * the OP is an SVOP, and the SV is a reference to a swash
245 * (i.e., an RV pointing to an HV).
247 return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF))
248 ? OPc_SVOP : OPc_PVOP;
256 case OA_BASEOP_OR_UNOP: TAG;
258 * UNI(OP_foo) in toke.c returns token UNI or FUNC1 depending on
259 * whether parens were seen. perly.y uses OPf_SPECIAL to
260 * signal whether a BASEOP had empty parens or none.
261 * Some other UNOPs are created later, though, so the best
262 * test is OPf_KIDS, which is set in newUNOP.
264 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
266 case OA_FILESTATOP: TAG;
268 * The file stat OPs are created via UNI(OP_foo) in toke.c but use
269 * the OPf_REF flag to distinguish between OP types instead of the
270 * usual OPf_SPECIAL flag. As usual, if OPf_KIDS is set, then we
271 * return OPc_UNOP so that walkoptree can find our children. If
272 * OPf_KIDS is not set then we check OPf_REF. Without OPf_REF set
273 * (no argument to the operator) it's an OP; with OPf_REF set it's
274 * an SVOP (and op_sv is the GV for the filehandle argument).
276 return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
278 (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
280 (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
282 case OA_LOOPEXOP: TAG;
284 * next, last, redo, dump and goto use OPf_SPECIAL to indicate that a
285 * label was omitted (in which case it's a BASEOP) or else a term was
286 * seen. In this last case, all except goto are definitely PVOP but
287 * goto is either a PVOP (with an ordinary constant label), an UNOP
288 * with OPf_STACKED (with a non-constant non-sub) or an UNOP for
289 * OP_REFGEN (with goto &sub) in which case OPf_STACKED also seems to
292 if (o->op_flags & OPf_STACKED)
294 else if (o->op_flags & OPf_SPECIAL)
299 warn("Devel::Size: Can't determine class of operator %s, assuming BASEOP\n",
300 PL_op_name[o->op_type]);
311 /* Figure out how much magic is attached to the SV and return the
314 magic_size(pTHX_ const SV * const thing, struct state *st) {
315 MAGIC *magic_pointer = SvMAGIC(thing);
317 /* Have we seen the magic pointer? (NULL has always been seen before) */
318 while (check_new(st, magic_pointer)) {
319 st->total_size += sizeof(MAGIC);
322 /* Have we seen the magic vtable? */
323 if (check_new(st, magic_pointer->mg_virtual)) {
324 st->total_size += sizeof(MGVTBL);
326 sv_size(aTHX_ st, magic_pointer->mg_obj, TOTAL_SIZE_RECURSION);
327 if (magic_pointer->mg_len == HEf_SVKEY) {
328 sv_size(aTHX_ st, (SV *)magic_pointer->mg_ptr, TOTAL_SIZE_RECURSION);
330 #if defined(PERL_MAGIC_utf8) && defined (PERL_MAGIC_UTF8_CACHESIZE)
331 else if (magic_pointer->mg_type == PERL_MAGIC_utf8) {
332 if (check_new(st, magic_pointer->mg_ptr)) {
333 st->total_size += PERL_MAGIC_UTF8_CACHESIZE * 2 * sizeof(STRLEN);
337 else if (magic_pointer->mg_len > 0) {
338 if (check_new(st, magic_pointer->mg_ptr)) {
339 st->total_size += magic_pointer->mg_len;
343 /* Get the next in the chain */
344 magic_pointer = magic_pointer->mg_moremagic;
347 if (st->dangle_whine)
348 warn( "Devel::Size: Encountered bad magic at: %p\n", magic_pointer );
354 check_new_and_strlen(struct state *st, const char *const p) {
356 st->total_size += 1 + strlen(p);
360 regex_size(const REGEXP * const baseregex, struct state *st) {
361 if(!check_new(st, baseregex))
363 st->total_size += sizeof(REGEXP);
364 #if (PERL_VERSION < 11)
365 /* Note the size of the paren offset thing */
366 st->total_size += sizeof(I32) * baseregex->nparens * 2;
367 st->total_size += strlen(baseregex->precomp);
369 st->total_size += sizeof(struct regexp);
370 st->total_size += sizeof(I32) * SvANY(baseregex)->nparens * 2;
371 /*st->total_size += strlen(SvANY(baseregex)->subbeg);*/
373 if (st->go_yell && !st->regex_whine) {
374 carp("Devel::Size: Calculated sizes for compiled regexes are incompatible, and probably always will be");
380 op_size(pTHX_ const OP * const baseop, struct state *st)
384 if(!check_new(st, baseop))
387 op_size(aTHX_ baseop->op_next, st);
389 switch (cc_opclass(baseop)) {
390 case OPc_BASEOP: TAG;
391 st->total_size += sizeof(struct op);
394 st->total_size += sizeof(struct unop);
395 op_size(aTHX_ cUNOPx(baseop)->op_first, st);
398 st->total_size += sizeof(struct binop);
399 op_size(aTHX_ cBINOPx(baseop)->op_first, st);
400 op_size(aTHX_ cBINOPx(baseop)->op_last, st);
403 st->total_size += sizeof(struct logop);
404 op_size(aTHX_ cBINOPx(baseop)->op_first, st);
405 op_size(aTHX_ cLOGOPx(baseop)->op_other, st);
407 case OPc_LISTOP: TAG;
408 st->total_size += sizeof(struct listop);
409 op_size(aTHX_ cLISTOPx(baseop)->op_first, st);
410 op_size(aTHX_ cLISTOPx(baseop)->op_last, st);
413 st->total_size += sizeof(struct pmop);
414 op_size(aTHX_ cPMOPx(baseop)->op_first, st);
415 op_size(aTHX_ cPMOPx(baseop)->op_last, st);
416 #if PERL_VERSION < 9 || (PERL_VERSION == 9 && PERL_SUBVERSION < 5)
417 op_size(aTHX_ cPMOPx(baseop)->op_pmreplroot, st);
418 op_size(aTHX_ cPMOPx(baseop)->op_pmreplstart, st);
419 op_size(aTHX_ (OP *)cPMOPx(baseop)->op_pmnext, st);
421 /* This is defined away in perl 5.8.x, but it is in there for
424 regex_size(PM_GETRE(cPMOPx(baseop)), st);
426 regex_size(cPMOPx(baseop)->op_pmregexp, st);
430 st->total_size += sizeof(struct pmop);
431 if (!(baseop->op_type == OP_AELEMFAST
432 && baseop->op_flags & OPf_SPECIAL)) {
433 /* not an OP_PADAV replacement */
434 sv_size(aTHX_ st, cSVOPx(baseop)->op_sv, SOME_RECURSION);
438 st->total_size += sizeof(struct padop);
441 check_new_and_strlen(st, cPVOPx(baseop)->op_pv);
444 st->total_size += sizeof(struct loop);
445 op_size(aTHX_ cLOOPx(baseop)->op_first, st);
446 op_size(aTHX_ cLOOPx(baseop)->op_last, st);
447 op_size(aTHX_ cLOOPx(baseop)->op_redoop, st);
448 op_size(aTHX_ cLOOPx(baseop)->op_nextop, st);
449 op_size(aTHX_ cLOOPx(baseop)->op_lastop, st);
454 basecop = (COP *)baseop;
455 st->total_size += sizeof(struct cop);
457 /* Change 33656 by nicholas@mouse-mill on 2008/04/07 11:29:51
458 Eliminate cop_label from struct cop by storing a label as the first
459 entry in the hints hash. Most statements don't have labels, so this
460 will save memory. Not sure how much.
461 The check below will be incorrect fail on bleadperls
462 before 5.11 @33656, but later than 5.10, producing slightly too
463 small memory sizes on these Perls. */
464 #if (PERL_VERSION < 11)
465 check_new_and_strlen(st, basecop->cop_label);
468 check_new_and_strlen(st, basecop->cop_file);
469 check_new_and_strlen(st, basecop->cop_stashpv);
471 sv_size(aTHX_ st, (SV *)basecop->cop_stash, SOME_RECURSION);
472 sv_size(aTHX_ st, (SV *)basecop->cop_filegv, SOME_RECURSION);
482 if (st->dangle_whine)
483 warn( "Devel::Size: Encountered dangling pointer in opcode at: %p\n", baseop );
487 #if PERL_VERSION > 9 || (PERL_VERSION == 9 && PERL_SUBVERSION > 2)
488 # define NEW_HEAD_LAYOUT
492 sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
494 const SV *thing = orig_thing;
496 if(!check_new(st, thing))
499 st->total_size += sizeof(SV);
501 if (SvTYPE(thing) >= SVt_PVMG) {
502 magic_size(aTHX_ thing, st);
505 switch (SvTYPE(thing)) {
509 /* Just a plain integer. This will be differently sized depending
510 on whether purify's been compiled in */
512 #ifndef NEW_HEAD_LAYOUT
514 st->total_size += sizeof(sizeof(XPVIV));
516 st->total_size += sizeof(IV);
519 if(recurse && SvROK(thing))
520 sv_size(aTHX_ st, SvRV_const(thing), recurse);
522 /* Is it a float? Like the int, it depends on purify */
525 st->total_size += sizeof(sizeof(XPVNV));
527 st->total_size += sizeof(NV);
530 #if (PERL_VERSION < 11)
531 /* Is it a reference? */
533 #ifndef NEW_HEAD_LAYOUT
534 st->total_size += sizeof(XRV);
536 if(recurse && SvROK(thing))
537 sv_size(aTHX_ st, SvRV_const(thing), recurse);
542 st->total_size += sizeof(XPVAV);
543 /* Is there anything in the array? */
544 if (AvMAX(thing) != -1) {
545 /* an array with 10 slots has AvMax() set to 9 - te 2007-04-22 */
546 st->total_size += sizeof(SV *) * (AvMAX(thing) + 1);
547 dbg_printf(("total_size: %li AvMAX: %li av_len: $i\n", st->total_size, AvMAX(thing), av_len((AV*)thing)));
549 if (recurse >= TOTAL_SIZE_RECURSION) {
550 SSize_t i = AvFILLp(thing) + 1;
553 sv_size(aTHX_ st, AvARRAY(thing)[i], recurse);
556 /* Add in the bits on the other side of the beginning */
558 dbg_printf(("total_size %li, sizeof(SV *) %li, AvARRAY(thing) %li, AvALLOC(thing)%li , sizeof(ptr) %li \n",
559 st->total_size, sizeof(SV*), AvARRAY(thing), AvALLOC(thing), sizeof( thing )));
561 /* under Perl 5.8.8 64bit threading, AvARRAY(thing) was a pointer while AvALLOC was 0,
562 resulting in grossly overstated sized for arrays. Technically, this shouldn't happen... */
563 if (AvALLOC(thing) != 0) {
564 st->total_size += (sizeof(SV *) * (AvARRAY(thing) - AvALLOC(thing)));
566 #if (PERL_VERSION < 9)
567 /* Is there something hanging off the arylen element?
568 Post 5.9.something this is stored in magic, so will be found there,
569 and Perl_av_arylen_p() takes a non-const AV*, hence compilers rightly
570 complain about AvARYLEN() passing thing to it. */
571 sv_size(aTHX_ st, AvARYLEN(thing), recurse);
575 /* First the base struct */
576 st->total_size += sizeof(XPVHV);
577 /* Now the array of buckets */
578 st->total_size += (sizeof(HE *) * (HvMAX(thing) + 1));
579 /* Now walk the bucket chain */
580 if (HvARRAY(thing)) {
583 for (cur_bucket = 0; cur_bucket <= HvMAX(thing); cur_bucket++) {
584 cur_entry = *(HvARRAY(thing) + cur_bucket);
586 st->total_size += sizeof(HE);
587 if (cur_entry->hent_hek) {
588 /* Hash keys can be shared. Have we seen this before? */
589 if (check_new(st, cur_entry->hent_hek)) {
590 st->total_size += HEK_BASESIZE + cur_entry->hent_hek->hek_len + 2;
593 if (recurse >= TOTAL_SIZE_RECURSION)
594 sv_size(aTHX_ st, HeVAL(cur_entry), recurse);
595 cur_entry = cur_entry->hent_next;
603 st->total_size += sizeof(XPVFM);
604 sv_size(aTHX_ st, (SV *)CvPADLIST(thing), SOME_RECURSION);
605 sv_size(aTHX_ st, (SV *)CvOUTSIDE(thing), recurse);
607 if (st->go_yell && !st->fm_whine) {
608 carp("Devel::Size: Calculated sizes for FMs are incomplete");
614 st->total_size += sizeof(XPVCV);
616 sv_size(aTHX_ st, (SV *)CvSTASH(thing), SOME_RECURSION);
617 sv_size(aTHX_ st, (SV *)SvSTASH(thing), SOME_RECURSION);
618 sv_size(aTHX_ st, (SV *)CvGV(thing), SOME_RECURSION);
619 sv_size(aTHX_ st, (SV *)CvPADLIST(thing), SOME_RECURSION);
620 sv_size(aTHX_ st, (SV *)CvOUTSIDE(thing), recurse);
621 if (CvISXSUB(thing)) {
622 sv_size(aTHX_ st, cv_const_sv((CV *)thing), recurse);
624 op_size(aTHX_ CvSTART(thing), st);
625 op_size(aTHX_ CvROOT(thing), st);
630 st->total_size += sizeof(XPVIO);
631 /* Some embedded char pointers */
632 check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_top_name);
633 check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_fmt_name);
634 check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_bottom_name);
635 /* Throw the GVs on the list to be walked if they're not-null */
636 sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_top_gv, recurse);
637 sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_bottom_gv, recurse);
638 sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_fmt_gv, recurse);
640 /* Only go trotting through the IO structures if they're really
641 trottable. If USE_PERLIO is defined we can do this. If
642 not... we can't, so we don't even try */
644 /* Dig into xio_ifp and xio_ofp here */
645 warn("Devel::Size: Can't size up perlio layers yet\n");
649 #if PERL_VERSION <= 8
651 st->total_size += sizeof(XPVBM);
656 st->total_size += sizeof(XPVLV);
657 #if (PERL_VERSION < 9)
664 st->total_size += sizeof(XPVGV);
665 #if (PERL_VERSION >= 9)
668 if(isGV_with_GP(thing)) {
669 st->total_size += GvNAMELEN(thing);
671 # if !defined(USE_ITHREADS) || (PERL_VERSION > 8 || (PERL_VERSION == 8 && PERL_SUBVERSION > 8))
672 /* With itreads, before 5.8.9, this can end up pointing to freed memory
673 if the GV was created in an eval, as GvFILE() points to CopFILE(),
674 and the relevant COP has been freed on scope cleanup after the eval.
675 5.8.9 adds a binary compatible fudge that catches the vast majority
676 of cases. 5.9.something added a proper fix, by converting the GP to
677 use a shared hash key (porperly reference counted), instead of a
678 char * (owned by who knows? possibly no-one now) */
679 check_new_and_strlen(st, GvFILE(thing));
682 /* Is there something hanging off the glob? */
683 if (check_new(st, GvGP(thing))) {
684 st->total_size += sizeof(GP);
685 sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_sv), recurse);
686 sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_form), recurse);
687 sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_av), recurse);
688 sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_hv), recurse);
689 sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_egv), recurse);
690 sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_cv), recurse);
692 #if (PERL_VERSION >= 9)
699 st->total_size += sizeof(XPVMG);
703 st->total_size += sizeof(XPVNV);
707 st->total_size += sizeof(XPVIV);
711 st->total_size += sizeof(XPV);
714 if(recurse && SvROK(thing))
715 sv_size(aTHX_ st, SvRV_const(thing), recurse);
717 st->total_size += SvLEN(thing);
720 st->total_size += SvIVX(thing);
725 warn("Devel::Size: Unknown variable type: %d encountered\n", SvTYPE(thing) );
730 /* Frustratingly, the vtables aren't const in perl.h
731 gcc is happy enough to have non-const initialisers in a static array.
732 VC seems not to be. (Is it actually treating the file as C++?)
733 So do the maximally portable thing, unless we know it's gcc, in which case
734 we can do the more space efficient version. */
738 #include "vtables.inc"
743 static struct state *
749 void **vt_p = vtables;
752 Newxz(st, 1, struct state);
754 if (NULL != (warn_flag = perl_get_sv("Devel::Size::warn", FALSE))) {
755 st->dangle_whine = st->go_yell = SvIV(warn_flag) ? TRUE : FALSE;
757 if (NULL != (warn_flag = perl_get_sv("Devel::Size::dangle", FALSE))) {
758 st->dangle_whine = SvIV(warn_flag) ? TRUE : FALSE;
760 check_new(st, &PL_sv_undef);
761 check_new(st, &PL_sv_no);
762 check_new(st, &PL_sv_yes);
765 check_new(st, *vt_p++);
767 #include "vtables.inc"
772 MODULE = Devel::Size PACKAGE = Devel::Size
780 total_size = TOTAL_SIZE_RECURSION
783 SV *thing = orig_thing;
784 struct state *st = new_state(aTHX);
786 /* If they passed us a reference then dereference it. This is the
787 only way we can check the sizes of arrays and hashes */
792 sv_size(aTHX_ st, thing, ix);
793 RETVAL = st->total_size;