This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
doc tweak (from Michael G Schwern <schwern@pobox.com>)
[perl5.git] / bytecode.pl
index 2423e3c..00df48b 100644 (file)
@@ -1,17 +1,19 @@
+BEGIN {
+  push @INC, './lib';
+}
 use strict;
 my %alias_to = (
     U32 => [qw(PADOFFSET STRLEN)],
     I32 => [qw(SSize_t long)],
     U16 => [qw(OPCODE line_t short)],
     U8 => [qw(char)],
-    objindex => [qw(svindex opindex)]          
 );
 
-my @optype= qw(OP UNOP BINOP LOGOP CONDOP LISTOP PMOP SVOP GVOP PVOP LOOP COP);
+my @optype= qw(OP UNOP BINOP LOGOP LISTOP PMOP SVOP PADOP PVOP LOOP COP);
 
 # Nullsv *must* come first in the following so that the condition
 # ($$sv == 0) can continue to be used to test (sv == Nullsv).
-my @specialsv = qw(Nullsv &sv_undef &sv_yes &sv_no);
+my @specialsv = qw(Nullsv &PL_sv_undef &PL_sv_yes &PL_sv_no);
 
 my (%alias_from, $from, $tos);
 while (($from, $tos) = each %alias_to) {
@@ -20,7 +22,7 @@ while (($from, $tos) = each %alias_to) {
 
 my $c_header = <<'EOT';
 /*
- *      Copyright (c) 1996, 1997 Malcolm Beattie
+ *      Copyright (c) 1996-1999 Malcolm Beattie
  *
  *      You may distribute under the terms of either the GNU General Public
  *      License or the Artistic License, as specified in the README file.
@@ -34,20 +36,12 @@ EOT
 my $perl_header;
 ($perl_header = $c_header) =~ s{[/ ]?\*/?}{#}g;
 
-if (-f "byterun.c") {
-    rename("byterun.c", "byterun.c.old");
-}
-if (-f "byterun.h") {
-    rename("byterun.h", "byterun.h.old");
-}
-if (-f "B/Asmdata.pm") {
-    rename("B/Asmdata.pm", "B/Asmdata.pm.old");
-}
+unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.pm";
 
 #
 # Start with boilerplate for Asmdata.pm
 #
-open(ASMDATA_PM, ">B/Asmdata.pm") or die "Asmdata.pm: $!";
+open(ASMDATA_PM, ">ext/B/B/Asmdata.pm") or die "ext/B/B/Asmdata.pm: $!";
 print ASMDATA_PM $perl_header, <<'EOT';
 package B::Asmdata;
 use Exporter;
@@ -68,25 +62,73 @@ EOT
 #
 # Boilerplate for byterun.c
 #
-open(BYTERUN_C, ">byterun.c") or die "byterun.c: $!";
+open(BYTERUN_C, ">ext/ByteLoader/byterun.c") or die "ext/ByteLoader/byterun.c: $!";
 print BYTERUN_C $c_header, <<'EOT';
 
+#define PERL_NO_GET_CONTEXT
 #include "EXTERN.h"
 #include "perl.h"
-#include "bytecode.h"
+#define NO_XSLOCKS
+#include "XSUB.h"
+
+#ifdef PERL_OBJECT
+#undef CALL_FPTR
+#define CALL_FPTR(fptr) (pPerl->*fptr)
+#undef PL_ppaddr
+#define PL_ppaddr (*get_ppaddr())
+#endif
+
 #include "byterun.h"
+#include "bytecode.h"
+
+
+static int optype_size[] = {
+EOT
+my $i = 0;
+for ($i = 0; $i < @optype - 1; $i++) {
+    printf BYTERUN_C "    sizeof(%s),\n", $optype[$i], $i;
+}
+printf BYTERUN_C "    sizeof(%s)\n", $optype[$i], $i;
+print BYTERUN_C <<'EOT';
+};
 
-#ifdef INDIRECT_BGET_MACROS
-void byterun(bs)
-struct bytestream bs;
-#else
-void byterun(fp)
-FILE *fp;
-#endif /* INDIRECT_BGET_MACROS */
+static SV *specialsv_list[4];
+
+static int bytecode_iv_overflows = 0;
+static SV *bytecode_sv;
+static XPV bytecode_pv;
+static void **bytecode_obj_list;
+static I32 bytecode_obj_list_fill = -1;
+
+void *
+bset_obj_store(pTHXo_ void *obj, I32 ix)
+{
+    if (ix > bytecode_obj_list_fill) {
+       if (bytecode_obj_list_fill == -1)
+           New(666, bytecode_obj_list, ix + 1, void*);
+       else
+           Renew(bytecode_obj_list, ix + 1, void*);
+       bytecode_obj_list_fill = ix;
+    }
+    bytecode_obj_list[ix] = obj;
+    return obj;
+}
+
+void
+byterun(pTHXo_ struct bytestream bs)
 {
     dTHR;
     int insn;
-    while ((insn = FGETC()) != EOF) {
+
+EOT
+
+for (my $i = 0; $i < @specialsv; $i++) {
+    print BYTERUN_C "    specialsv_list[$i] = $specialsv[$i];\n";
+}
+
+print BYTERUN_C <<'EOT';
+
+    while ((insn = BGET_FGETC()) != EOF) {
        switch (insn) {
 EOT
 
@@ -120,7 +162,7 @@ while (<DATA>) {
     if ($flags =~ /x/) {
        print BYTERUN_C "\t\tBSET_$insn($lvalue$optarg);\n";
     } elsif ($flags =~ /s/) {
-       # Store instructions store to obj_list[arg]. "lvalue" field is rvalue.
+       # Store instructions store to bytecode_obj_list[arg]. "lvalue" field is rvalue.
        print BYTERUN_C "\t\tBSET_OBJ_STORE($lvalue$optarg);\n";
     }
     elsif ($optarg && $lvalue ne "none") {
@@ -144,7 +186,7 @@ EOT
 #
 print BYTERUN_C <<'EOT';
          default:
-           croak("Illegal bytecode instruction %d\n", insn);
+           Perl_croak(aTHX_ "Illegal bytecode instruction %d\n", insn);
            /* NOTREACHED */
        }
     }
@@ -154,32 +196,18 @@ EOT
 #
 # Write the instruction and optype enum constants into byterun.h
 #
-open(BYTERUN_H, ">byterun.h") or die "byterun.h: $!";
+open(BYTERUN_H, ">ext/ByteLoader/byterun.h") or die "ext/ByteLoader/byterun.h: $!";
 print BYTERUN_H $c_header, <<'EOT';
-#ifdef INDIRECT_BGET_MACROS
 struct bytestream {
     void *data;
-    int (*fgetc)(void *);
-    int (*fread)(char *, size_t, size_t, void*);
-    void (*freadpv)(U32, void*);
+    int (*pfgetc)(void *);
+    int (*pfread)(char *, size_t, size_t, void *);
+    void (*pfreadpv)(U32, void *, XPV *);
 };
-void freadpv _((U32, void *));
-void byterun _((struct bytestream));
-#else
-void byterun _((FILE *));
-#endif /* INDIRECT_BGET_MACROS */
-
-#ifndef PATCHLEVEL
-#include "patchlevel.h"
-#endif
-#if PATCHLEVEL < 4 || (PATCHLEVEL == 4 && SUBVERSION < 50)
-#define dTHR extern int errno
-#endif
 
 enum {
 EOT
 
-my $i = 0;
 my $add_enum_value = 0;
 my $max_insn;
 for ($i = 0; $i < @insn_name; $i++) {
@@ -204,30 +232,17 @@ for ($i = 0; $i < @optype - 1; $i++) {
     printf BYTERUN_H "    OPt_%s,\t\t/* %d */\n", $optype[$i], $i;
 }
 printf BYTERUN_H "    OPt_%s\t\t/* %d */\n};\n\n", $optype[$i], $i;
-print BYTERUN_H <<'EOT';
-EXT int optype_size[]
-#ifdef DOINIT
-= {
-EOT
-for ($i = 0; $i < @optype - 1; $i++) {
-    printf BYTERUN_H "    sizeof(%s),\n", $optype[$i], $i;
-}
-printf BYTERUN_H "    sizeof(%s)\n}\n", $optype[$i], $i;
-print BYTERUN_H <<'EOT';
-#endif /* DOINIT */
-;
 
-EOT
+print BYTERUN_H <<'EOT';
+extern void byterun(pTHXo_ struct bytestream bs);
 
-printf BYTERUN_H <<'EOT', scalar(@specialsv);
-EXT SV * specialsv_list[%d];
 #define INIT_SPECIALSV_LIST STMT_START { \
 EOT
 for ($i = 0; $i < @specialsv; $i++) {
-    print BYTERUN_H "specialsv_list[$i] = $specialsv[$i]; \\\n";
+    print BYTERUN_H "\tPL_specialsv_list[$i] = $specialsv[$i]; \\\n";
 }
 print BYTERUN_H <<'EOT';
-} STMT_END
+    } STMT_END
 EOT
 
 #
@@ -243,12 +258,32 @@ while (($insn_name, $insn_data) = each %insn_data) {
 @insn_name = map($_ || "unused", @insn_name);
 
 1;
+
+__END__
+
+=head1 NAME
+
+B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode
+
+=head1 SYNOPSIS
+
+       use Asmdata;
+
+=head1 DESCRIPTION
+
+See F<ext/B/B/Asmdata.pm>.
+
+=head1 AUTHOR
+
+Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
+
+=cut
 EOT
 
 __END__
 # First set instruction ord("#") to read comment to end-of-line (sneaky)
 %number 35
-comment                arg                     comment
+comment                arg                     comment_t
 # Then make ord("\n") into a no-op
 %number 10
 nop            none                    none
@@ -256,122 +291,121 @@ nop             none                    none
 # ret so that \0-terminated strings can be read properly as bytecode.
 %number 0
 #
-#opcode                lvalue                  argtype         flags   
+#opcode                lvalue                                  argtype         flags   
 #
-ret            none                    none            x
-ldsv           sv                      svindex
-ldop           op                      opindex
-stsv           sv                      U32             s
-stop           op                      U32             s
-ldspecsv       sv                      U8              x
-newsv          sv                      U8              x
-newop          op                      U8              x
-newopn         op                      U8              x
-newpv          none                    PV
-pv_cur         pv.xpv_cur              STRLEN
-pv_free                pv                      none            x
-sv_upgrade     sv                      char            x
-sv_refcnt      SvREFCNT(sv)            U32
-sv_refcnt_add  SvREFCNT(sv)            I32             x
-sv_flags       SvFLAGS(sv)             U32
-xrv            SvRV(sv)                svindex
-xpv            sv                      none            x
-xiv32          SvIVX(sv)               I32
-xiv64          SvIVX(sv)               IV64
-xnv            SvNVX(sv)               double
-xlv_targoff    LvTARGOFF(sv)           STRLEN
-xlv_targlen    LvTARGLEN(sv)           STRLEN
-xlv_targ       LvTARG(sv)              svindex
-xlv_type       LvTYPE(sv)              char
-xbm_useful     BmUSEFUL(sv)            I32
-xbm_previous   BmPREVIOUS(sv)          U16
-xbm_rare       BmRARE(sv)              U8
-xfm_lines      FmLINES(sv)             I32
-xio_lines      IoLINES(sv)             long
-xio_page       IoPAGE(sv)              long
-xio_page_len   IoPAGE_LEN(sv)          long
-xio_lines_left IoLINES_LEFT(sv)        long
-xio_top_name   IoTOP_NAME(sv)          pvcontents
-xio_top_gv     *(SV**)&IoTOP_GV(sv)    svindex
-xio_fmt_name   IoFMT_NAME(sv)          pvcontents
-xio_fmt_gv     *(SV**)&IoFMT_GV(sv)    svindex
-xio_bottom_name        IoBOTTOM_NAME(sv)       pvcontents
-xio_bottom_gv  *(SV**)&IoBOTTOM_GV(sv) svindex
-xio_subprocess IoSUBPROCESS(sv)        short
-xio_type       IoTYPE(sv)              char
-xio_flags      IoFLAGS(sv)             char
-xcv_stash      *(SV**)&CvSTASH(sv)     svindex
-xcv_start      CvSTART(sv)             opindex
-xcv_root       CvROOT(sv)              opindex
-xcv_gv         *(SV**)&CvGV(sv)        svindex
-xcv_filegv     *(SV**)&CvFILEGV(sv)    svindex
-xcv_depth      CvDEPTH(sv)             long
-xcv_padlist    *(SV**)&CvPADLIST(sv)   svindex
-xcv_outside    *(SV**)&CvOUTSIDE(sv)   svindex
-xcv_flags      CvFLAGS(sv)             U8
-av_extend      sv                      SSize_t         x
-av_push                sv                      svindex         x
-xav_fill       AvFILLp(sv)             SSize_t
-xav_max                AvMAX(sv)               SSize_t
-xav_flags      AvFLAGS(sv)             U8
-xhv_riter      HvRITER(sv)             I32
-xhv_name       HvNAME(sv)              pvcontents
-hv_store       sv                      svindex         x
-sv_magic       sv                      char            x
-mg_obj         SvMAGIC(sv)->mg_obj     svindex
-mg_private     SvMAGIC(sv)->mg_private U16
-mg_flags       SvMAGIC(sv)->mg_flags   U8
-mg_pv          SvMAGIC(sv)             pvcontents      x
-xmg_stash      *(SV**)&SvSTASH(sv)     svindex
-gv_fetchpv     sv                      strconst        x
-gv_stashpv     sv                      strconst        x
-gp_sv          GvSV(sv)                svindex
-gp_refcnt      GvREFCNT(sv)            U32
-gp_refcnt_add  GvREFCNT(sv)            I32             x
-gp_av          *(SV**)&GvAV(sv)        svindex
-gp_hv          *(SV**)&GvHV(sv)        svindex
-gp_cv          *(SV**)&GvCV(sv)        svindex
-gp_filegv      *(SV**)&GvFILEGV(sv)    svindex
-gp_io          *(SV**)&GvIOp(sv)       svindex
-gp_form                *(SV**)&GvFORM(sv)      svindex
-gp_cvgen       GvCVGEN(sv)             U32
-gp_line                GvLINE(sv)              line_t
-gp_share       sv                      svindex         x
-xgv_flags      GvFLAGS(sv)             U8
-op_next                op->op_next             opindex
-op_sibling     op->op_sibling          opindex
-op_ppaddr      op->op_ppaddr           strconst        x
-op_targ                op->op_targ             PADOFFSET
-op_type                op                      OPCODE          x
-op_seq         op->op_seq              U16
-op_flags       op->op_flags            U8
-op_private     op->op_private          U8
-op_first       cUNOP->op_first         opindex
-op_last                cBINOP->op_last         opindex
-op_other       cLOGOP->op_other        opindex
-op_true                cCONDOP->op_true        opindex
-op_false       cCONDOP->op_false       opindex
-op_children    cLISTOP->op_children    U32
-op_pmreplroot  cPMOP->op_pmreplroot    opindex
-op_pmreplrootgv        *(SV**)&cPMOP->op_pmreplroot    svindex
-op_pmreplstart cPMOP->op_pmreplstart   opindex
-op_pmnext      *(OP**)&cPMOP->op_pmnext        opindex
-pregcomp       op                      pvcontents      x
-op_pmflags     cPMOP->op_pmflags       U16
-op_pmpermflags cPMOP->op_pmpermflags   U16
-op_sv          cSVOP->op_sv            svindex
-op_gv          *(SV**)&cGVOP->op_gv    svindex
-op_pv          cPVOP->op_pv            pvcontents
-op_pv_tr       cPVOP->op_pv            op_tr_array
-op_redoop      cLOOP->op_redoop        opindex
-op_nextop      cLOOP->op_nextop        opindex
-op_lastop      cLOOP->op_lastop        opindex
-cop_label      cCOP->cop_label         pvcontents
-cop_stash      *(SV**)&cCOP->cop_stash         svindex
-cop_filegv     *(SV**)&cCOP->cop_filegv        svindex
-cop_seq                cCOP->cop_seq           U32
-cop_arybase    cCOP->cop_arybase       I32
-cop_line       cCOP->cop_line          line_t
-main_start     main_start              opindex
-main_root      main_root               opindex
-curpad         curpad                  svindex         x
+ret            none                                    none            x
+ldsv           bytecode_sv                             svindex
+ldop           PL_op                                   opindex
+stsv           bytecode_sv                             U32             s
+stop           PL_op                                   U32             s
+ldspecsv       bytecode_sv                             U8              x
+newsv          bytecode_sv                             U8              x
+newop          PL_op                                   U8              x
+newopn         PL_op                                   U8              x
+newpv          none                                    PV
+pv_cur         bytecode_pv.xpv_cur                     STRLEN
+pv_free                bytecode_pv                             none            x
+sv_upgrade     bytecode_sv                             char            x
+sv_refcnt      SvREFCNT(bytecode_sv)                   U32
+sv_refcnt_add  SvREFCNT(bytecode_sv)                   I32             x
+sv_flags       SvFLAGS(bytecode_sv)                    U32
+xrv            SvRV(bytecode_sv)                       svindex
+xpv            bytecode_sv                             none            x
+xiv32          SvIVX(bytecode_sv)                      I32
+xiv64          SvIVX(bytecode_sv)                      IV64
+xnv            SvNVX(bytecode_sv)                      NV
+xlv_targoff    LvTARGOFF(bytecode_sv)                  STRLEN
+xlv_targlen    LvTARGLEN(bytecode_sv)                  STRLEN
+xlv_targ       LvTARG(bytecode_sv)                     svindex
+xlv_type       LvTYPE(bytecode_sv)                     char
+xbm_useful     BmUSEFUL(bytecode_sv)                   I32
+xbm_previous   BmPREVIOUS(bytecode_sv)                 U16
+xbm_rare       BmRARE(bytecode_sv)                     U8
+xfm_lines      FmLINES(bytecode_sv)                    I32
+xio_lines      IoLINES(bytecode_sv)                    long
+xio_page       IoPAGE(bytecode_sv)                     long
+xio_page_len   IoPAGE_LEN(bytecode_sv)                 long
+xio_lines_left IoLINES_LEFT(bytecode_sv)               long
+xio_top_name   IoTOP_NAME(bytecode_sv)                 pvcontents
+xio_top_gv     *(SV**)&IoTOP_GV(bytecode_sv)           svindex
+xio_fmt_name   IoFMT_NAME(bytecode_sv)                 pvcontents
+xio_fmt_gv     *(SV**)&IoFMT_GV(bytecode_sv)           svindex
+xio_bottom_name        IoBOTTOM_NAME(bytecode_sv)              pvcontents
+xio_bottom_gv  *(SV**)&IoBOTTOM_GV(bytecode_sv)        svindex
+xio_subprocess IoSUBPROCESS(bytecode_sv)               short
+xio_type       IoTYPE(bytecode_sv)                     char
+xio_flags      IoFLAGS(bytecode_sv)                    char
+xcv_stash      *(SV**)&CvSTASH(bytecode_sv)            svindex
+xcv_start      CvSTART(bytecode_sv)                    opindex
+xcv_root       CvROOT(bytecode_sv)                     opindex
+xcv_gv         *(SV**)&CvGV(bytecode_sv)               svindex
+xcv_file       CvFILE(bytecode_sv)                     pvcontents
+xcv_depth      CvDEPTH(bytecode_sv)                    long
+xcv_padlist    *(SV**)&CvPADLIST(bytecode_sv)          svindex
+xcv_outside    *(SV**)&CvOUTSIDE(bytecode_sv)          svindex
+xcv_flags      CvFLAGS(bytecode_sv)                    U8
+av_extend      bytecode_sv                             SSize_t         x
+av_push                bytecode_sv                             svindex         x
+xav_fill       AvFILLp(bytecode_sv)                    SSize_t
+xav_max                AvMAX(bytecode_sv)                      SSize_t
+xav_flags      AvFLAGS(bytecode_sv)                    U8
+xhv_riter      HvRITER(bytecode_sv)                    I32
+xhv_name       HvNAME(bytecode_sv)                     pvcontents
+hv_store       bytecode_sv                             svindex         x
+sv_magic       bytecode_sv                             char            x
+mg_obj         SvMAGIC(bytecode_sv)->mg_obj            svindex
+mg_private     SvMAGIC(bytecode_sv)->mg_private        U16
+mg_flags       SvMAGIC(bytecode_sv)->mg_flags          U8
+mg_pv          SvMAGIC(bytecode_sv)                    pvcontents      x
+xmg_stash      *(SV**)&SvSTASH(bytecode_sv)            svindex
+gv_fetchpv     bytecode_sv                             strconst        x
+gv_stashpv     bytecode_sv                             strconst        x
+gp_sv          GvSV(bytecode_sv)                       svindex
+gp_refcnt      GvREFCNT(bytecode_sv)                   U32
+gp_refcnt_add  GvREFCNT(bytecode_sv)                   I32             x
+gp_av          *(SV**)&GvAV(bytecode_sv)               svindex
+gp_hv          *(SV**)&GvHV(bytecode_sv)               svindex
+gp_cv          *(SV**)&GvCV(bytecode_sv)               svindex
+gp_file                GvFILE(bytecode_sv)                     pvcontents
+gp_io          *(SV**)&GvIOp(bytecode_sv)              svindex
+gp_form                *(SV**)&GvFORM(bytecode_sv)             svindex
+gp_cvgen       GvCVGEN(bytecode_sv)                    U32
+gp_line                GvLINE(bytecode_sv)                     line_t
+gp_share       bytecode_sv                             svindex         x
+xgv_flags      GvFLAGS(bytecode_sv)                    U8
+op_next                PL_op->op_next                          opindex
+op_sibling     PL_op->op_sibling                       opindex
+op_ppaddr      PL_op->op_ppaddr                        strconst        x
+op_targ                PL_op->op_targ                          PADOFFSET
+op_type                PL_op                                   OPCODE          x
+op_seq         PL_op->op_seq                           U16
+op_flags       PL_op->op_flags                         U8
+op_private     PL_op->op_private                       U8
+op_first       cUNOP->op_first                         opindex
+op_last                cBINOP->op_last                         opindex
+op_other       cLOGOP->op_other                        opindex
+op_children    cLISTOP->op_children                    U32
+op_pmreplroot  cPMOP->op_pmreplroot                    opindex
+op_pmreplrootgv        *(SV**)&cPMOP->op_pmreplroot            svindex
+op_pmreplstart cPMOP->op_pmreplstart                   opindex
+op_pmnext      *(OP**)&cPMOP->op_pmnext                opindex
+pregcomp       PL_op                                   pvcontents      x
+op_pmflags     cPMOP->op_pmflags                       U16
+op_pmpermflags cPMOP->op_pmpermflags                   U16
+op_sv          cSVOP->op_sv                            svindex
+op_padix       cPADOP->op_padix                        PADOFFSET
+op_pv          cPVOP->op_pv                            pvcontents
+op_pv_tr       cPVOP->op_pv                            op_tr_array
+op_redoop      cLOOP->op_redoop                        opindex
+op_nextop      cLOOP->op_nextop                        opindex
+op_lastop      cLOOP->op_lastop                        opindex
+cop_label      cCOP->cop_label                         pvcontents
+cop_stashpv    cCOP                                    pvcontents      x
+cop_file       cCOP                                    pvcontents      x
+cop_seq                cCOP->cop_seq                           U32
+cop_arybase    cCOP->cop_arybase                       I32
+cop_line       cCOP                                    line_t          x
+cop_warnings   cCOP->cop_warnings                      svindex
+main_start     PL_main_start                           opindex
+main_root      PL_main_root                            opindex
+curpad         PL_curpad                               svindex         x