regen/opcode.pl

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