ext/Devel/Peek/Peek.xs

   1 #define PERL_NO_GET_CONTEXT
   2 #include "EXTERN.h"
   3 #include "perl.h"
   4 #include "XSUB.h"
   5
   6 static bool
   7 _runops_debug(int flag)
   8 {
   9     dTHX;
  10     const bool d = PL_runops == MEMBER_TO_FPTR(Perl_runops_debug);
  11
  12     if (flag >= 0)
  13         PL_runops
  14             = MEMBER_TO_FPTR(flag ? Perl_runops_debug : Perl_runops_standard);
  15     return d;
  16 }
  17
  18 static SV *
  19 DeadCode(pTHX)
  20 {
  21 #ifdef PURIFY
  22     return Nullsv;
  23 #else
  24     SV* sva;
  25     SV* sv;
  26     SV* ret = newRV_noinc((SV*)newAV());
  27     register SV* svend;
  28     int tm = 0, tref = 0, ts = 0, ta = 0, tas = 0;
  29
  30     for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
  31         svend = &sva[SvREFCNT(sva)];
  32         for (sv = sva + 1; sv < svend; ++sv) {
  33             if (SvTYPE(sv) == SVt_PVCV) {
  34                 CV *cv = (CV*)sv;
  35                 AV* padlist = CvPADLIST(cv), *argav;
  36                 SV** svp;
  37                 SV** pad;
  38                 int i = 0, j, levelm, totm = 0, levelref, totref = 0;
  39                 int levels, tots = 0, levela, tota = 0, levelas, totas = 0;
  40                 int dumpit = 0;
  41
  42                 if (CvISXSUB(sv)) {
  43                     continue;           /* XSUB */
  44                 }
  45                 if (!CvGV(sv)) {
  46                     continue;           /* file-level scope. */
  47                 }
  48                 if (!CvROOT(cv)) {
  49                     /* PerlIO_printf(Perl_debug_log, "  no root?!\n"); */
  50                     continue;           /* autoloading stub. */
  51                 }
  52                 do_gvgv_dump(0, Perl_debug_log, "GVGV::GV", CvGV(sv));
  53                 if (CvDEPTH(cv)) {
  54                     PerlIO_printf(Perl_debug_log, "  busy\n");
  55                     continue;
  56                 }
  57                 svp = AvARRAY(padlist);
  58                 while (++i <= AvFILL(padlist)) { /* Depth. */
  59                     SV **args;
  60
  61                     pad = AvARRAY((AV*)svp[i]);
  62                     argav = (AV*)pad[0];
  63                     if (!argav || (SV*)argav == &PL_sv_undef) {
  64                         PerlIO_printf(Perl_debug_log, "    closure-template\n");
  65                         continue;
  66                     }
  67                     args = AvARRAY(argav);
  68                     levelm = levels = levelref = levelas = 0;
  69                     levela = sizeof(SV*) * (AvMAX(argav) + 1);
  70                     if (AvREAL(argav)) {
  71                         for (j = 0; j < AvFILL(argav); j++) {
  72                             if (SvROK(args[j])) {
  73                                 PerlIO_printf(Perl_debug_log, "     ref in args!\n");
  74                                 levelref++;
  75                             }
  76                             /* else if (SvPOK(args[j]) && SvPVX(args[j])) { */
  77                             else if (SvTYPE(args[j]) >= SVt_PV && SvLEN(args[j])) {
  78                                 levelas += SvLEN(args[j])/SvREFCNT(args[j]);
  79                             }
  80                         }
  81                     }
  82                     for (j = 1; j < AvFILL((AV*)svp[1]); j++) { /* Vars. */
  83                         if (SvROK(pad[j])) {
  84                             levelref++;
  85                             do_sv_dump(0, Perl_debug_log, pad[j], 0, 4, 0, 0);
  86                             dumpit = 1;
  87                         }
  88                         /* else if (SvPOK(pad[j]) && SvPVX(pad[j])) { */
  89                         else if (SvTYPE(pad[j]) >= SVt_PVAV) {
  90                             if (!SvPADMY(pad[j])) {
  91                                 levelref++;
  92                                 do_sv_dump(0, Perl_debug_log, pad[j], 0, 4, 0, 0);
  93                                 dumpit = 1;
  94                             }
  95                         }
  96                         else if (SvTYPE(pad[j]) >= SVt_PV && SvLEN(pad[j])) {
  97                             levels++;
  98                             levelm += SvLEN(pad[j])/SvREFCNT(pad[j]);
  99                                 /* Dump(pad[j],4); */
 100                         }
 101                     }
 102                     PerlIO_printf(Perl_debug_log, "    level %i: refs: %i, strings: %i in %i,\targsarray: %i, argsstrings: %i\n",
 103                             i, levelref, levelm, levels, levela, levelas);
 104                     totm += levelm;
 105                     tota += levela;
 106                     totas += levelas;
 107                     tots += levels;
 108                     totref += levelref;
 109                     if (dumpit)
 110                         do_sv_dump(0, Perl_debug_log, (SV*)cv, 0, 2, 0, 0);
 111                 }
 112                 if (AvFILL(padlist) > 1) {
 113                     PerlIO_printf(Perl_debug_log, "  total: refs: %i, strings: %i in %i,\targsarrays: %i, argsstrings: %i\n",
 114                             totref, totm, tots, tota, totas);
 115                 }
 116                 tref += totref;
 117                 tm += totm;
 118                 ts += tots;
 119                 ta += tota;
 120                 tas += totas;
 121             }
 122         }
 123     }
 124     PerlIO_printf(Perl_debug_log, "total: refs: %i, strings: %i in %i\targsarray: %i, argsstrings: %i\n", tref, tm, ts, ta, tas);
 125
 126     return ret;
 127 #endif /* !PURIFY */
 128 }
 129
 130 #if (defined(PERL_DEBUGGING_MSTATS) || defined(DEBUGGING_MSTATS)) \
 131         && (defined(MYMALLOC) && !defined(PLAIN_MALLOC))
 132 #   define mstat(str) dump_mstats(str)
 133 #else
 134 #   define mstat(str) \
 135         PerlIO_printf(Perl_debug_log, "%s: perl not compiled with DEBUGGING_MSTATS\n",str);
 136 #endif
 137
 138 #if (defined(PERL_DEBUGGING_MSTATS) || defined(DEBUGGING_MSTATS)) \
 139         && (defined(MYMALLOC) && !defined(PLAIN_MALLOC))
 140
 141 /* Very coarse overestimate, 2-per-power-of-2, one more to determine NBUCKETS. */
 142 #  define _NBUCKETS (2*8*IVSIZE+1)
 143
 144 struct mstats_buffer
 145 {
 146     perl_mstats_t buffer;
 147     UV buf[_NBUCKETS*4];
 148 };
 149
 150 static void
 151 _fill_mstats(struct mstats_buffer *b, int level)
 152 {
 153     dTHX;
 154     b->buffer.nfree  = b->buf;
 155     b->buffer.ntotal = b->buf + _NBUCKETS;
 156     b->buffer.bucket_mem_size = b->buf + 2*_NBUCKETS;
 157     b->buffer.bucket_available_size = b->buf + 3*_NBUCKETS;
 158     Zero(b->buf, (level ? 4*_NBUCKETS: 2*_NBUCKETS), unsigned long);
 159     get_mstats(&(b->buffer), _NBUCKETS, level);
 160 }
 161
 162 static void
 163 fill_mstats(SV *sv, int level)
 164 {
 165     dTHX;
 166
 167     if (SvREADONLY(sv))
 168         croak("Cannot modify a readonly value");
 169     SvGROW(sv, sizeof(struct mstats_buffer)+1);
 170     _fill_mstats((struct mstats_buffer*)SvPVX(sv),level);
 171     SvCUR_set(sv, sizeof(struct mstats_buffer));
 172     *SvEND(sv) = '\0';
 173     SvPOK_only(sv);
 174 }
 175
 176 static void
 177 _mstats_to_hv(HV *hv, const struct mstats_buffer *b, int level)
 178 {
 179     dTHX;
 180     SV **svp;
 181     int type;
 182
 183     svp = hv_fetch(hv, "topbucket", 9, 1);
 184     sv_setiv(*svp, b->buffer.topbucket);
 185
 186     svp = hv_fetch(hv, "topbucket_ev", 12, 1);
 187     sv_setiv(*svp, b->buffer.topbucket_ev);
 188
 189     svp = hv_fetch(hv, "topbucket_odd", 13, 1);
 190     sv_setiv(*svp, b->buffer.topbucket_odd);
 191
 192     svp = hv_fetch(hv, "totfree", 7, 1);
 193     sv_setiv(*svp, b->buffer.totfree);
 194
 195     svp = hv_fetch(hv, "total", 5, 1);
 196     sv_setiv(*svp, b->buffer.total);
 197
 198     svp = hv_fetch(hv, "total_chain", 11, 1);
 199     sv_setiv(*svp, b->buffer.total_chain);
 200
 201     svp = hv_fetch(hv, "total_sbrk", 10, 1);
 202     sv_setiv(*svp, b->buffer.total_sbrk);
 203
 204     svp = hv_fetch(hv, "sbrks", 5, 1);
 205     sv_setiv(*svp, b->buffer.sbrks);
 206
 207     svp = hv_fetch(hv, "sbrk_good", 9, 1);
 208     sv_setiv(*svp, b->buffer.sbrk_good);
 209
 210     svp = hv_fetch(hv, "sbrk_slack", 10, 1);
 211     sv_setiv(*svp, b->buffer.sbrk_slack);
 212
 213     svp = hv_fetch(hv, "start_slack", 11, 1);
 214     sv_setiv(*svp, b->buffer.start_slack);
 215
 216     svp = hv_fetch(hv, "sbrked_remains", 14, 1);
 217     sv_setiv(*svp, b->buffer.sbrked_remains);
 218
 219     svp = hv_fetch(hv, "minbucket", 9, 1);
 220     sv_setiv(*svp, b->buffer.minbucket);
 221
 222     svp = hv_fetch(hv, "nbuckets", 8, 1);
 223     sv_setiv(*svp, b->buffer.nbuckets);
 224
 225     if (_NBUCKETS < b->buffer.nbuckets)
 226         warn("FIXME: internal mstats buffer too short");
 227
 228     for (type = 0; type < (level ? 4 : 2); type++) {
 229         UV *p = 0, *p1 = 0, i;
 230         AV *av;
 231         static const char *types[4] = {
 232             "free", "used", "mem_size", "available_size"
 233         };
 234
 235         svp = hv_fetch(hv, types[type], strlen(types[type]), 1);
 236
 237         if (SvOK(*svp) && !(SvROK(*svp) && SvTYPE(SvRV(*svp)) == SVt_PVAV))
 238             croak("Unexpected value for the key '%s' in the mstats hash", types[type]);
 239         if (!SvOK(*svp)) {
 240             av = newAV();
 241             (void)SvUPGRADE(*svp, SVt_RV);
 242             SvRV_set(*svp, (SV*)av);
 243             SvROK_on(*svp);
 244         } else
 245             av = (AV*)SvRV(*svp);
 246
 247         av_extend(av, b->buffer.nbuckets - 1);
 248         /* XXXX What is the official way to reduce the size of the array? */
 249         switch (type) {
 250         case 0:
 251             p = b->buffer.nfree;
 252             break;
 253         case 1:
 254             p = b->buffer.ntotal;
 255             p1 = b->buffer.nfree;
 256             break;
 257         case 2:
 258             p = b->buffer.bucket_mem_size;
 259             break;
 260         case 3:
 261             p = b->buffer.bucket_available_size;
 262             break;
 263         }
 264         for (i = 0; i < b->buffer.nbuckets; i++) {
 265             svp = av_fetch(av, i, 1);
 266             if (type == 1)
 267                 sv_setiv(*svp, p[i]-p1[i]);
 268             else
 269                 sv_setuv(*svp, p[i]);
 270         }
 271     }
 272 }
 273
 274 static void
 275 mstats_fillhash(SV *sv, int level)
 276 {
 277     struct mstats_buffer buf;
 278
 279     if (!(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVHV))
 280         croak("Not a hash reference");
 281     _fill_mstats(&buf, level);
 282     _mstats_to_hv((HV *)SvRV(sv), &buf, level);
 283 }
 284
 285 static void
 286 mstats2hash(SV *sv, SV *rv, int level)
 287 {
 288     if (!(SvROK(rv) && SvTYPE(SvRV(rv)) == SVt_PVHV))
 289         croak("Not a hash reference");
 290     if (!SvPOK(sv))
 291         croak("Undefined value when expecting mstats buffer");
 292     if (SvCUR(sv) != sizeof(struct mstats_buffer))
 293         croak("Wrong size for a value with a mstats buffer");
 294     _mstats_to_hv((HV *)SvRV(rv), (struct mstats_buffer*)SvPVX(sv), level);
 295 }
 296 #else   /* !( defined(PERL_DEBUGGING_MSTATS) || defined(DEBUGGING_MSTATS) \ ) */
 297 static void
 298 fill_mstats(SV *sv, int level)
 299 {
 300     croak("Cannot report mstats without Perl malloc");
 301 }
 302
 303 static void
 304 mstats_fillhash(SV *sv, int level)
 305 {
 306     croak("Cannot report mstats without Perl malloc");
 307 }
 308
 309 static void
 310 mstats2hash(SV *sv, SV *rv, int level)
 311 {
 312     croak("Cannot report mstats without Perl malloc");
 313 }
 314 #endif  /* defined(PERL_DEBUGGING_MSTATS) || defined(DEBUGGING_MSTATS)... */
 315
 316 #define _CvGV(cv)                                       \
 317         (SvROK(cv) && (SvTYPE(SvRV(cv))==SVt_PVCV)      \
 318          ? SvREFCNT_inc(CvGV((CV*)SvRV(cv))) : &PL_sv_undef)
 319
 320 MODULE = Devel::Peek            PACKAGE = Devel::Peek
 321
 322 void
 323 mstat(str="Devel::Peek::mstat: ")
 324 char *str
 325
 326 void
 327 fill_mstats(SV *sv, int level = 0)
 328
 329 void
 330 mstats_fillhash(SV *sv, int level = 0)
 331     PROTOTYPE: \%;$
 332
 333 void
 334 mstats2hash(SV *sv, SV *rv, int level = 0)
 335     PROTOTYPE: $\%;$
 336
 337 void
 338 Dump(sv,lim=4)
 339 SV *    sv
 340 I32     lim
 341 PPCODE:
 342 {
 343     SV *pv_lim_sv = perl_get_sv("Devel::Peek::pv_limit", FALSE);
 344     const STRLEN pv_lim = pv_lim_sv ? SvIV(pv_lim_sv) : 0;
 345     SV *dumpop = perl_get_sv("Devel::Peek::dump_ops", FALSE);
 346     const U16 save_dumpindent = PL_dumpindent;
 347     PL_dumpindent = 2;
 348     do_sv_dump(0, Perl_debug_log, sv, 0, lim,
 349                (bool)(dumpop && SvTRUE(dumpop)), pv_lim);
 350     PL_dumpindent = save_dumpindent;
 351 }
 352
 353 void
 354 DumpArray(lim,...)
 355 I32     lim
 356 PPCODE:
 357 {
 358     long i;
 359     SV *pv_lim_sv = perl_get_sv("Devel::Peek::pv_limit", FALSE);
 360     const STRLEN pv_lim = pv_lim_sv ? SvIV(pv_lim_sv) : 0;
 361     SV *dumpop = perl_get_sv("Devel::Peek::dump_ops", FALSE);
 362     const U16 save_dumpindent = PL_dumpindent;
 363     PL_dumpindent = 2;
 364
 365     for (i=1; i<items; i++) {
 366         PerlIO_printf(Perl_debug_log, "Elt No. %ld  0x%"UVxf"\n", i - 1, PTR2UV(ST(i)));
 367         do_sv_dump(0, Perl_debug_log, ST(i), 0, lim,
 368                    (bool)(dumpop && SvTRUE(dumpop)), pv_lim);
 369     }
 370     PL_dumpindent = save_dumpindent;
 371 }
 372
 373 void
 374 DumpProg()
 375 PPCODE:
 376 {
 377     warn("dumpindent is %d", (int)PL_dumpindent);
 378     if (PL_main_root)
 379         op_dump(PL_main_root);
 380 }
 381
 382 I32
 383 SvREFCNT(sv)
 384 SV *    sv
 385
 386 # PPCODE needed since otherwise sv_2mortal is inserted that will kill the value.
 387
 388 SV *
 389 SvREFCNT_inc(sv)
 390 SV *    sv
 391 PPCODE:
 392 {
 393     RETVAL = SvREFCNT_inc(sv);
 394     PUSHs(RETVAL);
 395 }
 396
 397 # PPCODE needed since by default it is void
 398
 399 void
 400 SvREFCNT_dec(sv)
 401 SV *    sv
 402 PPCODE:
 403 {
 404     SvREFCNT_dec(sv);
 405     PUSHs(sv);
 406 }
 407
 408 SV *
 409 DeadCode()
 410 CODE:
 411     RETVAL = DeadCode(aTHX);
 412 OUTPUT:
 413     RETVAL
 414
 415 MODULE = Devel::Peek            PACKAGE = Devel::Peek   PREFIX = _
 416
 417 SV *
 418 _CvGV(cv)
 419     SV *cv
 420
 421 bool
 422 _runops_debug(int flag = -1)