[perl5.git] / bytecode.pl

BEGIN {
  push @INC, './lib';
  require 'regen_lib.pl';
}
use strict;
my %alias_to = (
    U32 => [qw(line_t)],
    PADOFFSET => [qw(STRLEN SSize_t)],
    U16 => [qw(OPCODE short)],
    U8  => [qw(char)],
);

my @optype= qw(OP UNOP BINOP LOGOP LISTOP PMOP SVOP PADOP PVOP LOOP COP);

# Nullsv *must* come first in the following so that the condition
# ($$sv == 0) can continue to be used to test (sv == Nullsv).
my @specialsv = qw(Nullsv &PL_sv_undef &PL_sv_yes &PL_sv_no pWARN_ALL pWARN_NONE);

my (%alias_from, $from, $tos);
while (($from, $tos) = each %alias_to) {
    map { $alias_from{$_} = $from } @$tos;
}

my $c_header = <<'EOT';
/*
 *      Copyright (c) 1996-1999 Malcolm Beattie
 *
 *      You may distribute under the terms of either the GNU General Public
 *      License or the Artistic License, as specified in the README file.
 *
 */
/*
 * This file is autogenerated from bytecode.pl. Changes made here will be lost.
 */
EOT

my $perl_header;
($perl_header = $c_header) =~ s{[/ ]?\*/?}{#}g;

safer_unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.pm";

#
# Start with boilerplate for Asmdata.pm
#
open(ASMDATA_PM, ">ext/B/B/Asmdata.pm") or die "ext/B/B/Asmdata.pm: $!";
binmode ASMDATA_PM;
print ASMDATA_PM $perl_header, <<'EOT';
package B::Asmdata;

our $VERSION = '1.01';

use Exporter;
@ISA = qw(Exporter);
@EXPORT_OK = qw(%insn_data @insn_name @optype @specialsv_name);
our(%insn_data, @insn_name, @optype, @specialsv_name);

EOT
print ASMDATA_PM <<"EOT";
\@optype = qw(@optype);
\@specialsv_name = qw(@specialsv);

# XXX insn_data is initialised this way because with a large
# %insn_data = (foo => [...], bar => [...], ...) initialiser
# I get a hard-to-track-down stack underflow and segfault.
EOT

#
# Boilerplate for byterun.c
#
open(BYTERUN_C, ">ext/ByteLoader/byterun.c") or die "ext/ByteLoader/byterun.c: $!";
binmode BYTERUN_C;
print BYTERUN_C $c_header, <<'EOT';

#define PERL_NO_GET_CONTEXT
#include "EXTERN.h"
#include "perl.h"
#define NO_XSLOCKS
#include "XSUB.h"

#include "byterun.h"
#include "bytecode.h"


static const int optype_size[] = {
EOT
my $i = 0;
for ($i = 0; $i < @optype - 1; $i++) {
    printf BYTERUN_C "    sizeof(%s),\n", $optype[$i], $i;
}
printf BYTERUN_C "    sizeof(%s)\n", $optype[$i], $i;
print BYTERUN_C <<'EOT';
};

void *
bset_obj_store(pTHX_ struct byteloader_state *bstate, void *obj, I32 ix)
{
    if (ix > bstate->bs_obj_list_fill) {
	Renew(bstate->bs_obj_list, ix + 32, void*);
	bstate->bs_obj_list_fill = ix + 31;
    }
    bstate->bs_obj_list[ix] = obj;
    return obj;
}

int
byterun(pTHX_ register struct byteloader_state *bstate)
{
    dVAR;
    register int insn;
    U32 ix;
    SV *specialsv_list[6];

    BYTECODE_HEADER_CHECK;	/* croak if incorrect platform */
    New(666, bstate->bs_obj_list, 32, void*); /* set op objlist */
    bstate->bs_obj_list_fill = 31;
    bstate->bs_obj_list[0] = NULL; /* first is always Null */
    bstate->bs_ix = 1;

EOT

for my $i ( 0 .. $#specialsv ) {
    print BYTERUN_C "    specialsv_list[$i] = $specialsv[$i];\n";
}

print BYTERUN_C <<'EOT';

    while ((insn = BGET_FGETC()) != EOF) {
	switch (insn) {
EOT


my (@insn_name, $insn_num, $insn, $lvalue, $argtype, $flags, $fundtype);

while (<DATA>) {
    if (/^\s*#/) {
	print BYTERUN_C if /^\s*#\s*(?:if|endif|el)/;
	next;
    }
    chop;
    next unless length;
    if (/^%number\s+(.*)/) {
	$insn_num = $1;
	next;
    } elsif (/%enum\s+(.*?)\s+(.*)/) {
	create_enum($1, $2);	# must come before instructions
	next;
    }
    ($insn, $lvalue, $argtype, $flags) = split;
    my $rvalcast = '';
    if ($argtype =~ m:(.+)/(.+):) {
	($rvalcast, $argtype) = ("($1)", $2);
    }
    $insn_name[$insn_num] = $insn;
    $fundtype = $alias_from{$argtype} || $argtype;

    #
    # Add the case statement and code for the bytecode interpreter in byterun.c
    #
    printf BYTERUN_C "\t  case INSN_%s:\t\t/* %d */\n\t    {\n",
	uc($insn), $insn_num;
    my $optarg = $argtype eq "none" ? "" : ", arg";
    if ($optarg) {
	printf BYTERUN_C "\t\t$argtype arg;\n\t\tBGET_%s(arg);\n", $fundtype;
    }
    if ($flags =~ /x/) {
	print BYTERUN_C "\t\tBSET_$insn($lvalue$optarg);\n";
    } elsif ($flags =~ /s/) {
	# Store instructions store to bytecode_obj_list[arg]. "lvalue" field is rvalue.
	print BYTERUN_C "\t\tBSET_OBJ_STORE($lvalue$optarg);\n";
    }
    elsif ($optarg && $lvalue ne "none") {
	print BYTERUN_C "\t\t$lvalue = ${rvalcast}arg;\n";
    }
    print BYTERUN_C "\t\tbreak;\n\t    }\n";

    #
    # Add the initialiser line for %insn_data in Asmdata.pm
    #
    print ASMDATA_PM <<"EOT";
\$insn_data{$insn} = [$insn_num, \\&PUT_$fundtype, "GET_$fundtype"];
EOT

    # Find the next unused instruction number
    do { $insn_num++ } while $insn_name[$insn_num];
}

#
# Finish off byterun.c
#
print BYTERUN_C <<'EOT';
	  default:
	    Perl_croak(aTHX_ "Illegal bytecode instruction %d\n", insn);
	    /* NOTREACHED */
	}
    }
    return 0;
}
EOT

#
# Write the instruction and optype enum constants into byterun.h
#
open(BYTERUN_H, ">ext/ByteLoader/byterun.h") or die "ext/ByteLoader/byterun.h: $!";
binmode BYTERUN_H;
print BYTERUN_H $c_header, <<'EOT';
struct byteloader_fdata {
    SV	*datasv;
    int next_out;
    int	idx;
};

struct byteloader_state {
    struct byteloader_fdata	*bs_fdata;
    SV				*bs_sv;
    void			**bs_obj_list;
    int				bs_obj_list_fill;
    int				bs_ix;
    XPV				bs_pv;
    int				bs_iv_overflows;
};

int bl_getc(struct byteloader_fdata *);
int bl_read(struct byteloader_fdata *, char *, size_t, size_t);
extern int byterun(pTHX_ struct byteloader_state *);

enum {
EOT

my $add_enum_value = 0;
my $max_insn;
for $i ( 0 .. $#insn_name ) {
    $insn = uc($insn_name[$i]);
    if (defined($insn)) {
	$max_insn = $i;
	if ($add_enum_value) {
	    print BYTERUN_H "    INSN_$insn = $i,\t\t\t/* $i */\n";
	    $add_enum_value = 0;
	} else {
	    print BYTERUN_H "    INSN_$insn,\t\t\t/* $i */\n";
	}
    } else {
	$add_enum_value = 1;
    }
}

print BYTERUN_H "    MAX_INSN = $max_insn\n};\n";

print BYTERUN_H "\nenum {\n";
for ($i = 0; $i < @optype - 1; $i++) {
    printf BYTERUN_H "    OPt_%s,\t\t/* %d */\n", $optype[$i], $i;
}
printf BYTERUN_H "    OPt_%s\t\t/* %d */\n};\n\n", $optype[$i], $i;

#
# Finish off insn_data and create array initialisers in Asmdata.pm
#
print ASMDATA_PM <<'EOT';

my ($insn_name, $insn_data);
while (($insn_name, $insn_data) = each %insn_data) {
    $insn_name[$insn_data->[0]] = $insn_name;
}
# Fill in any gaps
@insn_name = map($_ || "unused", @insn_name);

1;

__END__

=head1 NAME

B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode

=head1 SYNOPSIS

	use B::Asmdata qw(%insn_data @insn_name @optype @specialsv_name);

=head1 DESCRIPTION

Provides information about Perl ops in order to generate bytecode via
a bunch of exported variables.  Its mostly used by B::Assembler and
B::Disassembler.

=over 4

=item %insn_data

  my($bytecode_num, $put_sub, $get_meth) = @$insn_data{$op_name};

For a given $op_name (for example, 'cop_label', 'sv_flags', etc...) 
you get an array ref containing the bytecode number of the op, a
reference to the subroutine used to 'PUT', and the name of the method
used to 'GET'.

=for _private
Add more detail about what $put_sub and $get_meth are and how to use them.

=item @insn_name

  my $op_name = $insn_name[$bytecode_num];

A simple mapping of the bytecode number to the name of the op.
Suitable for using with %insn_data like so:

  my $op_info = $insn_data{$insn_name[$bytecode_num]};

=item @optype

  my $op_type = $optype[$op_type_num];

A simple mapping of the op type number to its type (like 'COP' or 'BINOP').

=item @specialsv_name

  my $sv_name = $specialsv_name[$sv_index];

Certain SV types are considered 'special'.  They're represented by
B::SPECIAL and are refered to by a number from the specialsv_list.
This array maps that number back to the name of the SV (like 'Nullsv'
or '&PL_sv_undef').

=back

=head1 AUTHOR

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

=cut
EOT


close ASMDATA_PM or die "Error closing ASMDATA_PM: $!";
close BYTERUN_H or die "Error closing BYTERUN_H: $!";
close BYTERUN_C or die "Error closing BYTERUN_C: $!";

__END__
# First set instruction ord("#") to read comment to end-of-line (sneaky)
%number 35
comment		arg			comment_t
# Then make ord("\n") into a no-op
%number 10
nop		none			none

# Now for the rest of the ordinary ones, beginning with \0 which is
# ret so that \0-terminated strings can be read properly as bytecode.
%number 0
#
# The argtype is either a single type or "rightvaluecast/argtype".
#
#opcode		lvalue					argtype		flags	
#
ret		none					none		x
ldsv		bstate->bs_sv				svindex
ldop		PL_op					opindex
stsv		bstate->bs_sv				U32		s
stop		PL_op					U32		s
stpv		bstate->bs_pv.xpv_pv			U32		x
ldspecsv	bstate->bs_sv				U8		x
ldspecsvx	bstate->bs_sv				U8		x
newsv		bstate->bs_sv				U8		x
newsvx		bstate->bs_sv				U32		x
newop		PL_op					U8		x
newopx		PL_op					U16		x
newopn		PL_op					U8		x
newpv		none					PV
pv_cur		bstate->bs_pv.xpv_cur			STRLEN
pv_free		bstate->bs_pv				none		x
sv_upgrade	bstate->bs_sv				U8		x
sv_refcnt	SvREFCNT(bstate->bs_sv)			U32
sv_refcnt_add	SvREFCNT(bstate->bs_sv)			I32		x
sv_flags	SvFLAGS(bstate->bs_sv)			U32
xrv		bstate->bs_sv				svindex		x
xpv		bstate->bs_sv				none		x
xpv_cur		bstate->bs_sv	 			STRLEN		x
xpv_len		bstate->bs_sv				STRLEN		x
xiv		bstate->bs_sv				IV		x
xnv		bstate->bs_sv				NV		x
xlv_targoff	LvTARGOFF(bstate->bs_sv)		STRLEN
xlv_targlen	LvTARGLEN(bstate->bs_sv)		STRLEN
xlv_targ	LvTARG(bstate->bs_sv)			svindex
xlv_type	LvTYPE(bstate->bs_sv)			char
xbm_useful	BmUSEFUL(bstate->bs_sv)			I32
xbm_previous	BmPREVIOUS(bstate->bs_sv)		U16
xbm_rare	BmRARE(bstate->bs_sv)			U8
xfm_lines	FmLINES(bstate->bs_sv)			IV
xio_lines	IoLINES(bstate->bs_sv)			IV
xio_page	IoPAGE(bstate->bs_sv)			IV
xio_page_len	IoPAGE_LEN(bstate->bs_sv)		IV
xio_lines_left	IoLINES_LEFT(bstate->bs_sv)	       	IV
xio_top_name	IoTOP_NAME(bstate->bs_sv)		pvindex
xio_top_gv	*(SV**)&IoTOP_GV(bstate->bs_sv)		svindex
xio_fmt_name	IoFMT_NAME(bstate->bs_sv)		pvindex
xio_fmt_gv	*(SV**)&IoFMT_GV(bstate->bs_sv)		svindex
xio_bottom_name	IoBOTTOM_NAME(bstate->bs_sv)		pvindex
xio_bottom_gv	*(SV**)&IoBOTTOM_GV(bstate->bs_sv)	svindex
xio_subprocess	IoSUBPROCESS(bstate->bs_sv)		short
xio_type	IoTYPE(bstate->bs_sv)			char
xio_flags	IoFLAGS(bstate->bs_sv)			char
xcv_xsubany	*(SV**)&CvXSUBANY(bstate->bs_sv).any_ptr	svindex
xcv_stash	*(SV**)&CvSTASH(bstate->bs_sv)		svindex
xcv_start	CvSTART(bstate->bs_sv)			opindex
xcv_root	CvROOT(bstate->bs_sv)			opindex
xcv_gv		*(SV**)&CvGV(bstate->bs_sv)		svindex
xcv_file	CvFILE(bstate->bs_sv)			pvindex
xcv_depth	CvDEPTH(bstate->bs_sv)			long
xcv_padlist	*(SV**)&CvPADLIST(bstate->bs_sv)	svindex
xcv_outside	*(SV**)&CvOUTSIDE(bstate->bs_sv)	svindex
xcv_outside_seq	CvOUTSIDE_SEQ(bstate->bs_sv)		U32
xcv_flags	CvFLAGS(bstate->bs_sv)			U16
av_extend	bstate->bs_sv				SSize_t		x
av_pushx	bstate->bs_sv				svindex		x
av_push		bstate->bs_sv				svindex		x
xav_fill	AvFILLp(bstate->bs_sv)			SSize_t
xav_max		AvMAX(bstate->bs_sv)			SSize_t
xav_flags	AvFLAGS(bstate->bs_sv)			U8
xhv_riter	HvRITER(bstate->bs_sv)			I32
xhv_name	HvNAME(bstate->bs_sv)			pvindex
xhv_pmroot	*(OP**)&HvPMROOT(bstate->bs_sv)		opindex
hv_store	bstate->bs_sv				svindex		x
sv_magic	bstate->bs_sv				char		x
mg_obj		SvMAGIC(bstate->bs_sv)->mg_obj		svindex
mg_private	SvMAGIC(bstate->bs_sv)->mg_private	U16
mg_flags	SvMAGIC(bstate->bs_sv)->mg_flags	U8
mg_name		SvMAGIC(bstate->bs_sv)			pvcontents	x
mg_namex	SvMAGIC(bstate->bs_sv)			svindex		x
xmg_stash	bstate->bs_sv				svindex		X
gv_fetchpv	bstate->bs_sv				strconst	x
gv_fetchpvx	bstate->bs_sv				strconst	x
gv_stashpv	bstate->bs_sv				strconst	x
gv_stashpvx	bstate->bs_sv				strconst	x
gp_sv		GvSV(bstate->bs_sv)			svindex
gp_refcnt	GvREFCNT(bstate->bs_sv)			U32
gp_refcnt_add	GvREFCNT(bstate->bs_sv)			I32		x
gp_av		*(SV**)&GvAV(bstate->bs_sv)		svindex
gp_hv		*(SV**)&GvHV(bstate->bs_sv)		svindex
gp_cv		*(SV**)&GvCV(bstate->bs_sv)		svindex
gp_file		GvFILE(bstate->bs_sv)			pvindex
gp_io		*(SV**)&GvIOp(bstate->bs_sv)		svindex
gp_form		*(SV**)&GvFORM(bstate->bs_sv)		svindex
gp_cvgen	GvCVGEN(bstate->bs_sv)			U32
gp_line		GvLINE(bstate->bs_sv)			line_t
gp_share	bstate->bs_sv				svindex		x
xgv_flags	GvFLAGS(bstate->bs_sv)			U8
op_next		PL_op->op_next				opindex
op_sibling	PL_op->op_sibling			opindex
op_ppaddr	PL_op->op_ppaddr			strconst	x
op_targ		PL_op->op_targ				PADOFFSET
op_type		PL_op					OPCODE		x
op_opt		PL_op->op_opt				U8
op_static	PL_op->op_static			U8
op_flags	PL_op->op_flags				U8
op_private	PL_op->op_private			U8
op_first	cUNOP->op_first				opindex
op_last		cBINOP->op_last				opindex
op_other	cLOGOP->op_other			opindex
op_pmreplroot	cPMOP->op_pmreplroot			opindex
op_pmreplstart	cPMOP->op_pmreplstart			opindex
op_pmnext	*(OP**)&cPMOP->op_pmnext		opindex
#ifdef USE_ITHREADS
op_pmstashpv	cPMOP					pvindex		x
op_pmreplrootpo	cPMOP->op_pmreplroot			OP*/PADOFFSET
#else
op_pmstash	*(SV**)&cPMOP->op_pmstash		svindex
op_pmreplrootgv	*(SV**)&cPMOP->op_pmreplroot		svindex
#endif
pregcomp	PL_op					pvcontents	x
op_pmflags	cPMOP->op_pmflags			U16
op_pmpermflags	cPMOP->op_pmpermflags			U16
op_pmdynflags	cPMOP->op_pmdynflags			U8
op_sv		cSVOP->op_sv				svindex
op_padix	cPADOP->op_padix			PADOFFSET
op_pv		cPVOP->op_pv				pvcontents
op_pv_tr	cPVOP->op_pv				op_tr_array
op_redoop	cLOOP->op_redoop			opindex
op_nextop	cLOOP->op_nextop			opindex
op_lastop	cLOOP->op_lastop			opindex
cop_label	cCOP->cop_label				pvindex
#ifdef USE_ITHREADS
cop_stashpv	cCOP					pvindex		x
cop_file	cCOP					pvindex		x
#else
cop_stash	cCOP					svindex		x
cop_filegv	cCOP					svindex		x
#endif
cop_seq		cCOP->cop_seq				U32
cop_arybase	cCOP->cop_arybase			I32
cop_line	cCOP->cop_line				line_t
cop_io		cCOP->cop_io				svindex
cop_warnings	cCOP->cop_warnings			svindex
main_start	PL_main_start				opindex
main_root	PL_main_root				opindex
main_cv		*(SV**)&PL_main_cv			svindex
curpad		PL_curpad				svindex		x
push_begin	PL_beginav				svindex		x
push_init	PL_initav				svindex		x
push_end	PL_endav				svindex		x
curstash	*(SV**)&PL_curstash			svindex
defstash	*(SV**)&PL_defstash			svindex
data		none					U8		x
incav		*(SV**)&GvAV(PL_incgv)			svindex
load_glob	none					svindex		x
#ifdef USE_ITHREADS
regex_padav	*(SV**)&PL_regex_padav			svindex
#endif
dowarn		PL_dowarn				U8
comppad_name	*(SV**)&PL_comppad_name			svindex
xgv_stash	*(SV**)&GvSTASH(bstate->bs_sv)		svindex
signal		bstate->bs_sv				strconst	x
# to be removed
formfeed	PL_formfeed				svindex
Commit	Line	Data
73f0cc2d GS	1	BEGIN {
73f0cc2d GS	2	push @INC, './lib';
9ad884cb	3	require 'regen_lib.pl';
73f0cc2d	4	}
a8a597b2 MB	5	use strict;
a8a597b2 MB	6	my %alias_to = (
113d5bd9 JH	7	U32 => [qw(line_t)],
113d5bd9 JH	8	PADOFFSET => [qw(STRLEN SSize_t)],
dea28490	9	U16 => [qw(OPCODE short)],
d5e9ef99	10	U8 => [qw(char)],
a8a597b2 MB	11	);
a8a597b2 MB	12
7934575e	13	my @optype= qw(OP UNOP BINOP LOGOP LISTOP PMOP SVOP PADOP PVOP LOOP COP);
a8a597b2 MB	14
	15	# Nullsv must come first in the following so that the condition
	16	# ($$sv == 0) can continue to be used to test (sv == Nullsv).
059a8bb7	17	my @specialsv = qw(Nullsv &PL_sv_undef &PL_sv_yes &PL_sv_no pWARN_ALL pWARN_NONE);
a8a597b2 MB	18
	19	my (%alias_from, $from, $tos);
	20	while (($from, $tos) = each %alias_to) {
	21	map { $alias_from{$_} = $from } @$tos;
	22	}
	23
	24	my $c_header = <<'EOT';
	25	/*
4eb8286e	26	* Copyright (c) 1996-1999 Malcolm Beattie
a8a597b2 MB	27	*
	28	* You may distribute under the terms of either the GNU General Public
	29	* License or the Artistic License, as specified in the README file.
	30	*
	31	*/
	32	/*
	33	* This file is autogenerated from bytecode.pl. Changes made here will be lost.
	34	*/
	35	EOT
	36
	37	my $perl_header;
	38	($perl_header = $c_header) =~ s{[/ ]?\*/?}{#}g;
	39
36bb303b	40	safer_unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.pm";
a8a597b2 MB	41
	42	#
	43	# Start with boilerplate for Asmdata.pm
	44	#
33b839e2	45	open(ASMDATA_PM, ">ext/B/B/Asmdata.pm") or die "ext/B/B/Asmdata.pm: $!";
dfb1454f	46	binmode ASMDATA_PM;
a8a597b2 MB	47	print ASMDATA_PM $perl_header, <<'EOT';
a8a597b2 MB	48	package B::Asmdata;
28b605d8	49
a0edd7f8	50	our $VERSION = '1.01';
28b605d8	51
a8a597b2 MB	52	use Exporter;
	53	@ISA = qw(Exporter);
	54	@EXPORT_OK = qw(%insn_data @insn_name @optype @specialsv_name);
1b11e67e	55	our(%insn_data, @insn_name, @optype, @specialsv_name);
a8a597b2 MB	56
	57	EOT
	58	print ASMDATA_PM <<"EOT";
	59	\@optype = qw(@optype);
	60	\@specialsv_name = qw(@specialsv);
	61
	62	# XXX insn_data is initialised this way because with a large
	63	# %insn_data = (foo => [...], bar => [...], ...) initialiser
	64	# I get a hard-to-track-down stack underflow and segfault.
	65	EOT
	66
	67	#
	68	# Boilerplate for byterun.c
	69	#
e8edd1e6	70	open(BYTERUN_C, ">ext/ByteLoader/byterun.c") or die "ext/ByteLoader/byterun.c: $!";
dfb1454f	71	binmode BYTERUN_C;
a8a597b2 MB	72	print BYTERUN_C $c_header, <<'EOT';
a8a597b2 MB	73
c5be433b	74	#define PERL_NO_GET_CONTEXT
a8a597b2 MB	75	#include "EXTERN.h"
a8a597b2 MB	76	#include "perl.h"
0cb96387 GS	77	#define NO_XSLOCKS
	78	#include "XSUB.h"
	79
e8edd1e6 TH	80	#include "byterun.h"
	81	#include "bytecode.h"
	82
0cb96387	83
059a8bb7	84	static const int optype_size[] = {
e8edd1e6 TH	85	EOT
	86	my $i = 0;
	87	for ($i = 0; $i < @optype - 1; $i++) {
	88	printf BYTERUN_C " sizeof(%s),\n", $optype[$i], $i;
	89	}
	90	printf BYTERUN_C " sizeof(%s)\n", $optype[$i], $i;
	91	print BYTERUN_C <<'EOT';
	92	};
	93
d613ef02	94	void *
acfe0abc	95	bset_obj_store(pTHX_ struct byteloader_state bstate, void obj, I32 ix)
d613ef02	96	{
059a8bb7 JH	97	if (ix > bstate->bs_obj_list_fill) {
	98	Renew(bstate->bs_obj_list, ix + 32, void*);
	99	bstate->bs_obj_list_fill = ix + 31;
d613ef02	100	}
059a8bb7	101	bstate->bs_obj_list[ix] = obj;
d613ef02 GS	102	return obj;
d613ef02 GS	103	}
a8a597b2	104
1df34986	105	int
acfe0abc	106	byterun(pTHX_ register struct byteloader_state *bstate)
a8a597b2	107	{
27da23d5	108	dVAR;
059a8bb7 JH	109	register int insn;
	110	U32 ix;
	111	SV *specialsv_list[6];
	112
	113	BYTECODE_HEADER_CHECK; /* croak if incorrect platform */
	114	New(666, bstate->bs_obj_list, 32, void); / set op objlist */
	115	bstate->bs_obj_list_fill = 31;
1df34986	116	bstate->bs_obj_list[0] = NULL; /* first is always Null */
566ece03	117	bstate->bs_ix = 1;
e8edd1e6 TH	118
	119	EOT
	120
e3751d82	121	for my $i ( 0 .. $#specialsv ) {
e8edd1e6 TH	122	print BYTERUN_C " specialsv_list[$i] = $specialsv[$i];\n";
	123	}
	124
	125	print BYTERUN_C <<'EOT';
	126
47358472	127	while ((insn = BGET_FGETC()) != EOF) {
a8a597b2 MB	128	switch (insn) {
	129	EOT
	130
	131
	132	my (@insn_name, $insn_num, $insn, $lvalue, $argtype, $flags, $fundtype);
	133
	134	while (<DATA>) {
1df34986 AE	135	if (/^\s*#/) {
	136	print BYTERUN_C if /^\s#\s(?:if\|endif\|el)/;
	137	next;
	138	}
a8a597b2	139	chop;
a8a597b2 MB	140	next unless length;
	141	if (/^%number\s+(.*)/) {
	142	$insn_num = $1;
	143	next;
	144	} elsif (/%enum\s+(.?)\s+(.)/) {
	145	create_enum($1, $2); # must come before instructions
	146	next;
	147	}
	148	($insn, $lvalue, $argtype, $flags) = split;
b97332e7 JH	149	my $rvalcast = '';
	150	if ($argtype =~ m:(.+)/(.+):) {
	151	($rvalcast, $argtype) = ("($1)", $2);
	152	}
a8a597b2 MB	153	$insn_name[$insn_num] = $insn;
	154	$fundtype = $alias_from{$argtype} \|\| $argtype;
	155
	156	#
	157	# Add the case statement and code for the bytecode interpreter in byterun.c
	158	#
	159	printf BYTERUN_C "\t case INSN_%s:\t\t/* %d */\n\t {\n",
	160	uc($insn), $insn_num;
	161	my $optarg = $argtype eq "none" ? "" : ", arg";
	162	if ($optarg) {
	163	printf BYTERUN_C "\t\t$argtype arg;\n\t\tBGET_%s(arg);\n", $fundtype;
	164	}
	165	if ($flags =~ /x/) {
	166	print BYTERUN_C "\t\tBSET_$insn($lvalue$optarg);\n";
	167	} elsif ($flags =~ /s/) {
e8edd1e6	168	# Store instructions store to bytecode_obj_list[arg]. "lvalue" field is rvalue.
a8a597b2 MB	169	print BYTERUN_C "\t\tBSET_OBJ_STORE($lvalue$optarg);\n";
	170	}
	171	elsif ($optarg && $lvalue ne "none") {
b97332e7	172	print BYTERUN_C "\t\t$lvalue = ${rvalcast}arg;\n";
a8a597b2 MB	173	}
	174	print BYTERUN_C "\t\tbreak;\n\t }\n";
	175
	176	#
	177	# Add the initialiser line for %insn_data in Asmdata.pm
	178	#
	179	print ASMDATA_PM <<"EOT";
	180	\$insn_data{$insn} = [$insn_num, \\&PUT_$fundtype, "GET_$fundtype"];
	181	EOT
	182
	183	# Find the next unused instruction number
	184	do { $insn_num++ } while $insn_name[$insn_num];
	185	}
	186
	187	#
	188	# Finish off byterun.c
	189	#
	190	print BYTERUN_C <<'EOT';
	191	default:
cea2e8a9	192	Perl_croak(aTHX_ "Illegal bytecode instruction %d\n", insn);
a8a597b2 MB	193	/* NOTREACHED */
	194	}
	195	}
1df34986	196	return 0;
a8a597b2 MB	197	}
	198	EOT
	199
	200	#
	201	# Write the instruction and optype enum constants into byterun.h
	202	#
e8edd1e6	203	open(BYTERUN_H, ">ext/ByteLoader/byterun.h") or die "ext/ByteLoader/byterun.h: $!";
dfb1454f	204	binmode BYTERUN_H;
a8a597b2	205	print BYTERUN_H $c_header, <<'EOT';
059a8bb7 JH	206	struct byteloader_fdata {
	207	SV *datasv;
	208	int next_out;
	209	int idx;
a8a597b2	210	};
a8a597b2	211
059a8bb7 JH	212	struct byteloader_state {
	213	struct byteloader_fdata *bs_fdata;
	214	SV *bs_sv;
	215	void **bs_obj_list;
	216	int bs_obj_list_fill;
566ece03	217	int bs_ix;
059a8bb7 JH	218	XPV bs_pv;
	219	int bs_iv_overflows;
	220	};
	221
	222	int bl_getc(struct byteloader_fdata *);
	223	int bl_read(struct byteloader_fdata , char , size_t, size_t);
1df34986	224	extern int byterun(pTHX_ struct byteloader_state *);
059a8bb7	225
a8a597b2 MB	226	enum {
	227	EOT
	228
a8a597b2 MB	229	my $add_enum_value = 0;
a8a597b2 MB	230	my $max_insn;
e3751d82	231	for $i ( 0 .. $#insn_name ) {
a8a597b2 MB	232	$insn = uc($insn_name[$i]);
	233	if (defined($insn)) {
	234	$max_insn = $i;
	235	if ($add_enum_value) {
	236	print BYTERUN_H " INSN_$insn = $i,\t\t\t/* $i */\n";
	237	$add_enum_value = 0;
	238	} else {
	239	print BYTERUN_H " INSN_$insn,\t\t\t/* $i */\n";
	240	}
	241	} else {
	242	$add_enum_value = 1;
	243	}
	244	}
	245
	246	print BYTERUN_H " MAX_INSN = $max_insn\n};\n";
	247
	248	print BYTERUN_H "\nenum {\n";
	249	for ($i = 0; $i < @optype - 1; $i++) {
	250	printf BYTERUN_H " OPt_%s,\t\t/* %d */\n", $optype[$i], $i;
	251	}
	252	printf BYTERUN_H " OPt_%s\t\t/* %d */\n};\n\n", $optype[$i], $i;
a8a597b2	253
a8a597b2 MB	254	#
	255	# Finish off insn_data and create array initialisers in Asmdata.pm
	256	#
	257	print ASMDATA_PM <<'EOT';
	258
	259	my ($insn_name, $insn_data);
	260	while (($insn_name, $insn_data) = each %insn_data) {
	261	$insn_name[$insn_data->[0]] = $insn_name;
	262	}
	263	# Fill in any gaps
	264	@insn_name = map($_ \|\| "unused", @insn_name);
	265
	266	1;
42d3a99d GS	267
	268	__END__
	269
	270	=head1 NAME
	271
	272	B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode
	273
	274	=head1 SYNOPSIS
	275
4162ffa6	276	use B::Asmdata qw(%insn_data @insn_name @optype @specialsv_name);
42d3a99d GS	277
	278	=head1 DESCRIPTION
	279
4162ffa6 MS	280	Provides information about Perl ops in order to generate bytecode via
	281	a bunch of exported variables. Its mostly used by B::Assembler and
	282	B::Disassembler.
	283
	284	=over 4
	285
	286	=item %insn_data
	287
	288	my($bytecode_num, $put_sub, $get_meth) = @$insn_data{$op_name};
	289
	290	For a given $op_name (for example, 'cop_label', 'sv_flags', etc...)
	291	you get an array ref containing the bytecode number of the op, a
	292	reference to the subroutine used to 'PUT', and the name of the method
	293	used to 'GET'.
	294
	295	=for _private
	296	Add more detail about what $put_sub and $get_meth are and how to use them.
	297
	298	=item @insn_name
	299
	300	my $op_name = $insn_name[$bytecode_num];
	301
	302	A simple mapping of the bytecode number to the name of the op.
	303	Suitable for using with %insn_data like so:
	304
	305	my $op_info = $insn_data{$insn_name[$bytecode_num]};
	306
	307	=item @optype
	308
	309	my $op_type = $optype[$op_type_num];
	310
	311	A simple mapping of the op type number to its type (like 'COP' or 'BINOP').
	312
	313	=item @specialsv_name
	314
	315	my $sv_name = $specialsv_name[$sv_index];
	316
	317	Certain SV types are considered 'special'. They're represented by
	318	B::SPECIAL and are refered to by a number from the specialsv_list.
	319	This array maps that number back to the name of the SV (like 'Nullsv'
	320	or '&PL_sv_undef').
	321
	322	=back
42d3a99d GS	323
	324	=head1 AUTHOR
	325
	326	Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
	327
	328	=cut
a8a597b2 MB	329	EOT
a8a597b2 MB	330
36bb303b NC	331
	332	close ASMDATA_PM or die "Error closing ASMDATA_PM: $!";
	333	close BYTERUN_H or die "Error closing BYTERUN_H: $!";
	334	close BYTERUN_C or die "Error closing BYTERUN_C: $!";
	335
a8a597b2 MB	336	__END__
	337	# First set instruction ord("#") to read comment to end-of-line (sneaky)
	338	%number 35
fe3a57c4	339	comment arg comment_t
a8a597b2 MB	340	# Then make ord("\n") into a no-op
	341	%number 10
	342	nop none none
1df34986	343
a8a597b2 MB	344	# Now for the rest of the ordinary ones, beginning with \0 which is
	345	# ret so that \0-terminated strings can be read properly as bytecode.
	346	%number 0
	347	#
b97332e7 JH	348	# The argtype is either a single type or "rightvaluecast/argtype".
b97332e7 JH	349	#
92742e37	350	#opcode lvalue argtype flags
a8a597b2	351	#
92742e37	352	ret none none x
059a8bb7	353	ldsv bstate->bs_sv svindex
92742e37	354	ldop PL_op opindex
059a8bb7	355	stsv bstate->bs_sv U32 s
92742e37	356	stop PL_op U32 s
059a8bb7 JH	357	stpv bstate->bs_pv.xpv_pv U32 x
059a8bb7 JH	358	ldspecsv bstate->bs_sv U8 x
566ece03	359	ldspecsvx bstate->bs_sv U8 x
059a8bb7	360	newsv bstate->bs_sv U8 x
566ece03	361	newsvx bstate->bs_sv U32 x
92742e37	362	newop PL_op U8 x
566ece03	363	newopx PL_op U16 x
92742e37 GS	364	newopn PL_op U8 x
92742e37 GS	365	newpv none PV
059a8bb7 JH	366	pv_cur bstate->bs_pv.xpv_cur STRLEN
059a8bb7 JH	367	pv_free bstate->bs_pv none x
6e21dc91	368	sv_upgrade bstate->bs_sv U8 x
059a8bb7 JH	369	sv_refcnt SvREFCNT(bstate->bs_sv) U32
	370	sv_refcnt_add SvREFCNT(bstate->bs_sv) I32 x
	371	sv_flags SvFLAGS(bstate->bs_sv) U32
87a1ef3d	372	xrv bstate->bs_sv svindex x
059a8bb7	373	xpv bstate->bs_sv none x
87a1ef3d SP	374	xpv_cur bstate->bs_sv STRLEN x
	375	xpv_len bstate->bs_sv STRLEN x
	376	xiv bstate->bs_sv IV x
	377	xnv bstate->bs_sv NV x
059a8bb7 JH	378	xlv_targoff LvTARGOFF(bstate->bs_sv) STRLEN
	379	xlv_targlen LvTARGLEN(bstate->bs_sv) STRLEN
	380	xlv_targ LvTARG(bstate->bs_sv) svindex
	381	xlv_type LvTYPE(bstate->bs_sv) char
	382	xbm_useful BmUSEFUL(bstate->bs_sv) I32
	383	xbm_previous BmPREVIOUS(bstate->bs_sv) U16
	384	xbm_rare BmRARE(bstate->bs_sv) U8
11a7ac70 JH	385	xfm_lines FmLINES(bstate->bs_sv) IV
	386	xio_lines IoLINES(bstate->bs_sv) IV
	387	xio_page IoPAGE(bstate->bs_sv) IV
	388	xio_page_len IoPAGE_LEN(bstate->bs_sv) IV
	389	xio_lines_left IoLINES_LEFT(bstate->bs_sv) IV
1df34986	390	xio_top_name IoTOP_NAME(bstate->bs_sv) pvindex
059a8bb7	391	xio_top_gv (SV*)&IoTOP_GV(bstate->bs_sv) svindex
1df34986	392	xio_fmt_name IoFMT_NAME(bstate->bs_sv) pvindex
059a8bb7	393	xio_fmt_gv (SV*)&IoFMT_GV(bstate->bs_sv) svindex
1df34986	394	xio_bottom_name IoBOTTOM_NAME(bstate->bs_sv) pvindex
059a8bb7 JH	395	xio_bottom_gv (SV*)&IoBOTTOM_GV(bstate->bs_sv) svindex
	396	xio_subprocess IoSUBPROCESS(bstate->bs_sv) short
	397	xio_type IoTYPE(bstate->bs_sv) char
	398	xio_flags IoFLAGS(bstate->bs_sv) char
1df34986	399	xcv_xsubany (SV*)&CvXSUBANY(bstate->bs_sv).any_ptr svindex
059a8bb7 JH	400	xcv_stash (SV*)&CvSTASH(bstate->bs_sv) svindex
	401	xcv_start CvSTART(bstate->bs_sv) opindex
	402	xcv_root CvROOT(bstate->bs_sv) opindex
	403	xcv_gv (SV*)&CvGV(bstate->bs_sv) svindex
	404	xcv_file CvFILE(bstate->bs_sv) pvindex
	405	xcv_depth CvDEPTH(bstate->bs_sv) long
	406	xcv_padlist (SV*)&CvPADLIST(bstate->bs_sv) svindex
	407	xcv_outside (SV*)&CvOUTSIDE(bstate->bs_sv) svindex
f52873be	408	xcv_outside_seq CvOUTSIDE_SEQ(bstate->bs_sv) U32
059a8bb7 JH	409	xcv_flags CvFLAGS(bstate->bs_sv) U16
059a8bb7 JH	410	av_extend bstate->bs_sv SSize_t x
1df34986	411	av_pushx bstate->bs_sv svindex x
059a8bb7 JH	412	av_push bstate->bs_sv svindex x
	413	xav_fill AvFILLp(bstate->bs_sv) SSize_t
	414	xav_max AvMAX(bstate->bs_sv) SSize_t
	415	xav_flags AvFLAGS(bstate->bs_sv) U8
	416	xhv_riter HvRITER(bstate->bs_sv) I32
1df34986 AE	417	xhv_name HvNAME(bstate->bs_sv) pvindex
1df34986 AE	418	xhv_pmroot (OP*)&HvPMROOT(bstate->bs_sv) opindex
059a8bb7 JH	419	hv_store bstate->bs_sv svindex x
	420	sv_magic bstate->bs_sv char x
	421	mg_obj SvMAGIC(bstate->bs_sv)->mg_obj svindex
	422	mg_private SvMAGIC(bstate->bs_sv)->mg_private U16
	423	mg_flags SvMAGIC(bstate->bs_sv)->mg_flags U8
1df34986 AE	424	mg_name SvMAGIC(bstate->bs_sv) pvcontents x
1df34986 AE	425	mg_namex SvMAGIC(bstate->bs_sv) svindex x
87a1ef3d	426	xmg_stash bstate->bs_sv svindex X
059a8bb7	427	gv_fetchpv bstate->bs_sv strconst x
566ece03	428	gv_fetchpvx bstate->bs_sv strconst x
059a8bb7	429	gv_stashpv bstate->bs_sv strconst x
566ece03	430	gv_stashpvx bstate->bs_sv strconst x
059a8bb7 JH	431	gp_sv GvSV(bstate->bs_sv) svindex
	432	gp_refcnt GvREFCNT(bstate->bs_sv) U32
	433	gp_refcnt_add GvREFCNT(bstate->bs_sv) I32 x
	434	gp_av (SV*)&GvAV(bstate->bs_sv) svindex
	435	gp_hv (SV*)&GvHV(bstate->bs_sv) svindex
	436	gp_cv (SV*)&GvCV(bstate->bs_sv) svindex
	437	gp_file GvFILE(bstate->bs_sv) pvindex
	438	gp_io (SV*)&GvIOp(bstate->bs_sv) svindex
	439	gp_form (SV*)&GvFORM(bstate->bs_sv) svindex
	440	gp_cvgen GvCVGEN(bstate->bs_sv) U32
	441	gp_line GvLINE(bstate->bs_sv) line_t
	442	gp_share bstate->bs_sv svindex x
	443	xgv_flags GvFLAGS(bstate->bs_sv) U8
92742e37 GS	444	op_next PL_op->op_next opindex
	445	op_sibling PL_op->op_sibling opindex
	446	op_ppaddr PL_op->op_ppaddr strconst x
	447	op_targ PL_op->op_targ PADOFFSET
	448	op_type PL_op OPCODE x
2814eb74 PJ	449	op_opt PL_op->op_opt U8
2814eb74 PJ	450	op_static PL_op->op_static U8
92742e37 GS	451	op_flags PL_op->op_flags U8
	452	op_private PL_op->op_private U8
	453	op_first cUNOP->op_first opindex
	454	op_last cBINOP->op_last opindex
	455	op_other cLOGOP->op_other opindex
92742e37	456	op_pmreplroot cPMOP->op_pmreplroot opindex
92742e37 GS	457	op_pmreplstart cPMOP->op_pmreplstart opindex
92742e37 GS	458	op_pmnext (OP*)&cPMOP->op_pmnext opindex
1df34986	459	#ifdef USE_ITHREADS
47682f07	460	op_pmstashpv cPMOP pvindex x
b97332e7	461	op_pmreplrootpo cPMOP->op_pmreplroot OP*/PADOFFSET
1df34986 AE	462	#else
	463	op_pmstash (SV*)&cPMOP->op_pmstash svindex
	464	op_pmreplrootgv (SV*)&cPMOP->op_pmreplroot svindex
	465	#endif
92742e37 GS	466	pregcomp PL_op pvcontents x
	467	op_pmflags cPMOP->op_pmflags U16
	468	op_pmpermflags cPMOP->op_pmpermflags U16
1df34986	469	op_pmdynflags cPMOP->op_pmdynflags U8
92742e37	470	op_sv cSVOP->op_sv svindex
7934575e	471	op_padix cPADOP->op_padix PADOFFSET
92742e37 GS	472	op_pv cPVOP->op_pv pvcontents
	473	op_pv_tr cPVOP->op_pv op_tr_array
	474	op_redoop cLOOP->op_redoop opindex
	475	op_nextop cLOOP->op_nextop opindex
	476	op_lastop cLOOP->op_lastop opindex
059a8bb7	477	cop_label cCOP->cop_label pvindex
1df34986	478	#ifdef USE_ITHREADS
059a8bb7 JH	479	cop_stashpv cCOP pvindex x
059a8bb7 JH	480	cop_file cCOP pvindex x
1df34986 AE	481	#else
	482	cop_stash cCOP svindex x
	483	cop_filegv cCOP svindex x
	484	#endif
92742e37 GS	485	cop_seq cCOP->cop_seq U32
92742e37 GS	486	cop_arybase cCOP->cop_arybase I32
1df34986 AE	487	cop_line cCOP->cop_line line_t
1df34986 AE	488	cop_io cCOP->cop_io svindex
b295d113	489	cop_warnings cCOP->cop_warnings svindex
92742e37 GS	490	main_start PL_main_start opindex
92742e37 GS	491	main_root PL_main_root opindex
1df34986	492	main_cv (SV*)&PL_main_cv svindex
92742e37	493	curpad PL_curpad svindex x
059a8bb7 JH	494	push_begin PL_beginav svindex x
	495	push_init PL_initav svindex x
	496	push_end PL_endav svindex x
1df34986 AE	497	curstash (SV*)&PL_curstash svindex
	498	defstash (SV*)&PL_defstash svindex
	499	data none U8 x
0ac16f7c	500	incav (SV*)&GvAV(PL_incgv) svindex
1df34986 AE	501	load_glob none svindex x
	502	#ifdef USE_ITHREADS
	503	regex_padav (SV*)&PL_regex_padav svindex
	504	#endif
	505	dowarn PL_dowarn U8
	506	comppad_name (SV*)&PL_comppad_name svindex
	507	xgv_stash (SV*)&GvSTASH(bstate->bs_sv) svindex
	508	signal bstate->bs_sv strconst x
	509	# to be removed
	510	formfeed PL_formfeed svindex