3 require 'regen_lib.pl';
8 PADOFFSET => [qw(STRLEN SSize_t)],
9 U16 => [qw(OPCODE short)],
13 my @optype= qw(OP UNOP BINOP LOGOP LISTOP PMOP SVOP PADOP PVOP LOOP COP);
15 # Nullsv *must* come first in the following so that the condition
16 # ($$sv == 0) can continue to be used to test (sv == Nullsv).
17 my @specialsv = qw(Nullsv &PL_sv_undef &PL_sv_yes &PL_sv_no pWARN_ALL pWARN_NONE);
19 my (%alias_from, $from, $tos);
20 while (($from, $tos) = each %alias_to) {
21 map { $alias_from{$_} = $from } @$tos;
24 my $c_header = <<'EOT';
26 * Copyright (c) 1996-1999 Malcolm Beattie
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.
33 * This file is autogenerated from bytecode.pl. Changes made here will be lost.
38 ($perl_header = $c_header) =~ s{[/ ]?\*/?}{#}g;
40 safer_unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.pm";
43 # Start with boilerplate for Asmdata.pm
45 open(ASMDATA_PM, ">ext/B/B/Asmdata.pm") or die "ext/B/B/Asmdata.pm: $!";
47 print ASMDATA_PM $perl_header, <<'EOT';
50 our $VERSION = '1.01';
54 @EXPORT_OK = qw(%insn_data @insn_name @optype @specialsv_name);
55 our(%insn_data, @insn_name, @optype, @specialsv_name);
58 print ASMDATA_PM <<"EOT";
59 \@optype = qw(@optype);
60 \@specialsv_name = qw(@specialsv);
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.
68 # Boilerplate for byterun.c
70 open(BYTERUN_C, ">ext/ByteLoader/byterun.c") or die "ext/ByteLoader/byterun.c: $!";
72 print BYTERUN_C $c_header, <<'EOT';
74 #define PERL_NO_GET_CONTEXT
84 static const int optype_size[] = {
87 for ($i = 0; $i < @optype - 1; $i++) {
88 printf BYTERUN_C " sizeof(%s),\n", $optype[$i], $i;
90 printf BYTERUN_C " sizeof(%s)\n", $optype[$i], $i;
91 print BYTERUN_C <<'EOT';
95 bset_obj_store(pTHX_ struct byteloader_state *bstate, void *obj, I32 ix)
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;
101 bstate->bs_obj_list[ix] = obj;
106 byterun(pTHX_ register struct byteloader_state *bstate)
110 SV *specialsv_list[6];
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;
115 bstate->bs_obj_list[0] = NULL; /* first is always Null */
120 for my $i ( 0 .. $#specialsv ) {
121 print BYTERUN_C " specialsv_list[$i] = $specialsv[$i];\n";
124 print BYTERUN_C <<'EOT';
126 while ((insn = BGET_FGETC()) != EOF) {
131 my (@insn_name, $insn_num, $insn, $lvalue, $argtype, $flags, $fundtype);
135 print BYTERUN_C if /^\s*#\s*(?:if|endif|el)/;
140 if (/^%number\s+(.*)/) {
143 } elsif (/%enum\s+(.*?)\s+(.*)/) {
144 create_enum($1, $2); # must come before instructions
147 ($insn, $lvalue, $argtype, $flags) = split;
149 if ($argtype =~ m:(.+)/(.+):) {
150 ($rvalcast, $argtype) = ("($1)", $2);
152 $insn_name[$insn_num] = $insn;
153 $fundtype = $alias_from{$argtype} || $argtype;
156 # Add the case statement and code for the bytecode interpreter in byterun.c
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";
162 printf BYTERUN_C "\t\t$argtype arg;\n\t\tBGET_%s(arg);\n", $fundtype;
165 print BYTERUN_C "\t\tBSET_$insn($lvalue$optarg);\n";
166 } elsif ($flags =~ /s/) {
167 # Store instructions store to bytecode_obj_list[arg]. "lvalue" field is rvalue.
168 print BYTERUN_C "\t\tBSET_OBJ_STORE($lvalue$optarg);\n";
170 elsif ($optarg && $lvalue ne "none") {
171 print BYTERUN_C "\t\t$lvalue = ${rvalcast}arg;\n";
173 print BYTERUN_C "\t\tbreak;\n\t }\n";
176 # Add the initialiser line for %insn_data in Asmdata.pm
178 print ASMDATA_PM <<"EOT";
179 \$insn_data{$insn} = [$insn_num, \\&PUT_$fundtype, "GET_$fundtype"];
182 # Find the next unused instruction number
183 do { $insn_num++ } while $insn_name[$insn_num];
187 # Finish off byterun.c
189 print BYTERUN_C <<'EOT';
191 Perl_croak(aTHX_ "Illegal bytecode instruction %d\n", insn);
200 # Write the instruction and optype enum constants into byterun.h
202 open(BYTERUN_H, ">ext/ByteLoader/byterun.h") or die "ext/ByteLoader/byterun.h: $!";
204 print BYTERUN_H $c_header, <<'EOT';
205 struct byteloader_fdata {
211 struct byteloader_state {
212 struct byteloader_fdata *bs_fdata;
215 int bs_obj_list_fill;
221 int bl_getc(struct byteloader_fdata *);
222 int bl_read(struct byteloader_fdata *, char *, size_t, size_t);
223 extern int byterun(pTHX_ struct byteloader_state *);
228 my $add_enum_value = 0;
230 for $i ( 0 .. $#insn_name ) {
231 $insn = uc($insn_name[$i]);
232 if (defined($insn)) {
234 if ($add_enum_value) {
235 print BYTERUN_H " INSN_$insn = $i,\t\t\t/* $i */\n";
238 print BYTERUN_H " INSN_$insn,\t\t\t/* $i */\n";
245 print BYTERUN_H " MAX_INSN = $max_insn\n};\n";
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;
251 printf BYTERUN_H " OPt_%s\t\t/* %d */\n};\n\n", $optype[$i], $i;
254 # Finish off insn_data and create array initialisers in Asmdata.pm
256 print ASMDATA_PM <<'EOT';
258 my ($insn_name, $insn_data);
259 while (($insn_name, $insn_data) = each %insn_data) {
260 $insn_name[$insn_data->[0]] = $insn_name;
263 @insn_name = map($_ || "unused", @insn_name);
271 B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode
275 use B::Asmdata qw(%insn_data @insn_name @optype @specialsv_name);
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
287 my($bytecode_num, $put_sub, $get_meth) = @$insn_data{$op_name};
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
295 Add more detail about what $put_sub and $get_meth are and how to use them.
299 my $op_name = $insn_name[$bytecode_num];
301 A simple mapping of the bytecode number to the name of the op.
302 Suitable for using with %insn_data like so:
304 my $op_info = $insn_data{$insn_name[$bytecode_num]};
308 my $op_type = $optype[$op_type_num];
310 A simple mapping of the op type number to its type (like 'COP' or 'BINOP').
312 =item @specialsv_name
314 my $sv_name = $specialsv_name[$sv_index];
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'
325 Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
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: $!";
336 # First set instruction ord("#") to read comment to end-of-line (sneaky)
338 comment arg comment_t
339 # Then make ord("\n") into a no-op
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.
347 # The argtype is either a single type or "rightvaluecast/argtype".
349 #opcode lvalue argtype flags
352 ldsv bstate->bs_sv svindex
354 stsv bstate->bs_sv U32 s
356 stpv bstate->bs_pv.xpv_pv U32 x
357 ldspecsv bstate->bs_sv U8 x
358 ldspecsvx bstate->bs_sv U8 x
359 newsv bstate->bs_sv U8 x
360 newsvx bstate->bs_sv U32 x
365 pv_cur bstate->bs_pv.xpv_cur STRLEN
366 pv_free bstate->bs_pv none x
367 sv_upgrade bstate->bs_sv U8 x
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
373 xpv_cur SvCUR(bstate->bs_sv) STRLEN
374 xpv_len SvLEN(bstate->bs_sv) STRLEN
375 xiv SvIVX(bstate->bs_sv) IV
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
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
389 xio_top_name IoTOP_NAME(bstate->bs_sv) pvindex
390 xio_top_gv *(SV**)&IoTOP_GV(bstate->bs_sv) svindex
391 xio_fmt_name IoFMT_NAME(bstate->bs_sv) pvindex
392 xio_fmt_gv *(SV**)&IoFMT_GV(bstate->bs_sv) svindex
393 xio_bottom_name IoBOTTOM_NAME(bstate->bs_sv) pvindex
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
398 xcv_xsubany *(SV**)&CvXSUBANY(bstate->bs_sv).any_ptr svindex
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
407 xcv_outside_seq CvOUTSIDE_SEQ(bstate->bs_sv) U32
408 xcv_flags CvFLAGS(bstate->bs_sv) U16
409 av_extend bstate->bs_sv SSize_t x
410 av_pushx bstate->bs_sv svindex x
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
416 xhv_name HvNAME(bstate->bs_sv) pvindex
417 xhv_pmroot *(OP**)&HvPMROOT(bstate->bs_sv) opindex
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
423 mg_name SvMAGIC(bstate->bs_sv) pvcontents x
424 mg_namex SvMAGIC(bstate->bs_sv) svindex x
425 xmg_stash *(SV**)&SvSTASH(bstate->bs_sv) svindex
426 gv_fetchpv bstate->bs_sv strconst x
427 gv_fetchpvx bstate->bs_sv strconst x
428 gv_stashpv bstate->bs_sv strconst x
429 gv_stashpvx bstate->bs_sv strconst x
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
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
448 op_opt PL_op->op_opt U8
449 op_static PL_op->op_static U8
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
455 op_pmreplroot cPMOP->op_pmreplroot opindex
456 op_pmreplstart cPMOP->op_pmreplstart opindex
457 op_pmnext *(OP**)&cPMOP->op_pmnext opindex
459 op_pmstashpv cPMOP pvindex x
460 op_pmreplrootpo cPMOP->op_pmreplroot OP*/PADOFFSET
462 op_pmstash *(SV**)&cPMOP->op_pmstash svindex
463 op_pmreplrootgv *(SV**)&cPMOP->op_pmreplroot svindex
465 pregcomp PL_op pvcontents x
466 op_pmflags cPMOP->op_pmflags U16
467 op_pmpermflags cPMOP->op_pmpermflags U16
468 op_pmdynflags cPMOP->op_pmdynflags U8
469 op_sv cSVOP->op_sv svindex
470 op_padix cPADOP->op_padix PADOFFSET
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
476 cop_label cCOP->cop_label pvindex
478 cop_stashpv cCOP pvindex x
479 cop_file cCOP pvindex x
481 cop_stash cCOP svindex x
482 cop_filegv cCOP svindex x
484 cop_seq cCOP->cop_seq U32
485 cop_arybase cCOP->cop_arybase I32
486 cop_line cCOP->cop_line line_t
487 cop_io cCOP->cop_io svindex
488 cop_warnings cCOP->cop_warnings svindex
489 main_start PL_main_start opindex
490 main_root PL_main_root opindex
491 main_cv *(SV**)&PL_main_cv svindex
492 curpad PL_curpad svindex x
493 push_begin PL_beginav svindex x
494 push_init PL_initav svindex x
495 push_end PL_endav svindex x
496 curstash *(SV**)&PL_curstash svindex
497 defstash *(SV**)&PL_defstash svindex
499 incav *(SV**)&GvAV(PL_incgv) svindex
500 load_glob none svindex x
502 regex_padav *(SV**)&PL_regex_padav svindex
505 comppad_name *(SV**)&PL_comppad_name svindex
506 xgv_stash *(SV**)&GvSTASH(bstate->bs_sv) svindex
507 signal bstate->bs_sv strconst x
509 formfeed PL_formfeed svindex