bytecode.pl

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