This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
d555ab7d08a927ca5b131f0d25a246c7a6d2e156
[perl5.git] / 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 (SvREADONLY(sv))
165         croak("Cannot modify a readonly value");
166     SvGROW(sv, sizeof(struct mstats_buffer)+1);
167     _fill_mstats((struct mstats_buffer*)SvPVX(sv),level);
168     SvCUR_set(sv, sizeof(struct mstats_buffer));
169     *SvEND(sv) = '\0';
170     SvPOK_only(sv);
171 }
172
173 static void
174 _mstats_to_hv(HV *hv, const struct mstats_buffer *b, int level)
175 {
176     dTHX;
177     SV **svp;
178     int type;
179
180     svp = hv_fetch(hv, "topbucket", 9, 1);
181     sv_setiv(*svp, b->buffer.topbucket);
182
183     svp = hv_fetch(hv, "topbucket_ev", 12, 1);
184     sv_setiv(*svp, b->buffer.topbucket_ev);
185
186     svp = hv_fetch(hv, "topbucket_odd", 13, 1);
187     sv_setiv(*svp, b->buffer.topbucket_odd);
188
189     svp = hv_fetch(hv, "totfree", 7, 1);
190     sv_setiv(*svp, b->buffer.totfree);
191
192     svp = hv_fetch(hv, "total", 5, 1);
193     sv_setiv(*svp, b->buffer.total);
194
195     svp = hv_fetch(hv, "total_chain", 11, 1);
196     sv_setiv(*svp, b->buffer.total_chain);
197
198     svp = hv_fetch(hv, "total_sbrk", 10, 1);
199     sv_setiv(*svp, b->buffer.total_sbrk);
200
201     svp = hv_fetch(hv, "sbrks", 5, 1);
202     sv_setiv(*svp, b->buffer.sbrks);
203
204     svp = hv_fetch(hv, "sbrk_good", 9, 1);
205     sv_setiv(*svp, b->buffer.sbrk_good);
206
207     svp = hv_fetch(hv, "sbrk_slack", 10, 1);
208     sv_setiv(*svp, b->buffer.sbrk_slack);
209
210     svp = hv_fetch(hv, "start_slack", 11, 1);
211     sv_setiv(*svp, b->buffer.start_slack);
212
213     svp = hv_fetch(hv, "sbrked_remains", 14, 1);
214     sv_setiv(*svp, b->buffer.sbrked_remains);
215     
216     svp = hv_fetch(hv, "minbucket", 9, 1);
217     sv_setiv(*svp, b->buffer.minbucket);
218     
219     svp = hv_fetch(hv, "nbuckets", 8, 1);
220     sv_setiv(*svp, b->buffer.nbuckets);
221
222     if (_NBUCKETS < b->buffer.nbuckets) 
223         warn("FIXME: internal mstats buffer too short");
224     
225     for (type = 0; type < (level ? 4 : 2); type++) {
226         UV *p = 0, *p1 = 0, i;
227         AV *av;
228         static const char *types[4] = { 
229             "free", "used", "mem_size", "available_size"    
230         };
231
232         svp = hv_fetch(hv, types[type], strlen(types[type]), 1);
233
234         if (SvOK(*svp) && !(SvROK(*svp) && SvTYPE(SvRV(*svp)) == SVt_PVAV))
235             croak("Unexpected value for the key '%s' in the mstats hash", types[type]);
236         if (!SvOK(*svp)) {
237             av = newAV();
238             (void)SvUPGRADE(*svp, SVt_RV);
239             SvRV_set(*svp, (SV*)av);
240             SvROK_on(*svp);
241         } else
242             av = (AV*)SvRV(*svp);
243
244         av_extend(av, b->buffer.nbuckets - 1);
245         /* XXXX What is the official way to reduce the size of the array? */
246         switch (type) {
247         case 0:
248             p = b->buffer.nfree;
249             break;
250         case 1:
251             p = b->buffer.ntotal;
252             p1 = b->buffer.nfree;
253             break;
254         case 2:
255             p = b->buffer.bucket_mem_size;
256             break;
257         case 3:
258             p = b->buffer.bucket_available_size;
259             break;
260         }
261         for (i = 0; i < b->buffer.nbuckets; i++) {
262             svp = av_fetch(av, i, 1);
263             if (type == 1)
264                 sv_setiv(*svp, p[i]-p1[i]);
265             else
266                 sv_setuv(*svp, p[i]);
267         }
268     }
269 }
270
271 static void
272 mstats_fillhash(SV *sv, int level)
273 {
274     struct mstats_buffer buf;
275
276     if (!(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVHV))
277         croak("Not a hash reference");
278     _fill_mstats(&buf, level);
279     _mstats_to_hv((HV *)SvRV(sv), &buf, level);
280 }
281
282 static void
283 mstats2hash(SV *sv, SV *rv, int level)
284 {
285     if (!(SvROK(rv) && SvTYPE(SvRV(rv)) == SVt_PVHV))
286         croak("Not a hash reference");
287     if (!SvPOK(sv))
288         croak("Undefined value when expecting mstats buffer");
289     if (SvCUR(sv) != sizeof(struct mstats_buffer))
290         croak("Wrong size for a value with a mstats buffer");
291     _mstats_to_hv((HV *)SvRV(rv), (struct mstats_buffer*)SvPVX(sv), level);
292 }
293 #else   /* defined(MYMALLOC) */ 
294 static void
295 fill_mstats(SV *sv, int level)
296 {
297     croak("Cannot report mstats without Perl malloc");
298 }
299
300 static void
301 mstats_fillhash(SV *sv, int level)
302 {
303     croak("Cannot report mstats without Perl malloc");
304 }
305
306 static void
307 mstats2hash(SV *sv, SV *rv, int level)
308 {
309     croak("Cannot report mstats without Perl malloc");
310 }
311 #endif  /* defined(MYMALLOC) */ 
312
313 #define _CvGV(cv)                                       \
314         (SvROK(cv) && (SvTYPE(SvRV(cv))==SVt_PVCV)      \
315          ? SvREFCNT_inc(CvGV((CV*)SvRV(cv))) : &PL_sv_undef)
316
317 MODULE = Devel::Peek            PACKAGE = Devel::Peek
318
319 void
320 mstat(str="Devel::Peek::mstat: ")
321 const char *str
322
323 void
324 fill_mstats(SV *sv, int level = 0)
325
326 void
327 mstats_fillhash(SV *sv, int level = 0)
328     PROTOTYPE: \%;$
329
330 void
331 mstats2hash(SV *sv, SV *rv, int level = 0)
332     PROTOTYPE: $\%;$
333
334 void
335 Dump(sv,lim=4)
336 SV *    sv
337 I32     lim
338 PPCODE:
339 {
340     SV *pv_lim_sv = perl_get_sv("Devel::Peek::pv_limit", 0);
341     const STRLEN pv_lim = pv_lim_sv ? SvIV(pv_lim_sv) : 0;
342     SV *dumpop = perl_get_sv("Devel::Peek::dump_ops", 0);
343     const U16 save_dumpindent = PL_dumpindent;
344     PL_dumpindent = 2;
345     do_sv_dump(0, Perl_debug_log, sv, 0, lim,
346                (bool)(dumpop && SvTRUE(dumpop)), pv_lim);
347     PL_dumpindent = save_dumpindent;
348 }
349
350 void
351 DumpArray(lim,...)
352 I32     lim
353 PPCODE:
354 {
355     long i;
356     SV *pv_lim_sv = perl_get_sv("Devel::Peek::pv_limit", 0);
357     const STRLEN pv_lim = pv_lim_sv ? SvIV(pv_lim_sv) : 0;
358     SV *dumpop = perl_get_sv("Devel::Peek::dump_ops", 0);
359     const U16 save_dumpindent = PL_dumpindent;
360     PL_dumpindent = 2;
361
362     for (i=1; i<items; i++) {
363         PerlIO_printf(Perl_debug_log, "Elt No. %ld  0x%"UVxf"\n", i - 1, PTR2UV(ST(i)));
364         do_sv_dump(0, Perl_debug_log, ST(i), 0, lim,
365                    (bool)(dumpop && SvTRUE(dumpop)), pv_lim);
366     }
367     PL_dumpindent = save_dumpindent;
368 }
369
370 void
371 DumpProg()
372 PPCODE:
373 {
374     warn("dumpindent is %d", (int)PL_dumpindent);
375     if (PL_main_root)
376         op_dump(PL_main_root);
377 }
378
379 I32
380 SvREFCNT(sv)
381 SV *    sv
382
383 # PPCODE needed since otherwise sv_2mortal is inserted that will kill the value.
384
385 SV *
386 SvREFCNT_inc(sv)
387 SV *    sv
388 PPCODE:
389 {
390     RETVAL = SvREFCNT_inc(sv);
391     PUSHs(RETVAL);
392 }
393
394 # PPCODE needed since by default it is void
395
396 void
397 SvREFCNT_dec(sv)
398 SV *    sv
399 PPCODE:
400 {
401     SvREFCNT_dec(sv);
402     PUSHs(sv);
403 }
404
405 SV *
406 DeadCode()
407 CODE:
408     RETVAL = DeadCode(aTHX);
409 OUTPUT:
410     RETVAL
411
412 MODULE = Devel::Peek            PACKAGE = Devel::Peek   PREFIX = _
413
414 SV *
415 _CvGV(cv)
416     SV *cv
417
418 bool
419 _runops_debug(int flag = -1)