[perl5.git] / ext / B / B / Debug.pm

package B::Debug;

our $VERSION = '1.05_02';

use strict;
use B qw(peekop class walkoptree walkoptree_exec
         main_start main_root cstring sv_undef @specialsv_name);
# <=5.008 had @specialsv_name exported from B::Asmdata
BEGIN {
    use Config;
    my $ithreads = $Config{'useithreads'} eq 'define';
    eval qq{
	sub ITHREADS() { $ithreads }
	sub VERSION() { $] }
    }; die $@ if $@;
}

my %done_gv;

sub _printop {
  my $op = shift;
  my $addr = ${$op} ? $op->ppaddr : '';
  $addr =~ s/^PL_ppaddr// if $addr;
  return sprintf "0x%x %s %s", ${$op}, ${$op} ? class($op) : '', $addr;
}

sub B::OP::debug {
    my ($op) = @_;
    printf <<'EOT', class($op), $$op, $op->ppaddr, _printop($op->next), _printop($op->sibling), $op->targ, $op->type;
%s (0x%lx)
	op_ppaddr	%s
	op_next		%s
	op_sibling	%s
	op_targ		%d
	op_type		%d
EOT
    if ($] > 5.009) {
	printf <<'EOT', $op->opt;
	op_opt		%d
EOT
    } else {
	printf <<'EOT', $op->seq;
	op_seq		%d
EOT
    }
    printf <<'EOT', $op->flags, $op->private;
	op_flags	%d
	op_private	%d
EOT
}

sub B::UNOP::debug {
    my ($op) = @_;
    $op->B::OP::debug();
    printf "\top_first\t%s\n", _printop($op->first);
}

sub B::BINOP::debug {
    my ($op) = @_;
    $op->B::UNOP::debug();
    printf "\top_last \t%s\n", _printop($op->last);
}

sub B::LOOP::debug {
    my ($op) = @_;
    $op->B::BINOP::debug();
    printf <<'EOT', _printop($op->redoop), _printop($op->nextop), _printop($op->lastop);
	op_redoop	%s
	op_nextop	%s
	op_lastop	%s
EOT
}

sub B::LOGOP::debug {
    my ($op) = @_;
    $op->B::UNOP::debug();
    printf "\top_other\t%s\n", _printop($op->other);
}

sub B::LISTOP::debug {
    my ($op) = @_;
    $op->B::BINOP::debug();
    printf "\top_children\t%d\n", $op->children;
}

sub B::PMOP::debug {
    my ($op) = @_;
    $op->B::LISTOP::debug();
    printf "\top_pmreplroot\t0x%x\n", ${$op->pmreplroot};
    printf "\top_pmreplstart\t0x%x\n", ${$op->pmreplstart};
    printf "\top_pmnext\t0x%x\n", ${$op->pmnext} if $] < 5.009005;
    if (ITHREADS) {
      printf "\top_pmstashpv\t%s\n", cstring($op->pmstashpv);
      printf "\top_pmoffset\t%d\n", $op->pmoffset;
    } else {
      printf "\top_pmstash\t%s\n", cstring($op->pmstash);
    }
    printf "\top_precomp->precomp\t%s\n", cstring($op->precomp);
    printf "\top_pmflags\t0x%x\n", $op->pmflags;
    printf "\top_reflags\t0x%x\n", $op->reflags if $] >= 5.009;
    printf "\top_pmpermflags\t0x%x\n", $op->pmpermflags if $] < 5.009;
    printf "\top_pmdynflags\t0x%x\n", $op->pmdynflags if $] < 5.009;
    $op->pmreplroot->debug;
}

sub B::COP::debug {
    my ($op) = @_;
    $op->B::OP::debug();
    my $cop_io = class($op->io) eq 'SPECIAL' ? '' : $op->io->as_string;
    printf <<'EOT', $op->label, $op->stashpv, $op->file, $op->cop_seq, $op->arybase, $op->line, ${$op->warnings}, cstring($cop_io);
	cop_label	"%s"
	cop_stashpv	"%s"
	cop_file	"%s"
	cop_seq		%d
	cop_arybase	%d
	cop_line	%d
	cop_warnings	0x%x
	cop_io		%s
EOT
}

