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