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