sub B::SVOP::debug {
    my ($op) = @_;
    $op->B::OP::debug();
    printf "\top_sv\t\t0x%x\n", ${$op->sv};
    $op->sv->debug;
}

sub B::PVOP::debug {
    my ($op) = @_;
    $op->B::OP::debug();
    printf "\top_pv\t\t%s\n", cstring($op->pv);
}

sub B::PADOP::debug {
    my ($op) = @_;
    $op->B::OP::debug();
    printf "\top_padix\t%ld\n", $op->padix;
}

sub B::NULL::debug {
    my ($sv) = @_;
    if ($$sv == ${sv_undef()}) {
	print "&sv_undef\n";
    } else {
	printf "NULL (0x%x)\n", $$sv;
    }
}

sub B::SV::debug {
    my ($sv) = @_;
    if (!$$sv) {
	print class($sv), " = NULL\n";
	return;
    }
    printf <<'EOT', class($sv), $$sv, $sv->REFCNT, $sv->FLAGS;
%s (0x%x)
	REFCNT		%d
	FLAGS		0x%x
EOT
}

sub B::RV::debug {
    my ($rv) = @_;
    B::SV::debug($rv);
    printf <<'EOT', ${$rv->RV};
	RV		0x%x
EOT
    $rv->RV->debug;
}

sub B::PV::debug {
    my ($sv) = @_;
    $sv->B::SV::debug();
    my $pv = $sv->PV();
    printf <<'EOT', cstring($pv), length($pv);
	xpv_pv		%s
	xpv_cur		%d
EOT
}

sub B::IV::debug {
    my ($sv) = @_;
    $sv->B::SV::debug();
    printf "\txiv_iv\t\t%d\n", $sv->IV;
}

sub B::NV::debug {
    my ($sv) = @_;
    $sv->B::IV::debug();
    printf "\txnv_nv\t\t%s\n", $sv->NV;
}

sub B::PVIV::debug {
    my ($sv) = @_;
    $sv->B::PV::debug();
    printf "\txiv_iv\t\t%d\n", $sv->IV;
}

sub B::PVNV::debug {
    my ($sv) = @_;
    $sv->B::PVIV::debug();
    printf "\txnv_nv\t\t%s\n", $sv->NV;
}

sub B::PVLV::debug {
    my ($sv) = @_;
    $sv->B::PVNV::debug();
    printf "\txlv_targoff\t%d\n", $sv->TARGOFF;
    printf "\txlv_targlen\t%u\n", $sv->TARGLEN;
    printf "\txlv_type\t%s\n", cstring(chr($sv->TYPE));
}

sub B::BM::debug {
    my ($sv) = @_;
    $sv->B::PVNV::debug();
    printf "\txbm_useful\t%d\n", $sv->USEFUL;
    printf "\txbm_previous\t%u\n", $sv->PREVIOUS;
    printf "\txbm_rare\t%s\n", cstring(chr($sv->RARE));
}

sub B::CV::debug {
    my ($sv) = @_;
    $sv->B::PVNV::debug();
    my ($stash) = $sv->STASH;
    my ($start) = $sv->START;
    my ($root) = $sv->ROOT;
    my ($padlist) = $sv->PADLIST;
    my ($file) = $sv->FILE;
    my ($gv) = $sv->GV;
    printf <<'EOT', $$stash, $$start, $$root, $$gv, $file, $sv->DEPTH, $padlist, ${$sv->OUTSIDE}, $sv->OUTSIDE_SEQ;
	STASH		0x%x
	START		0x%x
	ROOT		0x%x
	GV		0x%x
	FILE		%s
	DEPTH		%d
	PADLIST		0x%x
	OUTSIDE		0x%x
	OUTSIDE_SEQ	%d
EOT
    $start->debug if $start;
    $root->debug if $root;
    $gv->debug if $gv;
    $padlist->debug if $padlist;
}

