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