c9bb4910095a5e2b814b19abb16c415f7d8b5098
[p5sagit/p5-mst-13.2.git] / bytecode.pl
1 BEGIN {
2   push @INC, './lib';
3 }
4 use strict;
5 my %alias_to = (
6     U32 => [qw(PADOFFSET STRLEN)],
7     I32 => [qw(SSize_t long)],
8     U16 => [qw(OPCODE line_t short)],
9     U8 => [qw(char)],
10 );
11
12 my @optype= qw(OP UNOP BINOP LOGOP CONDOP LISTOP PMOP SVOP GVOP PVOP LOOP COP);
13
14 # Nullsv *must* come first in the following so that the condition
15 # ($$sv == 0) can continue to be used to test (sv == Nullsv).
16 my @specialsv = qw(Nullsv &PL_sv_undef &PL_sv_yes &PL_sv_no);
17
18 my (%alias_from, $from, $tos);
19 while (($from, $tos) = each %alias_to) {
20     map { $alias_from{$_} = $from } @$tos;
21 }
22
23 my $c_header = <<'EOT';
24 /*
25  *      Copyright (c) 1996-1999 Malcolm Beattie
26  *
27  *      You may distribute under the terms of either the GNU General Public
28  *      License or the Artistic License, as specified in the README file.
29  *
30  */
31 /*
32  * This file is autogenerated from bytecode.pl. Changes made here will be lost.
33  */
34 EOT
35
36 my $perl_header;
37 ($perl_header = $c_header) =~ s{[/ ]?\*/?}{#}g;
38
39 unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.pm";
40
41 #
42 # Start with boilerplate for Asmdata.pm
43 #
44 open(ASMDATA_PM, ">ext/B/B/Asmdata.pm") or die "ext/B/B/Asmdata.pm: $!";
45 print ASMDATA_PM $perl_header, <<'EOT';
46 package B::Asmdata;
47 use Exporter;
48 @ISA = qw(Exporter);
49 @EXPORT_OK = qw(%insn_data @insn_name @optype @specialsv_name);
50 use vars qw(%insn_data @insn_name @optype @specialsv_name);
51
52 EOT
53 print ASMDATA_PM <<"EOT";
54 \@optype = qw(@optype);
55 \@specialsv_name = qw(@specialsv);
56
57 # XXX insn_data is initialised this way because with a large
58 # %insn_data = (foo => [...], bar => [...], ...) initialiser
59 # I get a hard-to-track-down stack underflow and segfault.
60 EOT
61
62 #
63 # Boilerplate for byterun.c
64 #
65 open(BYTERUN_C, ">ext/ByteLoader/byterun.c") or die "ext/ByteLoader/byterun.c: $!";
66 print BYTERUN_C $c_header, <<'EOT';
67
68 #include "EXTERN.h"
69 #include "perl.h"
70 #include "byterun.h"
71 #include "bytecode.h"
72
73 static int optype_size[] = {
74 EOT
75 my $i = 0;
76 for ($i = 0; $i < @optype - 1; $i++) {
77     printf BYTERUN_C "    sizeof(%s),\n", $optype[$i], $i;
78 }
79 printf BYTERUN_C "    sizeof(%s)\n", $optype[$i], $i;
80 print BYTERUN_C <<'EOT';
81 };
82
83 static SV *specialsv_list[4];
84
85 static int bytecode_iv_overflows = 0;
86 static SV *bytecode_sv;
87 static XPV bytecode_pv;
88 static void **bytecode_obj_list;
89 static I32 bytecode_obj_list_fill = -1;
90
91 void *
92 bset_obj_store(void *obj, I32 ix)
93 {
94     if (ix > bytecode_obj_list_fill) {
95         if (bytecode_obj_list_fill == -1)
96             New(666, bytecode_obj_list, ix + 1, void*);
97         else
98             Renew(bytecode_obj_list, ix + 1, void*);
99         bytecode_obj_list_fill = ix;
100     }
101     bytecode_obj_list[ix] = obj;
102     return obj;
103 }
104
105 void
106 byterun(pTHX_ struct bytestream bs)
107 {
108     dTHR;
109     int insn;
110
111 EOT
112
113 for (my $i = 0; $i < @specialsv; $i++) {
114     print BYTERUN_C "    specialsv_list[$i] = $specialsv[$i];\n";
115 }
116
117 print BYTERUN_C <<'EOT';
118
119     while ((insn = BGET_FGETC()) != EOF) {
120         switch (insn) {
121 EOT
122
123
124 my (@insn_name, $insn_num, $insn, $lvalue, $argtype, $flags, $fundtype);
125
126 while (<DATA>) {
127     chop;
128     s/#.*//;                    # remove comments
129     next unless length;
130     if (/^%number\s+(.*)/) {
131         $insn_num = $1;
132         next;
133     } elsif (/%enum\s+(.*?)\s+(.*)/) {
134         create_enum($1, $2);    # must come before instructions
135         next;
136     }
137     ($insn, $lvalue, $argtype, $flags) = split;
138     $insn_name[$insn_num] = $insn;
139     $fundtype = $alias_from{$argtype} || $argtype;
140
141     #
142     # Add the case statement and code for the bytecode interpreter in byterun.c
143     #
144     printf BYTERUN_C "\t  case INSN_%s:\t\t/* %d */\n\t    {\n",
145         uc($insn), $insn_num;
146     my $optarg = $argtype eq "none" ? "" : ", arg";
147     if ($optarg) {
148         printf BYTERUN_C "\t\t$argtype arg;\n\t\tBGET_%s(arg);\n", $fundtype;
149     }
150     if ($flags =~ /x/) {
151         print BYTERUN_C "\t\tBSET_$insn($lvalue$optarg);\n";
152     } elsif ($flags =~ /s/) {
153         # Store instructions store to bytecode_obj_list[arg]. "lvalue" field is rvalue.
154         print BYTERUN_C "\t\tBSET_OBJ_STORE($lvalue$optarg);\n";
155     }
156     elsif ($optarg && $lvalue ne "none") {
157         print BYTERUN_C "\t\t$lvalue = arg;\n";
158     }
159     print BYTERUN_C "\t\tbreak;\n\t    }\n";
160
161     #
162     # Add the initialiser line for %insn_data in Asmdata.pm
163     #
164     print ASMDATA_PM <<"EOT";
165 \$insn_data{$insn} = [$insn_num, \\&PUT_$fundtype, "GET_$fundtype"];
166 EOT
167
168     # Find the next unused instruction number
169     do { $insn_num++ } while $insn_name[$insn_num];
170 }
171
172 #
173 # Finish off byterun.c
174 #
175 print BYTERUN_C <<'EOT';
176           default:
177             Perl_croak(aTHX_ "Illegal bytecode instruction %d\n", insn);
178             /* NOTREACHED */
179         }
180     }
181 }
182 EOT
183
184 #
185 # Write the instruction and optype enum constants into byterun.h
186 #
187 open(BYTERUN_H, ">ext/ByteLoader/byterun.h") or die "ext/ByteLoader/byterun.h: $!";
188 print BYTERUN_H $c_header, <<'EOT';
189 struct bytestream {
190     void *data;
191     int (*fgetc)(void *);
192     int (*fread)(char *, size_t, size_t, void *);
193     void (*freadpv)(U32, void *, XPV *);
194 };
195
196 enum {
197 EOT
198
199 my $i = 0;
200 my $add_enum_value = 0;
201 my $max_insn;
202 for ($i = 0; $i < @insn_name; $i++) {
203     $insn = uc($insn_name[$i]);
204     if (defined($insn)) {
205         $max_insn = $i;
206         if ($add_enum_value) {
207             print BYTERUN_H "    INSN_$insn = $i,\t\t\t/* $i */\n";
208             $add_enum_value = 0;
209         } else {
210             print BYTERUN_H "    INSN_$insn,\t\t\t/* $i */\n";
211         }
212     } else {
213         $add_enum_value = 1;
214     }
215 }
216
217 print BYTERUN_H "    MAX_INSN = $max_insn\n};\n";
218
219 print BYTERUN_H "\nenum {\n";
220 for ($i = 0; $i < @optype - 1; $i++) {
221     printf BYTERUN_H "    OPt_%s,\t\t/* %d */\n", $optype[$i], $i;
222 }
223 printf BYTERUN_H "    OPt_%s\t\t/* %d */\n};\n\n", $optype[$i], $i;
224 print BYTERUN_H <<'EOT';
225 EXT int PL_optype_size[]
226 #ifdef DOINIT
227 = {
228 EOT
229 for ($i = 0; $i < @optype - 1; $i++) {
230     printf BYTERUN_H "    sizeof(%s),\n", $optype[$i], $i;
231 }
232 printf BYTERUN_H "    sizeof(%s)\n}\n", $optype[$i], $i;
233 print BYTERUN_H <<'EOT';
234 #endif /* DOINIT */
235 ;
236
237 EOT
238
239 print BYTERUN_H <<'EOT';
240 #define INIT_SPECIALSV_LIST STMT_START { \
241 EOT
242 for ($i = 0; $i < @specialsv; $i++) {
243     print BYTERUN_H "\tPL_specialsv_list[$i] = $specialsv[$i]; \\\n";
244 }
245 print BYTERUN_H <<'EOT';
246     } STMT_END
247 EOT
248
249 #
250 # Finish off insn_data and create array initialisers in Asmdata.pm
251 #
252 print ASMDATA_PM <<'EOT';
253
254 my ($insn_name, $insn_data);
255 while (($insn_name, $insn_data) = each %insn_data) {
256     $insn_name[$insn_data->[0]] = $insn_name;
257 }
258 # Fill in any gaps
259 @insn_name = map($_ || "unused", @insn_name);
260
261 1;
262
263 __END__
264
265 =head1 NAME
266
267 B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode
268
269 =head1 SYNOPSIS
270
271         use Asmdata;
272
273 =head1 DESCRIPTION
274
275 See F<ext/B/B/Asmdata.pm>.
276
277 =head1 AUTHOR
278
279 Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
280
281 =cut
282 EOT
283
284 __END__
285 # First set instruction ord("#") to read comment to end-of-line (sneaky)
286 %number 35
287 comment         arg                     comment_t
288 # Then make ord("\n") into a no-op
289 %number 10
290 nop             none                    none
291 # Now for the rest of the ordinary ones, beginning with \0 which is
292 # ret so that \0-terminated strings can be read properly as bytecode.
293 %number 0
294 #
295 #opcode         lvalue                                  argtype         flags   
296 #
297 ret             none                                    none            x
298 ldsv            bytecode_sv                             svindex
299 ldop            PL_op                                   opindex
300 stsv            bytecode_sv                             U32             s
301 stop            PL_op                                   U32             s
302 ldspecsv        bytecode_sv                             U8              x
303 newsv           bytecode_sv                             U8              x
304 newop           PL_op                                   U8              x
305 newopn          PL_op                                   U8              x
306 newpv           none                                    PV
307 pv_cur          bytecode_pv.xpv_cur                     STRLEN
308 pv_free         bytecode_pv                             none            x
309 sv_upgrade      bytecode_sv                             char            x
310 sv_refcnt       SvREFCNT(bytecode_sv)                   U32
311 sv_refcnt_add   SvREFCNT(bytecode_sv)                   I32             x
312 sv_flags        SvFLAGS(bytecode_sv)                    U32
313 xrv             SvRV(bytecode_sv)                       svindex
314 xpv             bytecode_sv                             none            x
315 xiv32           SvIVX(bytecode_sv)                      I32
316 xiv64           SvIVX(bytecode_sv)                      IV64
317 xnv             SvNVX(bytecode_sv)                      double
318 xlv_targoff     LvTARGOFF(bytecode_sv)                  STRLEN
319 xlv_targlen     LvTARGLEN(bytecode_sv)                  STRLEN
320 xlv_targ        LvTARG(bytecode_sv)                     svindex
321 xlv_type        LvTYPE(bytecode_sv)                     char
322 xbm_useful      BmUSEFUL(bytecode_sv)                   I32
323 xbm_previous    BmPREVIOUS(bytecode_sv)                 U16
324 xbm_rare        BmRARE(bytecode_sv)                     U8
325 xfm_lines       FmLINES(bytecode_sv)                    I32
326 xio_lines       IoLINES(bytecode_sv)                    long
327 xio_page        IoPAGE(bytecode_sv)                     long
328 xio_page_len    IoPAGE_LEN(bytecode_sv)                 long
329 xio_lines_left  IoLINES_LEFT(bytecode_sv)               long
330 xio_top_name    IoTOP_NAME(bytecode_sv)                 pvcontents
331 xio_top_gv      *(SV**)&IoTOP_GV(bytecode_sv)           svindex
332 xio_fmt_name    IoFMT_NAME(bytecode_sv)                 pvcontents
333 xio_fmt_gv      *(SV**)&IoFMT_GV(bytecode_sv)           svindex
334 xio_bottom_name IoBOTTOM_NAME(bytecode_sv)              pvcontents
335 xio_bottom_gv   *(SV**)&IoBOTTOM_GV(bytecode_sv)        svindex
336 xio_subprocess  IoSUBPROCESS(bytecode_sv)               short
337 xio_type        IoTYPE(bytecode_sv)                     char
338 xio_flags       IoFLAGS(bytecode_sv)                    char
339 xcv_stash       *(SV**)&CvSTASH(bytecode_sv)            svindex
340 xcv_start       CvSTART(bytecode_sv)                    opindex
341 xcv_root        CvROOT(bytecode_sv)                     opindex
342 xcv_gv          *(SV**)&CvGV(bytecode_sv)               svindex
343 xcv_filegv      *(SV**)&CvFILEGV(bytecode_sv)           svindex
344 xcv_depth       CvDEPTH(bytecode_sv)                    long
345 xcv_padlist     *(SV**)&CvPADLIST(bytecode_sv)          svindex
346 xcv_outside     *(SV**)&CvOUTSIDE(bytecode_sv)          svindex
347 xcv_flags       CvFLAGS(bytecode_sv)                    U8
348 av_extend       bytecode_sv                             SSize_t         x
349 av_push         bytecode_sv                             svindex         x
350 xav_fill        AvFILLp(bytecode_sv)                    SSize_t
351 xav_max         AvMAX(bytecode_sv)                      SSize_t
352 xav_flags       AvFLAGS(bytecode_sv)                    U8
353 xhv_riter       HvRITER(bytecode_sv)                    I32
354 xhv_name        HvNAME(bytecode_sv)                     pvcontents
355 hv_store        bytecode_sv                             svindex         x
356 sv_magic        bytecode_sv                             char            x
357 mg_obj          SvMAGIC(bytecode_sv)->mg_obj            svindex
358 mg_private      SvMAGIC(bytecode_sv)->mg_private        U16
359 mg_flags        SvMAGIC(bytecode_sv)->mg_flags          U8
360 mg_pv           SvMAGIC(bytecode_sv)                    pvcontents      x
361 xmg_stash       *(SV**)&SvSTASH(bytecode_sv)            svindex
362 gv_fetchpv      bytecode_sv                             strconst        x
363 gv_stashpv      bytecode_sv                             strconst        x
364 gp_sv           GvSV(bytecode_sv)                       svindex
365 gp_refcnt       GvREFCNT(bytecode_sv)                   U32
366 gp_refcnt_add   GvREFCNT(bytecode_sv)                   I32             x
367 gp_av           *(SV**)&GvAV(bytecode_sv)               svindex
368 gp_hv           *(SV**)&GvHV(bytecode_sv)               svindex
369 gp_cv           *(SV**)&GvCV(bytecode_sv)               svindex
370 gp_filegv       *(SV**)&GvFILEGV(bytecode_sv)           svindex
371 gp_io           *(SV**)&GvIOp(bytecode_sv)              svindex
372 gp_form         *(SV**)&GvFORM(bytecode_sv)             svindex
373 gp_cvgen        GvCVGEN(bytecode_sv)                    U32
374 gp_line         GvLINE(bytecode_sv)                     line_t
375 gp_share        bytecode_sv                             svindex         x
376 xgv_flags       GvFLAGS(bytecode_sv)                    U8
377 op_next         PL_op->op_next                          opindex
378 op_sibling      PL_op->op_sibling                       opindex
379 op_ppaddr       PL_op->op_ppaddr                        strconst        x
380 op_targ         PL_op->op_targ                          PADOFFSET
381 op_type         PL_op                                   OPCODE          x
382 op_seq          PL_op->op_seq                           U16
383 op_flags        PL_op->op_flags                         U8
384 op_private      PL_op->op_private                       U8
385 op_first        cUNOP->op_first                         opindex
386 op_last         cBINOP->op_last                         opindex
387 op_other        cLOGOP->op_other                        opindex
388 op_true         cCONDOP->op_true                        opindex
389 op_false        cCONDOP->op_false                       opindex
390 op_children     cLISTOP->op_children                    U32
391 op_pmreplroot   cPMOP->op_pmreplroot                    opindex
392 op_pmreplrootgv *(SV**)&cPMOP->op_pmreplroot            svindex
393 op_pmreplstart  cPMOP->op_pmreplstart                   opindex
394 op_pmnext       *(OP**)&cPMOP->op_pmnext                opindex
395 pregcomp        PL_op                                   pvcontents      x
396 op_pmflags      cPMOP->op_pmflags                       U16
397 op_pmpermflags  cPMOP->op_pmpermflags                   U16
398 op_sv           cSVOP->op_sv                            svindex
399 op_gv           *(SV**)&cGVOP->op_gv                    svindex
400 op_pv           cPVOP->op_pv                            pvcontents
401 op_pv_tr        cPVOP->op_pv                            op_tr_array
402 op_redoop       cLOOP->op_redoop                        opindex
403 op_nextop       cLOOP->op_nextop                        opindex
404 op_lastop       cLOOP->op_lastop                        opindex
405 cop_label       cCOP->cop_label                         pvcontents
406 cop_stash       *(SV**)&cCOP->cop_stash                 svindex
407 cop_filegv      *(SV**)&cCOP->cop_filegv                svindex
408 cop_seq         cCOP->cop_seq                           U32
409 cop_arybase     cCOP->cop_arybase                       I32
410 cop_line        cCOP->cop_line                          line_t
411 cop_warnings    cCOP->cop_warnings                      svindex
412 main_start      PL_main_start                           opindex
413 main_root       PL_main_root                            opindex
414 curpad          PL_curpad                               svindex         x