This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
PVFMs don't need to access the IVX any more. (as of change 32836, which
[perl5.git] / opcode.pl
index d2602a2..7f88036 100755 (executable)
--- a/opcode.pl
+++ b/opcode.pl
@@ -8,16 +8,14 @@ BEGIN {
 
 my $opcode_new = 'opcode.h-new';
 my $opname_new = 'opnames.h-new';
-open(OC, ">$opcode_new") || die "Can't create $opcode_new: $!\n";
-binmode OC;
-open(ON, ">$opname_new") || die "Can't create $opname_new: $!\n";
-binmode ON;
-select OC;
+my $oc = safer_open($opcode_new);
+my $on = safer_open($opname_new);
+select $oc;
 
 # Read data.
 
 my %seen;
-my (@ops, %desc, %check, %ckname, %flags, %args);
+my (@ops, %desc, %check, %ckname, %flags, %args, %opnum);
 
 while (<DATA>) {
     chop;
@@ -32,6 +30,7 @@ while (<DATA>) {
     $seen{$key} = qq[opcode "$key"];
 
     push(@ops, $key);
+    $opnum{$key} = $#ops;
     $desc{$key} = $desc;
     $check{$key} = $check;
     $ckname{$check}++;
@@ -46,7 +45,7 @@ my %alias;
 # Format is "this function" => "does these op names"
 my @raw_alias = (
                 Perl_do_kv => [qw( keys values )],
-                Perl_unimplemented_op => [qw(padany mapstart)],
+                Perl_unimplemented_op => [qw(padany mapstart custom)],
                 # All the ops with a body of { return NORMAL; }
                 Perl_pp_null => [qw(scalar regcmaybe lineseq scope)],
 
@@ -91,6 +90,7 @@ my @raw_alias = (
                 Perl_pp_sin => [qw(cos exp log sqrt)],
                 Perl_pp_bit_or => ['bit_xor'],
                 Perl_pp_rv2av => ['rv2hv'],
+                Perl_pp_akeys => ['avalues'],
                );
 
 while (my ($func, $names) = splice @raw_alias, 0, 2) {
@@ -126,7 +126,7 @@ PERL_PPDEF(Perl_unimplemented_op)
 
 END
 
-print ON <<"END";
+print $on <<"END";
 /* -*- buffer-read-only: t -*-
  *
  *    opnames.h
@@ -148,13 +148,14 @@ END
 
 my $i = 0;
 for (@ops) {
-    print ON "\t", &tab(3,"OP_\U$_,"), "/* ", $i++, " */\n";
+    # print $on "\t", &tab(3,"OP_\U$_,"), "/* ", $i++, " */\n";
+      print $on "\t", &tab(3,"OP_\U$_"), " = ", $i++, ",\n";
 }
-print ON "\t", &tab(3,"OP_max"), "\n";
-print ON "} opcode;\n";
-print ON "\n#define MAXO ", scalar @ops, "\n";
-print ON "#define OP_phoney_INPUT_ONLY -1\n";
-print ON "#define OP_phoney_OUTPUT_ONLY -2\n\n";
+print $on "\t", &tab(3,"OP_max"), "\n";
+print $on "} opcode;\n";
+print $on "\n#define MAXO ", scalar @ops, "\n";
+print $on "#define OP_phoney_INPUT_ONLY -1\n";
+print $on "#define OP_phoney_OUTPUT_ONLY -2\n\n";
 
 # Emit op names and descriptions.
 
@@ -240,7 +241,6 @@ EXT Perl_ppaddr_t PL_ppaddr[] /* or perlvars.h */
 END
 
 for (@ops) {
-    $_ eq "custom" and next;
     if (my $name = $alias{$_}) {
        print "\tMEMBER_TO_FPTR($name),\t/* Perl_pp_$_ */\n";
     }
@@ -290,6 +290,8 @@ END
 
 # Emit allowed argument types.
 
+my $ARGBITS = 32;
+
 print <<END;
 #ifndef PERL_GLOBAL_STRUCT_INIT
 
@@ -326,39 +328,57 @@ my %opclass = (
     '}',  13,          # loopexop
 );
 
+my %opflags = (
+    'm' =>   1,                # needs stack mark
+    'f' =>   2,                # fold constants
+    's' =>   4,                # always produces scalar
+    't' =>   8,                # needs target scalar
+    'T' =>   8 | 256,  # ... which may be lexical
+    'i' =>  16,                # always produces integer
+    'I' =>  32,                # has corresponding int op
+    'd' =>  64,                # danger, unknown side effects
+    'u' => 128,                # defaults to $_
+);
+
 my %OP_IS_SOCKET;
 my %OP_IS_FILETEST;
+my %OP_IS_FT_ACCESS;
+my $OCSHIFT = 9;
+my $OASHIFT = 13;
 
-for (@ops) {
+for my $op (@ops) {
     my $argsum = 0;
-    my $flags = $flags{$_};
-    $argsum |= 1 if $flags =~ /m/;             # needs stack mark
-    $argsum |= 2 if $flags =~ /f/;             # fold constants
-    $argsum |= 4 if $flags =~ /s/;             # always produces scalar
-    $argsum |= 8 if $flags =~ /t/;             # needs target scalar
-    $argsum |= (8|256) if $flags =~ /T/;       # ... which may be lexical
-    $argsum |= 16 if $flags =~ /i/;            # always produces integer
-    $argsum |= 32 if $flags =~ /I/;            # has corresponding int op
-    $argsum |= 64 if $flags =~ /d/;            # danger, unknown side effects
-    $argsum |= 128 if $flags =~ /u/;           # defaults to $_
-    $flags =~ /([\W\d_])/ or die qq[Opcode "$_" has no class indicator];
-    $argsum |= $opclass{$1} << 9;
-    my $mul = 0x2000;                          # 2 ^ OASHIFT
-    for my $arg (split(' ',$args{$_})) {
+    my $flags = $flags{$op};
+    for my $flag (keys %opflags) {
+       if ($flags =~ s/$flag//) {
+           die "Flag collision for '$op' ($flags{$op}, $flag)\n"
+               if $argsum & $opflags{$flag};
+           $argsum |= $opflags{$flag};
+       }
+    }
+    die qq[Opcode '$op' has no class indicator ($flags{$op} => $flags)\n]
+       unless exists $opclass{$flags};
+    $argsum |= $opclass{$flags} << $OCSHIFT;
+    my $argshift = $OASHIFT;
+    for my $arg (split(' ',$args{$op})) {
        if ($arg =~ /^F/) {
-           $OP_IS_SOCKET{$_}   = 1 if $arg =~ s/s//;
-           $OP_IS_FILETEST{$_} = 1 if $arg =~ s/-//;
+           # record opnums of these opnames
+           $OP_IS_SOCKET{$op}   = $opnum{$op} if $arg =~ s/s//;
+           $OP_IS_FILETEST{$op} = $opnum{$op} if $arg =~ s/-//;
+           $OP_IS_FT_ACCESS{$op} = $opnum{$op} if $arg =~ s/\+//;
         }
        my $argnum = ($arg =~ s/\?//) ? 8 : 0;
-        die "op = $_, arg = $arg\n" unless length($arg) == 1;
+        die "op = $op, arg = $arg\n"
+           unless exists $argnum{$arg};
        $argnum += $argnum{$arg};
-       warn "# Conflicting bit 32 for '$_'.\n"
-           if $argnum & 8 and $mul == 0x10000000;
-       $argsum += $argnum * $mul;
-       $mul <<= 4;
+       die "Argument overflow for '$op'\n"
+           if $argshift >= $ARGBITS ||
+              $argnum > ((1 << ($ARGBITS - $argshift)) - 1);
+       $argsum += $argnum << $argshift;
+       $argshift += 4;
     }
     $argsum = sprintf("0x%08x", $argsum);
-    print "\t", &tab(3, "$argsum,"), "/* $_ */\n";
+    print "\t", &tab(3, "$argsum,"), "/* $op */\n";
 }
 
 print <<END;
@@ -371,41 +391,66 @@ END_EXTERN_C
 
 END
 
-if (keys %OP_IS_SOCKET) {
-    print ON "\n#define OP_IS_SOCKET(op)       \\\n\t(";
-    print ON join(" || \\\n\t ",
-               map { "(op) == OP_" . uc() } sort keys %OP_IS_SOCKET);
-    print ON ")\n\n";
-}
-
-if (keys %OP_IS_FILETEST) {
-    print ON "\n#define OP_IS_FILETEST(op)     \\\n\t(";
-    print ON join(" || \\\n\t ",
-               map { "(op) == OP_" . uc() } sort keys %OP_IS_FILETEST);
-    print ON ")\n\n";
+# Emit OP_IS_* macros
+
+print $on <<EO_OP_IS_COMMENT;
+
+/* the OP_IS_(SOCKET|FILETEST) macros are optimized to a simple range
+    check because all the member OPs are contiguous in opcode.pl
+    <DATA> table.  opcode.pl verifies the range contiguity.  */
+
+EO_OP_IS_COMMENT
+
+gen_op_is_macro( \%OP_IS_SOCKET, 'OP_IS_SOCKET');
+gen_op_is_macro( \%OP_IS_FILETEST, 'OP_IS_FILETEST');
+gen_op_is_macro( \%OP_IS_FT_ACCESS, 'OP_IS_FILETEST_ACCESS');
+
+sub gen_op_is_macro {
+    my ($op_is, $macname) = @_;
+    if (keys %$op_is) {
+       
+       # get opnames whose numbers are lowest and highest
+       my ($first, @rest) = sort {
+           $op_is->{$a} <=> $op_is->{$b}
+       } keys %$op_is;
+       
+       my $last = pop @rest;   # @rest slurped, get its last
+       die "Invalid range of ops: $first .. $last\n" unless $last;
+
+       print $on "#define $macname(op) \\\n\t(";
+
+       # verify that op-ct matches 1st..last range (and fencepost)
+       # (we know there are no dups)
+       if ( $op_is->{$last} - $op_is->{$first} == scalar @rest + 1) {
+           
+           # contiguous ops -> optimized version
+           print $on "(op) >= OP_" . uc($first) . " && (op) <= OP_" . uc($last);
+           print $on ")\n\n";
+       }
+       else {
+           print $on join(" || \\\n\t ",
+                         map { "(op) == OP_" . uc() } sort keys %$op_is);
+           print $on ")\n\n";
+       }
+    }
 }
 
-print OC "/* ex: set ro: */\n";
-print ON "/* ex: set ro: */\n";
+print $oc "/* ex: set ro: */\n";
+print $on "/* ex: set ro: */\n";
 
-close OC or die "Error closing opcode.h: $!";
-close ON or die "Error closing opnames.h: $!";
+safer_close($oc);
+safer_close($on);
 
-foreach ('opcode.h', 'opnames.h') {
-    safer_rename_silent $_, "$_-old";
-}
-safer_rename $opcode_new, 'opcode.h';
-safer_rename $opname_new, 'opnames.h';
+rename_if_different $opcode_new, 'opcode.h';
+rename_if_different $opname_new, 'opnames.h';
 
 my $pp_proto_new = 'pp_proto.h-new';
 my $pp_sym_new  = 'pp.sym-new';
 
-open PP, ">$pp_proto_new" or die "Error creating $pp_proto_new: $!";
-binmode PP;
-open PPSYM, ">$pp_sym_new" or die "Error creating $pp_sym_new: $!";
-binmode PPSYM;
+my $pp = safer_open($pp_proto_new);
+my $ppsym = safer_open($pp_sym_new);
 
-print PP <<"END";
+print $pp <<"END";
 /* -*- buffer-read-only: t -*-
    !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
    This file is built by opcode.pl from its data.  Any changes made here
@@ -414,7 +459,7 @@ print PP <<"END";
 
 END
 
-print PPSYM <<"END";
+print $ppsym <<"END";
 # -*- buffer-read-only: t -*-
 #
 # !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
@@ -426,30 +471,27 @@ END
 
 
 for (sort keys %ckname) {
-    print PP "PERL_CKDEF(Perl_$_)\n";
-    print PPSYM "Perl_$_\n";
+    print $pp "PERL_CKDEF(Perl_$_)\n";
+    print $ppsym "Perl_$_\n";
 #OP *\t", &tab(3,$_),"(OP* o);\n";
 }
 
-print PP "\n\n";
+print $pp "\n\n";
 
 for (@ops) {
     next if /^i_(pre|post)(inc|dec)$/;
     next if /^custom$/;
-    print PP "PERL_PPDEF(Perl_pp_$_)\n";
-    print PPSYM "Perl_pp_$_\n";
+    print $pp "PERL_PPDEF(Perl_pp_$_)\n";
+    print $ppsym "Perl_pp_$_\n";
 }
-print PP "\n/* ex: set ro: */\n";
-print PPSYM "\n# ex: set ro:\n";
+print $pp "\n/* ex: set ro: */\n";
+print $ppsym "\n# ex: set ro:\n";
 
-close PP or die "Error closing pp_proto.h: $!";
-close PPSYM or die "Error closing pp.sym: $!";
+safer_close($pp);
+safer_close($ppsym);
 
-foreach ('pp_proto.h', 'pp.sym') {
-    safer_rename_silent $_, "$_-old";
-}
-safer_rename $pp_proto_new, 'pp_proto.h';
-safer_rename $pp_sym_new, 'pp.sym';
+rename_if_different $pp_proto_new, 'pp_proto.h';
+rename_if_different $pp_sym_new, 'pp.sym';
 
 END {
   foreach ('opcode.h', 'opnames.h', 'pp_proto.h', 'pp.sym') {
@@ -523,7 +565,8 @@ sub tab {
 
 __END__
 
-# New ops always go at the end, just before 'custom'
+# New ops always go at the end
+# The restriction on having custom as the last op has been removed
 
 # A recapitulation of the format of this file:
 # The file consists of five columns: the name of the op, an English
@@ -553,7 +596,9 @@ __END__
 # Values for the operands are:
 # scalar      - S            list     - L            array     - A
 # hash        - H            sub (CV) - C            file      - F
-# socket      - Fs           filetest - F-           reference - R
+# socket      - Fs           filetest - F-           filetest_access - F-+
+
+# reference - R
 # "?" denotes an optional operand.
 
 # Nothing.
@@ -597,7 +642,7 @@ bless               bless                   ck_fun          s@      S S?
 backtick       quoted execution (``, qx)       ck_open         tu%     S?
 # glob defaults its first arg to $_
 glob           glob                    ck_glob         t@      S?
-readline       <HANDLE>                ck_null         t%      F?
+readline       <HANDLE>                ck_readline     t%      F?
 rcatline       append I/O operator     ck_null         t$
 
 # Bindable operators.
@@ -689,6 +734,8 @@ i_negate    integer negation (-)    ck_null         ifsT1   S
 not            not                     ck_null         ifs1    S
 complement     1's complement (~)      ck_bitop        fst1    S
 
+smartmatch     smart match             ck_smartmatch   s2
+
 # High falutin' math.
 
 atan2          atan2                   ck_fun          fsT@    S S
@@ -709,14 +756,14 @@ abs               abs                     ck_fun          fsTu%   S?
 
 # String stuff.
 
-length         length                  ck_lengthconst  isTu%   S?
+length         length                  ck_fun          ifsTu%  S?
 substr         substr                  ck_substr       st@     S S S? S?
 vec            vec                     ck_fun          ist@    S S S
 
 index          index                   ck_index        isT@    S S S?
 rindex         rindex                  ck_index        isT@    S S S?
 
-sprintf                sprintf                 ck_fun          mst@    S L
+sprintf                sprintf                 ck_fun          fmst@   S L
 formline       formline                ck_fun          ms@     S L
 ord            ord                     ck_fun          ifsTu%  S?
 chr            chr                     ck_fun          fsTu%   S?
@@ -734,15 +781,19 @@ aelemfast constant array element  ck_null         s$      A S
 aelem          array element           ck_null         s2      A S
 aslice         array slice             ck_null         m@      A L
 
+aeach          each on array           ck_each         %       A
+akeys          keys on array           ck_each         t%      A
+avalues                values on array         ck_each         t%      A
+
 # Hashes.
 
-each           each                    ck_fun          %       H
-values         values                  ck_fun          t%      H
-keys           keys                    ck_fun          t%      H
+each           each                    ck_each         %       H
+values         values                  ck_each         t%      H
+keys           keys                    ck_each         t%      H
 delete         delete                  ck_delete       %       S
 exists         exists                  ck_exists       is%     S
 rv2hv          hash dereference        ck_rvconst      dt1     
-helem          hash element            ck_null         s2@     H S
+helem          hash element            ck_null         s2      H S
 hslice         hash slice              ck_null         m@      H L
 
 # Explosives and implosives.
@@ -784,9 +835,11 @@ flop               range (or flop)         ck_null         1
 and            logical and (&&)                ck_null         |       
 or             logical or (||)                 ck_null         |       
 xor            logical xor                     ck_null         fs2     S S     
+dor            defined or (//)                 ck_null         |
 cond_expr      conditional expression          ck_null         d|      
 andassign      logical and assignment (&&=)    ck_null         s|      
 orassign       logical or assignment (||=)     ck_null         s|      
+dorassign      defined or assignment (//=)     ck_null         s|
 
 method         method lookup           ck_method       d1
 entersub       subroutine entry        ck_subr         dmt1    L
@@ -815,10 +868,14 @@ redo              redo                    ck_null         ds}
 dump           dump                    ck_null         ds}     
 goto           goto                    ck_null         ds}     
 exit           exit                    ck_exit         ds%     S?
-# continued below
+method_named   method with known name  ck_null         d$
 
-#nswitch       numeric switch          ck_null         d       
-#cswitch       character switch        ck_null         d       
+entergiven     given()                 ck_null         d|
+leavegiven     leave given block       ck_null         1
+enterwhen      when()                  ck_null         d|
+leavewhen      leave when block        ck_null         1
+break          break                   ck_null         0
+continue       continue                ck_null         0
 
 # I/O.
 
@@ -846,15 +903,13 @@ leavewrite        write exit              ck_null         1
 
 prtf           printf                  ck_listiob      ims@    F? L
 print          print                   ck_listiob      ims@    F? L
+say            say                     ck_listiob      ims@    F? L
 
 sysopen                sysopen                 ck_fun          s@      F S S S?
 sysseek                sysseek                 ck_fun          s@      F S S
 sysread                sysread                 ck_fun          imst@   F R S S?
 syswrite       syswrite                ck_fun          imst@   F S S? S?
 
-send           send                    ck_fun          imst@   Fs S S S?
-recv           recv                    ck_fun          imst@   Fs R S S
-
 eof            eof                     ck_eof          is%     F?
 tell           tell                    ck_fun          st%     F?
 seek           seek                    ck_fun          s@      F S S
@@ -865,7 +920,10 @@ fcntl              fcntl                   ck_fun          st@     F S S
 ioctl          ioctl                   ck_fun          st@     F S S
 flock          flock                   ck_fun          isT@    F S
 
-# Sockets.
+# Sockets.  OP_IS_SOCKET wants them consecutive (so moved 1st 2)
+
+send           send                    ck_fun          imst@   Fs S S S?
+recv           recv                    ck_fun          imst@   Fs R S S
 
 socket         socket                  ck_fun          is@     Fs S S S
 sockpair       socketpair              ck_fun          is@     Fs Fs S S S
@@ -882,16 +940,16 @@ ssockopt  setsockopt              ck_fun          is@     Fs S S S
 getsockname    getsockname             ck_fun          is%     Fs
 getpeername    getpeername             ck_fun          is%     Fs
 
-# Stat calls.
+# Stat calls.  OP_IS_FILETEST wants them consecutive.
 
 lstat          lstat                   ck_ftst         u-      F
 stat           stat                    ck_ftst         u-      F
-ftrread                -R                      ck_ftst         isu-    F-
-ftrwrite       -W                      ck_ftst         isu-    F-
-ftrexec                -X                      ck_ftst         isu-    F-
-fteread                -r                      ck_ftst         isu-    F-
-ftewrite       -w                      ck_ftst         isu-    F-
-fteexec                -x                      ck_ftst         isu-    F-
+ftrread                -R                      ck_ftst         isu-    F-+
+ftrwrite       -W                      ck_ftst         isu-    F-+
+ftrexec                -X                      ck_ftst         isu-    F-+
+fteread                -r                      ck_ftst         isu-    F-+
+ftewrite       -w                      ck_ftst         isu-    F-+
+fteexec                -x                      ck_ftst         isu-    F-+
 ftis           -e                      ck_ftst         isu-    F-
 ftsize         -s                      ck_ftst         istu-   F-
 ftmtime                -M                      ck_ftst         stu-    F-
@@ -990,6 +1048,7 @@ semctl             semctl                  ck_fun          imst@   S S S S
 
 require                require                 ck_require      du%     S?
 dofile         do "file"               ck_fun          d1      S
+hintseval      eval hints              ck_svconst      s$
 entereval      eval "string"           ck_eval         d%      S
 leaveeval      eval "string" exit      ck_null         1       S
 #evalonce      eval constant string    ck_null         d1      S
@@ -1037,23 +1096,8 @@ syscall          syscall                 ck_fun          imst@   S L
 # For multi-threading
 lock           lock                    ck_rfun         s%      R
 
-# Control (contd.)
-setstate       set statement info      ck_null         s;
-method_named   method with known name  ck_null         d$
-
-dor            defined or (//)                 ck_null         |
-dorassign      defined or assignment (//=)     ck_null         s|
-
-entergiven     given()                 ck_null         d|
-leavegiven     leave given block       ck_null         1
-enterwhen      when()                  ck_null         d|
-leavewhen      leave when block        ck_null         1
-break          break                   ck_null         0
-continue       continue                ck_null         0
-smartmatch     smart match             ck_smartmatch   s2
-
-say            say                     ck_listiob      ims@    F? L
+# For state support
 
-# Add new ops before this, the custom operator.
+once           once                    ck_null         |       
 
 custom         unknown custom operator         ck_null         0