In sv_size(), refactor the PV-derivatives to share as much code as possible.
[p5sagit/Devel-Size.git] / Size.xs
diff --git a/Size.xs b/Size.xs
index c276e44..4020733 100644 (file)
--- a/Size.xs
+++ b/Size.xs
@@ -46,7 +46,6 @@
    without excessive memory needs. The assumption is that your CPU cache
    works :-) (And that we're not going to bust it)  */
 
-#define ALIGN_BITS  ( sizeof(void*) >> 1 )
 #define BYTE_BITS    3
 #define LEAF_BITS   (16 - BYTE_BITS)
 #define LEAF_MASK   0x1FFF
@@ -312,19 +311,10 @@ cc_opclass(const OP * const o)
 /* Figure out how much magic is attached to the SV and return the
    size */
 static void
-magic_size(const SV * const thing, struct state *st) {
-  MAGIC *magic_pointer;
+magic_size(pTHX_ const SV * const thing, struct state *st) {
+  MAGIC *magic_pointer = SvMAGIC(thing);
 
-  /* Is there any? */
-  if (!SvMAGIC(thing)) {
-    /* No, bail */
-    return;
-  }
-
-  /* Get the base magic pointer */
-  magic_pointer = SvMAGIC(thing);
-
-  /* Have we seen the magic pointer? */
+  /* Have we seen the magic pointer?  (NULL has always been seen before)  */
   while (check_new(st, magic_pointer)) {
     st->total_size += sizeof(MAGIC);
 
@@ -333,6 +323,22 @@ magic_size(const SV * const thing, struct state *st) {
         if (check_new(st, magic_pointer->mg_virtual)) {
           st->total_size += sizeof(MGVTBL);
         }
+       sv_size(aTHX_ st, magic_pointer->mg_obj, TOTAL_SIZE_RECURSION);
+       if (magic_pointer->mg_len == HEf_SVKEY) {
+           sv_size(aTHX_ st, (SV *)magic_pointer->mg_ptr, TOTAL_SIZE_RECURSION);
+       }
+#if defined(PERL_MAGIC_utf8) && defined (PERL_MAGIC_UTF8_CACHESIZE)
+       else if (magic_pointer->mg_type == PERL_MAGIC_utf8) {
+           if (check_new(st, magic_pointer->mg_ptr)) {
+               st->total_size += PERL_MAGIC_UTF8_CACHESIZE * 2 * sizeof(STRLEN);
+           }
+       }
+#endif
+       else if (magic_pointer->mg_len > 0) {
+           if (check_new(st, magic_pointer->mg_ptr)) {
+               st->total_size += magic_pointer->mg_len;
+           }
+       }
 
         /* Get the next in the chain */
         magic_pointer = magic_pointer->mg_moremagic;
@@ -492,6 +498,10 @@ sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
 
   st->total_size += sizeof(SV);
 
+  if (SvTYPE(thing) >= SVt_PVMG) {
+      magic_size(aTHX_ thing, st);
+  }
+
   switch (SvTYPE(thing)) {
     /* Is it undef? */
   case SVt_NULL: TAG;
@@ -527,62 +537,7 @@ sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
        sv_size(aTHX_ st, SvRV_const(thing), recurse);
     TAG;break;
 #endif
-    /* How about a plain string? In which case we need to add in how
-       much has been allocated */
-  case SVt_PV: TAG;
-    st->total_size += sizeof(XPV);
-    if(recurse && SvROK(thing))
-       sv_size(aTHX_ st, SvRV_const(thing), recurse);
-    else
-       st->total_size += SvLEN(thing);
-    TAG;break;
-    /* A string with an integer part? */
-  case SVt_PVIV: TAG;
-    st->total_size += sizeof(XPVIV);
-    if(recurse && SvROK(thing))
-       sv_size(aTHX_ st, SvRV_const(thing), recurse);
-    else
-       st->total_size += SvLEN(thing);
-    if(SvOOK(thing)) {
-        st->total_size += SvIVX(thing);
-    }
-    TAG;break;
-    /* A scalar/string/reference with a float part? */
-  case SVt_PVNV: TAG;
-    st->total_size += sizeof(XPVNV);
-    if(recurse && SvROK(thing))
-       sv_size(aTHX_ st, SvRV_const(thing), recurse);
-    else
-       st->total_size += SvLEN(thing);
-    TAG;break;
-  case SVt_PVMG: TAG;
-    st->total_size += sizeof(XPVMG);
-    if(recurse && SvROK(thing))
-       sv_size(aTHX_ st, SvRV_const(thing), recurse);
-    else
-       st->total_size += SvLEN(thing);
-    magic_size(thing, st);
-    TAG;break;
-#if PERL_VERSION <= 8
-  case SVt_PVBM: TAG;
-    st->total_size += sizeof(XPVBM);
-    if(recurse && SvROK(thing))
-       sv_size(aTHX_ st, SvRV_const(thing), recurse);
-    else
-       st->total_size += SvLEN(thing);
-    magic_size(thing, st);
-    TAG;break;
-#endif
-  case SVt_PVLV: TAG;
-    st->total_size += sizeof(XPVLV);
-    if(recurse && SvROK(thing))
-       sv_size(aTHX_ st, SvRV_const(thing), recurse);
-    else
-       st->total_size += SvLEN(thing);
-    magic_size(thing, st);
-    TAG;break;
-    /* How much space is dedicated to the array? Not counting the
-       elements in the array, mind, just the array itself */
+
   case SVt_PVAV: TAG;
     st->total_size += sizeof(XPVAV);
     /* Is there anything in the array? */
@@ -615,7 +570,6 @@ sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
        complain about AvARYLEN() passing thing to it.  */
     sv_size(aTHX_ st, AvARYLEN(thing), recurse);
 #endif
-    magic_size(thing, st);
     TAG;break;
   case SVt_PVHV: TAG;
     /* First the base struct */
@@ -642,13 +596,23 @@ sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
         }
       }
     }
-    magic_size(thing, st);
     TAG;break;
+
+
+  case SVt_PVFM: TAG;
+    st->total_size += sizeof(XPVFM);
+    sv_size(aTHX_ st, (SV *)CvPADLIST(thing), SOME_RECURSION);
+    sv_size(aTHX_ st, (SV *)CvOUTSIDE(thing), recurse);
+
+    if (st->go_yell && !st->fm_whine) {
+      carp("Devel::Size: Calculated sizes for FMs are incomplete");
+      st->fm_whine = 1;
+    }
+    goto freescalar;
+
   case SVt_PVCV: TAG;
     st->total_size += sizeof(XPVCV);
-    magic_size(thing, st);
 
-    st->total_size += ((XPVIO *) SvANY(thing))->xpv_len;
     sv_size(aTHX_ st, (SV *)CvSTASH(thing), SOME_RECURSION);
     sv_size(aTHX_ st, (SV *)SvSTASH(thing), SOME_RECURSION);
     sv_size(aTHX_ st, (SV *)CvGV(thing), SOME_RECURSION);
@@ -660,16 +624,60 @@ sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
        op_size(aTHX_ CvSTART(thing), st);
        op_size(aTHX_ CvROOT(thing), st);
     }
+    goto freescalar;
+
+  case SVt_PVIO: TAG;
+    st->total_size += sizeof(XPVIO);
+    /* Some embedded char pointers */
+    check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_top_name);
+    check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_fmt_name);
+    check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_bottom_name);
+    /* Throw the GVs on the list to be walked if they're not-null */
+    sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_top_gv, recurse);
+    sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_bottom_gv, recurse);
+    sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_fmt_gv, recurse);
+
+    /* Only go trotting through the IO structures if they're really
+       trottable. If USE_PERLIO is defined we can do this. If
+       not... we can't, so we don't even try */
+#ifdef USE_PERLIO
+    /* Dig into xio_ifp and xio_ofp here */
+    warn("Devel::Size: Can't size up perlio layers yet\n");
+#endif
+    goto freescalar;
+
+#if PERL_VERSION <= 8
+  case SVt_PVBM: TAG;
+    st->total_size += sizeof(XPVBM);
+    goto freescalar;
+#endif
+
+  case SVt_PVLV: TAG;
+    st->total_size += sizeof(XPVLV);
+#if (PERL_VERSION < 9)
+    goto freescalar;
+#else
+    goto donegv;
+#endif
 