sub B::AV::debug {
    my ($av) = @_;
    $av->B::SV::debug;
    my(@array) = $av->ARRAY;
    print "\tARRAY\t\t(", join(", ", map("0x" . $$_, @array)), ")\n";
    printf <<'EOT', scalar(@array), $av->MAX, $av->OFF;
	FILL		%d
	MAX		%d
	OFF		%d
EOT
    printf <<'EOT', $av->AvFLAGS if $] < 5.009;
	AvFLAGS		%d
EOT
}

sub B::GV::debug {
    my ($gv) = @_;
    if ($done_gv{$$gv}++) {
	printf "GV %s::%s\n", $gv->STASH->NAME, $gv->SAFENAME;
	return;
    }
    my ($sv) = $gv->SV;
    my ($av) = $gv->AV;
    my ($cv) = $gv->CV;
    $gv->B::SV::debug;
    printf <<'EOT', $gv->SAFENAME, $gv->STASH->NAME, $gv->STASH, $$sv, $gv->GvREFCNT, $gv->FORM, $$av, ${$gv->HV}, ${$gv->EGV}, $$cv, $gv->CVGEN, $gv->LINE, $gv->FILE, $gv->GvFLAGS;
	NAME		%s
	STASH		%s (0x%x)
	SV		0x%x
	GvREFCNT	%d
	FORM		0x%x
	AV		0x%x
	HV		0x%x
	EGV		0x%x
	CV		0x%x
	CVGEN		%d
	LINE		%d
	FILE		%s
	GvFLAGS		0x%x
EOT
    $sv->debug if $sv;
    $av->debug if $av;
    $cv->debug if $cv;
}

sub B::SPECIAL::debug {
    my $sv = shift;
    print $specialsv_name[$$sv], "\n";
}

sub compile {
    my $order = shift;
    B::clearsym();
    if ($order && $order eq "exec") {
        return sub { walkoptree_exec(main_start, "debug") }
    } else {
        return sub { walkoptree(main_root, "debug") }
    }
}

1;

__END__

=head1 NAME

B::Debug - Walk Perl syntax tree, printing debug info about ops

=head1 SYNOPSIS

	perl -MO=Debug[,OPTIONS] foo.pl

=head1 DESCRIPTION

See F<ext/B/README> and the newer L<B::Concise>, L<B::Terse>.

=head1 OPTIONS

With option -exec, walks tree in execute order,
otherwise in basic order.

=head1 AUTHOR

Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>

=cut
Commit	Line	Data
a798dbf2	1	package B::Debug;
28b605d8	2
c1307613	3	our $VERSION = '1.05_02';
28b605d8	4
a798dbf2 MB	5	use strict;
a798dbf2 MB	6	use B qw(peekop class walkoptree walkoptree_exec
baccf54f	7	main_start main_root cstring sv_undef @specialsv_name);
c1307613 RU	8	# <=5.008 had @specialsv_name exported from B::Asmdata
	9	BEGIN {
	10	use Config;
	11	my $ithreads = $Config{'useithreads'} eq 'define';
	12	eval qq{
	13	sub ITHREADS() { $ithreads }
	14	sub VERSION() { $] }
	15	}; die $@ if $@;
	16	}
a798dbf2 MB	17
	18	my %done_gv;
	19
c1307613 RU	20	sub _printop {
	21	my $op = shift;
	22	my $addr = ${$op} ? $op->ppaddr : '';
	23	$addr =~ s/^PL_ppaddr// if $addr;
	24	return sprintf "0x%x %s %s", ${$op}, ${$op} ? class($op) : '', $addr;
	25	}
	26
a798dbf2 MB	27	sub B::OP::debug {
a798dbf2 MB	28	my ($op) = @_;
c1307613	29	printf <<'EOT', class($op), $$op, $op->ppaddr, _printop($op->next), _printop($op->sibling), $op->targ, $op->type;
a798dbf2	30	%s (0x%lx)
a798dbf2	31	op_ppaddr %s
c1307613 RU	32	op_next %s
c1307613 RU	33	op_sibling %s
a798dbf2 MB	34	op_targ %d
a798dbf2 MB	35	op_type %d
7252851f NC	36	EOT
7252851f NC	37	if ($] > 5.009) {
85594c31	38	printf <<'EOT', $op->opt;
2814eb74	39	op_opt %d
7252851f NC	40	EOT
	41	} else {
	42	printf <<'EOT', $op->seq;
	43	op_seq %d
	44	EOT
	45	}
	46	printf <<'EOT', $op->flags, $op->private;
