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