-    TAG;break;
   case SVt_PVGV: TAG;
-    magic_size(thing, st);
     st->total_size += sizeof(XPVGV);
+#if (PERL_VERSION >= 9)
+  donegv:
+#endif
     if(isGV_with_GP(thing)) {
        st->total_size += GvNAMELEN(thing);
 #ifdef GvFILE
-       /* Is there a file? */
+#  if !defined(USE_ITHREADS) || (PERL_VERSION > 8 || (PERL_VERSION == 8 && PERL_SUBVERSION > 8))
+       /* With itreads, before 5.8.9, this can end up pointing to freed memory
+          if the GV was created in an eval, as GvFILE() points to CopFILE(),
+          and the relevant COP has been freed on scope cleanup after the eval.
+          5.8.9 adds a binary compatible fudge that catches the vast majority
+          of cases. 5.9.something added a proper fix, by converting the GP to
+          use a shared hash key (porperly reference counted), instead of a
+          char * (owned by who knows? possibly no-one now) */
        check_new_and_strlen(st, GvFILE(thing));
+#  endif
 #endif
        /* Is there something hanging off the glob? */
        if (check_new(st, GvGP(thing))) {
@@ -681,54 +689,66 @@ sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
            sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_egv), recurse);
            sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_cv), recurse);
        }