a798dbf2 MB	47	op_flags %d
	48	op_private %d
	49	EOT
	50	}
	51
	52	sub B::UNOP::debug {
	53	my ($op) = @_;
	54	$op->B::OP::debug();
c1307613	55	printf "\top_first\t%s\n", _printop($op->first);
a798dbf2 MB	56	}
	57
	58	sub B::BINOP::debug {
	59	my ($op) = @_;
	60	$op->B::UNOP::debug();
c1307613	61	printf "\top_last \t%s\n", _printop($op->last);
a798dbf2 MB	62	}
a798dbf2 MB	63
ee3e756d RH	64	sub B::LOOP::debug {
	65	my ($op) = @_;
	66	$op->B::BINOP::debug();
c1307613 RU	67	printf <<'EOT', _printop($op->redoop), _printop($op->nextop), _printop($op->lastop);
	68	op_redoop %s
	69	op_nextop %s
	70	op_lastop %s
ee3e756d RH	71	EOT
	72	}
	73
a798dbf2 MB	74	sub B::LOGOP::debug {
	75	my ($op) = @_;
	76	$op->B::UNOP::debug();
c1307613	77	printf "\top_other\t%s\n", _printop($op->other);
a798dbf2 MB	78	}
a798dbf2 MB	79
a798dbf2 MB	80	sub B::LISTOP::debug {
	81	my ($op) = @_;
	82	$op->B::BINOP::debug();
c03c2844	83	printf "\top_children\t%d\n", $op->children;
a798dbf2 MB	84	}
	85
	86	sub B::PMOP::debug {
	87	my ($op) = @_;
	88	$op->B::LISTOP::debug();
	89	printf "\top_pmreplroot\t0x%x\n", ${$op->pmreplroot};
	90	printf "\top_pmreplstart\t0x%x\n", ${$op->pmreplstart};
196d796c	91	printf "\top_pmnext\t0x%x\n", ${$op->pmnext} if $] < 5.009005;
c1307613 RU	92	if (ITHREADS) {
	93	printf "\top_pmstashpv\t%s\n", cstring($op->pmstashpv);
	94	printf "\top_pmoffset\t%d\n", $op->pmoffset;
	95	} else {
	96	printf "\top_pmstash\t%s\n", cstring($op->pmstash);
	97	}
	98	printf "\top_precomp->precomp\t%s\n", cstring($op->precomp);
a798dbf2	99	printf "\top_pmflags\t0x%x\n", $op->pmflags;
c1307613 RU	100	printf "\top_reflags\t0x%x\n", $op->reflags if $] >= 5.009;
	101	printf "\top_pmpermflags\t0x%x\n", $op->pmpermflags if $] < 5.009;
	102	printf "\top_pmdynflags\t0x%x\n", $op->pmdynflags if $] < 5.009;
