Follow mg_obj, which points to an SV.
[p5sagit/Devel-Size.git] / Size.xs
CommitLineData
265a0548 1#define PERL_NO_GET_CONTEXT
2
e98cedbf 3#include "EXTERN.h"
4#include "perl.h"
5#include "XSUB.h"
2eb93d08 6#include "ppport.h"
e98cedbf 7
87372f42 8/* Not yet in ppport.h */
9#ifndef CvISXSUB
10# define CvISXSUB(cv) (CvXSUB(cv) ? TRUE : FALSE)
11#endif
0e1f978f 12#ifndef SvRV_const
13# define SvRV_const(rv) SvRV(rv)
14#endif
87372f42 15
9fc9ab86 16#ifdef _MSC_VER
1a36ac09 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)
9fc9ab86 24#else
1a36ac09 25# define TRY_TO_CATCH_SEGV if(1)
26# define CAUGHT_EXCEPTION else
9fc9ab86 27#endif
28
29#ifdef __GNUC__
30# define __attribute__(x)
31#endif
32
b7621729 33#if 0 && defined(DEBUGGING)
34#define dbg_printf(x) printf x
35#else
36#define dbg_printf(x)
37#endif
98ecbbc6 38
0964064b 39#define TAG /* printf( "# %s(%d)\n", __FILE__, __LINE__ ) */
6a9ad7ec 40#define carp puts
9fc9ab86 41
30fe4f47 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
30fe4f47 49#define BYTE_BITS 3
50#define LEAF_BITS (16 - BYTE_BITS)
51#define LEAF_MASK 0x1FFF
9fc9ab86 52
65db36c0 53struct state {
eee00145 54 UV total_size;
65db36c0 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
9fc9ab86 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 */
2eb93d08 70static bool
a4efdff3 71check_new(struct state *st, const void *const p) {
30fe4f47 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
f404ed48 80 = (raw_p >> ALIGN_BITS) | (raw_p << (bits - ALIGN_BITS));
30fe4f47 81 const U8 this_bit = 1 << (cooked_p & 0x7);
82 U8 **leaf_p;
83 U8 *leaf;
84 unsigned int i;
302077b6 85 void **tv_p = (void **) (st->tracking);
30fe4f47 86
302077b6 87 if (NULL == p) return FALSE;
1a36ac09 88 TRY_TO_CATCH_SEGV {
2eb93d08 89 const char c = *(const char *)p;
9fc9ab86 90 }
1a36ac09 91 CAUGHT_EXCEPTION {
a4efdff3 92 if (st->dangle_whine)
9fc9ab86 93 warn( "Devel::Size: Encountered invalid pointer: %p\n", p );
94 return FALSE;
95 }
9fc9ab86 96 TAG;
30fe4f47 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 */
5f04c81d 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 */
30fe4f47 113 assert(bits == 16);
5f04c81d 114#endif
30fe4f47 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
9fc9ab86 121 TAG;
30fe4f47 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;
9fc9ab86 129 return TRUE;
130}
131
e9716740 132static void
30fe4f47 133free_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
154static void
a4efdff3 155free_state(struct state *st)
e9716740 156{
30fe4f47 157 const int top_level = (sizeof(void *) * 8 - LEAF_BITS - BYTE_BITS) / 8;
a4efdff3 158 free_tracking_at((void **)st->tracking, top_level);
159 Safefree(st);
e9716740 160}
161
f3cf7e20 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
176static bool sv_size(pTHX_ struct state *, const SV *const, const int recurse);
db519f11 177
7ccc7d88 178typedef enum {
9fc9ab86 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 */
7ccc7d88 191} opclass;
192
193static opclass
9fc9ab86 194cc_opclass(const OP * const o)
7ccc7d88 195{
196 if (!o)
9fc9ab86 197 return OPc_NULL;
1a36ac09 198 TRY_TO_CATCH_SEGV {
9fc9ab86 199 if (o->op_type == 0)
200 return (o->op_flags & OPf_KIDS) ? OPc_UNOP : OPc_BASEOP;
7ccc7d88 201
9fc9ab86 202 if (o->op_type == OP_SASSIGN)
203 return ((o->op_private & OPpASSIGN_BACKWARDS) ? OPc_UNOP : OPc_BINOP);
7ccc7d88 204
9fc9ab86 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
7ccc7d88 209
9fc9ab86 210 if ((o->op_type == OP_TRANS)) {
211 return OPc_BASEOP;
212 }
7ccc7d88 213
9fc9ab86 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;
62691e7c 223
9fc9ab86 224 case OA_LOGOP: TAG;
225 return OPc_LOGOP;
7ccc7d88 226
9fc9ab86 227 case OA_LISTOP: TAG;
228 return OPc_LISTOP;
7ccc7d88 229
9fc9ab86 230 case OA_PMOP: TAG;
231 return OPc_PMOP;
7ccc7d88 232
9fc9ab86 233 case OA_SVOP: TAG;
234 return OPc_SVOP;
7ccc7d88 235
9fc9ab86 236 case OA_PADOP: TAG;
237 return OPc_PADOP;
7ccc7d88 238
9fc9ab86 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;
7ccc7d88 249
9fc9ab86 250 case OA_LOOP: TAG;
251 return OPc_LOOP;
7ccc7d88 252
9fc9ab86 253 case OA_COP: TAG;
254 return OPc_COP;
7ccc7d88 255
9fc9ab86 256 case OA_BASEOP_OR_UNOP: TAG;
7ccc7d88 257 /*
9fc9ab86 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.
7ccc7d88 263 */
9fc9ab86 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 }
1a36ac09 302 CAUGHT_EXCEPTION { }
7ccc7d88 303 return OPc_BASEOP;
304}
305
6a9ad7ec 306
a6ea0805 307#if !defined(NV)
308#define NV double
309#endif
310
6a9ad7ec 311/* Figure out how much magic is attached to the SV and return the
312 size */
eee00145 313static void
b7130948 314magic_size(pTHX_ const SV * const thing, struct state *st) {
6a9ad7ec 315 MAGIC *magic_pointer;
316
317 /* Is there any? */
318 if (!SvMAGIC(thing)) {
319 /* No, bail */
eee00145 320 return;
6a9ad7ec 321 }
322
323 /* Get the base magic pointer */
324 magic_pointer = SvMAGIC(thing);
325
326 /* Have we seen the magic pointer? */
e5c69bdd 327 while (check_new(st, magic_pointer)) {
eee00145 328 st->total_size += sizeof(MAGIC);
6a9ad7ec 329
1a36ac09 330 TRY_TO_CATCH_SEGV {
9fc9ab86 331 /* Have we seen the magic vtable? */
e5c69bdd 332 if (check_new(st, magic_pointer->mg_virtual)) {
eee00145 333 st->total_size += sizeof(MGVTBL);
9fc9ab86 334 }
b7130948 335 sv_size(aTHX_ st, magic_pointer->mg_obj, TOTAL_SIZE_RECURSION);
6a9ad7ec 336
0964064b 337 /* Get the next in the chain */
9fc9ab86 338 magic_pointer = magic_pointer->mg_moremagic;
339 }
1a36ac09 340 CAUGHT_EXCEPTION {
a4efdff3 341 if (st->dangle_whine)
9fc9ab86 342 warn( "Devel::Size: Encountered bad magic at: %p\n", magic_pointer );
343 }
6a9ad7ec 344 }
6a9ad7ec 345}
346
eee00145 347static void
99684fd4 348check_new_and_strlen(struct state *st, const char *const p) {
349 if(check_new(st, p))
6ec51ae0 350 st->total_size += 1 + strlen(p);
99684fd4 351}
352
353static void
eee00145 354regex_size(const REGEXP * const baseregex, struct state *st) {
c1bfd7da 355 if(!check_new(st, baseregex))
356 return;
eee00145 357 st->total_size += sizeof(REGEXP);
9fc9ab86 358#if (PERL_VERSION < 11)
6ea94d90 359 /* Note the size of the paren offset thing */
eee00145 360 st->total_size += sizeof(I32) * baseregex->nparens * 2;
361 st->total_size += strlen(baseregex->precomp);
6ea94d90 362#else
eee00145 363 st->total_size += sizeof(struct regexp);
364 st->total_size += sizeof(I32) * SvANY(baseregex)->nparens * 2;
365 /*st->total_size += strlen(SvANY(baseregex)->subbeg);*/
6ea94d90 366#endif
a4efdff3 367 if (st->go_yell && !st->regex_whine) {
6ea94d90 368 carp("Devel::Size: Calculated sizes for compiled regexes are incompatible, and probably always will be");
a4efdff3 369 st->regex_whine = 1;
98ecbbc6 370 }
7ccc7d88 371}
372
eee00145 373static void
1e5a8ad2 374op_size(pTHX_ const OP * const baseop, struct state *st)
375{
376 TRY_TO_CATCH_SEGV {
377 TAG;
378 if(!check_new(st, baseop))
379 return;
380 TAG;
381 op_size(aTHX_ baseop->op_next, st);
382 TAG;
383 switch (cc_opclass(baseop)) {
384 case OPc_BASEOP: TAG;
385 st->total_size += sizeof(struct op);
386 TAG;break;
387 case OPc_UNOP: TAG;
388 st->total_size += sizeof(struct unop);
389 op_size(aTHX_ cUNOPx(baseop)->op_first, st);
390 TAG;break;
391 case OPc_BINOP: TAG;
392 st->total_size += sizeof(struct binop);
393 op_size(aTHX_ cBINOPx(baseop)->op_first, st);
394 op_size(aTHX_ cBINOPx(baseop)->op_last, st);
395 TAG;break;
396 case OPc_LOGOP: TAG;
397 st->total_size += sizeof(struct logop);
398 op_size(aTHX_ cBINOPx(baseop)->op_first, st);
399 op_size(aTHX_ cLOGOPx(baseop)->op_other, st);
400 TAG;break;
401 case OPc_LISTOP: TAG;
402 st->total_size += sizeof(struct listop);
403 op_size(aTHX_ cLISTOPx(baseop)->op_first, st);
404 op_size(aTHX_ cLISTOPx(baseop)->op_last, st);
405 TAG;break;
406 case OPc_PMOP: TAG;
407 st->total_size += sizeof(struct pmop);
408 op_size(aTHX_ cPMOPx(baseop)->op_first, st);
409 op_size(aTHX_ cPMOPx(baseop)->op_last, st);
5a83b7cf 410#if PERL_VERSION < 9 || (PERL_VERSION == 9 && PERL_SUBVERSION < 5)
1e5a8ad2 411 op_size(aTHX_ cPMOPx(baseop)->op_pmreplroot, st);
412 op_size(aTHX_ cPMOPx(baseop)->op_pmreplstart, st);
413 op_size(aTHX_ (OP *)cPMOPx(baseop)->op_pmnext, st);
5a83b7cf 414#endif
c1bfd7da 415 /* This is defined away in perl 5.8.x, but it is in there for
416 5.6.x */
98ecbbc6 417#ifdef PM_GETRE
c1bfd7da 418 regex_size(PM_GETRE(cPMOPx(baseop)), st);
98ecbbc6 419#else
c1bfd7da 420 regex_size(cPMOPx(baseop)->op_pmregexp, st);
98ecbbc6 421#endif
c1bfd7da 422 TAG;break;
81f1c018 423 case OPc_SVOP: TAG;
424 st->total_size += sizeof(struct pmop);
574d9fd9 425 if (!(baseop->op_type == OP_AELEMFAST
426 && baseop->op_flags & OPf_SPECIAL)) {
427 /* not an OP_PADAV replacement */
f3cf7e20 428 sv_size(aTHX_ st, cSVOPx(baseop)->op_sv, SOME_RECURSION);
574d9fd9 429 }
81f1c018 430 TAG;break;
9fc9ab86 431 case OPc_PADOP: TAG;
eee00145 432 st->total_size += sizeof(struct padop);
99684fd4 433 TAG;break;
434 case OPc_PVOP: TAG;
435 check_new_and_strlen(st, cPVOPx(baseop)->op_pv);
219b7d34 436 TAG;break;
1e5a8ad2 437 case OPc_LOOP: TAG;
438 st->total_size += sizeof(struct loop);
439 op_size(aTHX_ cLOOPx(baseop)->op_first, st);
440 op_size(aTHX_ cLOOPx(baseop)->op_last, st);
441 op_size(aTHX_ cLOOPx(baseop)->op_redoop, st);
442 op_size(aTHX_ cLOOPx(baseop)->op_nextop, st);
443 op_size(aTHX_ cLOOPx(baseop)->op_lastop, st);
444 TAG;break;
445 case OPc_COP: TAG;
9fc9ab86 446 {
447 COP *basecop;
448 basecop = (COP *)baseop;
eee00145 449 st->total_size += sizeof(struct cop);
9fc9ab86 450
451 /* Change 33656 by nicholas@mouse-mill on 2008/04/07 11:29:51
452 Eliminate cop_label from struct cop by storing a label as the first
453 entry in the hints hash. Most statements don't have labels, so this
454 will save memory. Not sure how much.
455 The check below will be incorrect fail on bleadperls
456 before 5.11 @33656, but later than 5.10, producing slightly too
457 small memory sizes on these Perls. */
b7621729 458#if (PERL_VERSION < 11)
99684fd4 459 check_new_and_strlen(st, basecop->cop_label);
b7621729 460#endif
7ccc7d88 461#ifdef USE_ITHREADS
99684fd4 462 check_new_and_strlen(st, basecop->cop_file);
463 check_new_and_strlen(st, basecop->cop_stashpv);
7ccc7d88 464#else
f3cf7e20 465 sv_size(aTHX_ st, (SV *)basecop->cop_stash, SOME_RECURSION);
466 sv_size(aTHX_ st, (SV *)basecop->cop_filegv, SOME_RECURSION);
7ccc7d88 467#endif
468
9fc9ab86 469 }
470 TAG;break;
471 default:
472 TAG;break;
473 }
474 }
1a36ac09 475 CAUGHT_EXCEPTION {
a4efdff3 476 if (st->dangle_whine)
9fc9ab86 477 warn( "Devel::Size: Encountered dangling pointer in opcode at: %p\n", baseop );
7ccc7d88 478 }
7ccc7d88 479}
6a9ad7ec 480
24d37977 481#if PERL_VERSION > 9 || (PERL_VERSION == 9 && PERL_SUBVERSION > 2)
482# define NEW_HEAD_LAYOUT
483#endif
484
81f1c018 485static bool
db519f11 486sv_size(pTHX_ struct state *const st, const SV * const orig_thing,
f3cf7e20 487 const int recurse) {
9fc9ab86 488 const SV *thing = orig_thing;
eee00145 489
81f1c018 490 if(!check_new(st, thing))
491 return FALSE;
492
eee00145 493 st->total_size += sizeof(SV);
b1e5ad85 494
e98cedbf 495 switch (SvTYPE(thing)) {
496 /* Is it undef? */
9fc9ab86 497 case SVt_NULL: TAG;
498 TAG;break;
e98cedbf 499 /* Just a plain integer. This will be differently sized depending
500 on whether purify's been compiled in */
9fc9ab86 501 case SVt_IV: TAG;
24d37977 502#ifndef NEW_HEAD_LAYOUT
503# ifdef PURIFY
eee00145 504 st->total_size += sizeof(sizeof(XPVIV));
24d37977 505# else
eee00145 506 st->total_size += sizeof(IV);
24d37977 507# endif
e98cedbf 508#endif
81f1c018 509 if(recurse && SvROK(thing))
f3cf7e20 510 sv_size(aTHX_ st, SvRV_const(thing), recurse);
9fc9ab86 511 TAG;break;
e98cedbf 512 /* Is it a float? Like the int, it depends on purify */
9fc9ab86 513 case SVt_NV: TAG;
e98cedbf 514#ifdef PURIFY
eee00145 515 st->total_size += sizeof(sizeof(XPVNV));
e98cedbf 516#else
eee00145 517 st->total_size += sizeof(NV);
e98cedbf 518#endif
9fc9ab86 519 TAG;break;
520#if (PERL_VERSION < 11)
e98cedbf 521 /* Is it a reference? */
9fc9ab86 522 case SVt_RV: TAG;
24d37977 523#ifndef NEW_HEAD_LAYOUT
eee00145 524 st->total_size += sizeof(XRV);
24d37977 525#endif
81f1c018 526 if(recurse && SvROK(thing))
f3cf7e20 527 sv_size(aTHX_ st, SvRV_const(thing), recurse);
9fc9ab86 528 TAG;break;
6ea94d90 529#endif
e98cedbf 530 /* How about a plain string? In which case we need to add in how
531 much has been allocated */
9fc9ab86 532 case SVt_PV: TAG;
eee00145 533 st->total_size += sizeof(XPV);
db519f11 534 if(recurse && SvROK(thing))
f3cf7e20 535 sv_size(aTHX_ st, SvRV_const(thing), recurse);
eee00145 536 else
537 st->total_size += SvLEN(thing);
9fc9ab86 538 TAG;break;
e98cedbf 539 /* A string with an integer part? */
9fc9ab86 540 case SVt_PVIV: TAG;
eee00145 541 st->total_size += sizeof(XPVIV);
db519f11 542 if(recurse && SvROK(thing))
f3cf7e20 543 sv_size(aTHX_ st, SvRV_const(thing), recurse);
eee00145 544 else
545 st->total_size += SvLEN(thing);
0430b7f7 546 if(SvOOK(thing)) {
eee00145 547 st->total_size += SvIVX(thing);
9fc9ab86 548 }
549 TAG;break;
c8db37d3 550 /* A scalar/string/reference with a float part? */
9fc9ab86 551 case SVt_PVNV: TAG;
eee00145 552 st->total_size += sizeof(XPVNV);
db519f11 553 if(recurse && SvROK(thing))
f3cf7e20 554 sv_size(aTHX_ st, SvRV_const(thing), recurse);
eee00145 555 else
556 st->total_size += SvLEN(thing);
9fc9ab86 557 TAG;break;
558 case SVt_PVMG: TAG;
eee00145 559 st->total_size += sizeof(XPVMG);
db519f11 560 if(recurse && SvROK(thing))
f3cf7e20 561 sv_size(aTHX_ st, SvRV_const(thing), recurse);
eee00145 562 else
563 st->total_size += SvLEN(thing);
b7130948 564 magic_size(aTHX_ thing, st);
9fc9ab86 565 TAG;break;
0430b7f7 566#if PERL_VERSION <= 8
9fc9ab86 567 case SVt_PVBM: TAG;
eee00145 568 st->total_size += sizeof(XPVBM);
db519f11 569 if(recurse && SvROK(thing))
f3cf7e20 570 sv_size(aTHX_ st, SvRV_const(thing), recurse);
eee00145 571 else
572 st->total_size += SvLEN(thing);
b7130948 573 magic_size(aTHX_ thing, st);
9fc9ab86 574 TAG;break;
0430b7f7 575#endif
9fc9ab86 576 case SVt_PVLV: TAG;
eee00145 577 st->total_size += sizeof(XPVLV);
db519f11 578 if(recurse && SvROK(thing))
f3cf7e20 579 sv_size(aTHX_ st, SvRV_const(thing), recurse);
eee00145 580 else
581 st->total_size += SvLEN(thing);
b7130948 582 magic_size(aTHX_ thing, st);
9fc9ab86 583 TAG;break;
e98cedbf 584 /* How much space is dedicated to the array? Not counting the
585 elements in the array, mind, just the array itself */
9fc9ab86 586 case SVt_PVAV: TAG;
eee00145 587 st->total_size += sizeof(XPVAV);
e98cedbf 588 /* Is there anything in the array? */
589 if (AvMAX(thing) != -1) {
c8db37d3 590 /* an array with 10 slots has AvMax() set to 9 - te 2007-04-22 */
eee00145 591 st->total_size += sizeof(SV *) * (AvMAX(thing) + 1);
592 dbg_printf(("total_size: %li AvMAX: %li av_len: $i\n", st->total_size, AvMAX(thing), av_len((AV*)thing)));
6c5ddc0d 593
594 if (recurse >= TOTAL_SIZE_RECURSION) {
595 SSize_t i = AvFILLp(thing) + 1;
596
597 while (i--)
598 sv_size(aTHX_ st, AvARRAY(thing)[i], recurse);
599 }
e98cedbf 600 }
601 /* Add in the bits on the other side of the beginning */
0430b7f7 602
b7621729 603 dbg_printf(("total_size %li, sizeof(SV *) %li, AvARRAY(thing) %li, AvALLOC(thing)%li , sizeof(ptr) %li \n",
eee00145 604 st->total_size, sizeof(SV*), AvARRAY(thing), AvALLOC(thing), sizeof( thing )));
0430b7f7 605
606 /* under Perl 5.8.8 64bit threading, AvARRAY(thing) was a pointer while AvALLOC was 0,
b1e5ad85 607 resulting in grossly overstated sized for arrays. Technically, this shouldn't happen... */
0430b7f7 608 if (AvALLOC(thing) != 0) {
eee00145 609 st->total_size += (sizeof(SV *) * (AvARRAY(thing) - AvALLOC(thing)));
0430b7f7 610 }
795fc84c 611#if (PERL_VERSION < 9)
612 /* Is there something hanging off the arylen element?
613 Post 5.9.something this is stored in magic, so will be found there,
614 and Perl_av_arylen_p() takes a non-const AV*, hence compilers rightly
615 complain about AvARYLEN() passing thing to it. */
f3cf7e20 616 sv_size(aTHX_ st, AvARYLEN(thing), recurse);
795fc84c 617#endif
b7130948 618 magic_size(aTHX_ thing, st);
9fc9ab86 619 TAG;break;
620 case SVt_PVHV: TAG;
a6ea0805 621 /* First the base struct */
eee00145 622 st->total_size += sizeof(XPVHV);
a6ea0805 623 /* Now the array of buckets */
eee00145 624 st->total_size += (sizeof(HE *) * (HvMAX(thing) + 1));
a6ea0805 625 /* Now walk the bucket chain */
6a9ad7ec 626 if (HvARRAY(thing)) {
a6ea0805 627 HE *cur_entry;
9fc9ab86 628 UV cur_bucket = 0;
a6ea0805 629 for (cur_bucket = 0; cur_bucket <= HvMAX(thing); cur_bucket++) {
9fc9ab86 630 cur_entry = *(HvARRAY(thing) + cur_bucket);
631 while (cur_entry) {
eee00145 632 st->total_size += sizeof(HE);
9fc9ab86 633 if (cur_entry->hent_hek) {
634 /* Hash keys can be shared. Have we seen this before? */
a4efdff3 635 if (check_new(st, cur_entry->hent_hek)) {
eee00145 636 st->total_size += HEK_BASESIZE + cur_entry->hent_hek->hek_len + 2;
9fc9ab86 637 }
638 }
f3cf7e20 639 if (recurse >= TOTAL_SIZE_RECURSION)
640 sv_size(aTHX_ st, HeVAL(cur_entry), recurse);
9fc9ab86 641 cur_entry = cur_entry->hent_next;
642 }
a6ea0805 643 }
644 }
b7130948 645 magic_size(aTHX_ thing, st);
9fc9ab86 646 TAG;break;
647 case SVt_PVCV: TAG;
eee00145 648 st->total_size += sizeof(XPVCV);
b7130948 649 magic_size(aTHX_ thing, st);
7ccc7d88 650
eee00145 651 st->total_size += ((XPVIO *) SvANY(thing))->xpv_len;
f3cf7e20 652 sv_size(aTHX_ st, (SV *)CvSTASH(thing), SOME_RECURSION);
653 sv_size(aTHX_ st, (SV *)SvSTASH(thing), SOME_RECURSION);
654 sv_size(aTHX_ st, (SV *)CvGV(thing), SOME_RECURSION);
6c5ddc0d 655 sv_size(aTHX_ st, (SV *)CvPADLIST(thing), SOME_RECURSION);
f3cf7e20 656 sv_size(aTHX_ st, (SV *)CvOUTSIDE(thing), recurse);
66f50dda 657 if (CvISXSUB(thing)) {
f3cf7e20 658 sv_size(aTHX_ st, cv_const_sv((CV *)thing), recurse);
66f50dda 659 } else {
1e5a8ad2 660 op_size(aTHX_ CvSTART(thing), st);
661 op_size(aTHX_ CvROOT(thing), st);
7ccc7d88 662 }
663
9fc9ab86 664 TAG;break;
665 case SVt_PVGV: TAG;
b7130948 666 magic_size(aTHX_ thing, st);
eee00145 667 st->total_size += sizeof(XPVGV);
4a3d023d 668 if(isGV_with_GP(thing)) {
669 st->total_size += GvNAMELEN(thing);
78dfb4e7 670#ifdef GvFILE
2b217e71 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) */
4a3d023d 679 check_new_and_strlen(st, GvFILE(thing));
2b217e71 680# endif
78dfb4e7 681#endif
4a3d023d 682 /* Is there something hanging off the glob? */
683 if (check_new(st, GvGP(thing))) {
684 st->total_size += sizeof(GP);
f3cf7e20 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);
4a3d023d 691 }
5c2e1b12 692 }
9fc9ab86 693 TAG;break;
694 case SVt_PVFM: TAG;
eee00145 695 st->total_size += sizeof(XPVFM);
b7130948 696 magic_size(aTHX_ thing, st);
eee00145 697 st->total_size += ((XPVIO *) SvANY(thing))->xpv_len;
6c5ddc0d 698 sv_size(aTHX_ st, (SV *)CvPADLIST(thing), SOME_RECURSION);
f3cf7e20 699 sv_size(aTHX_ st, (SV *)CvOUTSIDE(thing), recurse);
7ccc7d88 700
a4efdff3 701 if (st->go_yell && !st->fm_whine) {
5073b933 702 carp("Devel::Size: Calculated sizes for FMs are incomplete");
a4efdff3 703 st->fm_whine = 1;
ebb2c5b9 704 }
9fc9ab86 705 TAG;break;
706 case SVt_PVIO: TAG;
eee00145 707 st->total_size += sizeof(XPVIO);
b7130948 708 magic_size(aTHX_ thing, st);
a4efdff3 709 if (check_new(st, (SvPVX_const(thing)))) {
eee00145 710 st->total_size += ((XPVIO *) SvANY(thing))->xpv_cur;
ebb2c5b9 711 }
5073b933 712 /* Some embedded char pointers */
99684fd4 713 check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_top_name);
714 check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_fmt_name);
715 check_new_and_strlen(st, ((XPVIO *) SvANY(thing))->xio_bottom_name);
5073b933 716 /* Throw the GVs on the list to be walked if they're not-null */
f3cf7e20 717 sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_top_gv, recurse);
718 sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_bottom_gv, recurse);
719 sv_size(aTHX_ st, (SV *)((XPVIO *) SvANY(thing))->xio_fmt_gv, recurse);
5073b933 720
721 /* Only go trotting through the IO structures if they're really
722 trottable. If USE_PERLIO is defined we can do this. If
723 not... we can't, so we don't even try */
724#ifdef USE_PERLIO
725 /* Dig into xio_ifp and xio_ofp here */
9fc9ab86 726 warn("Devel::Size: Can't size up perlio layers yet\n");
5073b933 727#endif
9fc9ab86 728 TAG;break;
e98cedbf 729 default:
9fc9ab86 730 warn("Devel::Size: Unknown variable type: %d encountered\n", SvTYPE(thing) );
e98cedbf 731 }
81f1c018 732 return TRUE;
e98cedbf 733}
734
d9b022a1 735void *vtables[] = {
736#include "vtables.inc"
737 NULL
738};
739
a4efdff3 740static struct state *
741new_state(pTHX)
65db36c0 742{
743 SV *warn_flag;
a4efdff3 744 struct state *st;
d9b022a1 745 void **vt_p = vtables;
746
a4efdff3 747 Newxz(st, 1, struct state);
748 st->go_yell = TRUE;
65db36c0 749 if (NULL != (warn_flag = perl_get_sv("Devel::Size::warn", FALSE))) {
a4efdff3 750 st->dangle_whine = st->go_yell = SvIV(warn_flag) ? TRUE : FALSE;
65db36c0 751 }
752 if (NULL != (warn_flag = perl_get_sv("Devel::Size::dangle", FALSE))) {
a4efdff3 753 st->dangle_whine = SvIV(warn_flag) ? TRUE : FALSE;
65db36c0 754 }
a52ceccd 755 check_new(st, &PL_sv_undef);
756 check_new(st, &PL_sv_no);
757 check_new(st, &PL_sv_yes);
d9b022a1 758 while(*vt_p)
759 check_new(st, *vt_p++);
a4efdff3 760 return st;
65db36c0 761}
762
9fc9ab86 763MODULE = Devel::Size PACKAGE = Devel::Size
e98cedbf 764
fea63ffa 765PROTOTYPES: DISABLE
766
eee00145 767UV
a6ea0805 768size(orig_thing)
769 SV *orig_thing
13683e3a 770ALIAS:
771 total_size = TOTAL_SIZE_RECURSION
e98cedbf 772CODE:
773{
6a9ad7ec 774 SV *thing = orig_thing;
a4efdff3 775 struct state *st = new_state(aTHX);
ebb2c5b9 776
6a9ad7ec 777 /* If they passed us a reference then dereference it. This is the
778 only way we can check the sizes of arrays and hashes */
b7621729 779 if (SvROK(thing)) {
780 thing = SvRV(thing);
781 }
b7621729 782
13683e3a 783 sv_size(aTHX_ st, thing, ix);
eee00145 784 RETVAL = st->total_size;
a4efdff3 785 free_state(st);
6a9ad7ec 786}
787OUTPUT:
788 RETVAL