+#if (PERL_VERSION >= 9)
+       TAG; break;
+#endif
     }
-    TAG;break;
-  case SVt_PVFM: TAG;
-    st->total_size += sizeof(XPVFM);
-    magic_size(thing, st);
-    st->total_size += ((XPVIO *) SvANY(thing))->xpv_len;
-    sv_size(aTHX_ st, (SV *)CvPADLIST(thing), SOME_RECURSION);
-    sv_size(aTHX_ st, (SV *)CvOUTSIDE(thing), recurse);
+    goto freescalar;
 
-    if (st->go_yell && !st->fm_whine) {
-      carp("Devel::Size: Calculated sizes for FMs are incomplete");
-      st->fm_whine = 1;
+  case SVt_PVMG: TAG;
+    st->total_size += sizeof(XPVMG);
+    goto freescalar;
+
+  case SVt_PVNV: TAG;
+    st->total_size += sizeof(XPVNV);
+    goto freescalar;
+
+  case SVt_PVIV: TAG;
+    st->total_size += sizeof(XPVIV);
+    goto freescalar;
+
+  case SVt_PV: TAG;
+    st->total_size += sizeof(XPV);
+
+  freescalar:
+    if(recurse && SvROK(thing))
+       sv_size(aTHX_ st, SvRV_const(thing), recurse);
+    else
+       st->total_size += SvLEN(thing);
+
+    if(SvOOK(thing)) {
+        st->total_size += SvIVX(thing);
     }
     TAG;break;
-  case SVt_PVIO: TAG;
-    st->total_size += sizeof(XPVIO);
-    magic_size(thing, st);
-    if (check_new(st, (SvPVX_const(thing)))) {
-      st->total_size += ((XPVIO *) SvANY(thing))->xpv_cur;
-    }
-    /* Some embedded char pointers */
-    check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_top_name);
-    check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_fmt_name);
-    check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_bottom_name);
-    /* Throw the GVs on the list to be walked if they're not-null */
-    sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_top_gv, recurse);
-    sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_bottom_gv, recurse);
-    sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_fmt_gv, recurse);
 
-    /* Only go trotting through the IO structures if they're really
-       trottable. If USE_PERLIO is defined we can do this. If
-       not... we can't, so we don't even try */
-#ifdef USE_PERLIO
-    /* Dig into xio_ifp and xio_ofp here */
-    warn("Devel::Size: Can't size up perlio layers yet\n");
-#endif
-    TAG;break;
   default:
     warn("Devel::Size: Unknown variable type: %d encountered\n", SvTYPE(thing) );
   }
   return TRUE;
 }
 
+/* Frustratingly, the vtables aren't const in perl.h
+   gcc is happy enough to have non-const initialisers in a static array.
+   VC seems not to be. (Is it actually treating the file as C++?)
+   So do the maximally portable thing, unless we know it's gcc, in which case
+   we can do the more space efficient version.  */
+
+#if __GNUC__
+void *vtables[] = {
+#include "vtables.inc"
+    NULL
+};
+#endif
+
 static struct state *
 new_state(pTHX)
 {
     SV *warn_flag;
     struct state *st;
+#if __GNUC__
+    void **vt_p = vtables;
+#endif
+
     Newxz(st, 1, struct state);
     st->go_yell = TRUE;
     if (NULL != (warn_flag = perl_get_sv("Devel::Size::warn", FALSE))) {
@@ -740,6 +760,12 @@ new_state(pTHX)
     check_new(st, &PL_sv_undef);
     check_new(st, &PL_sv_no);
     check_new(st, &PL_sv_yes);
+#if __GNUC__
+    while(*vt_p)
+       check_new(st, *vt_p++);
+#else
+#include "vtables.inc"
+#endif
     return st;
 }