a798dbf2 MB	103	$op->pmreplroot->debug;
	104	}
	105
	106	sub B::COP::debug {
	107	my ($op) = @_;
	108	$op->B::OP::debug();
6e6a1aef	109	my $cop_io = class($op->io) eq 'SPECIAL' ? '' : $op->io->as_string;
127212b2	110	printf <<'EOT', $op->label, $op->stashpv, $op->file, $op->cop_seq, $op->arybase, $op->line, ${$op->warnings}, cstring($cop_io);
c1307613 RU	111	cop_label "%s"
	112	cop_stashpv "%s"
	113	cop_file "%s"
a798dbf2 MB	114	cop_seq %d
	115	cop_arybase %d
	116	cop_line %d
b295d113	117	cop_warnings 0x%x
6e6a1aef	118	cop_io %s
a798dbf2	119	EOT
a798dbf2 MB	120	}
	121
	122	sub B::SVOP::debug {
	123	my ($op) = @_;
	124	$op->B::OP::debug();
	125	printf "\top_sv\t\t0x%x\n", ${$op->sv};
	126	$op->sv->debug;
	127	}
	128
	129	sub B::PVOP::debug {
	130	my ($op) = @_;
	131	$op->B::OP::debug();
3267896c	132	printf "\top_pv\t\t%s\n", cstring($op->pv);
a798dbf2 MB	133	}
a798dbf2 MB	134
7934575e	135	sub B::PADOP::debug {
a798dbf2 MB	136	my ($op) = @_;
a798dbf2 MB	137	$op->B::OP::debug();
c1307613	138	printf "\top_padix\t%ld\n", $op->padix;
a798dbf2 MB	139	}
a798dbf2 MB	140
a798dbf2 MB	141	sub B::NULL::debug {
	142	my ($sv) = @_;
	143	if ($$sv == ${sv_undef()}) {
	144	print "&sv_undef\n";
	145	} else {
	146	printf "NULL (0x%x)\n", $$sv;
	147	}
	148	}
	149
	150	sub B::SV::debug {
	151	my ($sv) = @_;
	152	if (!$$sv) {
	153	print class($sv), " = NULL\n";
	154	return;
	155	}
	156	printf <<'EOT', class($sv), $$sv, $sv->REFCNT, $sv->FLAGS;
	157	%s (0x%x)
	158	REFCNT %d
	159	FLAGS 0x%x
	160	EOT
	161	}
	162
3267896c RH	163	sub B::RV::debug {
	164	my ($rv) = @_;
	165	B::SV::debug($rv);
	166	printf <<'EOT', ${$rv->RV};
	167	RV 0x%x
	168	EOT
	169	$rv->RV->debug;
	170	}
	171
a798dbf2 MB	172	sub B::PV::debug {
	173	my ($sv) = @_;
	174	$sv->B::SV::debug();
	175	my $pv = $sv->PV();
	176	printf <<'EOT', cstring($pv), length($pv);
	177	xpv_pv %s
	178	xpv_cur %d
	179	EOT
	180	}
	181
	182	sub B::IV::debug {
	183	my ($sv) = @_;
	184	$sv->B::SV::debug();
	185	printf "\txiv_iv\t\t%d\n", $sv->IV;
	186	}
	187
	188	sub B::NV::debug {
	189	my ($sv) = @_;
	190	$sv->B::IV::debug();
	191	printf "\txnv_nv\t\t%s\n", $sv->NV;
	192	}
	193
	194	sub B::PVIV::debug {
	195	my ($sv) = @_;
	196	$sv->B::PV::debug();
	197	printf "\txiv_iv\t\t%d\n", $sv->IV;
	198	}
	199
	200	sub B::PVNV::debug {
	201	my ($sv) = @_;
	202	$sv->B::PVIV::debug();
	203	printf "\txnv_nv\t\t%s\n", $sv->NV;
	204	}
	205
	206	sub B::PVLV::debug {
	207	my ($sv) = @_;
	208	$sv->B::PVNV::debug();
	209	printf "\txlv_targoff\t%d\n", $sv->TARGOFF;
	210	printf "\txlv_targlen\t%u\n", $sv->TARGLEN;
	211	printf "\txlv_type\t%s\n", cstring(chr($sv->TYPE));
	212	}
	213
	214	sub B::BM::debug {
	215	my ($sv) = @_;
	216	$sv->B::PVNV::debug();
	217	printf "\txbm_useful\t%d\n", $sv->USEFUL;
	218	printf "\txbm_previous\t%u\n", $sv->PREVIOUS;
	219	printf "\txbm_rare\t%s\n", cstring(chr($sv->RARE));
	220	}
	221
	222	sub B::CV::debug {
	223	my ($sv) = @_;
	224	$sv->B::PVNV::debug();
	225	my ($stash) = $sv->STASH;
	226	my ($start) = $sv->START;
	227	my ($root) = $sv->ROOT;
	228	my ($padlist) = $sv->PADLIST;
57843af0	229	my ($file) = $sv->FILE;
a798dbf2	230	my ($gv) = $sv->GV;
a3985cdc	231	printf <<'EOT', $$stash, $$start, $$root, $$gv, $file, $sv->DEPTH, $padlist, ${$sv->OUTSIDE}, $sv->OUTSIDE_SEQ;
a798dbf2 MB	232	STASH 0x%x
	233	START 0x%x
	234	ROOT 0x%x
	235	GV 0x%x
57843af0	236	FILE %s
a798dbf2	237	DEPTH %d
7e107e90	238	PADLIST 0x%x
a798dbf2	239	OUTSIDE 0x%x
a3985cdc	240	OUTSIDE_SEQ %d
a798dbf2 MB	241	EOT
	242	$start->debug if $start;
	243	$root->debug if $root;
	244	$gv->debug if $gv;
a798dbf2 MB	245	$padlist->debug if $padlist;
	246	}
	247
	248	sub B::AV::debug {
	249	my ($av) = @_;
	250	$av->B::SV::debug;
	251	my(@array) = $av->ARRAY;
	252	print "\tARRAY\t\t(", join(", ", map("0x" . $$_, @array)), ")\n";
11ca45c0	253	printf <<'EOT', scalar(@array), $av->MAX, $av->OFF;
7e107e90	254	FILL %d
a798dbf2 MB	255	MAX %d
a798dbf2 MB	256	OFF %d
a798dbf2	257	EOT
bb7c595b NC	258	printf <<'EOT', $av->AvFLAGS if $] < 5.009;
	259	AvFLAGS %d
	260	EOT
