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