This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
The change #20809 opened up a code path that might leave s unset.
[perl5.git] / bytecode.pl
index 9321604..bfe7502 100644 (file)
@@ -1,12 +1,13 @@
 BEGIN {
   push @INC, './lib';
+  require 'regen_lib.pl';
 }
 use strict;
 my %alias_to = (
-    U32 => [qw(PADOFFSET STRLEN)],
-    I32 => [qw(SSize_t long)],
-    U16 => [qw(OPCODE line_t short)],
-    U8 => [qw(char)],
+    U32 => [qw(line_t)],
+    PADOFFSET => [qw(STRLEN SSize_t)],
+    U16 => [qw(OPCODE short)],
+    U8  => [qw(char)],
 );
 
 my @optype= qw(OP UNOP BINOP LOGOP LISTOP PMOP SVOP PADOP PVOP LOOP COP);
@@ -36,7 +37,7 @@ EOT
 my $perl_header;
 ($perl_header = $c_header) =~ s{[/ ]?\*/?}{#}g;
 
-unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.pm";
+safer_unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.pm";
 
 #
 # Start with boilerplate for Asmdata.pm
@@ -44,6 +45,9 @@ unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.
 open(ASMDATA_PM, ">ext/B/B/Asmdata.pm") or die "ext/B/B/Asmdata.pm: $!";
 print ASMDATA_PM $perl_header, <<'EOT';
 package B::Asmdata;
+
+our $VERSION = '1.01';
+
 use Exporter;
 @ISA = qw(Exporter);
 @EXPORT_OK = qw(%insn_data @insn_name @optype @specialsv_name);
@@ -71,13 +75,6 @@ print BYTERUN_C $c_header, <<'EOT';
 #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"
 
@@ -93,7 +90,7 @@ print BYTERUN_C <<'EOT';
 };
 
 void *