a798dbf2	261	}
7e107e90	262
a798dbf2 MB	263	sub B::GV::debug {
	264	my ($gv) = @_;
	265	if ($done_gv{$$gv}++) {
002b978b	266	printf "GV %s::%s\n", $gv->STASH->NAME, $gv->SAFENAME;
a798dbf2 MB	267	return;
	268	}
	269	my ($sv) = $gv->SV;
	270	my ($av) = $gv->AV;
	271	my ($cv) = $gv->CV;
	272	$gv->B::SV::debug;
002b978b	273	printf <<'EOT', $gv->SAFENAME, $gv->STASH->NAME, $gv->STASH, $$sv, $gv->GvREFCNT, $gv->FORM, $$av, ${$gv->HV}, ${$gv->EGV}, $$cv, $gv->CVGEN, $gv->LINE, $gv->FILE, $gv->GvFLAGS;
a798dbf2 MB	274	NAME %s
	275	STASH %s (0x%x)
	276	SV 0x%x
	277	GvREFCNT %d
	278	FORM 0x%x
	279	AV 0x%x
	280	HV 0x%x
	281	EGV 0x%x
	282	CV 0x%x
	283	CVGEN %d
	284	LINE %d
b195d487	285	FILE %s
a798dbf2 MB	286	GvFLAGS 0x%x
	287	EOT
	288	$sv->debug if $sv;
	289	$av->debug if $av;
	290	$cv->debug if $cv;
	291	}
	292
	293	sub B::SPECIAL::debug {
	294	my $sv = shift;
	295	print $specialsv_name[$$sv], "\n";
	296	}
	297
	298	sub compile {
	299	my $order = shift;
2b8dc4d2	300	B::clearsym();
7ebf56ae	301	if ($order && $order eq "exec") {
a798dbf2 MB	302	return sub { walkoptree_exec(main_start, "debug") }
	303	} else {
	304	return sub { walkoptree(main_root, "debug") }
	305	}
	306	}
	307
	308	1;
7f20e9dd GS	309
	310	__END__
	311
	312	=head1 NAME
	313
	314	B::Debug - Walk Perl syntax tree, printing debug info about ops
	315
	316	=head1 SYNOPSIS
	317
	318	perl -MO=Debug[,OPTIONS] foo.pl
	319
	320	=head1 DESCRIPTION
	321
c1307613 RU	322	See F<ext/B/README> and the newer L<B::Concise>, L<B::Terse>.
	323
	324	=head1 OPTIONS
	325
	326	With option -exec, walks tree in execute order,
	327	otherwise in basic order.
7f20e9dd GS	328
	329	=head1 AUTHOR
	330
	331	Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
	332
	333	=cut