[p5sagit/p5-mst-13.2.git] / bytecode.pl

BEGIN {
  push @INC, './lib';
  require 'regen_lib.pl';
}
use strict;
my %alias_to = (
    U32 => [qw(PADOFFSET STRLEN line_t)],
    I32 => [qw(SSize_t long)],
    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: $!";
print ASMDATA_PM $perl_header, <<'EOT';
package B::Asmdata;

our $VERSION = '1.00';

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