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 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 #define NO_XSLOCKS
  71 #include "XSUB.h"
  72
  73 #ifdef PERL_OBJECT
  74 #undef CALL_FPTR
  75 #define CALL_FPTR(fptr) (pPerl->*fptr)
  76 #undef PL_ppaddr
  77 #define PL_ppaddr (*get_ppaddr())
  78 #endif
  79
  80 #include "byterun.h"
  81 #include "bytecode.h"
  82
  83
  84 static int optype_size[] = {
  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
  94 static SV *specialsv_list[4];
  95
  96 static int bytecode_iv_overflows = 0;
  97 static SV *bytecode_sv;
  98 static XPV bytecode_pv;
  99 static void **bytecode_obj_list;
 100 static I32 bytecode_obj_list_fill = -1;
 101
 102 void *
 103 bset_obj_store(pTHXo_ void *obj, I32 ix)
 104 {
 105     if (ix > bytecode_obj_list_fill) {
 106         if (bytecode_obj_list_fill == -1)
 107             New(666, bytecode_obj_list, ix + 1, void*);
 108         else
 109             Renew(bytecode_obj_list, ix + 1, void*);
 110         bytecode_obj_list_fill = ix;
 111     }
 112     bytecode_obj_list[ix] = obj;
 113     return obj;
 114 }
 115
 116 void
 117 byterun(pTHXo_ struct bytestream bs)
 118 {
 119     dTHR;
 120     int insn;
 121
 122 EOT
 123
 124 for (my $i = 0; $i < @specialsv; $i++) {
 125     print BYTERUN_C "    specialsv_list[$i] = $specialsv[$i];\n";
 126 }
 127
 128 print BYTERUN_C <<'EOT';
 129
 130     while ((insn = BGET_FGETC()) != EOF) {
 131         switch (insn) {
 132 EOT
 133
 134
 135 my (@insn_name, $insn_num, $insn, $lvalue, $argtype, $flags, $fundtype);
 136
 137 while (<DATA>) {
 138     chop;
 139     s/#.*//;                    # remove comments
 140     next unless length;
 141     if (/^%number\s+(.*)/) {
 142         $insn_num = $1;
 143         next;
 144     } elsif (/%enum\s+(.*?)\s+(.*)/) {
 145         create_enum($1, $2);    # must come before instructions
 146         next;
 147     }
 148     ($insn, $lvalue, $argtype, $flags) = split;
 149     $insn_name[$insn_num] = $insn;
 150     $fundtype = $alias_from{$argtype} || $argtype;
 151
 152     #
 153     # Add the case statement and code for the bytecode interpreter in byterun.c
 154     #
 155     printf BYTERUN_C "\t  case INSN_%s:\t\t/* %d */\n\t    {\n",
 156         uc($insn), $insn_num;
 157     my $optarg = $argtype eq "none" ? "" : ", arg";
 158     if ($optarg) {
 159         printf BYTERUN_C "\t\t$argtype arg;\n\t\tBGET_%s(arg);\n", $fundtype;
 160     }
 161     if ($flags =~ /x/) {
 162         print BYTERUN_C "\t\tBSET_$insn($lvalue$optarg);\n";
 163     } elsif ($flags =~ /s/) {
 164         # Store instructions store to bytecode_obj_list[arg]. "lvalue" field is rvalue.
 165         print BYTERUN_C "\t\tBSET_OBJ_STORE($lvalue$optarg);\n";
 166     }
 167     elsif ($optarg && $lvalue ne "none") {
 168         print BYTERUN_C "\t\t$lvalue = arg;\n";
 169     }
 170     print BYTERUN_C "\t\tbreak;\n\t    }\n";
 171
 172     #
 173     # Add the initialiser line for %insn_data in Asmdata.pm
 174     #
 175     print ASMDATA_PM <<"EOT";
 176 \$insn_data{$insn} = [$insn_num, \\&PUT_$fundtype, "GET_$fundtype"];
 177 EOT
 178
 179     # Find the next unused instruction number
 180     do { $insn_num++ } while $insn_name[$insn_num];
 181 }
 182
 183 #
 184 # Finish off byterun.c
 185 #
 186 print BYTERUN_C <<'EOT';
 187           default:
 188             Perl_croak(aTHX_ "Illegal bytecode instruction %d\n", insn);
 189             /* NOTREACHED */
 190         }
 191     }
 192 }
 193 EOT
 194
 195 #
 196 # Write the instruction and optype enum constants into byterun.h
 197 #
 198 open(BYTERUN_H, ">ext/ByteLoader/byterun.h") or die "ext/ByteLoader/byterun.h: $!";
 199 print BYTERUN_H $c_header, <<'EOT';
 200 struct bytestream {
 201     void *data;
 202     int (*pfgetc)(void *);
 203     int (*pfread)(char *, size_t, size_t, void *);
 204     void (*pfreadpv)(U32, void *, XPV *);
 205 };
 206
 207 enum {
 208 EOT
 209
 210 my $add_enum_value = 0;
 211 my $max_insn;
 212 for ($i = 0; $i < @insn_name; $i++) {
 213     $insn = uc($insn_name[$i]);
 214     if (defined($insn)) {
 215         $max_insn = $i;
 216         if ($add_enum_value) {
 217             print BYTERUN_H "    INSN_$insn = $i,\t\t\t/* $i */\n";
 218             $add_enum_value = 0;
 219         } else {
 220             print BYTERUN_H "    INSN_$insn,\t\t\t/* $i */\n";
 221         }
 222     } else {
 223         $add_enum_value = 1;
 224     }
 225 }
 226
 227 print BYTERUN_H "    MAX_INSN = $max_insn\n};\n";
 228
 229 print BYTERUN_H "\nenum {\n";
 230 for ($i = 0; $i < @optype - 1; $i++) {
 231     printf BYTERUN_H "    OPt_%s,\t\t/* %d */\n", $optype[$i], $i;
 232 }
 233 printf BYTERUN_H "    OPt_%s\t\t/* %d */\n};\n\n", $optype[$i], $i;
 234
 235 print BYTERUN_H <<'EOT';
 236 EXT void byterun(pTHXo_ struct bytestream bs);
 237
 238 #define INIT_SPECIALSV_LIST STMT_START { \
 239 EOT
 240 for ($i = 0; $i < @specialsv; $i++) {
 241     print BYTERUN_H "\tPL_specialsv_list[$i] = $specialsv[$i]; \\\n";
 242 }
 243 print BYTERUN_H <<'EOT';
 244     } STMT_END
 245 EOT
 246
 247 #
 248 # Finish off insn_data and create array initialisers in Asmdata.pm
 249 #
 250 print ASMDATA_PM <<'EOT';
 251
 252 my ($insn_name, $insn_data);
 253 while (($insn_name, $insn_data) = each %insn_data) {
 254     $insn_name[$insn_data->[0]] = $insn_name;
 255 }
 256 # Fill in any gaps
 257 @insn_name = map($_ || "unused", @insn_name);
 258
 259 1;
 260
 261 __END__
 262
 263 =head1 NAME
 264
 265 B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode
 266
 267 =head1 SYNOPSIS
 268
 269         use Asmdata;
 270
 271 =head1 DESCRIPTION
 272
 273 See F<ext/B/B/Asmdata.pm>.
 274
 275 =head1 AUTHOR
 276
 277 Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
 278
 279 =cut
 280 EOT
 281
 282 __END__
 283 # First set instruction ord("#") to read comment to end-of-line (sneaky)
 284 %number 35
 285 comment         arg                     comment_t
 286 # Then make ord("\n") into a no-op
 287 %number 10
 288 nop             none                    none
 289 # Now for the rest of the ordinary ones, beginning with \0 which is
 290 # ret so that \0-terminated strings can be read properly as bytecode.
 291 %number 0
 292 #
 293 #opcode         lvalue                                  argtype         flags
 294 #
 295 ret             none                                    none            x
 296 ldsv            bytecode_sv                             svindex
 297 ldop            PL_op                                   opindex
 298 stsv            bytecode_sv                             U32             s
 299 stop            PL_op                                   U32             s
 300 ldspecsv        bytecode_sv                             U8              x
 301 newsv           bytecode_sv                             U8              x
 302 newop           PL_op                                   U8              x
 303 newopn          PL_op                                   U8              x
 304 newpv           none                                    PV
 305 pv_cur          bytecode_pv.xpv_cur                     STRLEN
 306 pv_free         bytecode_pv                             none            x
 307 sv_upgrade      bytecode_sv                             char            x
 308 sv_refcnt       SvREFCNT(bytecode_sv)                   U32
 309 sv_refcnt_add   SvREFCNT(bytecode_sv)                   I32             x
 310 sv_flags        SvFLAGS(bytecode_sv)                    U32
 311 xrv             SvRV(bytecode_sv)                       svindex
 312 xpv             bytecode_sv                             none            x
 313 xiv32           SvIVX(bytecode_sv)                      I32
 314 xiv64           SvIVX(bytecode_sv)                      IV64
 315 xnv             SvNVX(bytecode_sv)                      NV
 316 xlv_targoff     LvTARGOFF(bytecode_sv)                  STRLEN
 317 xlv_targlen     LvTARGLEN(bytecode_sv)                  STRLEN
 318 xlv_targ        LvTARG(bytecode_sv)                     svindex
 319 xlv_type        LvTYPE(bytecode_sv)                     char
 320 xbm_useful      BmUSEFUL(bytecode_sv)                   I32
 321 xbm_previous    BmPREVIOUS(bytecode_sv)                 U16
 322 xbm_rare        BmRARE(bytecode_sv)                     U8
 323 xfm_lines       FmLINES(bytecode_sv)                    I32
 324 xio_lines       IoLINES(bytecode_sv)                    long
 325 xio_page        IoPAGE(bytecode_sv)                     long
 326 xio_page_len    IoPAGE_LEN(bytecode_sv)                 long
 327 xio_lines_left  IoLINES_LEFT(bytecode_sv)               long
 328 xio_top_name    IoTOP_NAME(bytecode_sv)                 pvcontents
 329 xio_top_gv      *(SV**)&IoTOP_GV(bytecode_sv)           svindex
 330 xio_fmt_name    IoFMT_NAME(bytecode_sv)                 pvcontents
 331 xio_fmt_gv      *(SV**)&IoFMT_GV(bytecode_sv)           svindex
 332 xio_bottom_name IoBOTTOM_NAME(bytecode_sv)              pvcontents
 333 xio_bottom_gv   *(SV**)&IoBOTTOM_GV(bytecode_sv)        svindex
 334 xio_subprocess  IoSUBPROCESS(bytecode_sv)               short
 335 xio_type        IoTYPE(bytecode_sv)                     char
 336 xio_flags       IoFLAGS(bytecode_sv)                    char
 337 xcv_stash       *(SV**)&CvSTASH(bytecode_sv)            svindex
 338 xcv_start       CvSTART(bytecode_sv)                    opindex
 339 xcv_root        CvROOT(bytecode_sv)                     opindex
 340 xcv_gv          *(SV**)&CvGV(bytecode_sv)               svindex
 341 xcv_filegv      *(SV**)&CvFILEGV(bytecode_sv)           svindex
 342 xcv_depth       CvDEPTH(bytecode_sv)                    long
 343 xcv_padlist     *(SV**)&CvPADLIST(bytecode_sv)          svindex
 344 xcv_outside     *(SV**)&CvOUTSIDE(bytecode_sv)          svindex
 345 xcv_flags       CvFLAGS(bytecode_sv)                    U8
 346 av_extend       bytecode_sv                             SSize_t         x
 347 av_push         bytecode_sv                             svindex         x
 348 xav_fill        AvFILLp(bytecode_sv)                    SSize_t
 349 xav_max         AvMAX(bytecode_sv)                      SSize_t
 350 xav_flags       AvFLAGS(bytecode_sv)                    U8
 351 xhv_riter       HvRITER(bytecode_sv)                    I32
 352 xhv_name        HvNAME(bytecode_sv)                     pvcontents
 353 hv_store        bytecode_sv                             svindex         x
 354 sv_magic        bytecode_sv                             char            x
 355 mg_obj          SvMAGIC(bytecode_sv)->mg_obj            svindex
 356 mg_private      SvMAGIC(bytecode_sv)->mg_private        U16
 357 mg_flags        SvMAGIC(bytecode_sv)->mg_flags          U8
 358 mg_pv           SvMAGIC(bytecode_sv)                    pvcontents      x
 359 xmg_stash       *(SV**)&SvSTASH(bytecode_sv)            svindex
 360 gv_fetchpv      bytecode_sv                             strconst        x
 361 gv_stashpv      bytecode_sv                             strconst        x
 362 gp_sv           GvSV(bytecode_sv)                       svindex
 363 gp_refcnt       GvREFCNT(bytecode_sv)                   U32
 364 gp_refcnt_add   GvREFCNT(bytecode_sv)                   I32             x
 365 gp_av           *(SV**)&GvAV(bytecode_sv)               svindex
 366 gp_hv           *(SV**)&GvHV(bytecode_sv)               svindex
 367 gp_cv           *(SV**)&GvCV(bytecode_sv)               svindex
 368 gp_filegv       *(SV**)&GvFILEGV(bytecode_sv)           svindex
 369 gp_io           *(SV**)&GvIOp(bytecode_sv)              svindex
 370 gp_form         *(SV**)&GvFORM(bytecode_sv)             svindex
 371 gp_cvgen        GvCVGEN(bytecode_sv)                    U32
 372 gp_line         GvLINE(bytecode_sv)                     line_t
 373 gp_share        bytecode_sv                             svindex         x
 374 xgv_flags       GvFLAGS(bytecode_sv)                    U8
 375 op_next         PL_op->op_next                          opindex
 376 op_sibling      PL_op->op_sibling                       opindex
 377 op_ppaddr       PL_op->op_ppaddr                        strconst        x
 378 op_targ         PL_op->op_targ                          PADOFFSET
 379 op_type         PL_op                                   OPCODE          x
 380 op_seq          PL_op->op_seq                           U16
 381 op_flags        PL_op->op_flags                         U8
 382 op_private      PL_op->op_private                       U8
 383 op_first        cUNOP->op_first                         opindex
 384 op_last         cBINOP->op_last                         opindex
 385 op_other        cLOGOP->op_other                        opindex
 386 op_children     cLISTOP->op_children                    U32
 387 op_pmreplroot   cPMOP->op_pmreplroot                    opindex
 388 op_pmreplrootgv *(SV**)&cPMOP->op_pmreplroot            svindex
 389 op_pmreplstart  cPMOP->op_pmreplstart                   opindex
 390 op_pmnext       *(OP**)&cPMOP->op_pmnext                opindex
 391 pregcomp        PL_op                                   pvcontents      x
 392 op_pmflags      cPMOP->op_pmflags                       U16
 393 op_pmpermflags  cPMOP->op_pmpermflags                   U16
 394 op_sv           cSVOP->op_sv                            svindex
 395 op_gv           *(SV**)&cGVOP->op_gv                    svindex
 396 op_pv           cPVOP->op_pv                            pvcontents
 397 op_pv_tr        cPVOP->op_pv                            op_tr_array
 398 op_redoop       cLOOP->op_redoop                        opindex
 399 op_nextop       cLOOP->op_nextop                        opindex
 400 op_lastop       cLOOP->op_lastop                        opindex
 401 cop_label       cCOP->cop_label                         pvcontents
 402 cop_stash       *(SV**)&cCOP->cop_stash                 svindex
 403 cop_filegv      *(SV**)&cCOP->cop_filegv                svindex
 404 cop_seq         cCOP->cop_seq                           U32
 405 cop_arybase     cCOP->cop_arybase                       I32
 406 cop_line        cCOP->cop_line                          line_t
 407 cop_warnings    cCOP->cop_warnings                      svindex
 408 main_start      PL_main_start                           opindex
 409 main_root       PL_main_root                            opindex
 410 curpad          PL_curpad                               svindex         x