Size.xs

   1 #define PERL_NO_GET_CONTEXT
   2
   3 #include "EXTERN.h"
   4 #include "perl.h"
   5 #include "XSUB.h"
   6 #include "ppport.h"
   7
   8 /* Not yet in ppport.h */
   9 #ifndef CvISXSUB
  10 #  define CvISXSUB(cv)  (CvXSUB(cv) ? TRUE : FALSE)
  11 #endif
  12 #ifndef SvRV_const
  13 #  define SvRV_const(rv) SvRV(rv)
  14 #endif
  15
  16 #ifdef _MSC_VER
  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.  */
  21 #  include <excpt.h>
  22 #  define TRY_TO_CATCH_SEGV __try
  23 #  define CAUGHT_EXCEPTION __except(EXCEPTION EXCEPTION_EXECUTE_HANDLER)
  24 #else
  25 #  define TRY_TO_CATCH_SEGV if(1)
  26 #  define CAUGHT_EXCEPTION else
  27 #endif
  28
  29 #ifdef __GNUC__
  30 # define __attribute__(x)
  31 #endif
  32
  33 #if 0 && defined(DEBUGGING)
  34 #define dbg_printf(x) printf x
  35 #else
  36 #define dbg_printf(x)
  37 #endif
  38
  39 #define TAG /* printf( "# %s(%d)\n", __FILE__, __LINE__ ) */
  40 #define carp puts
  41
  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)  */
  48
  49 #define BYTE_BITS    3
  50 #define LEAF_BITS   (16 - BYTE_BITS)
  51 #define LEAF_MASK   0x1FFF
  52
  53 struct state {
  54     UV total_size;
  55     bool regex_whine;
  56     bool fm_whine;
  57     bool dangle_whine;
  58     bool go_yell;
  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.  */
  62     void *tracking[256];
  63 };
  64
  65 /*
  66     Checks to see if thing is in the bitstring.
  67     Returns true or false, and
  68     notes thing in the segmented bitstring.
  69  */
  70 static bool
  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
  78        pointers.  */
  79     const size_t cooked_p
  80         = (raw_p >> ALIGN_BITS) | (raw_p << (bits - ALIGN_BITS));
  81     const U8 this_bit = 1 << (cooked_p & 0x7);
  82     U8 **leaf_p;
  83     U8 *leaf;
  84     unsigned int i;
  85     void **tv_p = (void **) (st->tracking);
  86
  87     if (NULL == p) return FALSE;
  88     TRY_TO_CATCH_SEGV {
  89         const char c = *(const char *)p;
  90     }
  91     CAUGHT_EXCEPTION {
  92         if (st->dangle_whine)
  93             warn( "Devel::Size: Encountered invalid pointer: %p\n", p );
  94         return FALSE;
  95     }
  96     TAG;
  97
  98     bits -= 8;
  99     /* bits now 24 (32 bit pointers) or 56 (64 bit pointers) */
 100
 101     /* First level is always present.  */
 102     do {
 103         i = (unsigned int)((cooked_p >> bits) & 0xFF);
 104         if (!tv_p[i])
 105             Newxz(tv_p[i], 256, void *);
 106         tv_p = (void **)(tv_p[i]);
 107         bits -= 8;
 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  */
 113     assert(bits == 16);
 114 #endif
 115     leaf_p = (U8 **)tv_p;
 116     i = (unsigned int)((cooked_p >> bits) & 0xFF);
 117     if (!leaf_p[i])
 118         Newxz(leaf_p[i], 1 << LEAF_BITS, U8);
 119     leaf = leaf_p[i];
 120
 121     TAG;
 122
 123     i = (unsigned int)((cooked_p >> BYTE_BITS) & LEAF_MASK);
 124
 125     if(leaf[i] & this_bit)
 126         return FALSE;
 127
 128     leaf[i] |= this_bit;
 129     return TRUE;
 130 }
 131
 132 static void
 133 free_tracking_at(void **tv, int level)
 134 {
 135     int i = 255;
 136
 137     if (--level) {
 138         /* Nodes */
 139         do {
 140             if (tv[i]) {
 141                 free_tracking_at(tv[i], level);
 142                 Safefree(tv[i]);
 143             }
 144         } while (i--);
 145     } else {
 146         /* Leaves */
 147         do {
 148             if (tv[i])
 149                 Safefree(tv[i]);
 150         } while (i--);
 151     }
 152 }
 153
 154 static void
 155 free_state(struct state *st)
 156 {
 157     const int top_level = (sizeof(void *) * 8 - LEAF_BITS - BYTE_BITS) / 8;
 158     free_tracking_at((void **)st->tracking, top_level);
 159     Safefree(st);
 160 }
 161
 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.  */
 171
 172 #define NO_RECURSION 0
 173 #define SOME_RECURSION 1
 174 #define TOTAL_SIZE_RECURSION 2
 175
 176 static bool sv_size(pTHX_ struct state *, const SV *const, const int recurse);
 177
 178 typedef enum {
 179     OPc_NULL,   /* 0 */
 180     OPc_BASEOP, /* 1 */
 181     OPc_UNOP,   /* 2 */
 182     OPc_BINOP,  /* 3 */
 183     OPc_LOGOP,  /* 4 */
 184     OPc_LISTOP, /* 5 */
 185     OPc_PMOP,   /* 6 */
 186     OPc_SVOP,   /* 7 */
 187     OPc_PADOP,  /* 8 */
 188     OPc_PVOP,   /* 9 */
 189     OPc_LOOP,   /* 10 */
 190     OPc_COP /* 11 */
 191 } opclass;
 192
 193 static opclass
 194 cc_opclass(const OP * const o)
 195 {
 196     if (!o)
 197     return OPc_NULL;
 198     TRY_TO_CATCH_SEGV {
 199         if (o->op_type == 0)
 200         return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 201
 202         if (o->op_type == OP_SASSIGN)
 203         return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
 204
 205     #ifdef USE_ITHREADS
 206         if (o->op_type == OP_GV || o->op_type == OP_GVSV || o->op_type == OP_AELEMFAST)
 207         return OPc_PADOP;
 208     #endif
 209
 210         if ((o->op_type == OP_TRANS)) {
 211           return OPc_BASEOP;
 212         }
 213
 214         switch (PL_opargs[o->op_type] & OA_CLASS_MASK) {
 215         case OA_BASEOP: TAG;
 216         return OPc_BASEOP;
 217
 218         case OA_UNOP: TAG;
 219         return OPc_UNOP;
 220
 221         case OA_BINOP: TAG;
 222         return OPc_BINOP;
 223
 224         case OA_LOGOP: TAG;
 225         return OPc_LOGOP;
 226
 227         case OA_LISTOP: TAG;
 228         return OPc_LISTOP;
 229
 230         case OA_PMOP: TAG;
 231         return OPc_PMOP;
 232
 233         case OA_SVOP: TAG;
 234         return OPc_SVOP;
 235
 236         case OA_PADOP: TAG;
 237         return OPc_PADOP;
 238
 239         case OA_PVOP_OR_SVOP: TAG;
 240             /*
 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).
 246              */
 247         return (o->op_private & (OPpTRANS_TO_UTF|OPpTRANS_FROM_UTF))
 248             ? OPc_SVOP : OPc_PVOP;
 249
 250         case OA_LOOP: TAG;
 251         return OPc_LOOP;
 252
 253         case OA_COP: TAG;
 254         return OPc_COP;
 255
 256         case OA_BASEOP_OR_UNOP: TAG;
 257         /*
 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.
 263          */
 264         return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
 265
 266         case OA_FILESTATOP: TAG;
 267         /*
 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).
 275          */
 276         return ((o->op_flags & OPf_KIDS) ? OPc_UNOP :
 277     #ifdef USE_ITHREADS
 278             (o->op_flags & OPf_REF) ? OPc_PADOP : OPc_BASEOP);
 279     #else
 280             (o->op_flags & OPf_REF) ? OPc_SVOP : OPc_BASEOP);
 281     #endif
 282         case OA_LOOPEXOP: TAG;
 283         /*
 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
 290          * get set.
 291          */
 292         if (o->op_flags & OPf_STACKED)
 293             return OPc_UNOP;
 294         else if (o->op_flags & OPf_SPECIAL)
 295             return OPc_BASEOP;
 296         else
 297             return OPc_PVOP;
 298         }
 299         warn("Devel::Size: Can't determine class of operator %s, assuming BASEOP\n",
 300          PL_op_name[o->op_type]);
 301     }
 302     CAUGHT_EXCEPTION { }
 303     return OPc_BASEOP;
 304 }
 305
 306
 307 #if !defined(NV)
 308 #define NV double
 309 #endif
 310
 311 /* Figure out how much magic is attached to the SV and return the
 312    size */
 313 static void
 314 magic_size(const SV * const thing, struct state *st) {
 315   MAGIC *magic_pointer;
 316
 317   /* Is there any? */
 318   if (!SvMAGIC(thing)) {
 319     /* No, bail */
 320     return;
 321   }
 322
 323   /* Get the base magic pointer */
 324   magic_pointer = SvMAGIC(thing);
 325
 326   /* Have we seen the magic pointer? */
 327   while (check_new(st, magic_pointer)) {
 328     st->total_size += sizeof(MAGIC);
 329
 330     TRY_TO_CATCH_SEGV {
 331         /* Have we seen the magic vtable? */
 332         if (check_new(st, magic_pointer->mg_virtual)) {
 333           st->total_size += sizeof(MGVTBL);
 334         }
 335
 336         /* Get the next in the chain */
 337         magic_pointer = magic_pointer->mg_moremagic;
 338     }
 339     CAUGHT_EXCEPTION {
 340         if (st->dangle_whine)
 341             warn( "Devel::Size: Encountered bad magic at: %p\n", magic_pointer );
 342     }
 343   }
 344 }
 345
 346 static void
 347 check_new_and_strlen(struct state *st, const char *const p) {
 348     if(check_new(st, p))
 349         st->total_size += 1 + strlen(p);
 350 }
 351
 352 static void
 353 regex_size(const REGEXP * const baseregex, struct state *st) {
 354     if(!check_new(st, baseregex))
 355         return;
 356   st->total_size += sizeof(REGEXP);
 357 #if (PERL_VERSION < 11)
 358   /* Note the size of the paren offset thing */
 359   st->total_size += sizeof(I32) * baseregex->nparens * 2;
 360   st->total_size += strlen(baseregex->precomp);
 361 #else
 362   st->total_size += sizeof(struct regexp);
 363   st->total_size += sizeof(I32) * SvANY(baseregex)->nparens * 2;
 364   /*st->total_size += strlen(SvANY(baseregex)->subbeg);*/
 365 #endif
 366   if (st->go_yell && !st->regex_whine) {
 367     carp("Devel::Size: Calculated sizes for compiled regexes are incompatible, and probably always will be");
 368     st->regex_whine = 1;
 369   }
 370 }
 371
 372 static void
 373 op_size(pTHX_ const OP * const baseop, struct state *st)
 374 {
 375     TRY_TO_CATCH_SEGV {
 376         TAG;
 377         if(!check_new(st, baseop))
 378             return;
 379         TAG;
 380         op_size(aTHX_ baseop->op_next, st);
 381         TAG;
 382         switch (cc_opclass(baseop)) {
 383         case OPc_BASEOP: TAG;
 384             st->total_size += sizeof(struct op);
 385             TAG;break;
 386         case OPc_UNOP: TAG;
 387             st->total_size += sizeof(struct unop);
 388             op_size(aTHX_ cUNOPx(baseop)->op_first, st);
 389             TAG;break;
 390         case OPc_BINOP: TAG;
 391             st->total_size += sizeof(struct binop);
 392             op_size(aTHX_ cBINOPx(baseop)->op_first, st);
 393             op_size(aTHX_ cBINOPx(baseop)->op_last, st);
 394             TAG;break;
 395         case OPc_LOGOP: TAG;
 396             st->total_size += sizeof(struct logop);
 397             op_size(aTHX_ cBINOPx(baseop)->op_first, st);
 398             op_size(aTHX_ cLOGOPx(baseop)->op_other, st);
 399             TAG;break;
 400         case OPc_LISTOP: TAG;
 401             st->total_size += sizeof(struct listop);
 402             op_size(aTHX_ cLISTOPx(baseop)->op_first, st);
 403             op_size(aTHX_ cLISTOPx(baseop)->op_last, st);
 404             TAG;break;
 405         case OPc_PMOP: TAG;
 406             st->total_size += sizeof(struct pmop);
 407             op_size(aTHX_ cPMOPx(baseop)->op_first, st);
 408             op_size(aTHX_ cPMOPx(baseop)->op_last, st);
 409 #if PERL_VERSION < 9 || (PERL_VERSION == 9 && PERL_SUBVERSION < 5)
 410             op_size(aTHX_ cPMOPx(baseop)->op_pmreplroot, st);
 411             op_size(aTHX_ cPMOPx(baseop)->op_pmreplstart, st);
 412             op_size(aTHX_ (OP *)cPMOPx(baseop)->op_pmnext, st);
 413 #endif
 414             /* This is defined away in perl 5.8.x, but it is in there for
 415                5.6.x */
 416 #ifdef PM_GETRE
 417             regex_size(PM_GETRE(cPMOPx(baseop)), st);
 418 #else
 419             regex_size(cPMOPx(baseop)->op_pmregexp, st);
 420 #endif
 421             TAG;break;
 422         case OPc_SVOP: TAG;
 423             st->total_size += sizeof(struct pmop);
 424             if (!(baseop->op_type == OP_AELEMFAST
 425                   && baseop->op_flags & OPf_SPECIAL)) {
 426                 /* not an OP_PADAV replacement */
 427                 sv_size(aTHX_ st, cSVOPx(baseop)->op_sv, SOME_RECURSION);
 428             }
 429             TAG;break;
 430       case OPc_PADOP: TAG;
 431           st->total_size += sizeof(struct padop);
 432           TAG;break;
 433         case OPc_PVOP: TAG;
 434             check_new_and_strlen(st, cPVOPx(baseop)->op_pv);
 435             TAG;break;
 436         case OPc_LOOP: TAG;
 437             st->total_size += sizeof(struct loop);
 438             op_size(aTHX_ cLOOPx(baseop)->op_first, st);
 439             op_size(aTHX_ cLOOPx(baseop)->op_last, st);
 440             op_size(aTHX_ cLOOPx(baseop)->op_redoop, st);
 441             op_size(aTHX_ cLOOPx(baseop)->op_nextop, st);
 442             op_size(aTHX_ cLOOPx(baseop)->op_lastop, st);
 443             TAG;break;
 444         case OPc_COP: TAG;
 445         {
 446           COP *basecop;
 447           basecop = (COP *)baseop;
 448           st->total_size += sizeof(struct cop);
 449
 450           /* Change 33656 by nicholas@mouse-mill on 2008/04/07 11:29:51
 451           Eliminate cop_label from struct cop by storing a label as the first
 452           entry in the hints hash. Most statements don't have labels, so this
 453           will save memory. Not sure how much.
 454           The check below will be incorrect fail on bleadperls
 455           before 5.11 @33656, but later than 5.10, producing slightly too
 456           small memory sizes on these Perls. */
 457 #if (PERL_VERSION < 11)
 458           check_new_and_strlen(st, basecop->cop_label);
 459 #endif
 460 #ifdef USE_ITHREADS
 461           check_new_and_strlen(st, basecop->cop_file);
 462           check_new_and_strlen(st, basecop->cop_stashpv);
 463 #else
 464           sv_size(aTHX_ st, (SV *)basecop->cop_stash, SOME_RECURSION);
 465           sv_size(aTHX_ st, (SV *)basecop->cop_filegv, SOME_RECURSION);
 466 #endif
 467
 468         }
 469         TAG;break;
 470       default:
 471         TAG;break;
 472       }
 473   }
 474   CAUGHT_EXCEPTION {
 475       if (st->dangle_whine)
 476           warn( "Devel::Size: Encountered dangling pointer in opcode at: %p\n", baseop );
 477   }
 478 }
 479
 480 #if PERL_VERSION > 9 || (PERL_VERSION == 9 && PERL_SUBVERSION > 2)
 481 #  define NEW_HEAD_LAYOUT
 482 #endif
 483
 484 static bool
 485 sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
 486         const int recurse) {
 487   const SV *thing = orig_thing;
 488
 489   if(!check_new(st, thing))
 490       return FALSE;
 491
 492   st->total_size += sizeof(SV);
 493
 494   switch (SvTYPE(thing)) {
 495     /* Is it undef? */
 496   case SVt_NULL: TAG;
 497     TAG;break;
 498     /* Just a plain integer. This will be differently sized depending
 499        on whether purify's been compiled in */
 500   case SVt_IV: TAG;
 501 #ifndef NEW_HEAD_LAYOUT
 502 #  ifdef PURIFY
 503     st->total_size += sizeof(sizeof(XPVIV));
 504 #  else
 505     st->total_size += sizeof(IV);
 506 #  endif
 507 #endif
 508     if(recurse && SvROK(thing))
 509         sv_size(aTHX_ st, SvRV_const(thing), recurse);
 510     TAG;break;
 511     /* Is it a float? Like the int, it depends on purify */
 512   case SVt_NV: TAG;
 513 #ifdef PURIFY
 514     st->total_size += sizeof(sizeof(XPVNV));
 515 #else
 516     st->total_size += sizeof(NV);
 517 #endif
 518     TAG;break;
 519 #if (PERL_VERSION < 11)
 520     /* Is it a reference? */
 521   case SVt_RV: TAG;
 522 #ifndef NEW_HEAD_LAYOUT
 523     st->total_size += sizeof(XRV);
 524 #endif
 525     if(recurse && SvROK(thing))
 526         sv_size(aTHX_ st, SvRV_const(thing), recurse);
 527     TAG;break;
 528 #endif
 529     /* How about a plain string? In which case we need to add in how
 530        much has been allocated */
 531   case SVt_PV: TAG;
 532     st->total_size += sizeof(XPV);
 533     if(recurse && SvROK(thing))
 534         sv_size(aTHX_ st, SvRV_const(thing), recurse);
 535     else
 536         st->total_size += SvLEN(thing);
 537     TAG;break;
 538     /* A string with an integer part? */
 539   case SVt_PVIV: TAG;
 540     st->total_size += sizeof(XPVIV);
 541     if(recurse && SvROK(thing))
 542         sv_size(aTHX_ st, SvRV_const(thing), recurse);
 543     else
 544         st->total_size += SvLEN(thing);
 545     if(SvOOK(thing)) {
 546         st->total_size += SvIVX(thing);
 547     }
 548     TAG;break;
 549     /* A scalar/string/reference with a float part? */
 550   case SVt_PVNV: TAG;
 551     st->total_size += sizeof(XPVNV);
 552     if(recurse && SvROK(thing))
 553         sv_size(aTHX_ st, SvRV_const(thing), recurse);
 554     else
 555         st->total_size += SvLEN(thing);
 556     TAG;break;
 557   case SVt_PVMG: TAG;
 558     st->total_size += sizeof(XPVMG);
 559     if(recurse && SvROK(thing))
 560         sv_size(aTHX_ st, SvRV_const(thing), recurse);
 561     else
 562         st->total_size += SvLEN(thing);
 563     magic_size(thing, st);
 564     TAG;break;
 565 #if PERL_VERSION <= 8
 566   case SVt_PVBM: TAG;
 567     st->total_size += sizeof(XPVBM);
 568     if(recurse && SvROK(thing))
 569         sv_size(aTHX_ st, SvRV_const(thing), recurse);
 570     else
 571         st->total_size += SvLEN(thing);
 572     magic_size(thing, st);
 573     TAG;break;
 574 #endif
 575   case SVt_PVLV: TAG;
 576     st->total_size += sizeof(XPVLV);
 577     if(recurse && SvROK(thing))
 578         sv_size(aTHX_ st, SvRV_const(thing), recurse);
 579     else
 580         st->total_size += SvLEN(thing);
 581     magic_size(thing, st);
 582     TAG;break;
 583     /* How much space is dedicated to the array? Not counting the
 584        elements in the array, mind, just the array itself */
 585   case SVt_PVAV: TAG;
 586     st->total_size += sizeof(XPVAV);
 587     /* Is there anything in the array? */
 588     if (AvMAX(thing) != -1) {
 589       /* an array with 10 slots has AvMax() set to 9 - te 2007-04-22 */
 590       st->total_size += sizeof(SV *) * (AvMAX(thing) + 1);
 591       dbg_printf(("total_size: %li AvMAX: %li av_len: $i\n", st->total_size, AvMAX(thing), av_len((AV*)thing)));
 592
 593       if (recurse >= TOTAL_SIZE_RECURSION) {
 594           SSize_t i = AvFILLp(thing) + 1;
 595
 596           while (i--)
 597               sv_size(aTHX_ st, AvARRAY(thing)[i], recurse);
 598       }
 599     }
 600     /* Add in the bits on the other side of the beginning */
 601
 602     dbg_printf(("total_size %li, sizeof(SV *) %li, AvARRAY(thing) %li, AvALLOC(thing)%li , sizeof(ptr) %li \n",
 603     st->total_size, sizeof(SV*), AvARRAY(thing), AvALLOC(thing), sizeof( thing )));
 604
 605     /* under Perl 5.8.8 64bit threading, AvARRAY(thing) was a pointer while AvALLOC was 0,
 606        resulting in grossly overstated sized for arrays. Technically, this shouldn't happen... */
 607     if (AvALLOC(thing) != 0) {
 608       st->total_size += (sizeof(SV *) * (AvARRAY(thing) - AvALLOC(thing)));
 609       }
 610 #if (PERL_VERSION < 9)
 611     /* Is there something hanging off the arylen element?
 612        Post 5.9.something this is stored in magic, so will be found there,
 613        and Perl_av_arylen_p() takes a non-const AV*, hence compilers rightly
 614        complain about AvARYLEN() passing thing to it.  */
 615     sv_size(aTHX_ st, AvARYLEN(thing), recurse);
 616 #endif
 617     magic_size(thing, st);
 618     TAG;break;
 619   case SVt_PVHV: TAG;
 620     /* First the base struct */
 621     st->total_size += sizeof(XPVHV);
 622     /* Now the array of buckets */
 623     st->total_size += (sizeof(HE *) * (HvMAX(thing) + 1));
 624     /* Now walk the bucket chain */
 625     if (HvARRAY(thing)) {
 626       HE *cur_entry;
 627       UV cur_bucket = 0;
 628       for (cur_bucket = 0; cur_bucket <= HvMAX(thing); cur_bucket++) {
 629         cur_entry = *(HvARRAY(thing) + cur_bucket);
 630         while (cur_entry) {
 631           st->total_size += sizeof(HE);
 632           if (cur_entry->hent_hek) {
 633             /* Hash keys can be shared. Have we seen this before? */
 634             if (check_new(st, cur_entry->hent_hek)) {
 635               st->total_size += HEK_BASESIZE + cur_entry->hent_hek->hek_len + 2;
 636             }
 637           }
 638           if (recurse >= TOTAL_SIZE_RECURSION)
 639               sv_size(aTHX_ st, HeVAL(cur_entry), recurse);
 640           cur_entry = cur_entry->hent_next;
 641         }
 642       }
 643     }
 644     magic_size(thing, st);
 645     TAG;break;
 646   case SVt_PVCV: TAG;
 647     st->total_size += sizeof(XPVCV);
 648     magic_size(thing, st);
 649
 650     st->total_size += ((XPVIO *) SvANY(thing))->xpv_len;
 651     sv_size(aTHX_ st, (SV *)CvSTASH(thing), SOME_RECURSION);
 652     sv_size(aTHX_ st, (SV *)SvSTASH(thing), SOME_RECURSION);
 653     sv_size(aTHX_ st, (SV *)CvGV(thing), SOME_RECURSION);
 654     sv_size(aTHX_ st, (SV *)CvPADLIST(thing), SOME_RECURSION);
 655     sv_size(aTHX_ st, (SV *)CvOUTSIDE(thing), recurse);
 656     if (CvISXSUB(thing)) {
 657         sv_size(aTHX_ st, cv_const_sv((CV *)thing), recurse);
 658     } else {
 659         op_size(aTHX_ CvSTART(thing), st);
 660         op_size(aTHX_ CvROOT(thing), st);
 661     }
 662
 663     TAG;break;
 664   case SVt_PVGV: TAG;
 665     magic_size(thing, st);
 666     st->total_size += sizeof(XPVGV);
 667     if(isGV_with_GP(thing)) {
 668         st->total_size += GvNAMELEN(thing);
 669 #ifdef GvFILE
 670 #  if !defined(USE_ITHREADS) || (PERL_VERSION > 8 || (PERL_VERSION == 8 && PERL_SUBVERSION > 8))
 671         /* With itreads, before 5.8.9, this can end up pointing to freed memory
 672            if the GV was created in an eval, as GvFILE() points to CopFILE(),
 673            and the relevant COP has been freed on scope cleanup after the eval.
 674            5.8.9 adds a binary compatible fudge that catches the vast majority
 675            of cases. 5.9.something added a proper fix, by converting the GP to
 676            use a shared hash key (porperly reference counted), instead of a
 677            char * (owned by who knows? possibly no-one now) */
 678         check_new_and_strlen(st, GvFILE(thing));
 679 #  endif
 680 #endif
 681         /* Is there something hanging off the glob? */
 682         if (check_new(st, GvGP(thing))) {
 683             st->total_size += sizeof(GP);
 684             sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_sv), recurse);
 685             sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_form), recurse);
 686             sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_av), recurse);
 687             sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_hv), recurse);
 688             sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_egv), recurse);
 689             sv_size(aTHX_ st, (SV *)(GvGP(thing)->gp_cv), recurse);
 690         }
 691     }
 692     TAG;break;
 693   case SVt_PVFM: TAG;
 694     st->total_size += sizeof(XPVFM);
 695     magic_size(thing, st);
 696     st->total_size += ((XPVIO *) SvANY(thing))->xpv_len;
 697     sv_size(aTHX_ st, (SV *)CvPADLIST(thing), SOME_RECURSION);
 698     sv_size(aTHX_ st, (SV *)CvOUTSIDE(thing), recurse);
 699
 700     if (st->go_yell && !st->fm_whine) {
 701       carp("Devel::Size: Calculated sizes for FMs are incomplete");
 702       st->fm_whine = 1;
 703     }
 704     TAG;break;
 705   case SVt_PVIO: TAG;
 706     st->total_size += sizeof(XPVIO);
 707     magic_size(thing, st);
 708     if (check_new(st, (SvPVX_const(thing)))) {
 709       st->total_size += ((XPVIO *) SvANY(thing))->xpv_cur;
 710     }
 711     /* Some embedded char pointers */
 712     check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_top_name);
 713     check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_fmt_name);
 714     check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_bottom_name);
 715     /* Throw the GVs on the list to be walked if they're not-null */
 716     sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_top_gv, recurse);
 717     sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_bottom_gv, recurse);
 718     sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_fmt_gv, recurse);
 719
 720     /* Only go trotting through the IO structures if they're really
 721        trottable. If USE_PERLIO is defined we can do this. If
 722        not... we can't, so we don't even try */
 723 #ifdef USE_PERLIO
 724     /* Dig into xio_ifp and xio_ofp here */
 725     warn("Devel::Size: Can't size up perlio layers yet\n");
 726 #endif
 727     TAG;break;
 728   default:
 729     warn("Devel::Size: Unknown variable type: %d encountered\n", SvTYPE(thing) );
 730   }
 731   return TRUE;
 732 }
 733
 734 static struct state *
 735 new_state(pTHX)
 736 {
 737     SV *warn_flag;
 738     struct state *st;
 739     Newxz(st, 1, struct state);
 740     st->go_yell = TRUE;
 741     if (NULL != (warn_flag = perl_get_sv("Devel::Size::warn", FALSE))) {
 742         st->dangle_whine = st->go_yell = SvIV(warn_flag) ? TRUE : FALSE;
 743     }
 744     if (NULL != (warn_flag = perl_get_sv("Devel::Size::dangle", FALSE))) {
 745         st->dangle_whine = SvIV(warn_flag) ? TRUE : FALSE;
 746     }
 747     check_new(st, &PL_sv_undef);
 748     check_new(st, &PL_sv_no);
 749     check_new(st, &PL_sv_yes);
 750     return st;
 751 }
 752
 753 MODULE = Devel::Size        PACKAGE = Devel::Size
 754
 755 PROTOTYPES: DISABLE
 756
 757 UV
 758 size(orig_thing)
 759      SV *orig_thing
 760 ALIAS:
 761     total_size = TOTAL_SIZE_RECURSION
 762 CODE:
 763 {
 764   SV *thing = orig_thing;
 765   struct state *st = new_state(aTHX);
 766
 767   /* If they passed us a reference then dereference it. This is the
 768      only way we can check the sizes of arrays and hashes */
 769   if (SvROK(thing)) {
 770     thing = SvRV(thing);
 771   }
 772
 773   sv_size(aTHX_ st, thing, ix);
 774   RETVAL = st->total_size;
 775   free_state(st);
 776 }
 777 OUTPUT:
 778   RETVAL