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

package B::Debug;

our $VERSION = '1.04';

use strict;
use B qw(peekop class walkoptree walkoptree_exec
         main_start main_root cstring sv_undef @specialsv_name);

my %done_gv;

sub B::OP::debug {
    my ($op) = @_;
    printf <<'EOT', class($op), $$op, ${$op->next}, ${$op->sibling}, $op->ppaddr, $op->targ, $op->type;
%s (0x%lx)
	op_next		0x%x
	op_sibling	0x%x
	op_ppaddr	%s
	op_targ		%d
	op_type		%d
EOT
    if ($] > 5.009) {
	printf <<'EOT', $op->opt, $op->static;
	op_opt		%d
	op_static	%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\t0x%x\n", ${$op->first};
}

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

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

sub B::LOGOP::debug {
    my ($op) = @_;
    $op->B::UNOP::debug();
    printf "\top_other\t0x%x\n", ${$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};
    printf "\top_pmregexp->precomp\t%s\n", cstring($op->precomp);
    printf "\top_pmflags\t0x%x\n", $op->pmflags;
    $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\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>.

=head1 AUTHOR

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

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