-bset_obj_store(pTHXo_ struct byteloader_state *bstate, void *obj, I32 ix)
+bset_obj_store(pTHX_ struct byteloader_state *bstate, void *obj, I32 ix)
 {
     if (ix > bstate->bs_obj_list_fill) {
        Renew(bstate->bs_obj_list, ix + 32, void*);
@@ -103,10 +100,9 @@ bset_obj_store(pTHXo_ struct byteloader_state *bstate, void *obj, I32 ix)
     return obj;
 }
 
-void
-byterun(pTHXo_ register struct byteloader_state *bstate)
+int
+byterun(pTHX_ register struct byteloader_state *bstate)
 {
-    dTHR;
     register int insn;
     U32 ix;
     SV *specialsv_list[6];
@@ -114,10 +110,12 @@ byterun(pTHXo_ register struct byteloader_state *bstate)
     BYTECODE_HEADER_CHECK;     /* croak if incorrect platform */
     New(666, bstate->bs_obj_list, 32, void*); /* set op objlist */
     bstate->bs_obj_list_fill = 31;
+    bstate->bs_obj_list[0] = NULL; /* first is always Null */
+    bstate->bs_ix = 1;
 
 EOT
 
-for (my $i = 0; $i < @specialsv; $i++) {
+for my $i ( 0 .. $#specialsv ) {
     print BYTERUN_C "    specialsv_list[$i] = $specialsv[$i];\n";
 }
 
@@ -131,8 +129,11 @@ EOT
 my (@insn_name, $insn_num, $insn, $lvalue, $argtype, $flags, $fundtype);
 
 while (<DATA>) {
+    if (/^\s*#/) {
+       print BYTERUN_C if /^\s*#\s*(?:if|endif|el)/;
+       next;
+    }
     chop;
-    s/#.*//;                   # remove comments
     next unless length;
     if (/^%number\s+(.*)/) {
        $insn_num = $1;
@@ -142,6 +143,10 @@ while (<DATA>) {
        next;
     }
     ($insn, $lvalue, $argtype, $flags) = split;
+    my $rvalcast = '';
+    if ($argtype =~ m:(.+)/(.+):) {
+       ($rvalcast, $argtype) = ("($1)", $2);
+    }
     $insn_name[$insn_num] = $insn;
     $fundtype = $alias_from{$argtype} || $argtype;
 
@@ -161,7 +166,7 @@ while (<DATA>) {
        print BYTERUN_C "\t\tBSET_OBJ_STORE($lvalue$optarg);\n";
     }
     elsif ($optarg && $lvalue ne "none") {
-       print BYTERUN_C "\t\t$lvalue = arg;\n";
+       print BYTERUN_C "\t\t$lvalue = ${rvalcast}arg;\n";
     }
     print BYTERUN_C "\t\tbreak;\n\t    }\n";
 
@@ -185,6 +190,7 @@ print BYTERUN_C <<'EOT';
            /* NOTREACHED */
        }
     }
+    return 0;
 }
 EOT
 
@@ -204,20 +210,21 @@ struct byteloader_state {
     SV                         *bs_sv;
     void                       **bs_obj_list;
     int                                bs_obj_list_fill;
+    int                                bs_ix;
     XPV                                bs_pv;
     int                                bs_iv_overflows;
 };
 
 int bl_getc(struct byteloader_fdata *);
 int bl_read(struct byteloader_fdata *, char *, size_t, size_t);
-extern void byterun(pTHXo_ struct byteloader_state *);
+extern int byterun(pTHX_ struct byteloader_state *);
 
 enum {
 EOT
 
 my $add_enum_value = 0;
 my $max_insn;
-for ($i = 0; $i < @insn_name; $i++) {
+for $i ( 0 .. $#insn_name ) {
     $insn = uc($insn_name[$i]);
     if (defined($insn)) {
        $max_insn = $i;
@@ -262,11 +269,53 @@ B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode
 
 =head1 SYNOPSIS
 
-       use Asmdata;
+       use B::Asmdata qw(%insn_data @insn_name @optype @specialsv_name);
 
 =head1 DESCRIPTION
 
-See F<ext/B/B/Asmdata.pm>.
+Provides information about Perl ops in order to generate bytecode via
+a bunch of exported variables.  Its mostly used by B::Assembler and
+B::Disassembler.
+
+=over 4
+
+=item %insn_data
+
+  my($bytecode_num, $put_sub, $get_meth) = @$insn_data{$op_name};
+
+For a given $op_name (for example, 'cop_label', 'sv_flags', etc...) 
+you get an array ref containing the bytecode number of the op, a
+reference to the subroutine used to 'PUT', and the name of the method
+used to 'GET'.
+
+=for _private
+Add more detail about what $put_sub and $get_meth are and how to use them.
+
+=item @insn_name
+
+  my $op_name = $insn_name[$bytecode_num];
+
+A simple mapping of the bytecode number to the name of the op.
+Suitable for using with %insn_data like so:
+
+  my $op_info = $insn_data{$insn_name[$bytecode_num]};
+
+=item @optype
+
+  my $op_type = $optype[$op_type_num];
+
+A simple mapping of the op type number to its type (like 'COP' or 'BINOP').
+
+=item @specialsv_name
+
+  my $sv_name = $specialsv_name[$sv_index];
+
+Certain SV types are considered 'special'.  They're represented by
+B::SPECIAL and are refered to by a number from the specialsv_list.
+This array maps that number back to the name of the SV (like 'Nullsv'
+or '&PL_sv_undef').
+
+=back
 
 =head1 AUTHOR
 
@@ -275,6 +324,11 @@ Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
 =cut
 EOT
 
+
+close ASMDATA_PM or die "Error closing ASMDATA_PM: $!";
+close BYTERUN_H or die "Error closing BYTERUN_H: $!";
+close BYTERUN_C or die "Error closing BYTERUN_C: $!";
+
 __END__
 # First set instruction ord("#") to read comment to end-of-line (sneaky)
 %number 35
@@ -282,10 +336,13 @@ comment           arg                     comment_t
 # Then make ord("\n") into a no-op
 %number 10
 nop            none                    none
+
 # Now for the rest of the ordinary ones, beginning with \0 which is
 # ret so that \0-terminated strings can be read properly as bytecode.
 %number 0
 #
+# The argtype is either a single type or "rightvaluecast/argtype".
+#
 #opcode                lvalue                                  argtype         flags   
 #
 ret            none                                    none            x
@@ -295,20 +352,24 @@ stsv              bstate->bs_sv                           U32             s
 stop           PL_op                                   U32             s
 stpv           bstate->bs_pv.xpv_pv                    U32             x
 ldspecsv       bstate->bs_sv                           U8              x
+ldspecsvx      bstate->bs_sv                           U8              x
 newsv          bstate->bs_sv                           U8              x
+newsvx         bstate->bs_sv                           U32             x
 newop          PL_op                                   U8              x
+newopx         PL_op                                   U16             x
 newopn         PL_op                                   U8              x
 newpv          none                                    PV
 pv_cur         bstate->bs_pv.xpv_cur                   STRLEN
 pv_free                bstate->bs_pv                           none            x
-sv_upgrade     bstate->bs_sv                           char            x
+sv_upgrade     bstate->bs_sv                           U8              x
 sv_refcnt      SvREFCNT(bstate->bs_sv)                 U32
 sv_refcnt_add  SvREFCNT(bstate->bs_sv)                 I32             x
 sv_flags       SvFLAGS(bstate->bs_sv)                  U32
 xrv            SvRV(bstate->bs_sv)                     svindex
 xpv            bstate->bs_sv                           none            x
-xiv32          SvIVX(bstate->bs_sv)                    I32
-xiv64          SvIVX(bstate->bs_sv)                    IV64
+xpv_cur                SvCUR(bstate->bs_sv)                    STRLEN
+xpv_len                SvLEN(bstate->bs_sv)                    STRLEN
+xiv            SvIVX(bstate->bs_sv)                    IV
 xnv            SvNVX(bstate->bs_sv)                    NV
 xlv_targoff    LvTARGOFF(bstate->bs_sv)                STRLEN
 xlv_targlen    LvTARGLEN(bstate->bs_sv)                STRLEN
@@ -317,20 +378,21 @@ xlv_type  LvTYPE(bstate->bs_sv)                   char
 xbm_useful     BmUSEFUL(bstate->bs_sv)                 I32
 xbm_previous   BmPREVIOUS(bstate->bs_sv)               U16
 xbm_rare       BmRARE(bstate->bs_sv)                   U8
-xfm_lines      FmLINES(bstate->bs_sv)                  I32
-xio_lines      IoLINES(bstate->bs_sv)                  long
-xio_page       IoPAGE(bstate->bs_sv)                   long
-xio_page_len   IoPAGE_LEN(bstate->bs_sv)               long
-xio_lines_left IoLINES_LEFT(bstate->bs_sv)             long
-xio_top_name   IoTOP_NAME(bstate->bs_sv)               pvcontents
+xfm_lines      FmLINES(bstate->bs_sv)                  IV
+xio_lines      IoLINES(bstate->bs_sv)                  IV
+xio_page       IoPAGE(bstate->bs_sv)                   IV
+xio_page_len   IoPAGE_LEN(bstate->bs_sv)               IV
+xio_lines_left IoLINES_LEFT(bstate->bs_sv)             IV
+xio_top_name   IoTOP_NAME(bstate->bs_sv)               pvindex
 xio_top_gv     *(SV**)&IoTOP_GV(bstate->bs_sv)         svindex
-xio_fmt_name   IoFMT_NAME(bstate->bs_sv)               pvcontents
+xio_fmt_name   IoFMT_NAME(bstate->bs_sv)               pvindex
 xio_fmt_gv     *(SV**)&IoFMT_GV(bstate->bs_sv)         svindex
-xio_bottom_name        IoBOTTOM_NAME(bstate->bs_sv)            pvcontents
+xio_bottom_name        IoBOTTOM_NAME(bstate->bs_sv)            pvindex
 xio_bottom_gv  *(SV**)&IoBOTTOM_GV(bstate->bs_sv)      svindex
 xio_subprocess IoSUBPROCESS(bstate->bs_sv)             short
 xio_type       IoTYPE(bstate->bs_sv)                   char
 xio_flags      IoFLAGS(bstate->bs_sv)                  char
+xcv_xsubany    *(SV**)&CvXSUBANY(bstate->bs_sv).any_ptr        svindex
 xcv_stash      *(SV**)&CvSTASH(bstate->bs_sv)          svindex
 xcv_start      CvSTART(bstate->bs_sv)                  opindex
 xcv_root       CvROOT(bstate->bs_sv)                   opindex
@@ -339,23 +401,29 @@ xcv_file  CvFILE(bstate->bs_sv)                   pvindex
 xcv_depth      CvDEPTH(bstate->bs_sv)                  long
 xcv_padlist    *(SV**)&CvPADLIST(bstate->bs_sv)        svindex
 xcv_outside    *(SV**)&CvOUTSIDE(bstate->bs_sv)        svindex
+xcv_outside_seq        CvOUTSIDE_SEQ(bstate->bs_sv)            U32
 xcv_flags      CvFLAGS(bstate->bs_sv)                  U16
 av_extend      bstate->bs_sv                           SSize_t         x
+av_pushx       bstate->bs_sv                           svindex         x
 av_push                bstate->bs_sv                           svindex         x
 xav_fill       AvFILLp(bstate->bs_sv)                  SSize_t
 xav_max                AvMAX(bstate->bs_sv)                    SSize_t
 xav_flags      AvFLAGS(bstate->bs_sv)                  U8
 xhv_riter      HvRITER(bstate->bs_sv)                  I32
-xhv_name       HvNAME(bstate->bs_sv)                   pvcontents
+xhv_name       HvNAME(bstate->bs_sv)                   pvindex
+xhv_pmroot     *(OP**)&HvPMROOT(bstate->bs_sv)         opindex
 hv_store       bstate->bs_sv                           svindex         x
 sv_magic       bstate->bs_sv                           char            x
 mg_obj         SvMAGIC(bstate->bs_sv)->mg_obj          svindex
 mg_private     SvMAGIC(bstate->bs_sv)->mg_private      U16
 mg_flags       SvMAGIC(bstate->bs_sv)->mg_flags        U8
-mg_pv          SvMAGIC(bstate->bs_sv)                  pvcontents      x
+mg_name                SvMAGIC(bstate->bs_sv)                  pvcontents      x
+mg_namex       SvMAGIC(bstate->bs_sv)                  svindex         x
 xmg_stash      *(SV**)&SvSTASH(bstate->bs_sv)          svindex
 gv_fetchpv     bstate->bs_sv                           strconst        x
+gv_fetchpvx    bstate->bs_sv                           strconst        x
 gv_stashpv     bstate->bs_sv                           strconst        x
+gv_stashpvx    bstate->bs_sv                           strconst        x
 gp_sv          GvSV(bstate->bs_sv)                     svindex
 gp_refcnt      GvREFCNT(bstate->bs_sv)                 U32
 gp_refcnt_add  GvREFCNT(bstate->bs_sv)                 I32             x
@@ -380,14 +448,20 @@ 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
+#ifdef USE_ITHREADS
+op_pmstashpv   cPMOP->op_pmstashpv                     pvindex
+op_pmreplrootpo        cPMOP->op_pmreplroot                    OP*/PADOFFSET
+#else
+op_pmstash     *(SV**)&cPMOP->op_pmstash               svindex
+op_pmreplrootgv        *(SV**)&cPMOP->op_pmreplroot            svindex
+#endif
 pregcomp       PL_op                                   pvcontents      x
 op_pmflags     cPMOP->op_pmflags                       U16
 op_pmpermflags cPMOP->op_pmpermflags                   U16
+op_pmdynflags  cPMOP->op_pmdynflags                    U8
 op_sv          cSVOP->op_sv                            svindex
 op_padix       cPADOP->op_padix                        PADOFFSET
 op_pv          cPVOP->op_pv                            pvcontents
@@ -396,15 +470,36 @@ op_redoop cLOOP->op_redoop                        opindex
 op_nextop      cLOOP->op_nextop                        opindex
 op_lastop      cLOOP->op_lastop                        opindex
 cop_label      cCOP->cop_label                         pvindex
+#ifdef USE_ITHREADS
 cop_stashpv    cCOP                                    pvindex         x
 cop_file       cCOP                                    pvindex         x
+#else
+cop_stash      cCOP                                    svindex         x
+cop_filegv     cCOP                                    svindex         x
+#endif
 cop_seq                cCOP->cop_seq                           U32
 cop_arybase    cCOP->cop_arybase                       I32
-cop_line       cCOP                                    line_t          x
+cop_line       cCOP->cop_line                          line_t
+cop_io         cCOP->cop_io                            svindex
 cop_warnings   cCOP->cop_warnings                      svindex
 main_start     PL_main_start                           opindex
 main_root      PL_main_root                            opindex
+main_cv                *(SV**)&PL_main_cv                      svindex
 curpad         PL_curpad                               svindex         x
 push_begin     PL_beginav                              svindex         x
 push_init      PL_initav                               svindex         x
 push_end       PL_endav                                svindex         x
+curstash       *(SV**)&PL_curstash                     svindex
+defstash       *(SV**)&PL_defstash                     svindex
+data           none                                    U8              x
+incav          *(SV**)&GvAV(PL_incgv)                  svindex
+load_glob      none                                    svindex         x
+#ifdef USE_ITHREADS
+regex_padav    *(SV**)&PL_regex_padav                  svindex
+#endif
+dowarn         PL_dowarn                               U8
+comppad_name   *(SV**)&PL_comppad_name                 svindex
+xgv_stash      *(SV**)&GvSTASH(bstate->bs_sv)          svindex
+signal         bstate->bs_sv                           strconst        x
+# to be removed
+formfeed       PL_formfeed                             svindex