opcode.pl

   1 #!/usr/bin/perl -w
   2 use strict;
   3
   4 BEGIN {
   5     # Get function prototypes
   6     require 'regen_lib.pl';
   7 }
   8
   9 my $opcode_new = 'opcode.h-new';
  10 my $opname_new = 'opnames.h-new';
  11 my $oc = safer_open($opcode_new);
  12 my $on = safer_open($opname_new);
  13 select $oc;
  14
  15 # Read data.
  16
  17 my %seen;
  18 my (@ops, %desc, %check, %ckname, %flags, %args, %opnum);
  19
  20 while (<DATA>) {
  21     chop;
  22     next unless $_;
  23     next if /^#/;
  24     my ($key, $desc, $check, $flags, $args) = split(/\t+/, $_, 5);
  25     $args = '' unless defined $args;
  26
  27     warn qq[Description "$desc" duplicates $seen{$desc}\n] if $seen{$desc};
  28     die qq[Opcode "$key" duplicates $seen{$key}\n] if $seen{$key};
  29     $seen{$desc} = qq[description of opcode "$key"];
  30     $seen{$key} = qq[opcode "$key"];
  31
  32     push(@ops, $key);
  33     $opnum{$key} = $#ops;
  34     $desc{$key} = $desc;
  35     $check{$key} = $check;
  36     $ckname{$check}++;
  37     $flags{$key} = $flags;
  38     $args{$key} = $args;
  39 }
  40
  41 # Set up aliases
  42
  43 my %alias;
  44
  45 # Format is "this function" => "does these op names"
  46 my @raw_alias = (
  47                  Perl_do_kv => [qw( keys values )],
  48                  Perl_unimplemented_op => [qw(padany mapstart custom)],
  49                  # All the ops with a body of { return NORMAL; }
  50                  Perl_pp_null => [qw(scalar regcmaybe lineseq scope)],
  51
  52                  Perl_pp_goto => ['dump'],
  53                  Perl_pp_require => ['dofile'],
  54                  Perl_pp_untie => ['dbmclose'],
  55                  Perl_pp_sysread => [qw(read recv)],
  56                  Perl_pp_sysseek => ['seek'],
  57                  Perl_pp_ioctl => ['fcntl'],
  58                  Perl_pp_ssockopt => ['gsockopt'],
  59                  Perl_pp_getpeername => ['getsockname'],
  60                  Perl_pp_stat => ['lstat'],
  61                  Perl_pp_ftrowned => [qw(fteowned ftzero ftsock ftchr ftblk
  62                                          ftfile ftdir ftpipe ftsuid ftsgid
  63                                          ftsvtx)],
  64                  Perl_pp_fttext => ['ftbinary'],
  65                  Perl_pp_gmtime => ['localtime'],
  66                  Perl_pp_semget => [qw(shmget msgget)],
  67                  Perl_pp_semctl => [qw(shmctl msgctl)],
  68                  Perl_pp_ghostent => [qw(ghbyname ghbyaddr)],
  69                  Perl_pp_gnetent => [qw(gnbyname gnbyaddr)],
  70                  Perl_pp_gprotoent => [qw(gpbyname gpbynumber)],
  71                  Perl_pp_gservent => [qw(gsbyname gsbyport)],
  72                  Perl_pp_gpwent => [qw(gpwnam gpwuid)],
  73                  Perl_pp_ggrent => [qw(ggrnam ggrgid)],
  74                  Perl_pp_ftis => [qw(ftsize ftmtime ftatime ftctime)],
  75                  Perl_pp_chown => [qw(unlink chmod utime kill)],
  76                  Perl_pp_link => ['symlink'],
  77                  Perl_pp_ftrread => [qw(ftrwrite ftrexec fteread ftewrite
  78                                         fteexec)],
  79                  Perl_pp_shmwrite => [qw(shmread msgsnd msgrcv semop)],
  80                  Perl_pp_send => ['syswrite'],
  81                  Perl_pp_defined => [qw(dor dorassign)],
  82                  Perl_pp_and => ['andassign'],
  83                  Perl_pp_or => ['orassign'],
  84                  Perl_pp_ucfirst => ['lcfirst'],
  85                  Perl_pp_sle => [qw(slt sgt sge)],
  86                  Perl_pp_print => ['say'],
  87                  Perl_pp_index => ['rindex'],
  88                  Perl_pp_oct => ['hex'],
  89                  Perl_pp_shift => ['pop'],
  90                  Perl_pp_sin => [qw(cos exp log sqrt)],
  91                  Perl_pp_bit_or => ['bit_xor'],
  92                  Perl_pp_rv2av => ['rv2hv'],
  93                  Perl_pp_akeys => ['avalues'],
  94                 );
  95
  96 while (my ($func, $names) = splice @raw_alias, 0, 2) {
  97     $alias{$_} = $func for @$names;
  98 }
  99
 100 # Emit defines.
 101
 102 print <<"END";
 103 /* -*- buffer-read-only: t -*-
 104  *
 105  *    opcode.h
 106  *
 107  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
 108  *    2001, 2002, 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
 109  *
 110  *    You may distribute under the terms of either the GNU General Public
 111  *    License or the Artistic License, as specified in the README file.
 112  *
 113  * !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
 114  *  This file is built by opcode.pl from its data.  Any changes made here
 115  *  will be lost!
 116  */
 117
 118 #ifndef PERL_GLOBAL_STRUCT_INIT
 119
 120 #define Perl_pp_i_preinc Perl_pp_preinc
 121 #define Perl_pp_i_predec Perl_pp_predec
 122 #define Perl_pp_i_postinc Perl_pp_postinc
 123 #define Perl_pp_i_postdec Perl_pp_postdec
 124
 125 PERL_PPDEF(Perl_unimplemented_op)
 126
 127 END
 128
 129 print $on <<"END";
 130 /* -*- buffer-read-only: t -*-
 131  *
 132  *    opnames.h
 133  *
 134  *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
 135  *    2007, 2008 by Larry Wall and others
 136  *
 137  *    You may distribute under the terms of either the GNU General Public
 138  *    License or the Artistic License, as specified in the README file.
 139  *
 140  *
 141  * !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
 142  *  This file is built by opcode.pl from its data.  Any changes made here
 143  *  will be lost!
 144  */
 145
 146 typedef enum opcode {
 147 END
 148
 149 my $i = 0;
 150 for (@ops) {
 151     # print $on "\t", &tab(3,"OP_\U$_,"), "/* ", $i++, " */\n";
 152       print $on "\t", &tab(3,"OP_\U$_"), " = ", $i++, ",\n";
 153 }
 154 print $on "\t", &tab(3,"OP_max"), "\n";
 155 print $on "} opcode;\n";
 156 print $on "\n#define MAXO ", scalar @ops, "\n";
 157 print $on "#define OP_phoney_INPUT_ONLY -1\n";
 158 print $on "#define OP_phoney_OUTPUT_ONLY -2\n\n";
 159
 160 # Emit op names and descriptions.
 161
 162 print <<END;
 163 START_EXTERN_C
 164
 165 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM ? custom_op_name(o) : \\
 166                     PL_op_name[(o)->op_type])
 167 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM ? custom_op_desc(o) : \\
 168                     PL_op_desc[(o)->op_type])
 169
 170 #ifndef DOINIT
 171 EXTCONST char* const PL_op_name[];
 172 #else
 173 EXTCONST char* const PL_op_name[] = {
 174 END
 175
 176 for (@ops) {
 177     print qq(\t"$_",\n);
 178 }
 179
 180 print <<END;
 181 };
 182 #endif
 183
 184 END
 185
 186 print <<END;
 187 #ifndef DOINIT
 188 EXTCONST char* const PL_op_desc[];
 189 #else
 190 EXTCONST char* const PL_op_desc[] = {
 191 END
 192
 193 for (@ops) {
 194     my($safe_desc) = $desc{$_};
 195
 196     # Have to escape double quotes and escape characters.
 197     $safe_desc =~ s/(^|[^\\])([\\"])/$1\\$2/g;
 198
 199     print qq(\t"$safe_desc",\n);
 200 }
 201
 202 print <<END;
 203 };
 204 #endif
 205
 206 END_EXTERN_C
 207
 208 #endif /* !PERL_GLOBAL_STRUCT_INIT */
 209 END
 210
 211 # Emit function declarations.
 212
 213 #for (sort keys %ckname) {
 214 #    print "OP *\t", &tab(3,$_),"(pTHX_ OP* o);\n";
 215 #}
 216 #
 217 #print "\n";
 218 #
 219 #for (@ops) {
 220 #    print "OP *\t", &tab(3, "pp_$_"), "(pTHX);\n";
 221 #}
 222
 223 # Emit ppcode switch array.
 224
 225 print <<END;
 226
 227 START_EXTERN_C
 228
 229 #ifdef PERL_GLOBAL_STRUCT_INIT
 230 #  define PERL_PPADDR_INITED
 231 static const Perl_ppaddr_t Gppaddr[]
 232 #else
 233 #  ifndef PERL_GLOBAL_STRUCT
 234 #    define PERL_PPADDR_INITED
 235 EXT Perl_ppaddr_t PL_ppaddr[] /* or perlvars.h */
 236 #  endif
 237 #endif /* PERL_GLOBAL_STRUCT */
 238 #if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
 239 #  define PERL_PPADDR_INITED
 240 = {
 241 END
 242
 243 for (@ops) {
 244     if (my $name = $alias{$_}) {
 245         print "\tMEMBER_TO_FPTR($name),\t/* Perl_pp_$_ */\n";
 246     }
 247     else {
 248         print "\tMEMBER_TO_FPTR(Perl_pp_$_),\n";
 249     }
 250 }
 251
 252 print <<END;
 253 }
 254 #endif
 255 #ifdef PERL_PPADDR_INITED
 256 ;
 257 #endif
 258
 259 END
 260
 261 # Emit check routines.
 262
 263 print <<END;
 264 #ifdef PERL_GLOBAL_STRUCT_INIT
 265 #  define PERL_CHECK_INITED
 266 static const Perl_check_t Gcheck[]
 267 #else
 268 #  ifndef PERL_GLOBAL_STRUCT
 269 #    define PERL_CHECK_INITED
 270 EXT Perl_check_t PL_check[] /* or perlvars.h */
 271 #  endif
 272 #endif
 273 #if (defined(DOINIT) && !defined(PERL_GLOBAL_STRUCT)) || defined(PERL_GLOBAL_STRUCT_INIT)
 274 #  define PERL_CHECK_INITED
 275 = {
 276 END
 277
 278 for (@ops) {
 279     print "\t", &tab(3, "MEMBER_TO_FPTR(Perl_$check{$_}),"), "\t/* $_ */\n";
 280 }
 281
 282 print <<END;
 283 }
 284 #endif
 285 #ifdef PERL_CHECK_INITED
 286 ;
 287 #endif /* #ifdef PERL_CHECK_INITED */
 288
 289 END
 290
 291 # Emit allowed argument types.
 292
 293 my $ARGBITS = 32;
 294
 295 print <<END;
 296 #ifndef PERL_GLOBAL_STRUCT_INIT
 297
 298 #ifndef DOINIT
 299 EXTCONST U32 PL_opargs[];
 300 #else
 301 EXTCONST U32 PL_opargs[] = {
 302 END
 303
 304 my %argnum = (
 305     'S',  1,            # scalar
 306     'L',  2,            # list
 307     'A',  3,            # array value
 308     'H',  4,            # hash value
 309     'C',  5,            # code value
 310     'F',  6,            # file value
 311     'R',  7,            # scalar reference
 312 );
 313
 314 my %opclass = (
 315     '0',  0,            # baseop
 316     '1',  1,            # unop
 317     '2',  2,            # binop
 318     '|',  3,            # logop
 319     '@',  4,            # listop
 320     '/',  5,            # pmop
 321     '$',  6,            # svop_or_padop
 322     '#',  7,            # padop
 323     '"',  8,            # pvop_or_svop
 324     '{',  9,            # loop
 325     ';',  10,           # cop
 326     '%',  11,           # baseop_or_unop
 327     '-',  12,           # filestatop
 328     '}',  13,           # loopexop
 329 );
 330
 331 my %opflags = (
 332     'm' =>   1,         # needs stack mark
 333     'f' =>   2,         # fold constants
 334     's' =>   4,         # always produces scalar
 335     't' =>   8,         # needs target scalar
 336     'T' =>   8 | 256,   # ... which may be lexical
 337     'i' =>  16,         # always produces integer
 338     'I' =>  32,         # has corresponding int op
 339     'd' =>  64,         # danger, unknown side effects
 340     'u' => 128,         # defaults to $_
 341 );
 342
 343 my %OP_IS_SOCKET;
 344 my %OP_IS_FILETEST;
 345 my %OP_IS_FT_ACCESS;
 346 my $OCSHIFT = 9;
 347 my $OASHIFT = 13;
 348
 349 for my $op (@ops) {
 350     my $argsum = 0;
 351     my $flags = $flags{$op};
 352     for my $flag (keys %opflags) {
 353         if ($flags =~ s/$flag//) {
 354             die "Flag collision for '$op' ($flags{$op}, $flag)\n"
 355                 if $argsum & $opflags{$flag};
 356             $argsum |= $opflags{$flag};
 357         }
 358     }
 359     die qq[Opcode '$op' has no class indicator ($flags{$op} => $flags)\n]
 360         unless exists $opclass{$flags};
 361     $argsum |= $opclass{$flags} << $OCSHIFT;
 362     my $argshift = $OASHIFT;
 363     for my $arg (split(' ',$args{$op})) {
 364         if ($arg =~ /^F/) {
 365             # record opnums of these opnames
 366             $OP_IS_SOCKET{$op}   = $opnum{$op} if $arg =~ s/s//;
 367             $OP_IS_FILETEST{$op} = $opnum{$op} if $arg =~ s/-//;
 368             $OP_IS_FT_ACCESS{$op} = $opnum{$op} if $arg =~ s/\+//;
 369         }
 370         my $argnum = ($arg =~ s/\?//) ? 8 : 0;
 371         die "op = $op, arg = $arg\n"
 372             unless exists $argnum{$arg};
 373         $argnum += $argnum{$arg};
 374         die "Argument overflow for '$op'\n"
 375             if $argshift >= $ARGBITS ||
 376                $argnum > ((1 << ($ARGBITS - $argshift)) - 1);
 377         $argsum += $argnum << $argshift;
 378         $argshift += 4;
 379     }
 380     $argsum = sprintf("0x%08x", $argsum);
 381     print "\t", &tab(3, "$argsum,"), "/* $op */\n";
 382 }
 383
 384 print <<END;
 385 };
 386 #endif
 387
 388 #endif /* !PERL_GLOBAL_STRUCT_INIT */
 389
 390 END_EXTERN_C
 391
 392 END
 393
 394 # Emit OP_IS_* macros
 395
 396 print $on <<EO_OP_IS_COMMENT;
 397
 398 /* the OP_IS_(SOCKET|FILETEST) macros are optimized to a simple range
 399     check because all the member OPs are contiguous in opcode.pl
 400     <DATA> table.  opcode.pl verifies the range contiguity.  */
 401
 402 EO_OP_IS_COMMENT
 403
 404 gen_op_is_macro( \%OP_IS_SOCKET, 'OP_IS_SOCKET');
 405 gen_op_is_macro( \%OP_IS_FILETEST, 'OP_IS_FILETEST');
 406 gen_op_is_macro( \%OP_IS_FT_ACCESS, 'OP_IS_FILETEST_ACCESS');
 407
 408 sub gen_op_is_macro {
 409     my ($op_is, $macname) = @_;
 410     if (keys %$op_is) {
 411
 412         # get opnames whose numbers are lowest and highest
 413         my ($first, @rest) = sort {
 414             $op_is->{$a} <=> $op_is->{$b}
 415         } keys %$op_is;
 416
 417         my $last = pop @rest;   # @rest slurped, get its last
 418         die "Invalid range of ops: $first .. $last\n" unless $last;
 419
 420         print $on "#define $macname(op) \\\n\t(";
 421
 422         # verify that op-ct matches 1st..last range (and fencepost)
 423         # (we know there are no dups)
 424         if ( $op_is->{$last} - $op_is->{$first} == scalar @rest + 1) {
 425
 426             # contiguous ops -> optimized version
 427             print $on "(op) >= OP_" . uc($first) . " && (op) <= OP_" . uc($last);
 428             print $on ")\n\n";
 429         }
 430         else {
 431             print $on join(" || \\\n\t ",
 432                           map { "(op) == OP_" . uc() } sort keys %$op_is);
 433             print $on ")\n\n";
 434         }
 435     }
 436 }
 437
 438 print $oc "/* ex: set ro: */\n";
 439 print $on "/* ex: set ro: */\n";
 440
 441 safer_close($oc);
 442 safer_close($on);
 443
 444 rename_if_different $opcode_new, 'opcode.h';
 445 rename_if_different $opname_new, 'opnames.h';
 446
 447 my $pp_proto_new = 'pp_proto.h-new';
 448 my $pp_sym_new  = 'pp.sym-new';
 449
 450 my $pp = safer_open($pp_proto_new);
 451 my $ppsym = safer_open($pp_sym_new);
 452
 453 print $pp <<"END";
 454 /* -*- buffer-read-only: t -*-
 455    !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
 456    This file is built by opcode.pl from its data.  Any changes made here
 457    will be lost!
 458 */
 459
 460 END
 461
 462 print $ppsym <<"END";
 463 # -*- buffer-read-only: t -*-
 464 #
 465 # !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
 466 #   This file is built by opcode.pl from its data.  Any changes made here
 467 #   will be lost!
 468 #
 469
 470 END
 471
 472
 473 for (sort keys %ckname) {
 474     print $pp "PERL_CKDEF(Perl_$_)\n";
 475     print $ppsym "Perl_$_\n";
 476 #OP *\t", &tab(3,$_),"(OP* o);\n";
 477 }
 478
 479 print $pp "\n\n";
 480
 481 for (@ops) {
 482     next if /^i_(pre|post)(inc|dec)$/;
 483     next if /^custom$/;
 484     print $pp "PERL_PPDEF(Perl_pp_$_)\n";
 485     print $ppsym "Perl_pp_$_\n";
 486 }
 487 print $pp "\n/* ex: set ro: */\n";
 488 print $ppsym "\n# ex: set ro:\n";
 489
 490 safer_close($pp);
 491 safer_close($ppsym);
 492
 493 rename_if_different $pp_proto_new, 'pp_proto.h';
 494 rename_if_different $pp_sym_new, 'pp.sym';
 495
 496 END {
 497   foreach ('opcode.h', 'opnames.h', 'pp_proto.h', 'pp.sym') {
 498     1 while unlink "$_-old";
 499   }
 500 }
 501
 502 ###########################################################################
 503 sub tab {
 504     my ($l, $t) = @_;
 505     $t .= "\t" x ($l - (length($t) + 1) / 8);
 506     $t;
 507 }
 508 ###########################################################################
 509
 510 # Some comments about 'T' opcode classifier:
 511
 512 # Safe to set if the ppcode uses:
 513 #       tryAMAGICbin, tryAMAGICun, SETn, SETi, SETu, PUSHn, PUSHTARG, SETTARG,
 514 #       SETs(TARG), XPUSHn, XPUSHu,
 515
 516 # Unsafe to set if the ppcode uses dTARG or [X]RETPUSH[YES|NO|UNDEF]
 517
 518 # lt and friends do SETs (including ncmp, but not scmp)
 519
 520 # Additional mode of failure: the opcode can modify TARG before it "used"
 521 # all the arguments (or may call an external function which does the same).
 522 # If the target coincides with one of the arguments ==> kaboom.
 523
 524 # pp.c  pos substr each not OK (RETPUSHUNDEF)
 525 #       substr vec also not OK due to LV to target (are they???)
 526 #       ref not OK (RETPUSHNO)
 527 #       trans not OK (dTARG; TARG = sv_newmortal();)
 528 #       ucfirst etc not OK: TMP arg processed inplace
 529 #       quotemeta not OK (unsafe when TARG == arg)
 530 #       each repeat not OK too due to list context
 531 #       pack split - unknown whether they are safe
 532 #       sprintf: is calling do_sprintf(TARG,...) which can act on TARG
 533 #         before other args are processed.
 534
 535 #       Suspicious wrt "additional mode of failure" (and only it):
 536 #       schop, chop, postinc/dec, bit_and etc, negate, complement.
 537
 538 #       Also suspicious: 4-arg substr, sprintf, uc/lc (POK_only), reverse, pack.
 539
 540 #       substr/vec: doing TAINT_off()???
 541
 542 # pp_hot.c
 543 #       readline - unknown whether it is safe
 544 #       match subst not OK (dTARG)
 545 #       grepwhile not OK (not always setting)
 546 #       join not OK (unsafe when TARG == arg)
 547
 548 #       Suspicious wrt "additional mode of failure": concat (dealt with
 549 #       in ck_sassign()), join (same).
 550
 551 # pp_ctl.c
 552 #       mapwhile flip caller not OK (not always setting)
 553
 554 # pp_sys.c
 555 #       backtick glob warn die not OK (not always setting)
 556 #       warn not OK (RETPUSHYES)
 557 #       open fileno getc sysread syswrite ioctl accept shutdown
 558 #        ftsize(etc) readlink telldir fork alarm getlogin not OK (RETPUSHUNDEF)
 559 #       umask select not OK (XPUSHs(&PL_sv_undef);)
 560 #       fileno getc sysread syswrite tell not OK (meth("FILENO" "GETC"))
 561 #       sselect shm* sem* msg* syscall - unknown whether they are safe
 562 #       gmtime not OK (list context)
 563
 564 #       Suspicious wrt "additional mode of failure": warn, die, select.
 565
 566 __END__
 567
 568 # New ops always go at the end
 569 # The restriction on having custom as the last op has been removed
 570
 571 # A recapitulation of the format of this file:
 572 # The file consists of five columns: the name of the op, an English
 573 # description, the name of the "check" routine used to optimize this
 574 # operation, some flags, and a description of the operands.
 575
 576 # The flags consist of options followed by a mandatory op class signifier
 577
 578 # The classes are:
 579 # baseop      - 0            unop     - 1            binop      - 2
 580 # logop       - |            listop   - @            pmop       - /
 581 # padop/svop  - $            padop    - # (unused)   loop       - {
 582 # baseop/unop - %            loopexop - }            filestatop - -
 583 # pvop/svop   - "            cop      - ;
 584
 585 # Other options are:
 586 #   needs stack mark                    - m
 587 #   needs constant folding              - f
 588 #   produces a scalar                   - s
 589 #   produces an integer                 - i
 590 #   needs a target                      - t
 591 #   target can be in a pad              - T
 592 #   has a corresponding integer version - I
 593 #   has side effects                    - d
 594 #   uses $_ if no argument given        - u
 595
 596 # Values for the operands are:
 597 # scalar      - S            list     - L            array     - A
 598 # hash        - H            sub (CV) - C            file      - F
 599 # socket      - Fs           filetest - F-           filetest_access - F-+
 600
 601 # reference - R
 602 # "?" denotes an optional operand.
 603
 604 # Nothing.
 605
 606 null            null operation          ck_null         0
 607 stub            stub                    ck_null         0
 608 scalar          scalar                  ck_fun          s%      S
 609
 610 # Pushy stuff.
 611
 612 pushmark        pushmark                ck_null         s0
 613 wantarray       wantarray               ck_null         is0
 614
 615 const           constant item           ck_svconst      s$
 616
 617 gvsv            scalar variable         ck_null         ds$
 618 gv              glob value              ck_null         ds$
 619 gelem           glob elem               ck_null         d2      S S
 620 padsv           private variable        ck_null         ds0
 621 padav           private array           ck_null         d0
 622 padhv           private hash            ck_null         d0
 623 padany          private value           ck_null         d0
 624
 625 pushre          push regexp             ck_null         d/
 626
 627 # References and stuff.
 628
 629 rv2gv           ref-to-glob cast        ck_rvconst      ds1
 630 rv2sv           scalar dereference      ck_rvconst      ds1
 631 av2arylen       array length            ck_null         is1
 632 rv2cv           subroutine dereference  ck_rvconst      d1
 633 anoncode        anonymous subroutine    ck_anoncode     $
 634 prototype       subroutine prototype    ck_null         s%      S
 635 refgen          reference constructor   ck_spair        m1      L
 636 srefgen         single ref constructor  ck_null         fs1     S
 637 ref             reference-type operator ck_fun          stu%    S?
 638 bless           bless                   ck_fun          s@      S S?
 639
 640 # Pushy I/O.
 641
 642 backtick        quoted execution (``, qx)       ck_open         tu%     S?
 643 # glob defaults its first arg to $_
 644 glob            glob                    ck_glob         t@      S?
 645 readline        <HANDLE>                ck_readline     t%      F?
 646 rcatline        append I/O operator     ck_null         t$
 647
 648 # Bindable operators.
 649
 650 regcmaybe       regexp internal guard   ck_fun          s1      S
 651 regcreset       regexp internal reset   ck_fun          s1      S
 652 regcomp         regexp compilation      ck_null         s|      S
 653 match           pattern match (m//)     ck_match        d/
 654 qr              pattern quote (qr//)    ck_match        s/
 655 subst           substitution (s///)     ck_match        dis/    S
 656 substcont       substitution iterator   ck_null         dis|
 657 trans           transliteration (tr///) ck_match        is"     S
 658
 659 # Lvalue operators.
 660 # sassign is special-cased for op class
 661
 662 sassign         scalar assignment       ck_sassign      s0
 663 aassign         list assignment         ck_null         t2      L L
 664
 665 chop            chop                    ck_spair        mts%    L
 666 schop           scalar chop             ck_null         stu%    S?
 667 chomp           chomp                   ck_spair        mTs%    L
 668 schomp          scalar chomp            ck_null         sTu%    S?
 669 defined         defined operator        ck_defined      isu%    S?
 670 undef           undef operator          ck_lfun         s%      S?
 671 study           study                   ck_fun          su%     S?
 672 pos             match position          ck_lfun         stu%    S?
 673
 674 preinc          preincrement (++)               ck_lfun         dIs1    S
 675 i_preinc        integer preincrement (++)       ck_lfun         dis1    S
 676 predec          predecrement (--)               ck_lfun         dIs1    S
 677 i_predec        integer predecrement (--)       ck_lfun         dis1    S
 678 postinc         postincrement (++)              ck_lfun         dIst1   S
 679 i_postinc       integer postincrement (++)      ck_lfun         disT1   S
 680 postdec         postdecrement (--)              ck_lfun         dIst1   S
 681 i_postdec       integer postdecrement (--)      ck_lfun         disT1   S
 682
 683 # Ordinary operators.
 684
 685 pow             exponentiation (**)     ck_null         fsT2    S S
 686
 687 multiply        multiplication (*)      ck_null         IfsT2   S S
 688 i_multiply      integer multiplication (*)      ck_null         ifsT2   S S
 689 divide          division (/)            ck_null         IfsT2   S S
 690 i_divide        integer division (/)    ck_null         ifsT2   S S
 691 modulo          modulus (%)             ck_null         IifsT2  S S
 692 i_modulo        integer modulus (%)     ck_null         ifsT2   S S
 693 repeat          repeat (x)              ck_repeat       mt2     L S
 694
 695 add             addition (+)            ck_null         IfsT2   S S
 696 i_add           integer addition (+)    ck_null         ifsT2   S S
 697 subtract        subtraction (-)         ck_null         IfsT2   S S
 698 i_subtract      integer subtraction (-) ck_null         ifsT2   S S
 699 concat          concatenation (.) or string     ck_concat       fsT2    S S
 700 stringify       string                  ck_fun          fsT@    S
 701
 702 left_shift      left bitshift (<<)      ck_bitop        fsT2    S S
 703 right_shift     right bitshift (>>)     ck_bitop        fsT2    S S
 704
 705 lt              numeric lt (<)          ck_null         Iifs2   S S
 706 i_lt            integer lt (<)          ck_null         ifs2    S S
 707 gt              numeric gt (>)          ck_null         Iifs2   S S
 708 i_gt            integer gt (>)          ck_null         ifs2    S S
 709 le              numeric le (<=)         ck_null         Iifs2   S S
 710 i_le            integer le (<=)         ck_null         ifs2    S S
 711 ge              numeric ge (>=)         ck_null         Iifs2   S S
 712 i_ge            integer ge (>=)         ck_null         ifs2    S S
 713 eq              numeric eq (==)         ck_null         Iifs2   S S
 714 i_eq            integer eq (==)         ck_null         ifs2    S S
 715 ne              numeric ne (!=)         ck_null         Iifs2   S S
 716 i_ne            integer ne (!=)         ck_null         ifs2    S S
 717 ncmp            numeric comparison (<=>)        ck_null         Iifst2  S S
 718 i_ncmp          integer comparison (<=>)        ck_null         ifst2   S S
 719
 720 slt             string lt               ck_null         ifs2    S S
 721 sgt             string gt               ck_null         ifs2    S S
 722 sle             string le               ck_null         ifs2    S S
 723 sge             string ge               ck_null         ifs2    S S
 724 seq             string eq               ck_null         ifs2    S S
 725 sne             string ne               ck_null         ifs2    S S
 726 scmp            string comparison (cmp) ck_null         ifst2   S S
 727
 728 bit_and         bitwise and (&)         ck_bitop        fst2    S S
 729 bit_xor         bitwise xor (^)         ck_bitop        fst2    S S
 730 bit_or          bitwise or (|)          ck_bitop        fst2    S S
 731
 732 negate          negation (-)            ck_null         Ifst1   S
 733 i_negate        integer negation (-)    ck_null         ifsT1   S
 734 not             not                     ck_null         ifs1    S
 735 complement      1's complement (~)      ck_bitop        fst1    S
 736
 737 smartmatch      smart match             ck_smartmatch   s2
 738
 739 # High falutin' math.
 740
 741 atan2           atan2                   ck_fun          fsT@    S S
 742 sin             sin                     ck_fun          fsTu%   S?
 743 cos             cos                     ck_fun          fsTu%   S?
 744 rand            rand                    ck_fun          sT%     S?
 745 srand           srand                   ck_fun          s%      S?
 746 exp             exp                     ck_fun          fsTu%   S?
 747 log             log                     ck_fun          fsTu%   S?
 748 sqrt            sqrt                    ck_fun          fsTu%   S?
 749
 750 # Lowbrow math.
 751
 752 int             int                     ck_fun          fsTu%   S?
 753 hex             hex                     ck_fun          fsTu%   S?
 754 oct             oct                     ck_fun          fsTu%   S?
 755 abs             abs                     ck_fun          fsTu%   S?
 756
 757 # String stuff.
 758
 759 length          length                  ck_fun          ifsTu%  S?
 760 substr          substr                  ck_substr       st@     S S S? S?
 761 vec             vec                     ck_fun          ist@    S S S
 762
 763 index           index                   ck_index        isT@    S S S?
 764 rindex          rindex                  ck_index        isT@    S S S?
 765
 766 sprintf         sprintf                 ck_fun          fmst@   S L
 767 formline        formline                ck_fun          ms@     S L
 768 ord             ord                     ck_fun          ifsTu%  S?
 769 chr             chr                     ck_fun          fsTu%   S?
 770 crypt           crypt                   ck_fun          fsT@    S S
 771 ucfirst         ucfirst                 ck_fun          fstu%   S?
 772 lcfirst         lcfirst                 ck_fun          fstu%   S?
 773 uc              uc                      ck_fun          fstu%   S?
 774 lc              lc                      ck_fun          fstu%   S?
 775 quotemeta       quotemeta               ck_fun          fstu%   S?
 776
 777 # Arrays.
 778
 779 rv2av           array dereference       ck_rvconst      dt1
 780 aelemfast       constant array element  ck_null         s$      A S
 781 aelem           array element           ck_null         s2      A S
 782 aslice          array slice             ck_null         m@      A L
 783
 784 aeach           each on array           ck_each         %       A
 785 akeys           keys on array           ck_each         t%      A
 786 avalues         values on array         ck_each         t%      A
 787
 788 # Hashes.
 789
 790 each            each                    ck_each         %       H
 791 values          values                  ck_each         t%      H
 792 keys            keys                    ck_each         t%      H
 793 delete          delete                  ck_delete       %       S
 794 exists          exists                  ck_exists       is%     S
 795 rv2hv           hash dereference        ck_rvconst      dt1
 796 helem           hash element            ck_null         s2      H S
 797 hslice          hash slice              ck_null         m@      H L
 798
 799 # Explosives and implosives.
 800
 801 unpack          unpack                  ck_unpack       @       S S?
 802 pack            pack                    ck_fun          mst@    S L
 803 split           split                   ck_split        t@      S S S
 804 join            join or string          ck_join         mst@    S L
 805
 806 # List operators.
 807
 808 list            list                    ck_null         m@      L
 809 lslice          list slice              ck_null         2       H L L
 810 anonlist        anonymous list ([])     ck_fun          ms@     L
 811 anonhash        anonymous hash ({})     ck_fun          ms@     L
 812
 813 splice          splice                  ck_fun          m@      A S? S? L
 814 push            push                    ck_fun          imsT@   A L
 815 pop             pop                     ck_shift        s%      A?
 816 shift           shift                   ck_shift        s%      A?
 817 unshift         unshift                 ck_fun          imsT@   A L
 818 sort            sort                    ck_sort         dm@     C? L
 819 reverse         reverse                 ck_fun          mt@     L
 820
 821 grepstart       grep                    ck_grep         dm@     C L
 822 grepwhile       grep iterator           ck_null         dt|
 823
 824 mapstart        map                     ck_grep         dm@     C L
 825 mapwhile        map iterator            ck_null         dt|
 826
 827 # Range stuff.
 828
 829 range           flipflop                ck_null         |       S S
 830 flip            range (or flip)         ck_null         1       S S
 831 flop            range (or flop)         ck_null         1
 832
 833 # Control.
 834
 835 and             logical and (&&)                ck_null         |
 836 or              logical or (||)                 ck_null         |
 837 xor             logical xor                     ck_null         fs2     S S
 838 dor             defined or (//)                 ck_null         |
 839 cond_expr       conditional expression          ck_null         d|
 840 andassign       logical and assignment (&&=)    ck_null         s|
 841 orassign        logical or assignment (||=)     ck_null         s|
 842 dorassign       defined or assignment (//=)     ck_null         s|
 843
 844 method          method lookup           ck_method       d1
 845 entersub        subroutine entry        ck_subr         dmt1    L
 846 leavesub        subroutine exit         ck_null         1
 847 leavesublv      lvalue subroutine return        ck_null         1
 848 caller          caller                  ck_fun          t%      S?
 849 warn            warn                    ck_fun          imst@   L
 850 die             die                     ck_die          dimst@  L
 851 reset           symbol reset            ck_fun          is%     S?
 852
 853 lineseq         line sequence           ck_null         @
 854 nextstate       next statement          ck_null         s;
 855 dbstate         debug next statement    ck_null         s;
 856 unstack         iteration finalizer     ck_null         s0
 857 enter           block entry             ck_null         0
 858 leave           block exit              ck_null         @
 859 scope           block                   ck_null         @
 860 enteriter       foreach loop entry      ck_null         d{
 861 iter            foreach loop iterator   ck_null         0
 862 enterloop       loop entry              ck_null         d{
 863 leaveloop       loop exit               ck_null         2
 864 return          return                  ck_return       dm@     L
 865 last            last                    ck_null         ds}
 866 next            next                    ck_null         ds}
 867 redo            redo                    ck_null         ds}
 868 dump            dump                    ck_null         ds}
 869 goto            goto                    ck_null         ds}
 870 exit            exit                    ck_exit         ds%     S?
 871 method_named    method with known name  ck_null         d$
 872
 873 entergiven      given()                 ck_null         d|
 874 leavegiven      leave given block       ck_null         1
 875 enterwhen       when()                  ck_null         d|
 876 leavewhen       leave when block        ck_null         1
 877 break           break                   ck_null         0
 878 continue        continue                ck_null         0
 879
 880 # I/O.
 881
 882 open            open                    ck_open         ismt@   F S? L
 883 close           close                   ck_fun          is%     F?
 884 pipe_op         pipe                    ck_fun          is@     F F
 885
 886 fileno          fileno                  ck_fun          ist%    F
 887 umask           umask                   ck_fun          ist%    S?
 888 binmode         binmode                 ck_fun          s@      F S?
 889
 890 tie             tie                     ck_fun          idms@   R S L
 891 untie           untie                   ck_fun          is%     R
 892 tied            tied                    ck_fun          s%      R
 893 dbmopen         dbmopen                 ck_fun          is@     H S S
 894 dbmclose        dbmclose                ck_fun          is%     H
 895
 896 sselect         select system call      ck_select       t@      S S S S
 897 select          select                  ck_select       st@     F?
 898
 899 getc            getc                    ck_eof          st%     F?
 900 read            read                    ck_fun          imst@   F R S S?
 901 enterwrite      write                   ck_fun          dis%    F?
 902 leavewrite      write exit              ck_null         1
 903
 904 prtf            printf                  ck_listiob      ims@    F? L
 905 print           print                   ck_listiob      ims@    F? L
 906 say             say                     ck_listiob      ims@    F? L
 907
 908 sysopen         sysopen                 ck_fun          s@      F S S S?
 909 sysseek         sysseek                 ck_fun          s@      F S S
 910 sysread         sysread                 ck_fun          imst@   F R S S?
 911 syswrite        syswrite                ck_fun          imst@   F S S? S?
 912
 913 eof             eof                     ck_eof          is%     F?
 914 tell            tell                    ck_fun          st%     F?
 915 seek            seek                    ck_fun          s@      F S S
 916 # truncate really behaves as if it had both "S S" and "F S"
 917 truncate        truncate                ck_trunc        is@     S S
 918
 919 fcntl           fcntl                   ck_fun          st@     F S S
 920 ioctl           ioctl                   ck_fun          st@     F S S
 921 flock           flock                   ck_fun          isT@    F S
 922
 923 # Sockets.  OP_IS_SOCKET wants them consecutive (so moved 1st 2)
 924
 925 send            send                    ck_fun          imst@   Fs S S S?
 926 recv            recv                    ck_fun          imst@   Fs R S S
 927
 928 socket          socket                  ck_fun          is@     Fs S S S
 929 sockpair        socketpair              ck_fun          is@     Fs Fs S S S
 930
 931 bind            bind                    ck_fun          is@     Fs S
 932 connect         connect                 ck_fun          is@     Fs S
 933 listen          listen                  ck_fun          is@     Fs S
 934 accept          accept                  ck_fun          ist@    Fs Fs
 935 shutdown        shutdown                ck_fun          ist@    Fs S
 936
 937 gsockopt        getsockopt              ck_fun          is@     Fs S S
 938 ssockopt        setsockopt              ck_fun          is@     Fs S S S
 939
 940 getsockname     getsockname             ck_fun          is%     Fs
 941 getpeername     getpeername             ck_fun          is%     Fs
 942
 943 # Stat calls.  OP_IS_FILETEST wants them consecutive.
 944
 945 lstat           lstat                   ck_ftst         u-      F
 946 stat            stat                    ck_ftst         u-      F
 947 ftrread         -R                      ck_ftst         isu-    F-+
 948 ftrwrite        -W                      ck_ftst         isu-    F-+
 949 ftrexec         -X                      ck_ftst         isu-    F-+
 950 fteread         -r                      ck_ftst         isu-    F-+
 951 ftewrite        -w                      ck_ftst         isu-    F-+
 952 fteexec         -x                      ck_ftst         isu-    F-+
 953 ftis            -e                      ck_ftst         isu-    F-
 954 ftsize          -s                      ck_ftst         istu-   F-
 955 ftmtime         -M                      ck_ftst         stu-    F-
 956 ftatime         -A                      ck_ftst         stu-    F-
 957 ftctime         -C                      ck_ftst         stu-    F-
 958 ftrowned        -O                      ck_ftst         isu-    F-
 959 fteowned        -o                      ck_ftst         isu-    F-
 960 ftzero          -z                      ck_ftst         isu-    F-
 961 ftsock          -S                      ck_ftst         isu-    F-
 962 ftchr           -c                      ck_ftst         isu-    F-
 963 ftblk           -b                      ck_ftst         isu-    F-
 964 ftfile          -f                      ck_ftst         isu-    F-
 965 ftdir           -d                      ck_ftst         isu-    F-
 966 ftpipe          -p                      ck_ftst         isu-    F-
 967 ftsuid          -u                      ck_ftst         isu-    F-
 968 ftsgid          -g                      ck_ftst         isu-    F-
 969 ftsvtx          -k                      ck_ftst         isu-    F-
 970 ftlink          -l                      ck_ftst         isu-    F-
 971 fttty           -t                      ck_ftst         is-     F-
 972 fttext          -T                      ck_ftst         isu-    F-
 973 ftbinary        -B                      ck_ftst         isu-    F-
 974
 975 # File calls.
 976
 977 # chdir really behaves as if it had both "S?" and "F?"
 978 chdir           chdir                   ck_chdir        isT%    S?
 979 chown           chown                   ck_fun          imsT@   L
 980 chroot          chroot                  ck_fun          isTu%   S?
 981 unlink          unlink                  ck_fun          imsTu@  L
 982 chmod           chmod                   ck_fun          imsT@   L
 983 utime           utime                   ck_fun          imsT@   L
 984 rename          rename                  ck_fun          isT@    S S
 985 link            link                    ck_fun          isT@    S S
 986 symlink         symlink                 ck_fun          isT@    S S
 987 readlink        readlink                ck_fun          stu%    S?
 988 mkdir           mkdir                   ck_fun          isTu@   S? S?
 989 rmdir           rmdir                   ck_fun          isTu%   S?
 990
 991 # Directory calls.
 992
 993 open_dir        opendir                 ck_fun          is@     F S
 994 readdir         readdir                 ck_fun          %       F
 995 telldir         telldir                 ck_fun          st%     F
 996 seekdir         seekdir                 ck_fun          s@      F S
 997 rewinddir       rewinddir               ck_fun          s%      F
 998 closedir        closedir                ck_fun          is%     F
 999
1000 # Process control.
1001
1002 fork            fork                    ck_null         ist0
1003 wait            wait                    ck_null         isT0
1004 waitpid         waitpid                 ck_fun          isT@    S S
1005 system          system                  ck_exec         imsT@   S? L
1006 exec            exec                    ck_exec         dimsT@  S? L
1007 kill            kill                    ck_fun          dimsT@  L
1008 getppid         getppid                 ck_null         isT0
1009 getpgrp         getpgrp                 ck_fun          isT%    S?
1010 setpgrp         setpgrp                 ck_fun          isT@    S? S?
1011 getpriority     getpriority             ck_fun          isT@    S S
1012 setpriority     setpriority             ck_fun          isT@    S S S
1013
1014 # Time calls.
1015
1016 # NOTE: MacOS patches the 'i' of time() away later when the interpreter
1017 # is created because in MacOS time() is already returning times > 2**31-1,
1018 # that is, non-integers.
1019
1020 time            time                    ck_null         isT0
1021 tms             times                   ck_null         0
1022 localtime       localtime               ck_fun          t%      S?
1023 gmtime          gmtime                  ck_fun          t%      S?
1024 alarm           alarm                   ck_fun          istu%   S?
1025 sleep           sleep                   ck_fun          isT%    S?
1026
1027 # Shared memory.
1028
1029 shmget          shmget                  ck_fun          imst@   S S S
1030 shmctl          shmctl                  ck_fun          imst@   S S S
1031 shmread         shmread                 ck_fun          imst@   S S S S
1032 shmwrite        shmwrite                ck_fun          imst@   S S S S
1033
1034 # Message passing.
1035
1036 msgget          msgget                  ck_fun          imst@   S S
1037 msgctl          msgctl                  ck_fun          imst@   S S S
1038 msgsnd          msgsnd                  ck_fun          imst@   S S S
1039 msgrcv          msgrcv                  ck_fun          imst@   S S S S S
1040
1041 # Semaphores.
1042
1043 semop           semop                   ck_fun          imst@   S S
1044 semget          semget                  ck_fun          imst@   S S S
1045 semctl          semctl                  ck_fun          imst@   S S S S
1046
1047 # Eval.
1048
1049 require         require                 ck_require      du%     S?
1050 dofile          do "file"               ck_fun          d1      S
1051 hintseval       eval hints              ck_svconst      s$
1052 entereval       eval "string"           ck_eval         d%      S
1053 leaveeval       eval "string" exit      ck_null         1       S
1054 #evalonce       eval constant string    ck_null         d1      S
1055 entertry        eval {block}            ck_null         |
1056 leavetry        eval {block} exit       ck_null         @
1057
1058 # Get system info.
1059
1060 ghbyname        gethostbyname           ck_fun          %       S
1061 ghbyaddr        gethostbyaddr           ck_fun          @       S S
1062 ghostent        gethostent              ck_null         0
1063 gnbyname        getnetbyname            ck_fun          %       S
1064 gnbyaddr        getnetbyaddr            ck_fun          @       S S
1065 gnetent         getnetent               ck_null         0
1066 gpbyname        getprotobyname          ck_fun          %       S
1067 gpbynumber      getprotobynumber        ck_fun          @       S
1068 gprotoent       getprotoent             ck_null         0
1069 gsbyname        getservbyname           ck_fun          @       S S
1070 gsbyport        getservbyport           ck_fun          @       S S
1071 gservent        getservent              ck_null         0
1072 shostent        sethostent              ck_fun          is%     S
1073 snetent         setnetent               ck_fun          is%     S
1074 sprotoent       setprotoent             ck_fun          is%     S
1075 sservent        setservent              ck_fun          is%     S
1076 ehostent        endhostent              ck_null         is0
1077 enetent         endnetent               ck_null         is0
1078 eprotoent       endprotoent             ck_null         is0
1079 eservent        endservent              ck_null         is0
1080 gpwnam          getpwnam                ck_fun          %       S
1081 gpwuid          getpwuid                ck_fun          %       S
1082 gpwent          getpwent                ck_null         0
1083 spwent          setpwent                ck_null         is0
1084 epwent          endpwent                ck_null         is0
1085 ggrnam          getgrnam                ck_fun          %       S
1086 ggrgid          getgrgid                ck_fun          %       S
1087 ggrent          getgrent                ck_null         0
1088 sgrent          setgrent                ck_null         is0
1089 egrent          endgrent                ck_null         is0
1090 getlogin        getlogin                ck_null         st0
1091
1092 # Miscellaneous.
1093
1094 syscall         syscall                 ck_fun          imst@   S L
1095
1096 # For multi-threading
1097 lock            lock                    ck_rfun         s%      R
1098
1099 # For state support
1100
1101 once            once                    ck_null         |
1102
1103 custom          unknown custom operator         ck_null         0